AOFRYCMD Description

Purpose

AOFRYCMD is a REXX procedure that issues commands to a SA z/OS agent and receives the results of those commands.

Note: AOFRYCMD is identical to EVJRYCMD. For an easy migration EVJRYCMD still exists in the library SINGREXX while AOFRYCMD resides in SINGTREX. The use of AOFRYCMD is recommended.

Syntax

Parameters

wsid

This parameter is optional.

This parameter specifies the name of the TWS workstation that submitted this batch job. This information is used by the command to disable the workstation in the event that communications between the batch job and the SA z/OS Agent cannot be established.

If this parameter is specified, any NetView PPI communications problem will cause the command to issue a TWS WSSTAT command to place the workstation offline.

NOWKSTS

This parameter is optional. It is also deprecated. It is preferable to omit the workstation ID.

This parameter modifies the behavior of the command. In the event of a failure in communications to the SA z/OS Agent, this parameter prevents the command from disabling the TWS workstation that is defined with the wsid parameter.

SERVER

This parameter is optional.

The default for this parameter is EVJCMDRV. This parameter specifies the name of the PPI receiver in the SA z/OS Agent NetView that commands will be sent to. Specifying SERVER=* causes the command receiver to pass the command to one of the associated work tasks to enable parallel processing of commands. The command receiver EVJCMDRV is deprecated but still exists for compatability reasons.

For details on defining EVJCMDRV, refer also to the *IBMCOMP Add-on policy.

Note: When using the general purpose command receiver by coding SERVER=*, the SINGTREX library must be added to the SYSPROC concatenation chain.

TIMEOUT

This parameter is optional.

The default for this parameter is 60 seconds.

This parameter specifies the time in seconds that the batch job will wait for a command to execute in the SA z/OS Agent NetView. This timeout is applied separately to each command. If the timeout is set to NONE, no timeout will be applied to the batch job.

Note: It is recommended that the INGREQ/INGMOVE/INGGROUP timeout (as defined with the FDBK parameter) should be less than the TIMEOUT= parameter for the job.

This is because the INGREQ/INGMOVE/INGGROUP command's FDBK parameter can be used to specify a WAIT period that will result in the command waiting until the desired status change is complete. For example, if the TIMEOUT parameter is defaulted to 60 seconds, the INGREQ FDBK parameter should be coded as, say, FDBK=(WAIT, :55).

HIGHRC

This parameter is optional.

The default for this parameter is 0 (zero).

This parameter specifies the highest acceptable Return Code for the job. Any return codes from commands that are less than or equal to this value will reset the JCL Step return code to zero. Any command return code that is greater than this value will be passed as the JCL Step return code.

Note: The JCL Step return code will be the highest return code of all the command return codes.

MAXRC

This parameter is optional.

The default for this parameter is 999.

This parameter specifies the maximum acceptable return codes from commands issued by the batch job. If a command return code is higher than the value specified, the batch job is aborted and any remaining commands will not be executed.

The return code that is reported to the JCL is determined by the HIGHRC parameter.

SYSIN

This parameter is optional.

The default for this parameter is SYSIN.

This parameter sets the DDNAME of the input file that contains the command to be executed.

REDIRECT

This parameter is optional.

The default for this parameter is >.

This parameter defines the redirection character. Enclose it in quotes or double-quotes if the string contains special characters, such as the equal sign. It must not be the same as any of the characters that occur in the command.

ASIS

This parameter is optional.

The default for this parameter is NO.

This parameter enables the submission of a required command in mixed case, to be executed as presented, when the parameter value is YES.

Usage

When the SA z/OS Agent is started, it will automatically issue a WSSTAT command to mark the workstation online. The specifications of which workstations to mark online at agent restart are contained in the WORKSTATION message/user data policy for the tracker or controller. Multiple workstations may be defined. Workstations that are assigned to trackers should have their WORKSTATION policy defined to the same trackers that they are assigned to.

Each command is submitted in turn and the results of the command are retrieved. These results are then written to either SYSTSPRT or to the output redirection DDNAME.

Whether or not the command completed successfully is indicated by message ING330I for satisfactory completion or message ING332I when the command failed. Message ING332I shows the return code of the command completion. These messages are written to SYSPRINT (//SYSTSPRT DDName).

Note: The DW0369I message that might have been requested when using the NetView PIPE command with the MOE option or automatically injected by SA when the command completed successfully is no longer passed along.