How to set up data sources for the NetDocuments cloud collector
Introduction
This article will guide you through the specifics of creating data source paths for your NetDocuments integration. For a general guide of setting up a new data source, please refer to How to Create a Data Source.
Constructing a Valid Data Path
Basic data paths target individual cabinets. The URL is formed of three elements, <geo-location>/<repository-id>/<cabinet-id>.
An example of this is: vault.netvoyage.com/CA-309O0HSK/NG-SZPJDD0X
Obtaining the URL Elements
- Geolocation: This will from the first part of the URL when you log into NetDocuments:
- Repository ID: This can be found in the URL after going to the NetDocuments Admin Console:
- Cabinet ID: This can be seen in the URL after navigating to a cabinet in the NetDocuments UI:
Advanced Data Source Paths
Creating data source paths to folders below cabinet level requires identifying the folder IDs. It will also depend on how the cabinet is set up in terms of profile attributes that are assigned in the NetDocuments Admin Console.
Tip - For constructing more intricate data paths, it is advisable to utilize a basic text editor, like Notepad, to facilitate the creation and organization of your paths.
How to Obtain Folder IDs
- Go into a folder
- To the right-hand side of its name, click the drop-down
- In the menu that is displayed, select Edit Profile:
- The ID will be displayed in the Edit Profile window that opens:
Note - Depending on the type of folder ID you are looking at, this may be shown as Workspace ID.
Example Path Construction
Top level structure
If the requirement is to start a discovery in a specific top-level folder, such as the Exploratory folder in the image below, the constructed path would be formed as this:
vault.netvoyage.com/CA-309O0HSK/NG-6JEUBXZJ/toplevelfolders/4918-9859-6864
This is the breakdown of the data path:
| Geolocation | vault.netvoyage.com |
| Repository ID | CA-309O0HSK |
| Cabinet ID | NG-6JEUBXZJ |
| NetDocuments environment designation | toplevelfolders |
| Exploratory workspace | 4918-9859-6864 |
Should I want my start location to be a folder below the Exploratory workspace, I can simply append the folder ID to the data path URL -
Data path URL:
vault.netvoyage.com/CA-309O0HSK/NG-6JEUBXZJ/toplevelfolders/4918-9859-6864/4923-8513-6128
Workspaces - Parent / child attribute configuration
To illustrate how to construct a data path using a hierarchical folder structure, let us consider an example where the aim is to create a path to the Financial Transactions folder:
Data path URL:
vault.netvoyage.com/CA-309O0HSK/NG-JKNY60Q7/workspaces/QA Client 1/4891-1338-4950/4856-9293-0038/4862-2311-6790/4866-9340-3126
This is the breakdown of the path -
| Geolocation | vault.netvoyage.com |
| Repository ID | CA-309O0HSK |
| Cabinet ID | NG-JKNY60Q7 |
| NetDocuments environment designation | workspaces |
| Parent attribute | QA Client 1 |
| Workspace ID | 4891-1338-4950 |
| Hearing Prep folder | 4856-9293-0038 |
| Defence Evidence folder | 4862-2311-6790 |
| Financial Transactions folder | 4866-9340-3126 |
Note - This is not an exhaustive list of the possible cabinet structures within NetDocuments. If your data path requirements are different, please do not hesitate to contact your customer success representative.
Caution - The initial design of the ActiveNav Cloud NetDocuments collector has a limitation regarding visibility of some documents.
If a user chooses to delete a folder, the NetDocuments UI asks them what they would like to do with the documents that are contained in that folder. The user can choose to delete or unfile the documents.
If the documents are unfiled, the objects can only be found through the NetDocuments search function. ActiveNav Cloud does not yet perform a search for these types of document. As such, these documents will not be discovered by the ActiveNav cloud NetDocuments collector.
URL Encoding
In NetDocuments, the parent attribute key can contain the path delimiter characters \ , / and %. An example of this is shown image below:
If your NetDocuments key values contain these characters, then you will need to use URL encoding to replace these characters when constructing your data paths.
That means a path such as...
vault.netvoyage.com/CA-309O0HSK/NG-JKNY60Q7/workspaces/QA Client/US/NYC/4904-4512-2049
Would become...
vault.netvoyage.com/CA-309O0HSK/NG-JKNY60Q7/workspaces/QA Client%5cUS%5cNYC/4904-4512-2049
The table below provides some examples:
| Client Id | Encoded equivalent |
|---|---|
| Client / Id | Client %2f Id |
| Client \ Id | Client %5c Id |
| Client % Id | Client %25 Id |
| Client /% Id | Client %2f%25 Id |
| Client %25 Id | Client %2525 Id |