eCopy Connector for iManage WorkSite

The eCopy Connector for iManage WorkSite allows users to scan documents directly into the WorkSite library of an iManage WorkSite system from an eCopy-enabled device.

Users can store documents in any eCopy-supported format (PDF, PDF/A, TIF Fax, TIF, JPG, DOC, DOCX, RTF, XPS, XLS and XLSX).

To be able to use this connector with the Email and folder watching service, you need to create a profile in such a way that it does not require user interaction (express). To ensure that your connector profile is such:

Under Logon settings, set the value of Type to Login as.
In the Navigation tab select Specify as Behavior, select a folder and turn Storage confirmation screen off, or
Choose the Auto select behavior, provide a folder and turn both Storage confirmation screen and Autonavigation property screen off.
In the Attributes tab, select Auto-index as the Behavior.
Ensure that the Encryption connector setting has the User Modify parameter set to 'No' (clear the Yes check box).

The connector associated with the routing Watcher workflow needs to create output files matching the file type of the routed documents. If you want to route several different file formats, it is recommended that you set up one connector profile – rule pair for each format.

For the generic connector configuration options, see Configure connector profile.

Defining a scanning destination

For a generic description of defining a scanning destination, see Configure connector profile.

If you select Specify, then you must specify a location, such as a folder or Document Worklist that can hold documents.

Selecting the Auto Index option enables you to configure the index field values. The Document Profile screen does not appear at the device.

Authentication settings

Field Name	Description
Name	Enter the display name of the destination.
Protocol	This list lets you select: COM API: Specify server via name or IP address; or Rest API: This is a REST-based API supported only in iManage Worksite 10.3 or above configurations, including iManage cloud. Select this setting to use modern authentication (OAuth2) for Worksite server (cloud or on-premises). Specify Server URL in the format shown by the watermark text. Specify a user name using the DOMAIN\username format. Specify a Token Vault Authorization Provider ID under Connector Token Vault settings or the Token Vault settings dialog.
Server	Enter the server you want to connect to. Only available if you select COM API as your protocol.
Server URL	The Server URL of the REST-based API of your Worksite server. Only available if you select Rest API as your protocol.
User name	Enter the user name to be used. If Login as is selected, this user name is also used for authentication instead of prompting the scanning user for this information. If Runtime is selected, the scanning user is prompted for credentials at the scanning device.
Password	Enter the password to be used.
Type	Determines the authentication at the ScanStation. If Login As is selected, the authentication form is skipped and the credentials provided are used for login. If Runtime is selected, the authentication form is displayed at the scanning device.
Search while typing	Enables or disables the functionality.
Use trusted login	If checked, the trusted login settings are used when a user authenticates at the scanning device. Only available if you select COM API as your protocol.
Trusted login settings	Set the following options: Impersonation password: if login to the current domain/tree is successful, the connector logs the user in via the administrator password. Windows/Novell: sets what to authenticate against.
Test	Clicking the Test button tests the connector with the current settings.

Navigation settings

Field Name	Description
Behavior	Select the behavior you want to use: Navigate workarea: if selected, the user is able to browse the entire Worksite server, and can choose any valid folder to store documents as a target. Specify: select a valid folder as final scanning destination. The navigation form on the client side is skipped. Specify and browse: select a valid folder as a default scanning destination. Users can browse for different folders, Autoselect: the connector navigates a target automatically using the data publishing values. Three Data Publishing fields are used in this feature: ECOPY_CLIENT_ID (or ECOPY_CUSTOM1), ECOPY_MATTER_NUMBER (or ECOPY_CUSTOM2) and WORKSITEFOLDER. The first two are used to navigate to a workspace which relates to the client and matter. When a workspace is identified, the navigation to the folder can happen in two ways: the connector tries to find a folder with an administrator-defined name, or a folder with the name published via the WORKSITEFOLDER data publishing key. If the ellipsis button of the Navigation tab is pressed when this behavior is selected, the Search folder dialog is displayed, and the administrator can specify folder name source. Using the displayed dialog window, checking the Create folder option allows automatic folder creation with the provided name, if the workspace is identified successfully, but the folder does not exist yet. Clicking the Browse button resets the content of the list control to the content before clicking on the Search button if the list contains search results. Otherwise it resets to the content which was in the list when the form was displayed.
Folder name	Displays the selected folder name. Use the ... button to browse the folder structure.
Provide a storage confirmation screen	Enables or disables client-side displaying of the successfully stored document's Worksite document ID.
Provide autonavigation property screen as needed	Enabling allows the user to enter the Client ID and Matter number on a separate client form if these values are not received through data publishing. The connector performs workspace search based on the entered values and the document is stored at the found location. If disabled, the standard navigation form appears

Attributes settings

Field Name	Description
Behavior	Select the behavior you want to use. The available options are: Show selected fields: the connector displays all required fields and selected optional custom fields for the client, and prepopulate them from the source defined by the administrator. Show required fields: the connector displays all required fields for the client, and prepopulates them from the source defined by the administrator. Auto-index: the connector pre-populates attributes from the source defined by the administrator. When the automatic profile population creates a valid profile, the document attributes forms on the scanning device are skipped. If it fails, the document profile attributes form is displayed on the device screen, and the end user can correct the issue.
Select fields	Click this button to customize the visible fields.
eCopy values	Select an entry in the table and click the Edit button to configure the default value of the attribute. The following attributes can be configured: Database: can be configured only if the target is the Document worklist and the Worksite server manages more than one database. Description: always configurable. Can be populated from the <FILENAME> system variable as well. Author: always configurable. Can be populated from the <OPERATOR> system variable as well. Type, Class, Subclass, and custom fields: configurable via the Default value dialog. The Default value of <attribute> dialog provides a check box in order the enable/disable attribute value population from data publishing. The default value can be configured for folder default value, or administrator predefined value. Predefining is available if the target database is unambiguous, and works by either clicking the value on the displayed list, or entering it manually. The predefined value is validated against the target database, if it is possible. If not, a warning dialog is displayed, the validation process is skipped, and values are validated just before the document storing. To support the selection of a different workspace and folder with different associated Client ID and Matter number associated select the Override field's default value check box. When configuring a sub-attribute (a subcategory of a main attribute), the valid values list contains only those values which are real sub-categories of the already configured main category. The Category - Sub-Category pairs are: Class-SubClass, Custom1- Custom2 and Custom29-Custom30.

Field Name

Description

Behavior

Select the behavior you want to use. The available options are:

Show selected fields: the connector displays all required fields and selected optional custom fields for the client, and prepopulate them from the source defined by the administrator.
Show required fields: the connector displays all required fields for the client, and prepopulates them from the source defined by the administrator.
Auto-index: the connector pre-populates attributes from the source defined by the administrator. When the automatic profile population creates a valid profile, the document attributes forms on the scanning device are skipped. If it fails, the document profile attributes form is displayed on the device screen, and the end user can correct the issue.

Select fields

Click this button to customize the visible fields.

eCopy values

Select an entry in the table and click the Edit button to configure the default value of the attribute. The following attributes can be configured:

Database: can be configured only if the target is the Document worklist and the Worksite server manages more than one database.
Description: always configurable. Can be populated from the <FILENAME> system variable as well.
Author: always configurable. Can be populated from the <OPERATOR> system variable as well.
Type, Class, Subclass, and custom fields: configurable via the Default value dialog.

The Default value of <attribute> dialog provides a check box in order the enable/disable attribute value population from data publishing. The default value can be configured for folder default value, or administrator predefined value. Predefining is available if the target database is unambiguous, and works by either clicking the value on the displayed list, or entering it manually. The predefined value is validated against the target database, if it is possible. If not, a warning dialog is displayed, the validation process is skipped, and values are validated just before the document storing.

To support the selection of a different workspace and folder with different associated Client ID and Matter number associated select the Override field's default value check box.

When configuring a sub-attribute (a subcategory of a main attribute), the valid values list contains only those values which are real sub-categories of the already configured main category. The Category - Sub-Category pairs are: Class-SubClass, Custom1- Custom2 and Custom29-Custom30.

Data Publishing keys

Published key	Mapped Worksite attribute	Note
ATTYPE_CLASS	Class	Used by the Auto select mode as well.
ATTYPE_SUBCLASS	Subclass	Used by the Auto select mode as well.
ATTYPE_CUSTOM1	Custom1	When data are provided in both ECOPY_CLIENT_ID and ATTYPE_CUSTOM1, ECOPY_CLIENT_ID takes precedence.
ATTYPE_CUSTOM2	Custom2	When data are provided in both ECOPY_MATTER_NUMBER and ATTYPE_CUSTOM2, ECOPY_MATTER_NUMBER takes precedence.
ATTYPE_CUSTOM3	Custom3
ATTYPE_CUSTOM4	Custom4
ATTYPE_CUSTOM5	Custom5
ATTYPE_CUSTOM6	Custom6
ATTYPE_CUSTOM7	Custom7
ATTYPE_CUSTOM8	Custom8
ATTYPE_CUSTOM9	Custom9
ATTYPE_CUSTOM10	Custom10
ATTYPE_CUSTOM11	Custom11
ATTYPE_CUSTOM12	Custom12
ATTYPE_CUSTOM29	Custom29
ATTYPE_CUSTOM30	Custom30
WORKSITEFOLDER	-	Used by the Auto select mode as well.
ATTYPE_TYPE	Type

For more information on Data Publishing, see Data Publishing Mapper tool. The Worksite connector can also use batching when processing documents with the help of Data Publishing. For more information on batching and data publishing, see Batching and routing in ShareScan.

Your search for returned results.

Search tips