SET (Set Processing Options)

Set various Z Data Tools processing control options.
Usage notes
Use this function to list the processing options that are currently in effect. You can also use the SET function to change one or more options, or reset options to the installation default. If you use the SET function within a batch job, your changes affect only the current batch job. In any other case, your changes are saved in the user profile and are available for further Z Data Tools sessions.

To change the installation defaults that apply to all users and batch jobs, see the Z Data Tools Customization Guide.

Read syntax diagramSkip visual syntax diagram

        '-RESET-'  '-ASCII=-+-BOTH-+-'  +-CYLHD=ABSOLUTE-+   
                            +-IN---+    '-CYLHD=RELATIVE-'   

   +-USEIOX=NO--+  +-IOX=sysexit-+  |        .-00037-. |   
   '-USEIOX=YES-'  '-IOX=ioxname-'  '-CCSID=-+-num---+-'   

   +-DATAHDR=YES-+  +-DBCSPRT=OFF-------+  +-DUMP=UPDOWN-+   
   '-DATAHDR=NO--'  '-DBCSPRT=-+-3200-+-'  '-DUMP=ACROSS-'   

   '-EOD=delimiter-'  +-HEADERPG=YES-+  +-JCL=RECORD-+   
                      '-HEADERPG=NO--'  '-JCL=COMPAT-'   

   +-LANGUAGE=ENGLISH--+  +-PAD=OFF-----+  +-PRTCLASS=A-----+   
   '-LANGUAGE=language-'  '-PAD=-+-ON-+-'  '-PRTCLASS=class-'   

   +-TRACECLS=A-----+  +-PAGESIZE=60--+  +-PAGESKIP=NO--+   
   '-TRACECLS=class-'  '-PAGESIZE=nnn-'  '-PAGESKIP=YES-'   

   +-PRINTLEN=132-+  +-PRINTOUT=SYSPRINT------+   
   '-PRINTLEN=80--'  '-PRINTOUT=-+-PRINTDSN-+-'   

   '-PRINTDSN=dsn------------'  '-PRTTRANS=OFF-'   

   +-PRTDISP=MOD------+  +-RECLIMIT=(1,*)-+   
   '-PRTDISP=---OLD---'  '-RECLIMIT=(n,m)-'   

   +-TAPELBL=SL-------+  +-ABENDCC=system----+   
   '-TAPELBL=-+-AL--+-'  '-ABENDCC=-+-NONE-+-'   
              '-AL4-'               '-num--'     

   '-TEMPHLQ=temp_hlq-'  '-TSOPREFIX=tsoprefix-'   

Returns all options to the installation default values (described in the Z Data Tools Customization Guide).
Specifies requirements for translation of tape data between ASCII and EBCDIC. The default setting for this parameter is determined at installation, by the value of the ASCII parameter in the HFM0POPT macro. Typically, this is set to BOTH.
Translates tape input from ASCII format to EBCDIC format, and translates tape output from EBCDIC format to ASCII format.
Translates tape input from ASCII format to EBCDIC format.
Does not translate data.
Translates tape output from EBCDIC format to ASCII format.

This processing option applies to all tape input and output functions except: Initialize Tape, Tape Browse, Tape Label Display, and Tape Update. For Tape Label Display, ASCII translation is automatically performed when needed. For Initialize Tape and Tape Browse, you can specify ASCII input or output when invoking the function. For the other (non-tape) functions, ASCII translation is not supported by HFM.

Defines the way you specify the location of a disk data set in disk functions.
Z Data Tools interprets cylinder-head and track-number values as actual physical addresses.
Z Data Tools interprets cylinder-head and track-number values as relative to the start of the data set.
Specifies whether to invoke a user I/O exit.
  1. If your site customization for Z Data Tools does not allow user I/O exits, you cannot use this option to override that setting.
  2. The user I/O exit values set with the SET function have no effect unless a subsequent function requests I/O exit processing using its own options; for example, USEIOXIN for the DSC (Data Set Copy) input user I/O exit.
Also, see Setting your System Processing Options (option 0.2).
Do not invoke a user I/O exit.
Invoke a user I/O exit. This option is only effective if your site customization for Z Data Tools allows user I/O exits on a site-wide basis.
Specifies the name of the user I/O exit. This option only takes effect if your site customization for Z Data Tools allows user I/O exits on a site-wide basis, and one of these is true:
  • A prior SET function set USEIOX to YES.
  • The current SET function is setting USEIOX to YES.
There are no restrictions on the programming language that you can use to write an exit, however, the exit must be provided to Z Data Tools in the STEPLIB/ISPLLIB concatenation or their extensions (LINKLIST, LPA, and so on).
Default. If you specify USEIOX=YES and do not supply a user I/O exit name, Z Data Tools uses the name of the exit provided by either a prior SET function in the current job step, or the installation customization options. If you specify USEIOX=YES and no installation default has been provided, you must specify IOX=ioxname.
Note: If you have selected batch processing in an online panel, the generated JCL statements use the default name provided in your Set System Processing Options panel.
The name of a PDS(E) member of a data set that has been provided to Z Data Tools in the STEPLIB concatenation.
Specifies the CCSID to be used as the default CCSID when Z Data Tools is run in batch. The CCSID specified should be a valid CCSID and a CCSID which is recognised by the Z/OS system which runs the batch job.
When data is printed in CHAR print format, specifies whether record number and length are included in character-format print output.

The DATAHDR setting affects only DSP and FCH processing.

Record header information is not included in character-format output. Specify DATAHDR=NO to left-justify the data in the print output, without header information.
Record header information is included in character-format output.
This option is no longer used. The syntax is kept for compatibility only.
Specifies the format of hexadecimal print output (for example, when you use Tape Print with Print format set to HEX). For an example of each format, see Selecting a display format.
The hexadecimal digits are displayed as 2 groups of 4 full words resulting in 32 hexadecimal digits followed by the EBCDIC character display to the right of the hexadecimal display.
The two digits making up the hexadecimal representation of each EBCDIC character are displayed vertically directly under that character.
End-of-data delimiter for tape input.
A 1- to 8-character delimiter. For character data, enclose the string in quotation marks if it contains blanks, commas, or lowercase letters. For hexadecimal data, enter an X followed by the string enclosed in quotation marks (for example, X'04').

For some tape functions, you specify the number of files to process in an NFILES keyword. If you specify NFILES=EOD, then files are processed until the first record that begins with the EOD delimiter. However, there is no default EOD delimiter for tape input. So, if you want to specify NFILES=EOD, then you must first use the SET function to specify an EOD delimiter; otherwise, Z Data Tools issues an error.

Specifies whether a header page (a title page with Z Data Tools on it) is included in print output. If the PRINTOUT option is set to TERMINAL, then the header page is not included in print output, even if HEADERPG is set to YES.
A header page is not included in print output.
Note: For the HEADERPG=NO setting to be effective for the duration of the entire batch processing, you must specify it as the first Z Data Tools control statement. The HEADERPG=NO setting also suppresses the output of the message "HFM0062I current SET function values" as long as it is active.
A header page is included in print output.
Defines the method by which JCL data is processed when running FCH or DSC with JCL=YES.
Z Data Tools processes each physical JCL record as is, unless it contains a parameter field enclosed in apostrophes. If this parameter continues across multiple records, the records are flowed together to join the parameter before processing.
Z Data Tools reformats the physical JCL records into a single logical JCL statement for processing and then builds a new set of physical JCL records.
Specifies the language of Z Data Tools message text and panel text. The possible values depend on which translated message text you installed.

For instructions on installing translated messages and panels, and the keyword values that you can specify for the LANGUAGE processing option, see the Z Data Tools Customization Guide.

Specifies whether records are padded or truncated while being copied.
Records are not padded with blanks or a specified character, except where required by the output record format. If the output records are fixed format, they are padded with nulls ('00'x), as required to match the output record length. Variable and undefined format outputs are not padded.

Output records are always truncated if they exceed the maximum record length (for fixed or variable) or maximum block length (for undefined formats). However, trailing blanks that fit within the maximum length are not stripped from the record.

Records are modified, depending on the output record format. For fixed-format output, input records that do not fit are truncated or padded with blanks. For variable or undefined output, trailing blanks are stripped from the input record. (For reasonable results, do not try to deblock and pad in one run.)
The value used for padding records. This can be a single character or a hexadecimal value. For example, you can enter an X followed by two hexadecimal characters enclosed in quotation marks (X'00'). In addition, for variable or undefined output, a trailing series of the specified character is stripped from the input record. Essentially, this option has the same effect as PAD=ON except that the specified character c is used for padding or truncation instead of blanks.
Specifies the class of the JES spool queue to be used when the PRINT command is issued while browsing the temporary print data set.
Specifies the class of the JES spool queue to be used when the PRINT command is issued when browsing the temporary trace data set.
Specifies the number of lines printed on each page of print output. You can specify a value from 1 to 999. The default is 60.
Specifies whether print output from each function begins on a new page.
Print output from each function does not begin on a new page.
Print output from each function begins on a new page.
Specifies the line length of print output.
The line length of print output is 80 characters, suitable for a terminal.
The line length of print output is 132 characters, suitable for a printer.
Note: PRINTLEN is not applicable when:
  • The data is printed in TABL format, or
  • You specify the wide format for the compare output listing
In either of the above cases, when data is printed the line length is determined from the number and size of fields printed. If this length is greater than the record length specified for the data set, the print line is truncated. The maximum print line length is 32760.
If PRINTOUT=PRINTDSN (see below) is specified, then Z Data Tools sends print output to this temporary data set. The default is userid.HFM.LIST, unless changed in your Z Data Tools installation.

To browse this data set, enter PB on any Z Data Tools Command line. Then, to forward the contents of the data set to PRTCLASS class, enter PRINT. For details, see Printing from Z Data Tools.

Specifies where print output is sent, except for batch execution.
Send print output to the current SYSPRINT allocation.
Send print output to the TSO terminal.
Output is accumulated in the print data set specified in the Data set name field (PRINTDSN). This data set can browsed using the PB command or sent for printing to the JES spool queue with class specified in the Output class field using the PRINT command while browsing.
Send output to a REXX stem variable. Each line corresponds to a variable named FILEM.nnn. FILEM.0 contains the line count.

When you use the PRINT primary command in Print Browse (option 3.9), or if you specify batch execution in a Z Data Tools panel, then print output is always sent to a JES class.

Specifies how Z Data Tools translates non-printable characters.
No translation performed. Use PRTTRANS=OFF to support special print chains. This might make printing faster.
Non-printable characters translated to blanks using a translate table.

For instructions on altering the print translate table, see the Z Data Tools Customization Guide.

Specifies the disposition of a print data set.
The print data set is cleared before each print operation, and print output is written from the beginning of the data set.
Default setting. Print output is appended to the existing print data set.
When data is printed in CHAR or LHEX print format, limits print output for each record (or OAM object).
Print output is limited to the data from columns (bytes) n through m. An asterisk (*) specified for m indicates the end of the record.
The entire record (or block) is printed.
Specifies the type of labels that are created:
ANSI Version 3 labels are created. (“Version 3” refers to ANSI X3.27–1978, ISO 1001–1979, and FIPS 79 standards.)
ANSI Version 4 labels are created. (“Version 4” refers to ANSI X3.27–1987 level 4 and ISO 1001–1986(E) standards.)
EBCDIC labels are created.

For detailed information about ANSI tape labels, see z/OS DFSMS: Using Magnetic Tapes.

This parameter only affects Initialize Tape (option 4.12).

Specifies how Z Data Tools processing resulting in non-zero return code (including customized return code) is completed in batch.
Default. This option can be set as part of the customization options for your site. If you do not specify the ABENDCC parameter in the SET function, the installation setting is used. The installation setting defaults to NONE, but if it is set as an integer, that integer becomes the default setting for Z Data Tools batch processing.
The job step is finished with a non-zero return code.
Must be specified as an integer, from 1 to 32767 (0 is treated as NONE).

Use this parameter to transform an original or customized non-zero return code to an abend. If the return code is greater than or equal to num, Z Data Tools abends with U999, Reason Code=888 (hex: 378). Abnormal termination of a Z Data Tools step prevents the execution of successors (steps and/or jobs). You can specify the num value appropriately to suit the customized return codes issued by Z Data Tools functions.

Note: In addition, specification of any non-zero integer prevents Z Data Tools from intercepting abnormal terminations (system abends).
TEMPHLQ specifies an installation-specific high-level qualifier for the temporary data sets created during a Z Data Tools session. You can specify any valid qualifier, including multilevel if required, up to a total length of 24 characters. If you specify &USER. for any part of the qualifier, this is replaced with the user's userid. A multilevel qualifier with symbols follows the same rules as in the specification of a data set name with symbolic parameters in JCL procedures. Thus, a single period used after a symbol combines the symbol with the text following it (See Example 1 below); a period separating parts of a multilevel qualifier must be doubled (see Example 2 below).
Example 1
If the userid is XXXX, then specifying &USER.1.TEMP results in a high-level-qualifier of XXX1.TEMP
Example 2
If the userid is ZZZZ then specifying HFM.&USER..ABCD results in a high-level-qualifier of HFM.ZZZZ.ABCD
  1. The TEMPHLQ parameter can be up to 24 characters long. However, temporary data sets can have different lengths, and the system part of the data set name may be longer than 20 characters. In this case, minor levels of TEMPHLQ are ignored, to the extent that the final data set name is less than or equal to 44 characters.
  2. Concatenation of &USER.string could result in a part of the high-level qualifier being longer than 8 characters. In this case, the string is shortened to the extent that the final part of the qualifier is 8 characters long.
This parameter allows you to specify the user's TSO prefix. The parameter is provided because functions run in batch mode cannot obtain the user's TSO prefix but sometimes they require it. Batch functions may require it when the &PREFIX symbol is specified in the TEMPHLQ or AUDITHLQ parameters in the Z Data Tools Installation Options modules or the TEMPHLQ parameter of a SET function. The &PREFIX symbol represents the user's TSO prefix, so when Z Data Tools functions encounter this symbol in any of the above parameters, they are supposed to substitute the user's TSO prefix. Batch functions can only do this, if this parameter is specified.