Process Macros › SYSCMD Macro

SYSCMD Macro

The SYSCMD macro issues a system command and interprets the results. It lets you specify message rules to detect the required response message.

Parameters: SYSCMD Macro

• Command

  A mandatory field that specifies the system command issued by the SYSCMD macro.

  The command follows the syntax of the SYSCMD command.

• Jobname

  Lets you limit the response messages to those from the specified job.

• 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: A number from 1 through 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: A number from 1 through 999.

  Default: 69

• Message Text

  Specifies the initial part of the required response message.

  Limits: Up to 45 characters.

• Return Code

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

  Limits: A number from 0 through 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: SYSCMD 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

  Contain 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: SYSCMD Macro

In the following example, the SYSCMD macro issues the S DENMIMS1 command and awaits a specified response.

No extended filter has been defined in this example.

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

 .- System Command ------------------------------------------------------------.
 |                                                                             |
 | Command ..... S DENMIMS1                                                    |
 |                                                                             |
 | Jobname .....                                                               |
 |                                                                             |
 | Wait Time ... 5     Wait Time Expiry Return Code ... 0                      |
 '-----------------------------------------------------------------------------'
 .- Response Message Analysis -------------------------------------------------.
 |                                                           S=Extended Filter |
 |           Message Text                                      Return Extended |
 |                                                             Code   Filter?  |
 |   ___   IEF403I DENMIMS1 DENMIMS1                              0      NO    |
 |   ___   IEF450I DENMIMS1 DENMIMS1                              6      NO    |
 |   ___                                                                       |
 |   ___                                                                       |
 |   ___                                                                       |
 |                                                                             |
 '-----------------------------------------------------------------------------'
  F1=Help      F2=Split     F3=Exit
                            F9=Swap