Report Command Reference

LIST command

This section provides an overview of the Auxiliary command LIST.

Usage

Use the LIST command to define a named list of values for a OMEGAMON® XE for DB2® PE identifier, and to use the list name in INCLUDE or EXCLUDE instead of entering each list item.

Usage notes

The LIST command is available in all report sets.
A list can contain values or lists of values for a particular identifier. Items in a list are treated independently, as if they were entered individually in INCLUDE or EXCLUDE.
You can assign a name to the list and specify this name by using the INCLUDE or EXCLUDE subcommand option. In this way, you do not need to enter each list item individually.
Each LIST command defines one list.
You can use as many LIST commands as you want.
All values itemized in a list must be for the same OMEGAMON XE for DB2 PE identifier.
You can use more than one LIST command for the same OMEGAMON XE for DB2 PE identifier.
The combination of list name and OMEGAMON XE for DB2 PE identifier must be unique in the job step.

Rules applying to the use of LIST with INCLUDE and EXCLUDE

List definitions are searched in the order that they were specified for INCLUDE or EXCLUDE.
All list names that are referenced in INCLUDE or EXCLUDE must be defined by a LIST command in the same job step. Those list names that are not defined by a LIST command are ignored during INCLUDE and EXCLUDE processing.

Syntax

>>-LIST--------------------------------------------------------->
 
                                      .-,--------------------------.
                                      V                            |
>--(--PE_identifier--(--list name--(----+-value------------------+-+--)--)--)-><
                                        +-L(list name)-----------+
                                        +-G(set name)------------+
                                        '-R(from_value,to_value)-'

Subcommand options

The syntax diagram shows the options that are available with this subcommand. See OMEGAMON XE for DB2 PE subcommand options for comprehensive descriptions of these options. The following list gives additional or specific descriptions of selected options, where appropriate.

PE_identifier

The OMEGAMON XE for DB2 PE identifier that the list contains. Any identifier can be used with the LIST command except FIELD.

list name

The name of the list. The combination of list name and OMEGAMON XE for DB2 PE identifier must be unique in the job step. List names can consist of up to eight alphanumeric characters (A -- Z, _, #, $, @, 0 -- 9) with no embedded spaces. List names must begin with a character in the range A to Z.

set name

The name of the set. It must be unique within the job step. Set names can consist of up to eight alphanumeric characters (A -- Z, _, #, $, @, 0 -- 9) with no embedded spaces. Set names must begin with a character in the range A to Z.

value

A value for the specified OMEGAMON XE for DB2 PE identifier.

Identifier values must consist of the following characters: A -- Z, _, #, $, @, >, <, or 0 -- 9. If the value you want to include contains a character that is not in this list, use an asterisk in its place.

Except for the INSTANCE identifier, a value can be specified in generic form. Place an asterisk (*) in the value to indicate that any value is valid. For example:

* processes any value.
ABCD* processes any value starting with ABCD.
*BCDE processes any value in the first character position where the second, third, fourth, and fifth character positions contain BCDE.
**CDE processes any value in the first and second character positions where the third, fourth, and fifth character positions contain CDE.
A*CDE processes any value in the second character position where the first character position contains A, and the third, fourth, and fifth character positions contain CDE.

L

Denotes that the following value is a list name. You cannot use the generic form for list names. For example, L(ABC*E) cannot be used.

The L(list name) option cannot specify the list name for this LIST command.

G

Denotes that the following value is a set name. You cannot use the generic form for set names. For example, G(ABC*E) cannot be used.

R

Denotes a range of values beginning with from_value and ending with to_value. The from_value must be less than to_value. The generic form can be used only in the last character position in range values. For example, R(AUTH1*,AUTH2*) is acceptable, but R(AUTH*1,AUTH*2) is not.

Example using the LIST command

This example requests the following:

The name of the list is AUTHLST5.
The primary authorization IDs (PRIMAUTH) associated with this list definition are:
- USER01 through USER05
- USER11.

//SYSIN DD *
LIST
		   (PRIMAUTH(AUTHLST5(R(USER01,USER05),USER11)))
ACCOUNTING
   TRACE
      INCLUDE (PRIMAUTH(L(AUTHLST5)))
EXEC