General Information for DO SHOUT

The message is sent to the required destination when the accompanying ON statement criteria are satisfied.

DO SHOUT statements can also be defined in SMART Table Entities, where they are used in a manner similar to jobs.

The TO Subparameter

Specify TO=USERID-userid to write the message to the IOA Log file under the user ID specified in the parameter.

Specify TO=OPER[–n] to send the message to the operator console (route code n). If the n value is omitted, the message is sent to all consoles to which route codes 1 or 11 are assigned. For more detailed information regarding route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102. Optionally, the message can also be sent to the Control-M/Enterprise Manager user, as described in "Shouting to Control-M/Enterprise Manager" below.

Specify TO=OPER2[–n] to send a highlighted, unrollable message to the operator console (route code n). If the n value is omitted, the message is sent to all consoles to which route codes 1 or 11 are assigned. For more detailed information regarding route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102. Optionally, the message can also be sent to the Control-M/Enterprise Manager user, as described in "Shouting to Control-M/Enterprise Manager" below.

Specify TO=TSO-id or T-id to send the message to a groupid or logonid. The Shout facility first searches the IOA Dynamic Destination table for the specified ID. If the table contains an entry (groupid) that matches the value, the content of the entry is used as the target for the shouted message. The entire TO field is used. Therefore, when directing the message to a remote user, do not append Nn or Mm. Instead, do this in the IOA Dynamic Destination Table itself. For more information, see the description of the Dynamic Destination Table in the INCONTROL for z/OS Administrator Guide.

If no matching ID is found in the Dynamic Destination table, the Shout facility assumes the specified ID is a logonid. It then creates a TSO message that it hands over to MVS. MVS then sends the message to that logonid. (If the logonid does not exist, MVS cannot send the message, but no error message is generated.) When a second value is used, the message is sent to the TSO logonid in the specified computer or node (machine ID). To determine the machine ID under JES2, specify JES command $D MEMBER.

Specify TO=U-M: email_dest to send the message by e-mail to the recipient identified by the variable (email_dest). For more information about mail destinations, see the INCONTROL for z/OS Administrator Guide. The IOAPARM member includes DFLTSFFX, the mail address suffix, such as MAIL.DOMAIN.COM, the SMTP STC name, and the HOSTNAME. If installation parameter ATTSYSOT=Y, the job's SYSOUT will be attached to the e-mail message.

Specify TO=U-S:snmp_dest to send the SNMP trap (message) to the recipient identified by snmp_dest. For more information about mail destinations, see the INCONTROL for z/OS Administrator Guide.

Shouting to Control-M/Enterprise Manager

For Control-M to be able to shout to Control-M/Enterprise Manager, the following conditions must be satisfied at the site:

1. Control-M/Enterprise Manager must be installed and the ECS parameter must be set to Y in member IOAPARM in the IOA PARM library.
2. File MG2 (the Control-M/Enterprise Manager Shout File) must be defined.
3. The following parameters in the IOAPARM member in the IOA PARM library must be defined according to how messages are targeted to Control-M/Enterprise Manager:
   • If TO=OPER and TO=OPER2 messages must be sent to Control-M/Enterprise Manager, the OPER2ECS parameter must be set to Y (Yes). Otherwise, it must be set to N (No).

     When OPER2ECS is set to Y:

     • If these messages must also be sent to the MVS operator console, the OPER2CON parameter must also be set to Y (Yes).
     • If these messages must not also be sent to the MVS operator console, the OPER2CON parameter must also be set to N (No).
   • If TO=U-ECS messages must be sent to Control-M/Enterprise Manager, the UECS2ECS parameter must be set to Y (Yes); otherwise, it must be set to N (No). Regardless of the value of this parameter, these messages are also sent to Control-M and the IOA Log.

Once the above conditions are satisfied, messages can be shouted to Control-M/Enterprise Manager by specifying a destination of TO=OPER or TO=OPER2 (without a route code qualifier), or TO=U-ECS.

Such messages are then placed by Control-M in the M2G file. Once the shouted message is in the M2G file, the Control-M Application Server reads the file and sends the message to the Control-M/Enterprise Manager user.

The URGENCY Subparameter

The URGENCY value indicates the urgency level of the message.

In addition, if the destination is USERID-userid (or U-userid), the user can control, according to urgency, which messages are displayed when the IOA Log file is accessed. Urgent and very urgent messages are highlighted on the screen. For more details, see IOA Log Facility.