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
Or
Registering in iManage on-premise or private iManage cloud
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.
-
In iManage Control Center, select the Users tab and click + Create User
-
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).
-
Click Create to create the account.
-
Next, go to the Groups tab in iManage Control Center.
-
Find and select the group nrtadmin.
-
Select the Members tab for nrtadmin.
-
Click + Add Members
-
In the new panel, search for and add the previously created Shinydocs Service User
-
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
-
In Shinydocs Pro Control Center, select Add source. It is on the Overview page and the Sources page.
-
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.
-
Enter the connection details:
-
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 examplehttps://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:
c0e5d05b-f8b8-4a26-afbf-4fa6953489da. It is always the same.
-
-
Under Search Authentication Type, select Protected - OAuth2, then enter:
-
Search App Client Id and Search App Client Secret: for iManage Cloud, from iManage support; on-premise, the values 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,.../tokenand.../revoke-token). On-premise, replacecloudimanage.comwith your server. -
Redirect URL:
https://<hostname>:9701, matching a redirect URL you registered for the Search app.
-
-
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.
-
Under Library, Workspace or Folder ID (optional), choose what to analyze, using the moniker or ID. For example,
DEVis a library andDEV!242is a specific matter. Leave it blank to analyze everything the service user can see. Select Add or Add multiple for more entries.
-
Optionally, select More options to set the Schedule (Daily or None), then select Return.
-
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.
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.
-
Go to the Control Center flags page (
https://localhost:9701/flags, or your custom Control Center URL followed by/flags). Change only the flag below; other flags can break things. -
Turn on Add crumbs.
-
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.
-
When the crawl completes, a crumbs field is available in the Catalog. Add it with Columns.