Document Handler domain’s specific gates

Table 39 summarizes the document handler domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 39. Document Handler domain’s specific gates
Gate Trace Function XPI
DHDH
DH 0120
DH 0121
CREATE_DOCUMENT
INSERT_DATA
INSERT_BOOKMARK
REPLACE_DATA
DELETE_DOCUMENT
DELETE_DATA
DELETE_BOOKMARK
RETRIEVE_WITH_CTLINFO
RETRIEVE_WITHOUT_CTLINFO
INQUIRE_DOCUMENT
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
DHSL
DH 0200
DH 0201
SET_SYMBOL_VALUE_BY_API,
SET_SYMBOL_VALUE_BY_SSI,
ADD_SYMBOL_LIST
EXPORT_SYMBOL_LIST
IMPORT_SYMBOL_LIST
NO
NO
NO
NO
NO
DHTM
DH 0401
DH 0402
INITIALIZE_DOCTEMPLATES
ADD_REPLACE_DOCTEMPLATE
DELETE_DOCTEMPLATE
INQUIRE_DOCTEMPLATE
INQUIRE_TEMPLATE_STATUS
START_BROWSE
GET_NEXT
END_BROWSE
READ_TEMPLATE
NO
NO
NO
NO
NO
NO
NO
NO
NO
DHRP
DH 0C01
DH 0C02
RECOVER_DEFINITIONS
NO

DHDH gate, CREATE_DOCUMENT function

The CREATE_DOCUMENT function of the DHDH gate is used to create a new CICS® document.

Input parameters

[TEXT]
is a buffer containing a block of text to be added to the document.
[BINARY]
is a buffer containing a block of binary data to be added to the document.
[TEMPLATE_BUFFER]
is a buffer containing a template to be added to the document.
[TEMPLATE_NAME]
is the name of an RDO defined DOCTEMPLATE which is to be added to the document.
[SOURCE_DOCUMENT]
is the document token of an existing document created by the same CICS task which is to be added to the document.
[RETRIEVED_DOCUMENT]
is a buffer containing a document in a retrieved format which is to be added to the document.
[HOST_CODEPAGE]
is the character encoding for the block of data being added to the document. This parameter is taken into account for the TEXT and TEMPLATE_BUFFER options and ignored for all other options.
[SYMBOL_LIST]
is a buffer containing a list of symbols to be added to the symbol table of the document.
[TEMPLATE_IN_ERROR]
is a buffer which is used by the Document Handler domain to return the name of a DOCTEMPLATE in which an error has been detected. This parameter is only meaningful when specified with the TEMPLATE_NAME option or the TEMPLATE_BUFFER option where the template in the TEMPLATE_BUFFER option contains an embedded template.

Output parameters

DOCUMENT_TOKEN
is the token identifying the newly created document.
ERROR_OFFSET
is the offset into a template where a syntax error has been detected.
RETRIEVE_SIZE
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
CODEPAGE_NOT_SPECIFIED
INVALID_HOST_CODEPAGE
INVALID_TEMPLATE_SYNTAX
TEMPLATE_NOT_FOUND
SOURCE_DOC_NOT_FOUND
INVALID_RETRIEVE_FORMAT
SYMBOL_NAME_INVALID
SYMBOL_VALUE_INVALID
EMBED_DEPTH_EXCEEDED
INVALID_TEMPLATE_LENGTH

DHDH gate, INSERT_DATA function

The INSERT_DATA function of the DHDH gate is used to insert a block of data into an existing document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document into which the data will be inserted.
[TEXT]
is a buffer containing a block of text to be added to the document.
[BINARY]
is a buffer containing a block of binary data to be added to the document.
[TEMPLATE_BUFFER]
is a buffer containing a template to be added to the document.
[TEMPLATE_NAME]
is the name of an RDO defined DOCTEMPLATE which is to be added to the document.
[SYMBOL]
is the name of a symbol defined in the symbol table. The value associated with the symbol will be added to the document.
[SOURCE_DOCUMENT]
is the document token of an existing document created by the same CICS task which is to be added to the document.
[RETRIEVED_DOCUMENT]
is a buffer containing a document in a retrieved format which is to be added to the document.
[HOST_CODEPAGE]
is the character encoding for the block of data being added to the document. This parameter is taken into account for the TEXT, SYMBOL and TEMPLATE_BUFFER options and ignored for all other options.
[INSERT_POINT]
identifies the beginning or end as the position at which data should be inserted into a document. It can have either of these values:
START|END
[INSERT_AT]
is the name of a bookmark which identifies the position at which the data should be inserted.
[TEMPLATE_IN_ERROR]
is a buffer which is used by the Document Handler domain to return the name of a DOCTEMPLATE in which an error has been detected. This parameter is only meaningful when specified with the TEMPLATE_NAME option or the TEMPLATE_BUFFER option where the template in the TEMPLATE_BUFFER option contains an embedded template.

Output parameters

ERROR_OFFSET
is the offset into a template where a syntax error has been detected.
RETRIEVE_SIZE
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
CODEPAGE_NOT_SPECIFIED
INVALID_HOST_CODEPAGE
EMBED_DEPTH_EXCEEDED
INSERTPOINT_NOT_FOUND
INVALID_TEMPLATE_SYNTAX
TEMPLATE_NOT_FOUND
SOURCE_DOC_NOT_FOUND
INVALID_RETRIEVE_FORMAT
SYMBOL_NOT_FOUND
INVALID_TEMPLATE_LENGTH
INVALID DOCUMENT_NOT_FOUND

DHDH gate, INSERT_BOOKMARK function

The INSERT_BOOKMARK function of the DHDH gate is used to insert a bookmark into an existing document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document into which the bookmark will be inserted.
BOOKMARK_NAME
is the 16 byte name of a bookmark to be added to the document.
[INSERT_POINT]
identifies the beginning or end as the position at which the bookmark should be inserted into a document. It can have either of these values:
START|END
[INSERT_AT]
is the name of a bookmark which identifies the position at which the bookmark should be inserted.

Output parameters

RETRIEVE_SIZE
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INSERTPOINT_NOT_FOUND
INVALID_BOOKMARK_NAME
DUPLICATE_BOOKMARK
INVALID DOCUMENT_NOT_FOUND

DHDH gate, REPLACE_DATA function

The REPLACE_DATA function of the DHDH gate is used to replace the data between 2 bookmarks in an existing document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document into which the data will be inserted.
[TEXT]
is a buffer containing a block of text to be added to the document.
[BINARY]
is a buffer containing a block of binary data to be added to the document.
[TEMPLATE_BUFFER]
is a buffer containing a template to be added to the document.
[TEMPLATE_NAME]
is the name of an RDO defined DOCTEMPLATE which is to be added to the document.
[SYMBOL]
is the name of a symbol defined in the symbol table. The value associated with the symbol will be added to the document.
[SOURCE_DOCUMENT]
is the document token of an existing document created by the same CICS task which is to be added to the document.
[RETRIEVED_DOCUMENT]
is a buffer containing a document in a retrieved format which is to be added to the document.
[HOST_CODEPAGE]
is the character encoding for the block of data being added to the document. This parameter is taken into account for the TEXT, SYMBOL and TEMPLATE_BUFFER options and ignored for all other options.
[FROM_POSITION]
identifies the beginning or end of the document as the start of the data which is to be replaced in the document. It can have either of these values:
START|END
[FROM_BOOKMARK]
is the name of a bookmark which identifies the start of the data which is to be replaced.
[TO_POSITION]
identifies the beginning or end of the document as the end of the data which is to be replaced in the document. It can have either of these values:
START|END
[TO_BOOKMARK]
is the name of a bookmark which identifies the end of the data which is to be replaced.
[TEMPLATE_IN_ERROR]
is a buffer which is used by the Document Handler domain to return the name of a DOCTEMPLATE in which an error has been detected. This parameter is only meaningful when specified with the TEMPLATE_NAME option or the TEMPLATE_BUFFER option where the template in the TEMPLATE_BUFFER option contains an embedded template.

Output parameters

ERROR_OFFSET
is the offset into a template where a syntax error has been detected.
RETRIEVE_SIZE
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
CODEPAGE_NOT_SPECIFIED
INVALID_HOST_CODEPAGE
EMBED_DEPTH_EXCEEDED
INVALID_TEMPLATE_SYNTAX
TEMPLATE_NOT_FOUND
SOURCE_DOC_NOT_FOUND
INVALID_RETRIEVE_FORMAT
SYMBOL_NOT_FOUND
FROM_BOOKMARK_NOT_FOUND
TO_BOOKMARK_NOT_FOUND
INVALID_TEMPLATE_LENGTH
INVALID DOCUMENT_NOT_FOUND

DHDH gate, DELETE_DOCUMENT function

The DELETE_DOCUMENT function of the DHDH gate is used to delete a document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document to be deleted.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID DOCUMENT_NOT_FOUND

DHDH gate, DELETE_DATA function

The DELETE_DATA function of the DHDH gate is used to delete the data between 2 bookmarks in an existing document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document from which the data will be deleted.
[FROM_POSITION]
identifies the beginning or end of the document as the start of the data which is to be deleted from the document. It can have either of these values:
START|END
[FROM_BOOKMARK]
is the name of a bookmark which identifies the start of the data which is to be deleted.
[TO_POSITION]
identifies the beginning or end of the document as the end of the data which is to be deleted from the document. It can have either of these values:
START|END
[TO_BOOKMARK]
is the name of a bookmark which identifies the end of the data which is to be deleted.

Output parameters

RETRIEVE_SIZE
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
FROM_BOOKMARK_NOT_FOUND
TO_BOOKMARK_NOT_FOUND
INVALID_BOOKMARK_SEQUENCE
INVALID DOCUMENT_NOT_FOUND

DHDH gate, DELETE_BOOKMARK function

The DELETE_BOOKMARK function of the DHDH gate is used to delete a bookmark in an existing document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document from which the bookmark will be deleted.
BOOKMARK_NAME
is the name of the bookmark to be deleted from the document.

Output parameters

RETRIEVE_SIZE
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION BOOKMARK_NOT_FOUND
INVALID DOCUMENT_NOT_FOUND

DHDH gate, RETRIEVE_WITH_CTLINFO function

The RETRIEVE_WITH_CTLINFO function of the DHDH gate is used to retrieve a copy of an existing document. The retrieved copy will contain embedded control information.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document to be retrieved.
DOCUMENT_BUFFER
is a buffer into which the Document Handler domain will place the copy of the document.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID DOCUMENT_NOT_FOUND

DHDH gate, RETRIEVE_WITHOUT_CTLINFO function

The RETRIEVE_WITHOUT_CTLINFO function of the DHDH gate is used to retrieve a copy of an existing document. The retrieved copy will only contain the data in the document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document to be retrieved.
DOCUMENT_BUFFER
is a buffer into which the Document Handler domain will place the copy of the document.
[CLIENT_CODEPAGE]
is the character encoding that the retrieved document should be converted to when it is placed in the buffer.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_HOST_CODEPAGE
INVALID_CLIENT_CODEPAGE
INVALID DOCUMENT_NOT_FOUND

DHDH gate, INQUIRE_DOCUMENT function

The INQUIRE_DOCUMENT function of the DHDH gate is used to obtain information about the document.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document to be queried.

Output parameters

[DOCUMENT_SIZE]
is the size of the data in a document.
[RETRIEVE_SIZE]
is the maximum size in bytes that a retrieved copy of the document can be.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID DOCUMENT_NOT_FOUND

DHSL gate, SET_SYMBOL_VALUE_BY_API function

The SET_SYMBOL_VALUE_BY_API function of the DHSL gate is used to set the value of a symbol in the symbol table. If the symbol does not exist in the table, it will be added. If the symbol does exist in the table, it will always be replaced.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document that owns the symbol table.
SYMBOL_NAME
is the name of the symbol in the symbol table.
VALUE
is the value to be associated with the symbol.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
GETMAIN_ERROR
SYMBOL_NAME_INVALID
INVALID DOCUMENT_NOT_FOUND

DHSL gate, SET_SYMBOL_VALUE_BY_SSI function

The SET_SYMBOL_VALUE_BY_SSI function of the DHSL gate is used to set the value of a symbol in the symbol table. If the symbol does not exist in the table, it will be added. If the symbol does exist in the table, it will only be replaced if it was previously set using the SET_SYMBOL_VALUE_BY_SSI function.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document that owns the symbol table.
SYMBOL_NAME
is the name of the symbol in the symbol table.
VALUE
is the value to be associated with the symbol.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
GETMAIN_ERROR
SYMBOL_NAME_INVALID
INVALID DOCUMENT_NOT_FOUND

DHSL gate, ADD_SYMBOL_LIST function

The ADD_SYMBOL_LIST function of the DHSL gate is used to add a list of symbols to the symbol table at one time.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document that owns the symbol table.
SYMBOL_LIST
is a buffer containing a list of symbols to be added to the symbol table of the document.

Output parameters

ERROR_OFFSET
is the offset into the symbol list where a syntax error has been detected.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
GETMAIN_ERROR
SYMBOL_NAME_INVALID
SYMBOL_VALUE_INVALID
INVALID DOCUMENT_NOT_FOUND

DHSL gate, EXPORT_SYMBOL_LIST function

The EXPORT_SYMBOL_LIST function of the DHSL gate is used to export all the symbols in the symbol table in a form that can be re-imported with IMPORT_SYMBOL_LIST.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document that owns the symbol table.
SYMBOL_LIST_BUFFER
is a buffer that is to contain the exported symbol list.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID DOCUMENT_NOT_FOUND

DHSL gate, IMPORT_SYMBOL_LIST function

The IMPORT_SYMBOL_LIST function of the DHSL gate is used to import all the symbols in the symbol table that were exported with EXPORT_SYMBOL_LIST.

Input parameters

DOCUMENT_TOKEN
is the token which identifies the document that owns the symbol table.
SYMBOL_LIST_BUFFER
is a buffer that contains the symbol list to be added to the symbol table. This list should have been created using and the EXPORT_SYMBOL_LIST function.

Output parameters

ERROR_OFFSET
is the offset into the list where a syntax error has been detected.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
SYMBOL_NAME_INVALID
SYMBOL_VALUE_INVALID
INVALID DOCUMENT_NOT_FOUND

DHTM gate, INITIALIZE_DOCTEMPLATES function

The INITIALIZE_DOCTEMPLATES function of the DHSL gate is used to initialize the state required by the template manager.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER DIRECTORY_ERROR

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

DOCTEMPLATE
is the name of the DOCTEMPLATE resource that is to be added.
TEMPLATE_NAME
is the name by which the DOCTEMPLATE is known outside of RDO.
RESOURCE_TYPE
specifies the type of resource containing the DOCTEMPLATE. It can have one of the following values:
PDS_MEMBER|FILE|PROGRAM|TSQUEUE|TDQUEUE|EXITPGM
RESOURCE_NAME
is the name of the resource containing the DOCTEMPLATE.
[DDNAME]
is the DDNAME of the PDS containing the DOCTEMPLATE resource if the resource resides on a PDS.

Output parameters

[DATASET]
is the dataset name of the PDS containing the DOCTEMPLATE resource if the resource resides on a PDS.
[DOCTEMPLATE_IN_USE]
is the name of the DOCTEMPLATE definition that uses the same TEMPLATE_NAME as the resource being defined.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID, DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_RESOURCE_TYPE
DISASTER DIRECTORY_ERROR
EXCEPTION
GETMAIN_FAILED
NAME_IN_USE
NOT_FOUND
DDNAME_NOT_FOUND
MEMBER_NOT_FOUND

DHTM gate, READ_TEMPLATE function

The READ_TEMPLATE function of the DHTM gate is used to read a named template into a buffer provided by the caller.

Input parameters

TEMPLATE_NAME
is the name of a previously installed document template.
TEMPLATE_BUFFER
is the buffer into which the template is to be read.

Output parameters

[DOCTEMPLATE]
is the name of the DOCTEMPLATE resource as it is known to RDO.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
DIRECTORY_ERROR
INVALID_RESOURCE_TYPE
EXCEPTION NOT_FOUND NOT_USABLE TRUNCATED

DHTM gate, INQUIRE_DOCTEMPLATE function

The INQUIRE_DOCTEMPLATE function of the DHTM gate returns information about a previously installed document template.

Input parameters

DOCTEMPLATE
is the name of the DOCTEMPLATE as known to RDO.

Output parameters

TEMPLATE_NAME
is the full name of the template as known outside RDO.
RESOURCE_TYPE
is the CICS or non-CICS resource type associated with the template. It can have one of the following values:
PDS_MEMBER|FILE|PROGRAM|TSQUEUE|TDQUEUE|EXITPGM
RESOURCE_NAME
is the name of the CICS or non-CICS resource.
DATASET
is the dataset name of the template PDS if the RESOURCE_TYPE indicates a PDS.
DDNAME
is the DDNAME of the template PDS if the RESOURCE_TYPE indicates a PDS.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER DIRECTORY_ERROR
EXCEPTION NOT_FOUND

DHTM gate, INQUIRE_TEMPLATE_STATUS function

The INQUIRE_TEMPLATE_STATUS function of the DHTM gate is used to inquire the install status of one or more templates.

Input parameters

TEMPLATE_NAME_LIST
is a list of template names whose install status is sought.
TEMPLATE_STATUS_LIST
is a list of install status indicators for the templates named in the TEMPLATE_NAME_LIST

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DHTM gate, DELETE_DOCTEMPLATE function

The DELETE_DOCTEMPLATE function of the DHTM gate deletes a previously installed DOCTEMPLATE.

Input parameters

DOCTEMPLATE
is the name of the DOCTEMPLATE as known to RDO.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER DIRECTORY_ERROR
EXCEPTION NOT_FOUND

DHTM gate, START_BROWSE function

The START_BROWSE function of the DHTM gate is used to initiate a browse of installed DOCTEMPLATE definitions.

Output parameters

BROWSE_TOKEN
is a token identifying this DOCTEMPLATE browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DHTM gate, GET_NEXT function

The GET_NEXT function of the DHTM gate returns information about the next installed DOCTEMPLATE in the browse.

Input parameters

BROWSE_TOKEN
is the token identifying this browse of the DOCTEMPLATE definitions.

Output parameters

DOCTEMPLATE
is the name of the DOCTEMPLATE as known to RDO.
TEMPLATE_NAME
is the full name of the template as known outside RDO.
RESOURCE_TYPE
is the CICS or non-CICS resource type associated with the template. It can have one of the following values:
PDS_MEMBER|FILE|PROGRAM|TSQUEUE|TDQUEUE|EXITPGM
RESOURCE_NAME
is the name of the CICS or non-CICS resource.
DATASET
is the dataset name of the template PDS if the RESOURCE_TYPE indicates a PDS.
DDNAME
is the DDNAME of the template PDS if the RESOURCE_TYPE indicates a PDS.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_BROWSE_TOKEN
EXCEPTION BROWSE_END

DHTM gate, END_BROWSE function

The END_BROWSE function of the DHTM gate is used to terminate a browse of installed DOCTEMPLATE definitions.

Input parameters

BROWSE_TOKEN
is the token identifying this browse of the DOCTEMPLATE definitions.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_BROWSE_TOKEN

DHRP gate, RECOVER_DEFINITIONS function

The RECOVER_DEFINITIONS function of the DHRP gate is used to purge/recover DOCTEMPLATE definitions from the global catalog depending upon the CICS start type.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
INVALID_BROWSE_TOKEN
CATALOG_BROWSE_FAILURE
CATALOG_PURGE_FAILURE
LOGIC_ERROR
WAIT_PHASE_FAILURE
ABEND
[[ Contents Previous Page | Next Page Index ]]