SirScan browsing of the journal: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision: SirScan doc from m204stage)
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!-- Page name: SirScan browsing of the journal-->
Output from the [[SirScan scan specification|journal scan criteria]] you specified is placed in a special data structure, and
Output from the journal scan is placed in a special data structure, and
you are transferred to a TN3270 or [[RKWeb]] browsing session. The body of the display presents the journal information returned from your <var class="product">SirScan</var> request.
you are transferred to a browse session.


If <var class="product">SirScan</var> is in auto refresh mode &mdash; that is, the user left
If <var class="product">SirScan</var> is in [[#Auto-refresh mode|auto-refresh mode]] &mdash; that is, you left <b>Interval</b> blank in your  journal scan criteria &mdash; <var class="product">SirScan</var> places newly formatted journal entries into the data structure every time you request a forward scroll past the end of the current data.
<b>Interval</b> blank on the specification screen &mdash; <var class="product">SirScan</var> places
newly formatted journal entries into the data structure every time the
user requests a forward scroll past the end of the current data.


<p class="caption">Browsing the formatted journal output</p>
<p class="caption" style="width:600px">Browsing the formatted journal output</p>
<p class="figure">[[File:ScanBrowseJournal.png|600px]]</p>


The body of this screen presents the journal information returned from
==Commands and function keys==
the user's <var class="product">SirScan</var> request.
The following commands and PF keys are valid from the TN3270 interface:
The following commands and PF keys are valid:


<table class="thJustBold">
<table class="thJustBold">
Line 18: Line 14:
<tr><th nowrap>ALL <i>searchstring</i></th>
<tr><th nowrap>ALL <i>searchstring</i></th>
<td>Limits the display to lines containing the string <i>searchstring</i>.
<td>Limits the display to lines containing the string <i>searchstring</i>.
Typing ALL with no searchstring returns the user to viewing the entire selection of journal entries as originally specified.
Entering <code>ALL</code> with no search string returns the view to the entire selection of journal entries as originally specified.
To limit based on a string ending or beginning with blanks, use slashes to delimit the string, for example:
To limit based on a string ending or beginning with blanks, use slashes to delimit the string, for example:
<p class="code">ALL /&nbsp;<i>searchstring</i>&nbsp;/
<p class="code">ALL /&nbsp;<i>searchstring</i>&nbsp;/
Line 24: Line 20:


<tr><th>USER <i>unum</i></th>
<tr><th>USER <i>unum</i></th>
<td>The <var>USER</var> command limits the display to only those lines associated with the indicated usernumber. This is very similar to specifying <code>ALL /<i>unum</i>/</code>, except that,
<td>The <var>USER</var> command limits the display to only those lines associated with the indicated usernumber. This is very similar to specifying <code>ALL /<i>unum</i>/</code>, except that, with the <var>USER</var> command, lines not associated with the the user number that happen to have the number in them for some other reason are suppressed.
with the <var>USER</var> command, lines not associated with the the user number that happen to have the number in them for some other reason are suppressed.
<p>
<p>
Also, continuation lines for entries associated with the indicated user are likely to be suppressedfor the <var>ALL</var> command, but will not be for <var>USER</var>.</p>
Also, continuation lines for entries associated with the indicated user are likely to be suppressed for the <var>ALL</var> command, but they are not suppressed for <var>USER</var>.</p>
<p>
<p>
An effect similar to the <var>USER</var> command can be achieved by moving the cursor down to a line associated with the required user and pressing the Enter key.
An effect similar to the <var>USER</var> command can be achieved by moving the cursor down to a line associated with the required user and pressing the Enter key. This is different from the <var>USER</var> command in that entries are limited to the login session associated with the entry over which the cursor was positioned. </p>
This is different from the <var>USER</var> command in that entries are limited to the login sessionassociated with the entry over which the cursor was positioned.
<p>
<p>
This facility is dependent on M204.0352 messages appearing in the journal. If these are <var>MSGCTL</var>'ed to <var>NOAUDIT</var>, cursor-position based user selection will behave the same as <var>USER</var> command based selection.</p></td></tr>
This facility is dependent on M204.0352 messages appearing in the journal. If these are <var>MSGCTL</var>'ed to <var>NOAUDIT</var>, cursor-position based user selection will behave the same as <var>USER</var> command based selection.</p></td></tr>


<tr><th>PFKEYS ON | OFF</th>
<tr><th>PFKEYS ON | OFF</th>
<td><var>PFKEYS</var> allows the user to turn on or off the display of the messaage line and the two lines with PF key descriptions. If <code>PFKEYS OFF</code> is specified, the three extra lines are used to display formatted journal data.</td></tr>
<td><var>PFKEYS</var> lets you turn on or off the display of the message line and the two lines with PF key descriptions. If <code>PFKEYS OFF</code> is specified, the three extra lines are used to display formatted journal data.</td></tr>


<tr><th>SCALE ON | OFF</th>
<tr><th>SCALE ON | OFF</th>
Line 52: Line 46:
<td>Same as above, but performs the search backward form the current line.</td></tr>
<td>Same as above, but performs the search backward form the current line.</td></tr>


<tr><th>M (with PF7, 8, 10 or 11)</th>
<tr><th nowrap>M (with PF7, 8, 10, or 11)</th>
<td>Scrolls the display the maximum number of lines up or down, or the maximum number of characters left or right.</td></tr>
<td>Scrolls the display the maximum number of lines up or down, or the maximum number of characters left or right.</td></tr>


<tr><th>L <i>xxx</i></th>
<tr><th>L <i>xxx</i></th>
<td>Moves the current line to the requested line number <i>xxx</i>.</td></tr>
<td>Moves the current line to the requested line number <i>xxx</i>.</td></tr>
<tr><th nowrap><p class="codeInTable">.[<i>num</i>]</p></th>
<td><p>
Go directly to the indicated [[SirScan scan specification#Using bookmarks|bookmark]]. For example, <code>.4</code> takes you to the fourth bookmark, if present.</p></td></tr>
<tr><th nowrap><p class="codeInTable">[sir]<i>prodShortName</i> [<i>num</i>]</p></th>
<td><p>
[[RKTools#Fast-pathing|Fastpath navigation of the RKTools menu system]]. For example, <code>pro 8</code> takes you to the <var class="product">SirPro</var> group definitions screen.</p></td></tr>
</table>
</table>


<table class="thJustBold">
<table class="thJustBold">
<caption>PF Keys</caption>
<caption>PF keys</caption>
<tr><th>PF1</th>
<tr><th>PF1</th>
<td>Accesses full-screen help.</td></tr>
<td>Accesses full-screen help.</td></tr>
Line 68: Line 70:


<tr><th>PF3</th>
<tr><th>PF3</th>
<td>Quit to <var class="product">SirScan</var> specification screen.</td></tr>
<td>Quit to <var class="product">SirScan</var> scan criteria screen.</td></tr>


<tr><th>PF4</th>
<tr><th>PF4</th>
Line 74: Line 76:


<tr><th>PF5</th>
<tr><th>PF5</th>
<td>Scroll up an Interval (only active if an Interval was specified on the previous screen).</td></tr>
<td>Scroll up an interval (only active if an <b>Interval</b> was specified on the scan criteria screen). If [[SirScan_scan_specification#Using bookmarks|bookmarking]] is on, this key is <b>Prev Bkmk</b> and it brings you to the start of the previous bookmark. </td></tr>


<tr><th>PF6</th>
<tr><th>PF6</th>
<td>Scroll down an Interval (only active if an Interval was specified on the previous screen).</td></tr>
<td>Scroll down an Interval (only active if an <b>Interval</b> was specified on the scan criteria screen). If bookmarking is on, this key is <b>Next Bkmk</b> and it brings you to the start of the next bookmark.</td></tr>


<tr><th>PF7</th>
<tr><th>PF7</th>
<td>Scroll up.</td></tr>
<td>Scroll up; the line on which the cursor was placed becomes the bottom line. The cursor is reset to the command-line field, so subsequent scrolling is for full pages.</td></tr>


<tr><th>PF8</th>
<tr><th>PF8</th>
<td>Scroll down.</td></tr>
<td>Scroll down; the line on which the cursor was placed becomes the top line. The cursor is reset to the command-line field, so subsequent scrolling is for full pages.</td></tr>


<tr><th>PF9</th>
<tr><th>PF9</th>
Line 93: Line 95:
<tr><th>PF11</th>
<tr><th>PF11</th>
<td>Scroll right.</td></tr>
<td>Scroll right.</td></tr>
<tr><th>PF12</th>
<td>Print. Printing can go to a dataset so perhaps a better term would be "Extract".</td></tr>
</table>
</table>


When entries are displayed with dates, the dates are in <var>YYMMDD</var> format.
When entries are displayed with dates, the dates are in YYMMDD format. When entries are displayed with times, the times are displayed in
When entries are displayed with times, the times are displayed in
HHMMSS format.
<var>HHMMSS</var> format.


==Journal entry types==
For journal entry type selection, the following types
For journal entry type selection, the following types
of entries might be displayed (each type may be included or excluded
of entries might be displayed (each type may be included or excluded
Line 110: Line 115:


<tr><th>CI</th>
<tr><th>CI</th>
<td>Physical input line from user terminal or [[Model 204 configurations and operating environments#Model_204_configurations|IFAM]] argument.</td></tr>
<td>Physical input line from user terminal or [[Model 204 configurations and operating environments#Model 204 configurations|IFAM]] argument.</td></tr>


<tr><th>CP</th>
<tr><th>CP</th>
Line 128: Line 133:


<tr><th>LS</th>
<tr><th>LS</th>
<td>One input value from a SCREEN, or a menu selection number of a MENU.</td></tr>
<td>One input value from a <var>SCREEN</var>, or a menu selection number of a <var>MENU</var>.</td></tr>


<tr><th>MS</th>
<tr><th>MS</th>
<td>A <var class="product">Model 204</var> information message.</td></tr>
<td>A <var class="product">Model&nbsp;204</var> information message.</td></tr>


<tr><th>OI</th>
<tr><th>OI</th>
Line 138: Line 143:
<tr><th>OO</th>
<tr><th>OO</th>
<td>An output line to the operator's console.</td></tr>
<td>An output line to the operator's console.</td></tr>
<tr><th>QT</th>
<td>[[Model_204_intersystem_processing#Horizon|Horizon]] SQL output (available as of Model 204 Version 7.5).</td></tr>


<tr><th>RK</th>
<tr><th>RK</th>
Line 153: Line 161:
<!--Caution: <div> above-->
<!--Caution: <div> above-->


When no time interval was specified on the scan specification screen
If no time interval was specified on the scan specification screen,
<var class="product">SirScan</var> browsing occurs in auto-refresh mode.
<var class="product">SirScan</var> browsing occurs in auto-refresh mode.
This means that every time an attempt is made to go beyond the
This means that every time an attempt is made to go beyond the
end of the current formatted records, <var class="product">SirScan</var> formats a new interval
end of the current formatted records, <var class="product">SirScan</var> formats a new interval of records from the last time it formatted records to the current time.
of records from the last time it formatted records to the current time.
Going beyond the end of current formatted records could occur because
Going beyond the end of current formatted records could occur because
of an attempt to scroll beyond the current set of records, an attempt
of an attempt to scroll beyond the current set of records, an attempt
Line 166: Line 173:


Auto-refresh mode is a convenient way of monitoring things as they happen.
Auto-refresh mode is a convenient way of monitoring things as they happen.
A typical thing to do with <var class="product">SirScan</var> is to specify a start time
A typical way to use <var class="product">SirScan</var> is to specify a start time of <code>-0</code>, which means start "now" with no time-interval size.
of <code>-0</code>, which means start "now" with no time-interval size.
You enter the browse screen and then initiate the action you want to monitor. Because auto-refresh automatically
The browse screen is then entered and the user could then initiate
populates the screen with newly written journal records, you see
the action being monitored and, because auto-refresh automatically
what is being logged to the journal without leaving the browse screen.
populates the screen with newly written journal records, see
what's being logged to the journal without leaving the browse screen.


Ordinarily, auto-refresh mode is fairly efficient; however it should
Ordinarily, auto-refresh mode is fairly efficient. However, if the system <var>SCANTIME</var> parameter is set, and
be kept in mind that if the system <var>SCANTIME</var> parameter is set and
the <b>Read extra SCANTIME seconds</b> field on the scan criteria
the "read extra SCANTIME seconds" field on the scan selection
screen was set to <code>Y</code>, then an extra <var>SCANTIME</var> seconds of journal will be read on every auto-refresh.
screen was set to <code>Y</code>, then an extra <var>SCANTIME</var> seconds of journal will be read on every auto-refresh.


This is not to say that users should set the indicated parameter to
This is not to say that you should set the indicated parameter to
<code>N</code> when in auto-refresh mode.
<code>N</code> when in auto-refresh mode. Quite the contrary.
Quite the contrary.
Without that parameter set to <code>Y</code>, the behavior of auto-refresh
Without that parameter set to <code>Y</code>, the behavior of auto-refresh
could be very confusing indeed.
could be very confusing indeed.
It should just be kept in mind that the use of the <var>SCANTIME</var> data will
Just keep in mind that the use of the <var>SCANTIME</var> data will
perhaps add a little extra delay and overhead to auto-refresh processing,
perhaps add a little extra delay and overhead to auto-refresh processing,
especially on very busy systems with heavy journal activity.
especially on very busy systems with heavy journal activity.
Auto-refresh mode on such systems will tend to be somewhat sluggish
Auto-refresh mode on such systems will tend to be somewhat sluggish
anyway, so the addition of the <var>SCANTIME</var> data scan would probably still
anyway, so the addition of the <var>SCANTIME</var> data scan will probably still not produce dramatic delays, unless <var>SCANTIME</var> is set to an absurdly high value.
not produce dramatic delays, unless <var>SCANTIME</var> is set to an absurdly high value.


==See also==
==See also==

Latest revision as of 20:45, 20 December 2021

Output from the journal scan criteria you specified is placed in a special data structure, and you are transferred to a TN3270 or RKWeb browsing session. The body of the display presents the journal information returned from your SirScan request.

If SirScan is in auto-refresh mode — that is, you left Interval blank in your journal scan criteria — SirScan places newly formatted journal entries into the data structure every time you request a forward scroll past the end of the current data.

Browsing the formatted journal output

Commands and function keys

The following commands and PF keys are valid from the TN3270 interface:

Commands
ALL searchstring Limits the display to lines containing the string searchstring.

Entering ALL with no search string returns the view to the entire selection of journal entries as originally specified. To limit based on a string ending or beginning with blanks, use slashes to delimit the string, for example:

ALL / searchstring /

USER unum The USER command limits the display to only those lines associated with the indicated usernumber. This is very similar to specifying ALL /unum/, except that, with the USER command, lines not associated with the the user number that happen to have the number in them for some other reason are suppressed.

Also, continuation lines for entries associated with the indicated user are likely to be suppressed for the ALL command, but they are not suppressed for USER.

An effect similar to the USER command can be achieved by moving the cursor down to a line associated with the required user and pressing the Enter key. This is different from the USER command in that entries are limited to the login session associated with the entry over which the cursor was positioned.

This facility is dependent on M204.0352 messages appearing in the journal. If these are MSGCTL'ed to NOAUDIT, cursor-position based user selection will behave the same as USER command based selection.

PFKEYS ON | OFF PFKEYS lets you turn on or off the display of the message line and the two lines with PF key descriptions. If PFKEYS OFF is specified, the three extra lines are used to display formatted journal data.
SCALE ON | OFF Turns on or off a two-line character scale display. If the scale is turned off, the extra two lines are used to display formatted journal data.
RIGHT x Scrolls the display x characters to the right.
LEFT x Scrolls the display x characters to the left.
F xxxx or /xxxx Finds the string xxxx in the formatted audit trail data beginning at the current line.
-F or -/ Same as above, but performs the search backward form the current line.
M (with PF7, 8, 10, or 11) Scrolls the display the maximum number of lines up or down, or the maximum number of characters left or right.
L xxx Moves the current line to the requested line number xxx.

.[num]

Go directly to the indicated bookmark. For example, .4 takes you to the fourth bookmark, if present.

[sir]prodShortName [num]

Fastpath navigation of the RKTools menu system. For example, pro 8 takes you to the SirPro group definitions screen.

PF keys
PF1 Accesses full-screen help.
PF2 On/Off toggle for the horizontal scale.
PF3 Quit to SirScan scan criteria screen.
PF4 On/Off toggle for the PF key display.
PF5 Scroll up an interval (only active if an Interval was specified on the scan criteria screen). If bookmarking is on, this key is Prev Bkmk and it brings you to the start of the previous bookmark.
PF6 Scroll down an Interval (only active if an Interval was specified on the scan criteria screen). If bookmarking is on, this key is Next Bkmk and it brings you to the start of the next bookmark.
PF7 Scroll up; the line on which the cursor was placed becomes the bottom line. The cursor is reset to the command-line field, so subsequent scrolling is for full pages.
PF8 Scroll down; the line on which the cursor was placed becomes the top line. The cursor is reset to the command-line field, so subsequent scrolling is for full pages.
PF9 Repeat the last command.
PF10 Scroll left.
PF11 Scroll right.
PF12 Print. Printing can go to a dataset so perhaps a better term would be "Extract".

When entries are displayed with dates, the dates are in YYMMDD format. When entries are displayed with times, the times are displayed in HHMMSS format.

Journal entry types

For journal entry type selection, the following types of entries might be displayed (each type may be included or excluded from the display by switches on the previous screen):

Entry Description
AD General Model 204 status messages.
CI Physical input line from user terminal or IFAM argument.
CP Physical input line from a procedure.
CS A physical line from full screen input.
ER A Model 204 error message.
LI A logical input line from user terminal or Model 204 Host Language Interface argument.
LP A logical input line from a procedure.
LS One input value from a SCREEN, or a menu selection number of a MENU.
MS A Model 204 information message.
OI An input line from the operator's console.
OO An output line to the operator's console.
QT Horizon SQL output (available as of Model 204 Version 7.5).
RK Information about system initialization or to record a call to a Host Language Interface function.
ST Miscellaneous statistics.
US Information audited on a SOUL Audit statement.

Auto-refresh mode

If no time interval was specified on the scan specification screen, SirScan browsing occurs in auto-refresh mode. This means that every time an attempt is made to go beyond the end of the current formatted records, SirScan formats a new interval of records from the last time it formatted records to the current time. Going beyond the end of current formatted records could occur because of an attempt to scroll beyond the current set of records, an attempt to position beyond the current set of records, or a search for a string that is not found in the current set of records. In addition, if any display is about to contain some empty lines, an auto-refresh is done to see if the lines can be filled in.

Auto-refresh mode is a convenient way of monitoring things as they happen. A typical way to use SirScan is to specify a start time of -0, which means start "now" with no time-interval size. You enter the browse screen and then initiate the action you want to monitor. Because auto-refresh automatically populates the screen with newly written journal records, you see what is being logged to the journal without leaving the browse screen.

Ordinarily, auto-refresh mode is fairly efficient. However, if the system SCANTIME parameter is set, and the Read extra SCANTIME seconds field on the scan criteria screen was set to Y, then an extra SCANTIME seconds of journal will be read on every auto-refresh.

This is not to say that you should set the indicated parameter to N when in auto-refresh mode. Quite the contrary. Without that parameter set to Y, the behavior of auto-refresh could be very confusing indeed. Just keep in mind that the use of the SCANTIME data will perhaps add a little extra delay and overhead to auto-refresh processing, especially on very busy systems with heavy journal activity. Auto-refresh mode on such systems will tend to be somewhat sluggish anyway, so the addition of the SCANTIME data scan will probably still not produce dramatic delays, unless SCANTIME is set to an absurdly high value.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SirScan_browsing_of_the_journal&oldid=118315"