Set ACL

 

Function Name: getSetACLXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This call is used to set rRights for a User or a gGroup on any oObject like dDocument, fFolder, aAnnotation or cCabinet. This call will consider the lList sent as the final lList and will overwrite the previous existing rRights on that oObject. It takes objectindex, objecttype (Cabinet, Document, Folder, Annotation, DataDefinition) and set of Acl lList. An Acl contains information about User or gGroup the includeing iIndex of the User (or gGroup), tType (User or Group) and 6 digit6-digit rRights string. This call can be used efficiently when the User wants to set rights Rights for multiple Users and groups Groups on an object Object.

 

Input Parameter

Sample InputXml

Output Parameter

Sample OutputXml

View xml API:: NGOSetAcl

 

 

Prototype:

public String getSetACLXml(String cabinetName, String userDBId,

String objType, String objId, String retainPrev,

String userGroupAcls, String logGeneration)

Overloaded Function

public String getSetACLXml(String cabinetName, String userDBId,

String objType, String objId, String retainPrev,

String userGroupAcls)

 

Input Parameters:

Name

Description

Valid Values

Default

Values

CabinetName

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

 

N/A

UserDBId

UserDatabase ID that is returned in the NGOConnectCabinet call.

 

N/A

ObjectType

Information about the Type of the Object on which the Rights are assigned.

‘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

RetainPrevious

ACL

User wants to retain the previous ACL.

‘X’-Retaining previous Acl, i.e. append this Acl to the previous one

‘Y’ – do not retain previous Acl i.e. replace the previous ACL

‘N’

LogGeneration

Whether log has to be generated or not.

‘Y’ – Yes

‘N’ - No

 

UserGroupACLs

It contains information about the User or Group to whom Rights are to be assigned. It can be obtained from getUserGroupACLList call.

 

N/A

LogGeneration

Whether log has to be generated or not.

‘Y’ – Yes

‘N’ - No

 

 

Output Parameters:

Input Xml of call NGOSetACL.