eManager 3000 Overview

eManager is an advanced software tool used to manage and maintain Visara products remotely. eManager allows you to make software updates and configuration changes to the products from a remote workstation. Some of the functions supported by eManager include:

Store specific product information in the eManager database on all Visara products installed
Automatically locate and enter Visara products into the database
Create and store update objects for configurations and code
Create and execute distribution plans for the update objects
Backup configurations for all Visara products onto the centrally located eManager platform
Shadow remote users on select desktop products
Monitor network availability of defined nodes

eManager uses standard IP protocols to communicate with the individual product nodes through available network connections. A complete Visara network can be managed easily and efficiently from a central location using eManager. eManager works with the following Visara products:

1683, 1783, 1883 Network Computing Terminals
eTerm 300, 350, 360, 760 Windows Based Terminal (WBT)
LINCS Communication Servers (1174 and SCON models)

Getting Started

If you have not installed eManager, refer to Appendix A for installation instructions.

Once installed, you can start eManager from the Start menu, generally located at the bottom of your screen on the left side. Click Start, Program Files, Visara eManager, eManager. When eManager loads, a password prompt is displayed. You must key in the correct password to start eManager. The initial password is ‘eman’. Key ‘eman’ and click OK to finish loading. When loading finishes, product node, configuration and code update names, and distributions are loaded from the database if they exist. See the discussion on the Folders/Items screen for details. Once loaded, it is recommended that you change the password to something more secure. See the eManager Configuration Panel for instructions on changing your password. To use eManager for code or configuration management, the following steps are generally required:

Add Product Nodes To The Database (use Autolocate or add manually)

Create optional Distribution Groups if desired
Create Code and Configuration Updates as needed
Create a Distribution Plan to distribute Updates to the necessary targets

There are instructions in the Folders/Items screen discussion to accomplish each of these steps.

Folders/Items View Screen
General

The Folders/Items View Screen is the initial screen displayed and is used to launch most eManager functions. The Folders View on the screen’s left side displays a tree structure with three primary branches: Network Nodes, Update Files, and Distribution Plans. Each branch of the tree can be expanded or collapsed by clicking the + or – respectively. The Items View on the right side displays a view of items that can be node information, update or configuration files, or distribution plan information, depending upon what has been clicked in Folders view. This operation is quite similar to Window Explorer except for the type of information displayed. Information displayed in the Items View can be printed as a report by selecting Reports/Item View Report from the menu at the top of the panel.

A sample structure of the Folders tree is shown below with a description of each branch.

Network Nodes

\__Product - Product model e.g. 1783. Clicking a product branch displays all product nodes for the product type in Items View. Expanding the product branch displays the groups defined for that product type.

\__Group Name – Group Name. Clicking a group branch displays all product nodes assigned to the group in Items View. Expanding the group branch lists the members of the group in Folders View.

\__Group Node – Node that are members of this group

Updates

\__Product – Product model e.g. 1783

\__Code – All code updates for parent product are under this branch

\__ Code Object Name – Name of a code revision. Clicking a code object name displays the code object's files in Item View.

\__File Name – Names of all files in code revision

\__Config – All configuration updates for parent product are under this branch

\__ Configuration Object Name – Name of a configuration change. Clicking a configuration object name displays the configuration object's files in Item View

\__Pull – All pull updates for parent product are under this branch

\__ Pull Object Name – Name of a Pull update change. Clicking a pull update object name displays the pull object's files in Item View

Distributions

\__Product – Product model e.g. 1783. Clicking on a product branch displays the distribution plans saved for this product

\__Name – Name of distribution plan.

The information displayed in the Item View can be displayed in various formats including Icon View, Small Icon View, List View and Report View. In Report View, data is displayed in tabular columns each with a column title. Clicking the column title causes a sort to occur using data in that column. For example, clicking the Name title would sort entries in alphabetical order according to the name. Clicking again will sort in reverse alphabetical order. Another example is clicking the IL title will sort node entries by Integration Level.

The Folders/Items screen contains a menu bar, buttons, and drop down menus to perform various functions as described below. In general, many of the buttons and menus expect you to select a branch in Folders view or the item in Item view before clicking the menu or button. Also, in some cases you may need to collapse, then expand a branch in Folders View or click on a branch to refresh the screen with changes made by the function just performed. In some cases, e.g. after an AutoLocate, you will need to click the File/Reset Menu to update the information on this screen, or just click the product type in the Folders View section.

Product Node Management

Adding Product Nodes to the Database

Nodes can be added to the database by manually entering a minimal amount of node data, by using the AutoLocate function, or by importing an existing eManager database. The AutoLocate function provides the easiest way to add product node information in most cases, if a structured naming scheme is to be used.

Manual Method

Click on the desire product branch in Folders View, then right mouse click and select Add Nodes. This displays the Node Viewer Screen, which contains fields where node parameters can be entered. See the Node Viewer Screen discussion for details. Once you enter the basic information required for your node definitions (name for the node and IP address, in most cases), you can use the "Collect Data from Nodes" function to gather the remaining information from the nodes themselves. You can also click Nodes on the menu bar and Add Node to display the Node Viewer screen.

Using AutoLocate

Click on the <AutoLocate> button to display the AutoLocate Screen which can be set up to search a range of addresses and store any Visara product nodes found. See the AutoLocate Screen discussion for details. You can also bring up the AutoLocate screen by clicking on any product branch in Folders View, then right mouse click to display the dropdown menu and select AutoLocate. You can also click Nodes/AutoLocate on the menu bar to display the AutoLocate screen.

Editing Product Nodes

Click on the desired product branch in Folders View to display the desired product node in Item View, then right mouse click it and select Edit Nodes. This displays the Node Edit Screen, which contains fields where node parameters can be edited. Editing node parameters does not change anything configured at the node itself, only the information stored in the eManager database. See the Node Edit Screen discussion for details. You can also highlight the node in Items View and click Nodes / Edit Node from the menu to display the Node Edit screen.

Viewing Product Nodes

Click on the desired product branch in Folders View to display the desired product node in Item View, then right mouse click it and select View Node Info. This displays the Node View Screen, which contains information specific to the selected node, as stored in the eManager database. You can also double click the node in Item View to bring up the same information.

List Group Affiliation

Click on the desired product branch in Folders View to display the desired product node in Item View, then right mouse click it and select List Group Affiliation. A message box will appear listing all of the groups that the selected node is part of.

Adding a Group

You may decide to create a group when you have product nodes in a department or location that you desire to view, update, monitor, and/or create backups as a group. To add a group name, click on the desired product branch in Folders View, then right mouse click to display the dropdown menu and select Add Group. At the prompt, enter a group name and click OK. The group name you entered is added under the selected product. You can also click Nodes on the menu bar and Add Group to display the prompt. Collapse, then expand the product branch to show the new group.

Adding Product Nodes to a Group

Product nodes can be added to a group by editing the node using the Node Viewer Screen or with a drag drop operation. See the Node Viewer Screen discussion for details on this method. To drag and drop, click on the desired product branch in Folders view to display its product nodes in Item view. Then select the desired nodes in Item view. Multiple selections are possible by holding down the <Ctrl> key as nodes are clicked to add one at a time or holding down the <Shift> key to select a range. Double click, but stop with the mouse button down and drag the nodes to the desired group. As the mouse pointer moves over the branches in Folders view, they are highlighted so you can see the target selected. When the desired group is highlighted, release the mouse button and the nodes are added to the group. Note that product nodes can not be copied to a group in another product type. Also, if the selected target is not a group, nothing happens.

You can also add product nodes to a group as part of the AutoLocate function, by specifying which group the nodes are to be added to when detected.

Deleting Nodes and Groups

You can delete a node(s) from the database, delete a node(s) from a group, or delete a group. In each case the first step is to highlight the desired selection.

To delete a node from the database, click on a product in Folders View to display its product nodes in Item View. In Item view, click on the desired node or nodes to select them, then right-click the mouse to display the dropdown menu and select delete node. The node is completely removed from the database.

To delete a node from a group, click on the group in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select delete node. The node is removed from this group but remains in the database.

Multiple product node selections are possible by holding down the <Ctrl> key as nodes are clicked to add one at a time or holding down the <Shift> key to select a range.

To delete a group, click on the group in Folders view, then right click the mouse to display the dropdown menu and select delete group. The group is removed from the database; however product nodes that were in the group remain in the database.

You can also click Nodes on the menu bar and the appropriate delete function.

Renaming a Group

You can rename a group by highlighting the name of the group in Folders View and right-mouse-clicking to display the pop down menu. Select Rename Group from the menu. A box with an edit field will appear to allow you to change the name. Note that the underscore character "_" is not allowed as part of the name.

Updating Node Information

If your network information is current within eManager, the simplest way to update the node information in the database is to use the Collect Node Data function. eManager connects to each node selected for updating, downloads the latest information and updates the database. See the Collect Node Data Screen discussion for details.

For networks where DHCP is used, and IP addresses are constantly changing, the preferred method of updating information in the database uses the AutoLocate function to update the database. A 'Minimal Information' option on the AutoLocate panel can be used to keep the process short. See the AutoLocate Screen discussion for details.

Backups

eManager allows you to create and restore configuration backups of your network nodes, for disaster recovery situations. The backup is intended to retrieve and store only the configuration information from a node, and not the complete binary image. The backup is stored in a subdirectory of the …eman3000\backups directory.

Backups can be performed on an individual basis or you can create a Backup Job to backup multiple nodes of the same node type, and schedule it to run at some convenient time. When running Backup Jobs, you may indicate the number of backups to be kept for each node, and schedule the job to repeat on a regular basis.

Some care is required to insure that the proper code level is restored or installed on a unit prior to restoring the configuration. Information about the code level that was installed on the node should be available in the eManager database.

Create Backup: Selecting this menu entry creates a copy of the selected product’s configuration files, and stores them in a subdirectory associated with the selected node. If a backup is already stored for the selected node, it will be overwritten by the new backup.

Restore Backup: You may select to restore the configuration backup previously created by eManager. If multiple backups have been created for a specific node, then you can select to restore the last backup or one of the previous backups by selecting which one from the menu (previous backups are identified by their date and time). In order to restore the configuration, the target node should be loaded with a stable copy of its operating system at the same code level that the backup was saved from. One exception to requiring the same code level is the LINCS server platforms. The LINCS platform only needs to be at the same or higher code level than the backup files.

Additional Backup functions are available for the LINCS Server platforms.

Create Backup Job: You can create a Backup Job capable of making backups of multiple nodes of the same type at the same time. The Backup Job is scheduled to execute on the Scheduler tab of the eManager Options panel.

Retrieving Vital Product Data

Another way to retrieve and optionally store current information on a node is to use the Retrieve Vital Product Data function. To retrieve and display vital product data from a node, click on its name in Items View, right click to display the dropdown menu and select the Retrieve Vital Product Data menu. eManager connects to the selected node, downloads the parameters and displays them in the Node Viewer Screen. Information retrieved using this function is not automatically stored to the eManager database. The Node Viewer Screen permits saving the information to the existing database entry or creating a new one.

Retrieving the Update Log

Some of the products supported by eManager keep an Update Log, giving information on the last update(s) that occurred to that device. This log is typically a log from the node's perspective as to whether an upgrade was successful or not, and what took place. Selecting this function retrieves the log from the node, stores it into the backup directory for that node, and displays it. From the viewing screen, you can print a copy of the contents of the file, save the contents to another file, or copy the contents to the clipboard for pasting into another application.

Telnet to a Node

To establish a Telnet session with a product node, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select Telnet To Node. The Telnet connection is then made. For security reasons, in most cases, you will be prompted to enter ID and password when connecting to a node via Telnet. Not all product node types support the Telnet function. For node types that do not support Telnet, the 'Telnet to Node' option will be grayed out on the menu.

The eManager product currently supports a single Telnet connection at one time. An icon in the status bar will display any time that the Telnet client is in use.

Wake Sleeping Node

eManager allows you to wake nodes that support Wake On LAN. To wake a node or nodes, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node(s). Right-mouse-click to display the dropdown menu and select 'Wake Sleeping Node'. If the 'Wake Sleeping Node' option is grayed out, the node type that you have selected does not support WOL. A WOL Icon should appear in the status line to indicate that the WOL process has been started. If some of the nodes that have been selected do not support Wake On LAN, they will be deselected (for example eTerm 360 and 760 models).

While the WOL icon is displayed, you can click on the icon to display the 'Wake On LAN Status' panel for the node(s) that were selected. A 'View' button on the resulting panel allows you to alternate between displaying the information in 'Icon' mode and 'Report' mode. Pressing the 'Exit' button closes the Wake On LAN Status panel.

You can Wake non-Visara products that support Wake On LAN by selecting 'Wake On LAN' from the Tools menu. A dialog box is presented, requesting the hardware or MAC address of the node, and if entered a second dialog box asks for the IP address. If both addresses are provided, eManager will attempt to wake the node up.

Pinging A Node

To Ping a product node, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select 'Ping Node'. A prompt displays with the product node’s IP address. If no node was selected the address is blank. You may edit or add an address or DNS name if desired. The Ping Screen displays and attempts to Ping the node. You may also Ping any IP address that you desire, by pressing the <Ping> button on the main eManager panel, filling in the IP Address or DNS name that you want to Ping, and press <OK>.

Reset a Node

You may reset a product node (force a power on reset) using eManager on an individual node basis. If the network interface is working, and a reset is initiated with eManager, the node will immediately, and without warning to the user commence to perform a power on reset. Because of the potentially disruptive nature of this function, the eManager administrator is required to enter the eManager password at the time the request is made.

To reset a node, highlight the desired node in Item View and right-mouse-click to display the popup menu, and select Reset Node. A small box will appear that allows you to select whether you want eManager to monitor the reset process or not. Selecting to monitor the reset will cause eManager to monitor the device once it is reset, until such time it appears to respond once again on the network, or until a predetermined timeout occurs. Either way, the eManager administrator will be advised when communications have been reestablished, or the timeout occurs. Once this selection has been made, enter the eManager password and press the <Reset Node> button. You may also choose to <Cancel> the request.

VNC Connection

VNC, as it applies to eManager, is a product of AT&T Laboratories, designed to provide a shadowing capability to desktops running a suitable VNC server application. Screen data from the target platform is presented to the eManager platform, and keyboard and mouse input on the eManager platform is directed to the target platform as if you were directly attached. VNC is distributed and installed by eManager under the terms of the 'GNU General Public License'. You may also obtain a free copy of the VNC product, as well as the source code for VNC, by going to the AT&T Laboratories website at: http://www.uk.research.att.com/vnc/. The application reference for VNC is automatically configured for eManager, and may be reconfigured to a different location if desired on the eManager's Options panel. If properly installed and configured within eManager, you may kick off a VNC connection to a Visara 1883 from eManager. VNC connections to the eTerm 300, 360, and 760 products is supported if they are running Windows CE 4.2 Build 4026 or higher.

To accept a VNC connection on the 1883, the VNC application on the 1883 must be running. eManager will start the VNC application at the 1883 through a Telnet connection, then start the VNC connection. The Telnet session is closed as soon as the application has been started.

VNC connections can be password protected on most products. If a password is required, you will be prompted for that password when you attempt the connection.

Configuration of the VNC application path within eManager is on the Applications tab of the Options panel.

To establish a VNC connection to an 1883, click the 1883 nodes entry in the Folders View, then right-mouse-click on the desired 1883 target listed in the Item View. Next, select '1883 Utilities/VNC Connection/Start'.

Closing the VNC application window, only stops the current VNC session to the client, but does not shut the client application down on the 1883. To stop the client application as well, select the desired 1883 target in the Item View, then select '1883 Utilities/VNC Connection/Stop'. If the VNC application is still open on the eManager platform, it will close itself when the application at the client stops.

The VNC daemon is always running on the eTerm products, so eManager just kicks off the VNC application to connect to it.

Shut Down Node

Initiating this operation will cause a node to power down. For some nodes supporting Wake On LAN, the node will power down, but can be brought back normal operation by performing the Wake On LAN function.

Because of the potential to cause a problem for a user, the Shut Down Node function is password protected (eManager Password). To cause a node to shut down, right-mouse-click on the node in Item View, and select 'Shut Down Node'. You will be prompted for the eManager password, and upon successfully giving this password the node will be remotely shut down. Only nodes supporting the Shutdown function will have a menu entry.

Phindows to a Node

This is an optional function available only if you have installed Phindows, and only applies to the 1683 and 1783 products. The path and command line parameters must be configured. See the eManager Configuration Screen discussion for details.

To establish a Phindows session with a product node, click on a product branch in Folders View to display its product nodes in Item View. In Item View, click on the desired node to select it, then right click the mouse to display the dropdown menu and select Phindows To Node. A prompt displays with the product node’s IP address. If no node was selected the address is blank. You may edit or add an address if desired. The Phindows session then automatically connects to the node. If you get a connection 89 error, the node number configured at the product node is not the default. In this case, enter a space N after the IP address in the prompt. eManager will automatically determine the node number. If you know the node number, key space N and the node number after the IP address to connect more quickly. General connection information can be entered on the eManager Configuration Screen.

If the password option has been set at the target product node, Phindows will require that you enter the node's connection password (not the administrator's password).

Phindows comes standard with licensed copies of eManager on the eManager CD, but is not installed as part of the eManager setup. There is a separate setup program for the Phindows program, which can be found in the Phindows directory on the CD.

Viewing the Master Node

One product node database entry can be designated as a master using the Node Viewer Screen. The Configuration Update Screen uses Files located on the master to create configuration updates. To view parameters for the master, Click on any branch under Network Nodes in Folders View so the node information is displayed, then right click the mouse to display the dropdown menu and select View Master Node. eManager displays the master node information in the Node Viewer Screen.

eManager’s Main Menu Items

File

Import Database - allows you to merge the contents of another eManager database into your database.

Refresh View – eManager refreshes the data displayed in the Folders/Item View Screen.

Reset View – eManager resets the data displayed in the Folders/Item View Screen, by collapsing the Folders View tree structure and clearing the Item View.

Exit – Exits eManager

Nodes

AutoLocate – Displays the AutoLocate Screen

Add Node - See Adding Product Nodes To The Database

Group Definitions

New Group - See Adding A Group

Delete Group - See Deleting Nodes Or Groups

Rename Group – See Renaming a Group

Change Connection Password – Displays the Password Change Screen

Collect Data From Node – See Collect Node Data Screen

View Master Node – See Viewing The Master Node

Broadcast Message - Displays the Broadcast Message Screen

View Device VPD - Displays the contents of the VPD database, displaying VPD on devices attached to LINCS platforms.

Patch Manager - Brings up the patch manager utility for LINCS platforms.

LINCS Configuration Library - LINCS Central Site Library utilities

Backup Library - Backups the LINCS Central Site Library

Restore Library - Restores the LINCS Central Site Library

LINCS Event Code Lookup - Allows you to look up LINCS error codes online

Communicate With Node

Node Definitions

Delete Node - See Deleting Nodes Or Groups

View Node Info - See Viewing Product Nodes

Edit Node - See Editing Product Node

List Group Affiliation - See List Group Affiliation

Retrieve Vital Product Data – See Retrieving Node Configuration

Backups – See Backups

Create Backup – See Create Backup

Restore Backup – See Restore Backup

Create Backup Jog - See Backup Jobs

Retrieve Update Log - See Retrieving the Update Log

Ping Node – See Pinging A Node

Wake Sleeping Node - See Wake Sleeping Node

Telnet To Node – See Telneting To A Node

Reset Node – See Reset a Node

Product Specific Utilities - An additional menu item is displayed specific to the product type selected. See Product Specific Utilities.

Product Specific Utilities

1683/1783 Utilities

Phindows to Node - See Phindows to a Node

1883 Utilities

VNC Connection - See VNC Connection

Edit Configuration - See 1883 Configuration Updates

eTerm 350 Utilities

Shut Down Node - See Shut Down Node

eTerm 360 Utilities

Change Terminal Properties - See Change Terminal Properties

Change Host Connections - See Change Host Connections

VNC Connection - See VNC Connection

Shut Down Node - See Shut Down Node

LINCS Utilities

Diagnostic Utilities - See Diagnostic Utilities

Force Dump - See Force Dump

Retrieve Dump - See Retrieve Dump

Delete Remote Dump - See Delete Remote Dump

Retrieve Event Log - See Retrieve Event Log

Retrieve Box Fail File - See Retrieve Box Fail File

Retrieve Existing ESCON Trace

Stop and Retrieve ESCON Trace

View ESCON Trace

Backups - See Backups

Create Backup - See Create Backup

Restore Backup - See Restore Backup

Backup File List - See Backup File List

View Event Log - See View Event Log

View Box Fail Log - See View Box Fail Log

Configuration Panels - See Configuration Panels

Retrieve Panels - See Retrieve Panels

View Panels - See View Panels

Hardware View - See Hardware View

Device VPD

View Device VPD

Delete Device VPD

Updates

Code Updates

Add Code Updates – Displays the Code Update Screen

Edit Code Updates – Displays the Code Update Screen, listing the files in the selected code update

Delete Code Updates – Deletes the selected code update directory and its contents

Create/Edit Update Matrix - See Code Update Matrix Screen

Rename Update – Renames a code update

View Instruction File - Brings up the instruction file associated with the Code Update into the eManager Viewer. No editing capability of the file is provided. This option applies to 1883 nodes only.

Make Floppy Disks - Allows you to create floppy disks from the Code Update

Configuration Updates

New Configuration Update – Displays the Configuration Update Screen

Edit Configuration Update – Displays the Configuration Editor Screen showing the selected miscellaneous option.

Delete Configuration Update – Deletes the selected configuration update

View Configuration Update – Displays the Configuration Update Screen showing the selected configuration update

Rename Update – Renames a configuration update

Pull Updates - See Pull Update Screen

New Pull Update - Displays the Pull Update Screen

Edit Pull Update - Displays the selected pull update on the Pull Update Screen

Delete Pull Update - Deletes the selected pull update

Rename Update – Renames a pull update

Distributions

New Distribution – Displays the Distribution Plan Screen

Edit Distribution – Displays the Distribution Plan Screen showing the selected distribution plan

Delete Distribution – Deletes the selected distribution plan

Rename Distribution - Allows you to change the name of your distribution plan

Submit Distribution – Causes the selected distribution plan to be queued for execution. Execution starts when the start date and time is reached.

Terminate Distribution – Clicking this menu submits a request to terminate this distribution. The distribution will not initiate further product node updates but will finish its current tasks prior to terminating.

Verify Distribution – Making this request will generate a Verify Distribution job for the Distribution Plan that is highlighted, and submit it for immediate operation. Each node in the original distribution list, will be checked to see if the distribution completed successfully or not.

View Distribution Status – Displays the Distribution Monitor Screen

Pulse (Network Monitor)

Start Network Monitor – Starts the Pulse Network Monitor, monitoring all nodes specified by the Pulse configuration. The black on yellow Pulse symbol should appear in the status line of the main menu to indicate when the network monitor is running.

Stop Network Monitor - Stops the Pulse Network Monitor. The black on yellow Pulse symbol should disappear from the status line to indicate that the network monitor is not running.

View Network Monitor - Displays a set of icons representing the groups or subnets being monitored by Pulse. The choice of groups or subnets is determined by the Pulse configuration.

Report Generation

View Report Data - Displays the collected network monitor data, in a panel, where you can scroll through the data and perform searches.

Save Report Data - You will be prompted for a file name to save the report data to. Two file extensions are supported, '.txt' and '.csv'. The file created will be compatible to the extension that is selected. Files with '.txt' extensions are made to be viewed with a text editor. Files with '.csv' extensions are saved with comma separated fields and CR/LF separated records and may be imported into a spreadsheet.

Clear Report Data - Deletes the pulse.log file that contains the network monitor data. A message box allowing you to change your mind is displayed. If you proceed to clear the report data, the file is deleted. Individual node history information is not deleted. That information can be viewed on a node by node basis.

Clear Monitor History - Deletes the individual monitor history information that is normally collected and saved for nodes being monitored by Pulse. Clearing the individual monitor information does not affect the pulse.log file.

Tools

Job Creator - See Job Creator Panel

Telnet Application – See Telneting To A Node

Ping Application – See Pinging A Node

VNC Application - See VNC Connection

Phindows Application – See Phindow To A Node

Wake On LAN - See Wake Sleeping Node

View

This menu contains four selections that let you choose how data is displayed in the Item View section. They are Icon View, Small Icon View, List View and Report View

Reports

The 'Reports' menu allows you to select from two types of report generation. Selecting the 'Item View Report' will allow you to print whatever is displayed in the 'Item View' control of the main eManager panel. Display whatever information you wish to print, adjust column widths or even collapse columns, sort on any field that you need to then select 'Reports/Item View Report'. You will be allowed to edit the name of the report, or use the default name based on the contents that are currently displayed. Upon approving the report name, the contents of the Item View will be displayed as a report. You can then choose to review the appearance of the report, print the report, or export the report as a file.

Selecting the 'Special Reports' option takes you to the eManager Report Generator panel, from where you can choose to generate a report based on several predefined report options.

Options

This menu item displays the eManager Configuration Screen

Help

Contents – Loads the help file with the cursor pointing in the table of contents

Folders/Items View – Loads the help file with the cursor pointing to the Folders/Items View Screen discussion

About – gives information about your copy of eManager (serial number and license)

Buttons

AutoLocate – Displays the AutoLocate Screen

Distr. Monitor – Displays the Distribution Monitor Screen and shows the selected distribution plan

Broadcast - Displays the Broadcast Message Screen

Telnet – Uses the internal Telnet client of eManager. See Telneting To A Node

Ping – See Pinging A Node

Shadow – Used to connect to a 1683/1783 with Phindows or to an 1883, e300, e360, or e760 with VNC. See Phindows To A Node (button appears if Phindows is configured) or VNC Connection (button appears if a path to the VNC application is configured).

Options – Displays the eManager Configuration Screen

Exit – Exits eManager

Node Viewer Screen

The Node Viewer Screen permits viewing details of the product node parameters for the selected node. You can bring up the viewer by two different methods. The easiest method is to double-mouse-click the node displayed in the Item View list. You may also right-mouse-click the node and select View Node Info from the list of options displayed. A small panel containing a product image and a description of the node's vital product data will be displayed. The panel is removed by pressing OK.

Node Editor Screen

The Node Editor Screen permits viewing details of the product node parameters and editing some of them. The parameters displayed in color (or grayed) are parameters collected from the node or are system parameters that can not be edited. It is a multifunction screen used to add new product nodes to the database, edit existing product node entries, or view the configuration retrieved from product nodes during the Retrieve Vital Data function. Not all parameters will appear for every node type. The following sections describe the parameters displayed on the screen and how they are used, in addition to the menu items and button functions.

Product Node Parameters

Time Zone - Allows you to specify the time zone that the node resides in, for distribution and informational purposes. This field will display the time zone configured for eManager (on the eManager Options panel) by default, when you are adding new nodes.

Node Type - The type of product node is displayed here. This field is a drop down list that displays the node types currently enabled for eManager. (The Options panel is used to enable/disable product node types) It is convenient to change this value when manually adding new nodes of different product types or correcting a database entry that was saved under the wrong product type.

Group - This field is a drop down list of group names associated with the currently selected Node Type. Selecting a group name and saving will add this entry to the group. (Note that you can also add product nodes to a group with drag and drop from the Folders/Items View Screen.)

Name - This is an arbitrary name you can assign to the database entry for this product node. This name is displayed in other screens to make node selections for various functions, so it is recommended that you choose names that you can relate to the product node. See the "AutoLocate Screen" for a discussion of how names are assigned when AutoLocate adds database entries.

Model - Provides Model Number information for node types that come in various models.

DNS Name - This is the full DNS address, if there is one, for the product node. The eManager configuration choices determine if this address will be used to contact the product node. See the eManager Options Screen. Note: Either the DNS Name field or the IP Address field must contain an address.

IP Address - This is the full IP address for the product node in the format NNN.NNN.NNN.NNN where NNN is a number from 1 to 255. The eManager configuration choices determine if this address will be used to contact the product node. See the "Option Panel" for details. Note: Either the DNS Name field or the IP Address field must contain an address.

FTP Password - This password is used by eManager, to access the product node when using FTP. If you are adding a new entry, eManager inserts the default password for the selected node type. If the password at the product node has been changed, you will need to edit this field with the correct password. If the password field is changed, you will be prompted when saving to reenter the password for verification.

Desired Password - The field is used in conjunction with the Password Change Screen. If you need to change a product node password, you can enter the new password here. There is an option on the Password Change Screen that compares the FTP Password with the Desired Password and, if they differ, changes the product node password to the desired password. Note also that the Password Change Screen also writes the desired password to this field during a password change task.

Master - A number 1 or letter Y in this field designates this node as the Master product node. The 'Master' selection can be used by the "Configuration Update Screen", as the source for files when creating a configuration object.

Telnet Password - This password entry field is for products that require the use of a separate password from that used for FTP connections.

Telnet Port - This entry is a 5-digit field used for numerical entry of the Telnet port to be used for communication by eManager.

The remaining fields are parameters collected from the product node or are system parameters, and are not editable.

Buttons

Previous - Clicking the Previous button displays the previous product node entry from the database.

Next - Clicking the Next button displays the next product node entry from the database.

Copy - Clicking the Copy button writes the displayed product node parameters to the Windows clipboard. This enables you to paste it into any other application for editing and/or printing.

Save - Selecting this button saves any changes made on the panel to the database.

Exit - Exits the Node Viewer Screen

Menus

File

Save To Database - This saves the displayed data to the database. Existing fields in the database entry are overwritten with the new data.

Save As New Record - The menu save the data as a new product node database entry.

Exit - Exits the Node Viewer Screen

Edit

Copy Node Data - Copies just the node data to the Windows clipboard

Copy Log - Copies just the log data to the Windows clipboard

Copy All - Copies all data displayed to the Windows clipboard

Help

Contents - Displays the eManager Help file indexed at the table of contents

Node Viewer Screen - Displays the eManager Help file starting at the Node Viewer Screen discussion.

AutoLocate Screen

The AutoLocate screen permits you to perform an automatic network search for product nodes using a range of IP addresses, then creates or updates database entries for these nodes. This function provides for the creation of the product node database with minimal effort. This function can also be used to update the current information kept in the database or find new nodes that are not currently stored in the database.

The AutoLocate function criteria is defined as a job, that once created can be executed immediately, or can be scheduled to execute later. A name must be assigned to the job, to distinguish it from other jobs. Once saved you can make changes to the jobs execution start time, cancel the start time, delete the job, or make the job recursive on the eManager Options panel Scheduler tab. You can also select the job from a list of saved jobs for immediate or later execution from the 'Stored AutoLocate Jobs' dropdown list.

To launch an immediate search, just enter the information on the panel as desired and click <Submit> (the Immediate box is checked by default). By pressing the <Submit> button, the job is queued for immediate execution, and will begin to execute, as long as there is not already an AutoLocate job executing. AutoLocate uses a combination of SNMP, PINGs, and FTP to locate, identify, and retrieve information from the selected address range, dependent upon the types of devices that you have elected to search for, and the type of search you are performing. Information for all selected product node types is stored when found. You may view the progress of the AutoLocate function graphically by pressing the <View> button.

The following sections describe the information you need to enter and the choices you can make in more detail. AutoLocate creates a log in the bottom portion of the screen showing the progress of the search. You can use the <Display Log In Viewer> button to display the log in the larger viewer provided by eManager for easier viewing. The <Cancel> button issues a request to cancel the AutoLocate tasks that is currently executing. As soon as AutoLocate finishes with the current task(s), it terminates. The <Save> button allows you to save an AutoLocate job without executing it immediately.

Start Time Options

All jobs may be saved for future action or submitted for execution. The eManager Options Scheduler tab provides a means to reschedule, submit, cancel, or delete the job later. A description of the Start Time Option controls follows.

Immediately – When selected, the <Submit> button will be available to start an AutoLocate job immediately.

Do Not Schedule - If the 'Immediately' option is not selected, the 'Do Not Schedule' option becomes available to allow you to create an AutoLocate job that is not scheduled to execute. Selecting this option will cause the <Save> button to be available, and pressing the Save button will save this job. You can later schedule the job to execute if desired on the eManager Options Scheduler tab.

Start Date - Indicates the date when you want this AutoLocate job to next execute. You must press <Submit> button to save the job and submit it for execution.

Start Time - The time selected indicates at what time you want this AutoLocate job to next execute. You must press the <Submit> button to save the job and submit it for execution.

Three tabs contain the AutoLocate job options.

Locate Criteria Tab

The 'Starting IP Address' and 'Number of Increments to Start Address' fields are required fields to let eManager know what you are searching for. The remaining parameters are optional, and should be selected according to what you are trying to accomplish (search for new nodes or update existing node information). A description of the other options for this tab are described below.

Starting IP Address – A standard IP address in the format NNN.NNN.NNN.NNN where NNN is a number in a range of 1 to 255

Increments To Starting Address – The number of additional addresses to search. AutoLocate begins the search with the starting address and increments it by this quantity or until the '.255' address is reached.

Subnet Mask to Use - Informs eManager what subnet mask to use for SNMP broadcasts within the address range selected.

LINCS Telnet Port Number - Indicates which Telnet port to use on target LINCS platforms. If LINCS nodes are not part of the selection, this option does not appear.

Locate Options – Determines which nodes are to receive new records in the database.

Locate All – AutoLocate searches the network for all addresses in the specified range.

Locate Undefined Only - AutoLocate searches for only addresses in the range that are not already listed in the database.

Create Record of Non-Visara Nodes - Determines whether eManager will create a record into the database for Non-Visara nodes that are located ('Other SNMP-Capable' and 'Non-SNMP Capable' nodes are listed into the 'Unknown' node type category when found).

Device Types to Locate - Determines which device types eManager is supposed to locate. Node types that are not selected will be ignored when located by eManager. Normally by default, eManager will select the node types for which you have indicated you want support for on the eManager Options panel. Two other entries are provided in addition to Visara node types. These are, 'Other SNMP Capable' - devices that respond to SNMP broadcasts, and 'Non-SNMP Capable' - nodes that respond to an FTP connection attempt. The SNMP response, and the FTP connection string response can be used to help identify what node type is out there. If the 'Create Record of Non-Visara Nodes' option has been selected, a database record of the detected nodes will be created and stored under the 'Unknown' node type category by eManager, otherwise the node types will appear in the log and on the AutoLocate view, but will not be stored. It is possible to create an Alias for the connection strings and associate an icon to be displayed for these 'Unknown' device types when detected, by customizing the eManager Options Node Types panel. Note that the name of the 'Unknown' category can be changed to something more suitable to your application, by editing the name on the main eManager panel.

Successful Contact Options Tab

Record Action

Update Existing Record – AutoLocate searches the database for a match of the selected Record Match Option as described below and, if found, updates this record with the information downloaded from the product node; otherwise, a new record entry is created.

Always Add New Record – AutoLocate creates a new database entry for each product node found, even if there is an existing entry for the same device.

Record Match Options

Match Serial Number – AutoLocate checks the database for an entry with a serial number that matches the serial number downloaded from a responding product node.

Match IP Address – AutoLocate checks the database for an entry with an IP address that matches the IP address of a responding product node.

Match Node Name – AutoLocate checks the database for an entry whose name matches the node name downloaded from a responding node.

Match Hardware Address - The network MAC address of the node will be compared to the MAC addresses stored in the database for a match.

Information Gathering

Minimal - eManager will use only the minimum contact criteria to match the node to existing nodes in the database, based on the Record Match Options and the node types being searched for. This can be used to speed up the search process, when you are just trying to identify the new IP Address assignments in a DHCP environment, for example. Not all database information is collected from the node for this selection.

Full - eManager will attempt to collect all information normally collected for the type of nodes that are being searched for.

Default Time Zone Assignment - This field indicates which time zone will be assigned to a detected node when it is placed into the database. By default, the time zone displayed will be the same as eManager's time zone. You can select a different time zone by selecting a different one from the drop down box.

Naming Convention – These choices determine the name that will be used for the database entry, i.e. the name written to the Name field in the database.

Use Existing Database Name – AutoLocate keeps the existing name of a database entry when updating existing records. This option is not available if the Locate Criteria specifies Locate Undefined Only or the option to always add a new record is selected. This selection takes priority over other selections in this group if a match is made to an existing record.

Assign Name Stored At Node – AutoLocate uses the "node name" downloaded from the product node as the name for the database entry. This information may not be unique or configured depending on the node type, and how they are configured.

User Serial Number - This option will cause eManager to enter the serial number information collected from the remote node as the eManager name for this device.

Use Base Name – For each product node that responds, AutoLocate appends a suffix to this name and uses it for the database entry name. See Name Suffix Options below for choices on how this numeric suffix is generated.

Name Suffix Options

Increment – AutoLocate creates a suffix for the base name starting at 1 and incrementing 1 for each node found. eManager searches the database for the base name assignments and determines the highest number assigned, then uses the next number to begin incrementing from if new nodes are found.

Use Last Octet In Address – AutoLocate appends the digits in the last octet of the IP address to the base name. This method should not be used if the same base name is to be used for multiple subnets, or if you are using DHCP, where the IP addresses will change periodically.

Advanced Contact Options Tab

Group Assignments

Assign To Group- When this box is checked, eManager puts each node located into the specified group. A group name is specified, by clicking the drop down arrow for the desired product type, then clicking the name. If a name is typed into the field, a new Group will be created by that name and the located nodes will be stored into it, as long as the name has not already been used. You can define one group for each node type that is being searched for, for any particular job.

Password

Stored Default (Checkbox) - Indicates that you want to used the stored default connection password for each node type selected. If a password other than the default is to be used, it must be configured in the Connect Password fields provided for the various node types.

Factory Defaults Button – Resets the connection passwords in the Connect Password fields back to the factory defaults for all node types.

Stored Defaults Button – Resets the connection passwords in the Connect Password fields back to the values entered and saved on the eManager Options panel for each node type.

Connect Password Fields - Fields contain the password that is to be used when attempting to locate and download node information from selected node types. Node types that do not have a corresponding Connect Password field, will always use the factory default, as no other option is allowed. The LINCS nodes use both an FTP and Telnet password to connect into the node with.

AutoLocate Button Options

Submit - Saves and submits the AutoLocate job for execution. All parameters should be set to the desired values prior to submitting the AutoLocate job.

View - Provides a graphical representation of the progress of the AutoLocate job. A series of symbols representing each address, and eventually each node that has been detected and identified, will appear on the graphical representation. You can double-click on the icons to get more information about the progress of the AutoLocate procedure, or the devices that have been identified.

Save - Saves the job, without submitting it for execution. This option is available if you have deselected the Immediate checkbox and selected the 'Do Not Schedule' checkbox.

Cancel - Terminates the current AutoLocate job, when the currently running task completes. A message will be placed in the log, to indicate that a request to cancel has been made. Another message will be entered into the log when the AutoLocate has actually terminated.

Exit - Provides an exit from the AutoLocate panel.

Help - Pressing the help button brings up the eManager documentation.

AutoLocate Viewer Panel

The AutoLocate Viewer panel provides a means to visually display the progress of an AutoLocate job executing. Nodes are graphically displayed as icons on the panel. Information provided in the status bar at the bottom of the panel, give the elapsed time, number of addresses attempted, number of nodes contacted, and the number of nodes identified.

The AutoLocate Viewer panel is displayed by pressing the <View> button during an AutoLocate immediate execution.

Double-clicking on an icon displays information gathered about the node at that address. If the device is a Visara node, the information displayed is a reflection of the information known about that node. If the AutoLocate being performed is for 'Minimal' information, then eManager will attempt to match a node in the database with the basic information pulled from the unit. The information displayed will be information from the database. If the option for 'Full' information has been selected, the information displayed will be information pulled from the device itself.

Right-mouse-clicking on a non-Visara node allows you to assign an alias name to the response that was received from that node. Once an alias name has been assigned to a particular response, eManager will identify nodes that respond in the same fashion by using the same alias. You can also assign an icon to be used with that alias on the eManager Options Node Types tab.

Broadcast Message Panel

Messages that need to be conveyed to remote stations can be written using eManager and then transmitted so they display at remote 1683 or 1783 stations. You can display this screen by clicking the Broadcast button or Broadcast menu on the Folders/Items View Screen. To broadcast a message, enter the information on the panel as described below and click submit. The broadcast process connects to each selected product node, uploads the message and causes the remote product node to display a window containing your message. You can also specify the window's title. The following sections describe the information you need to enter and the choices you can make in more detail. The Broadcast Message Screen displays a log in the bottom portion of the screen showing progress. You can use the copy button to copy this log to the clipboard. Once in the clipboard, you can paste the information to any other application for editing or printing. The Cancel button issues a request to cancel the collection process. As soon as the current task is finished, it terminates.

Node Target Options

All Nodes - The broadcast function tries to contact every 1683 and 1783 product node in the database. Note that that the list is grayed out when this selection is made.

Individual Nodes – Clicking Individual Nodes causes the node names to display in the list. The broadcast function tries to contact each node selected.

Groups - Clicking Groups causes the group names defined for this product type to display in the list. The broadcast function tries to contact each node in every group selected.

A node (or group) is selected if it is highlighted. To select a single node (or group), click it. To select a range of nodes (or groups), click on the first node (or group), hold the shift key down, then click the last node (or group) in the desired range. To select nodes (or groups) that are not adjacent, hold the CTL key down while clicking the desired nodes (or groups). To deselect a node (or group), click it again.

Title - Enter text that you want displayed as the window title when the message is displayed at the remote product node.

Message - Enter the text for the message you want to display at the remote product node.

Start Date/Start Time – These entries determine when this task starts. It starts on or after the date and time specified. Note that information and selections for this task are not stored to disk or database, so if eManager is closed down for any reason, the task will not be completed.

Collect Node Data Screen

This screen automates updating the database with the latest information collected from product nodes listed in the database. To launch the collection process, enter the information on the panel as described below and click submit. The collection process connects to each selected product node, downloads the node parameters, and updates the corresponding fields in the database. The following sections describe the information you need to enter and the choices you can make in more detail. The Collection Screen displays a log in the bottom portion of the screen showing progress. You can use the copy button to copy this log to the clipboard. Once in the clipboard, you can paste the information to any other application for editing or printing. The Cancel button issues a request to cancel the collection process. As soon as the current task is finished, it terminates.

Node Target Options

All Nodes - The collection process tries to contact every product node, of the type selected, in the database. Note that that the list is grayed out when this selection is made.

Individual Nodes – Clicking Individual Nodes causes the node names to display in the list. The collection process tries to contact each node selected.

Groups - Clicking Groups causes the group names defined for this product type to display in the list. The collection process tries to contact each node in every group selected.

Naming Options

Use Existing Database Name - When updates are made to the database entry, the name is not changed.

Assign Name Stored At Node - The node name downloaded from the product node is written to the name field.

Delete Record If No Ping Response – The database entry is deleted if the product node does not respond to a ping. This can be used in DHCP environments to eliminate old node definitions from the database.

Password Change Screen

This screen automates changing the password at targeted product nodes. Not all node types support the changing of this password. To launch the password changes, enter the information on the panel as described below and click submit. The password change task connects to each selected product node, makes the password change, and updates the corresponding fields in the database. The following sections describe the information you need to enter and the choices you can make in more detail. The Password Change Screen displays a log in the bottom portion of the screen showing progress. You can use the copy button to copy this log to the clipboard. Once in the clipboard, you can paste the information to any other application for editing or printing. The Cancel button issues a request to cancel the password change task. As soon as the current task is finished, it terminates.

Node Target Options

All NCT Nodes - The password change task tries to contact every 1683, 1783 or 1883 product node in the database. Note that that the list is grayed out when this selection is made.

Individual Nodes – Clicking Individual Nodes causes the node names to display in the list. The password change task tries to contact each node selected.

Groups - Clicking Groups causes the group names defined for this product type to display in the list. The password change task tries to contact each node in every group selected.

All NCT Nodes Where Database Fields Differ – Desired vs Current – Clicking this selection causes eManager to compare the desired password field and the FTP password field for each NCT record in the database and, if they differ, attempt to change the product node’s password to the desired password.

Desired Password

Enter the password you want to change to. It must be entered twice for verification

Current Password

Use Database Password

When connecting to the product node, use the FTP password stored in the database record.

Use Nodes Default Password

When connecting to the product node, use the default password assigned for this node.

Use This Password

When connecting to the product node, use the password entered in the edit box. The password must be entered twice for verification.

Start Date/Start Time

These entries determine when this task starts. It starts on or after the date and time specified. Note that information and selections for this task are not stored to disk or database, so if eManager is closed down for any reason, the task will not be.

How to Update a Remote Node

Updating the code or configuration of a remote node with eManager is accomplished through the creation and execution of an update distribution. Requirements for the different products that are supported by eManager are different, but the overall process can be summarized. This process can be broken down into the following components that should be performed in the order listed:

The creation of an update object that includes all the necessary files or information to make the change
The creation of a distribution plan that references or uses the objects
The submission of the distribution plan for execution.
Verify that the distribution was successful. (Check the 'Verify' box at time of Distribution Plan creation, or manually initiating it later.)

1683/1783 Updates

Updates sent to a 1683 or 1783 will cause the update daemon in the 1683 or 1783 to fire up. An information screen will appear on the display of the unit, and give the user the options to do nothing (update starts in 60 seconds), postpone the update (for 5 minutes) to allow time to close down what they are working on, or start the update immediately. If the user powers down their unit while this screen is displayed, the update which is stored in nonvolatile memory will be lost and the unit will not be updated, even though eManager will log the distribution to that device as a success. Running the 'verify' option should detect most instances of a unit that does not actually get upgraded.

Once the update actually begins, another panel will be displayed warning the user not to power off the display. A log appears on the screen indicating the success or failure of the update to install.

1683/1783 Configuration Updates

The remote configuration of the 1683 and 1783 product is accomplished by making configuration changes to one unit, pulling the configuration from it, then distribute that configuration to any number of other units. A Configuration Update panel allows you to specify which configuration options you wish to pull from a unit to put into your configuration update object. To reduce the size of the files that are moved across the network, most of the configuration information is compressed into one or more files prior to retrieval.

Most configuration options in the configuration update object cannot be edited once you have retrieved them due to the compression, so it is important to pull only the information needed, and to make sure that you have correctly configured the information prior to pulling it. Those options that may be edited, are available for changing by performing the Edit Configuration Update function from the Updates menu item on the main eManager panel. Although many of the configuration options are the same between the 1683 and 1783, some are different, so eManager handles the two products separately.

1683/1783 Code Updates

Code updates for the 1683 and 1783 products are in the form of code files and instruction files. You typically will have at least one code file (new code level or hot flash) and one instruction file associated with each change released for the product. eManager allows you to include one code level change and multiple hot flash changes into the same code object. eManager will determine the default order in which the changes will be installed at the remote unit.

1683/1783 Pull Updates

Pull updates can be initiated on a group of 1683/1783 products by creating a Pull Update Template within eManager, then distributing this template to the target products. The targets will process the Template in the immediate mode, and pull the update from the FTP Server location indicated in the template. You can establish an interval between 1683/1783 template loads, to provide more control over FTP Server access, by configuring a Pull Interval on the Distribution Plan Editor panel. You can also configure whether the units are to IML when the Pull is complete.

Using the Code Update Matrix

You can create a Code Update Matrix for use with the Code and Pull Updates that you have created for use with the 1683/1783. In the matrix you can specify IL (code) level and a particular Update that you want to be sent to any device detected with that IL level during execution of the distribution plan. By using the Code Update Matrix you can create a path by which down level units can be stepped up to the latest code level in an orderly fashion.

1883 Updates

For older levels of 1883 code (IL 003 and earlier), the configuration and application code is stored in a portion of memory that eManager can push changes to. The Linux kernel however, is stored in a protected area of memory that eManager cannot write to. Code changes to the kernel require that eManager push instructions to the 1883 that result in the 1883 pulling its update from an FTP server (Pull Update). Beginning with IL 004, all of the code files including the kernel can be written to directly by eManager, and can be handled as Code Updates unless they are too large (larger than 7.5 MB). Note that you cannot directly upgrade an 1883 from pre IL 004 levels to IL 004 and higher. (A Disk On Chip - DOC - replacement is required.)

1883 Configuration Updates

Remote configuration of the 1883, can be performed by using one of the methods described below:

Direct configuration of the 1883 can be achieved using the VNC product. The VNC product allows configuration of the 1883 in real time, by providing a shadow connection where the screen, keyboard and mouse can be controlled from a remote platform such as eManager. One drawback to this type of control is that you must make a separate connection to each 1883, one at a time to perform changes. A second drawback is dealing with network delays that are inherent within VNC and slower networks.

A second method entails creating a Configuration Update with eManager, using eManager panels to generate a configuration. Once created, this Configuration Update may be distributed to multiple 1883s using a distribution plan. Not all features can be configured using eManager panels.

A third option involves selecting an individual node from the list and selecting to 'Edit Configuration' from the menu. This option pulls the editable files from the node, and displays the configurable options in a tabbed configuration format. You can make changes, then press the <Save> button, which will cause the changes to be written back to the node. Not all features can be configured using this method, but you will not have the delays inherent to VNC while you are making the changes.

A fourth method is achieved by making configuration changes to one unit, pulling the configuration from it, then distribute that configuration to any number of other units. A Configuration Update panel allows you to specify which configuration options you wish to pull from a unit to put into your configuration update object. Although the configuration files are retrieved individually, most configuration options in the configuration update object cannot be edited once you have retrieved them. It is important then, to pull only the information needed, and to make sure that you have correctly configured the information prior to pulling it. Those options that can be edited, are available for changing by performing the Edit Configuration Update function from the Updates menu item on the main eManager panel.

1883 Code Updates

New application update code is distributed to the 1883 through a Code Update. Code updates for the 1883 products are usually in the form of tar files accompanied with an instruction file, but other individual files can be distributed as well in a code object. eManager should know what to do with most tar files through instructions included in the instruction file. In some cases you may also include other code files if necessary, and most individual application code files will be recognized by eManager. If a file is included with the object that eManager is not familiar with, you will be prompted to provide the path information for the unknown file. Some care should be taken not to attempt to push downlevel code to a unit, and you should also not attempt to push code levels 004 and higher to an older version (003 and before).

Code update information is kept in a history file at the node, when eManager is used to update the nodes. This information is reflected in the eManager database, when information is collected from the 1883 nodes. Code updates are limited in size to 7.5 MB, by eManager, because of the size of the cache memory used on the 1883. A warning will be presented if a larger Code update is attempted. You will need to send larger updates using the Pull update method.

1883 Pull Updates

Making changes to the Linux kernel on the 1883 (at IL 003 and before) is performed through the use of a Pull Update. The pull update provides a means to distribute the necessary information in the form of a template, that a 1883 needs to pull its update from an FTP server. Distributing an 1883 Pull Update sends the template to the 1883, then instructs the 1883 to update itself. You can also pull updates on 1883s that are at IL 006 and higher (IL 004 and 005 do not support Pull updates), and may need to do so if the update exceeds 7.5 MB in size.

Using the Code Update Matrix

You can create a Code Update Matrix for use with the Code and Pull Updates that you have created for use with the 1883. In the matrix you can specify IL (code) level and a particular Update that you want to be sent to any device detected with that IL level during execution of the distribution plan. By using the Code Update Matrix you can create a path by which down level units can be stepped up to the latest code level in an orderly fashion.

eTerm 350 Updates

All code changes to the 350 using eManager are performed as a pull update, using FTP (TFTP code changes must be performed directly from the unit). Configurations are pushed to the 350.

350 Configuration Updates

The remote configuration of the 350 product can be achieved in a couple of ways. You can make configuration changes to one unit, pull the configuration from it, then distribute that configuration to any number of other units. A Configuration Update panel allows you to specify which configuration options you wish to pull from a unit to put into your configuration update object. Most configuration information can be edited within eManager, so it is possible to pull the configuration from a unit, make changes, then push the configuration back to the unit. Those options that can be edited, are available for changing by performing the Edit Configuration Update function from the Updates menu item on the main eManager panel. You can also create a configuration from scratch from eManager, then push it to a unit. eManager keeps track of the options selected, and determines which levels of code, memory, and loader are required at the node, and provides a visual display of this in the Edit Configuration Update panel. You can use the Edit function to "dumb down" a configuration to allow you to push it to a downlevel client.

350 Pull Updates

New code is installed on the 350 through use of a Pull Update. A Pull Update template must be created in eManager then, distributed to the 350. Each 350 will then use the template instructions to make contact with an FTP server and pull, then process the file specified. The file must be placed on the FTP server prior to executing the distribution plan. You can control the number of 350s that will attempt to pull their updates from the FTP server by setting the Pull Interval on the Distribution Plan Editor panel when creating the Distribution Plan.

eTerm 300/360/760 Updates

Code changes to the e300/360/760 products using eManager consists of replacing the complete binary (typically 12-15 MB) and can be performed as either a push operation or pull operation. A push operation involves moving the binary file residing in the eManager directory structure, to the client. The pull operation requires that you position the update on a Windows platform available to the nodes that you are attempting to update, and pointing the nodes to the binary file through means of a pull update template. It should be mentioned that prior to code version WinCE 4.2 Build 4021, the portions of the existing configuration of the device may not be saved through a binary code update. At older levels, eManager strives to copy configuration information from the device prior to the binary code update, then restore what it can afterwards. However, if specific IP addresses were assigned in configuration of the devices, restoring of configuration information is not possible as part of the update process. A backup of the nodes configuration is made during the Distribution Plan for a Code Update and much of the configuration can be restored once the node is assigned the correct IP address again. Configuration changes can be handled several different ways, on the e300/360/760 family, allowing for changes to be made to one node, or multiple nodes, in real time or after a reboot.

eTerm 300/360/760 Configuration Updates

Configuration changes can be made to a single node, by using the Change Terminal Properties utility. This utility establishes contact with the node and presents a user interface dialog similar to Windows Control Panel, allowing you to make changes to the configuration in real time. A similar utility is available for making changes to Host Connections. In both cases, the changes take immediate affect, but affect only one node, so if the same changes need to be made to several nodes, you must repeat the process several times. Not every feature configuration is accessible through these utilities. To access these utilities display the list of e300/360/760 nodes on the main eManager panel, and select the node that you want to modify. Right-mouse-click the node and select 'eTerm 360 Utilities'. The resulting submenu displayed will include the 'Change Terminal Properties' and 'Change Host Connections' utilities.

Another option is to create a Configuration Update with eManager. The Configuration Update is made by either pulling an existing Configuration from a node that has already been configured, or by using the eManager panels to create a configuration by scratch. When creating a Configuration Update with eManager, you can specify which configuration options are to be changed or configured, and with the intent not to change other options. A feature checklist is provided when pulling a configuration from a unit, to indicate which feature configurations to pull. A similar check off list is used when making configuration changes, allowing to modify your original feature selection. When pushing the resulting configuration to a remote node, only the options that were selected are modified on the remote device. Configuration Updates can be sent to one or multiple units by way of a Distribution Plan that you create. Not every feature can be configured through this utility. Using this process, it is possible to duplicate configuration options across the different models.

VNC is yet another option to allow you to reconfigure an individual remote node. VNC allows you to shadow the operations of the remote device, including the ability to make configuration changes in real time. Additional information on VNC operations in general is described under VNC Connection.

eTerm 300/360/760 Code Updates

Using a Code Update you can update the binary code on one or more eTerm 300/360/760 nodes at one time. Separate code binaries are used on the individual models. The remote nodes should have the intelligence to only accept the correct code updates for their model type, but it is still good practice to group the nodes by model type, to streamline the update process. To create a Code Update, expand the Folders View tree, Update Files branch to display the eTerm 300/36/760 category, and further expand to reveal the Code category. Right-mouse-click the Code entry and select 'Add Code Update'. You will be required to name the Code Update and browse for the binary file that will be included in the update, from the Code Update panel. Once the Code Update has been saved, you will use a Distribution Plan to send the Code Update to the node(s) that you wish to update.

eTerm 300/360/760 Pull Updates

Update a remote node with a Pull update involves positioning the correct binary file onto a Windows platform, typically on the same subnet as the remote node that you want to update. You then create a Pull Update template by expanding the Folders View tree to display the 'Update Files/eTerm 300/360/760/pull' path and select it with a right-mouse-click. From the resulting menu, select 'New Pull Update'. Fill in the template with the correct information and save it. Once saved, you can call out the template as part of a Distribution Plan, and send it to one or more remote nodes.

LINCS Updates

A code update to a LINCS platform requires replacement of all code files (over 200) at one time. Code upgrades can normally be performed from any Integration Level to a higher level. If you are attempting to take a platform to a lower code level, you should also send a corresponding lower level of configuration for that unit with it. (The older code level is normally incapable of using the configuration files that reside on the node.)

Configuration is concentrated into just a few files, one containing the main configuration, and a few specialized files. The main configuration file is typically created on a specific LINCS platform and used only with that platform. This file contains all of the network and host connection information, as well as information that is specific to a particular combination of hardware, making each LINCS platform's configuration unique. The other specialty configuration files, may contain information that can be globally used by multiple platforms.

Configuration files have a code level associated with them, and can be used on LINCS platforms that are at the same code level or higher. A lower code level can not read the configuration created at a higher code level.

LINCS Configuration Updates

A configuration update is first created on a LINCS platform and then pulled off with eManager. You can pull any of the configuration files from a platform and store them in the update. You can select which of the configuration files are to be retrieved and added into the update. This update can then be distributed to another LINCS platform. Note that the main configuration file should not be pulled from one unit and sent to another unless you are attempting to duplicate the configuration complete with network connections and hardware configurations.

LINCS Code Updates

Code updates are normally distributed from Visara in the form of 4 self-extracting zipped files. Each of these 4 files can be unzipped onto a floppy. The floppies can be manually loaded onto a LINCS platform as part of a "merge" process. You can also load these floppies into eManager as part of a Code Update. When loaded into eManager from 4 floppies or from 4 different subdirectories on a hard drive, eManager will remember which files are contained on each floppy for recreating floppies later if desired (for manual distribution and installation if needed). Once a Code Update has been created in eManager, you can distribute the code across the network to one or more LINCS platforms as part of a distribution plan. If all 4 zipped files are unzipped into a single directory, eManager can still create a Code Update, but the ability to reconstruct floppies from the Code Update has been lost.

Code Update Screen

The Code Update Screen is used to create software updates that can be distributed to the product nodes. For the 1683 and 1783, a software update can be an integration level change, a hot flash update or a combination of the two. For the 1883 the code update can be a combination of tar files and regular files as well as hot flash updates. Code updates on the eTerm 300/360/760 products consists of a single binary file. The LINCS code update consists of over 200 files.

As this screen is launched, you are prompted to enter a name for this update. A directory with this name is created within the eManager directory structure. The Code Update Screen then provides for adding and deleting files via the Add A File and Delete File buttons, respectively. You should use these functions to copy the files required by the update into the new directory. eManager also adds an object.txt file to the directory containing a list of the files that are included in the code update.

Note that the Distribution Plan Screen handles any situations where the installation order of the files needs to be specified.

Code updates are contained within the eManager directory structure in the following way:

<eManager Directory>/Updates/<Product Type>/Code/<New Directory>

Where,

<eManager Directory> is the directory where eManager files were installed

<Product Type> is the Name of target product Type. eManager has already created this branch of the directory. Be sure to select the one that matches your target product.

<New Directory> is the name of the directory that will contain the update files.

For example a directory for integration level 47 for a 1783 might be:

C:\program files\eman3000\updates\1783\code\IL47

In the case of adding LINCS files to a code update, eManager looks for a specific file associated with each of the 4 disks, and upon your selecting that file, eManager pulls the remaining files over for that disk. If all files associated with that update are located in one directory, eManager will pull all of the files in the directory over, and recognize that all 4 disks are accounted for. Configuration files are not allowed in a code update, and must be handled with a configuration update.

Note that when adding a file, eManager will start you in the current directory, unless you have configured a default directory in the eManager Options.

Configuration Update Screen

The Configuration Update Screen is used to create configuration updates that can be distributed to the product nodes. Included on the screen is an array of configuration options that you can select from. Only the selected options will be included as part of the update when you create it and when you distribute it. This allows you to copy and change only the options that you desire, leaving other options untouched on the nodes that you are updating.

In some instances, a configuration update can include code for an application, e.g. 1480 client, TN3270 client, etc., but in most instances, consists of one or more configuration files used by the client node type. By default, eManager does not allow you to select the application code files, and will leave the checkboxes for application code grayed out. You can change this on the eManager Options panel.

A dropdown control is used to specify the Configuration Source. Sources vary from one node type to another, but typically selections include the ability to pull a configuration from a node that has already been configured, create the configuration from panels within eManager, or copy existing configurations stored on the eManager platform (such as from a backup taken of a node).

If copying a configuration from a node, you have the option to specify the node from a list, or simply pointing to a node's IP address, if the node is not known to eManager.

Optionally, for some node types, you can choose the NCT Master as the source. See the Node Viewer Screen on how to designate a product node as NCT Master.

Each Configuration Update is stored in a separate directory within the eManager directory structure. The directory location is as follows:

<eManager Directory>/Updates/<Product Type>/Config/<New Directory>

For example, a configuration change named TN3270 for the TN3270 Client in a 1783 might be:

C:\program files\eman3000\updates\1783\config\Tn3270

When creating the Configuration Update from eManager panels, you will be presented with the Configuration Editor Screen, containing a set of tabbed panels labeled by configuration category. On each of the tabbed panels, a box entitled 'Options Enabled' gives a list of features that may be configured on that panel. Only options checked may be configured on that panel. An unchecked option indicates that you do not wish to include the configuration of that feature in your update, and nodes to which your update is sent will not change the options that have not been checked.

Before exiting the configuration panels, you must perform a save using the <Save> button. If you do not save the configuration, eManager will save what you have when you exit the configuration panels. Not all features may be configured directly from eManager panels. If you need configurations not included in the eManager panels, you must pull them from an appropriately configured node. Exiting the configuration panels takes you back to the Configuration Update Screen.

There is a scratchpad at the bottom of the screen where comments or notes about this configuration can be stored. This is for documentation purposes only. This area also serves as a log. As the configuration is created, progress is displayed in the scratchpad area. (To switch between the two, click the View Log or View Comments button.)

At this point you could click the Distribute button to display the Distribution Plan Screen and create a distribution plan to transmit this configuration to the product nodes.

Pull Update Screen

The Pull Update Screen provides a means to specify information that can be loaded into a node to allow the node to update itself from an FTP server. The specified information can be thought of as a Pull Update Template, that can be sent to a node or group of nodes that will all be updating themselves from the same FTP server. The Pull Update is distributed as part of a Distribution Plan. You can set additional distribution options for the Pull updates on the Distribution Plan Editor panel.

It is important to remember to load the update files onto the FTP server, prior to executing the Pull Update distribution. Not all node types support the Pull function.

Configuration Editor Screen

The Configuration Editor Screen permits changing specific node configuration items as part of the creation process for a Configuration Update, or once a Configuration Update has been created. Not all configuration items can be changed in the editor. A set of checkboxes are provided under the heading of "Options Enabled", to indicate which configuration options are included in the update (and which options can be changed). Options can be added or deleted from the update by changing the status of the checkboxes. Once deleted from the update, most options will default back to a "factory default", if enabled once again. When editing an existing Configuration Update, and you exit the Configuration Editor Screen without saving the edits, the changes will be lost, and the Configuration Update will remain unchanged.

When an option group is disabled, it is usually grayed out. When enabled, you can make selections within that group. Pressing the <Save> button writes the current changes to the Configuration Update.

Distribution Plan Editor Screen

The Distribution Plan Editor is used to schedule transmission of a code and/or configuration and/or pull update to targeted product nodes. The screen permits selection of a code update, a configuration update, or pull update, or a combination from dropdown lists; the target product nodes or groups, and other miscellaneous choices as described below. For the 1683, 1783, and 1883, you can also select a Code Update Matrix. When selections have been made, click File/Save and enter a name at the prompt to save the plan to the database. No further action is taken until you submit it for distribution. To submit it, click the Action/Submit menu or from the Folders/Items View Screen by select the named plan, right click it, and click the Submit menu. Once submitted, eManager starts the plan, i.e. starts sending the update to target product nodes, according to the Start/Stop Date/Time as explained below and maintain a log so success or failure and be determined.

When a code update or configuration update is selected, files contained in the update directory are listed on the right side of the screen. eManager provides a verify function that checks these files for potential errors according to the following rules and node type and displays results in the verify log at the bottom of the screen.

1683/1783 Nodes

All files in the directory must be targeted for the same integration level.
If the directory contains a code update file, ilNN.car, it must also contain a corresponding ilNNupdY.XX instruction file where NN is the new code integration level and XX is the lowest integration level to which the update can be applied (file type XX is optional) and Y is the target product type, i.e. Y=t implies either 1683 or 1783, Y=6 implies 1683, Y=7 implies 1783
The Y parameter must match the target product node type for which this distribution is created.
Each hot flash instruction file, HFNN.LL (or HFNN.L), generally has a corresponding code file, HFNNLL.car, where NN is the code integration level and LL is the hot flash number.
As a minimum, the directory must contain one code update file and instruction or one hot flash update file and instruction.
Each file specified for expansion or copy in the code update instruction or in a hot flash instruction must be present in the directory. All files in the directory must be at the same integration level.

If errors are detected, the plan will not be saved. Note that these are basic, high level checks and obviously do not cover all possible errors. In some cases a warning in lieu of an error is issued and save is permitted. The prudent user will double-check each update for accuracy. In some cases you may need to change the installation order of the instruction files. See the Menu Items discussion below for details on how to do this.

Similar revision level checks and instruction file checks are done for the configuration update.

If an integration level update matrix has been created, "Matrix" can be selected as the code update. See Code Update Matrix Screen for information on how the update matrix is used.

No error checking is done when "Matrix" is selected. However, unless Ignore All Errors has been check, the distribution manager will check for errors when an update specified by the matrix is processed.

When a Pull Update is selected for distribution, an additional Pull Interval parameter is displayed and is available for setting. The Pull Interval defines the amount of time that eManager will wait between attempting to load each node with a template, to prevent large number of nodes from attempting to download their updates from an FTP server all at once.

The following paragraphs describe the menu items, target node selection and other choices available in more detail.

Menu Items

File

Save – Saves the plan to the database. If this is a new plan, you are prompted for a name.

Save As – Saves the plan as a new plan.

Exit – Exists the Distribution Plan Screen

Edit

Copy Plan - Clicking the Copy Plan menu writes the plan information to the Windows clipboard. This enables you to paste it into any other application for editing and/or printing. Right clicking the file list can also access this menu.

Change Installation Order - The update may require instruction files to be implemented in an order other than the default. The default order generated by eManager orders the integration level update file first, followed by any hot flash instruction files ordered by the hot flash number. To change the installation order of a file, right-mouse-click the file list to display the dropdown menu and select the Change Installation Order menu. At the prompt, enter the desired position number for the file.

Return To Default Order – Clicking this menu item returns the installation order of the instruction file to the default.

Add A File – Clicking the menu displays a screen that permits browsing to a file and adding it to the update directory. Right clicking the file list can also access this menu.

Delete A File – To delete a file, click it to select it, then click this menu item

Target

Workstation Nodes – Clicking this menu item causes workstation node names to display in the list.

Workstation Groups – Clicking this menu item causes workstation Group names to display in the list.

FTP Server Nodes – Clicking this menu item causes FTP server node names to display in the list.

FTP Server Groups – Clicking this menu item causes FTP Server Group names to display in the list.

Action

Submit – Clicking this menu added this plan to the queue for distribution. Distribution will start according to the start/stop parameters as described below.

Terminate – Clicking this menu submits a request to terminate this distribution. The distribution will not initiate further product node updates but will finish its current tasks prior to terminating.

Monitor – Clicking this menu item displays the Distribution Monitor Screen.

View

View Distribution Log – If you are editing an existing plan, you can display the distribution plan log by clicking this menu. The scratchpad area at the bottom of the screen is shared by the distribution log and the verify log.

View Verify Log – Clicking this menu item displays the verify log.

Help

Contents – Clicking this menu item displays this document.

Distribution Editor Screen – Clicking this menu item displays the Distribution Plan Editor portion of this document.

Buttons

Save – see save menu item

Nodes – displays workstation nodes

Groups – displays workstation groups

Submit – see Action/Submit menu

Exit – Exists the Distribution Plan Screen

Other Choices

Send Configuration Update First

eManager orders the configuration instruction file first followed by any code and hot flash instruction files; otherwise, the code and hot flash instruction files are ordered first. This option is not allowed for all product types.

IML After Distribution

It is generally recommended that you