How to Setup and Configure the iManage Connector

Info: All BA Insight connectors can be downloaded from the Upland Right Answers Portal under Knowledge > BA Insight > Product Downloads > Connectors. Please review and comply with the Connector Prerequisites before installing. Install the connector using the installation wizard.

Note: This connector supports one installation per tenancy.

Before You Start

You must satisfy the Prerequisites before continuing, including acquiring your:

  • Client ID
  • Client Secret
  • redirect URL

Upgrading the iManage Connector

When upgrading to the iManage Connector v2.0.0.0-19672 (or later) from an older version, you must perform the following:

  • Reset the index
  • Run a full crawl

If you are upgrading to the iManage connector 2.1.0.0, and you are going to use the new iManage with Sync API service, you must rerun all your security sync jobs Loads User and Group tables and executes the mapping based on the connector configuration. and perform a full crawl job. For more information, see run required jobs in the Connectivity Hub documentation.

How to Authorize the Connector

The iManage connector must be authorized with appropriate permissions to your iManage content.

Use the following steps to grant the iManage connector access to your iManage tenancy:

  1. On the server where the iManage connector is installed, navigate to: http://localhost: number>/OAuth Specifies a process for resource owners to authorize third-party access to their server resources without providing credentials..aspx
    • <port number>: This is the port number that you selected during the connector installation.
      • Default port is 2292. 
  2. Configure your iManage connector:
    • The iManage connector is pre-configured to work with the US Region and comes with the BA Insight application ID for the OAuth authorization process.
      • If you wish to use it, leave the text boxes empty.
      • If you want to use the connector in a different region or register your own application, follow the instructions below:
        1. Create a new application. For this you have to contact your iManage administrator
        2. On the server where the iManage connector is installed:
          1. Navigate to: http://localhost: number>/OAuth.aspx
          2. Enter your Client Id and Client Secret
          3. If you are indexing an iManage tenancy from a different data center, change the Server URL path.
          4. For more information see the iManage Cloud Speedtest.
  3. Click Authorize to start the authorization process.

  4. Log into iManage using an account that has READ access to all content that you want to crawl.

    Note: This connector has the same permissions in iManage as the user account that is used to log in here.

    * If multiple instances of the connector are deployed, you must use different user accounts for each connector instance.

  5. Click Allow.
  6. If the authorization is successful, the following message is displayed:

  7. If the authorization is unsuccessful, ensure you are using the correct user or service account and that account contains the correct permissions. 

Specify your API integration

The iManage connector support two API integrations:

  • iManage work API: This is the traditional API service. This API has a limitation where you cannot crawl more than 10,000 users, groups, or group members.

  • iManage with Sync API: This is the new API service. This API does not have the limitation mentioned above, so it should be used when crawling if your iManage instance has more than 10,000 members, groups, or group members. If you select this API, you will need to have a valid iManage Service Account.

When you are setting up your iManage connector in Connectivity Hub, you must specify one of these API services:

  1. In the Connectivity Hub administration portal, click Connections.

  2. Click New Connection > Web Service Connection.

  3. In the Web Service URL field, enter the address to your DataConnector.asmx file. For example, http://localhost:2292/DataConnector.asmx.

  4. Click Connect. If your web service URL is valid, the Connect to web service window will refresh with a new Services field.

  5. In the Services field, select your desired API service.

Connection Configuration

To configure your connector, do the following:

  1. On the Connection Info tab, complete the necessary information. See the Connectivity hub documentation for more information.
  2. Click the General Settings tab.
  3. If you selected iManage with Sync API as your API service, two additional fields are displayed: System Account and Password. These fields are not required with the iManage work API.
    1. In the System Account field, enter the account name for your iManage service account. If you do not have a service account, you must reach out to iManage to obtain one.
    2. In the Password field, enter the password for you iManage service account.
  4. In the iManage Instance URL, enter the URL of your iManage instance.
  5. In the Library Name field, enter the library name in iManage that you want to crawl.

Content Filters

Filter

You can filter (refine) crawled items by specifying the item properties in JSON format in the field found under the Content Filters tab.

  • Optional setting
  • Used for content filtering
  • To refine crawled items, specify properties in a JSON format in the Content Filters tab
  • Supports multiple values separated by comma (see custom1 in the example below)
  • "exclude_emails": true improves performance significantly
  • For date fields, only ISO format is supported:
    yyyy-MM-ddTHH\:mm\:ss.fffffffzzz
    Examples:

    • Copy 
    2008-09-22T13:57:31.2311892-04:00
    2008-09-22T14:01:54.9571247Z
    2008-09-22T14:01:54
    2008-09-22

Example

Copy 
{
    "exclude_emails": true,
    "email_only": false,
    "class": "",
    "subclass": "",
    "container_id": "",
    "author": "",
    "document_number": "",
    "type": "",
    "edit_date_from": "",
    "edit_date_to": "",
    "create_date_from": "",
    "create_date_to": "",
    "custom1": "value1, value2, value3",
    "custom2": "",
    "custom3": "",
    "custom4": "",
    "custom5": "",
    "custom6": "",
    "custom7": "",
    "custom8": "",
    "custom9": "",
    "custom10": "",
    "custom11": "",
    "custom12": "",
    "custom13": "",
    "custom14": "",
    "custom15": "",
    "custom16": "",
    "custom17": "",
    "custom18": "",
    "custom19": "",
    "custom20": "",
    "custom29": "",
    "custom30": ""}

If you are upgrading to the iManage connector 2.1.0.0, and you are going to use the new iManage with Sync API service, you must rerun all your security sync Loads User and Group tables and executes the mapping based on the connector configuration. jobs and perform a full crawl job. For more information, see run required jobs in the Connectivity Hub documentation.