TEMPLATE block syntax and description

Use the TEMPLATE control statement to allocate data sets without using JCL DD statements when an UNLOAD command is processed.

You can use the TEMPLATE control statement when you process a LISTDEF or LISTDEFTBV list, but the statement can also be used with standard UNLOAD commands. In its simplest form, the TEMPLATE statement defines the data set naming convention. You can also write TEMPLATE statements so that they contain allocation parameters that define data set size, location, and attributes.

The TEMPLATE statement uses the z/OS® DYNALLOC macro (SVC 99) to perform data set allocation. Therefore, the facility is constrained by the limitations of this macro and by the subset of DYNALLOC that is supported by TEMPLATE.

The following diagram shows the syntax of the TEMPLATE block:

TEMPLATE block

name expression

path expression

qualifier expression

common options

Notes:

¹ SUBSYS and path-expression are mutually exclusive.
² The entire name expression represents one character string and cannot contain any blanks.
³ If you use substring notation, the entire DSN operand must be enclosed in single quotation marks, such as 'P&PA(4,2).'.
⁴ If a TAPEUNIT specification (defined either by a TAPEUNIT option or the TAPEUNIT parmlib parameter) applies to the UNIT specified by the UNIT suboption of the TEMPLATE statement, the default_devices_value is used as a default UNCNT value. For allocation of sequential data sets on disk, i.e. when no TAPEUNIT specification applies to the UNIT specified by the TEMPLATE statement, where MAXPRIME is specified and no VOLUME is specified, the value of UNCNT is calculated to allow the data set to be written over several volumes according to the estimated amount data it must store. If none of the previous condition is fulfilled, a value of 1 is used for UNCNT.

disk options

tape options

Important: To share TEMPLATE libraries with other Db2 utilities, Db2 HPU accepts, but ignores, all keywords that are not specified in the syntax diagram.

TEMPLATE template-name

Defines a data set allocation template and assigns a name to the template for subsequent reference in an UNLOAD command. The name is followed by keywords that control the allocation of tape and disk data sets. You cannot specify both disk options and tape options in the same TEMPLATE statement. The UNIT keyword specifies a generic unit name that is already defined on your system.

Valid values are 1 - 8 alphanumeric characters and must begin with an alphabetic character.

DSN name-expression

Specifies the TEMPLATE for the z/OS data set name. You can specify the data set name by using symbolic variables, non-variable alphanumeric or national characters, or any combination of these characters. The name must adhere to the z/OS data set naming rules, including those rules about name length, valid characters, name structure, and qualifier length.

Data set names consist of a series of qualifiers and qualifier expressions that are separated by a period and an optional expression in parentheses. Embedded blanks are restricted. If the DSN name operand contains any special characters, it must be enclosed in single quotation marks. For example, in the following TEMPLATE statement, the DSN operand contains parentheses as special characters, so the entire operand is enclosed in single quotation marks:

TEMPLATE X DSN 'A.GDG.VERSION(+1)'

Parentheses around the DSN name operand are optional. The following DSN specification shows a DSN name operand in parentheses:

DSN(&DB..&TS..D&DATE.)

Important: If you use the RESTART feature (see RESTART feature), make sure the name-expression you specify, once evaluated at run time, gives a different name than the one generated for the name-expression defined by the value of the VUU091/RSTTMPL parmlib parameter.

When the name-expression specifies the creation of a new GDS, i.e. by specifying an expression such as gdg_name (+1), a new GDS is created each time the nested template is used in the HPU SYSIN. This default behavior can be changed with the ONE_GDS_TEMPLATE option (see GLOBAL OPTIONS block).

PATH path-name

Specifies a z/OS UNIX System Services (USS) file path name. This path name can be a USS pipe path name. The path name must be in single-byte EBCDIC format and must not exceed 255 bytes. If the path name contains blanks, you must enclose it in single quotation marks.

Db2 HPU can use a template with the PATH keyword only for the following types of files:

UNLDDN for output of physical unloads
OUTDDN for output of logical unloads
LOADDDN for the LOAD SYSIN for logical unloads
DDLDDN to specify the DDL for unloading from an image copy
A template that is used to define a LOB file reference when LOB or XML data is unloaded

You can use a variable name for a complete directory name or part of a directory name. Before the files are generated, Db2 HPU ensures that the directory exists. Db2 HPU does not create the directory. If the directory does not exist, Db2 HPU issues an error.

Syntax rules regulate how Db2 HPU interprets variable names. When you use an ampersand (&), Db2 HPU interprets the ampersand as the introduction to a variable name. To generate an ampersand in the path name, you must use a backslash (\) as an escape character before the ampersand. In the following example, &TS. is coded as a variable name, and &SPECIAL is coded as regular text.

PATH '/u/&TS.\&SPECIAL'

After variables have been replaced, the following path name is generated:

/u/TS01&SPECIAL

To create a USS pipe file, you must specify DSNTYPE PIPE in the TEMPLATE statement.

FILEDATA

Specifies the content type of a z/OS USS file. Valid values are TEXT, BINARY, and RECORD.

The default value is RECORD, and RECFM VB and LRECL 32756 are assumed.

RECFM

Specifies the record format of the z/OS USS file. The RECFM option is required when FILEDATA is specified. The following values are valid:

F (Fixed)
FB (Fixed block)
V (Variable)
VB (Variable block)

If FILEDATA is not specified, RECFM VB is assumed with FILEDATA RECORD LRECL 32756.

LRECL

Specifies the record length of the z/OS USS file. The LRECL option is required when FILEDATA is specified.

If FILEDATA is not specified, LRECL 32756 is assumed with FILEDATA RECORD RECFM VB.

PATHOPTS

Specifies the access and status for the z/OS USS file that is named in the PATH parameter. The following values are valid:

ORDONLY

Specifies that the utility will open the file only for read access.

OCREAT

Specifies that files are created based on the following conditions:

If the file does not exist, the system creates it.
If a directory that is specified in the path name does not exist, the directory and the new file are not created.
If the file exists, the existing file is used by the utility.

OWRONLY

Specifies that the utility will open the file only for write access.

ONONBLOCK

Specifies that an open() function will return or block (wait) based on conditions for the following file types:

For a first-in first-out (FIFO) special file, such as a USS pipe file:

If ONONBLOCK is specified with ORDONLY access, an open() function for only reading returns a file descriptor (handler) without delay.
If ONONBLOCK is not specified with ORDONLY access, an open() function for only reading waits until a process opens the file for writing.
If ONONBLOCK is specified with OWRONLY access, an open() function for only writing returns an error if a process does not currently have the file open for reading.
If ONONBLOCK is not specified with OWRONLY access, an open() function for only writing waits until a process opens the file for reading.

For a character special file that supports nonblocking open:

If ONONBLOCK is specified, an open() function returns a file descriptor without waiting until the device is ready or available. The device response depends on the type of device.
If ONONBLOCK is not specified, an open() function waits until the device is ready or available.

Specifying ONONBLOCK does not affect other file types.

The default values are OCREAT and OWRONLY.

PATHMODE

Specifies the file mode of the HFS file. The following values are valid:

SIRUSR: Allows the file owner to read the file.
SIWUSR: Allows the file owner to write the file.
SIXUSR: If the file is a directory, allows the file owner to search; if the file is not a directory, allows the file owner to run the program in the file.
SIRWXU: If the file is a directory, allows the file owner to read, write, and search; if the file is not a directory, allows the file owner to read, write, and run the file. Specifying SIRWXU is eqivalent to specifying SIRUSR, SIWUSR, and SIXUSR together.
SIRGRP: Allows users in the file group class to read the file.
SIWGRP: Allows users in the file group class to write the file.
SIXGRP: If the file is a directory, allows users in the file group class to search; if the file is not a directory, allows users in the file group class to run the program in the file.
SIRWXG: If the file is a directory, allows users in the file group class to read, write, and search; if the file is not a directory, allows users in the file group class to read, write, and run the file. Specifying SIRWXG is equivalent to specifying SIRGRP, SIWGRP, and SIXGRP together.
SIROTH: Allows users in the file other class to read the file.
SIWOTH: Allows users in the file other class to write the file.
SIXOTH: If the file is a directory, allows users in the file other class to search; if the file is not a directory, allows users in the file other class to run the program in the file.
SIRWXO: If the file is a directory, allows users in the file other class to read, write, and search; if the file is not a directory, allows users to read, write, and run the file. Specifying SIRWXO is equivalent to specifying SIROTH, SIWOTH, and SIXOTH together.

The default value is SIRUSR.

PATHDISP

Specifies the disposition of a z/OS USS file when the job step ends. Valid values are KEEP and DELETE.

The MVS™ system default is KEEP,KEEP.

SUBSYS name

Specifies the MVS BATCHPIPES SUBSYSTEM name. The specified name must be a valid BATCHPIPES SUBSYSTEM name and must be 1 - 8 characters. When SUBSYS is specified, LRECL and RECFM are required, and TEMPLATE keywords that are not compatible with SUBSYS, such as UNIT, are ignored.

Restriction: When you use BATCHPIPES and TEMPLATE with the SUBSYS keyword, the utility cannot be restarted, and the LOAD DISCARDDN keyword is not supported.

LRECL integer

Specifies the record length of the MVS BATCHPIPES SUBSYSTEM file. LRECL is required when SUBSYS is specified.

RECFM

Specifies the record format of the MVS BATCHPIPES SUBSYSTEM file. RECFM is required when SUBSYS is specified. Valid values are F, FB, V, or VB.

character-expression

Specifies the data set name or part of the data set name by using nonvariable alphanumeric or national characters.

&variable

Specifies the data set name or part of the data set name by using nonvariable alphanumeric or national characters.

In addition to the list of variables, you can use user-defined variables in the DSN expression. You set the values for these user-defined variables by using the TEMPLATESET keyword in the OPTIONS block. Syntax rules for such user-defined variables are identical to the rules for standard variables. To avoid duplicate data set names when you specify a TEMPLATE statement with a LISTDEF and LISTDEFTBV list that contains a multi-table table space, specify TEMPLATESET and use a user-defined variable that corresponds with the :SELNUM predefined variable in the DSN expression.

Each symbolic variable is substituted with its related value at run time to form a specific data set name. When you use substitution variables in a DSN expression, they begin with an ampersand sign (&) and end with a period (.), as shown in the following example:

DSN &DB..&TS..D&JDATE..P&PART.

If you use only numeric variables, an invalid data set qualifier for all numeric-type variables, such as all date or time-type variables, &SEQ, and &PART, is generated. These variables must be preceded by character constants to form valid DSN qualifiers. The following specifications are valid:

P&PART.
D&DATE.

Some variables inherit default values when their values are not known. For example, the default value of &PART becomes 00000 for nonpartitioned objects.

You can also use substring notations for the data set name. This notation can prevent the data set name from exceeding the 44-character maximum. If you use substring notation, you must enclose the entire DSN operand in single quotation marks. To specify a substring, use the form &variable(start). or &variable(start,length).

The following table contains a list of JOB variables and their descriptions:

Table 1. JOB variables and descriptions
Variable	Description
&JOBNAME. or &JO.	The z/OS job name.
&STEPNAME. or &ST.	The z/OS step name. This variable might be needed if data set names from two different job steps conflict.
&USERID. or &US.	The user ID of the person who is running Db2 HPU. Valid values are 1 - 8 characters.
&UTILID. or &UT.	The utility ID truncated to eight characters and checked for invalid DSN characters.
&SSID. or &SS.	Db2 identifier against which Db2 HPU is run. This variable is resolved taking the value of the subparameter TEMPLATE_SSID_SUBSTITUTION of the VUU030/ULOPTNS parmlib parameter into account. if TEMPLATE_SSID_SUBSTITUTION is set to MEMBER_NAME or is not specified the &SSID or &SS variable is substituted with the current Db2 member name to which Db2 HPU has connected. if TEMPLATE_SSID_SUBSTITUTION is set to GROUP_NAME the &SSID or &SS variable is substituted with theDb2 member name in a non datasharing environment and with the group attachment name for datasharing environment.

The following table contains a list of UTILITY variables and their descriptions:

Table 2. UTILITY variables and descriptions
Variable	Description
&UTILNAME. or &UN.	The utility name. The value is set to Db2 HPU.
&SEQ. or &SQ.	The sequence number of the list item.

The following table contains a list of OBJECT variables and their descriptions:

Table 3. OBJECT variables and descriptions
Variable	Description
&LIST. or &LI.	The name of the list that is defined by using the LISTDEF and LISTDEFTBV control statement and that is referenced on the same control statement as this TEMPLATE.
&DB.	The database name.
&TS.	The table space name.
&SN.	The table space name.
&PART. or &PA.	The five-digit partition number, padded with leading zeros.

Notes:

To generate one output file per partition, use the &PA. variable when you process LISTDEF and LISTDEFTBV lists that include partitioned table spaces.
When you specify the &TS. or &SN. variables in a TEMPLATE statement that is used by an UNLOAD statement with BLOBF, CLOBF, or DBCLOBF columns, Db2 HPU substitutes the name of the table space that stores the LOB column value, not the base table space name. This substitution enables Db2 HPU to generate unique data set names for each LOB column with partitioned table spaces.
When the SELECT statement in which the TEMPLATE is used is processed by using SQL (DB2 FORCE or DB2 YES with an unsupported SELECT statement), the &PART variable is set to one of the following values based on whether SQLPART is used:
- The partition number when the SQLPART keyword is used,
- 00000 when the SQLPART keyword is not used.
The &DB, &TS, and &SN variables are set to DBn, TSn, LOBn or XMLn, depending on the tables pace type, where n is a sequential number. This sequential number ensures unity, but it does not have a specific meaning regarding the actual database or the table space that it represents.
In Db2 HPU V3.1, when a partitioned table space was unloaded from a global full image copy (FIC) that used a template with a DSNAME that contains the &PART variable, a single output file with partition number set to 00000 was generated. In Db2 HPU V3.2, an output file per partition with the &PART variable set to the partition number is generated.

The following table contains a list of DATE and TIME variables and their descriptions:

Table 4. DATE and TIME variables and descriptions
Variable	Description
&DATE. or &DT.	`YYYYDDD`
&TIME. or &TI.	`HHMMSS`
&JDATE. or &JU.	`YYYYDDD`
&YEAR. or &YE.	`YYYY` portion of &DATE.
&MONTH. or &MO.	`MM`
&DAY. or &DA.	`DD`
&JDAY. or &JD	`DDD` portion of &DATE.
&HOUR. or &HO.	`HH` portion of &TIME.
&MINUTE. or &MI.	`MM` portion of &TIME.
&SECOND. or &SC.	`SS` portion of &TIME.
&UNIQ. or &UQ.	Unique eight characters that Db2 HPU derives from the system clock. This set of characters begins with an alphabetic character and is followed by seven alphabetic or numeric characters.

Attention: All date and time values are set by using the STCK instruction and reflect the date and time value in Greenwich Mean Time (GMT). DATE and TIME values are captured during the initialization phase of Db2 HPU and remain constant during the STEP.

start

Specifies the substring starting byte location within the current variable base value at run time.

length

Specifies the length of the substring. If you specify start but do not specify length, the default value for length is the number of characters from the start character to the last character of the variable value at run time. For example, given a five-digit base value, &PART(4). specifies the fourth and fifth digits of the value. The length value must be an integer that does not cause the substring to extend beyond the end of the base value.

parenthetical-expression

Specifies part of the data set name by using nonvariable alphanumeric or national characters that are enclosed in parentheses. For example, the following expressions are valid: Q1.Q2.Q3(member) and Q1.Q2.Q3(+1).

UNIT

Specifies the device number, device type (generic), or group name for the data set. The default value is SYSALLDA.

MODELDCB dsname

Specifies the name of the data set on which the TEMPLATE statement is based. DCB information is read from this model data set.

When the template corresponds to a GDG, MODELDCB uses the VUX033/TMPLDSCB PARMLIB parameter as the default value.

BUFNO integer

Specifies the number of BSAM buffers. Valid values are 0 - 99. The default value is 30.

DATACLAS name

Specifies the SMS data class. The name value must be a valid SMS data class and must be 1 - 8 characters. If you specify DATACLAS, the data set is cataloged. If you do not specify DATACLAS, no SMS DATACLAS is specified.

MGMTCLAS name

Specifies the SMS management class. The name value must be a valid SMS management class and must be 1 - 8 characters. If you specify MGMTCLAS, the data set is cataloged. If you do not specify MGMTCLAS, no MGMTCLAS is specified to SMS.

STORCLAS name

Specifies the SMS storage class. The name value must be a valid SMS storage class and must be 1 - 8 characters. If you specify STORCLAS, the data set is cataloged. If you do not specify STORCLAS, no STORCLAS is specified to SMS.

RETPD integer

Specifies the retention period in days for the data set. Valid values are 0 - 9999. If you specify DATACLAS, MGMTCLAS, or STORCLAS, the class definition might control the retention. RETPD cannot be specified with EXPDL.

EXPDL 'date'

Specifies the expiration date for the data set, in the form YYYYDDD, where YYYY is the 4-digit year, and DDD is the 3-digit Julian day. The 'date' value must be enclosed in single quotation marks. If you specify DATACLAS, MGMTCLAS, or STORCLAS, the class definition might control the retention. EXPDL cannot be specified with RETPD.

VOLUMES (volume-1,volume-2,...)

Specifies a list of volume serial numbers for this allocation. The specified number of volumes cannot exceed the specified value or default value of the VOLCNT keyword. The first volume must contain enough space for the primary space allocation. If an individual volume serial number contains leading zeros, it must be enclosed in single quotation marks.

VOLCNT (integer)

Specifies the maximum number of volumes that an output data set might require. Valid values are 0 - 255.

Unless a tape storage class is used, the default value for tape templates is 95. If a tape storage class is used, the default value is the value that is set by the tape storage class.

Db2 HPU does not set a default value for disk templates. Operating system defaults apply.

UNCNT integer

Specifies the number of devices that are to be allocated. The integer value must range from 0 to 59 and must not exceed the maximum value defined by the TAPEUNIT option applicable to the related unit. When not specified, the maximum value (defined by the TAPEUNIT option) is assumed. If UNIT specifies a specific device number, the value of UNCNT must either be 1 or be omitted. If several templates share the same unit, the sum of the UNCNT parameters must be less or equal to the related TAPEUNIT parameter.

GDGLIMIT (integer)

Specifies the number of entries that are to be created in a GDG base if a GDG DSN is specified and the base does not exist. If a GDG base does not exist and you do not want to define one, specify GDGLIMIT (0). Valid values are 0 - 255.

The default value is 99.

LIMIT

Specifies that the template switching feature applies, i.e. that an alternate TEMPLATE is to be used when the estimated amount of data to unload exceeds a given size.

Important: This keyword is taken into account only if TEMPLATE_LIMIT(YES) is specified in the setting for the VUU030/ULOPTNS parmlib parameter.

The following details must be specified. The output data set size taken into account is an estimate. The estimation method, thus its result, depends on the setting for the VUX036/RTSESTIM parmlib.

n

Specifies the maximum size of the output data set that is permitted using this TEMPLATE. This number is expressed in the unit specified by one of the following keywords:

CYL: Cylinders
GB: Gigabytes
MB: Megabytes

new_template

Specifies a character string that specifies the name of a TEMPLATE to use if the size limit is exceeded.

Restriction:

You cannot switch to a DD card.
The template control statement that LIMIT references must exist in SYSIN or SYSTEMPL and it cannot refer to itself. If the reference contains also a LIMIT statement, the limit size must be greater than the referee.
You cannot use LIMIT for LOADDDN file, LOB or XML file.
Data set names patterns specified in the templates chained by the template switching feature must be consistent regarding the &PART. variable : if one template of among the related templates specify the &PART. variable, all the other templates must specify a pattern with the &PART. variable as well.
If the SPACE option is specified, the LIMIT option is ignored.

TIME

Specifies time used in expansion of date and time DSN variables. The default TIME value is determined by the TEMPLATE_TIME subsystem parameter if USE_ADMIN_INFO_SYSPARM(YES) is specified for the VUU030/ULOPTNS parameter. Otherwise, UTC applies.

LOCAL: Use local time at the DB2 server in the expansion of date and time in DSN variables.
UTC: Use Coordinated Universal Time (UTC) in the expansion of date and time in DSN variables.

DISP (status, normal-termination, abnormal-termination)

Specifies the data set disposition. You must specify values for all of the following variables:

status: Specify one of the following standard z/OS values: NEW, OLD, SHR, and MOD.
normal-termination: Specify one of the following standard z/OS values: DELETE, KEEP, CATLG, and UNCATLG.
abnormal-termination: Specify one of the following standard z/OS values: DELETE, KEEP, CATLG, and UNCATLG.

Default values for the disposition are NEW,CATLG,CATLG for output files for TEMPLATE statements that UNLDDN, OUTDDN, or LOADDDN statements, and SHR,KEEP,KEEP for input files for TEMPLATE statements that use COPYDDN or DDLDDN statements. When a PDS or PDSE is created by a TEMPLATE statement, its default disposition is NEW,CATLG,CATLG. When new members are created in the PDS or PDSE, the disposition is SHR,KEEP,KEEP.

SPACE (primary,secondary)

Specifies the z/OS disk space allocation parameters. If you specify (primary,secondary) values, these values are used instead of the values that are calculated Db2 HPU. When specifying primary and secondary quantities, you must either specify both values or omit both values. Use the MAXPRIME option to set an upper limit on the primary quantity.

Valid values are 1 - 1677215

CYL: Specifies that allocation quantities, if present, are to be expressed in cylinders and that allocation is to occur in cylinders. If SPACE CYL is specified, without (primary,secondary), the Db2 HPU-calculated quantities are allocated in cylinders by using 3390 quantities for byte conversion.
TRK: Specifies that, in the absence of values for (primary,secondary), the Db2 HPU-calculated quantities are to be allocated in tracks by using 3390 disk drive quantities for byte conversion. If the amount calculated is greater than one cylinder, the TRK keyword is ignored, and the data set is allocated in cylinders (CYL).
MB: Specifies that if allocation quantities are present, they are to be expressed in megabytes, and that allocation is to occur in records. One MB is 1048576 bytes. If SPACE MB is specified without (primary,secondary), the Db2 HPU-calculated quantities are allocated in records by using the average record length for the data set.

The default value is CYL.

Consider the following settings and keywords for default SPACE values for allocating NEW data sets:

Default SPACE values for allocating NEW data sets

DB2 NO or DB2 YES with supported SELECT statements: When Db2 HPU uses a TEMPLATE statement to allocate an output file (using UNLDDN or OUTDDN), the space that is allocated is calculated by using the catalog statistics for the unloaded object. If there are no statistics, Db2 HPU uses the physical characteristics of the underlying data set to compute the space for the output files. If necessary, you can override the calculated space allocation by using the SPACE parameter of the TEMPLATE definition.
DB2 FORCE or DB2 YES with unsupported SELECT statements: Use the SPACE keyword with specification of primary and secondary allocation in the TEMPLATE statement, or an error message is issued.
RLSE keyword: The RLSE (release) keyword is always used to allocate new data sets so that unused space is released on deallocation except when the allocated data set is a PDS or a PDSE (using DSNTYPE PDS or LIBRARY parameters).

PCTPRIME integer

Specifies the percentage of the estimated required space that will be obtained as the primary quantity. Use the MAXPRIME keyword to set the upper limit of this value for large objects.

The default value is 100.

MAXPRIME integer

Specifies the maximum allowable primary space allocation. The value is expressed in cylinders (CYL). This value constrains the primary space value, the PCTPRIME calculation, and the size of each secondary allocation.

NBRSECND integer

Specifies the division of secondary space allocations. After the primary space is allocated, an amount of space equal to the estimated required space is divided into the specified number of secondary allocations. Valid values are 1 - 10.

The default value is 10.

DIR integer

Specifies the number of 256-byte records that are to be allocated for the directory of a new (DISP NEW or DISP MOD) partitioned data set (DSNTYPE PDS) or library (DSNTYPE LIBRARY).

With DSNTYPE PDS, the DIR option must be specified unless the dataset is used in an UNLOAD statement with BLOBF, CLOBF, or DBCLOBF. In such a case, if DIR is omitted, Db2 HPU calculates the number of 256-byte records to allocate by dividing the estimated number of records of the table to unload by 20. You may specify your own value by specifying a DIR option if the value calculated by Db2 HPU is not suitable.

With DSNTYPE LIBRARY, the DIR option is not mandatory as Db2 uses 1 as a default value. Be aware that the DIR option for a PDSE has almost no impact as it would be used only in case of a future conversion of the PDSE (LIBRARY) into a PDS dataset. If such a conversion is planed, setting a DIR option to a suitable value is advisable.

DSNTYPE

Specifies the type of data set to be allocated.

LIBRARY: Specifies that a partitioned data set extended (PDSE) will be allocated.
PDS: Specifies that a partitioned data set (PDS) will be allocated.
HFS: Specifies that a hierarchical file system (HFS) file will be allocated. An HFS file is allowed only when a TEMPLATE is used to allocate a LOB file reference (CLOBF, BLOBF, or DBCLOBF columns).
NULL: Specifies a null file. Use this value for a TEMPLATE statement with UNLOAD CLOBF, BLOBF, or DBCLOBF columns to unload a null LOB value. In this case, the unload data set contains a null file name.
PIPE: Specifies a USS pipe file. Specify PIPE only when you allocate a new pipe output file by using the PATH option in the TEMPLATE statement. You cannot use DSNTYPE PIPE when you allocate input files, existing pipe files, standard z/OS files with the DSN option, or a LOB file reference.
BASIC: Specifies that a basic data set will be allocated. Basic format data sets are sequential data set that are specified as neither extended-format nor large-format. Basic format data sets have a size limit of 65 535 tracks (4 369 cylinders) per volume.
LARGE: Specifies that a large data set will be allocated. Large format data sets are sequential data sets that can grow beyond 65 535 tracks (4 369 cylinders) up to 16 777 215 tracks per volume.
EXTREQ: Specifies that an extended format data set will be allocated. The allocation should fail if that is not possible.
EXTPREF: Specifies that allocation is preferred to be in extended format, but if the necessary system resources for extended are not available, then the data set should be allocated as BASIC.

If you omit DSNTYPE, the type of data set is determined by other data set attributes, the data class for the data set, or an installation default.

KEYLABEL key-label-name

Specifies the key label for the allocation of the data set. If the security administrator has specified a key label for RACF data set profile, that key label takes precedence over the DB2 provided key label.

STACK

Specifies whether output data sets are to be stacked contiguously on the same tape volumes.

NO: Specifies that output data sets are not stacked contiguously on tape.
YES: Specifies that output data sets are stacked as successive files on one tape volume. A logical tape volume can consist of an aggregate of more than one volume.

Stacking is allowed only for the output data sets from a physical unload (UNLDDN) or a logical unload (OUTDDN). When you unload LOB or XML data, stacking output files on tape is not supported for CLOBF, DBCLOBF, or BLOBF columns.

TRTCH

Specifies the track recording method for magnetic tape drives that have improved data recording capability.

NONE: Specifies that a track recording method is not specified during dynamic allocation.
COMP: Specifies that data is written in compacted format.
NOCOMP: Specifies that data is written in standard format.

See MVS JCL Reference for more information about the PATHOPTS and PATHMODE options.