Selection Criteria fields

Not every selection criteria field can be used for every event type.

The second column in the following table shows which event types can use a specific selection criteria field. For any event type for which you create a Rule, a selection criteria panel for that event type appears and contains a subset of the criteria listed in the following table.

The following table lists all of the available selection criteria fields for all event types.

That TIME-initiated Rules do not use any of the selection criteria listed that are here. To see the selection criteria for TIME-initiated Rules, refer to Creating TIME-initiated Rules.

Selection Criteria fields and event types

Selection Criteria field

Event type

Description

Acct Info

CICS

CMD

EXT

IMS

MSG

TLM

Enter up to 33 bytes of accounting information for the issuer of the event.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Alarm ID

ALRM

Enter the Alarm ID associated with the Alarm.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Alarm Text

ALRM

Enter the text string that all ALARM messages are searched for

Cell Name

BRC

Select all events that match the cell name.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Cell Type

BRC

Select all events that match the cell type.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

CICS TDQ

CICS

Enter the one- to four-character name of the CICS Transient Data Queue where the event originated.

If the queue is an indirect queue, specify the indirect queue name instead of the name the queue resolves to. The indirect queue name is the queue that MainView AutoOPERATOR compares to the destination queue of the incoming message.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Class

BRC

Select all events that contain the class string.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Client

IMP

Specify a 1- to 8-byte name of the client (IMSplex member) where the IMS Type-2 command originated.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Note

This selection criteria field is not valid for IMSPlex commands that are issued from MainView AutoOPERATOR or MainView for IMS.

Console Name

CMD

MSG

Specify the console name of a specific MVS console associated with the message. This field is 33 characters long.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Context

ALRM

Enter the context associated with the Alarm.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Count

TLM

Specify the maximum number of Time Limit Extensions are allowed to occur for this address space.

Values can be from 0 to 9999. SHARED variables and EVENT variables can be used in this field.

Desc codes

MSG

Enter one or more MVS descriptor codes associated with the message. Separate each descriptor code by a blank. Valid codes are 1-128.

Variables and pattern matching cannot be used in this field.

Event

ALRT

Specify when a Rule should fire when a matching ALERT is detected. Valid values are as follows:

  • ADD (default): The Rule fires when a matching ALERT is added (created).

  • DELETE: The Rule fires when a matching ALERT is deleted manually or by way of automation.

  • DELETEQ: The Rule fires when the matching ALERT queue is deleted manually or by way of automation.

  • ANY: The Rule fires for any matching ADD, DELETE, or DELETEQ event.

    Specifying ANY is useful when you want the same action to occur when an ALERT is added and when it is deleted. When you specify ANY, a single Rule can accomplish automation for both cases.

    When ANY is in effect, only the following fields are used to determine a match:

    • ADD: TEXT ID, TEXT STRING, KEY, or QUEUE

    • DELETE: KEY or QUEUE

    • DELETEQ: QUEUE

  • ESC: The Rule fires when a matching ALERT is being escalated. All ALERT variables will contain 'after' values for the escalation. The following fields can be used to determine a match:

    • TEXT ID

    • TEXT STRING

    • KEY

    • QUEUE

  • ALL: The Rule fires for any matching ADD, DELETE, DELETEQ, or ESC event. See ANY for details about how ALERTs are matched for only ADD, DELETE, and DELETEQ events.

Host Address

BRC

Select all events that match the host IP address.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Host Class

BRC

Select all events that match the host class.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Host Name

BRC

Select all events that match the host name.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Ignore leading plus

MSGDB2

Specify YES to ignore a leading plus sign (+) in the text-ID of write-to-operator messages (WTOs).

Note

Leave this field blank to use the default that is specified for the Rule Set on the Rule Set Default Values panel (refer to Enabling filtering and Rule Set match rate for Rule Sets for more information. Specify NO to ignore the default that is specified in the Rule Set Default Values panel.

Messages that are issued from a non-authorized program can have a plus sign (+) inserted at the beginning of the text-ID of the message. By specifying YES in this field, you can create a single Rule that fires for messages that are issued from both authorized and non-authorized programs because the Rule ignores the leading plus sign.

When you specify YES, you need to take additional steps to ensure that the message is being issued from a trusted job, such as by verifying the user ID, job name, accounting code, or some other information provided by the Rule or EXEC.

This setting does not impact the contents of the IMFTEXT or WORD1 event variables.

For more information about how to set a default for all the MSG, HWTO, or DB2 initiated Rules within a Rule Set to ignore the leading plus sign, refer to the description of the Default ignore leading plus value for MSG rules field in Enabling filtering and Rule Set match rate for Rule Sets.

You can use the STRIP built-in Rules function on the Advanced Variable Dependencies panel to ignore a leading plus signs in the &IMFTEXT variable during variable value comparisons: for example; STRIP(&IMFTEXT,L,'+')

Interval

Time

Specify (in hours, minutes, and seconds) how often the Rule fires. The minimum interval is 5 seconds.

For example, 00:05:00 means the Rule fires at the start time and every 5 minutes thereafter until the Stop Time or the Stop Count is reached.

Jobclass

CICS

CMD

EXT

IMS

MSG

TLM

Specify a one byte identifier for the job class of a batch job issuer. Valid values are 0-9 and A-Z.

SHARED variables and EVENT variables can be used in this field.

Job name

CMD

DB2

EOSEOM

EXT

HWTO

IMP

IMS

MSG

NVC

NVM

TLM

Specify a 1- to 8-byte name of the address space that issued the event. This field is usually used with the Type field which specifies the type of address space that is issuing the event.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Key

ALRT

Specify the key used to uniquely identify an ALERT within a queue. Use this field to create Rules for ALERTs written with specific keys.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

For more information about ALERT keys, refer to the MainView AutoOPERATOR Advanced Automation Guide.

MLWTO Minor

MSG

Specify how a Rule processes the minor lines of a multiline write-to-operator (MLWTO) message.

Valid values are ALL or SINGLE.

Specifying ALL means that the Rule treats the entire MLWTO (the major message plus all the minor message lines) as a single entity.

A Rule with ALL specified does not fire unless the entire MLWTO has been issued. In other words, it does not fire until the MLWTO is considered complete by z/OS or MainView AutoOPERATOR or the text line with a text type of E or DE has been received. For more information about message text type codes, refer to the IBM publication MVS Programming: Assembler Services Reference, Volume 2.

When you specify ALL, BMC Software recommends that you use the variables &LINEx_WORDn on the Variable Dependencies panel to create Rules that fire based on specific content of a MLWTO message. The &LINEx variable resolves for each line of the MLWTO and the WORDn variable resolves to words on the first (major) line.

For example, specify the following values on the Selection Criteria Panel:

Text ID    ===>  IEA995I
MLWTO Minor ===>   ALL

MLWTO Minor

MSG

On the Variable Dependencies panel, specify:

LINE6_WORD1:6:11 EQ MYPROG

The Rule fires for the message IEA995I only if the 6th through 11th characters of the first word on the sixth line equals MYPROG.

Specify SINGLE so that the Rule treats each minor line of the MLWTO as a separate entity.

This value means that each minor line of the MLWTO can cause the Rule to fire. When a single minor line matches the Selection Criteria, the Rule fires immediately.

BMC Software recommends that you use the Variable Dependencies panel with the &LINE2_WORDn variable or &IMFMTEXT variables to filter out unwanted minor lines.

On the Variable Dependencies panel, when you use the variable &LINE2_WORDn, &LINE2 resolves to any line of the MLWTO and the individual &WORDn variables resolve to words on the first (major) line.

For example, specify the following values on the Selection Criteria Panel:

Text ID     ===> IEA995I
MLWTO Minor ===> SINGLE

On the Variable Dependencies panel, specify:

LINE2_WORD1:6:11 EQ MYPROG

The Rule fires for the message IEA995I if the 6th through 11th characters of the first word of any line equals MYPROG

MLSEG Minor

IMS

Specify how a Rule processes the minor segments of a multisegment IMS (MLSEG) message.

Valid values are ALL or SINGLE.

Specify ALL if you want the Rule to treat the entire MLSEG (the major plus all the minor segment lines) as a single entity.

A Rule with ALL specified does not fire unless the entire MLSEG has been received. In other words, it does not fire until IMS has sent the last segment of a message (or last response for a command), or the maximum time to wait between receiving segments (IMSMSTIM) has been reached.

When you specify ALL, BMC Software recommends that you use the variables &LINEx_WORDn on the Variable Dependencies panel to create Rules that fire based on specific content of a MLSEG message. The &LINEx variable resolves for each segment of the MLSEG and the individual &WORDn variables resolve to the words on the first (major) segment. For example, specify the following values on the Selection Criteria Panel:

Text ID ===> DFS2503W

MLSEG Minor ===> ALL

On the Variable Dependencies panel, specify:

LINE3_WORD3:1:8 EQ BE2PCUST

The Rule fires for the IMS message DFS2503W only if the 1st through 8th characters of the third word on the third segment equals BE2PCUST.

MLSEG Minor

IMS

Specify SINGLE if you want the Rule to treat each minor segment of the MLSEG as a separate entity.

SINGLE means that each minor segment of the MLSEG can cause the Rule to fire. When a single segment line matches the Selection Criteria, the Rule fires immediately.

BMC Software recommends that you use the Variable Dependencies panel with the &LINE2_WORDn variables or &IMFTEXT to filter out unwanted minor segments.

On the Variable Dependencies panel, when you use the variable &LINE2_WORDn, &LINE2 resolves to any segment of the MLSEG and the individual &WORDn variables resolve to words on the first (major) segment.

Example: Specify the following values on the Selection Criteria Panel:

Text ID ===> DFS2503W

MLSEG Minor ===> SINGLE

On the Variable Dependencies panel, specify:

LINE2_ WORD3:1:8 EQ BE2PCUST

The Rule fires for message DFS2503W if the 1st through 8th characters of the third word of any segment equals BE2PCUST.

MLTDQ

CICS

Specify whether a CICS Rule should process only the first line of a multiline CICS (MLTDQ) message or the entire message.

Valid values are ALL or blank.

Specify ALL if you want the Rule to treat the entire MLTDQ (the major plus any minor lines) as a single entity.

A Rule with MLTDQ ==> ALL specified does not fire unless the entire MLTDQ is received. In other words, it does not fire until CICS has sent the last line of a message.

When you specify ALL, use the variables &LINEx_WORDn on the Variable Dependencies panel to base the firing of the Rule on specific content of the MLTDQ. &LINEx resolves to the line of the MLTDQ message: &LINE1 contains the contents of the major line of the MLTDQ, and &LINE2 through &LINEx contain the subsequent minor lines. WORDn resolves to a word on &LINEx. For example, assume that you specify the following values on the Selection Criteria panel:

Text ID ===> DFHXS1111

MLTDQ ===> All

On the Variable Dependencies panel, specify:

LINE2_WORD7:4:8 EQ 00000008

The Rule fires for the CICS message DFHXS1111 only if the fourth through eithth characters of the seventh word on the second line equals 00000008.

Name

VAR

Specify the name of a SHARED pool variable so that, when its value changes, it will trigger a Rule to fire.

SHARED variables can be used in this field.

Origin

JRNL

Enter the name of the address space that issued the message for the BBI-SS PAS Journal.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Priority

ALRM

Enter the priority associated with the Alarm.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Queue

ALRM

ALRT

Specify the name of the queue to which the ALERT is targeted. Use this field to create Rules for ALERTs destined for specific queues.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

For more information about ALERT queues, refer to the MainView AutoOPERATOR Advanced Automation Guide.

RACF Group

CICS

CMD

EOS

EXT

IMS

MSG

TLM

Enter the RACF group ID (1- to 8-bytes) for the address space that issued the message. The RACF Group ID is taken from the GROUP keyword of the job card.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

RACF User

CICS

CMD

EOS

EXT

IMS

MSG

TLM

Enter the RACF user ID (1- to 8-bytes) for the address space that issued the message. The RACF user ID is taken from the USERID keyword of the job card.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Randomize Start Time

TIME

Enter an optional value to delay the Start Time. 

Do not enter a value for the Randomize Start Time field when the Time Rule must fire at the appointed time.

The value can be 1 to  4 minutes and must also be at least 1 minute less than the value specified in the Interval field. When you use this selection criteria, a random value of minutes and seconds (rounded down to the nearest 5 seconds) is added to the specified start time. 

Use the Randomize Start Time field when a TIME-initiated Rule is shared among many BBI-SS PASs, and you want it to fire at a slightly different time in each PAS to avoid spikes in CPU consumption. If you do not use this selection criteria, you would need to create a separate TIME-initiated Rule with a different Start Time in each PAS.

The randomized start time for the Rule is determined when the TIME-initiated Rule is enabled. The TIME-initiated Rule behaves as though you specified the Randomized Start Time selection criteria. The modified Start Time remains unchanged until the Rule is enabled again and a new randomized Start Time is computed.

For example:

Start Time = 10:00:00
Interval = 00:06:00
Randomize Start Time = 2

When the TIME-initiated Rule is enabled, the Start Time is modified to one of these random values:

10:00:05, 10:00:10 ...10:00:55, 10:01:00, 10:01.05 ... 10:01:30 .. 10:01.55, 10:02:00

If 10:00:55 is chosen, the Rule starts as if you had coded the Rule with Start Time = 10:00:55

The first and last values (10:00:00 and 10:02:00) are not selected to reduce the potential for running at the same time as other TIME-initiated Rules.  The goal of using the Randomize Start Time selection criteria is to avoid creating a spike in CPU usage by not firing a TIME-initiated Rule at a common time.

BMC recommends that you consider using the Randomize Start Time selection criteria when you have a TIME-initiated Rule that schedules an large EXEC.

Note that randomness generated is imperfect and some Rules might still be scheduled at the same time.

Route codes

MSG

Enter one or more MVS route codes associated with the message. Separate each route code by a blank. Valid codes are 1-128.

Variables and pattern matching cannot be used in this field.

Route list

IMP

Specify a 1- to 30-byte Route list of the IMS Type-2 command.

The ROUTE list is a list of client names separated by commas. The ROUTE list can contain a single asterisk for a client name, which represents all clients.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Scope

ALRM

Enter the scope associated with the Alarm.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Seconds

TLM

Specify the maximum number amount of time in seconds allowed for extensions for this address space.

Values can be from 0 to 9999. SHARED variables and EVENT variables can be used in this field.

Severity

BRC

Select all events that match the severity.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Start Time

Time

Specify (in hours, minutes, and seconds) at what clock time the Rule begins firing.

For example, 10:05:30 means the Rule begins firing at 5 minutes and 30 seconds after 10:00 A.M.

You can enter a start time of ATSTART. This specifies that Rules will begin firing at BBI-SS start-up.

Note

TIME-initiated Rules that use ATSTART are automatically suspended or disabled if the Rule is modified. When you modify TIME-initiated Rules that uses ATSTART, a confirmation panel is displayed that warns you about suspending or disabling the Rule, and allows you to cancel or proceed with the changes. Refer to Example 2: creating a TIME-initiated Rule with ATSTART to see an example of the Confirm Timer Rule Update panel.

Step CC

EOS

Select all messages whose condition code matches.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Step Name

EOS

Select all messages whose step name matches.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Step Name

TLM

Specify the name of the step for this Rule to fire.

The following values are possible:

Batch Jobs: Name of the Step on the EXEC statement. If the JCL invokes a procedure, it will still be the name on the EXEC statement.

TSO: TSO user IID

STC: Name of a Started Task. If started with an identifier, the identifier is used.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Step Number

EOS

Select all messages whose step number matches.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Step Number

TLM

Specify the number of the step where this Rule will fire.

Valid values can be from 1 to 255.

SHARED variables and EVENT variables can be used in this field.

Stop Count

Time

Specify the number of times for the Rule to be fired from the Start Time within a 24-hour interval.

For example, a Stop Count value of 12 means that the Rule will begin firing at the specified Start Time and continue firing (at a rate determined by the Interval field) 12 times.

If you do not specify a Stop Time or a Count value, the default is Stop Count=1.

You can specify a Stop Time or a Stop Count but not both.

Stop Time

Time

Specify (in hours, minutes, and seconds) at what clock time the Rule should stop firing.

If you do not specify a Stop Time or a Count value, the default is Stop Count=1.

You can specify a Stop Time or a Stop Count but not both.

Target Name

BRC

Select all events that match the target name.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Termination Type

EOM

Select termination type for the End-of-Memory event.

NORMAL, ABNORMAL, SHARED variables, EVENT variables can be used in this field.

Text ID

All event types

Enter the 1- to 16-byte Text ID associated with the message. The length of the Text ID is determined by the first blank character in the text. The Text ID for the message is the first word, delimited by a blank, or the first 16 characters if the first word is longer than 16 characters.

To select on more information, use the Text String field to enter message text.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

For event type MSG:

  • If you journal the message, the entire message (including the reply ID) is written to the journal.

  • If you use IMFTEXT the reply ID is stripped from the message.

  • WORD1 is the first word after the reply ID.

  • TEXT STRING does not include the reply ID.

Text String

All event types

Specify message text to be matched in addition to the Text ID. In this field, you must enter the Text ID and additional information from the message text for the Rule to match before it fires. This field supports up to 75 bytes.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

For event type MSG:

  • if you journal the message, the entire message (including the reply ID) is written to the journal

  • if you use IMFTEXT the reply ID is stripped from the message

  • WORD1 is the first word after the reply ID

  • TEXT ID is the first word after the reply ID

  • TEXT STRING does not include the reply ID

Time Limit Type

TLM

Specify with kind of Time Limit expiration for a Rule to fire.

Possible values are CPU, JCPU, SCPU or WAIT.

Note

It might be difficult to discern whether an address space's Step or Job CPU will expire. Specifying CPU will account for both the Job and the Step CPU time.

Tool Name

BRC

Select all events that match the tool name.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Tool Severity

BRC

Select all events that match the tool severity.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Type

ALRM

CMD

EOM

EOS

EXT

IMS

MSG

TLM

Specify a 1- to 3-byte name for the type of address space that issued the event. Valid values are JOB, STC, or TSO. This field provides additional information about the address space that issued the event.

SHARED variables and EVENT variables can be used in this field.

User ID

ALRM

Enter the User ID associated with the Alarm.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

UserId

IMP

Specify a 1- to 8-byte name user ID of application where the IMS Type-2 command originated.

SHARED variables, EVENT variables, and pattern matching can be used in this field.

Variable is

VAR

Specify the action that will fire the Rule; valid values are as follows:

  • Created: The Rule will fire when the variable is created in the SHARED pool.

  • Deleted: The Rule will fire when the variable is deleted from the SHARED pool.

  • Upd: The Rule will fire when the value of the variable is updated in the SHARED pool.



The first and last values (10:00:00 and 10:02:00) are excluded from selection to reduce potential collisions with other Time Rules.  The ultimate goal is to avoid firing the Time Rule at a ‘popular’ time, in order to reduce CPU spikes especially if the Time Rule schedules an intensive EXEC.


Was this page helpful? Yes No Submitting... Thank you

Comments