groupwise

A simple node module for connecting to a Novell Groupwise Server using SOAP. It was written primarily for the purpose of getting a "Resource" calendar's events.

History

• 17May2015: This module is currently on hold for a bit. I should be returning back to it soon. Because of this, I have now returned the SOAP client in the init method so that you can run methods I have not currently implemented.

• 13May2015:
  Currently this module some basic functionality.
  It is a module that I will be updating daily (Mon-Fri) until it is completed.

NOTE: This is my very first public module, so it may have lots of issues. Its a learning process. Expect changes to how it operates to occur.

Additional Documentation:

Novell GroupWise SOAP Service Documentation available at: Novell Website

---

How To Use:

(Note: you will need to have a git client installed prior, as the soap module being used it pulled directly from Github.)

npm install groupwise

In your node javascript file header:

var GWS = require('groupwise');
var gws = new GWS();

(Note: Currently, this module only supports one instance of the module.)

---

---

GroupWise Methods:

init()

Execute this method first before anything else:

    var client = {};       // Optional
    var args = {
        server: <string>,    // Required - IP Address of server
        port:   <number>,    // Optional - TCP Port of SOAP Service (Defaults to 7191)
        wsdl:   <string>     // Optional - Location of the Groupwise WSDL file
    };
    gws.init(args, function (err, res) {
        client = res;
        ...
    });

The return object is the soap client itself.
This is useful if there are methods that are not currently implemented in this module but you need access to.
To see available methods, either refer to the the SOAP Documentation on the Novell Site or print out the return object to your console.
Each method requires you to pass an argument object even if the method does not require that object. Simply pass a empty object to the method.

---

login()

Is used to authenticate to a POA (Post Office Agent).
If successful, it returns a user object which contains:

• session:
• info:
• version:
• build:
• serverUtcTime:
• folders: (array)
  Note: The session is automatically set to the primary user after log in.
  Note: Trusted Application is currently not supported.
  Note: Applications cannot log in to GroupWise resources. To access resources data, log in as the owner of the resource and then proxy into the resource.

    var args = {		
    user:    <string>,  // Required	
    pass:    <string>,  // Required		
    lang:    <string>,  // Optional (Default: en)		
    version: <string>   // Optional (Default: 1.05)	
  };
    gws.login(args, function (err, res) {
        ...
    });

---

proxyLogin()

Used to login as an authorized proxy of another user's account.
You must first login is as the primary user before running the proxy login.
Note: The domain and po will be automatically added to the proxy user.

    var proxy: <string> // Required - Name of User
    gws.proxyLogin(proxy, function (err, res) {
        ...
    });

---

initProxies()

Will initialize all available proxies that the logged in user has access to.
The return object will contain an array of those proxies, each containing:

• session:
• uid:
• folders: (array)
• info:
• entry:
  Note: You must be logged in first before running this method.

    gws.initProxies(function (err, res) {
        ...
    });

---

setSession()

Sets the specific session you want to use.
By default, the primary account session id is used.
The "key" is the unique id generated and stored in the return object from the login/initProxies method.

  var key = <string>;
  gws.setSession(key,function(err,res){
    ...
  });

---

logout()

Will logout of the primary user's session.
Note: This will remove any and all proxy sessions as well.

  gws.logout(function (err, res) {
    ...
  });

---

getResources()

Will return any item from the global address book that is marked as a resource.

    gws.getResources(function (err, res) {
    ...
  });

---

getProxyList()

Will return an array of user objects that the current logged in user can proxy into.

  gws.getProxyList(function (err, res) {
    ...
  });

---

getUserFreeBusy()

Returns a specified user's calendar events in between a start and end time frame.

 var params = {
 	id: <string>,
 	start: <date>,
 	end: <date>
 };
 gws.getUserFreeBusy(params,function(err,res){
 	...
 });

Example: Get events between now and 3 days from now

  var start = new Date();
  var end = new Date();
  end.setDate(start.getHours() + 3);
  var params = {
  	id: 'Conference Room 2',
  	start: start,
  	end: end
  };
  gws.getUserFreeBusy(params,function(err,res){
  	...
  });

---

getCalendar()

Returns calendar events for the main calendar

  gws.getCalendar(function (err, res) {
  	...
  });

If you want to filter your results, then use the opts object.
Example: Get events from 2 days ago and newer

  var dt = new Date();
    dt.setDate(dt.getDate() - 2);
    var dts = gws.getDateTimeStr(dt);  
    var opts = {
        op: 'gt',                               // gt, lt, eq, contains
      field: 'startDate',
      value: dts
    };
    gws.getCalendar(opts, function (err, res) {
        ...
    });

---

createAppointment()

Creates a new appointment and returns that appointments id.

    var params = {
    subject: <string>,
 	  message: <string>,
 	  start: <date>,
 	  end: <date>,
 	  allDay: <bool>,
 	  place: <string>
 	};
 	gws.createAppointment(params,function(err,res){
 		...
 	});

---

updateAppointment()

Updates an existing appointment.

 var params = {
 		id: <string>,             // Required
 		update: {
 		  <field>:<value>
 		},
 		add: {
 		  <field>:<value>
 		},
 		delete: {
 		  <field>:<value>
 		}
 	};
 	gws.updateAppointment(params,function(err,res){
 		...
 	});

---

removeAppointment()

Removes an appointment from the calendar.

 var id = <string>
 	gws.removeAppointment(id,function(err,res){
 		...
 	});

---

getGlobalAddressBook()

Returns the users accessible global address book.

  gws.getGlobalAddressBook(function (err, res) {
    ...
  });

---

getSettings()

Returns the users settings.

  gws.getSettings(function (err, res) {
    ...
  });

---

---

GroupWise Callbacks:

On method callbacks, if there is an error, the error object this contain these parameters: - message: A general statement of the error - code: a number value representing the error. - subErr: If the error was produced by a dependency module, its error will be placed into here - params: Contains the parameters that was passed into the method.

---

---

GroupWise Events:

Events generated by this module are as follows

Error:

    gws.on('error',function(err){
        // ...
    }): 

Response:

    gws.on('response', function(res){
        //...
    }):