eCopy Connector for Xerox DocuShare

New

Add a new destination.

Edit an existing destination.

Copy

Copy the selected destination.

Remove the selected destination.

Move up

Move the selected destination up in the list.

Move down

Move the selected destination down in the list.

Name

Specify a name for your destination.

Enter the URL of the DocuShare server to which you want to connect. The URL should represent the following string:

protocol://server_name:port/docushare

Where:

• protocol is a web protocol used to access the server.

• server_name is a name of the host machine where the DocuShare server is running. You can specify the full machine name with its domain, or just the name without domain. You can use the IP address of the host machine instead of its name.

• port is a port number used by the server to communicate with its clients. Port number can be omitted. The usual port is 8080.

The following examples provide you with sample reference:

• http://myserver:8080/docushare

• https://my-docushare/docushare

• http://192.168.30.70/docushare

Username

Enter the name of the DocuShare user account that will be used to connect to the server. If you modify it, configuration options on the Navigation and Document types tabs are disabled until you execute a successful connection test.

Password

Specify the password.

Domain

Enter the domain name to be used.

Test

Click this button to test the connector with the current settings.

Login mode

Select the authentication mode:

• In Login As mode, the authentication screen is not displayed at the device and the credentials that are provided are used for login.

• In Runtime mode, the device displays the authentication screen.

Search while typing

Enable or disable the type-ahead feature when you start entering a user name on the client authentication form.

Use JSP page to get groups

Enable or disable the use of a custom JSP script at DocuShare server side to get groups.

To use this option, the eCopy_GetUserGroups.jsp file located in the %programdata%\Tungsten\ShareScan\Connectors\DocuShareConnector\Data folder must be installed on the DocuShare server (see How to install custom JSP Page(s) on DocuShare server).

Behavior

Select the behavior that you want to use from the following options:

• Navigate: If selected, the user can browse the entire DocuShare server on the client side and can choose any valid location to store documents as a target. On the Navigation tab, checking the Create location option allows location creation with the type selected as Default type for new location on this tab and with the provided name on the client side.
• Specify: Select a valid location as final scanning destination.

  If the ellipsis button of the Navigation tab is pressed when this behavior is selected, the Specify a location dialog box is displayed, and the administrator can browse between collections and workspaces on the DocuShare server or search for them by name.

  The navigation form on the client side is skipped.

• Specify and browse: Select a valid location as a default scanning destination.

  If the ellipsis button of the Navigation tab is pressed when this behavior is selected, the Specify a location dialog box is displayed, and the administrator can browse between collections and workspaces on the DocuShare server or search for them by name.

  Users can browse for different collections and workspaces under the specified location on the client side.

  On the Navigation tab, checking the Create location option allows location creation with the type selected as Default type for new location on this tab and with the provided name on the client side.

• Auto select using location path: The connector selects the target location automatically using the value of the data publishing key selected as Data Publishing key to select location. The selected data publishing key must contain a valid location path.

  Checking the Ignore case when determining location option allows to determine location based on the value of the selected data publishing key in case insensitive way.

  Checking the Create location option allows automatic location creation with the type selected as Default type for new location on this tab if the target location determined by the selected data publishing value does not exist.

  When Use JSP page to find location option is checked, the connector uses a custom JSP script to find location by the path specified in the selected data publishing value.

  To use this option, the eCopy_FindCollection.jsp file located in the %programdata%\Tungsten\ShareScan\Connectors\DocuShareConnector\Data folder must be installed on the DocuShare server (see How to install custom JSP Page(s) on DocuShare server).

• Auto select using location handle: The connector selects the target location automatically using the value of the data publishing key selected as Data Publishing key to select location. The selected data publishing key must contain a valid handle of a location existing on the DocuShare server.

Enable Personal collection

Display the Personal collection button on the Navigation screen at the device, allowing documents to be stored under the user's personal collection.

Enable DocuShare favorites

Display the DocuShare favorites button on the Navigation screen at the device, allowing:

• to select a location from the user's DocuShare favorites.

• to add the location selected on the Navigation screen at the device to the user's DocuShare favorites.

• to remove the location selected on the Navigation screen at the device from the user's DocuShare favorites.

If document title already exists

Set the method for resolving document title conflicts when a document with the same title as of the scanned document already exists:

• Add document with the same title: The connector uploads the document as second document with the same title.

• Create unique file name (.1,.2, etc.): The connector creates a unique document title by appending a rolling number with a dot separator.

• Overwrite the existing document: Overwrite the existing document with the scanned document.

• Prepend to the existing document: The connector inserts the scanned document before the first page of the existing document.

• Append to the existing document: The connector inserts the scanned document after the last page of the existing document.

• Create new version: The document will be uploaded as a new version of the existing document.

• Return error: Display an error message at the device. The user must specify a different name at the device or cancel the current job.

The Ignore title case option determines that the check for an existing document by title should be case sensitive or not.

When the Use JSP page to find documents option is selected, the connector uses a custom JSP script to find documents by title. Sometimes, the search does not find the document with the same title, even though one does exist as certain DocuShare servers might take some time to index existing document. This option is useful for these cases.

Retrieve Document type from Data Publishing

Clicking on the key icon or on the text allows the connector to automatically select the document type for the document using the value of the data publishing key selected as Data Publishing key to select document type.

Display the configured document types.

Note that at least one valid document type is required.

• The first column displays the name of the document type appears for users at the device.

• The second column displays the name of the document type on the DocuShare server.

• The third column displays the number of displayed document properties from the selected document properties.

The configured document types on the Select Document type form on the device appears in the same order as they do in the grid.

The Select Document type form on the device is skipped:

• if a single document type is configured, or

• if the Retrieve Document type from Data Publishing option is configured and the value of the data publishing key selected as Data Publishing key to select document type equals to the display name of one of the configured document types.

New

Open a window displaying available document types.

Select one and configure its properties on the appearing Configure '<selected document name>' document type dialog box:

• Display name: Specify the name with which the selected document type appear for user at the device.

• Name: This is the name of the selected document type on the DocuShare server.

• Document properties data grid: Configure the document properties of the selected document type.

  The arrows on the right side of the grid allows to modify the order of the properties and how they appears on the client Document properties form. The data grid columns are the follows:

  • Key icon: Clicking on this in the first column, you can specify whether the custom value of the document property comes via data publishing or not.

  • Display name: Display name of the property.

  • Name: Internal name of the property.

  • Type: Type of the property.

  • Required: Specify if the property must have a value. If a property is not a required property on the DocuShare server, selecting this option enables that the property value must be specified by users on the client Document properties form.

  • Show: If selected, the property is displayed on the client Document properties form.

  • Modify: If selected, the user can modify the property value on the client Document properties form.

  • Default value: Default value can be selected/specified for the property.

    When selecting a document type to configure it and the dialog box opens, the properties' default value configured on the DocuShare server appears in this column.

    Users can see/modify this value on the client Document properties form if the Show/Modify flag is set.

  • Data Publishing key: The data publishing key to be used to receive the property value from Data Publishing. If this is specified and the Key icon is also checked, the property value can be received from Data Publishing.

    Users can see/modify this value on the client Document properties form if the Show/Modify flag is set.

Edit

Configure the properties of the selected document type on the opening Configure '<selected document name>' document type dialog box.

Remove

Delete the selected document type from the list.

Move up

Move the selected document type up in the list.

Move down

Move the selected document type down in the list.