NetDocuments source connector
The NetDocuments source connector uses the NetDocuments REST API. NetDocuments is a cloud-based DMS and does not have a specific version number.
Requirements
For the connector to work, a REST API application will have to be registered within NetDocuments. This has to be done by an administrator in the NetDocuments portal.
Furthermore, an application service account that is linked to the previously registered application will have to be created. This can be done in the repository's admin console by navigating to the service accounts inside users and groups.
Lastly, the application service account needs to be added as an administrator to the cabinet(s) in the cabinet administration page in the admin console.
Flows
NetDocuments (1. Content)
Supported Features
- Exporting content structure
- Exporting users and groups
This connector has been developed to be used when migrating content to NetDocuments. Therefore, some of the typical source connector features like exporting metadata, versions, access control lists and binaries are not supported.
Settings
mongoConnection
The Mongo connection string including the database name to connect to.
clientID
The client ID of the NetDocuments application.
clientSecret
The client secret of the NetDocuments application.
repositoryID
The ID of the repository where the content resides. This identifier can be found by navigating to the NetDocuments admin console and retrieving the value from the URL after <baseUrl>/neWeb2/administration.
Example: CA-AB1234CD
baseUrl
The base URL to the NetDocuments REST API.
Example: https://api.eu.netdocuments.com
The URL is determined by the region the NetDocuments repository is in.
| Region | Front-end URL | REST API URL |
|---|---|---|
| United States | https://vault.netvoyage.com | https://api.vault.netvoyage.com |
| United Kingdom | https://eu.netdocuments.com | https://api.eu.netdocuments.com |
| Australia | https://au.netdocuments.com | https://api.au.netdocuments.com |
| Germany | https://de.netdocuments.com | https://api.de.netdocuments.com |
| Australia | https://can.netdocuments.com | https://api.can.netdocuments.com |
pageSize
Specifies the page size number that is used when paginating.
Example: 250
retrieveUsers
Enables retrieving all users from the NetDocuments repository. Can either be true or false.
retrieveGroups
Enables retrieving all groups from the NetDocuments repository. Can either be true or false.
rootIds
A list of comma-separated rootIds. The following object types are supported as starting points: repository, cabinet and folder.
Example repository identifier: ["CA-AB1234CD"]
Example cabinet identifier: ["NG-AB12CD34"]
Example folder identifier: ["1234-5678-9012"]
extractionDepth
Specifies the maximum depth of objects that will be retrieved from the configured roots.
When set to -1, all objects will be retrieved and when set to 0 the root will be not be crawled.
A positive number indicates the object depth to be crawled. For example, when set to 1 only the root its direct children are retrieved.
origin
Specifies the origin of the document in the Content Store.
NetDocuments (2. Content Types)
This flow exports the metadata fields that are configured on the repository. These fields can also be found by navigating to (baseUrl)/neWeb2/administration/(repositoryId)/profileAttributes.
Furthermore, if a field is a lookup field the allowed values are also exported.
NetDocuments only supports the folder and document content types and no custom content types. The fields that are exported have their source.parentIds set to these two content types.
For lookup fields, source.parentIds reference their corresponding field.
Settings
mongoConnection
The Mongo connection string including the database name to connect to.
clientID
The client ID of the NetDocuments application.
clientSecret
The client secret of the NetDocuments application.
repositoryID
The ID of the repository where the content resides. This identifier can be found by navigating to the NetDocuments admin console and retrieving the value from the URL after <baseUrl>/neWeb2/administration.
Example: CA-AB1234CD
baseUrl
The base URL to the NetDocuments REST API.
Example: https://api.eu.netdocuments.com
The URL is determined by the region the NetDocuments repository is in.
| Region | Front-end URL | REST API URL |
|---|---|---|
| United States | https://vault.netvoyage.com | https://api.vault.netvoyage.com |
| United Kingdom | https://eu.netdocuments.com | https://api.eu.netdocuments.com |
| Australia | https://au.netdocuments.com | https://api.au.netdocuments.com |
| Germany | https://de.netdocuments.com | https://api.de.netdocuments.com |
| Australia | https://can.netdocuments.com | https://api.can.netdocuments.com |
origin
Specifies the origin of the document in the Content Store.