XSUTSYIN (SYSIN processing) automation control point
Variable name | Contents | Possible values | Notes |
|---|---|---|---|
jobname | Name of the current job | Not applicable | |
stepname | Name of the current step | Not applicable | |
plan | Db2 plan used to connect to Db2 | Not applicable | |
rc | Return code for this automation control point | SeeReturn codes | |
restart_parm | Value of the third parameter on the EXEC statement |
| |
ssid | Db2 subsystem ID | Not applicable | |
statement | Text of the current SYSIN statement. This variable is user-definable. | Not applicable | All leading blanks are removed; therefore, you can use the REXX substr function to extract portions of the statement text. You can change this variable. However, changes to this variable are processed only if the rc variable is set to 8. |
uid | Utility ID | Not applicable |
Return codes
The XSUTSYIN automation control point returns the following return codes:
Return code | Description |
|---|---|
0 | Accept the current statement as it is. |
4 | Skip the current statement. |
8 | Execute the statements returned from the automation control point. (See the definition of the statement variable for this automation control point.) |
Any other value | Skip the current statement. |
Restrictions
Do not use the _dsnutil function (which invokes the IBM DSNUTILB module) anywhere in this automation control point as doing so might yield unpredictable results. For more information about this function, see _dsnutil-function.
Usage considerations
You can use the XSUTSYIN automation control point to generate processing statements by converting input statements read from SYSIN. For example, you might use the SYSIN statement AARDVARK to generate a sequence of statements such as REORG, RUNSTATS, and MODIFY, or a set of statements for a user-defined group of objects. AARDVARK might be defined on a Db2 table as a group name whose objects are table spaces to be reorganized.
However, the SYSIN read routine in NGTUTIL will not recognize AARDVARK as a valid input statement, but will treat it as a keyword of the previous input statement. If AARDVARK is the first command in the SYSIN stream, the read routine will pass the statement to the XSUTSYIN automation control point.
To resolve this issue, you can use the USERCMD SYSIN command anywhere in the SYSIN. The syntax processor will read all of the statement that begins with USERCMD and pass it to XSUTSYIN. If the XSUTSYIN automation control point doesn't exist for the run, the processor ignores the USERCMD statement.