Note: This section applies to the Cleo Harmony and Cleo VLTrader applications only.
You can use a web browser UI to access Cleo Harmony, Cleo VLTrader, or Cleo VLNavigator software. To configure and set up the parameters of the web browser service, see Configuring Cleo VersaLex web browser service.
To run the Cleo Harmony or Cleo VLTrader application from a web browser while not running through a Cleo VLProxy connection, you must enter the proper URL in the browser:
http(s)://VersaLexComputerIP: http(s)Port/VersaLexResourcePath
To run VersaLex from a web browser while running through a VLProxy connection, the VersaLex serial number must be supplied as a parameter:
http(s)://VLProxyComputerIP: http(s)Port/VersaLexResourcePath?serial=LX7589-YU2693
or concatenated to the resource, preceded by a dash:
http(s)://VLProxyComputerIP: http(s)Port/VersaLexResourcePath-LX7589-YU2693
In addition, you can use a number of optional URL parameters to associate external IDs with new or existing VersaLex host/mailbox aliases, limit the contents of the UI, and provide user authentication:
Type | Parameter | Description | Values |
---|---|---|---|
a | hostID= |
ID value for new or existing VLT host | Up to 255 characters, unique across all hosts |
a | mailboxID= |
ID value for new or existing VLT mailbox | Up to 255 characters, unique across all mailboxes |
a | type= |
If host or mailbox does not yet exist, comma-separated list of types of host to use | ILexiCom.listHostTypes()[].getName() |
a | alias= |
If host or mailbox does not yet exist, suggested value for new alias | Up to 50 characters, backslash character not allowed |
b | readonly= |
Comma-separated list of components that should be readonly | Host – host cannot be created or modified |
b | view= |
Comma-separated list of VLT UI components to show |
Menubar Toolbar Tree Content Messages Statusbar |
b | toolbar= |
Comma-separated list of VLT toolbar buttons to show |
Log Options Scheduler Router Certificates Transfers |
b | no= |
Comma-separated list of miscellaneous features/components to hide |
Scheduler – scheduler tool not shown Router – router tool not shown Boxes – inbox/outbox/sentbox/ receivedbox fields not shown Send+Receive – send+receive actions are not shown Collect – collect (and send+collect) actions not shown Release – release actions not shown |
c | auth= |
VLT web UI authentication. Edit/view-only authentication request honored if hostID or mailboxID URL parameter also specified or if VLNavigator user groups have not been established for VersaLex. |
or
or
|
abc | uiparms= |
Encrypted URL-encoded string containing any/all of the above parameters. Parameters can either appear directly in the URL or within the uiparms value. |
URL-encoded string encrypted using Pre-encrypted example:
|
abc | reset= |
If this is not the first entry into VersaLex and a previous session already exists, indicates to reset the session using the parameters provided above. This parameter cannot be wrapped within the uiparms= parameter value. | True |
All parameter names and values are case insensitive except for ID, alias, and password values.
Note: If a host or mailboxID is passed, VersaLex is being integrated with another application's web UI and VersaLex expects that application to display VersaLex as a popup window. To distinguish hosts and mailboxes with ID associations, the tree node icon of a host or mailbox with an ID association will have a gray box around it. Host and mailbox IDs are stored in the host XML files and are retained on export/import of hosts.
To run Cleo VLNavigator from a web browser, you must enter the proper URL in the browser:
http(s)://VersaLexComputerIP:http(s)Port/VLNavigatorResourcePath
When Cleo VLNavigator logins are not in use (see Require Logins above), the web UI supports two password-protected modes:
view-only: | user can not modify any configuration data nor active hosts |
edit: | fully-privileged user, like native UI user |
The passwords are defined under the Harmony tab or VLTrader tab of the Web Browser Service.
While the web browser interface is active, you should not use the standard web browser refresh, back, and forward buttons. To force refresh, use the refresh button in the upper right-hand corner of the web UI. Instead of the back and forward buttons, navigate through the , , or windows as if you were using the native UI.
Do not attempt to have different tabs in the same browser session accessing multiple instances of the , , or application (or even the same instance in different tabs of the same browser session.) In this case, cached information can cause you to be directed to the incorrect session.
Creating active host subfolders
Note: This section applies to the Cleo Harmony and Cleo VLTrader applications only.
If a large number of hosts are going to be activated, it is advantageous to create host subfolders for groups of active hosts. Any structure of nested host subfolders – both depth and width – is allowed. This allows the tree pane as well as other dialogs (for example Schedule,TCP/IP Port Usage, Transfer Report) to show groupings of the active hosts rather than the entire, alphabetized list.
- Click the Active tab in the tree pane.
- Right-click the top Hosts folder or any host subfolder.
- Click New Folder and rename the host subfolder to a meaningful name.
- Click and drag any active hosts between host subfolders.
Searching for a host property value
Note: This section applies to the Cleo Harmony and Cleo VLTrader applications only.
- Click the Active or Templates tab in the tree pane.
- In the Search field, enter the property value you want to search for. Optionally, select Match case. Click Search.
Note: Some right-click functions are not available while a Search is active.
- Click Clear to remove the search results from the panel being viewed (Active or Template) and return to the original tree.
Watching messages
The Messages pane scrolls runtime messages for all actions and local hosts. For a description of the message types, see Messages Pane. The level of detailed messages shown in the messages pane can be configured. See Logs. If two or more actions are running concurrently, their messages will be intertwined.
- Select a running action or local host in the tree pane.
- Select the Messages tab in the content pane.
The Messages tab scrolls runtime messages for the selected action only. Other differences between the messages pane and the Messages tab include:
- During a file transfer, the Messages tab will continually reflect the current byte count and transfer rate.
- The Messages tab has no limit on the total number of messages it can contain.
- The contents of the Messages tab is retained until the next time the action is run, even if LexiCom is restarted.
Previous messages can also be viewed through the system log file. See Viewing log files - Web UI and Viewing log files -- Native UI and Classic Web UI.
Determining status
Status can be reviewed a number of different ways:
- The status bar will list which actions are running. Only one action within each activated host can be running at any given time.
- In the Tree pane, each host\mailbox\ action branch currently running is green.
- Select the Hosts folder in the Tree pane. The Status column in the Content pane table will indicate whether an action is running and the current command, and the file and byte count, when applicable.
- Select a running action in the Tree pane. The lower portion of the Action tab in the Content pane panel will indicate the current command, and the file and byte count, when applicable.
Comments
0 comments
Please sign in to leave a comment.