eCopy ShareScan NetDocuments Connector

The NetDocuments connector allows users to scan documents directly into NetDocuments system from an eCopy-enabled device in any supported document format. You need a NetDocuments connector license loaded into ShareScan to access this connector.

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 do this, verify that you select connector configuration options marked with 3 dashes (the "Express" icon).

A note on compatibility: in this ShareScan version the NetDocuments connector is integrated into the main product and is installed as part of ShareScan installation. This integrated version of NetDocuments requires Token Vault v3.6 or later. Earlier versions of the NetDocuments connector (installed separately - for ShareScan 5.4 SP2 and ShareScan 6.1 SP1) require Token Vault version 2.x.

Before end-users can use the NetDocuments connector they need to authorize themselves to

Get an access token
Associate their NetDocuments and domain accounts, and
Store the token in Token Vault for later use with the NetDocuments storage.

If this authorization is not performed before using the NetDocuments connector, connector authentication fails and ShareScan sends a notification email to the user with instructions on the necessary actions. This email contains the Token Vault URL, where the authorization steps should be performed by users. As access tokens might expire during extended idle periods for the connector, end-users may need to perform the authorization steps again at a later time.

To enable ShareScan to send such notifications the ShareScan Notification service has to be configured and turned on for the NetDocuments connector.

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

Destination settings

Field/Button	Description
New	Adds a new destination.
Edit	Edits an existing destination.
Copy	Copies the selected destination.
Remove	Removes the selected destination.
Move up	Moves the selected destination up in the list.
Move down	Moves the selected destination down in the list.
Expression	Displays the Expression dialog.

Authentication settings

Field/Button	Description
Name	Specify a name for your destination in this field.
Web Service	Select the Net Documents service URL from the list of available and accessible repositories.
Username	Specify an user name in this field. If you modify it, configuration options on the Navigation and Attributes tabs are disabled until you execute a successful connection test.
Password	Specify the password in this field.
Domain	Select a domain from this list or type in a new one manually.
Login mode	Select the mode of authentication: In Login As mode, the authentication screen is not shown and the credentials that are provided are used for login. In RunTime mode, the device displays the authentication screen.
Authorize	Click this button to open the Token Vault web application in a browser. This page lets users authenticate themselves using their domain accounts and authorize their NetDocuments accounts.
Test	Click this button to validate the entered domain credentials verify if the NetDocuments account is authorized, and check the availability of the NetDocuments web service.

Navigation settings

Field/Button	Description
Behavior	Select the behavior that you want to use from the following options: Specify:Scanned documents will be saved in the specified cabinet, folder or workspace selected under the Location field. Search and browse:Users can browse folders or workspaces under the selected Location where the scanned documents will be uploaded. Auto select using workspace attributes: Workspace is selected automatically based on attributes connected to the workspace at NetDocuments, retrieved from Data Publishing Keys under the selected Cabinet. When a workspace is identified, in the actual navigation step either the connector tries to find a folder with a configured name, or a folder with the name published via the NETDOCUMENTSFOLDER Data Publishing key. This folder name source can be configured on the Specify folder dialog. To display this dialog go to the Navigation tab then click the ellipsis button next to folder name input field. If Use Data Publishing value option is selected on this dialog, then the folder name will be retrieved from the NETDOCUMENTSFOLDER DP Data Publishing key mentioned above.If Specify the folder name option is selected on this dialog, the connector tries to find a folder with the name specified in the input field under this option. If such folder does not exist under the identified workspace the connector creates one if the Create folder option is selected. Auto select using document cover sheet: The scanned pages will be uploaded to the document identified by the document ID retrieved from Data Publishing. In this case the first scanned page as a cover sheet printed from NetDocuments should contain a barcode that defines an existing document ID.
Provide a storage confirmation screen	Enables or disables displaying confirmation screen with the NetDocuments ID(s) of the successfully stored document(s). The confirmation screen will be displayed only Background processing setting is disabled.

Field/Button

Description

Behavior

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

Specify:Scanned documents will be saved in the specified cabinet, folder or workspace selected under the Location field.
Search and browse:Users can browse folders or workspaces under the selected Location where the scanned documents will be uploaded.
Auto select using workspace attributes: Workspace is selected automatically based on attributes connected to the workspace at NetDocuments, retrieved from Data Publishing Keys under the selected Cabinet. When a workspace is identified, in the actual navigation step either the connector tries to find a folder with a configured name, or a folder with the name published via the NETDOCUMENTSFOLDER Data Publishing key. This folder name source can be configured on the Specify folder dialog. To display this dialog go to the Navigation tab then click the ellipsis button next to folder name input field. If Use Data Publishing value option is selected on this dialog, then the folder name will be retrieved from the NETDOCUMENTSFOLDER DP Data Publishing key mentioned above.If Specify the folder name option is selected on this dialog, the connector tries to find a folder with the name specified in the input field under this option. If such folder does not exist under the identified workspace the connector creates one if the Create folder option is selected.
Auto select using document cover sheet: The scanned pages will be uploaded to the document identified by the document ID retrieved from Data Publishing. In this case the first scanned page as a cover sheet printed from NetDocuments should contain a barcode that defines an existing document ID.

Provide a storage confirmation screen

Enables or disables displaying confirmation screen with the NetDocuments ID(s) of the successfully stored document(s). The confirmation screen will be displayed only Background processing setting is disabled.

Attributes settings

Field/Button	Description
Behavior	Select the behavior that you want to use from the following options: Specify: Attributes are displayed on the device as they are specified in the data grid. Inherit from parent folder or workspace: Only in case a folder or a workspace was selected as Location in Navigation tab. The document attributes will be the attributes of the parent folder or workspace.
Attributes data grid	Key icon: Data publishing keys can be enabled for each attribute by clicking the key icon next to the attribute name. In that case the attribute values can be received from Data Publishing. Attribute name: name of the attribute Type: type of the attribute Required: Specifies if the attribute must have a value Show: If checked, the attribute will be shown on the client attributes form Modify: If checked, the user can modify the attribute value on the client attributes form. Default value: Default value can be entered for the attribute. Users can modify it on the client attributes form if the Modify flag is set. “Today” can be entered in case of date attributes. In that case the attribute always picks up the current date at runtime.
Search While Typing	Enable or disable the type-ahead feature when you start entering an attribute value on the client attributes form. Two search options can be selected for type-ahead from the list: Contains and Starts with.

Field/Button

Description

Behavior

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

Specify: Attributes are displayed on the device as they are specified in the data grid.
Inherit from parent folder or workspace: Only in case a folder or a workspace was selected as Location in Navigation tab. The document attributes will be the attributes of the parent folder or workspace.

Attributes data grid

Key icon: Data publishing keys can be enabled for each attribute by clicking the key icon next to the attribute name. In that case the attribute values can be received from Data Publishing. Attribute name: name of the attribute Type: type of the attribute Required: Specifies if the attribute must have a value Show: If checked, the attribute will be shown on the client attributes form Modify: If checked, the user can modify the attribute value on the client attributes form. Default value: Default value can be entered for the attribute. Users can modify it on the client attributes form if the Modify flag is set. “Today” can be entered in case of date attributes. In that case the attribute always picks up the current date at runtime.

Search While Typing

Enable or disable the type-ahead feature when you start entering an attribute value on the client attributes form. Two search options can be selected for type-ahead from the list: Contains and Starts with.

Configuration settings

The NetDocuments connector configuration settings are stored in the TokenVault.Connectors.NetDocuments.config.json file.This file is located in the <Token Vault installation folder>\plugins\NetDocuments folder. (for example, C:\Program Files (x86)\Kofax\TokenVault\plugins\NetDocuments). It is recommended that you keep a backup copy of this file at all times. An incorrect TokenVault.Connectors.NetDocuments.config.json file can make the Token Vault NetDocuments connector inoperable.

To change Token Vault behavior, you need to modify this file. You can use a simple text editor tool for this. When you are done, restart the “Kofax Token Vault Service” windows service to apply the changes.

The Token Vault NetDocuments connector communicates with and requests authentication tokens from a NetDocuments service host. The service host varies by region and is specified in the WebService setting value as follows:

"WebService": "vault.netvoyage.com", // US
//"WebService": "eu.netdocuments.com", // EU
//"WebService": "au.netdocuments.com", // AU

The default value is ‘vault.netvoyage.com’: this is the host that belongs to the US region. To modify the default value, comment lines out as needed by inserting ‘//’ before the “WebService” string and remove ‘//’ from the beginning of the line that contains your chosen service host .

Other configuration settings (LoginUrl, ApiUrl and LogourUrl) in this json file are static and based on the value of the WebService setting.