Policy rule conditions

Conditions defined in the rule trigger the requested action when they are met. Different rule types support different conditions. Task rules and system rules share some condition filters such as the Transaction ID and User ID. For task rules, you can also specify thresholds for supported attributes as filters.

For available policy rule types, see Policy system rules and Policy task rules.

The minimum CICS® release that is required for each rule type can vary. The required CICS release for each rule can be found in Policy schema versions or in the policy definition editor.

Task rule conditions

The following two tables include the attribute thresholds and filters you can specify as task rule conditions in the Policy Definition editor.

Specify thresholds for the following attributes as filters. You can define multiple task rules of the same rule type with the same or different threshold values. When multiple task rules with the same threshold are deployed, the rules are processed in the following order: message action rules, event action rules, and then abend action rules.

Table 1. Attribute thresholds supported by task rules
Task rule type Subtype Unit Value

Async requests

RUN TRANSID commands

No unit
Thousands

0 - 4294967295
0 - 4294967

Container storage

Container storage used
Note: This container storage rule tracks both explicitly occurred storage on CHANNEL containers such as PUT CONTAINER (CHANNEL), PUT64 CONTAINER, DELETE CONTAINER (CHANNEL), and FETCH CHILD CHANNEL, and implicitly occurred storage for CHANNEL containers, for example, START TRANSID CHANNEL, RUN TRANSID CHANNEL CHILD and so on.

Bytes
Kilobytes
Megabytes
Gigabytes

0 - 4294967295
0 - 4294967295
0 - 4294967295
0 - 4294967295

Database requests

SQL commands
DLI commands (EXEC DLI or CALLDLI)

No unit
Thousands

0 - 4294967295
0 - 4294967

EXEC CICS requests

All EXEC CICS commands

No unit
Thousands

0 - 4294967295
0 - 4294967

File requests

DELETE commands
READ commands
READNEXT commands
READPREV commands
READ UPDATE commands
REWRITE commands
STARTBR commands
WRITE commands
All file commands

No unit
Thousands

0 - 4294967295
0 - 4294967

These value ranges for requests or thousand requests apply to all subtypes of file request task rules.

IBM® MQ requests

MQ commands

No unit
Thousands

0 - 4294967295
0 - 4294967

Named counter requests

GET COUNTER commands
GET DCOUNTER commands

No unit
Thousands

0 - 4294967295
0 - 4294967

Program requests

LINK commands

Note: As well as LINK commands, INVOKE APPLICATION commands are also included in the count for program request, but are not a separate subtype.

No unit
Thousands

0 - 4294967295
0 - 4294967

Start requests

START commands

No unit
Thousands

0 - 4294967295
0 - 4294967

Storage allocation

24-bit shared storage allocated
24-bit task storage allocated



Bytes
Kilobytes
Megabytes
Gigabytes

24-bit rule items:

0 - 16777215
0 - 16383
0 - 15
0

31-bit shared storage allocated
31-bit task storage allocated



Bytes
Kilobytes
Megabytes
Gigabytes

31-bit rule items:

0 - 2147483647
0 - 2097151
0 - 2047
0 - 1

64-bit shared storage allocated
64-bit task storage allocated



Bytes
Kilobytes
Megabytes
Gigabytes

64-bit rule items:

0 - 4294967295
0 - 4294967295
0 - 4294967295
0 - 4294967295

All storage allocated

Bytes
Kilobytes
Megabytes
Gigabytes

0 - 4294967295
0 - 4294967295
0 - 4294967295
0 - 4294967295

Storage requests

24-bit shared storage requests
24-bit task storage requests

31-bit shared storage requests
31-bit task storage requests

64-bit shared storage requests
64-bit task storage requests

All storage requests

No unit
Thousands

0 - 4294967295
0 - 4294967

These value ranges for requests or thousand requests apply to all subtypes of storage request task rules.

Syncpoint requests

SYNCPOINT commands

No unit
Thousands

0 - 4294967295
0 - 4294967

TD queue requests

READQ TD commands
WRITEQ TD commands
All READQ TD and WRITEQ TD commands

No unit
Thousands

0 - 4294967295
0 - 4294967

These value ranges for requests or thousand requests apply to all subtypes of TD queue request task rules.

Time

CPU time
Elapsed time

Microseconds
Milliseconds
Seconds

0 - 4294967295
0 - 86400000
0 - 86400

A value of 86400 seconds equates to 24 hours.

TS queue bytes

All TS bytes written
Auxiliary TS bytes written
Main TS bytes written
Shared TS bytes written

Note:
  • The WRITEQ subtype is used to set a threshold for the amount of data that is written to all TSQs combined. The other subtypes are used to set a threshold for a specific type of TSQ.
  • Data that is written by both WRITE and REWRITE requests count towards the total, and REWRITE requests are treated as WRITE operations, in that the count is incremented by the total size of the REWRITE, and not the delta between the original WRITE and REWRITE.
  • Data is counted only if the WRITEQ is performed successfully.

Bytes
Kilobytes
Megabytes
Gigabytes

0 - 4294967295
0 - 4194303
0 - 4095
0 - 3

All subtypes of the TS queue byte task rule have the same value ranges.

TS queue requests

All WRITEQ TS commands
READQ TS commands
WRITEQ TS commands to auxiliary
WRITEQ TS commands to main
WRITEQ TS commands to shared
All READQ and WRITEQ TS commands

Note:
  • The All WRITEQ TS commands subtype is used to set a threshold for the total number of WRITE requests to the auxiliary, main, and shared TSQs combined as well as WRITE requests to remote regions. The other WRITEQ subtypes are used to set a threshold for the number of WRITE requests to a specific type of TSQ.
  • The READQ TS commands subtype is used to set a threshold for the total number of READ requests.
  • The All READQ and WRITEQ TS commands subtype is used to set a threshold for the number of READQ requests and WRITEQ requests (to any TSQ location and to remote regions).

No unit
Thousands

0 - 4294967295
0 - 4294967

These value ranges for requests or thousand requests apply to all subtypes of TS queue request task rules.

Note: When you select a unit and specify a value for the threshold in your policy task rule, be aware that the granularity decreases as the size of the unit increases. However, if you cannot specify a high enough value with a smaller unit, you might be able to specify an appropriate value by using a larger unit. For example, if you create a storage request task rule, and want to set a threshold for 64-bit shared storage requests greater than 4294967295 bytes, you cannot use bytes as the unit, but you might be able to set your threshold by using kilobytes and entering an appropriate kilobyte value in the Value field in the policy definition editor.
Important:

You can use CICS monitoring data to determine an appropriate threshold to set for a task rule, but be aware that the number of requests that are counted by CICS monitoring and the requests that are counted by CICS policy might differ. This is because policy counts only EXEC CICS API requests, but monitoring also includes internal requests. Therefore, requests that do not go through the EXEC CICS layer are counted by CICS monitoring, but are not included in the policy count. To use the policy to count WRITEQ TD requests as an example, if a user task issues an EXEC CICS SPI request to change the status of a CICS resource, message DFHAP1900 is written to the transient data queue CADS; this request is counted in CICS monitoring data but is not included in the policy count.

For information about CICS monitoring data that you can use to determine an appropriate threshold to set for a CICS task rule , see CICS monitoring data for determining task rule thresholds.

The following filters are provided to restrict the effect of the rules to specific user tasks:

Table 2. Condition filters supported by task rules
Task rule type Condition Condition value Condition operator

All task rule types

Transaction ID

1-4 characters

Acceptable characters:

A-Z a-z 0-9 $ @ # . / - _ % & ? ! : | " = ¬ , ; < >

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

All task rule types

User ID

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

System rule conditions

The following table lists the condition filters that you can specify in the Policy Definition editor when you define a system rule. You can use them to restrict the rule to certain status changes or user tasks.

Table 3. Condition filters supported by system rules
System rule type Filter Filter value Filter operator

AID threshold

AID threshold

0-65535

  • greater than

Bundle available status
Bundle enable status

Bundle ID

1-64 characters

Acceptable characters:

A-Z a-z 0-9 @ # . / - _

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

Bundle available status
Bundle enable status

Bundle name

1-8 characters

Acceptable characters:

A-Z a-z 0-9 $ @ # . / - _ % & ? ! : | " = ¬ , ; < >

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

Bundle available status

From available status
To available status

AVAILABLE
SOMEAVAIL
UNAVAILABLE

  • does not equal
  • equals

Bundle enable status

From enable status

ANY
DISABLED
DISABLING
ENABLED
ENABLING
INITIAL

  • does not equal
  • equals

Bundle enable status

To enable status

ANY
DISABLED
DISABLING
DISCARDING
ENABLED
ENABLING

  • does not equal
  • equals
Compound condition See Table 4.    
Db2 connection status

From connection status
To connection status

CONNECTED
CONNECTING
DISCONNING
NOTCONNECTED

  • does not equal
  • equals

DBCTL connection status

From connection status

CONNECTED
CONNECTING  2 
DISCONNING  2 
NOTCONNECTED

  • does not equal
  • equals

DBCTL connection status

To connection status

CONNECTED  2 
CONNECTING
DISCONNING
NOTCONNECTED  2 
UNUSABLE  2 

  • does not equal
  • equals

DB2® connection status

From connection status
To connection status

CONNECTING
CONNECTED
DISCONNING
NOTCONNECTED

  • does not equal
  • equals

File enable status
File open status

File name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

File enable status

From enable status
To enable status

DISABLED
DISABLING
ENABLED
UNENABLED
UNENABLING

  • does not equal
  • equals

File enable status

Open status

CLOSED
CLOSEREQUEST
OPEN

  • all
  • does not equal
  • equals

File open status

From open status
To open status

CLOSED
CLOSEREQUEST
OPEN

  • does not equal
  • equals

IBM MQ connection status

From connection status
To connection status

CONNECTING
CONNECTED
DISCONNING  3 
NOTCONNECTED  3 

  • does not equal
  • equals

IPIC connection status

Connection name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

IPIC connection status

From connection status
To connection status

ACQUIRED
FREEING
OBTAINING
RELEASED

  • does not equal
  • equals

Message

Message ID

9 characters

Format: DFHXXnnnn or EYUXXnnnn

Where:
  • X is any uppercase character A-Z.
  • n is any digit 0-9.
  • XX is not EC, EP or MP for a DFH message.
  • all
  • equals
  • starts with

MRO connection status

Connection name

1-4 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

MRO connection status

From connection status
To connection status

ACQUIRED
RELEASED

  • does not equal
  • equals

Message

Message insert

0-255 characters

Acceptable characters:

All characters, including white space.  1 

  • does not equal
  • does not start with
  • equals
  • starts with

Pipeline enable status

Pipeline name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

Pipeline enable status


From enable status

DISABLED
DISABLING
ENABLED
INITIAL  4   5 

  • does not equal
  • equals

Pipeline enable status

To enable status

DISABLED
DISABLING
DISCARDING
ENABLED

  • does not equal
  • equals

Program enable status

Program name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

Program enable status

From enable status
To enable status

DISABLED
ENABLED

  • does not equal
  • equals

User tasks

Percentage of MXT

Valid values for goes higher than:
60, 70, 80, 90, 100
Valid values for goes lower than:
50, 60, 70, 80, 90
  • all
  • goes higher than
  • goes lower than

Tranclass tasks
Tranclass queued tasks

Transaction class

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with
Tranclass queued tasks Percentage of PURGETHRESH - 1
Valid values for GHT:
60, 70, 80, 90, 100
Valid values for GLT:
50, 60, 70, 80, 90
  • all
  • goes higher than
  • goes lower than

Tranclass tasks

Percentage of MAXACTIVE

Valid values for GHT:
60, 70, 80, 90, 100
Valid values for GLT:
50, 60, 70, 80, 90
  • all
  • goes higher than
  • goes lower than

Transaction abend

Abend code

1-4 characters

Acceptable characters:

A-Z a-z 0-9 $ @ # . / - _ % & ? ! : | " = ¬ , ; < >

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

Bundle enable status
Bundle available status
DB2 connection status
File enable status
File open status IBM MQ connection status  3 
Message
MRO connection status
Pipeline enable status  4 
Program status
Transaction abend

Transaction ID

1-4 characters

Acceptable characters:

A-Z a-z 0-9 $ @ # . / - _ % & ? ! : | " = ¬ , ; < >

  • all
  • does not equal
  • does not start with
  • equals
  • starts with

Bundle enable status
Bundle available status
DBCTL connection status  2 
DB2 connection status
File enable status
File open status
IBM MQ connection status
IPIC connection status
Message
MRO connection status
Pipeline enable status  5 
Program status
Transaction abend

User ID

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • all
  • does not equal
  • does not start with
  • equals
  • starts with
Table 4. Condition filters supported by compound condition system rules
Condition type Filter Filter value Filter operator

Bundle available status
Bundle enable status

Bundle ID

1-64 characters

Acceptable characters:

A-Z a-z 0-9 @ # . / - _

  • all
  • equals

Bundle available status
Bundle enable status

Bundle name

1-8 characters

Acceptable characters:

A-Z a-z 0-9 $ @ # . / - _ % & ? ! : | " = ¬ , ; < >

  • equals

Bundle available status

To available status

AVAILABLE
SOMEAVAIL
UNAVAILABLE

  • equals

Bundle enable status

To enable status

ANY
DISABLED
DISABLING
DISCARDING
ENABLED
ENABLING

  • equals

DB2 connection status

To connection status

CONNECTING
CONNECTED
DISCONNING
NOTCONNECTED

  • equals

DBCTL connection status

To connection status

CONNECTED
CONNECTING
DISCONNING
NOTCONNECTED
UNUSABLE

  • equals

File enable status
File open status

File name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • equals

File enable status

To enable status

DISABLED
DISABLING
ENABLED
UNENABLED
UNENABLING

  • equals

File open status

To open status

CLOSED
CLOSEREQUEST
OPEN

  • equals

IBM MQ connection status

To connection status

CONNECTING
CONNECTED
DISCONNING
NOTCONNECTED

  • equals

IPIC connection status

Connection name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • equals

IPIC connection status

To connection status

ACQUIRED
FREEING
OBTAINING
RELEASED

  • equals

MRO connection status

Connection name

1-4 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • equals

MRO connection status

To connection status

ACQUIRED
RELEASED

  • equals

Pipeline enable status

Pipeline name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • equals

Pipeline enable status

To enable status

DISABLED
DISABLING
DISCARDING
ENABLED

  • equals

Program enable status

Program name

1-8 characters

Acceptable characters:

A-Z 0-9 $ @ #

  • equals

Program enable status

To enable status

DISABLED
ENABLED

  • equals
Notes:
  •  1  When the "does not start with" or "starts with" condition operator is specified, at least one character must be specified.
  •  2  A User ID condition cannot be defined for a DBCTL connection status rule that specifies either "From connection status equals CONNECTING or DISCONNING", or "To connection status equals CONNECTED, NOTCONNECTED or UNUSABLE".
  •  3  A Transaction ID condition cannot be defined for an IBM MQ connection status rule that specifies either "From connection status equals DISCONNING" or "To connection status equals NOTCONNECTED".
  •  4  A Transaction ID condition cannot be defined for a Pipeline enable status rule that specifies "From enable status equals INITIAL".
  •  5  A User ID condition cannot be defined for a Pipeline enable status rule that specifies "From enable status equals INITIAL".
  •  6  This condition is not checked at the time the rule becomes enabled.