iManage setup

Your iManage account needs to have an iManage support account. It also needs to be connected to Collect.

To get an iManage support account, see the iManage instructional information. For further guidance, reach out to iManage. To create a ticket with iManage, see help.imanage.com. You can also email General support, Technical issues and resources, and API support and Developer technical questions.

This page contains the following information:

Authentication

To set up an application, you need to have the ability to add and edit applications. The Client Secret will be provided by iManage or through the Universal App Registration. Assuming you have these permissions, follow the steps below to get your Client ID:

  1. In the Applications pane, navigate to the Control Panel.

  2. Select Add Application

  3. Select the application you wish to add and set up the application accordingly. If the VerQu Universal App is not listed, iManage support will need to create an app for you.

  4. Once you have complete setting up the app, click on the application in the Applications Explorer.

  5. Click View and the Client ID will be displayed in the application view. The Client Secret is not visible in iManage. If you're using the Universal app, the secret can be obtained form secret server, otherwise you will need to get the secret from iManage support.

Permissions

Permissions are based off the account you use to authenticate with the iManage API. This account username and credentials are located in the configuration file under the settings Username and Password. The module will only be able to discover items that the account specified by username has access to.

Throttling

We handle throttling by reading the response headers for each API call Relativity makes for the header x-ratelimit-remaining. When that header value returns 0, we look for another header value called x-ratelimit-reset. The x-ratelimit-reset value specifies the amount of time in seconds to wait until we no longer need to. After the wait has been completed, the module will then retry the API call that it was throttled for.

Search filters

The following search filters are available:

Name Description
Extension Exclusions Types of files to exclude. The exclusion list has priority so if the same extension is in both lists the item will be excluded.
Extension Inclusions Types of files to include.
Operator Filters documents based on the user ID of the operator of the documents.
Author Filters documents based on the user ID of the author of the documents.
Create Date From Filters documents created on or after this date. The date must be in ISO 8601 format. The Create Date From must be less than the Create Date To if both filters are included.
Create Date To Filters documents created on or before this date. The date must be in ISO 8601 format. The Create Date To must be greater than the Create Date From if both filters are included.
Recipient Filters documents based on the text that appears in recipient field of emails. Email addresses only.
Received Date From Filters emails received on or after this date. The date must be in ISO 8601 format. Specifies to search for emails received on or after this date.
Received Date To Filters emails received on or before this date. The date must be in ISO 8601 format. Specifies to search for emails received on or before this date.
Sent Date From Filters emails sent on or before this date. The date must be in ISO 8601 format. The Send Date From must be less than the Create Date To if both filters are included.
Sent Date To Filters emails sent on or after this date. The date must be in ISO 8601 format. The Send Date To date must be greater than the Send Date From date if both are included.
Subject Filters emails based on the matching text found in the email subject.
Body Filters documents based on the matching text found in a document's content.
Sender Filters documents based on the text that appears in the sender field of emails. Use email addresses only.
Anywhere Filters documents based on the matching text found anywhere in the document's profile or its contents. Use this when searching for parts of email addresses.
Limit Specifies the maximum number of items to return per page. The default is 25 and the max is 9999.

Settings

This section shows the different settings for Discovery.iManage and Delivery.iManage.

Discovery.iManage

The following Discovery.iManage settings are available:

Name Description Required Default
BaseAddress Base Addres (i.e. https://cloudimanage.com) True  

Username

iManage Username True  
Password iManage Password True  
Version Target API Version True v2
True True True  
True True True  
OAuth Use OAuth or Basic authentication True false
DatabaseId The name of the iManage database True  
MaintainFolderStructure If the item exists in a subfolder, replicate that folder structure in iManage by creating folders if needed True true
WorkspaceName The name of the workspace you want to seach in False  
Concurrency The amount of concurrent threads to run for Discovery True 4
MaxSize Max size of a file to keep in memory False  
ExtensionExclusions Types of files to exclude. The exclusion list has priority so if the same extension is in both lists the item will be excluded. False  
ExtensionInclusions Types of files to Include False  
Operator Filters documents based on the user ID of the operator of the documents. False  
Author Filters documents based on the user ID of the author of the documents. False  
CreatedDateFrom Filters documents created on or after this date. The date must be in ISO 8601 format. The Create Date From must be less than the Create Date To if both filters are included. False  
CreateDateTo Filters documents created on or before this date. The date must be in ISO 8601 format. The Create Date To must be greater than the Create Date From if both filters are included. False  
Recipient Filters documents based on the text that appears in recipient field of emails. Use email addresses only. False  
ReceivedDateFrom Filters documents created on or after this date. The date must be in ISO 8601 format. The Received Date From must be less than the Received Date To if both filters are included. False  
ReceivedDateTo Filters emails received on or before this date. The date must be in ISO 8601 format. The Received Date To must be greater than the Recieved Date From date if both are included. False  
SentDateFrom Filters emails sent on or before this date. The date must be in ISO 8601 format. The Send Date From must be less than the Create Date To if both filters are included. False  
SentDateTo Filters emails sent on or after this date. The date must be in ISO 8601 format. The Send Date To date must be greater than the Send Date From date if both are included. False  
Subject Filters emails based on the matching text found in the email subject. False  
Body Filters documents based on the matching text found in a document's content. False  
Sender Filters documents based on the text that appears in the sender field of emails. Use email addresses only. False  
Anywhere Filters documents based on the matching text found anywhere in the document's profile or its contents. Use this when searching for parts of email addresses. False  
Limit Specifies the maximum number of items to return per page. The default is 25 and the max is 9999. True 25
RetryAttempts The Number of Attempts to Retry Failed API Calls True 4

Delivery.iManage

The following Delivery.iManage settings are available:

Name Description Required Default
BaseAddress iManage instance Base Address. Example: https://cloudimanage.com for v2 cloud. True  
Username iManage Username. True  
Password iManage Password. True  
Version Target API Version. True v2
ClientId Client ID for the Application. True (Only for v2)  
ClientSecret Client Secret for the Application. True (Only for v2)  
OAuth Use OAuth or Basic authentication. True False
DatabaseID The name of the iManage database. True  
ContainerID The DocID of the folder you wish to import to. True (unless mapping tag is provided)  
MaintainFolderStructure If the item exists in a subfolder, replicate that folder structure in iManage by creating folders if needed. False True
Rootpath Used with Maintain Folder Structure. Any folders under this path will be maintained in iManage. False False
UseMappingTag Use the mapping tag from the settings if provided. This will assume the mapping tag contains an iManage ContainerID. False True
UploadAttemptLimit Number of times to attempt to upload an item before failing. This must be set to 1 or more. True 2
AuthorOverride Override the Author on the uploaded item. False