DHTM gate, ADD_REPLACE_DOCTEMPLATE function

The ADD_REPLACE_DOCTEMPLATE function of the DHTM gate is used to install a document template into the currently executing CICS system.

Input Parameters

APPENDCRLF
specifies whether CICS is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template .
Values for the parameter are:
  • NO
  • YES
CATALOG_DOC
Specifies if the changes to the doucment template are to be added to the catalog.
Values for the parameter are:
  • NO
  • YES
DOCTEMPLATE
is the name of the DOCTEMPLATE resource that is to be added.
HFSPATH
When the template resides in a z/OS UNIX System Services file, the fully qualified (absolute) or relative name of the file.
RESOURCE_NAME
is the name of the resource containing the DOCTEMPLATE.
RESOURCE_TYPE
specifies the type of resource containing the DOCTEMPLATE.
Values for the parameter are:
  • EXITPGM
  • FILE
  • HFSFILE
  • PDS_MEMBER
  • PROGRAM
  • TDQUEUE
  • TSQUEUE
TEMPLATE_NAME
is the name of an RDO defined DOCTEMPLATE which is to be added to the document.
TYPE
specifies the format of the contents of the template.
Values for the parameter are:
  • BINARY
  • EBCDIC
DDNAME
Optional Parameter
is the DDNAME of the PDS containing the DOCTEMPLATE resource if the resource resides on a PDS.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • DIRECTORY_ERROR
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • BROWSE_END
  • DDNAME_NOT_FOUND
  • FREEMAIN_FAILED
  • GETMAIN_FAILED
  • IO_ERROR
  • MEMBER_NOT_FOUND
  • NAME_IN_USE
  • NOT_FOUND
  • NOT_USABLE
  • TRUNCATED
The following values are returned when RESPONSE is INVALID:
  • INVALID_BROWSE_TOKEN
  • INVALID_FORMAT
  • INVALID_FUNCTION
  • INVALID_RESOURCE_TYPE
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
DATASET
Optional Parameter
is the data set name of the PDS containing the DOCTEMPLATE resource if the resource resides on a PDS.
DOCTEMPLATE_IN_USE
Optional Parameter
is the name of the DOCTEMPLATE definition that uses the same TEMPLATE_NAME as the resource being defined.


dfhs3_DHTMadd_replace_doctemplate.html | Timestamp icon Last updated: Monday, 5 June 2017