Configure Shinydocs Pro Control Center access for NetDocuments

Requirements

• A NetDocuments account with administrator rights

• Internet connection

• Shinydocs Pro installed

Creating a Shinydocs Service Account in NetDocuments

Creating and Mapping the Service Account

NetDocuments requires an internal service account that is mapped to the Shinydocs application.

1. In the NetDocuments Admin Console, select Users & Groups.

2. Click Add User.

3. In the Add User popup, enter the email address for the new service account user and click OK.

4. In the Details tab, enter the required details and any additional details you would like to add to the account. Then, select these options near the bottom of the window:

   1. User type: Internal

   2. Repository admin type: Full

   3. Other options: Non-Interactive Application Service Account

5. Click the Save button.

6. Navigate to the Service Accounts tab in Users & Groups and click the Create Service Account button.

7. Enter the email address you provided in Step 3, and click the Create button.

8. Enter the Client ID: AP-MT00CP73 and click the Create Mapping button.

9. Click the Save button.

10. On the NetDocuments Cabinets page, select the cabinet to map to the service account

    1. You will need to repeat this process for each cabinet you want to analyze

11. Go to the Cabinet Administrators and add the service account you created as a cabinet administrator.

12. Ensure the created service account has DEFAULT rights to your selected cabinet.

Gather your NetDocuments Repository ID

With the application registered and the service account created and mapped, you will need to gather your NetDocuments Repository ID. This ID will be used in the Shinydocs Pro NetDocuments configuration.

1. In the NetDocuments Admin Console, go to Information and Settings

2. In the General section, copy the ID displayed (ex. AB-CDE1FGH2), which is your NetDocuments Repository ID.

Shinydocs Pro can analyze all cabinets it has access to or you can provide specific Cabinet IDs. If you want to use Cabinet IDs, gather those now.

NetDocuments Search App Registration

To register the Search application with OAuth support, you will need to add a new application to your NetDocuments Support account. NetDocuments needs to manually approve the application which can take 15-20 minutes.

1. Login to NetDocuments Support and go to the developed applications section (Developed Applications)

2. Click New Application.

   

3. Fill out the following information in the Application Information fields:

   1. Application Name: Shinydocs Search

   2. Service: Vault

   3. Application Type: Rest

   4. Client Type: Confidential (Supports Authorized Code Grant flow)

   5. Description: Shinydocs Search application

   6. Redirect URI: Replace <ShinydocsServerHostname> with your Shinydocs Server hostname or FQDN
      https://<ShinydocsServerHostname>:9701/oauth/netdocuments/authorized

   7. Additional Redirect URIs:

      1. urn:ietf:wg:oauth:2.0:oob

      2. ndoffice://OAuthCallback

      3. https://oauth.pstmn.io/v1/browser-callback

      4. https://localhost:9701/oauth/authorize

      5. Replace <ShinydocsServerHostname> with your Shinydocs Server hostname or FQDN
         https://<ShinydocsServerHostname>:9701/oauth/authorized

4. Click Submit for Approval.

5. You will need to wait for the application to be approved by NetDocuments. Once approved, you will be able retrieve the Client Id and Client Secret.

   

   

Add NetDocuments to Shinydocs Pro

Once you have created the Shinydocs Service Account in the NetDocuments Admin Console, and mapped it to the cabinets you wish to analyze, you are ready to make the connection and start analyzing your content.

1. In either Quick-Start or + Add Source, select NetDocuments as your source

2. On the next page, Shinydocs Pro will ask you for the following information
   

   

   Name: Provide a name for the source, this name will be used in Shinydocs Pro to differentiate from other sources.
   Server Url: Enter the URL for NetDocuments, this is typically https://api.vault.netvoyage.com
   Client Id: AP-MT00CP73
   Client Secret: DvMnrCCHfPCeVbyKqyrJ2MovRWy2k5Nu53mYx9aQb9p5EOOr
   Repository ID: Your NetDocuments Repository ID
   Example: AB-CDE1FGH2

3. Select Protected - OAuth2 in the Search Authentication Type field

   

4. Enter the following values

   1. Search App Client Id: <Client Id from approved app registration>

   2. Search App Client Secret: <Client Secret from approved app registration>

   3. Login/Authorize Endpoint: https://vault.netvoyage.com/neWeb2/OAuth.aspx

   4. Token Endpoint: https://api.vault.netvoyage.com/v1/OAuth

   5. Revoke Token Endpoint: https://api.vault.netvoyage.com/v1/OAuth/revoke

   6. Redirect URL: The same Redirect Url provided to the app registration (e.g. https://<ShinydocsServerHostname>:9701/oauth/netdocuments/authorized)

5. Click Next

6. Optionally, enter the Cabinet ID of the NetDocuments cabinet you wish to crawl. If you do not enter an ID, all cabinets will be crawled where permissions are granted to Shinydocs.

7. Click Start Analysis to begin the crawl.

8. Congratulations, you have connected Shinydocs Pro to your NetDocuments repository! Your crawl will be added to the queue or will start crawling immediately