NetDocuments - Document Repository Configuration

Configuration Settings

As described in ShareDo Document Management Integration, each Document Management System (DMS) will have several document repositories defined.

The information below describes the settings for a matter documents repository, demonstrating the settings that can be provided when configuring this to operate against a NetDocuments location.

Key Example Value Usage / Comments
repository.matter-documents Matter documents This is the display name for the repository, what will be seen in Modeller when selecting this repository to be configured against a work item.
repository.matter-documents.context.graph workitem This tells the repository to load the work item Data Composer graph for the work item that is provided in context.
repository.matter-documents.type netdocuments Declares the underlying DMS as being netdocuments.
repository.matter-documents.serviceSystemName netdocuments Refers to the linked service that should be used to communicate to the DMS. Defaults to netdocuments. If the system name for the linked service is not netdocuments, then the linked service's system name should be provided.
repository.matter-documents.repository CA-YNMWW2E7

The identifier of the NetDocuments repository.

Can only be obtained from specific NetDocuments API calls. i.e.

GET /v1/User/cabinets

Responds with:

repository.matter-documents.cabinet NG-4F0G4N5G

The identifier for the NetDocuments cabinet.

repository.matter-documents.container workspace

This can be cabinet or workspace.

  • Cabinets are storage locations without profile attributes.
  • Workspaces are storage locations in cabinets that mandate profile attributes.
repository.matter-documents.type.container.workspaceClientProfile

{

"type": "client",

"id": "1001",

"key": "[workitem.pms-client-id]",

"description": "[workitem.pms-client-id]",

"parent": null

}

Describes the client profile for a workspace.

In the example given, the client attribute has an identifier in NetDocuments of 1001.

When we search for or create documents or folders in this workspace, we will use the values held against the work item in a custom field for pms-client-id.

This value will become the key and the description for this profile attribute.

repository.matter-documents.type.container.workspaceMatterProfile

{

"type": "matter",

"id": "1002",

"key": "[workitem.reference]",

"description": "[workitem.title]",

"parent": "1001"

}

Describes the matter profile for a workspace.

In the example given, the matter attribute has an identifier in NetDocuments of 1002.

When we search for or create documents or folders in this workspace, we will use the values held against the work item. The work item reference will be the key, and the work item title will be the description.

This will be created as a child of the 1001 attribute.

repository.matter-documents.folder [workitem.reference]

Specifies the base folder in the document library where the documents will be stored.

This example will create a folder for the work items reference field value and store all documents in this folder.

repository.matter-documents.type.expandMetadataFields true Useful where additional metadata should be retrieved from the DMS. Not usually required to be true.
repository.matter-documents.extensionBlacklist exe,com,dll Stops users from uploading files with these extensions. Files are streamed directly to the DMS. No virus scanning is done via ShareDo.
repository.matter-documents.features CreateFolders,Upload,OpenNatively,DownloadCopy,OpenRepositoryNatively,Preview,DeleteFiles,DeleteFolders,FilingEnabled,RenameFiles,ChangeFileTitles

Document repositories have many features. These features describe what a user can do with a repository. 

This can be further restricted via ShareDo permissions and their permissions in the DMS, but it should never be expanded beyond this list.

i.e. if you don't have CreateFolders here, then users will not be able to create folders.

Note on New Repository

If you are configuring this as a new repository, there is one additional key. 

Key Example Value Usage / Comments
repositories templates,instructions,matter-documents,inboundEmailStaging,printToPostRoom,scanning-repo,documentPackAttachments,documentPackEnclosures, A list of all the document repository system names. This needs to be complete, and reference all configured repositories.