Using the HWIREXX interface

For basic REXX execs, BCPii API calls can be run easily from the System REXX programming environment using the supplied HWIREXX helper program, without the need to code an assembler program with an AXREXX macro invocation. IBM provides sample invocation JCL for HWIREXX in SAMPLIB member HWIXMRJL.

The HWIREXX interface provides some of the most common AXREXX macro keywords as input parameters. The following keywords are supported:

Table 1. HWIREXX keywords
HWIREXX keyword	Required/Optional	Default value	AXREXX macro parameter equivalent
NAME=`xxx`; where `xxx` is a 1-8 character exec name to be executed.	Required	N/A	NAME
DSN=`xxx.xxx.xxx`; where `xxx.xxx.xxx` is a 1-44 character PDS data set name where the REXX exec output is directed. Note: The data set may be pre-allocated prior to execution of the exec. If the data set is not pre-allocated, the data set is allocated by System REXX. In either case, the output from the REXX exec is contained in a member name within the data set that matches the specified HWIREXX NAME.	Optional	NO_ REXXOUTDSN	REXXOUTDSN
TSO=<Y/N>; where 'Y' means to run in the TSO host command environment, and 'N' means to run in the standard MVS host environment.	Optional	N	TSO
SYNC=<Y/N>; where 'Y' means the request is synchronous, and 'N' means the request is asynchronous.	Optional	Y	SYNC
TIMELIM=<Y/N>; where 'Y' means that a time limit is applied, and 'N' means that no time limit is applied.	Optional	Y	TIMELIMIT
TIME=`xxx`; where `xxx` is a number value between 1 and 21474536 that represents the number of seconds to allow the exec to run.	Optional	System default value	TIMEINT

See the JCL example HWIXMRJL shipped in SAMPLIB for more information on the invocation of the HWIREXX helper program.

If additional AXREXX macro parameters are required (other than the AXREXX macro parameters listed above) to properly establish the System REXX environment, an explicit invocation of the AXREXX macro is required. See Using the AXREXX macro for detailed information.