Previous Topic: When to UseNext Topic: Example JCL


How to Use

Multi-User mode is required to execute this command. To edit a stream of DBUTLTY functions, execute DBUTLTY using the following command format preceding the input stream to be edited:

►►─ SET ─ OPTION1= ─┬─ DATALN=nnnnn ──────┬───────────────────────────────────►◄
                    ├─ DATANO=nnnn ───────┤
                    ├─ DXXNO=nnnn ────────┤
                    ├─ ECHO_FUNCTIONS ────┤
                    ├─ EOJ_REPORT ────────┤
                    ├─ EOJ_REPORT_X ──────┤
                    ├─ IXXLN=nnnn ────────┤
                    ├─ IXXNO=nnnn ────────┤
                    ├─ ON-ERROR-CONTINUE ─┤
                    ├─ ON-ERROR-STOP ─────┤
                    ├─ ON-ERROR-ABEND ────┤
                    ├─ ON-ERROR-RCn ──────┤
                    ├─ ON-ERROR-REMOVE ───┤
                    ├─ SNAPALL ───────────┤
                    ├─ SNAPERR ───────────┤
                    └─ WTO--x ────────────┘

Command

SET

Invokes the SET function for the input stream following this command.

Required Keywords

OPTION1=

Specifies the options for the SET function, as follows:

DATALN=nnnnn

The length of a data buffer as set in the DBMSTLST Master List assembly can be overridden, for any reason, by providing this option. The nnnnn must be replaced by a number in the range 4096-32767. This option is always accepted but only used if it occurs before the first function that opens the CXX.

DATANO=nnnn

The number of data buffers as set in the DBMSTLST Master List assembly can be overridden, for any reason, by providing this option. The nnnn must be replaced by a number in the range 3-9999. Some DBUTLTY functions need minimal data buffers and some would benefit with a large number. This option is always accepted but only used if it occurs before the first function that opens the CXX.

DXXNO=nnnn

The number of DXX buffers as set in the DBMSTLST Master List assembly can be overridden, for any reason, by providing this option. The nnnn must be replaced by a number in the range 3-9999. Some DBUTLTY functions need minimal data buffers and some would benefit with a large number. This option is always accepted but only used if it occurs before the first function that opens the CXX.

ECHO_FUNCTIONS

This option causes the first statement of each function to be sent to the console to aid in debugging or tracking the function being executed. This option can be helpful in seeing which other console messages occurred by which functions. Take note that that there is no equal sign and no additional values after the function name. It can be easier to see the function being executed in the log instead of going to the bottom of the print. The action once requested cannot be turned off. Following is an example:

DB10098I - STARTING FUNCTION - REPORT AREA=CXX,DBID=0997,TYPE=B
EOJ_REPORT

This option is intended to only be used in consultation with Technical Support. EOJ_REPORT requests that reports be generated at end of the current DBUTLTY execution, similar to the way in which MUF EOJ reports are generated. Information that is specific to the MUF is excluded from the report requested by EOJ_REPORT, for example Memory Resident Data Facility (MRDF) Summary Information reports and Task Control Block (TCB) Use Summary Information reports are excluded.

The EOJ_REPORT option includes a PXX-like summary report.

DBUTLTY functions use fast path processing and all statistical information normally present in the MUF may seem inconsistent. For example, a BACKUP shows I/O to the index and data areas but no requests to the tables. This result is not an error in DBUTLTY.

EOJ_REPORT_X

This option is intended to only be used in consultation with Technical Support. While the EOJ_REPORT option requests that reports be generated at end of the current DBUTLTY execution, the EOJ_REPORT_X option requests a report be generated at the end of the execution of most DBUTLTY functions. For information about what is produced, see the previously provided description of EOJ_REPORT.

IXXLN=nnnn

The length of an index buffer as set in the DBMSTLST Master List assembly can be overridden, for any reason, by providing this option. The nnnn must be replaced by a number in the range 4096-8182. This option is always accepted but only used if it occurs before the open of the CXX.

IXXNO=nnnn

The number of IXX buffers as set in the DBMSTLST Master List assembly can be overridden, for any reason, by providing this option. The nnnn must be replaced by a number in the range 3-9999. Some DBUTLTY functions need minimal data buffers and some would benefit with a large number. This option is always accepted but only used if it occurs before the first function that opens the CXX.

ON-ERROR-STOP

If an error condition exists, future functions (excluding SET and EDIT) are syntax edited but are not executed. This is the default at the start of each step.

Use of this function sets this action for future functions.

ON-ERROR-CONTINUE

If an error condition exists, future functions are edited and processed as though an error condition did not exist.

Note: Various system failures can occur that the operating system considers fatal and that prevent continued operation.

The error condition is not reset based upon the successful completion of this or a future function.

ON-ERROR-ABEND

Dictates action taken after the last function is complete for step. This is the default at the start of each step.

If an error condition then exists, the step is terminated with an z/OS ABEND 4 or a z/VSE CANCEL.

ON-ERROR-RCn

Dictates action taken after the last function is complete for step. The number in the parameter (n) can be 0, 4, 8, or 12.

If an error condition then exists, the step is terminated with the return code of the number provided.

ON-ERROR-REMOVE

Removes an error condition.

From this point following functions are edited and executed and, unless errors occur in them, the step terminate with a return code 0.

SNAPALL

This diagnostic tool is available, when requested by Technical Support, to help find a problem. Its purpose is to snap the address space after a utility function that is processed by a subordinate program completes, with or without an error condition. The reason this might be necessary is, for example, if a utility function's process, deeming itself successful and without error, completes but has not actually completed successfully after all.

SNAPERR

This diagnostic tool is available, when requested by Technical Support, to help find a problem. Its purpose is to snap the address space after a utility function, processed by a subordinate program, completes with an error condition. The reason this might be necessary is that some error conditions are expected to be obvious and no dump is taken, because a dump should not be necessary in order to correct the condition. If the error turns out not to be obvious, however, the SNAPERR can be used to help Technical Support with the additional information needed to find a solution.

Valid Entries:

OPTION1=ON-ERROR-STOP
OPTION1=ON-ERROR-CONTINUE
OPTION1=ON-ERROR-ABEND
OPTION1=ON-ERROR-RCn
OPTION1=ON-ERROR-REMOVE
OPTION1=SNAPALL
OPTION1=SNAPERR

Default Value:

OPTION1=ON-ERROR-STOP
OPTION1=ON-ERROR-ABEND

WTO--x

Specify WTO--x as shown, with WTO followed by two dashes, followed by a set of characters (replacing the x variable) that you want written to the console with a WTO in the DBUTLTY address space.

The set of characters specified by x have a length restriction imposed by the number of characters that fit on one input statement. Given that the SET OPTION1=WTO-- is 17 characters long and starts in column 1 (with the S in SET), and given that the last column in which the last possible character could occur is column 71, subtracting 17 from 71 gives a maximum of 54 user-characters (for the x), if blanks are not required (see following explanations) and 52 user-characters if blanks are required (due to two places being required for two single quote characters, as described in the next paragraphs).

If the set of characters that comprise the x have blank spaces embedded in them, they must be surrounded by single quotes. Otherwise, OPTION1= terminates on the first blank. If single quotes are used, however, those single quote marks are not printed. For example, BEGIN DATABASE 22 would be specified as follows:

SET OPTION1='WTO--BEGIN DATABASE 22'

An example of the result of the SET function just shown would be that it generates the message:

DB10099I - USER WTO--BEGIN DATABASE 22.

If the set of characters that comprises the x do not have blank spaces embedded in them, the single quotes are not needed. For example, BEGIN_DATABASE_22 would be specified as follows:

SET OPTION1=WTO--BEGIN_DATABASE_22

Note: If using a value for a keyword that starts with a quote, the end is the next quote. It is not possible to provide a value that has both a blank and a quote.

Possible uses for the WTO option include the following:

  • The WTO option can be used to provide information about the progress of a DBUTLTY execution that has multiple functions. For example, if you were executing a series of functions for database 200, followed by a series of functions for database 300, before the database 200 executions begin, you could do the following:

    SET OPTION1=WTO--STARTING-DATABASE-2__

  • Then, before the database 300 executions start, do the following:

    SET OPTION1=WTO--STARTING-DATABASE-3__

  • You can use the WTO option to provide for a set of functions a meaningful descriptive name that would be useful to those who are watching the execution or reviewing the output. For example, you could specify the following:

    SET OPTION1='WTO--STARTING FUNCTIONS FOR PAYROLL DATABASE'

  • If operator information is needed for some reason, the WTO option can be used to provide it.

Note: These actions could be done using a comment statement that would be imbedded in the print output but would not be in the console messages.