Introduction on setting up credentials, service account and other useful settings for the NetDocuments cloud collector
Overview
Adding NetDocuments credentials differs from other repository types insofar as the setup will be performed by the ActiveNav customer success team. Once this has been configured, we will provide you with the details that you will need to use in your NetDocuments setup.
First Steps
Once you have discussed your requirements with our team, they will begin the application registration process with NetDocuments.
During your discussions with ActiveNav, it is important for us to know if you have NetDocuments data sources in multiple geographic locations as this will affect how we register your application.
If you are unsure of the geographic location, check the URL of your NetDocuments instance in the table below.
Location | Short Code | URL |
United States | US | https://vault.netvoyage.com/ |
United Kingdom (European Union) | EU | https://eu.netdocuments.com/ |
Australia | AU | https://au.netdocuments.com/ |
Germany | DE | https://de.netdocuments.com/ |
Canada | CA | https://can.netdocuments.com/ |
Creating a Service Account
Once your application has been registered, customer success will contact you with your Client ID. Use this to set up a service account user, which allows ActiveNav Cloud permission to integrate with your cabinets.
To create the service account user, you should follow these steps:
- Log into your NetDocuments instance as a repository administrator.
- Click on your name and select Admin
- In the left-hand side menu, select Users & Groups -
- Press the Add User button and enter an email address
- On following screen, enter appropriate details and ensure:
- User Type is Internal
- Repository Admin Type is Non-Admin
- In Other Options, Non-Interactive Application Service Account should be selected:
- Press Save
- Select the Service Accounts tab
- Select the user just created and press Edit
- In the Application ID field, the Client ID provided by ActiveNav should be
entered: - Press the Create Mapping button
- Press Save
Important - It should be noted that the user selected as the Service Account will no longer be able to log in to the NetDocuments UI. It is therefore recommended that a service account user is created explicitly for ActiveNav Cloud integration.
Assigning Service Account User to Cabinets
Once the service account user has been created, it must be assigned to all cabinets that are to be part of the integration.
To assign the service account user to a cabinet, follow these steps:
- Log into the NetDocuments instance as a Repository Administrator
- Click on your name and select Admin
- On the left-hand side, select Cabinets
- Click on the cabinet that is to be modified and wait for the cabinet page to load
- Scroll to the Cabinet Administrators section and move the newly created service account into the administrators list box
- Click the Submit button at the bottom of the page
If it is not desirable for your organization to assign the service user account as a cabinet administrator, you can alternatively assign it to a group. These can be created in the Users & Groups page.
When inside the cabinet admin page, you can add the group under Cabinet Security. Your group should be assigned at least the View (V) access level.
Caution - When assigning the service account using the groups method, it is possible that some content may not be found due to to any deliberate breaking of permissions inheritance within that cabinet.
For further information, see the NetDocuments support article Understanding Access Rights Inheritance.
ActiveNav Credentials
Once the customer success team completes your initial setup, you will see your NetDocuments credentials in ActiveNav Cloud by navigating to System > Credentials. Note that there is no Actions menu for NetDocuments credentials as they are managed by our customer success team. If you encounter any issues with these, please reach out to the team.
Note - If you have NetDocuments instances in different geolocations, you will have a set of credentials for each locations.
Useful Information in NetDocuments Admin Console
- On most pages of the Admin Console, the page URL will contain your repository ID. The URLs will look something like this:
https://vault.netvoyage.com/neWeb2/administration/CA-197J0RSK/cabinets/dashboard
Where the value is 'CA-197J0RSK', this is your unique repository ID, which is required when constructing the data paths for your NetDocuments data sources.
- In the Admin Console's Information and Settings page, it is highly recommended to increase the value of Activity Threshold. This will prevent NetDocuments administrators from receiving frequent warning emails during discoveries on large repositories.