Add Group

 

Function Name: getAddGroupXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to add a new User Group to the System.

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOAddGroup

 

 

Prototype:

public String getAddGroupXml(String cabinetName, String userDBId,

String mainGroupIndex, String groupName,

String creationDateTime, String expiryDateTime,

String privileges, String comment, String groupType

String limitCount)

OverLoaded Functions:

public String getAddGroupXml(String cabinetName, String userDBId,

String mainGroupIndex, String groupName,

String creationDateTime, String expiryDateTime,

String privileges, String comment, String groupType)

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

cabinetName

Name of the Database Cabinet to which the User wants to connect.

 

N/A

UserDBId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

N/A

mainGroupIndex

This parameter is Reserved. The default value can be sent.

Integer >= 0

0

GroupName

Name of the new Group that is to be added.

 

New Group (incremental no). For example, if a Group with name ‘New Group’ is already present then a

Group with the name, New Group (1) is created.

creationDateTime

Date and Time of the creation of the Group.

A valid Date in the format yyyy-mm-dd hh:mm:ss

Current Date and Time.

expiryDateTime

Date and Time when the new Group will expire.

A valid date in the format yyyy-mm-dd hh:mm:ss

12/31/2099

Privileges

Specify the various Privileges that are assigned to the Group.

String of seven bits, each 0 or 1 depending upon whether that particular Privilege is to be provided to the Group or not.

None of the privilege is given to the new group

Comment

Any comment to be associated with the Group.

 

Blank

groupType

Type of the Group.

‘G’- General

‘A’- Reserved

‘G’

limitCount

Specifies the maximum number of Groups that can be added in the System

Integer > 0

No check is made for limit on number of Groups.

 

Output Parameters:

An inputXml string for the NGOAddGroup call.