Welcome to Kofax eCopy ShareScan > Configure connectors > eCopy connectors > eCopy Connector for OpenText Documentum

eCopy Connector for OpenText Documentum

The eCopy Connector for OpenText Documentum allows users to scan documents directly into the OpenText Documentum Repository of an OpenText Documentum system from an eCopy-enabled device.

Users can store documents in any eCopy-supported format (PDF, PDF/A, TIF Fax, TIF, JPG, DOC, XPS, and XLS). For OpenText Documentum server 6.0 or later, DOCX and XLSX formats are also supported.

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:

  1. Use the Express wizard to configure your profile, or
  2. Ensure that you choose the options marked with the "express" icon (3 dashes) when you create a new profile or edit an existing one.
  3. Regardless of what you choose from the above options, you also need to ensure that the Encryption connector setting has the User Modify parameter set to 'No' (clear the Yes check box).
  4. ensure that the Document Name connector setting is configured as follows:
    1. It is set to the Default File Name value, or
    2. Its value is Specify name... with the User Modify option off (clear the Yes check box), or
    3. Used Advanced File Naming..., where all fields have the User Modify option off (in the Field Editor dialog).

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.

Configuring a destination

The options available via the Configure tab allow you to configure the destinations used by the connector.

Field Name

Description

Express Wizard

Click this button to create an express destination via the Wizard. The express destination can be saved either to a new profile or to the current profile.

New

Displays the destination dialog for adding a new destination.

Edit

Displays the destination dialog for the selected destination, allowing you to edit its properties.

Copy

Copies the selected destination with a new name.

Remove

Deletes the selected destination from the list.

Move up

Moves the selected destination up the list.

Move down

Moves the selected destination down the list.

Summary

Displays the main settings. Every client form has a main row in this list with summary information according to its settings. The settings can be hidden by clicking the arrow icon.

Destination dialog, generic options

Field Name

Description

Destination name

Specify a unique destination name.

Express destination

If checked, the Logon as option is selected on the Authentication tab, Store in specified cabinet or folder is selected on the Navigation tab and the list on the Doctypes tab can contain only one document type which has no attributes to be shown.

If file name already exists

The following actions can be set:

  • Allow duplicated name
  • Create unique name (.1, .2, and so on)
  • Return error

Destination dialog, Connection tab

Field Name

Description

Documentum REST Services URL

The URL of the Documentum REST Services of your Documentum server.

Important In earlier version of ShareScan Documentum connector the Documentum Server was configured in the separately installed Documentum Foundation Classes (DFC), and so the profile destinations configured in an earlier version of ShareScan do not contain this field. In case of such destinations the 'Documentum.DefaultRESTServicesURL' advanced setting value is displayed and used as the value of this field. After saving the profile the destination will already contain this field with the configured value and the value of this advanced setting will be no longer used for this profile destination.

ShareScan tries to fill out the value of this advanced setting with the following URL:

http://<Documentum Server>:8080/dctm-rest

where <Documentum Server> is the Documentum server name or IP configured in DFC earlier.

If your Documentum REST Service URL is different or 'Documentum.DefaultRESTServicesURL' advanced setting value is empty, you must configure manually your Documentum REST Services URL either as the value of this advanced setting or as the value of this field at every Documentum connector profile destinations before using any Documentum connector based workflows to avoid connection errors.

Test connection

Connects to the Documentum REST Services specified by URL. If successful, the Documentum REST Services version appears.

Destination dialog, Authentication tab

Field Name

Description

Logon as

If checked, a specified account is used to logon on the client side, thus the Authentication form is not shown. This is the express mode of the client authentication form.

Logon at runtime

If checked, the Authentication form asks for user name, password and domain on the client side. This is the non-express mode of client authentication form, and the dialog enables selecting from the Search while typing list.

Repository

The list shows the connectable Repositories.

User name

Specifies the administrator's user name. Modifying the user name disables Navigation, Doctypes and If file name already exists settings, until a successful connection test.

Password

Specifies the administrator's password. Modifying the password disables Navigation, Doctypes and If file name already exists settings, until a successful connection test.

Domain

Specifies the administrator's domain name. The list shows domain names on the network, you can select one from there, or type it manually. Modifying the domain name disables Navigation, Doctypes and If file name already exists settings, until a successful connection test.

This field is optional.

Test authentication

Connects to the specified Repository with the specified administrator's account.

Search while typing

Connects to the Documentum server with the administrator's account and retrieves users list on runtime. The list becomes enabled when Logon at runtime is checked.

Destination dialog, Navigation tab

Field Name

Description

Store in specified cabinet or folder

If checked, the document is stored in a specific cabinet/folder and the Location form is not shown. This is the express mode of the client location form.

Allow user to navigate

Enables you to select the types of cabinets that the user sees on the Location screen at the device. This is the non-express mode of the client location form.

Specific cabinet or folder

Sets the root point of the subfolder navigation to a specific location.

Entire Repository

Sets the root point of the subfolder navigation for the entire repository. The following values can be selected:

  • All Cabinets: shows all Cabinets.
  • Public and users private Cabinets: shows public Cabinets and private Cabinets owned by logged on users.
  • Users private Cabinets: shows only private Cabinets owned by logged on users.

Enable home cabinet

Displays the Home cabinet button on the Location screen at the device, allowing documents to be stored in the user’s Home cabinet.

Enable subscriptions

Displays the Subscriptions button on the Location screen at the device, allowing documents to be stored in the user's subscription locations.

Enable subfolder navigation

Enables the user to navigate folders below the location chosen in the Specify location field. The user cannot access folders above the specified location.

Destination dialog, Doctypes tab

Field Name

Description

Doctypes

The list view displays configured Doctypes. Note that at least one valid Doctype is required.

  • The first column indicates if the Doctype attributes are properly configured.
  • The second column displays the Doctype name
  • The third column displays the number of shown attributes from the selected attributes
  • The fourth column displays the defined file format of the document type.

If a single Doctype is configured and the default format type corresponding to the scanned document type is specified, the Document form is skipped on the client.

New

Opens a window showing available doctypes.

Edit

Enables you to configure the attributes of the selected Doctype. The Doctype icon shows the Doctype as invalid until the attributes are configured, and the OK button is clicked. The attributes that you have configured and set as Show appear on the Attributes screen at the device.

Remove

Deletes the selected Doctype from the list.

Move up

Moves the selected Doctype up the list.

Move down

Moves the selected Doctype down the list.

Express Wizard

This wizard enables creating an express destination in a new express profile (a profile which has only one express destination) or in the current profile step by step.

Welcome page

This page displays generic information on the aim of the Wizard.

Destination page

Field Name

Description

Create destination in a new profile

After finishing the wizard, all destinations are deleted and an express destination is created with the specified name in the current profile. The user can save the profile with a new name retaining the data of the current profile.

Create destination in the current profile

The destination is created in the current profile after finishing the wizard.

Destination name

Specify destination name. The destination name must meet the following criteria:

  • Must be unique in the profile.
  • Is case sensitive.
  • Name has to be specified.

The length of name is not limited.

Connection page

Field Name

Description

Documentum REST Services URL

 The URL of the Documentum REST Services of your Documentum server.

Test connection

Connects to the Documentum REST Services specified by URL. If successful, the Documentum REST Services version appears.

Authentication page

Field Name

Description

Repository

The list shows the connectable Repositories.

User name

Specifies the administrator's user name. Modifying the user name disables Navigation, Doctypes and If file name already exists settings, until a successful connection test.

Password

Specifies the administrator's password. Modifying the password disables Navigation, Doctypes and If file name already exists settings, until a successful connection test.

Domain

Specifies the administrator's domain name. The list shows domain names on the network, you can select one from there, or type it manually. Modifying the domain name disables Navigation, Doctypes and If file name already exists settings, until a successful connection test.

This field is optional.

Test

Connects to the specified Repository with the specified administrator's account. If successful, Navigation, Doctypes and If file name already exists settings are enabled.

Location page

Field Name

Description

Specific cabinet or folder

Sets the root point of the subfolder navigation to a specific location.

Doctypes page

Field Name

Description

Doctypes

The list view displays configured Doctypes. Note that at least one valid Doctype is required.

  • The first column indicates if the Doctype attributes are properly configured.
  • The second column displays the Doctype name
  • The third column displays the number of shown attributes from the selected attributes
  • The fourth column displays the defined file format of the document type.

If a single Doctype is configured and the default format type corresponding to the scanned document type is specified, the Document form is skipped on the client.

New

Open a window showing available doctypes.

Edit

Enables you to configure the attributes of the selected Doctype. The Doctype icon shows the Doctype as invalid until the attributes are configured, and the OK button is clicked. The attributes that you have configured and set as Show appear on the Attributes screen at the device.

Remove

Deletes the selected Doctype from the list.