Output a message (WRITE_MSG)

Specify the WRITE_MSG keyword to output a message upon execution of the actions for a rule definition.

Syntax

Read syntax diagramSkip visual syntax diagramWRITE_MSG=(msgtext,env)

WRITE_MSG=(msgtext,env...)

Where:

msgtext
is the message to write to the destination that is specified in the MSG_DESTINATION function. If blanks are included in the message, surround the message text with double quotation marks. The maximum length of the message, including quotation marks, is 120 characters.
env
(Optional.) Specifies the environments in which to display the message. You can specify 0 - 7 environment keywords. The following options are valid:
ACS
The point in SMS processing directly following the assignment of one or more of the SMS constructs of Data Class, Storage Class, Management Class, or Storage Group.
ALL
(Default.) All points where Advanced Allocation Management intercepts processing.
ALLOCATE
The point in processing where a new data set is allocated (including VSAM and non-VSAM, SMS, and non-SMS data sets).
CATCHECK
The point in allocation processing where the determination of the prior existence of a data set is made. For SMS data sets, this point is just before the allocation of a data set. For non-SMS data sets, this point can be just before the allocation of a data set (or at unallocation processing time during catalog disposition processing).
EXTEND
The point in processing where a new extent is added to a data set, either on the current volume or on a new volume (including volume addition).
STOW
The point in PDS processing when a new member is being added to a data set and the directory is being updated.
UNALLOCATE
The point in processing where a data set is unallocated.
Note:
  • The message text can contain the following symbolic variables, which are replaced with the appropriate text when the message is generated. The total length of the message, after the symbolic variables are expanded, cannot exceed 120 characters. Text that exceeds the maximum length is truncated.
    &JB
    Jobname.
    &ST
    Stepname.
    &PS
    Procedure stepname.
    &DS
    Data set name.
    &DD
    DDNAME.
    &EV
    Environment. This variable displays the same values for Environment as described for env.
    &LN
    The rule definition line number that is associated with the rule definition that contains the WRITE_MSG keyword for which the selection criteria matched.
    &SS
    The Advanced Allocation Management subsystem identification.

    When the symbolic variables are replaced with actual values, trailing blanks are removed. If a symbolic variable does not have an associated value (such as Procedure stepname), a single asterisk is displayed.

    Specifying two ampersands in a row displays a single ampersand character (&) in the output message.

  • The specification of the first eight characters can use the same rules that are used for other Advanced Allocation Management messages. If the first three characters are GLO and the next four characters are numeric characters, the eighth character can be used to define the circumstances under which the message is displayed:
    • If the eighth character is an E, the message is always displayed.
    • If the eighth character is an I, the message is displayed only if the MSG_LEVEL function is set to ALL.
    • If the eighth character is set to S, the message is always displayed and the S is replaced with an I.

    If the first three characters are not GLO and the next four characters are not numeric, the message is always displayed.

  • To continue the message text to another line, surround the text with double quotation marks. Continue the text to (and including) column 72. On the next line, continue the message text at column one.

    For example: 

    12345678901234567890123456789012345678901234567890123456789012345678901234567890
--------------------------------------------------------------------------------
 
INCLUDE JOBNAME=JJHTEST1
      WRITE_MSG="THIS VERY LONG SAMPLE MESSAGE TEXT IS GOING TO BE CONTINUED ON 
THE NEXT LINE"

Default

ALL

Environments

ACS, ALLOCATE, CATCHECK, EXTEND, STOW, and UNALLOCATE.

Example

In the following example, the message: Do not allocate TEST data sets in VGRP=PROD is generated:

WRITE_MSG=("Do not allocate TEST data sets in VGRP=PROD")