Shinydocs Pro
Shinydocs Pro
Breadcrumbs

Configure Shinydocs Pro Control Center in iManage

:light_bulb_on:

When Shinydocs Pro analyzes your iManage content, you'll see Export activity from the configured Shinydocs user. This process allows Shinydocs Pro to capture text data for searchability, PII identification, and various other analysis operations.

Shinydocs Pro supports iManage Server 10.2.x and higher for legacy iManage systems.

You must be an Administrator (NRTADMIN) in iManage Cloud to register an application. 

Requirements

  • The server Shinydocs is installed on will require internet access to reach iManage.

Step 1 - iManage Set Up

Register the application

You will need to register the Shinydocs application to be used in your iManage instance. You probably have iManage Cloud, but if you have on-premise or use a managed private cloud provided by iManage, we have you covered.

You only need to do one of these configurations, based on what your iManage:

Registering in iManage Cloud

iManage Cloud

If you are a multi-tenant iManage customer, you will need to reach out to appregistration@imanage.com to register the application.

In this step, you will be registering both the Shinydocs Control Center and Shinydocs Search with iManage.

iManage support should reply with a client ID and secret key for the Shinydocs Search application only, the Shinydocs Control Center registration does not require a client Id from iManage, use the provided Id below.

You will need to provide iManage with the information below. Replace <shinydocs-search-server> with the name of the server hosting Shinydocs Pro.


iManage requires you to submit any changes to the redirect URLs as you change them (e.g. changing hostname to fully qualified domain name). iManage offers a request form available: https://help.imanage.com/hc/en-us/articles/43278130849051-iManage-OAuth-application-request-form
Note: an iManage support account is required to access the above link.

Hello,

We would like to register two Shinydocs applications in our iManage tenant. Here is the information about the app for the registration:

Application #1

Name: Shinydocs Pro

Description: iManage analyzer 

Client ID: c0e5d05b-f8b8-4a26-afbf-4fa6953489da

Publisher: Shinydocs Corporation


Application #2 (Custom Application)

Name: Shinydocs Search

Publisher: Shinydocs Corporation

Description: App is used to authenticate users to check permissions when searching our local index

Type: Web

Allow Refresh Token: Yes

OAuth2 redirect URLs: 

  • https://<shinydocs-search-server>:443/oauth/authorized

  • https://<shinydocs-search-server>:9701/oauth/authorized

  • https://localhost:9701/oauth/authorized

  • https://localhost:443/oauth/authorized

Thank you

Or

Registering in iManage on-premise or private iManage cloud

Registering in iManage on-premise or private iManage cloud

iManage requires you to submit any changes to the redirect URLs as you change them (e.g. changing hostname to fully qualified domain name).

  1. Log in to iManage as an Administrator account. 

  2. Follow iManage’s documentation for Adding a package manually (https://docs.imanage.com/cc-help/10.4.3/en-US/Adding_Apps.html#src-125070565_id-.AddingAppsv10.4.0-Configuringapackage ) 

    1. First application registration details 
      Name: Shinydocs Control Center

      Description: iManage analyzer 

      Client ID: c0e5d05b-f8b8-4a26-afbf-4fa6953489CC

      API Secret: select Auto-Generate 

      Publisher: Shinydocs Corporation 

      Website: http://www.shinydocs.com  

      Email: helpdesk@shinydocs.com 

      Type: Native 

    2. Second application registration details
      Name: Shinydocs Search

      Description: Shinydocs iManage Search Integration 

      Client ID: c0e5d05b-f8b8-4a26-afbf-4fa6953489SE

      API Secret: select Auto-Generate 

      Publisher: Shinydocs Corporation 

      Website: http://www.shinydocs.com  

      Email: helpdesk@shinydocs.com 

      Type: Web
      Allow Refresh Token: Yes
      OAuth2 redirect URLs: 

      • https://<shinydocs-search-server>:443/oauth/authorized

      • https://<shinydocs-search-server>:9701/oauth/authorized

      • https://localhost:9701/oauth/authorized

      • https://localhost:443/oauth/authorized

  3. For the Shinydocs Search application registration, you will get a client Id and a secret key for the registration

Create the service user

The iManage user must have these options configured in iManage Control Center

  • Is a virtual user

  • Has an email address

    • The email address does not need to be valid, but will be used for authentication.
      Note for iManage On-Premise customers:
      We have found an inconsistency with iManage on-premise APIs, if using the email address of the virtual user does not work (e.g. svc_shinydocs@shinydocs.com) try to authenticate in Shinydocs Pro with just the username.

  • To analyze Private files in iManage, the Shinydocs service account will need to be a member of the NRTAdmin group.

  1. In iManage Control Center, select the Users tab and click + Create User

    image-20251008-201040.png

  2. Fill in the required information, remember that the user must be Virtual (created in iManage, not your Active Directory) and have an email address (though it does not need to be valid).

    image-20251008-201322.png

  3. Click Create to create the account.

  4. Next, go to the Groups tab in iManage Control Center.

  5. Find and select the group nrtadmin.

  6. Select the Members tab for nrtadmin.

  7. Click + Add Members

  8. In the new panel, search for and add the previously created Shinydocs Service User

  9. Congratulations! You have registered the account Shinydocs will use to analyze your iManage content. You will use the new account in the next step.

Step 2: Set up iManage Source in Shinydocs Pro

Once you have iManage configured, the next step is to add the source in Shinydocs Pro.

By default, iManage does not provide path information (crumbs) when gathering information about your iManage content. We have a new feature in early access that will allow Shinydocs Pro to get the crumbs from iManage during the Crawling content step. To enable this feature:

Note: Due to how iManage’s API works, additional API calls need to be made to get crumb information. This can greatly increase the time for the Crawling content step.

  1. Navigate to Shinydocs Pro Control Center flags page (https://localhost:9701/flags) in your browser
    IMPORTANT!
    You can break things in /flags! We do not recommend changing any setting on this page unless instructed to by Shinydocs.

  2. Enable Add iManage crumbs

    image-20241219-184826.png

    1. If you've previously analyzed an iManage source with Shinydocs Pro and now wish to include crumb data in your analysis, ensure the Advanced Sources Control flag is enabled in addition to Add iManage crumbs.

      image-20241219-185147.png

    2. If an analysis is currently running, you can let it finish or end it.

    3. Navigate to Sources > Select your iManage source title > click Re-crawl Only. Shinydocs Pro will only perform the Crawling content step and skip the other steps. The other steps will run in the next scheduled run.

      image-20241219-185420.png

    4. Allow the crawl to complete

  3. Now you will have a new field called crumbs in your catalog. You can enable this column along with many others with the View button.

  1. In Shinydocs Pro Control Center, click + Add Source

    1. If this is your first source, you will already be in the Add Source wizard

  2. Select iManage from the list of options

  3. Input the required connection information:

    image-20251014-182038.png

    1. Server:
      iManage cloud: https://cloudimanage.com
      iManage on premise/legacy cloud: https://yoururl.com

    2. Username: The username of the iManage account
      (must be an email address, even if it is invalid)

    3. Password: The password for the supplied account

    4. Client ID: c0e5d05b-f8b8-4a26-afbf-4fa6953489da (this is the client id for Shinydocs Pro from iManage, it is always the same)

  4. Set Search Authentication Type to Protected - OAuth2

    image-20250707-185933.png

    1. Search App Client Id:

      1. iManage cloud: The client ID received from iManage support.

      2. iManage on-premise: The client Id will be generated during the application registration.

    2. Search App Client Secret:

      1. iManage cloud: The client secret received from iManage support.

      2. iManage on-premise: The client secret will be generated during the application registration.

    3. Login/Authorize Endpoint:

      1. iManage cloud: https://cloudimanage.com/auth/oauth2/authorize

      2. iManage on-premise: https://<iManage>/auth/oauth2/authorize

    4. TokenEndpoint:

      1. iManage cloud: https://cloudimanage.com/auth/oauth2/token

      2. iManage on-premise: https://<iManage>/auth/oauth2/authorize

    5. Revoke Token Endpoint:

      1. iManage cloud: https://cloudimanage.com/auth/oauth2/revoke-token

      2. iManage on-premise: https://<iManage>/auth/oauth2/authorize

    6. Redirect URL:
      https://<hostname>:9701

  5. Click Next

  6. Now you can choose to analyze a specific iManage library, workspace, or folder using the moniker or ID.

    image-20241219-204701.png

    DEV!242 is an example value for a specific matter in iManage

    image-20241219-205019.png

    DEV is an example value for a library

More options

In Shinydocs Pro 26.1+, administrators can now by default select which analysis tools will run on the source.

image-20260313-130327.png

  • Extracting digital and image content reads file contents, including images, for analysis.

    • Digital fingerprint (Hash): creates a unique identifier for each file to detect exact duplicates.

    • Text Extraction: extracts readable text from documents for searching and analysis (includes OCR).

  • Tag duplicate: marks files as duplicates based on their digital fingerprint across all Shinydocs Pro sources.

  • Identifying people, places and organizations: detects mentions of people, locations, and organizations within document content.

  • Identifying content with personal information: scans for personally identifiable information like names, addresses, and social insurance/security numbers (PII).

  • Identifying non-valuable content: flags redundant, obsolete, or trivial (ROT) content to identify cleanup candidates.

  • AI Analysis Tool (license dependent, requires setup before use): employs AI for deeper content classification beyond rules.

  • Schedule: controls how often analysis tasks run. "Daily" runs them once per day.

Click Start analysis to begin. Congratulations!