WHEN

Situation in which to send the message. Valid values are:

• OK–The message is sent if the mission ends OK.
• NOTOK–The message is sent if the mission ends NOTOK.
• LATE time–The message is sent if the mission does not finish executing by the specified time, where time is in hhmm format.
• EXECTIME limit – The message is sent if the job’s elapsed runtime is outside a specified limit. The limit can be expressed as a runtime limit, or as a deviation from the job’s average runtime.
  Valid formats for limit are (where n is a 3-digit nonzero value):
  >n    – Job’s elapsed runtime is greater than n minutes.
             n cannot exceed 999.
  <n   – Job’s elapsed runtime is less than n minutes. n
            cannot exceed 999.
  +n    – Job’s elapsed runtime exceeds the job’s average
             execution time by at least n minutes. n cannot
             exceed 999.
  –n    – Job’s elapsed runtime is at least n minutes less than
             the job’s average execution time. n cannot exceed
             999.
  +n% – Job’s elapsed runtime exceeds the job’s average
              execution time by at least n%. n cannot exceed 900.
  –n% – Job’s elapsed runtime is at least n% less than the
               job’s average execution time. n cannot exceed 99.

TO

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

• 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.
• OPER[–n]–Sends a rollable message to the operator console. n is an optional 2-digit route code. If a route code is not specified, the default routes are Master Console and Programmer Information (1 and 11). For more detailed information regarding route 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. If a route code is not specified, the default routes are Master Console and Programmer Information (1 and 11). For more detailed information regarding route codes, refer to the IBM publication Routing and Descriptor Codes, GC38-1102.
• 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 Mm) 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 system ID). For more information, see
      "Specify IOA CPUs" under "Customization Process" in
      the Installing IOA 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 "Specify IOA CPUs" under "Customization Process" in the Installing IOA chapter of the INCONTROL for z/OS Installation Guide.

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

URG

Determines the priority level of the message. Valid values:

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

MSG

Message text. Maximum length: 70 characters.

AutoEdit variables (both system and user-defined) are supported and automatically resolved (replaced) at the time the SHOUT message is issued. For AutoEdit usage information see Shout Facility Variables.