iManage Work (REST API)

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.

Authentication Type

Select the OAuth option.

The cloud platform does not support legacy credential based authentication.

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.

Desktop Redirect URI

The URL used for callback to obtain the login result when the browser navigates away from the login web page (e.g. http://localhost:5000/auth/callback)

This URI should not exist as an actual URI on the workstation.

Authorisation Type

Select the Authorization Code option.

Connector API Version

Select the V2 option.

The Work v1 REST API was retired on December 30, 2022.

Supported for V1 has since been removed from this integration.

Service URL

Specify the Service URL of the organisation’s iManage Work Server (e.g. https://imanwork.mycompany.com/)

Authentication Type

Select the OAuth option.

The Login option is deprecated due to requiring the now unsupported Work V1 REST API and will be removed in a future release.

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 How to register application in iManage Control Center.

Client Secret

The Client Secret of the application registered in iManage Control Centre.

Refer to How to register application in iManage Control Center.

Username

Username of named account to connect as when using Login authentication type.

This option is deprecated due to requiring the now unsupported Work V1 REST API and will be removed in a future release.

Password

Password of named account to connect as when using Login authentication type.

This option is deprecated due to requiring the now unsupported Work V1 REST API and will be removed in a future release.

Desktop Redirect URI

The URL used for callback to obtain the login result when the browser navigates away from the login web page (e.g. http://localhost:5000/auth/callback)

This URI should not exist as an actual URI on the workstation.

Authorisation Type

Select the Authorization Code option.

The Implicit authorisation type is not recommended due to possible security vulnerabilities and should be used with caution.

Folders

When selected this option enables the iManage Work Folder Browse button on the EzeScan Viewer KFI indexing panel. This will allow the KFI operator to choose which iManage Work folder to attach the document to.

Files

When selected this option enables the iManage Work Folder Browse button on the EzeScan Viewer KFI indexing panel. This will allow the KFI operator to choose a iManage Work document to be updated as a new version or replaced.

Custom Attribute Number

When selected this option enables the iManage Work Custom Attribute Browse button on the EzeScan Viewer KFI indexing panel. This will allow the KFI verify operator to choose iManage Work custom attributes values to apply to the document.

(e.g. The Client Code and Matter Number fields are custom attributes). For Example, if the Client Code was to be a KFI field it could be custom field 1.

If a Matter Number was to be a KFI field it could be custom field 2 with a restrict view using parent attribute number 1

Client Code

Matter Number

NOTE

The iManage Work Administrator should be able to obtain the custom class fields for your respective iManage Work server.

Classes

When selected this option enables the iManage Work Classes Browse button on the EzeScan Viewer KFI indexing panel. This will allow the KFI verify operator to choose which iManage Work Class to apply to the document.

Subclasses

When selected this option enables the iManage Work Sub Classes Browse button. This will allow the EzeScan operator to specify a Sub Class of the Document Type selected in the Classes KFI field.

NOTE

The Classes KFI field must be determined before a Sub Class is determined.

Users

When selected this option enables the iManage Work User Browse button on the EzeScan Viewer KFI indexing panel. This will allow the KFI verify operator to choose which iManage Work User to apply to the document.

Start At Folder

This option is to be used in conjunction with the Browse Folders option.

When selected this option allows the user to select the workspace/folder to start at when browsing for a folder.

Restrict view using parent attribute name

When selected, this option determines if the search results returned belong to a parent attribute (E.g. searching for a matter from a client ID), if the parent name is equal to that specified, the result will be shown, if not it will be omitted.

NOTE

KFI Field Placeholders are accepted in this field. E.g. <<F1>>

Parent document class name

This option is to be used in conjunction with the Browse Subclass option; this will allow the operator to define the Parent Class Type, therefore omitting any sub class results that do not relate to that Parent type.

NOTE

Field Placeholders are accepted in this field. <<F1>>

Auto Search

When selected, this option will cause a blank search to be automatically performed when a search window is launched.

Allow Multiple Selections

When selected, this option allows for multiple files or folders to be specified in this KFI field.

Lookup Query

The Lookup query to run.

e.g. Workspace/CustomProperty[1]/equals/<<F1>>/And/CustomProperty[2]/equals/<<F2>>

Where: <<F1>> is the KFI field placeholder for the KFI field containing the Client ID, and <<F2>> is the KFI field placeholder for the KFI field containing the Matter ID

Return Format

An expression representing the properties of objects, such as their Description or Name.

For a workspace query we would want to return the workspace ID value by specifying

e.g {ID}

Max Results

A number to control how many objects the iManage Server will return on queries. The higher this number, the longer searches will take.

Client Attribute

This is the Custom field number being used for the Client field on the iManage Work server. If using the Populate Client Using Matter mapping this setting must be correctly applied.

Matter Attribute

This is the Custom field number being used for the Matter field on the iManage Work server. If using the Populate Client Using Matter mapping this setting must be correctly applied.

Class

Use this field to set the class field. E.g. doc, email, contract, scanned. This is a usually a mandatory field. If a class has been pre-set on the folder that the document is being uploaded to, EzeScan can inherit the value. To do this set the Class source field to a static value and set to “INHERIT_FROM_FOLDER”.

Description

Use this field to name the document. This is a mandatory field.

Author

Use this field to set the author field.

Comments

Use this field to set the comments on the upload document.

Database

Use this field to specify the database where the document will be created in the iManage Work Server.

Declare As Record

Use this field to specify whether to Declare the document as a record. Set to True to activate, False to not activate or leave the field source value set to ignore.

Folder

Use this field to specify the folder path where the document will be saved into.

Operator

Use this field to set the operator field. This is a mandatory field.

Parent Document New Version

With a iManage Work document number populated in this field, EzeScan will create a new version of this document.

Parent Document Replace Version

With a iManage Work document number populated in this field, EzeScan will replace the latest version.

Populate Client Using Matter

A iManage Work Matter value is required to be supplied into this target mapping, EzeScan will perform a search and return the Client ID. For this option to work correctly there would only be a single result for the search. e.g. a Specific matter number can only have one client.

Private Search Folder

With the value populated in this field, EzeScan will search for a iManage Work folder that is set to Private access.

(e.g. owned by the current IManage Work login username).

NOTE

EzeScan assumes only 1 folder of that name will exist, otherwise if multiple folders exist with the same name EzeScan uses the first result returned (which may not be the one you wanted!)

Public Search Folder

With the value populated in this field, EzeScan will search for a iManage Work folder that is set to Public access.

(e.g. owned by any username).

NOTE

EzeScan assumes only 1 folder of that name will exist, otherwise if multiple folders exist with the same name EzeScan uses the first result returned (which may not be the one you wanted!)

Default Security Visibility

This option is to set the default security on the uploaded image. The options are Public, Private or View.

Security Include External Users

This can be set to either True or False. If set to true it will allow access to the document externally and display the message “Shared to External Users” on the properties page of the saved image into the IManage Work Client.

Security Inherited

This can be set to either True or False. If set to true the image will inherit the permissions from the parent folder that the image is being saved into.

Security User ACL

This option can apply permissions on a User/s on the uploaded image. The syntax required (per user) is USERNAME||SECURITY_LEVEL

The security options available are ALL, READ, READWRITE and NONE

So for example JBLOGGS||READ or for multiple users JBLOGGS||READ||JDOE||READWRITE

Security Group ACL

This option can apply permissions on a Group/s on the uploaded image. The syntax required (per group) is GROUPNAME||SECURITY_LEVEL

The security options available are ALL, READ, READWRITE and NONE.

So for example GENUSERS||READ or for multiple users GENUSERS||READ||POWERUSERS||READWRITE

Sub Class

This is the iManage Work Sub Class field, this is the child of the Class field. e.g. Inward Email, Outward Email. If a subclass has been pre-set on the folder that the document is being uploaded to, EzeScan can inherit the value. To do this set the SubClass source field to a static value and set to “INHERIT_FROM_FOLDER”.

Sub Folder

This is the subfolder of a Workspace or another folder. If a Workspace the operator would also use the Workspace by Name or Workspace By Custom Property. EzeScan would then search for the workspace and then when found will place the image in the Sub Folder Specified.

EzeScan can store into a sub folder one or multi levels deep
e.g. specify as follows \contracts or \scanning\contracts

NOTE

EzeScan assumes only 1 sub folder of that name will exist, otherwise if multiple sub folders exist with the same name EzeScan uses the first result returned (which may not be the one you wanted)

Workspace Tab

This is a Tab immediately underneath a Workspace. The Workspace is selected by either Workspace by Name or Workspace By Custom Property fields. Sub Folders, if specified, will be used underneath the Workspace Tab.

Workspace By Custom Property

With the value populated in this field, EzeScan will search for the Workspace using a Custom property. e.g. if the property is Custom1 in the iManage Work database, the operator will need to put a “1:” in the prefix for the respective KFI field. If a workspace is found EzeScan will store the image specified by the Sub Folder Target Field value.

In this example we are looking for a workspace where the Custom1 value is 108000

If the operator is required to search for a workspace by supplying two or more properties, e.g. Custom1 and Custom2 the following syntax is required.

In this example we are looking for a workspace where the Custom1 value is 108000 and Custom2 value is 1000

The two pipe values notify EzeScan of the next custom field to search with.

NOTE

EzeScan assumes only 1 Workspace with the respective Workspace Custom property/s value will exist, otherwise if multiple workspaces exist with the same custom property/s EzeScan will use the first result returned (which may not be the one you wanted)

Workspace By Name

With the value populated in this field, EzeScan will perform an exact search for the Workspace by its name. If a workspace is found EzeScan will store the image specified by the Sub Folder upload value.

NOTE

EzeScan assumes only 1 Workspace with the respective workspace name will exist, otherwise if multiple Workspaces exist with the same name EzeScan uses the first result returned (which may not be the one you wanted)

Workspace By Description

With the value populated in this field, EzeScan will perform an exact search on the Workspace Description field. If a workspace is found EzeScan will store the image specified by the Sub Folder upload value.

NOTE

EzeScan assumes only 1 Workspace with the respective Workspace description will exist, otherwise if multiple Workspaces exist with the same description EzeScan uses the first result returned (which may not be the one you wanted)

Custom1 to 30

These are the default custom fields on the iManage Work server. You will need to check with your iManage Work Administrator to see if any fields are mapped to these. For example, Custom1 could be mapped to “Client” and Custom2 could be mapped to “Matter”.

Some documents on iManage Work servers could also be configured to inherit properties from its parent folder. If loading documents into these folders from EzeScan and you require the fields to be inherited, set the CustomX field value to “INHERIT_FROM_FOLDER”. EzeScan will then obtain the field information from the folder and apply it to the document.

Additional Properties

EzeScan supports populating additional iManage Work properties (these may be used for other integrating applications e.g. workflow engines).

The add an additional field, click the