Previous Topic

Next Topic

Book Contents

Book Index

DO SHOUT: Action Parameter

Sends a user notification message to a particular destination.

Figure 162 DO SHOUT Parameter Format

Optional. Type SHOUT (or its abbreviation SH) in the DO field and press Enter. The following subparameters are displayed:

Table 160 DO SHOUT Subparameters

Subparameter

Description

TO

 

Destination of the message (1 through 16 characters). Mandatory. Valid values:

  • U-userid or USERID-userid–Writes the message to the IOA Log file under the specified user ID. userid must be 1 through 8 characters. For more detailed information regarding route and descriptor codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.
  • OPER[–n]–Sends a rollable message to the operator console. n is an optional 2-digit route code. For more detailed information regarding route and descriptor codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.
  • OPER2[–n]–Sends an unrollable, highlighted message to the operator console. n is an optional 2-digit route code. For more detailed information regarding route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.
  • U-M – sends a message to an email destination. In order to send an email, sample exit IOAX034M should be implemented. The destination must start with "U-M:".

    Refer to the description of sample exits IOAX034M and IOAMAIL in the INCONTROL for z/OS Administrator Guide.

  • TSO - loginid [;Nn | ;Mm | ;NnMm | ;Lname] – Sends the message to the specified ID (logonid). ID is mandatory (1 through 7 characters).

An optional second value, indicating the computer and/or node (such as Nn) of the TSO logonid, can be specified, as follows:

Under JES2:
Valid values are Nn, Mm or NnMm, where:

m is the machine ID (the computer in JES2, not the 4-character SMF ID). For more information, see Step 6.3 of ICE, as described in the IOA installation chapter of the INCONTROL for z/OS Installation Guide.

n is the 1 to 2 character JES/NJE node ID.

Under JES3:
The only valid value is Lname, where Lname is the logical JES name of the machine (that is, the name as used in JES3 command *T, not the SMF system ID).

For more information, see Step 6.3 of ICE, as described in the IOA installation chapter of the INCONTROL for z/OS Installation Guide.

Note: A shout to a TSO user performs a TSO SEND command that may require authorization at the receiving node.

URGENCY

Determines the priority level of the message. Valid values:

  • R — Regular. Default.
  • U — Urgent.
  • V — Very urgent.

MESSAGE

Message text. Maximum length: 62 characters.

AutoEdit variables (both system and user-defined) are supported and automatically resolved (replaced) when the SHOUT message is issued. For AutoEdit usage information, see the KeyStroke Language (KSL) User Guide.

AT

 

The operation is performed if the specified event occurs. The shortest unique abbreviation can be specified.

  • Check in Volumes (CH) – An external volumes is checked in either automatically, or manually by screen TC.
  • Mount (M) – The media is mounted by the operation.

Supported only if Y (Yes) or M (Mount) was specified for Control-M/Tape installation parameter DYNWTO.

  • Open (O)–The data set is open.
  • Close (CL)–The data set is closed.
  • Abend Close (A)–The data set is closed due to an abend.
  • Keep (K)–The media is dismounted.

Supported only if Y (Yes) or K (Keep) was specified for Control-M/Tape installation parameter DYNWTO

Notes: Open, Close or Abend Close apply only for data set creation events.

Keep and Mount can be activated (through ON statements) only upon attributes that are available at keep and mount time. For example, you cannot request DO CONDITION AT KEEP based on the program name, since this information is not available from the Keep message.

Parent Topic

Rule Parameters