Required Parameters for DGADCHLA
DGADCHLA requires IBM® Connect:Direct® to pass three parameters on every invocation from an application program.
The parameters, in order, are the following:
|CMDLEN (first parameter)||Points to a variable-length character string (up to 4096 bytes) that contains
the string length in the first halfword and the command text in the remainder of the string. Just as
in DGADBATC, the first command string must be a SIGNON and the last command must be a SIGNOFF. The
following figure shows the command string format.
|UICB@ (second parameter)||Points to a fullword pointer of zeroes, which is filled in with the UICB address by DGADCHLA when DGADCHLA receives the SIGNON command from the application program. Information in the UICB can now be interrogated by the application program, if necessary. The UICB@ field is cleared and filled again with zeroes when DGADCHLA receives the SIGNOFF command.|
|OUTSPECS (third parameter)||Points to a 7-character string containing the output format specifications. The
output is written to the file name defined by DMPRINT. Each specification is one character
All output generated as a result of these specifications is routed to a DDNAME of DMPRINT. No output is created if the DDNAME is not present.
The following table describes the OUTSPECS output format specifications:
|1||Y||Displays the command string that executed.|
|N||Does not display the command string that executed.|
|2||Y||Displays the API return code and message ID.|
|N||Does not display the API return code and message ID.|
|3||S||Displays the short message text when a return code of zero comes from the API.|
|L||Displays long message text when a return code of zero is received from the API.|
|N||Does not display message text when a return code of zero is received from the API.|
|4||S||Displays the short message text when a nonzero return code comes from the API.|
|L||Displays long message text when a nonzero return code comes from the API.|
|N||Does not display message text when a return code greater than zero comes from the API.|
|5||Y||Displays the data generated in the temporary file.|
|N||Does not display the data generated in the temporary file.|
|6||Y||Displays the string that identifies UICB fields which the Extract feature returns information about.|
|N||Does not display the string that identifies UICB fields which the Extract feature returns information about.|
|7||Y||Displays a dump of the area that received output from the Extract feature.|
|N||Does not display a dump of the area that received output from the Extract feature.|
|8||Y||If parameter 9 is specified as N, this parameters prints output from a SELECT STATS command to DMPRINT when a MAXDELAY Process fails with a return code other than 52.|
|9||Y||Enables monitoring of the MAXDELAY Restart Process. Produces informational messages about monitoring and about the submitted and monitored Process number. For more information about MAXDELAY restart, see Using the MAXDELAY keyword parameter to synchronize submitted Processes|
|N||Allows the MAXDELAY Process to execute without restart. The DGADBATC step is suspended until the Process completes execution.|
|APIINIT||Optional parameter used on first invocation to anchor DCB storage for print/trace output. All other parameters are ignored.|
Applies to MAXDELAY Restart only.
|Y||If parameter 9 is specified as Y, the MAXDELAY progress is processed on a
status report to the DMPRINT DD using the Select Process command.
Note: Using this parameter may result in a large amount of data for DMPRINT DD.
|N||Suppresses the progress report.|
Applies to MAXDELAY and MAXDELAY Restart.
|Y||Forces the DGADBATC step to terminate on the first return code of 8 or greater.|
|N||Allows the DGADBATC step to continue to process the commands in SYSIN even after a non-zero return code.|
The following example shows the most common specifications for this parameter.
OUTSPECS DC C'YYSLYNNNNNN'
Positions 6 and 7 are not used by DGADCHLA unless the extract feature of DGADCHLA is used, as explained in the next section.