Function Name: getSetRightsXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to set Rights of a User or a Group on a particular Object like Cabinet, Folder, Document, Data Definition or Annotation. This call takes objectindex, object type(Cabinet, Document, Folder, Annotation), UserAcl and TypeOfProcess(Add, Modify, Delete).
|
Prototype:
public String getSetRightsXml(String cabinetName, String userDBId,
String objType, String objId,
String typeOfProcess,String makerCheckerFlag,
String userGroupIndex,String userGroupType,
String rights, String logGeneration)
Overloaded Function:
public String getSetRightsXml(String cabinetName, String userDBId,
String objType, String objId,
String typeOfProcess,String makerCheckerFlag,
String userGroupIndex,String userGroupType,
String rights)
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 |
objectType |
Information about the Type of the Object on which the Rights are being set.. |
‘C’- Cabinet, ‘D’-Document, ‘F’-Folder, ‘A’-Annotation ‘T’ – Data Class |
N/A |
objectId |
Index of the Object on which Rights are being set. |
Integer >= 0 |
N/A |
typeOfProcess |
It specifies the Type of the Process whether the process is addition of Rights or modification of an existing Right. |
‘A’-Add ‘M’-Modify, ‘D’-Delete
|
N/A |
makerCheckerFlag |
Not used. |
|
|
userGroupIndex |
Index of the User or Group. |
Integer >= 0 |
N/A |
userGroupType |
User or Group. |
U-User G-Group |
N/A |
rights |
6 digit Rights string like 010000. |
|
N/A |
logGeneration |
Whether log would be generated or not. |
‘Y’ – Yes ‘N’ – No |
|
Input Xml of call NGOSetRights.
Function Name: getSetACLXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to set Rights for a User or Group on any Object like document, Folder, Annotation or Cabinet. This function will consider the List, sent as the Final List and will overwrite the existing Rights on that Object. It takes objectindex, objecttype (Cabinet, Document, Folder, Annotation, Data definition) and set of ACL List. An ACL contains information about User or Group that includes Index of the User (or Group), type (User or Group) and 6-digit Rights string. This function can be used efficiently when User wants to set Rights for multiple Users and Groups on an Object.
|
Prototype:
public String getSetACLXml(String cabinetName, String userDBId,
String objType, String objId,
String retainPrev,String userGroupAcls)
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 |
objectType |
Information about the Type of the Object on which the Rights are being set.. |
‘C’- Cabinet, ‘D’-Document, ‘F’-Folder, ‘A’-Annotation ‘T’-DataDefinition |
N/A |
objectIndex |
Index of the Object on which Rights are being set. |
Integer >= 0 |
N/A |
retainPrev |
User wants to retain previous ACL. |
‘Y’-Retaining previous ACL ‘N’ – do not retain previous ACL |
‘N’ |
userGroupAcls |
List of Rights ACL’ which contains Rights information of the User or Group. This List can be generated using the function |
|
|
Input Xml of call NGOSetAcl.