Show contents of event stream
Component: | BS2000 |
Functional area: | Job processingg |
Domain: | CONSOLE-MANAGEMENT |
Privileges: | STD-PROCESSING |
Function
The SHOW-SYSEVENT-LOG command enables an interactive task to call or start the presentation function of the Event Stream Service (ESS). The presentation function features two presentation modes:
Static mode
Static mode allows selections to be made within the event stream being viewed. In this mode, events which have already been recorded can be represented, but new events cannot be shown immediately. In static mode, interactive output control can be exercised with the aid of a menu, by direct input on the command line or using function keys.
The presentation function always starts up in static mode. The presentation window then shows the current end of the event stream. In the case of active event streams, it is possible to switch instantly to dynamic mode using the [F6] key or the menu.Dynamic mode
In dynamic mode, new events are represented immediately. The current end of the event stream is always shown. Each time a new event occurs, the screen is updated. Consequently, dynamic mode is only useful and selectable for active event streams. Event streams which have finished, with logging completed, can only be represented in static mode.
As the presentation function in dynamic mode is always ready to show new output, interactive operation is not possible. The [K2] key switches from dynamic mode to static.
The event stream is displayed in a full-screen presentation window, in either English or German depending on the task-local setting of the MIP message language (see the MODIFY-MSG-ATTRIBUTES command). The windows are drawn by FHS. In interaction with the presentation function, the full FHS functionality is available (control statements, help system, etc.).
It is not possible to issue system commands from within the presentation function.
Privileged functions
Systems support staff (OPERATING privilege) can have the contents of system event streams output.
Furthermore, they can have the system messages directed to the operating staff via the routing code displayed at a data display terminal. It is not necessary to allocate an event stream to a user task (LOG-ID=*SYSTEM-MSG-ONLY).
Format
SHOW-SYSEVENT-LOG |
Operands
LOG-ID = *ACTIVE / <alphanum-name 1..4>(...) / *SYSTEM-MSG-ONLY
Selects which event stream to show.
LOG-ID = *ACTIVE
The event stream which is currently assigned to the user’s own task and is active is to be shown.
LOG-ID = <alphanum-name 1..4>(...)
The event stream with the specified name is to be shown. The name may also begin with numeric characters (if LOG-ID was set to *OWN-TSN when the stream was assigned).
TYPE = *SYSTEM-LOG / *USER-LOG
This operand is reserved for users with OPERATING privilege.
Defines the type of event stream which is to be shown (system event stream or user event stream).
LOG-ID = *SYSTEM-MSG-ONLY
This operand is reserved for users with OPERATING privilege.
System messages directed by routing code to operating personnel are to be output on a terminal without previous assignment of an event stream to a user task. That means that there is no representation of synchronous or asynchronous messages which are addressed to a specific user task (i.e. no interactive elements). Selection of the messages which are represented is based solely on the settings defined for OPERATOR-ROLES, MSG-SUPPRESSION, MSG-SUBSCRIPTION, and CONSOLE-FILTER.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command successfully executed | |
1 | CMD0202 | Syntax error | |
32 | NBR3115 | FHS-TPR subsystem not available | |
32 | NBR3199 | Internal error on command server | |
64 | CMD0216 | User does not have required privilege | |
64 | NBR3103 | No event stream assigned | |
64 | NBR3104 | No event stream matches selection criteria | |
64 | NBR3105 | No event stream being managed | |
64 | NBR3114 | Associated event stream file not cataloged |
Output form in static mode
If the task-local MIP message language is English, the following presentation window is displayed when the presentation function is started or when static mode is activated for the referenced event stream (the presentation window shows the current end of the event stream for the setting LOG-ID=*SYSTEM-MSG-ONLY):
File Edit View Help
--------------------------------------------------------------------------------
EVENT STREAM SERVICE
Log-Id: 0KUC User-Id: USER1 Owner-TSN: 0KUC Mode: Static
--------------------------------------------------------------------------------
Date: 2012-06-29 Time: 15:07:16 Status: Active
Lines 1 thru 4 of 4
More:
MESS % FTR0014 FT-BS2000: CMD REJECTED. ERROR IN TRANSFER-ADMISSION.
TRANSFER-ID 43058448 :15:07:06 :2012-06-29181
MESS % FTR0014 FT-BS2000: CMD REJECTED. ERROR IN TRANSFER-ADMISSION.
TRANSFER-ID 41092378 :15:07:16 :2012-06-29181
* * * End of actual presentation range * * *
Command ===>
F1=Help F3=Exit F6=Dynamic F7=Backward F8=Forward F10=Menu F11=Index ...
If the task-local message language is German, the above presentation window appears in German.
Menu bar
File Edit View Help -----------------------------------------------------------------------------
On the menu bar, you can select the various menu items (objects) both with the cursor and directly with the [F10] key. You move the cursor to the required position and then press the [DUE] (send) or [ENTER] key.
Some menu items activate pull-down menus. If you select one of these items, a submenu opens, offering various options. Selecting one of these options may, in turn, open a dialog box. Once the necessary choices have been made in the dialog box, you can start the desired operation by pressing [DUE] or [ENTER].
To close a pull-down menu without selecting an option, you press the [F12] key.
Many of the options offered on pull-down menus can also be activated with the aid of F keys (see the table "Function keys and commands").
The items on the menu bar are as follows:
Menu item | Option | Function |
|---|---|---|
File | Exit | Quit presentation function |
Edit | Find | Call search function |
Reply | Call reply function (only for system event stream) | |
View | Dynamic Mode | Switch to dynamic mode |
Display | Define whether presentation is to be with or without header. | |
Top Range | Position presentation area at start of event stream. | |
Bottom Range | Update event stream | |
Previous Range | Scroll backwards through presentation area | |
Next Range | Scroll forwards through presentation area | |
Help | Switch to help system |
If conflicting selections are made, the menu bar selection has top priority. The function keys (F keys) have a lower priority, and the commands have the lowest priority.
Status area
EVENT STREAM SERVICE Log-Id: @@@@ User-Id: @@@@@@@@ Owner-TSN: @@@@ Mode: Static -----------------------------------------------------------------------------
The status area beneath the menu bar consists of the title line plus the following information about the displayed event stream:
Log-Id | Name (ID) of the displayed event stream. |
User-Id | User ID of the task under which the event stream was started. |
Owner-TSN | TSN of the task under which the event stream was started and to which the event stream is consequently assigned. |
Mode | Display mode of the presentation function (static or dynamic) |
Work area
Date: @@@@@@@@@@ Time: @@@@@@@@ Status: @@@@@
The work area below the status area contains the following information, updated each time the screen is redrawn:
Date | Date when the last message in the current area was generated. |
Time | Time when the last message in the current area was generated. |
Status | Indicates whether the displayed event stream is active or inactive (closed). |
Presentation window
Lines @@@@ thru @@@@ of @@@@
More: + -
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
.
.
.
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
The presentation window below the work area takes the form of a list. Its first two lines are an indication of which lines of the full list are on the current screen (line 7) and a prompt showing possible positioning (scrolling) commands (line 8). The next 14 lines are available for the presentation function. The events are displayed here, and the lines can be marked (selected).
Owing to the variable length of the events, line breaks may be inserted when they are presented. This feature cannot be deactivated. Line breaks make allowance both for word boundaries and for format control characters included in the messages (newline = X'15'). If a message which extends over a number of lines is displayed and needs to be selected so that a reply to it can be sent, only one line of the message (any line) should be marked. Multiple selections are rejected.
Command area
Command ===> F1=Help F3=Exit F6=Dynamic F7=Backward F8=Forward F10=Menu F11=Index ...
The command area (command line) is immediately below the presentation window. Direct input to the presentation function can be entered on the command line, primarily positioning (scrolling) commands, but also all the commands supported by FHS-DM (except for the SYS command) plus the strings which are the written equivalents of the ESS-specific
F keys (e.g. [F10], [F13]; see also table 159 below). The latter option is typically useful on terminals which only have keys [F1] through [F3]. As a rule, the command line is preset to show the positioning (scrolling) command “-” or “+”.
Function keys
The penultimate line of the window (line 24) displays a selection of the principal function keys (F keys). The following table lists all the available function keys and indicates what they do and the commands which are equivalent to them:
F key | Command | Meaning |
|---|---|---|
[F1] | HELP | Call help system |
[F3] | EXIT | Quit presentation function |
[F5] | RESHOW | Reshow last output |
[F6] | F6 | Switch to dynamic display mode |
[F7] | - | Scroll up |
[F8] | + | Scroll down |
[F10] | MENUE | Switch to menu bar |
[F12] | CANCEL | Cancel (e.g. selected menu item) |
[F13] | F13 | Position to start |
[F14] | F14 | Position to end |
[F15] | F15 | Call search function |
[F16] *) | F16*) | Mark (select) |
[F18] | F18 | Call reply function |
[F21] | F21 | Previous range |
[F22] | F22 | Next range |
[F24] | F24 | Switch to with header or without header |
*) | For terminals which do not have a [MAR] key |
If conflicting selections are made, the menu bar selection has top priority. The function keys (F keys) have a lower priority, and the commands have the lowest priority.
Message area
The bottom line of the window (line 25) displays system messages.
Messages generated by the presentation function are output in nonmodal message boxes.
Functions
Find function
If you select “Edit” from the menu bar, a pull-down menu opens. If you select “Find” from this menu, a dialog box (with “Find” on its title bar) opens in the bottom right-hand corner of the screen, prompting you to enter a search pattern up to 32 characters long. You can also call the Find function directly using function key [F15].
The characters you enter are interpreted as “character”-type characters, and C‘...’ will be interpreted as a search pattern. The dialog box also lets you define the position to start from (current presentation window, beginning, end) and the direction to search in (forward, backward). The dialog box remains open until the search function is terminated.
When the Find function is called, the dialog box has the “Start from” position preset to “Current Screen” and the search direction preset to “Backward”. If you change this default setting, the new setting is retained as the default for any subsequent search. Pointless combinations (such as Start from =Top, Direction = Backward) are rejected. To start searching you press [DUE] (send key) or [ENTER].
If the search finds a match, the message containing the matching string is displayed in the presentation window, beginning on the first line. The reopened dialog box continues to show the search pattern. If you want to continue searching for the next match, you simply need to press [F13]. To start a new search for a different pattern, you replace the old pattern with a new one of your choice and then press [F13]. To cancel the Find function you press [F12]. If you press [F12] and a match has been found, the presentation window will be positioned to the last match. If no match has been found, a message to that effect is issued, and the presentation window is not repositioned but stays where it was when the unsuccessful search began. The following function keys control the Find function:
F key | Command | Meaning |
|---|---|---|
[F1] | HELP | Call help system |
[F3] | EXIT | Quit Find function |
[F12] | CANCEL | Cancel Find function |
[F13] | F13 | Find next match |
If conflicting selections are made, the menu bar selection has top priority. The function keys (F keys) have a lower priority, and the commands have the lowest priority.
Reply function
The Reply function is available only for system event stream presentations. With user event streams the function is marked “*” on the menu to show that it is disabled.
If you select “Edit” from the menu bar, a pull-down menu opens. If you select “Reply” from this menu, a dialog box (with “Reply to pending message” on its title bar) opens in the middle of the output form’s work area, prompting you to enter a reply.
You can, however, also call the Reply function directly using function key [F18]. If you mark a system message in the work area before you call the function, the “Sender” field will be preset to the TSN of the task which sent the message or to the device mnemonic of the operator terminal (console) which sent the message, and the “Message Identifier” field will already contain the three-character message identifier. In such cases all you need to enter is the reply text (up to 80 characters, case-sensitive). The message identifier entry box ends with a dot as part of the reply format known from the operator terminal. If you do not mark a system message in the work area before you call the function, you will have to fill out the dialog box in full.
To start the Reply function, i.e. to send the reply to the system, you press [DUE] (send key) or [ENTER]. A final message indicates whether the function was successful.
To cancel the function you press [F12].
The dialog box supports the [F1] key (which calls the help function).
Dynamic Mode function
If you select “View” from the menu bar, a pull-down menu opens. If you select “Dynamic Mode” from this menu, you switch to dynamic mode. You can also call the function directly using function key [F6].
The dynamic mode can only be called for active event streams. Closed event streams can only be displayed in static mode. With a closed event stream, the Dynamic Mode function is marked “*” on the menu to show that it is disabled.
Display... function
The Display... function is available only for system event stream presentations. With user event streams the function is marked with an asterisk to show that it is disabled.
If you select “View” from the menu bar, a pull-down menu opens. If you select “Display...” from this menu, a further menu opens. Here you can decide whether to have the event stream displayed in the presentation window with or without a header. Depending on the current setting, there will either be “/” or a blank in the marker field. The characters you are allowed to choose are “/”, “x” and “X”.
You can also call the function directly using function key [F24].
The Header option only makes sense with system event streams, because it is only there that system messages which have a header and are distributed via UCON are logged. The header is in the same format as is used for logging on the operator terminal (console) and in the Conslog file.
If output with header is selected as the output form, system messages which have been given a header are output along with their header. Line breaks are inserted in messages which are over 80 characters long or include suitable control characters, and all lines after the first line of the message are then indented by the length of the header (17 characters). Other messages (those which have no header) are output flush with the left-hand margin of the presentation window, without blank padding to allow for the header or indentation following line breaks.
Top Range function
If you select “View” from the menu bar, a pull-down menu opens. If you select “Top Range” from this menu, a new presentation range starting at the beginning of the selected event stream is displayed. The presentation window is positioned at the start of the new presentation range. The top end of the range is the first message in the stream, the bottom end is aligned on the message boundary.
You can also call the function directly using function key [F13].
Bottom Range function
If you select “View” from the menu bar, a pull-down menu opens. If you select “Bottom Range” from this menu, a new presentation range finishing at the end of the selected event stream is displayed. The presentation window is positioned at the end of the new presentation range. The top end of the range is aligned on message boundary, the bottom end is the last message in the stream. When active event streams are presented in static mode, this function allows you to update the output without switching to dynamic mode, provided that extra events have been recorded in the meantime.
You can also call the function directly using function key [F14].
Previous Range function
If you select “View” from the menu bar, a pull-down menu opens. If you select “Previous Range” from this menu, you are taken back to the previous range. A new presentation range is displayed, containing the events which precede those of the current presentation range. The presentation window is positioned at the bottom end of the new presentation range. Scrolling can be performed within the newly displayed range just as in the old one. When this function is executed, the boundaries between the presentation ranges are always aligned on the end of a message. This ensures that the full text of a multiline message is always included in a presentation range.
You can also call the function directly using function key [F21].
Next Range function
If you select “View” from the menu bar, a pull-down menu opens. If you select “Next Range” from this menu, you are taken forward to the next range. A new presentation range is displayed, containing the events which come after those of the current presentation range. The presentation window is positioned at the start of the new presentation range. Scrolling can be performed within the newly displayed range just as in the old one.
The information on presentation range boundaries given under “Previous Range” applies mutatis mutandis.
You can also call the function directly using function key [F22].
Help function
A complete FHS-DM-supported help system is offered for the presentation function. Function keys [F1] and [F2] call up help screens for keywords and individual fields.
You can activate the help function from a pull-down menu under “Help” on the menu bar. If the help function is active, a form containing general information on ESS and a reference to the INDEX command is displayed. The [F2] key and the INDEX command both take you straight from this form to the help system.
Output form in dynamic mode
The output form for dynamic mode differs from that for static mode in that it has no menu bar and no command line. The only function key it supports is [K2] for switching to static mode.
Under OMNIS, a change into static mode is effected with the [DUE] or with any F or K key with the exception of the key that functions as the BREAK-KEY in OMNIS (default: [K2]).
Instead of the input capabilities provided in static mode, dynamic mode offers a presentation function with dynamically changing output; interactive operation is not possible.
If the task-local MIP message language is English, the following presentation window is displayed when the presentation function is started or when dynamic mode is activated for the referenced event stream. The presentation window always shows the current end of the event stream:
EVENT-STREAM-SERVICE Log-Id: 0KUC User-Id: USER1 Owner-TSN: 0KUC Mode: Dynamic -------------------------------------------------------------------------------- Date: 2012-06-29 Time: 15:07:16 MESS % FTR0014 FT-BS2000: CMD REJECTED. ERROR IN TRANSFER-ADMISSION. TRANSFER-ID 43058448 :15:07:06 :2012-06-29181 MESS % FTR0014 FT-BS2000: CMD REJECTED. ERROR IN TRANSFER-ADMISSION. TRANSFER-ID 41092378 :15:07:16 :2012-06-29181 K2=Static Mode
Status area
The status area consists of the title line plus the following information about the displayed event stream:
Log-Id | Name (ID) of the displayed event stream. |
User-Id | User ID of the task under which the event stream was started. |
Owner-TSN | TSN of the task under which the event stream was started and to which the event stream is consequently assigned. |
Mode | Display mode of the presentation function (static or dynamic) |
Work area
The work area below the status area contains the following information, updated each time the screen is redrawn:
Date | Date when the last message displayed was generated. |
Time | Time when the last message displayed was generated. |
Presentation window
The presentation window below the work area covers lines 5 through 23. This is where the events are displayed; the lines cannot be marked.
For system event streams, the output by default includes the header specific to the operator terminal (console). The only way to change this default setting is to switch to the static mode and make the modification there; thereafter the new setting applies to both modes until it is changed again. This configuration option is not provided for user event streams as there is no need for it in such cases.
Owing to the variable length of the messages, the command server may insert line breaks. The maximum line length of 80 characters as defined in the output form is fully utilized.