Add User

Function Name: getAddUserXml

Class: com.newgen.dmsapi.DMSInputXml

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

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::NGOAddUser

Prototype:

public String getAddUserXml( String cabinetName, String userDBId,

String creationDateTime, String userName, String password,

String personalName, String familyName,

String privileges, String account,

String comment, String expiryDateTime,

String companyFolderId, String limitCount,

String mailId, String fax, String noteColor,

String superiorIndex,String superiorFlag,

String parentGroupIndex,String passwordExpiryDate,

String passwordNeverExpires, String groupList)

public String getAddUserXml( String cabinetName, String userDBId,

String creationDateTime, String userName, String password,

String personalName, String familyName,

String privileges, String account,

String comment, String expiryDateTime,

String companyFolderId, String limitCount,

String mailId, String fax, String noteColor,

String superiorIndex,String superiorFlag,

String parentGroupIndex,String passwordExpiryDate,

String passwordNeverExpires)

public String getAddUserXml(String cabinetName, String userDBId, String creationDateTime,String userName, String password,

String personalName,String familyName, String privileges,

String account, String comment,String expiryDateTime,

String companyFolderId,String limitCount,String mailId,String Fax,

String noteColor,String superiorIndex,String superiorFlag,

String parentGroupIndex)

public String getAddUserXml( String cabinetName, String userDBId,

String userName, String password,

String personalName, String familyName,

String creationDateTime, String privileges,

String comment, String account,

String deletedDateTime, String companyFolderId,

String groupList);

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 after the execution of getConnectCabinetXml call.		N/A
userName	New Name of the User.	Any String (Valid)	New User (Incremental number)
Password	New Password of the User.		Blank
personalName	First Name of the User.	Any String (Valid)	Blank
familyName	Last Name of the User.	Any String (Valid)	Blank
creationDateTime	Date and Time of Creation of the User.	Valid date in the format yyyy-mm-dd hh:mm:ss	Current Date and Time.
Privileges	Specifies the various Privileges assigned to the User.	String of seven bits, each 0 or 1 depending upon whether that particular privilege is to be given to the User or not.	No Privileges assigned to the User.
Comment	New Comments to be associated with the User.	Any String (Valid)	Null
Account	Specifies the Type of Account of the User. By default, all the Users in the System have a normal account and only the Supervisor User has System account.	0-Normal Account and 1 - Super account	0
deletedDateTime	Date and Time of deletion of the User.	Valid Date in the format yyyy-mm-dd hh:mm:ss
companyFolderId	This parameter is reserved and it can be used with the default value.	Null	Null
GroupList	List of Group Indexes of those Groups to which the User has to be added. It is generated by getGroupIndexXml.		N/A
expiryDateTime	Date and Time of expiry of the User account.	Valid Date and Time in the format yyyy-mm-dd hh:mm:ss	31/12/2090
limitCount	Specifies the maximum number of Users that can be added in the System.		No check is made for limit on number of Users
MailId	Mail id of the user.		NULL
Fax	Fax number of the user.		NULL
NoteColor	Color preference of the user.		NULL
superiorIndex	Superior index of the new user.		NULL
SuperiorFlag	Flag indicates whether superior is a User or a Role of a group.	‘U’ or ‘G’
ParentGroupIndex	Parent Group index of the new user to be added.		NULL
PasswordExpiryDate	Expiry date & time of password. (Currently Not in use).
PasswordNeverExpires	Password never expires flag indicating whether password expires or not. (Currently Not in use).	‘Y’ or ‘N’	‘Y’

Output Parameters:

An inputXml string of the NGOAddUser call.