Shinydocs Pro

Configure Shinydocs Pro Control Center for 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

iManage registers applications for iManage Cloud through its OAuth application request form. Submit the form twice: once for Shinydocs Control Center and once for Shinydocs Search. Replace <shinydocs-search-server> with the name of the server hosting Shinydocs Pro.

  1. Sign in to the iManage Help Center with your iManage support account and open the iManage OAuth application request form.

  2. Submit a request for Shinydocs Control Center:

    • Customer name: your organization’s name.

    • Customer ID: your iManage customer ID. If you have more than one environment, for example production and test, give each environment’s ID.

    • Request type: New Application Creation Request.

    • Application origin: Tech Partner Universal Application.

    • Known Technology Partner Organizations/Addins: Shinydocs Pro.

    • Application name: Shinydocs Pro.

    • Application type: Native type.

    • Application description: iManage analyzer.

    • Client ID (if the form asks for one): c0e5d05b-f8b8-4a26-afbf-4fa6953489da.

    • OAuth2 redirect URLs: none.

    • App Extension package attached: n/a.

  3. Submit a second request for Shinydocs Search:

    • Customer name: your organization’s name.

    • Customer ID: your iManage customer ID. If you have more than one environment, for example production and test, give each environment’s ID.

    • Request type: New Application Creation Request.

    • Application origin: Tech Partner Universal Application.

    • Known Technology Partner Organizations/Addins: Shinydocs Pro.

    • Application name: Shinydocs Pro Search.

    • Application type: Web type.

    • Application description: App is used to authenticate users to check permissions when searching our local index.

    • 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

    • App Extension package attached: n/a.

iManage support replies with a client ID and secret for Shinydocs Search. Shinydocs Control Center always uses the client ID c0e5d05b-f8b8-4a26-afbf-4fa6953489da, so you don’t need one from iManage for it.

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

  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 iManage, then select Next. To add another source to a iManage 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-imanage-connection.png
    • Connection name: leave as is, or enter a name of your own.

    • Server URL: for iManage Cloud, https://cloudimanage.com. For on-premise, your iManage server URL, for example https://yoururl.com.

    • Username: the service user you created. It must be an email address, even if the address is not a real mailbox. On-premise, if the email address doesn’t work, try just the username.

    • Password: the service user’s password.

    • Client ID: for iManage Cloud, c0e5d05b-f8b8-4a26-afbf-4fa6953489da. On-premise or private cloud, the client ID you entered when you registered the Shinydocs Control Center application.

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

    cc-src-26-5-auth-imanage-protected-oauth2.png
    • Search App Client Id and Search App Client Secret: for iManage Cloud, from iManage support; on-premise, the client ID you entered and the secret generated when you registered the Shinydocs Search app.

    • Login/Authorize Endpoint, Token Endpoint and Revoke Token Endpoint (optional): filled in with the iManage Cloud addresses (https://cloudimanage.com/auth/oauth2/authorize, .../token and .../revoke-token). On-premise, replace cloudimanage.com with your server.

    • Redirect URL: https://<hostname>:9701, matching a redirect URL you registered for the Search app.

  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. Under Library, Workspace or Folder ID (optional), choose what to analyze, using the moniker or ID. For example, DEV is a library and DEV!242 is a specific matter. Leave it blank to analyze everything the service user can see. Select Add or Add multiple for more entries.

    cc-src-26-5-imanage-source.png
  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 iManage 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.

Before you change a feature flag. Feature flags are on their own page, https://localhost:9701/settings/flags (or your Control Center address followed by /settings/flags). They aren’t in the Settings menu, and a change saves straight away. A flag applies to every user, and some flags can change or remove data. Turn on only the flags a Shinydocs guide or Shinydocs Support tells you to, and leave the rest at Default. Don’t select Reset all: it also switches off flags you turned on.

Optional: capture iManage crumbs (feature flag)

Shinydocs Pro can capture each item’s crumbs (its location path in iManage) during the crawl. This can greatly increase crawl time.

  1. Go to the Control Center flags page (https://localhost:9701/settings/flags, or your Control Center address followed by /settings/flags).

  2. Turn on Add crumbs.

  3. For a source that has already been analyzed, open it from the Sources page, select the arrow next to Run now, and select Full crawl only. If an analysis is running, let it finish or stop it first.

  4. When the crawl completes, a crumbs field is available in the Catalog. Add it with Columns.

Change the password or client secret

Control Center signs in to iManage as the service user, with its Username and Password. When that password changes, for example under your password policy, update it in Control Center straight away: crawls can’t sign in until you do. Control Center doesn’t warn you before a credential expires, so note each expiry date when you create the credential and plan to renew it a few weeks ahead.

In Control Center

  1. Go to Sources, find the group for the connection, and select Edit. You can also go to Settings > Connections, choose the connector, and select Edit connection.

  2. In Password, delete the asterisks (**********) and enter the new value. If you leave the asterisks, Control Center keeps the old value.

  3. Select Save changes. Control Center checks the new credential through an agent before saving, so an agent must be running. If the check fails, nothing is saved and the dialog shows the error.

The change applies to every source that shares the connection. Crawls that start after you save use the new credential, and nothing needs to change on the agents. To check the connection again later, select Run tests in Settings > Connections.

If the password is wrong, Control Center shows: The client ID ‘…’ or password provided was rejected.

Search sign-in secret. If the source uses Protected - OAuth2 for Search, replace its Search App Client Secret the same way, under Search Authentication Type in the same dialog. Control Center doesn’t check this secret when you save, so sign in to Search afterwards to make sure it works.

Get a new Search app secret the same way you got the first one: from iManage support for iManage Cloud, or from your own application registration for iManage on-premise or private cloud (see Step 1 - iManage Set Up).