Document template definition attributes

The document template definitions attribute descriptions are:

AppendCRLF
specifies whether CICS® is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template as it is read from the PDS, FILE, TDQUEUE, or TS QUEUE.
YES
Carriage return/linefeed pairs should be appended, and trailing blanks should be removed.
NO
Carriage return/linefeed pairs should not be appended, and trailing blanks should not be removed.
Type
Specify whether the contents of the template are binary or EBCDIC. If the type in BINARY, no parsing takes place. If the type is EBCDIC, the contents of the template are parsed as EBCDIC text.
DDname
when the template resides in an MVS™ partitioned data set (PDS), specifies the DDname of the PDS. The name can be up to eight characters in length.

If you specify a value for the MEMBERNAME attribute, but do not specify a value for DDNAME, the default value of DFHHTML is taken.

If you specify this attribute, you cannot specify EXITPGM, FILE, PROGRAM, TDQUEUE or TSQUEUE.

Description
(Optional.) Specifies a 1- to 30-character description of the resource.
Name
specifies the name of this document template definition. The name can be up to eight characters in length. The acceptable characters are: A-Z a-z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < and >.
Exitpgm
specifies the name of an exit program that generates a template. The name can be up to eight characters in length.

If you specify this attribute, you cannot specify DDNAME, FILE, MEMBERNAME, PROGRAM, TDQUEUE or TSQUEUE.

File
when the template resides in a CICS file, specifies the name of the file. The name can be eight characters in length.

If you specify this attribute, you cannot specify DDNAME, EXITPGM, MEMBERNAME, PROGRAM, TDQUEUE or TSQUEUE.

Membername
when the template resides in an MVS partitioned data set (PDS), specifies the name of the member containing the template. The name can be up to eight characters in length.

If you specify this attribute, you cannot specify EXITPGM, FILE, PROGRAM, TDQUEUE or TSQUEUE.

Program
when the template resides in a CICS program, specifies the name of the program. The name can be up to eight characters in length.

If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, TDQUEUE or TSQUEUE.

RESGROUP
(Optional.) The name of the resource definition group to which this definition is to be automatically added.
TDqueue
when the template resides in a transient data queue, specifies the name of the queue. The name can be up to four characters in length.

If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, or TSQUEUE.

Templatename
specifies the name by which the template is known to application programs that use it. The name can be up to 48 characters in length.
If no value is specified, the default is the 1- to 8-character name for the document template definition.
TSqueue
when the template resides in a temporary storage queue, specifies the name of the queue. The name can be up to 16 characters in length.

If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, or TDQUEUE.

Type
specifies the format of the contents of the template.
BINARY
When the template is loaded from the template library, no parsing of the template's contents is done.
EBCDIC
When the template is loaded from the template library, the contents are parsed as EBCDIC text.
User data
(Optional.) Three 8-character fields provided for any site-specific data related to the DB2® entry. CICSPlex® SM makes no use of this user data.
Version
(Optional.) Specify an integer in the range 1 through 15. Specify 0 or leave blank for CICSPlex SM to assign the first available version id in the range 1 through 15.

Related concepts
Document template resource definitions
CICS Resource Definition Guide
Related tasks
Accessing BAS document template definitions
Working with the DOCDEF view
Defining document templates using BAS
Installing BAS document template definitions
[[ Contents Previous Page | Next Page Index ]]