{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":47315,"path":"servicenow-platform/document-management-services/r_ManagedDocumentsPlugin.md","title":"Managed Documents plugin","bundle":null,"doc_type":null,"release":"australia","body":"\n# Managed Documents plugin\n\nThis page describes the applications and modules, database table structure, scripts, and roles.\n\n## Database table structure\n\nThe following tables are added:\n\n|Display Name \\(Table Name\\)|Description|\n|---------------------------|-----------|\n|Document \\[dms\\_document\\]|The document details.|\n|Revision \\[dms\\_revision\\]|The document revisions.|\n|Audience \\[dms\\_audience\\]|The intended document readers.|\n|Classifications \\[classification\\]|The document restriction level, such as public or confidential. \\(Does not define access to the document. Document security is set in user and group permissions.\\)|\n|Type \\[dms\\_type\\]|The document purpose.|\n|Component \\[dms\\_component\\]|The components of name formats. The value field is a dot-walking expression that is evaluated. An exception is made for the revision because it does not exist when the revision name is generated.|\n|Name format \\[dms\\_name\\_format\\]|The composition of components to generate revision names.|\n|Approval sequence \\[approval\\_sequence\\]|The approval sequences that users must follow.|\n|Approval Rule \\[dms\\_approval\\_rule\\]|The criteria that records of the dms\\_document table must match. Used to automatically add approvers to a document.|\n|Collection \\[dms\\_collection\\]|The document groups created by the user.|\n\n## Scripts\n\n|Rule|Description|\n|----|-----------|\n|Update Document|Changes the state of a document depending on its revisions.|\n|Add Approvers|Populates the list of approvers in the document.|\n\n|Script include|Description|\n|--------------|-----------|\n|DocumentManagement|Contains the main logics for the Managed Documents plugin.|\n|DocumentManagementDB|Contains methods to perform CRUD operations on the database.|\n|DocumentManagementSecurity|Helps manage the security of the Managed Documents system.|\n|DocumentManagementAjax|Updates the details of the temporary revision that is created when opening the upload/check in revision form.|\n|DocumentAttachmentAjax|Renames an attachment file.|\n|DocumentRevisionWorkflowHelper|Helps perform basic workflow operations on a revision.|\n|DocumentManagementApprovalMatcher|Helps obtain the user and group approvers for a document that matches approval rules.|\n|DocumentApproverHelper|Contains logics to handle document approvers.|\n|DocumentManagementUtils|Useful methods.|\n|DocumentReferenceQualifiers|Static methods that return reference qualifiers.|\n\n|Rule|Description|\n|----|-----------|\n|Document type change|Updates the name format field in the revision settings section of the document. Each type has a default name format.|\n\n## Roles\n\nThis plugin introduces two new roles:\n\n|Role|Description|\n|----|-----------|\n|document\\_management\\_user|This role enables a user to access the Managed Documents plugin, create documents, and search for documents. Document reviewers and approvers need the document\\_management\\_user role to access the Managed Document plugin. \\(Please note that reviewers and approvers can also access a document revision from an approval record.\\)|\n|document\\_management\\_admin|This role enables a user to change administrative settings for the Managed Documents plugin.|\n\n**Note:** Each document has individual permissions, so even if a user is given the document\\_management\\_user role and has permissions to the application, the user can only view documents to which they have been given access.\n\n-   **[Install the Managed Documents plugin](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/document-management-services/t_InstallTheManagedDocumentsPlugin.md)**  \nThe Managed Documents plugin is available for activation by users with the admin role.\n\n**Parent Topic:**[Managed Documents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/document-management-services/c_ManagedDocuments.md)\n\n"}}