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.
|
Encryption type |
The type of encryption used to encrypt the XML data:
|
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.
|
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. |