CEDA DEFINE DOCTEMPLATE

Use this resource definition to define document templates to CICS®. Document templates allow you to perform variable substitution on documents in a manner similar to that done by BMS for 3270 screens.

The template can reside in any one of the following places:

z/VSE sublibrary
CICS temporary storage
CICS transient data
CICS load module
exit program

Defining a DOCTEMPLATE

Figure 1. The DEFINE panel for DOCTEMPLATE

  DOctemplate  ==>
  Group        ==>
  DEscription  ==>
 FULL TEMPLATE NAME
  TEmplatename ==>
 ASSOCIATED CICS RESOURCE
  File         ==>
  TSqueue      ==>
  TDqueue      ==>
  Program      ==>
  Exitpgm      ==>
 TEMPLATE SUBLIBRARY
  Library      ==>
  Membername   ==>
 TEMPLATE PROPERTIES
  Appendcrlf   ==> Yes                Yes | No
  TYpe         ==>                    Binary | Ebcdic

Options

APPENDCRLF

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

LIBRARY

specifies the library name of the z/VSE library containing the template. The library applies only to a template of type z/VSE library. If a membername attribute is supplied without a value for library, the SOURCE LIBDEF chain is searched for the template. If a value for library is specified, the sublibrary DFHDOC of that library is used to locate the template.

DESCRIPTION(text)

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

DOCTEMPLATE

specifies the name of this DOCTEMPLATE definition. The name can be up to eight characters in length. The acceptable characters are: A-Z 0-9 $ @ # . / - _ % & ¢ ? ! : | " = ¬ , ; < and >.

EXITPGM

specifies the exit program to be invoked when a request is made for this template. CICS passes a commarea to the exit program which is mapped by the following copybooks:

DFHDHTXD (Assembler)
DFHDHTXH (C)
DFHDHTXL (PL/I)
DFHDHTXO (COBOL)

FILE(filename)

specifies, for a template of type FILE, the up to 7-character name of the CICS file definition for the data set containing the template.

GROUP(groupname)

specifies the group name, which can be up to eight characters in length. The characters allowed are A-Z 0-9 @ # and $. Lowercase characters are treated as uppercase characters. Do not use group names beginning with DFH, because these characters are reserved for use by CICS.

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. For more information about groups, see CICS Resource Definition Guide.

MEMBERNAME

specifies the name of the z/VSE library member containing the template. It applies only to a template of type z/VSE library. The z/VSE library member type of the template must be HTML.

PROGRAM

specifies the program in which the template data is stored. CICS loads the program and takes all data after the entrypoint to be the template.

TDQUEUE

specifies the name of the TD queue on which the template is stored.

TEMPLATENAME

specifies the extended Template-name by which the doctemplate is to be known outside the resource definition function.

TSQUEUE

specifies the name of the TS queue on which the template is stored.

TYPE(BINARY|EBCDIC)

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.

Note: The fields EXITPGM, FILE, MEMBER, PROGRAM, TDQUEUE, and TSQUEUE define alternative sources of the template data. Only one of them may be specified on each DOCTEMPLATE definition.