CREATE DOCTEMPLATE

Define a document template.

Read syntax diagramSkip visual syntax diagramCREATE DOCTEMPLATE
 
>>-CREATE DOCTEMPLATE(data-value)--ATTRIBUTES(data-value)------->
 
>--ATTRLEN(data-value)--LOGMESSAGE(cvda)-----------------------><
 
CREATE DOCTEMPLATE attribute values:
 
   .-APPENDCRLF(YES)-.
|--+-----------------+--+---------------------+----------------->
   '-APPENDCRLF(NO)--'  '-DESCRIPTION(char58)-'
 
>--+-FILE(char8)---------------------------+-------------------->
   +-TSQUEUE(char16)-----------------------+
   +-TDQUEUE(char4)------------------------+
   +-PROGRAM(char8)------------------------+
   +-EXITPGM(char8)------------------------+
   |                   .-DDNAME(DFHHTML)-. |
   +-MEMBERNAME(char8)-+-----------------+-+
   |                   '-DDNAME(char8)---' |
   '-HFSFILE(char255)----------------------'
 
>--+----------------------+-------------------------------------|
   '-TEMPLATENAME(char48)-'
 

Conditions: ILLOGIC, INVREQ, LENGERR, NOTAUTH

Note to COBOL programmers:

In the syntax above, you must use
     --- ATTRIBUTES ( data-area )---  instead of
     --- ATTRIBUTES ( data-value)---

Description

The CREATE DOCTEMPLATE command installs a DOCTEMPLATE definition with the attribute specified on the command. It does not use a resource definition stored in the CSD. If there is already a document template with the name you specify in the local CICS region, the new definition replaces the old one; if not, the new definition is added.

A syncpoint is implicit in CREATE DOCTEMPLATE processing, except when an exception condition is detected early in processing the command. Uncommitted changes to recoverable resources made up to that point in the task are committed if the CREATE executes successfully, and rolled back if not. See Creating resource definitions for other general rules governing CREATE commands.

Options

ATTRIBUTES(data-value)
specifies the attributes of the DOCTEMPLATE being added. The list of attributes must be coded as a single character string using the syntax shown in DOCTEMPLATE attributes. See ATTRIBUTES option for general rules for specifying attributes, and the DOCTEMPLATE section in the CICS® Resource Definition Guide for details about specific attributes.
ATTRLEN(data-value)
specifies the length in bytes of the character string supplied in the ATTRIBUTES option, as a halfword binary value. The length may not exceed 32767 bytes.
DOCTEMPLATE(data-value)
specifies the 8-character name of the DOCTEMPLATE definition to be added to the CICS region.
LOGMESSAGE
specifies whether CICS logs the attributes used for the resource being created to the CSDL transient data queue. CVDA values are:
LOG
The resources attributes are logged to the CSDL transient data queue.
NOLOG
The resources attributes are not logged to the CSDL transient data queue.

Conditions

INVREQ
RESP2 values:
n
There is a syntax error in the ATTRIBUTES string, or an error occurred during either the discard or resource definition phase of the processing. See Appendix C. EXEC CICS CREATE RESP2 values for information on RESP2 values.
7
The LOGMESSAGE cvda value is not valid.
200
The command was executed in a program defined with an EXECUTIONSET value of DPLSUBSET for a program invoked from a remote system by a distributed program link without the SYNCONRETURN option.
LENGERR
RESP2 values:
1
The length you have specified in ATTRLEN is negative.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
[[ Contents Previous Page | Next Page Index ]]