Previous Topic: OLP System Task SyntaxNext Topic: Example: OLP System Task


OLP System Task Parameters

OLP

Starts an OLP session. Current log records are shown on the full OLP screen.

olp-session-option

Sets the specified option for the session. You can override any session options during the OLP session. The following table summarizes OLP session options. Each is described in detail following the table.

Type of option

OLP session option

Control key simulation *

  • PAn—Simulates the indicated PA key (forterminals that do not have PA keys)
  • PFn—Simulates the specified PF key (for terminals that do not have PF keys)

Exit from OLP *

BYE—Terminates the OLP session

Log record retrieval limit

RLIMIT—Specifies the maximum number of log records OLP is allowed to read from the log without selecting one for display

Next page to be displayed

  • DOWN/UP—Scrolls the display in the specified direction
  • FIND—Displays the first occurrence of the specified string
  • ROLL—Specifies the number of columns to skip when scrollingleft or right

Printer usage

  • PRINT/ NOPRINT—Specifies whether lines are queued to aprinter when displayed
  • PLIMIT—Specifies the maximum number of lines queued for printing at one time

Range of time for log records

  • FROM/TO—Specifies the beginning and/or end times for logrecords to be displayed
  • ETIM/STIM—Specifies the form in which each log record's time is displayed; ETIM (extended display) or STIM (short display)

Screen layout

  • COL1—Specifies the message column to be displayed in thescreen's first column (when scrolling left or right)
  • FSCR/NOFSCR—Specifies whether the session is to be conducted in full screen mode (FSCR) or line mode (NOFSCR)
  • SCROLL/WRAP—Specifies whether long log records are displayed on a single line (SCROLL) or allowed to wrap around to a second line (WRAP)
  • SIZE—Specifies the number of message lines displayed at one time in full-screen mode

Types of messages displayed

  • DUMPS/ NODUMPS—Includes or inhibits display of snap dumps
  • MESSAGES/ NOMESSAGES—Includes or inhibits display of systemmessages
  • LTERMS/ NOLTES—Displays or inhibits display of logical terminal IDs for log records
  • TRACE/ NOTRACE—Includes or inhibits display of user trace information

Note: * These session options apply when you are already using OLP.

BYE/END/LOGoff/SIGnoff

Terminates the OLP session. You return to the location from where you invoked OLP. All session options that you established during the terminated OLP session are cleared.

This applies only when you are already using OLP.

BYE, END, LOGoff, and SIGnoff are synonyms and can be used interchangeably.

COl1

Specifies the message column to be displayed in the screen's first column.

column-number

Range: 1 – 132

Default: 1

The current column value is displayed in the OLP screen's COL field. For example, the following partial display shows you what you would see if you specified a column of 10:

   FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
 17:47:50 2003-08-26 18:17:50 2003-08-26 010 OFF 0000 (WT/TR/DU/  ) 040
Down/Up

Scrolls the display up or down.

skip-amount

The number of lines to scroll the display.

Range: 0 – 32,767

Default: the number of message lines on the screen.

The value you specify is displayed in the OLP screen's SKIP field. For example, the following partial display shows what you would see if you specified a skip value of 50:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
17:47:50 2003-08-26 18:17:50 2003-08-26 010 OFF 0050 (WT/TR/DU/  ) 040

If skip-amount is greater than 9999, the SKIP field on the OLP screen displays only the 4 right-most digits of the skip amount. For example, if you specify 12345, you would see:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
17:47:50 2003-08-26 18:17:50 2003-08-26 010 OFF 2345 (WT/TR/DU/  ) 040
DUmps

Includes snap dumps in the OLP display.

DUMPS is the default.

When you request DUMPS, OLP displays DU in the LOG TYPES field, as shown below on the following partial screen:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
17:47:50 2003-08-26 18:17:50 2003-08-26 001 OFF 0000 (WT/TR/DU/  ) 040
NODUMPS

Does not include snap dumps in the OLP display.

ETim

Specifies an extended time format for each log record. The extended format is:

hh:mm:ss:tttt
STIm

Specifies a short time format for each log record. The short format is:

hh:mm

STIm is the default.

Find

Searches through the log for a specified search string.

When OLP finds a match, it displays the log starting at the matching log record.

search-string

The string to search for.

FORward/FWD

Searches forward from your current location in the log. FORWARD is the default.

You cannot search through log records issued after the current TO time (see FROM/TO below).

You can press PF6 to search forward for another match.

BACkward/BWD

Search backward from your current location in the log.

You cannot search through log records issued before the current FROM time (see FROM/TO below).

You can press PF5 to search backward for another match.

FRom/TO

Specifies the log messages to be displayed according to the time when the messages were issued.

OLP displays the current FROM/TO times and dates. The following partial screen shows what you would see if you were searching for log records issued between 11:00 and 11:56 p.m. on 1/13/10:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
23:00:00 2007-01-13 23:56:00 2010-01-13 001 OFF 0000 (WT/TR/DU/  ) 040
begin-time

Specifies the time of the first log message to be displayed.

You can specify begin-time using any one of these formats (where hh specifies hours based on a 24-hour clock, mm minutes, and ss seconds):

  • hh:mm:ss—For example, 13:04:07
  • hhmm—For example, 1304
  • hh:mm—For example, 4:23
  • hh—For example, 12

The following defaults are defined for begin-time:

  • 00:00:00 is the default time if you specify FROM without a time.
  • 30 minutes before the session began is the default time if you do not specify FROM at all.
ON begin-date

Specifies the date when the log message was issued. The default is the current date.

Use this format for begin-date:

MM-DD-YY or MMDDYY
end-time

Specifies the time of the last log message to be displayed.

You can specify end-time using any one of these formats (where hh specifies hours based on a 24-hour clock, mm minutes, and ss seconds):

  • hh:mm:ss—For example, 13:04:07
  • hhmmss—For example, 130407
  • hhmm—For example, 1304
  • hh:mm—For example, 4:23
  • hh—For example, 12

The following defaults are defined for end-time:

  • 24:00:00 is the default time if you specify TO without a time.
  • The time at which the session began is the default time if you do not specify TO at all.
ON end-date

Specifies the date when the last log message was issued. The default is the current date.

Use this format for end-date:

MM-DD-YY or MMDDYY
LOCAL

Specifies that Start and Stop times entered after this point are interpreted as local times. This is the default when starting an OLP session.

UTC

Specifies that Start and Stop times entered after this point are interpreted as UTC times.

FScr

Specifies full screen mode. FSCR is the default for 3270-type terminals. FSCR applies when you are starting an OLP session.

NOFScr

Specifies line mode. NOFSCR is the default for TTY-type terminals. NOFSCR applies when you are starting an OLP session.

LTErms

Displays logical terminal IDs for some or all current log records.

By default, logical terminal IDs for all current logs are displayed.

*

Limits the display of logical terminal IDs to those associated with your current logical terminal.

'lterm-id'

The identifier of a logical terminal. Only log records associated with the specified logical terminal are displayed.

Lterm-id must be the ID of a logical terminal defined at DC/UCF system generation time.

This ID must be enclosed in single quotation marks.

NOLTes

Inhibits displays of logical terminal IDs for log records, canceling any previous LTERMS specification.

NOLTES is the default.

MESsages/MSGs

Displays system messages. This is the default.

When you specify MESSAGES, OLP displays WT (WRITE TO LOG) in the LOG TYPES field, as shown on the following partial screen:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
23:00:00 2010-01-13 23:56:00 2010-01-13 001 OFF 0000 (WT/TR/DU/  ) 040
NOMESsages/NOMSGs

Does not display system messages.

PAn

Simulates 3270-type PA (program attention) keys at terminals that don't have these keys. N can be either 1 (for PA1) or 2 (for PA2). PAn applies only when you are already using OLP.

PFn

Simulates 3270-type PF (programmer function) keys at terminals that don't have these keys. N specifies an integer value in the range 1 through 12. PFn applies only when you are already using OLP.

For a list of valid control keys, see "Usage".

cursor-position

Specifies a line number identifying the cursor location required for the operation associated with the PF key.

PLimit

Specifies the maximum number of lines OLP is allowed to queue for printing at one time. Print queueing is enabled by the PRINT option described below.

When this limit is exceeded, OLP displays the XSPRT error-status message in the screen's STATUS field.

line-count

Range: 1 – 32,767

Default: 1000

PRint

Specifies that lines are automatically queued to a printer when displayed. When messages are queued to a printer, OLP displays ON in the screen's PRT field, as shown on the following partial screen:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
17:47:50 2003-08-26 18:17:50 2003-08-26 001 OFF 0000 (WT/TR/DU/  ) 040
NOPRint

Specifies that lines are not queued to a printer.

This is the default.

RLimit

Specifies the maximum number of lines OLP is allowed to read from the log without selecting one for display. When this limit is exceeded, OLP displays the XSREC error-status message in the screen's STATUS field.

record-count

Range: 1 – 32,767

Default: 10,000

Note: 0 (zero) disables the Rlimit checking so that OLP continues to read from the log until the display is filled, or until the end of the log is reached.

ROll

Specifies the number of columns to skip when scrolling left or right. The current roll value is displayed in the OLP screen's ROLL field.

roll-amount

Range: 0 – 131

Default: 40

SCRoll

Displays long log record on one line. This is the default.

To scroll:

WRap

Wraps long log records around to a second line. Pressing PF11 and PF10 does not change the online PLOG display.

SIze

In full screen mode, specifies the full message area of the screen.

page-size

Specifies the number of lines in the screen's message area. Page-size is an integer in the range from 2 through the number of lines in the screen's message area.

The message area begins after the top three lines on the screen. OLP reserves these three lines of the screen to communicate with you. Thus, if your screen can display a total of 24 lines, page-size can be an integer in the range from 2 through 21.

TRace

Requests display of user trace information. TRACE is the default.

When you have requested display of user trace information, OLP displays TR in the LOG TYPES field, as shown on the following partial screen:

  FROM       ON        TO       ON      COL PRT SKIP   LOG TYPES  ROLL STATUS
17:47:50 2003-08-26 18:17:50 2003-08-26 001 OFF 0000 (WT/TR/DU/  ) 040
NOTRace

Suppresses display of user trace information.

More Information