Rights Management Extension DSC

h2. RightsManagementExt Service

Rights Management Extension: Rights Management Extension provides additional operations to manage policies and policy users/groups. Note: This requires LC Rights Management ES component installed on the server.

h3. Operation Title: Add or Update Principal (User/Group) to Policy   (addOrUpdatePrincipalToPolicy)

Add or Update Principal (User/Group) to Policy: Adds or updates a principal with permissions set to a policy. If the specified principal already exists, it will perform update.
|| Input Parameter || Type || Description ||
| Policy Set Name | java.lang.String | The policy set name. Type: String |
| Policy Name | java.lang.String | The policy name. Type: String |
| Principal ID | java.lang.String | The principal ID of the user or group. Use "Lookup" operation to get the principal ID for the user/group prior to this step. Type: String |
| Always Valid | boolean | Whether the principal permission to the policy is always valid. Note: if this is selected, it will ignore the date values specify the validity period. Type: boolean |
| Valid From | java.util.Date | The start date for the principal to have permission on the policy. Note: This value will be ignored, if "Always Valid" is selected. Type: Date |
| To | java.util.Date | The termination date for the principal to no longer have permission on the policy beyond this date. Note: This value will be ignored, if "Always Valid" is selected. Type: Date |
| Allow View Offline | boolean | Allow the principal to view policy protected document offline. Type: boolean |
| Print Permission | java.lang.String | Printing permission on policy protected document. Type: String |
| Modification Permission | java.lang.String | Modification permission on policy protected document. Type: String |
| Allow Copy Content | boolean | Allow the principal to copy protected document content. Note: if this is selected, it will also allow screen reader regardless whether allow screen reader is selected or not. Type: boolean |
| Allow screen reader | boolean | Allow the principal to use screen reader on policy protected document for the visually impaired. This is automatically included if principal is allowed to copy content on the policy. Type: boolean |

|| Output Parameter || Type || Description ||
| Result | int | Process variable to store the result of this operation. Returns 0, if it failed to add or update principal to permission; returns 1, if the principal is added; returns 2, if the principal has already existed and permission updated. |

h3. Operation Title: Remove Principal (User/Group) From Policy   (removePrincipalFromPolicy)

Remove Principal (User/Group) From Policy: Removes a principal from a policy.
|| Input Parameter || Type || Description ||
| Policy Set Name | java.lang.String | The policy set name. Type: String |
| Policy Name | java.lang.String | The policy name. Type: String |
| Principal ID | java.lang.String | The principal ID of the user or group. Use "Lookup" operation to get the principal ID for the user/group prior to this step. Type: String |

|| Output Parameter || Type || Description ||
| Result | boolean | Process variable to store the result of the principal removal from the policy. Returns true if the principal is successfully removed from the policy, otherwise it returns false. |

h5.

{panel:borderStyle=solid}
For how to configure license information for this component service - Rights Management Extension, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]

Please send us any questions or comments on this documentation regarding Rights Management Extension by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: Rights Management Extension]
{panel}