Welcome to Kofax eCopy ShareScan > About configuring services > About connector services > The eCopy Cost Recovery Service

The eCopy Cost Recovery Service

The eCopyCost Recovery Service is compatible with major cost recovery systems. When cost recovery is enabled, scanning functions are unavailable until the user unlocks the cost recovery terminal or application and specifies the billing account information:

  • Scan date and time
  • The name of the scanning device
  • The scanning function used (e-mail, fax, scan to desktop, and so on)
  • The number of pages scanned
  • The size of the document
  • Sender and recipient information
  • Any additional information provided by the cost recovery system

At the end of the session, you can log off using the terminal and ShareScan returns to the 'locked' state.

ShareScan offers Cost Recovery protocol v3.5. It can be selected as a protocol version in the Cost Recovery service if the Cost Recovery server also supports this protocol version, as both sides need to be set to the same version of the protocol.

The benefit of using v3.5 is that it fully supports the correct accounting for the workflows using background (formerly offline) processing as well.

When pre-v3.5 protocol versions were used with background processed jobs, it was not possible to send some of the job related data to the Cost Recovery server, if the user logged out before the final document was sent to the destination (typical for background processed jobs).

Though the count of scanned pages were sent to the Cost Recovery server even in this scenario, it was not possible to send several other pieces of data – successful document delivery, document size etc. – after logout.

With protocol v3.5 now all these data items are delivered correctly.

Configuring the service

The ShareScan software includes timers that automatically log you off after a certain period of inactivity. However, when the Cost Recovery Service is enabled, these timers are disabled and you remain logged on until you press End or Complete on the terminal, or until the terminal times out.

Configure the service

  1. In the ShareScan Administration Console, select the Configure services tab. The tab displays a list of available services.
  2. Select the service name. The service configuration and the settings pane open.
  3. On the configuration pane, select Configuring Service: Cost Recovery. The Cost Recovery Service fields become active.
  4. To use Encryption, specify the settings.
  5. To use the Activity log, specify the settings.
  6. To enable the service for all devices, select Enabled.
  7. Click Save, then click Test. The eCopy Cost Recovery Terminal Emulator opens.

Note If you are passing user credentials from your cost recovery terminal to the eCopyCost Recovery Service, Session Logon must be set to Enabled in the Enable for all devices tab and Configured in the Configuring Service: Session Logon tab. This functionality is only available if you are using the Unicode/XML (v3) protocol.

Test the service

In the eCopy Cost Recovery Terminal Emulator, click Connect to connect with your server.

Cost Recovery settings

The following table describes the settings available for the Cost Recovery Service.

Cost Recovery settings

Setting

Description

Configured

Enables all settings for the service. Select the Yes check box to make all settings configurable.

Port number

Enters port number. The port number must match the TCP port configured for the cost recovery device. The default port is 9325.

If you change the Port field, the Manager is automatically restarted after saving your settings.

Show Lock Button

Shows Lock Button at the client if you select the Yes check box. This button allows you to lock the terminal from any screen during a session. This option is only available for ScanStation devices.

Protocols

Selects the protocol. This version of the service supports cost recovery terminals that were configured to work with previous versions of the eCopyCost Recovery Service.

  • Auto detect (v1, v2): Select this option if your terminal is configured to work with earlier versions of the Cost Recovery Service.
  • Unicode/XML (v3): Select this option if your terminal is configured to use version 3 of the Cost Recovery Service.
  • Unicode/XML (v3.5): Select this option if your terminal is configured to use the latest version of the Cost Recovery Service (recommended).

All devices controlled by a Manager must use the same protocol.

Field separator

Specify field separator used in Cost Recovery activity logging.

Encryption

Encryption settings must be used if a password is included.

Type

The encryption type for Cost Recovery:

  • None: Passes credentials to ShareScan without encryption.
  • TripleDES: Enables you to encrypt the information from the application supplying the credentials to ShareScan. You can do this by creating an encryption key that you store on the computer where the Manager is running and on the Cost Recovery device.

Path

Set the path for the encryption key. Specifies a path to the storage destination for the encryption key on the device where the Manager is running.

Key

Generates a new key. Generates the encryption key and stores it in the eCopyCRSKey.txt file. You must manually copy this file to the Cost Recovery device. If you regenerate the key, you must copy the new key to the Cost Recovery device.

Important All devices that use Cost Recovery Service and are managed by the same Manager must use the same encryption key. After generating a key for the first device, when you configure subsequent devices, you must select the same path you selected for the first device. ShareScan automatically recognizes the key file that is already in the storage destination.

Activity log

Includes the standard eCopyShareScan user activity log information.

If Cost Recovery logging is turned on and you change protocol version in any direction, use a new log file name and extension. If you want to use the same name and extension, you must archive the old logs to a safe location and delete the original ones.

Configure

Track Cost Recovery using activity logging. Enables all settings for the service. Select the Yes check box to enable configuration options.

Location

Root folder for all Cost Recovery logs. The default location is %programdata%\Kofax\ShareScan\costrecovery.log or %programdata%\Kofax\ShareScan\costrecovery.xml.

Maximum Log Size (10-5000)

Maximum file size in kB. Maximum log size is 5000 kB.

File overflow type

Activity log file types. Enables file overflow for Cost Recovery, if appropriate:

  • Rolling filenames: ShareScan001, ShareScan002, and so on.
  • Overwrite oldest events: New events will overwrite the oldest events in the log.

Extended fields

Allows extended fields in Cost Recovery activity logging. Select the Yes check box to enable this feature.

Device specific activity

Allows separate Cost Recovery activity logging for each specific device. Select the Yes check box to enable this feature.

Enable for all Devices

Enables settings for all devices.

Enabled

Select the Yes check box to enable the service for all devices.

If the key is re-generated, the eCopyCRSKey.txt file must be copied to the Cost Recovery terminal again. If a key mismatch occurs, the data is not decrypted correctly.

eCopy Cost Recovery Terminal Emulator

eCopy Cost Recovery Terminal Emulator appears when you click Test in Configure Cost Recovery service.

To configure the emulator, launch the dialog by clicking Config on the main dialog.

Configuration settings

Setting

Description

Server name

Specifies the name or IP address of the machine running the TCP server. The default value is localhost, which is the machine that the emulator is running on.

Port number

Must match the port number set in ShareScan Administration Console. Default value is 9325, which matches the default for ShareScan.

Timeout (secs)

Value in seconds until the terminal times out if no pulses are received from ShareScan Manager. The default value is 120 seconds.

Device IP

Specifies the IP address of device.

CLID

Emulates the type of data fields (client identification) you enter in a terminal.

Delimiter

The field delimiter for the activity tracking and fake CLID and MID fields. This value matches the value set up in ShareScan Administration Console, the default is ",", which matches the default used in ShareScan.

MID

Emulates the type of data fields (Multiplex Identification) you enter in a terminal.

XML Attributes

Name and value of the XML files you can add to the emulator settings.

XML name

Inserts the XML name.

Value

Inserts XML values.

  • Add XML: click this button to add an XML file with the provided values (XML Name and Value). The result is displayed under the Add XML button.
  • View XML: click this button to view the XML file. The XML file has the following structure:

    <COSTRECOVERYIsIdentificationEmulator="true"><REQUEST><ECOPY_CLIENT_IDvalue="Clientid" /><ECOPY_DELIMITER value=","/><ECOPY_MATTER_NUMBER value="Matternumber"/></REQUEST></COSTRECOVERY>

  • Clear XML: click this button to delete the XML file.

Encryption type

The type of encryption used to encrypt the XML data:

  • None: Passes credentials to ShareScan without encryption.
  • TripleDES: Enables you to encrypt the information sent from the application that is supplying the credentials to ShareScan. You can do this by creating an encryption key that you store on the computer where the Manager is running and on the Cost Recovery device. If TripleDES encryption is enabled, the eCopyCRSKey.txt file must reside in the path location specified in the eCopyShareScan Administration (Activity Tracking, Cost Recovery tab). After this file is generated by the Administrator Console, the file is copied to the Cost Recovery Terminal so that it uses the same TripleDES key encryption value.

Key path

You can browse for the path location of the encryption eCopyCRSKey.txt file. This file contains the Initialization Vector (IV) key used to seed the encryption provider.

Protocol version

You can choose which eCopy protocol to send and receive data between the Cost Recovery terminal and ShareScan Manager. The following versions are available: v1, v2, v3 (default) and v3.5.

Enter credentials

Click to bring up a dialog to enter the following user credentials for use: Username, Password, Domain, and UserID.

If UserID is used, the UserName, Password, and Domain fields must be blank.

Metadata

This button is enabled only if v3.5 radio button is selected under Protocol Version.

In order for Cost Recovery protocol version 3.5 to function properly, you must click Metadata... and click OK afterwards even when no data is provided.

  • Metadata key-value pairs: enter data into the Key and Value fields and click OK to record your key-value pairs.
  • Transaction handler: URI of the separate communication channel for protocol v3.5 for transmitting metadata and Cost Recovery transaction related data.

Save and close

Saves all field data to tcpclient.ini. The emulator always tries to load any value held in this file, which is located in the same folder as the emulator executable.

The text at the top of the status window (default value of Waiting for server messages) gives helpful tips about the state of the emulator.

Once the emulator has been configured, it is ready for use.

Terminal Emulator settings

Setting

Description

Status window

Displays time stamped status messages.

Connect

Connects to ShareScan using the server name and port configured in the configuration dialog. Once a connection has been established, the emulator sends an ECOPY_SCAN_BEGIN message to ShareScan. The CLID, MID, and Device ID values are all passed with this message.

This button is disabled once a connection has been established.

End

Only enabled once a connection has been established. Sends an ECOPY_LOCK_NOW message, waits for an ECOPY_LOCK message from ShareScan, and then disconnects from the TCP server.

Clear

Clears all text in the status window.

Top most

When checked, the emulator is always displayed on top of any window. When unchecked, the emulator retains its normal order.

Seconds left until lock

Displays a running countdown in seconds until the emulator times out. When the emulator times out, it sends the ECOPY_LOCK_NOW message, waits for the ECOPY_LOCK message from ShareScan, and then disconnects from the TCP server. Maximum timeout is 120 seconds.

Config

Pops up the configuration dialog.

NetStat

Pops up a command prompt window that runs the netstat –a –p TCP command.

Exit

Closes the application.