The main body of the VersaLex window is divided into several sections:
- tree pane (upper-left),
- content pane (upper-right)
- messages pane (lower)
- status bar (bottom).
The VersaLex application makes extensive use of right-click menus. When in doubt, especially in the tree pane, right-click.
yyyy/mm/dd
and hh:mm:ss
(24-hour clock).Tree Pane
The tree pane actually contains two trees - the Active host tree and the Templates host tree. Only active hosts can be manipulated; template hosts are display-only until activated.
Within each folder in the tree, branches are sorted alphabetically.
Within the active tree, colors are used to represent status:
- Red indicates that the branch has been disabled and cannot be used.
- Orange indicates that configuration is incomplete for the branch and it is not yet ready for use.
- Green indicates that the branch or an action within the branch is currently running.
Content Pane
The tree pane selection controls what appears in the content pane.
- If you select a Hosts, Mailboxes, HostActions, TradingPartners, Actions, or Services folder in the tree pane, a folder table listing details specific to the folder contents is displayed in the content pane.
- If you select a specific host, mailbox, host action, trading partner, action, local host, or service in the tree pane, a configuration panel specific to the object selected is displayed in the content pane.
Folder table
When you select a folder containing Hosts, Mailboxes, HostActions, TradingPartners, Actions, or Services in the tree pane, the content of the folder is displayed in a table listing details specific to that folder.
Colors represent status:
- Red indicates that the branch has been disabled and cannot be used.
- Orange indicates that configuration is incomplete for the branch and it is not yet ready for use.
- Green indicates that the branch or an action within the branch is currently running.
You can sort the table using any column. The current sort column is marked accordingly.
Configuration panel
Even though configuration panels are specific to the host type and the branch selected, there are some similarities among them.
The upper section of the panel always contains the alias of the branch selected, the enabled selection, the ready indication, and the host type and transport description.
- If the enabled selection is set to
off
, it is displayed in red. - Required fields are starred (*). If any required fields are missing or incorrect, the ready indication will be
off
and displayed as orange. If the mouse is moved over 'Ready', tool tip help will indicate which required field is missing.
The middle section of the panel always contains one or more tabbed sub-panels.
Some of the tabs are consistent across host types. For example, the General and Notes tabs above are used for ALL host types.
Password fields will mask the actual value entered (for example, ).
The lower section of the panel always contains Apply and Reset buttons. These buttons are enabled only for active hosts when changes have been entered into the panel.
Messages Pane
The messages pane continually scrolls runtime messages as they occur. Messages can originate from two main sources:
A running action, host action or local host will generate status messages. Indentation and color are used to indicate message flow and status.
hh:mm:ss <Action>Mailbox@Host Run: type="type"
hh:mm:ss <Action>Mailbox@Host Detail: "message" level=#
hh:mm:ss <Action>Mailbox@Host Command: "put command" type="protocol" line=#
hh:mm:ss <Action>Mailbox@Host File: "local path" direction="Loca -> Host" destination="remote path" number=# of #
hh:mm:ss <Action>Mailbox@Host PROTOCOL: "request"
hh:mm:ss <Action>Mailbox@Host Transfer: kB/sec=#.# kBytes=#.# seconds=#.#
hh:mm:ss <Action>Mailbox@Host Response: "good host response"
hh:mm:ss <Action>Mailbox@Host Result: "Success"
hh:mm:ss <Action>Mailbox@Host File: "local path" direction="Local->Host" destination="remote path" number=# of #
hh:mm:ss <Action>Mailbox@Host PROTOCOL: "request"
hh:mm:ss <Action>Mailbox@Host Transfer: kB/sec=#.# kBytes=#.# seconds=#.#
hh:mm:ss <Action>Mailbox@Host Response: "good host response"
hh:mm:ss <Action>Mailbox@Host Result: "Success"
--> hh:mm:ss <Action>Mailbox@Host Command:--> "get command" type="protocol" line=#
hh:mm:ss <Action>Mailbox@Host File: "remote path" direction="Host->Local" destination="local path" number=# of #
hh:mm:ss <Action>Mailbox@Host PROTOCOL: "request"
hh:mm:ss <Action>Mailbox@Host Transfer: kB/sec=#.# kBytes=#.# seconds=#.#
hh:mm:ss <Action>Mailbox@Host Response: "bad host response"
hh:mm:ss <Action>Mailbox@Host Result: "unsuccesful" "reason"
hh:mm:ss <Action>Mailbox@Host Hint: "possible cause"
hh:mm:ss <Action>Mailbox@Host End
--> Message Type | Purpose | How many | Color |
---|---|---|---|
--> Run: | Mark start of action run, has run type | 1 | Black |
--> Detail: | Provide extra detailed information; can appear anywhere in the flow | Unlimited | Black |
--> Command: | Mark start of a command, has command text and line number | --> 0 or more per Run: | Green |
--> File: | Mark start of a file transfer, has file paths and counts | --> 0 or more per Command | Blue |
--> Transfer: | Mark completion of a file transfer, has transfer rate | 1 per File | Blue |
FTP: or HTTP: | Protocol-specific request made to host | 0 or more per Command | Black |
Response: | Protocol-specific response from host | 1 per FTP or HTTP request |
Black if good --> Red --> if bad |
--> Result: | Mark end of a command or file transfer, has resultant status | --> 1 per Command or File |
--> Green --> if successful --> Red --> if unsuccessful |
Hint: | Provide insight into possible cause of error or exception | Unlimited | Magenta |
End | Mark end of action run | 1 | Black |
The outer VersaLex application shell may detect a situation that requires a message. Color is used to indicate message severity.
hh:mm:ss Note: "message"
hh:mm:ss Warning: "message"
hh:mm:ss Error: "message"
hh:mm:ss Exception: "message"
hh:mm:ss Detail "message" level=#
Type | Purpose | Color |
---|---|---|
Note: | Log a notable condition | Black |
Warning: | Log a cautionary condition | --> Orange |
Error: | Log an unrecoverable error | Red |
Exception: | Log an unrecoverable program exception | Red |
--> Detail: | Provide extra detailed information; can appear anywhere in the flow | Black |
Status Bar
The status bar has five sections:
- Lists any running action, host actions, and local hosts.
- Indicates whether the scheduler is currently running.
- VLTrader and Harmony only. Indicates whether the router is currently running.
- Shows the mode of the UI:
- Service/Daemon: Running - The UI is a 2nd process attached to a Windows service or Unix daemon, which is running in the background. If the service/daemon should stop, the UI will indicate Service/Daemon: Stopped and then shutdown.
- UI Service/Daemon - is not running in the background as a Windows service or Unix daemon, but the UI is enabled as a “service” (see Other system options). This means that the UI will act as a service/daemon would and service any command line processes.
- Standalone - is not running in the background as a Windows service or Unix daemon, and the UI is not enabled as a “service” (see Other system options). This means that command line processes will queue up and only run after the UI is exited.
- Service/Daemon - is running in the background as a Windows service or Unix daemon, but because the service/daemon is enabled as a UI (see Other system options), there is not a 2nd UI process attached (i.e. the service/daemon process itself is displaying the UI).
Note: When is running on an AS/400, by default it is running in the background like a Windows service or Unix daemon. The UI can be displayed on a Windows PC connected to the AS/400, and in this case the UI mode will be AS/400: Running. - Continually reflects the current day, date, and time.
Comments
0 comments
Please sign in to leave a comment.