Stay Linked - User.guide - Rev.10.0.0
Stay Linked - User.guide - Rev.10.0.0
Stay Linked - User.guide - Rev.10.0.0
Stay-Linked Administrator
User’s Guide
Stay-Linked Administrator User Guide Page 1 Rev. 10.0.0 Dated: 04/27/10
Table of Contents
Stay-Linked™, from evolveIT, Inc., is a software product that provides a complete solution for managing your
wireless terminals and their host Telnet and SSH sessions. This section describes the features and architecture of
the Stay-Linked product.
This section contains an overview of the basic steps required to get your Stay-Linked Wireless Terminal Session
Management Solution operational. Detailed administrator and server installation, upgrade, and uninstall
instructions are contained in the various platform-specific installation guides.
After completing the basic steps described below, you will be able to take advantage of the reliable wireless
terminal emulation and centralized management features that are provided by the Stay-Linked Terminal Session
Management and Device Management solution.
2.3 Install the Stay-Linked Client Software onto your Wireless Devices
• Download the appropriate Stay-Linked Client Software for your Wireless Devices
• Download and review the Stay-Linked User Guide for the specific device
• Install the Stay-Linked Client Software onto the device
• Configure the Radio and Network settings for the device and verify connectivity
• Configure the Client Settings, pointing the client to the IP address of the Stay-Linked Server
• Connect the client to the Stay-Linked Server and go to work
This section describes the Stay-Linked Administrator application, which provides centralized management of your
Stay-Linked servers, hosts, and wireless devices. The section begins by walking you through your first use of the
administrator, connecting to your Stay-Linked server, retrieving the server serial number, and installing the license
key. After that, the various functions of the administrator are described.
If you answer “Yes”, you will be prompted to add the server information. Just enter a name for the
server – anything will do – no more than 50 characters (15-20 characters is a good size). Then, enter
the IP address where the Stay-Linked server can be found. Of course, you will need to have a route to
the server system from the Administrator PC. Next, enter the UDP port number on the Stay-Linked
Server to which the administrator connects. The default port is 3006. Finally, you can specify that the
Administrator not query this server, in case the server is not always available. If you check this box,
the server list will show that this server has been ‘skipped’, but you can still select it to connect.
Enter the default User ID “administrator” and the default Password ‘esp’ for your server. Click OK.
Fill-in the appropriate client quantities and then cut-and-paste your license key into the text box.
Click ‘Validate’ and then click ‘Install License Key’ to complete this step.
• Menu Bar – The pull-down menu bar is used to navigate to various Administrator functions.
• Servers Tree – This Explorer-style outline control provides a list of all defined servers. Indented
below each server is a list of available server functions. Click on a function name to select it.
Depending on the function, a pop-up window or a list may appear in the main display panel. In
some cases, a second click of the function name with the right mouse button will show a small
menu of additional options.
• Main List Panel – Shows a list of defined servers, server functions, or function details
pertaining to the current function. In some cases, double-clicking an item in the list will perform
a default action. In some cases, clicking on items in the list with the right mouse button will
show a small menu of additional options.
• Server Status Bar – Shows current server and serial number.
• Current Server – Shows the currently-selected server. All functions apply to this server.
• Current Function – Shows the function whose list appears in the main display panel.
• Transfer Progress Bar – Shows the progress of file transfer transactions between the
Administrator and the Server.
Client TFTP Port: Configure this option to match the remote TFTP Port used on the device. The
TFTP Port used on the device can be configured using ‘Client Settings’.
Local TFTP Port: Configure this option to reflect the Local TFTP Port that you want to use on your
Administrator PC. You may need to configure this setting to match your firewall settings.
Client Athena Port: Configure this option to match the device port on which the Athena Services are
listening (if you have this application installed on the device).
Athena via HTTPS: Check this box if your Athena Service should be accessed via HTTPS.
Trans. Timeout: Increase this value in case of high-latency between Administrator and Server.
Monitor Local Port Range: Configure a Monitor port range to match your Firewall if needed.
The Server Alerts are classified as one of three levels, Information, Warning and Critical. Each Alert
records the Alert Level, Alert Date/Time and the Alert Message. You may view more details of a
selected alert by double-clicking or selecting the Alerts-Details menu option. The Details will usually
recommend actions that can be taken to resolve Warning or Critical alert conditions. Clicking the right
mouse button over an alert line will cause a small menu to appear with the following options:
Details– This menu option displays the details of the selected alert item.
Clear Alerts: Select this option to clear the Server Alert Log that is stored on the server.
Refresh: This menu option reloads the Server Alert dialog with the most recent alerts.
Log File Settings – These options are used to control the server logs. The server logs are used by
technical support to analyze connectivity issues. This option should be set to ‘No Logging’ unless
otherwise directed by technical support. The Max Log Size feature controls the size of the log files. If
desired, you can control the devices that generate logs by specifying a low and high IP range.
Server Statistics Settings: These options are used to control the server statistics. The server logs are
used by technical support to analyze connectivity and performance issues. The Interval should be set to
‘0’ (off) unless otherwise directed by technical support. The Max Stats Size option controls the
maximum size of the server statistics file.
Firewall Settings: If your devices are connecting to the Stay-Linked server through a firewall, then
you may need to restrict the ports that are assigned to devices and configure a server that is running
behind one-to-one NAT.
Use Fixed Port Range: You may enable this option and then specify a range of ports that the server
should use for device connections. You will need to ensure that you specify a range that is large
enough to accommodate the number of licenses that you are running. When there are no further open
ports available, then devices will no longer be able to connect to the server.
Key 1, Key 2, Key 3 and Key 4: You may specify one to four blowfish keys. Each key can be from 8
characters to 56 characters in length. The keys are case sensitive. The Encryption capabilities of the
Java Runtime used by the server will determine the maximum key length that can be used. If the Java
Runtime does not support a key of the length that you have entered, that key will be automatically
trimmed until it can be used. The server will only use Key 1 unless you specify a ‘Key Rotation
Interval’.
When you select the Delete option, you are prompted for confirmation. If you select the Add or Edit
options, the following window will appear where you can enter/edit the host group definition.
The two additional options are not available for the ‘Default’ Host Group. If you want to take
advantage of the Use ‘Group Name’ as Menu Title option or the Display ‘Quit’ on the Host
Menu option, then you will have to add a new Host Group where these options will be
available. You can then use the ‘Device Group’ feature to make your new Host Group
available to your devices.
Name: This is a descriptive name for the Telnet Host, i.e.: “Production iSeries”.
Address: This is the Host Name or IP address for the Telnet Host.
Telnet Port: This is the Telnet Port for the Telnet Host, typically port 23.
The Telnet Session Inactivity Timeout setting can be used to force old, unused sessions to be
ended, but the Stay-Linked Server has no idea if it is safe to terminate these sessions. It would
be safest to use your Telnet Server or end-user application to terminate sessions, if possible.
You can also specify a Telnet Session Inactivity Script that will be run before the session is
terminated because of a Session Inactivity Timeout event.
Manage - Alt Keyboards (menu option) Alternate Keyboard Maps: For Telnet Hosts, you can
override the keyboard map that a device would normally use and specify a different keyboard map to
be used as an alternate.
Keyboard maps are used by the Stay-Linked system as a cross-reference between the many and varied
device keyboards and the various host types (5250, 3270, and VT). With Stay-Linked, you can use the
default keyboard map or alter it to suit the specific needs of your device users and their applications. In
addition, you can create alternate keyboard maps to support variations needed for a specific host or
group of users.
In this example, when an Intermec 700C, 35-key device connects to this Host, the alternate keyboard
map for the Stay-Linked Generic PPC2003 device will be used instead.
You may add and delete these alternate keyboard maps using the Keyboard menu (the Add New
Alternate Map selection window is shown above). The Original Map and Alternate Map dropdowns
provide a list of available keyboard maps from which to choose.
Select “Save Changes” from the “File” drop-down menu to save any changes that you have made to
the currently selected host group.
Manage - Barcodes (menu option) Barcode Settings at the Telnet Host Level: If your device
belongs to a ‘Host Group’ that contains more than one host with different emulation types, then it
might be valuable to have different barcode settings for the different types of emulation hosts. For
instance, if your Host Group contains a 5250 Telnet host entry and also contains a VT220 Telnet host
entry, then you might require different barcode suffixes for the different hosts, like a Field Exit [fldext]
for the 5250 host and an Enter [enter] for the VT host. The configuration of barcode settings for a
Telnet Host entry is identical to the configuration of barcode settings for ‘Device Groups’ as described
in the Managing Barcodes section of this guide. The barcode settings that you define at the ‘Device
Group’ level have priority over any barcode settings that you define at the ‘Telnet Host Entry’ level.
Group Description: This is a descriptive name for the Device Group, i.e.: “Shipping Department”.
Group IP Address Range: This is the range of device IP addresses for this group.
Device Type: This is the device type filter for this group. The combination of IP Range and Device
Type are used to determine which devices will be a member of this device group. Leave this value
blank to include all device types in this device group.
Host Group: This is the Host Group that defines which emulation hosts will be available to devices in
this group. If the selected host group is not available at the time a device connects, then the device will
automatically use the ‘Default’ host group. A special host group named ‘Device Management Only’ is
also available for selection. This host group will cause the device to run a Device Management Only
session. There will be no Telnet or SSH access provided in this Device Management Only session. The
client software will behave much differently on the device when the client is running a Device
Management Only session.
Allow Connections: This checkbox provides the administrator with the ability to determine which
devices can establish sessions. This checkbox must be checked in order for devices belonging to this
device group to be able to connect to a telnet session.
Enable Undefined Barcodes: This option works in conjunction with the list of barcode types that are
configured for this device group. Check this box if you want to allow the device to scan barcode types
that are not specifically configured for this device group.
Append Field Exit to Short Scan (5250): For 5250 sessions, select this option to cause a FieldExit to
be automatically appended to barcodes that are shorter than the field into which they are being
scanned. This option is often used to enhance scanning into display fields that cause an automatic end-
of-record advance via the CHECK(ER) display attribute. (This setting has no effect for 3270 or VT).
Append Enter on Last Field (5250 & 3270): For 5250 and 3270 sessions, select this option to cause
an Enter to be automatically appended to barcodes that are scanned into the last field on the current
application screen. (This setting has no effect for VT).
Barcode Scan Prefix: This feature provides for the definition of characters to be inserted as a prefix to
the scanned data. Select from the Drop-down list, or key in your prefix characters. This setting will
affect all barcode symbologies unless a specific prefix is defined for a specific symbology.
Barcode Scan Suffix: This feature provides for the definition of characters to be inserted as a suffix to
the scanned data. Select from the Drop-down list, or key in your suffix characters. This setting will
affect all barcode symbologies unless a specific suffix is defined for a specific symbology.
You may add, edit, and delete Barcode Type entries using the “Barcode” menu or by right clicking on
a specific Barcode Type entry in the list. When adding or editing barcode types for this device group,
the following window will be displayed.
The following criteria are used to determine if the scanned barcode data will be affected by this
particular barcode setting:
Barcode Type: Use this drop-down list to select the barcode type that you wish to define.
Minimum Length: Specifies the minimum value length to have this setting apply.
Maximum Length: Specifies the maximum value length to have this setting apply.
• Note: Input length restrictions for barcode types can be eliminated by setting both the Minimum
and Maximum parameters to zero (0).
If the scanned barcode meets the criteria for this barcode setting, then you can control whether the
scanned barcode is allowed to be processed using the following option:
Decode this type: Use this checkbox to enable the use of the scanned barcode in the session. If this
option is checked, then the barcode is allowed and the barcode data manipulation functions are applied.
If this option is not checked, then the scanned barcode is rejected and the device will beep.
User Message: This parameter allows you to display a message on the device screen during the time
that the client-side program is running. If you leave this parameter blank, then no message is displayed.
Screen Dump File: This parameter gives you the option of dumping an image of the entire current
5250 screen to a text file on the read/write drive on the device. The file will be written to the device
before the client-side program is called. Do not specify a drive letter with the file name, as the Stay-
Linked client determines what drive is available for writing, depending upon the device make and
model. If you leave this parameter blank, then no screen image is written to the device.
Command/Program: This parameter specifies the DOS command or client-side program that is to be
called. If the program does not exist, no action will be taken and no error message is displayed. When
the program has completed it’s processing, the session continues normally.
Enable Screen-based Printing: This option will enable or disable client-side printing for this device
group for host applications where screen recognition is required.
Display the Screen Containing Printer Data: This parameter determines whether or not the screen,
which has been identified as containing printer command, is displayed on the device.
Enable Print Transaction Throttling: Forces acknowledgments for each printer data packet sent.
5250 Startup Script: Enter the startup script to be used when connecting to a 5250 Telnet host.
3270 Startup Script: Enter the startup script to be used when connecting to a 3270 Telnet host.
VT Startup Script: Enter the startup script to be used when connecting to a VT Telnet host.
In this example, when an Intermec 700C, 35-key device connects to this Host, the alternate keyboard
map for the Stay-Linked Generic PPC2003 device will be used instead.
You may add and delete these alternate keyboard maps using the Keyboard menu (the Add New
Alternate Map selection window is shown above). The Original Map and Alternate Map dropdowns
provide a list of available keyboard maps from which to choose.
Select “Save Changes” from the “File” drop-down menu to save any changes that you have made to
the currently selected device group.
Select the Manufacturer and then the Device and Host type from the drop-down lists of pre-defined
keyboard definitions. Once selected, click OK and you will be presented with the Keyboard Map
Editor dialog (see below).
Keyboard Map - Edit – Select this menu option in order to modify the keyboard mappings for the
selected keyboard map using the Keyboard Map Editor (see below).
Keyboard Map - Delete – Select this menu option in order to remove the selected keyboard maps
from the list.
Keyboard Map - Copy – Select this menu option in order to copy the selected keyboard map to an
alternate keyboard map.
You can change the description and enter the device type that you wish to use for this copied keyboard
map. The device type is the name you will use when referring to this keyboard map, and as such, must
be unique in the list of keyboard maps for this Stay-Linked Server. This option is useful for creating
alternate keyboard maps that can be assigned to Telnet Hosts and to Device Groups. Once entered,
click OK and you will be presented with the Keyboard Map Editor dialog (see below).
You must provide a description for this map and enter the device type that you wish to use for this
copied keyboard map. The device type is the name you will use when referring to this keyboard map,
and as such, must be unique in the list of keyboard maps for this Stay-Linked Server. Finally, select
the emulation type for which this map will be used. This option is typically used to support devices for
which there is no pre-defined keyboard map. If the device does not appear in the ‘Select a Keyboard’
dialog, then use this option to build a map from scratch. Once entered, click OK and you will be
presented with the Keyboard Map Editor dialog (see below).
NOTE: Keyboard maps that are ‘created’ and are not based upon a pre-defined keyboard definition
will only contain keys that you define. Whereas keyboard maps that are based upon keyboard
definitions contain all possible key combinations that are reasonably available on the device, even if
those keys have not been mapped to anything.
• Key Code: Stay-Linked Clients on DOS devices will have a ‘Keyboard Test’ option on the
‘Diagnostics’ menu. Stay-Linked Clients on PPC/CE devices will have a ‘Key Test’ option on
the ‘Tools’ menu. Use this test to determine what ‘Key Code’ is generated by the possible key
combinations on the device. If this ‘Key Code’ is not defined in the pre-defined keyboard map,
you can add the key to the map by entering its code.
• Mapping: You can select a mnemonic from the drop down list, or type in the character or text
that you wish to map to this key.
• Modifier: Select from the list the most appropriate modifier based on the key combination you
are mapping.
• Key Name: Enter the name of the key you are mapping (i.e., A).
Update Key Entry Dialog: Use this dialog to select the mnemonic or function you wish to associate
with the selected key combination.
• Mapping: You can select a mnemonic from the drop down list, or type in the character or text
that you wish to map to this key.
Double clicking on one of these emulation types will cause the tap spot maintenance panel to appear.
Delimiters: Enter a string of characters, each of which will be used to identify the limits of a word or
number that is tapped upon. The ‘Space’ character is automatically included in the string of delimiters.
Fill Short Number: Use this drop-down selection to cause either a FieldExit key, an Enter key or
Nothing to be automatically appended to tapped numbers that are shorter than the field into which they
are being entered.
Allow Tap Cursor Movement?: This option, if selected, will allow the cursor to be moved to the
location that was tapped, so long as that location did not contain a Tap Spot. Deselect this option to
prevent inadvertent movement of the cursor to protected areas of the display.
Tap Numbers?: This option, if selected, will cause all numbers that appear on the session screens to
be treated as tap spots (useful for numbered menu lists, etc.).
From the File Menu:
• Save Changes: Select this menu option to save the current tap spot mappings.
• File - Exit: Select this menu option to close this dialog.
From the Spot Entries Menu:
• Add New: Select this menu option to add a new tap spot entry.
• Edit: Select this menu option to edit the selected tap spot entry.
• Delete: Select this menu option to delete the selected tap spot entry.
• Spot Text: Enter the text, as it will appear on the screen, which you wish to make tap sensitive.
The text can only be entered in upper case and the match is not case sensitive. The text on the
screen must appear between two delimiters.
• Mapping: You can select a mnemonic from the drop down list, or type in the character or text
that you wish to map to this key.
Update Tap Spot Dialog: Use this dialog to select the mnemonic/text you wish to associate with the
selected Tap Spot Text.
• Mapping: You can select a mnemonic from the drop down list, or type in the character or text
that you wish to map to this key.
• Group: Use this drop-down list to select a group of settings to work with.
• Setting: Use this drop-down list to select from the client settings included in the selected group.
After a selection is made, a brief description of the setting is provided below. You can hover
your mouse-pointer over the ‘setting’ to display a ‘tool-tip’ that will show the syntax for the
current client setting and the selected value.
• Enabled: Check this option to enable the setting. Only enabled settings will be kept current on
the targeted devices.
• Sort Settings: Check this option to have the contents of the ‘Setting’ drop-down list be sorted
alphabetically. This option will be remembered the next time you use this dialog.
• Setting Level: Use this drop-down list to select from the following distribution groups:
Global – Setting applies to all devices
Device Type – Setting applies only to the specified device type (a text box will appear for
you to enter the device type or a drop-down list of devices will be provided if the setting
only applies to certain devices). Note: when specifying a device type, enter the value exactly
as reported by the device. The only exception to this would be the use of the ‘*’ wildcard
character at the end of your entry. This will allow you to cover multiple, similar devices with
a single entry. Use this option to define a setting for all devices of a specific type.
IP Range – Setting applies only to the specified range of IP addresses (2 text boxes will
appear for you to enter the Low and High IP addresses)
MAC Address – Setting applies only to the specified MAC address (a text box will appear
for you to enter the MAC Address). Use this option to define a setting for a single device.
• Setting Value: Depending on the Setting, you enter a value into a text box or select from a drop-
down list of available options.
• Setting: Displays the current setting and a description below. You can hover your mouse-pointer
over the ‘setting’ to display a ‘tool-tip’ that will show the syntax for the current client setting
and the selected value.
• Enabled: Check this option to enable the setting. Only enabled settings will be kept current on
the targeted devices.
• Setting Level: Use this drop-down list to select from the following distribution groups:
Global – Setting applies to all devices
Device Type – Setting applies only to the specified device type (a text box will appear for
you to enter the device type or a drop-down list of devices will be provided if the setting
only applies to certain devices). Note: when specifying a device type, enter the value exactly
as reported by the device. The only exception to this would be the use of the ‘*’ wildcard
character at the end of your entry. This will allow you to cover multiple, similar devices with
a single entry. Use this option to define a setting for all devices of a specific type.
IP Range – Setting applies only to the specified range of IP addresses (2 text boxes will
appear for you to enter the Low and High IP addresses)
MAC Address – Setting applies only to the specified MAC address (a text box will appear
for you to enter the MAC Address). Use this option to define a setting for a single device.
• Setting Value: Depending on the Setting, you enter a value into a text box or select from a drop-
down list of available options.
• Enabled: Check this option to enable the setting. Only enabled settings will be kept current on
the targeted devices.
• Setting Level: Use this drop-down list to select from the following distribution groups:
This example shows the dialog for sending a ‘locale.ini’ file to devices that are of a specific device
type, in this case Symbol PDT9000 devices.
• Import File Name: The original ‘locale.ini’ file was located on the Administrator PC in the
‘c:\localize’ folder with the name ‘locale_greek.ini’. This file will be transferred to the server.
• Server File Name: The unique file name to be used for this file when it is stored on the server
has been entered as ‘locale_greek_pdt9000.ini’. Since all of the files selected for ‘Configuration
File Transfer’ settings will be stored in a single folder on the Stay-Linked Server machine, each
of these files must have a unique file name in this folder on the server. The files are stored on the
Stay-Linked Server at ‘..\stay-linked\deploy\files’.
• Device File Name: The name of this file as it will be stored on the device is ‘locale.ini’. The
‘locale.ini’ is a special configuration file that is recognized and managed by the Stay-Linked
Client. In this case, it is not necessary to provide a path for the file on the device.
After configuring the dialog for ‘Add Device Setting’, press the OK button to validate the dialog. Once
validated, the file will be transferred from the Administrator to the Stay-Linked Server where it will be
stored for deployment to qualifying devices. When a Stay-Linked device creates a new connection to
the Stay-Linked Server, and both ‘Configuration File Deployment Settings’ and ‘Device Settings’ are
to be sent to the device, first the ‘Configuration Files’ will be transferred to the device and then
immediately the ‘Device Settings’ will be sent to the device. The Stay-Linked Client will restart
automatically after receiving these files and settings and then, upon connection, those settings will take
effect immediately.
• Package File: Type or browse for the client deployment package file name (with the .sdp
extension) that you wish to import. Client deployment package files are available on the Stay-
Linked portal site.
• Verify: Click on this button to verify the deployment file and contents. If the file is a valid
deployment package, the Package information will be displayed in the window and the ‘Verify’
button will transform into an ‘Install’ button.
• Install: Click this button to install the package onto the Stay-Linked server. By default, when a
new package is installed, it will be disabled until it has been manually reviewed and enabled.
When you select the Edit option from the menu, the following window will appear:
Session Partnerships - Add – Select this menu option in order to add a session partnership.
Session Partnerships - Edit – Select this menu option in order to modify the attributes of the selected
partnership.
Session Partnerships - Delete – Select this menu option in order to remove the selected partnership
from the list.
Scan2Command/Scan2Configure - Add – Select this menu option in order to add a new profile.
Scan2Command/Scan2Configure - Edit – Select this menu option in order to modify the contents and
attributes of the selected profile. You can also use this option to print an existing profile.
Scan2Command/Scan2Configure - Delete – Select this menu option in order to remove the selected profile
from the list.
Profile Name: This text box is used to enter the unique name for this Scan2Command or Scan2Congfigure
Profile.
Symbology: Select from this list the symbology to be used for printing the profile barcode sheet. You can
select from the following symbologies: Code 39 Full ASCII (1D), Code 128 (1D), PDF417 (2D), QRCode
(2D) or DataMatrix (2D).
Symbology Notes: If you select Code 39 Full ASCII, then you must ensure that your scanners are
configured to read Code 39 Full ASCII. If you select a 2D symbology for your Scan2Congfigure profiles,
this will cause the client settings to be combined into one (or more) 2D barcode images.
From the File Menu:
• Save Changes: Select this menu option to save the current profile.
• Print: Select this menu option to print the current profile.
• Print Preview: Select this menu option to preview the printed current profile.
• Settings – Barcode Delimiter: Select this menu option to change the delimiter used to identify a
Scan2Command or Scan2Configure barcode to the Stay-Linked Client software.
• Settings – Barcode Spacing: Select this menu option to change the vertical spacing between printed
barcodes.
From the Commands/Settings Menu:
• Add New: Select this menu option to add a new command or setting.
• Add Post-Config Command: Select this menu option to add a post-configuration command. This
option is only available for Scan2Configure profiles.
• Edit: Select this menu option to edit the selected command or setting.
• Delete: Select this menu option to delete the selected command or setting.
• Move Up: Select this menu option to move the selected command or setting up in the list.
• Move Down: Select this menu option to move the selected command or setting down in the list.
• Command: You can select a command from the drop down list, or directly type in a command or
script to be encoded into the barcode.
• Caption: Type in a meaningful caption that will be printed below the barcode image.
If you select to Add or Edit a Scan2Configure Setting entry, you will be presented with a dialog similar to
this:
• Setting: In Add mode, you can select a client setting from this drop-down list.
• Setting Value: Depending on the selected Client Setting, you enter a value into a text box or select
from a drop-down list of available values.
• Barcode Caption: Type in a meaningful caption that will be printed below the barcode image.
• Print ID: Check this box if you would like to have the ‘Setting ID’ encoded into the barcode data
rather than having the ‘Setting Name’ encoded into the barcode data. The ‘Setting ID’ is a three digit
numeric value that will create a smaller barcode that if you encode the ‘Setting Name’.
Select a group by double clicking on the group name in the list. A list of connections that belong to the
selected group will appear in the main display panel.
Open – This menu option will send the list of connection groups to the main display panel.
Refresh – This menu option will cause the currently displayed connections list to be refreshed from
the server. There is no automatic or periodic refresh of this data, so you will need to take this option or
press F5 whenever you want to get the latest connection list.
Print List – This menu option will send the list of connected devices to a report on your current
Windows default printer. The report will include columns for Device Type, Device Name, MAC
Address, IP Address, Client Version and User/Device ID.
Export List – This menu option will export the list of connected devices to a ‘Comma Separated
Variable’ (.csv) file of your choice. The export will include all of the connections and columns that are
displayed in the Connections List. This format is appropriate for import into common spreadsheets and
databases.
Start Console Session – This menu option will establish a connection to the current Stay-Linked
Server using the built-in Stay-Linked Console Client. This feature provides an easy way for the
administrator to confirm the operation of the Stay-Linked Server. The Stay-Linked Console Client runs
on the Administrator PC and is a fully functional Stay-Linked Client for Windows.
When you are finished running a Console Session, press the ‘Esc’ key to “Quit Session” and
then press the ‘Y’ key to end the session. Finally, press the ‘0’ key to exit the Console Client.
Details Tab: This tab displays information about the device, connection and session.
User Variables Tab: This tab will display any defined ‘User Variables’ that have been User Variables
are implemented using Host APIs and Screen Recognition features.
* You can right-click on Session ID, Device Type, Device Name and MAC Address to copy the values to the clipboard.
File: Send to Device: TFTP – This panel allows the administrator to send files to the device using the
TFTP protocol. The files will be stored on the writable media on the device.
• Device IP Address: This is the IP address of the currently selected device and may be manually
changed to another IP if desired.
• Port: This is the port on the device that is used for the file transfer function. The default port is
3773.
• Local File to Send: This is the full path to the file that will be sent to the device. You may use
the Browse button to locate this file.
• Remote File Name: This is the name of the file that will be stored on the device. You may
include the file path. The path must exist on the device and be writable on the device.
• Send File/Receive File Options: This option allows you to toggle between Send and Receive
modes.
• Send File Button: Click this button to send the file to the device.
• Close Button: Use this button to close the ‘Send File to Device’ dialog.
File: Receive from Device: Reliable – This panel allows the administrator to receive files from the
device using the Stay-Linked Reliable protocol. The files will be retrieved from the writable media on
the device.
File: Receive from Device: TFTP – This panel allows the administrator to receive files from the
device using the TFTP protocol. The files will be retrieved from the writable media on the device.
• Device IP Address: This is the IP address of the currently selected device and may be manually
changed to another IP if desired.
• Port: This is the port on the device that is used for the file transfer function. The default port is
3773.
• Local File Name: This is the full path to the file that will be received from the device. You may
use the Browse button to specify this file name.
• Remote File Name: This is the name of the file that will be retrieved from the device. You may
include the file path.
• Send File/Receive File Options: This option allows you to toggle between Send and Receive
modes.
• Receive File Button: Click this button to receive the file from the device.
• Close Button: Use this button to close the ‘Receive File from Device’ dialog.
• Reboot device after message: This option allows the administrator to have the device
automatically reboot after the device user answers the message. After rebooting, the device will
automatically reconnect to the same session and display the same screen and cursor to the device
user. You can seamlessly continue the previous task after the reboot and reconnect is completed.
• Restart client after message: This option allows the administrator to have the client software
automatically restart after the device user answers the message. After restarting, the device will
automatically reconnect to the same session and display the same screen and cursor to the device
user. You can seamlessly continue the previous task after the restart and reconnect is completed.
• Message Text Box: Type your message into this text box.
• Send Button: Click this button to send the message to the device.
• Cancel Button: Use this button to close the ‘Send Administrator Message’ dialog.
Commands: Clear Client Log File – This command causes the log file on the client to be cleared.
The client log file is named staylink.log and is stored on the device’s writable media. Stay-Linked
Support generally uses the client log file for debugging and problem analysis.
Commands: Reload Client Settings – This command causes the client software to reload its
operating parameters from the Client Configuration file. The Client Configuration file is named
staylink.ini and is stored on the device’s writable media.
Commands: Resend All Client Settings – This command causes the server to send all active client
settings to the client device, replacing any previous values found there. This is an override to the
existing “smart” client settings update that occurs during the device connection request. This command
will not trigger a transmission of any ‘Configuration File Transfer’ client settings.
Commands: Execute Remote Program/Command – This command allows you to specify a
command to run locally on the device. The command can call a program that is installed on the device
• Show ‘Press Any Key’: This option will cause a ‘Press any key’ message to be displayed on the
client device after the command has been executed.
• Clear Device Screen: This option will cause the screen to be cleared on the client device prior
to executing the command.
• Command Text Box: Type the command/program to call into this text box.
• Execute Button: Click this button to send the command to the device.
• Cancel Button: Use this button to close the window.
Commands: Device Management Interface -> Start/Stop – These command are only available if the
client is running the tightly integrated Stay-Linked Device Management components. Using these
commands, the Device Management Interface (service) on the device can be stopped and started.
Commands: Restart Client – This command causes the client software to exit the active session and
return to the Main Menu. The active session will not be terminated. When the device user selects the
‘Connect to Host’ option on the Main Menu, the device will automatically reconnect to the same
session and display the same screen and cursor to the device user. The user can seamlessly continue the
previous task after the reboot and reconnect is completed.
Commands: Reboot Device – This option allows the administrator to have the device automatically
and immediately reboot. After rebooting, the device will automatically reconnect to the same session
and display the same screen and cursor to the device user. The user can seamlessly continue the
previous task after the reboot and reconnect is completed.
• Remote File: Type the file name that you wish to view into this text box.
• OK Button: Click this button to send the request to the device.
• Cancel Button: Use this button to close the window.
View: Client, Session, Protocol, and IP Traffic Logs – (normally hidden, invoked by Stay-Linked
technical support). These options allow the administrator to view the contents of the specified log file
from the client device or from the server.
This monitor window will be updated in real time as the device is utilized.
You may monitor more than one device at a time, depending upon the
available space on your desktop. In order to terminate a monitor session, find
the device in the connection list and select the ‘Monitor’ menu option again
to toggle this feature off. The monitor window on your PC will close
automatically. Or, just click on the [X] in the Monitor Window to close the
monitor session.
As the administrator, you are able to type into this window and run the
session. The original user will see your changes on the device. If you types on
the device, you will see those changes in your share window. You may share
more than one device at a time, depending upon the available space on your
desktop and available licensed seats installed on the server. In order to exit a
shared session, press the ‘Esc’ key and you will be prompted to ‘EXIT
SESSION? (Y)es or (N)o’ . Press ‘Y’ to quit the session. The original user
will be able to continue.
You can now type and control the session as if you had started the session
yourself. The Take Control function is not reversible. Once you take control
of a session, the device will not be able to regain control of that session. The
device might be able to start a new session. This feature is especially useful
to complete sessions after a device has been disabled.
Enter a valid session ID and, if verified, the session will be transferred to the target device.
IMPORTANT: It is recommended that you create at least one additional User ID with ‘Administrator
Management’ permissions. This way, if the master ‘administrator’ User ID becomes disabled, or you
cannot remember the password, there will be a way to reset the master ‘administrator’ User ID. If,
however, the master ‘administrator’ User ID becomes disabled or otherwise cannot be accessed, there is
a way to reset it. You will need to create an empty file named ‘resetadmin.xml’ and place that file onto
the server in the ‘..\stay-linked\config’ folder. Then, the next time the Stay-Linked Server process is
started, the master ’administrator’ User ID will be reset to its default state. The ‘administrator’ User ID
will be re-enabled and the password will be reset to ‘esp’. However, a server process restart is required.
• The Administrator Management functions are divided into three groups of configuration
settings:
• List Users – Display and edit User IDs that are allowed to manage this server.
• List Groups – Display and edit Groups that predefine groups of permissions for this server.
• Change Settings – Display and edit settings that control the Administrator Management
functions.
User ID: This column displays the User IDs that have been defined on this server.
User Type: There are two types of users. There will be only one ‘Administrator’ type user with the
User ID of ‘administrator’. All other User IDs that you defined will be of type ‘User’.
Description: This is a free-form description that you can enter to help identify a user.
User Group: This column displays the group that the User ID belongs to. If the User ID does not
belong to a group, then this column will display the special value of ‘*NONE’.
User Status: This column displays the status of the current user as either ‘Enabled’, ‘Disabled’ or
‘Expired’.
Expire Date: This column displays the date that the password will expire for the User ID. If the
Password Expiration Interval setting is set to zero, then this column will display ‘n/a’.
Clicking the right mouse button in a blank area or on a User ID will cause a small menu to appear with
options you can perform.
The User ID name is case-sensitive. You can enter any name that does not already exist on this server.
The names ‘John’ and ‘john’ are considered to be unique names and they can both exist on the server
at the same time. It is recommended to use lower-case User IDs for consistency and simplicity. When a
User ID is created, the password is set to match the new User ID name. The User ID is also created in
the expired status and the user will be forced to change the password the first time they log on using
this new User ID. Once the User ID is created, it will appear in the User List and you can then
configure the permissions for the user as desired.
Expire Date – The date that the User ID will expire and require the user to enter a new password. If
this value is displaying ‘n/a’, then this means that the server is configured to never expire User IDs.
Permissions List – This list contains all of the modules and functions that can be controlled using
permissions. The list displays these columns:
Module – The module in the Administrator to which the permissions apply.
Function – The specific function within the module to which the permission applies.
Setting – The configurable setting that controls the effective permission for this module/function.
Value – The effective permission for this module/function based upon the selected setting.
If the User ID has any ‘Connection Filters’ defined, then there will be no ‘Connection List’
module functions displayed in this ‘User Information’ permissions list. Instead, you will select
the ‘Connection Filters’ option from the ‘View’ menu to access the ‘Connection Filters’ that have
been defined for this User ID. When you edit a ‘Connection Filter’, you can configure the
permissions that will apply for the ‘Connection List’ module for the Connections to which the
user is allowed access according to that Connection Filter.
*GROUP – Set the permission to the value defined in the Group for this module and function.
*YES – Give the user permission to this module and function, overriding any Group settings.
*NO – Deny the user permission to this module and function, overriding any Group settings.
The menu options that will appear are based upon the current setting for this item and the Group
membership for the User ID.
If the User ID is not a member of a Group, then depending upon the current setting, the only possible
menu options will be either *YES -or- *NO.
If the User ID is a Group member, then depending upon the current setting, the menu options could be
either *YES and *NO -or- *GROUP and *YES -or- *GROUP and *NO.
When setting permissions, you can select multiple items from the permissions list and apply your
desired setting to all of them at once. If you use Ctrl-Click, then you can select multiple individual
items from anywhere in the list. If you use Shift-Click, then you can select a contiguous block of items.
Right-click on the selected items and a context menu will appear with the available permissions,
depending upon whether the User ID is a member of a Group or not.
If the User ID is not a member of a Group, then the menu options will include both *YES and *NO.
If the User ID is a Group member, then the menu options will include *GROUP and *YES and *NO.
The permission that you select from the menu will be applied to all selected items in the list.
You can Add and Delete Allowed Origin IPs from the list.
Add – Select this menu option to add a new Allowed Origin IP for this User ID. You will be presented
with a dialog into which you can type the Allowed Origin IP address:
Delete – Select this menu option to delete the currently selected Allowed Origin IP. You will be
prompted to delete the Allowed Origin IP.
Delete – Select this menu option to delete the currently selected Connection Filter. You will be
prompted to delete the Connection Filter.
Edit – Select this menu option to edit the currently selected Connection Filter. You will be presented
with the Edit dialog where you can change the Filter Type if desired. You can also use this dialog to
change permissions for the various connection list functions.
On the Add Connection Filter dialog, you can select your desired Filter Type as either ‘by Device
Group’ or ‘by IP Range’. Depending upon your selection, the dialog will change to enable
configuration of the Connection Filter for that Filter Type.
by Device Group – This option allows this User ID to access connections based upon the ‘Device
Group’ to which the connection belongs. The dialog will provide a ‘Device Group’ drop-down list
from which you can select the desired ‘Device Group’ for this connection filter.
by IP Address – This option allows this User ID to access connections based upon the device’s local
IP address being contained in the IP range defined for this connection filter. This dialog will provide a
‘Low IP’ and a ‘High IP’ text box where you can enter the desired IP Range for this connection filter.
Changing Permissions – The permissions list will contain all of the possible functions that are
available from the Connections List. You can set the permissions that this user has for the individual
function by right-clicking on the item in the permissions list. A context-sensitive menu will appear
with the available permissions for this selected item. Depending upon the current setting, the only
possible menu option will be either *YES -or- *NO.
When setting permissions, you can select multiple items from the permissions list and apply your
desired setting to all of them at once. If you use Ctrl-Click, then you can select multiple individual
items from anywhere in the list. If you use Shift-Click, then you can select a contiguous block of items.
Right-click on the selected items and a context menu will appear with the available permissions, both
*YES and *NO. The permission that you select from the menu will be applied to all selected items in
the list.
Select the ‘Save Changes’ option from the File menu to save your changes to this User ID.
Type in the ‘New Password’ and then retype the password into the ‘Confirm New Password’.
The password that you enter must validate against any password configuration settings that may be in
effect on this server, like ‘Minimum Password Length’, ‘Maximum Password Length’ or ‘Require
Digits in Password’.
Clicking the right mouse button in a blank area or on a Group will cause a small menu to appear with
options you can perform.
The Group name is case-sensitive. You can enter any Group name that does not already exist on this
server. The names ‘Warehouse’ and ‘warehouse’ are considered to be unique Group names and they
can both exist on the server at the same time. Once the Group is created, it will appear in the Group
List and you can then configure the permissions for the Group as desired.
The Group Permissions List will contain all of the possible module functions that are available to be
pre-configured for a Group. You can set the permissions that this Group has for the individual function
by right-clicking on the item in the permissions list. A context-sensitive menu will appear with the
available permissions for this selected item. Depending upon the current setting, the only possible
menu option will be either *YES -or- *NO.
When setting permissions, you can select multiple items from the permissions list and apply your
desired setting to all of them at once. If you use Ctrl-Click, then you can select multiple individual
items from anywhere in the list. If you use Shift-Click, then you can select a contiguous block of items.
Right-click on the selected items and a context menu will appear with the available permissions, both
*YES and *NO. The permission that you select from the menu will be applied to all selected items in
the list.
Select the ‘Save Changes’ option from the File menu to save your changes to this Group.
You must double-click on one of the settings in the list in order to make changes to that setting.
If you wish to have the User ID be disabled, click ‘Yes’. If you wish to take no action, click ‘No’. To
leave the current setting, click ‘Cancel’.
Enter the new password expiration interval. Enter zero (0) if you want the passwords to never expire.
Enter a value of 1 to 366 days to cause passwords to expire after that number of days.
Enter a value between 1 and 50 and then press OK. To leave the current setting. press Cancel.
Enter a value between 1 and 50 and then press OK. To leave the current setting. press Cancel.
If you wish to require digits in passwords, click ‘Yes’. If not, click ‘No’. To leave the current setting,
click ‘Cancel’.
Examples:
• The mnemonic [hex 0D] will insert an ASCII CR (Carriage Return) into the script.
• If you need to include any square brackets in your script, you should include two of them.
• The mnemonic [hex 1B5B5B32347E] is the equivalent of ‘ESC[24~’ or the VT F12 key.
• This script ‘[hex 1B][[24~’ is also the equivalent of ‘ESC[24~’ or the VT F12 key.
These special scripting mnemonics are available for the following Stay-Linked Features:
• VT Telnet Host Property – ANSWER BACK MESSAGE
[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [userid], [deviceid], [devicetype]
• Telnet Host and Device Group Startup Scripts
[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [var ##], [delay], [long_delay], [userid] ,
[deviceid] , [devicetype]
eSP Error ID: Error Message Text Possible Causes and Solutions
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
Stay-Linked Administrator User Guide Page 100 Rev. 10.0.0 Dated: 04/27/10