Shinydocs Pro
Shinydocs Pro
Breadcrumbs

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.

    image-20250708-140016.png

  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.

    image-20250708-143350.png
    image-20250708-143416.png

Add NetDocuments to Shinydocs Pro

  1. In Shinydocs Pro Control Center, select Add source. It is on the Overview page and the Sources page.

  2. On the New tab, select NetDocuments, then select Next. To add another source to a NetDocuments connection you already set up, use the Existing tab instead.

    cc-src-26-5-picker.png

  3. Enter the connection details:

    cc-src-26-5-netdocuments-connection.png

    • Connection name: leave as is, or enter a name of your own.

    • Server URL: typically https://api.vault.netvoyage.com (filled in for you).

    • Client ID: AP-MT00CP73, the Client ID you mapped the service account to.

    • Client Secret: the secret for that Client ID.

    • Repository ID: the Repository ID you gathered, for example AB-CDE1FGH2.

  4. Under Search Authentication Type, select Protected - OAuth2, then enter:

    cc-src-26-5-auth-netdocuments-protected-oauth2.png

    • Search App Client Id and Search App Client Secret: from your Shinydocs Search app registration.

    • Login/Authorize Endpoint (https://vault.netvoyage.com/neWeb2/OAuth.aspx), Token Endpoint (https://api.vault.netvoyage.com/v1/OAuth) and Revoke Token Endpoint (optional) (https://api.vault.netvoyage.com/v1/OAuth/revoke): these are filled in for you.

    • Redirect URL: the same Redirect URL you gave the app registration, as domain and port only.

  5. Select Next. Control Center checks the connection before you continue. If something is wrong, the error says which setting to fix. A source can only be added while an agent is online.

  6. Optionally, enter the Cabinet ID of each NetDocuments cabinet you want to crawl. If you don’t enter any, every cabinet the Shinydocs service account has permission to is crawled.

  7. Optionally, select More options to set the Schedule (Daily or None), then select Return.

    cc-src-26-5-schedule.png

  8. Select Start analysis.

The new source runs the analysis set for NetDocuments connections under Settings > Analysis. To change what runs for this source, or its schedule, open it from the Sources page. See Shinydocs Pro Control Center Guide.