iManage Work

The following information details the connectivity and functionality offered by the EzeScan integration with the iManage Work solution. It details the available options and how to configure an EzeScan job into iManage Work.

For information on iManage Work please refer to the iManage website - https://imanage.com/products/work/

Requirements

EzeScan WebApps

EzeScan WebApps 3.11.x or higher.

iManage Cloud

• iManage Work Cloud account

• Network access to https://oauth.services.ezescan.net for OAuth redirects

• The EzeScan - Server application must be installed in iManage Control Center.
  Refer to How to Register Application in iManage Control Center (Cloud)

iManage On-Premise

• iManage Work server (on-premise), version 10.1 or higher

• A custom application must be registered in iManage Control Center.
  Refer to How to Register Application in iManage Control Center (On Premise)

Configuration

To add a new built-in integration, go to the Integrations Tab on the Admin Panel and on the Built-in tab select Add New. Then select iManage Work from the drop-down menu.

Give your connector a name and description. Below you will find the information required to fill out the Connection Settings Section.

Cloud

Setting	Description
Connector API Version	Select the Cloud option.
Service URL	If you are using a custom subdomain please enter the URL (e.g. https://subdomain.cloudimanage.com/), otherwise leave blank.
Customer ID	The customer ID assigned to your organisation in iManage Cloud (e.g. 259). This can be found by logging into the iManage cloud in a web browser and then navigating to https://cloudimanage.com/work/web/startup/session-info.
Library ID	The database to connect to (e.g. ACTIVE). This can be found in iManage Work Cloud web page as per below.
Access Level	Type of access level: User for normal operations. Default option. Admin for administrative operations such as Supervised Import Mode.
Client ID	Leave this field blank.
Client Secret	Leave this field blank.
Redirect URI	The URL used for callback to obtain the login result when the browser navigates away from the login web page and should be formatted as follows: {scheme}://{hostname}[/{virtual-directory}]/api/integrations/oAuthCallback For example, https://localhost/ewa/api/integrations/oAuthCallback The virtual directory can be omitted if not configured. For example, https://localhost/api/integrations/oAuthCallback
Grant Type	Select the Authorization Code option.
Ignore SSL Certificate Errors	Leave unticked, unless using a self signed certificate.

On-Premise

Setting	Description
Connector API Version	Select the V2 option.
Service URL	Specify the Service URL of the organisation’s iManage Work server (e.g. https://imanwork.mycompany.com/).
Customer ID	The customer ID assigned to your organisation in iManage Work Server. This should be 1 for single tenant installations. If unsure, the customer ID can be found by logging onto iManage work in a web browser and then navigating to http[s]://<server-address>/work/web/startup/session-info.
Library ID	The database to connect to (e.g. ACTIVE). This can be found in iManage Work Cloud web page as per below.
Access Level	Type of access level: User for normal operations. Default option. Admin for administrative operations such as Supervised Import Mode.
Client ID	The Client ID of the application registered in iManage Control Center (e.g. ezescan). Refer to iManage Work | How-to-Register-Application-in-iManage-Control-Center-(On-Premise) .
Client Secret	The Client Secret of the application registered in iManage Control Centre. Refer to iManage Work | How-to-Register-Application-in-iManage-Control-Center-(On-Premise) .
Redirect URI	The URL used for callback to obtain the login result when the browser navigates away from the login web page where formatted as follows: {scheme}://{hostname}[/{virtual-directory}]/api/integrations/oAuthCallback For example, https://localhost/ewa/api/integrations/oAuthCallback The virtual directory can be omitted if not configured. For example, https://localhost/api/integrations/oAuthCallback
Grant Type	Select the Authorization Code option. The Implicit authorisation type is not recommended due to possible security vulnerabilities and should be used with caution.
Ignore SSL Certificate Errors	Leave unticked, unless using a self signed certificate.

Testing Connection Settings

The Test Login button can be used to confirm the connection is working as expected. You should see a login prompt open in a pop-up window after clicking on the button. If not, you may need to configure the browser to allow pop-ups for the EWA website.

Search Functions

The integration provides search capabilities via the Integration Find field type in BCG, DFA, and RIA modules.

To configure the search function:

1. Navigate to the Integration tab of the respective field.

2. Select the iManage connection from the list.

3. Navigate to Search → Actions.

4. Enable the Search Enabled option.

3. Select the search action to use (for example, Search Custom Attributes. Refer to following sections for more details regarding the available actions.

4. Add and configure any action specific settings.

5. Navigate to Values tab.

6. Select Type Record to configure specific properties to display in the field vs return as the value.

7. Enter the Included properties to return as the hidden value of the field (for example, Id).

8. Enter the Display property to return as the display value of the field (for example, Id;Description;Custom1).

9. Finally save the field.

Search Clients List

The Clients list can be searched using the Search Custom Attributes action with the Custom attribute number set to 1 as per below screenshot.

The following properties can be returned to the EWA field when the user selects a search result.

• Id

• Description

The following search criteria can be used to automatically match a client by id.

Search Matters List

The Matters list can be search using the Search Custom Attributes action with the Custom attribute number set to 2 as per below screenshot.

A field placeholder can be used to restrict the list of matters to those belonging to a specific client.

The following search criteria can be used to automatically match the matter by id.

FAQs

How to Register Application in iManage Control Center (Cloud)

This integration requires an application be added in iManage Control Center.

To add the application:

1. Open iManage Control Center in a web browser (e.g. https://cloudimanage.com/work/cc)

2. Navigate to Settings → Applications as shown below.
   

3. Click Add Application to choose from the available applications.

4. Select the EzeScan - Server application.

If the application does not appear in the list, it may have already been installed and no further steps are required.

5. Click Authentication

6. Ensure Allow Refresh Token is enabled and configure the expiry options as desired.

7. Click Access

8. Select All Users if any user should be allowed to sign-in using this integration, otherwise select Custom and choose the desired users.

9. Click Review

10. Ensure Enable Application is on.

11. Finally click Finish

How to Register Application in iManage Control Center (On-Premise)

This integration requires an application be registered in iManage Control Center in order for user’s to sign-in using the OAuth authentication.

To register an application open in iManage Control Center in a web browser (e.g. https://imanage.company.com.au/work/cc)

Navigate to System Setup → Applications as show below.

Search the list of available applications for EzeScan to ensure if has not already been configured.

Click the Blue circle with the Plus symbol to add a new application registration.

The Blue Button will open the Add Application modal.

Click on Configure Manually

Enter a name, API Key, and auto generate an API Secret.

We recommend using ezescan as the API Key.

Click in Authentication

Configure the options highlighted above.

Confidential and Allow Refresh Token are required for background processing in EzeScan Server.

Without these options the access token would expire every 30 minutes and require a user manually sign-in again.

Click on Access

Select All users

Click on Review

Ensure application is enabled.

Store the API Key and Secret somewhere safe - these will be needed when configuring the connection in EWA.