DOCTEMPLATE attributes

Describes the syntax and attributes of the DOCTEMPLATE resource.

APPENDCRLF(YES|NO)

specifies whether CICS® is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template .

DDNAME(DFHHTML|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.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

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, HFSFILE, PROGRAM, TDQUEUE or TSQUEUE.

DESCRIPTION(text)

You can provide a description of the resource that you are defining in this field. The description text can be up to 58 characters in length. No restrictions apply to the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right one. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.

DOCTEMPLATE(name)

specifies the name of this document template definition. The name can be up to eight characters in length.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

EXITPGM(program)

specifies the name of an exit program that generates a template. The name can be up to eight characters in length.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

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

FILE(file)

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

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

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

GROUP(groupname)

Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.

Acceptable characters: `A-Z 0-9 $ @ #` Any lowercase characters that you enter are converted to uppercase.

The GROUP name can be up to 8 characters in length. Lowercase characters are treated as uppercase characters.

HFSFILE(hfsfile)

When the template resides in a z/OS® UNIX System Services file, this specifies the fully qualified (absolute) or relative name of the z/OS UNIX file. The name can be specified as an absolute name including all directories and beginning with a slash, for example, /u/facts/images/bluefish.jpg. Alternatively, it can be specified as a name relative to the HOME directory of the CICS region userid, for example, facts/images/bluefish.jpg. Up to 255 characters can be used.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

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

Note: The CICS region must have permissions to access z/OS UNIX, and it must have permission to access the z/OS UNIX directory containing the file, and the file itself. Giving CICS regions permission to access z/OS UNIX directories and files explains how to grant these permissions.

MEMBERNAME(member)

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.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

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

PROGRAM(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.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

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

TDQUEUE(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.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

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

TEMPLATENAME(template)

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.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

If you do not specify a value for this attribute, the value of the DOCTEMPLATE attribute is used, extended on the right with blanks.

TSQUEUE(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.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

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

TYPE({EBCDIC|BINARY})

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.