Option List

The option list enables you to specify the input file to be used by LOGANALYZER, the destination of the LOGANALYZER output, the range of records to be searched, and the types of records to be searched for.

Syntax

<option list>

──┬────────────────────────┬─┬─────────────────────┬───────────────────►
  └─<output device option>─┘ ├─ / ──<integer>──────┤
                             ├─ " ──<logname>── " ─┤
                             └─ ' ──<logname>── ' ─┘
►─┬────────────────────────────────────────────┬───────────────────────►
  ├─<time>─┬────────┬─┬────────────────────────┤
  │        └─<date>─┤ └─ TO ─┬─<time>─┬────────┤
  └─<date>──────────┘        │        └─<date>─┤
                             └─<date>──────────┘
►─┬───────────────────────┬─┬────────┬─────────────────────────────────┤
  └─<loganalyzer options>─┘ └─ STOP ─┘

<output device option>

──┬─ ODT ───────────────────────────┬──────────────────────────────────┤
  ├─ CONSOLE ───────────────────────┤
  ├─ REMOTE ────────────────────────┤
  ├─ DCSTATION ─────────────────────┤
  ├─ PRINTER ───────────────────────┤
  ├─ LINEPRINTER ───────────────────┤
  └─ TEXT ─┬─ " ──<file title>── " ─┤
           └─ ' ──<file title>── ' ─┘

<logname>

──┬────────────┬─┬─<name of log file>──────┬─┬─────────────────────┬───┤
  ├─<usercode>─┤ └─ <name of directory>/= ─┘ └─ ON ──<family name>─┘
  └─ * ────────┘

Explanation

If the option list is empty, the effect is the same as if you had specified LOG ALL. Refer to Selection Options for information about the ALL option.

The following text describes the meaning of each variable:

<output device option>

Controls the output destination of the LOGANALYZER output.

The PRINTER and LINEPRINTER options cause the output to be printed in lines of 132 characters.

The TEXT option causes the output to be written to the file with the specified file title. If the specified file already exists, the run will be aborted and a message will be displayed to indicate that the file already exists. By default, the file has a FILEKIND file attribute value of DATA and 132 character records. If LOGANALYZER is run with the SW1 task attribute set to TRUE, the file is created with FILEKIND value of TEXTDATA and 80 character records, which are sequentially numbered with an 8-digit number at the end of each record. If LOGANALYZER is discontinued before completing its run, the DATA or TEXTDATA output file preserves the output generated up to that point.

When LOGANALYZER is invoked from an ODT, the ODT and CONSOLE options cause output to be displayed on that ODT, assuming that the device has been set up with visible ETX characters. The REMOTE and DCSTATION options also cause output to be displayed on the originating ODT, assuming that the device has been set up with invisible ETX characters. The output is displayed in pages of 23 lines, with 80 characters per line.

When LOGANALYZER is invoked from a remote terminal, the REMOTE, DCSTATION, ODT, and CONSOLE options cause output to be displayed on that terminal. If the terminal is set up as a screen device, the output is consistent with the terminal screen size and width definitions. You can use the CANDE TERM command to alter the defines of the terminal screen size and width. For more information, see the CANDE Operations Reference Manual. The default device option for remote terminals is REMOTE; otherwise PRINTER is assumed.

For remote terminals, the VALUE task attribute can be used to change the default number of lines per page and characters per line. The lower three digits of the VALUE attribute represent the number of characters per line; the fourth and fifth digits represent the number of lines per page. The number of lines per page can be from 12 through 64; the number of characters per line can be from 40 through 256.

The following examples show the use of the VALUE attribute:

  • LOG REMOTE;VALUE=27132 sets the page size to 27 lines, with 132 characters per line.

  • LOG PRINTER;VALUE=80 sets the number of characters per line to 80.

  • LOG ODT;VALUE=17000 sets the page size to 17 lines.

<integer>

Specifies the log file sequence number, from 1 to 65535. The number can be up to 6 digits long (/5 is the same as /000005). It specifies that the log file to be analyzed has the title SUMLOG/<system serial number>/<current date>/<integer> and is located on the same family as the current system log. The corresponding security log file SECURITYLOG/<system serial number>/<current date>/<number> is also used.

For example, if the user is on a system with a serial number of 227 and the current date is August 22, 2006, then including /5 in the option list causes LOGANALYZER to use the files named SUMLOG/227/082206/000005 and SECURITYLOG/227/082206/000005 as its input files.

<logname>

Specifies a valid file title for a log file or a directory of log files. LOGANALYZER assumes all log files to be on the family that was specified for LOG when using the DL (Disk Location) system command unless the ON <family name> part of the <logname> syntax is used. Using the ON <family name> syntax causes the program to look for the log file on the specified family. Family substitution is not invoked unless a directory is specified. Refer to the System Commands Operations Reference Manual for information on the DL command.

If a SUMLOG file is marked to indicate that there is a companion SECURITYLOG file, SDASUPPORT attempts to locate this SECURITYLOG file by replacing all instances of the string “SUMLOG” in the source file title with the string “SECURITYLOG”.

For example, if the SUMLOG is named *SYSTEM/SUMLOG, then SDASUPPORT tries to locate the file *SYSTEM/SECURITYLOG.

When a directory is specified

  • LOGANALYZER performs the requested functions for all SUMLOG files in the directory. If the directory includes a file that is not a SUMLOG file, a message is displayed and LOGANALYZER continues with the next file.

  • If output to a text file, or the creation of a new SUMLOG file is requested, that output is included in one text file or one new SUMLOG file instead of in a series of files.

  • LOGANALYZER invokes family substitution.

Notes:
  • If a file title is specified inside quotation marks, it will be converted to uppercase. If, however, a file title containing quotation marks is surrounded by apostrophes, the string inside the quotation marks will not be converted to uppercase, allowing special characters and lowercase letters to be specified.

  • If a RUN command is used to initiate LOGANALYZER, and the option list is enclosed in quotation marks, then a double set of quotation marks ("") is required to signify a single quotation mark ('') for embedded strings.

  • If a non-resident file is specified as <logname> (or using the / <integer> syntax), archive restoration action is initiated. This does not occur for non-resident files when a directory is specified. This also applies to the corresponding SECURITYLOG file.

<time>

Specifies a four-digit integer denoting time in an HHMM format or a six-digit integer denoting time in an HHMMSS format (H is hours; M is minutes; S is seconds). For example, 1:45 p.m. is represented as 1345 and 3:30:18 p.m. is represented as 153018. Leading zeros are required. For example, 9:15 a.m. must be represented as 0915, and 12:05:12 a.m. as 000512. If no start time is specified, 0000 is used. If no stop time is specified, 2400 is used.

<date>

Specifies the date for the LOGANALYZER report in the form mm/dd/yy or mm/dd/yyyy, where mm, dd, and yy (or yyyy) stand for month, day, and year, respectively. For example, June 1, 1996 is 06/01/96 or 06/01/1996. If only one date is specified, it is used as both the start and stop date for the time range. If no date is specified, the following factors determine the default range:

  • If a time is specified, or if the last entry in the log file has today's date, then today's date is used as both the start and stop date for the time range.

  • Otherwise, the date range includes the full range of dates in the log file.

STOP

Signifies the end of input. All input records after STOP are ignored by LOGANALYZER. The use of STOP is optional; if STOP is not entered, LOGANALYZER inserts a STOP at the end of the input.