Process Macros › SUBJOB Macro

SUBJOB Macro

The SUBJOB macro submits a JCL batch job.

Parameters: SUBJOB Macro

• Dataset Name

  Specifies a mandatory field that specifies the data set member that contains the job steps.

  This field can contain a sequential data set.

• Wait Time

  Specifies the maximum time, in seconds, that the region waits for a response message. The time is reset each time a response is received. The macro waits until a message that matches a rule in the Message Text fields is received or until the time expires without receiving any more responses.

  Limits: 1 to 9999.

  Default: 30

• Wait Time Expiry Return Code

  Specifies the value of the macro return code if the expected message does not arrive before the expiry of the time specified in the Wait Time field.

  Limits: 1 to 999.

  Default: 69

• Message Text

  Specifies the initial part of the required response message. The text can contain up to 45 characters.

• Return Code

  Specifies the value set by the macro when it receives the response message.

  Limits: 0 to 999.

• Extended Filter?

  Indicates whether an extended filter has been defined. This field is empty until you complete the Message Text and Return Code fields. If you want to define an extended filter, enter S to access the Extended Message Filtering panel.

  After this panel is completed, the Extended Filter field is updated automatically.

Returned Variables: SUBJOB Macro

• &$RMMCMSGTEXT

  Contains the full text of the message that satisfies the message rules.

• &$RMMCWORDn

  Contains the words in the message, where n indicates the position of the word in the message.

• &ZRMMSGn

  Contains any messages received before the required response message, where n is a number indicating the order in which those messages are received.

• &$RMMCWTORID

  Contains the ID of the last encountered WTOR message if the macro encounters any WTOR messages before it encounters an expected message.

For example, if the response to a command consists of three messages A, B, and C, and message B satisfies the message rules, then:

• &ZRMMSG1 contains message A
• &$RMMCMSGTEXT contains message B
• The macro ends on receipt of message B and does not see message C

Example: SUBJOB Macro

In the following example, the name of the data set member that contains the job steps is USER.JCL (JPTAPE).

 PROD ---- Automation Services : SUBJOB Macro Parameter Definition -------------
 Command ===>                                                    Function=BROWSE

 .- JCL Details ---------------------------------------------------------------.
 |                                                                             |
 | Dataset Name .... USER.JCL (JPTAPE)_____________________________________    |
 |                                                                             |
 | Wait Time ... 0     Wait Time Expiry Return Code ... 69                     |
 '-----------------------------------------------------------------------------'
 .- Response Message Analysis -------------------------------------------------.
 |                                                           S=Extended Filter |
 |           Message Text                                      Return Extended |
 |                                                             Code   Filter?  |
 |   ___                                                                       |
 |   ___                                                                       |
 |   ___                                                                       |
 |   ___                                                                       |
 |   ___                                                                       |
 |                                                                             |
 '-----------------------------------------------------------------------------'

  F1=Help      F2=Split     F3=Exit
                            F9=Swap