Document templates: Resource statistics

You can access document templates resource statistics by using the EXEC CICS EXTRACT STATISTICS DOCTEMPLATE command. They are mapped by the DFHDHDDS DSECT. The resource information gives details of various attribute settings of each DOCTEMPLATE resource, and the usage of the document template.

Table 1. Document templates: Resource statistics
DFHSTUP name	Field name	Description
DOCTEMPLATE name	DHD_DOCTEMPLATE_NAME	The name of the DOCTEMPLATE resource definition. Reset characteristic: not reset
Template name	DHD_TEMPLATE_NAME	The name by which the template is known to application programs (the TEMPLATENAME attribute in the DOCTEMPLATE resource definition). Reset characteristic: not reset
Append crlf	DHD_APPEND_CRLF	Whether CICS® appends carriage-return line-feed to each logical record of the template. Reset characteristic: not reset
Template contents	DHD_TEMPLATE_CONTENTS	The format of the contents of the template, either binary or EBCDIC. Reset characteristic: not reset
Template type	DHD_TEMPLATE_TYPE	The type for the source of the document template, which can be an exit program, a CICS file name for a data set, an zFS file, a member of a PDS, a program, a transient data queue, or a temporary storage queue. Reset characteristic: not reset
Template type name	DHD_TEMPLATE_EXIT_PROGRAM DHD_TEMPLATE_FILE_NAME DHD_TEMPLATE_PROGRAM_NAME DHD_TEMPLATE_PDS_MEMBER DHD_TEMPLATE_TDQUEUE DHD_TEMPLATE_TSQUEUE DHD_TEMPLATE_HFSFILE	The name for the source of the document template, such as a program name or zFS file name. Reset characteristic: not reset
Template cache size	DHD_TEMPLATE_CACHE_SIZE	The amount of storage required for a cached copy of the document template. Before the first use of the template, this field is zero. This field is always zero for templates in a CICS program, which are never cached, and for templates in an exit program if they are not specified for caching. Reset characteristic: not reset
Use count	DHD_TEMPLATE_USE_COUNT	The total number of times the document template was referenced for any reason. Reset characteristic: reset to zero
Newcopy count	DHD_TEMPLATE_NEWCOPIES	The number of times the SET DOCTEMPLATE NEWCOPY command was issued for this document template. Reset characteristic: reset to zero
Read count	DHD_TEMPLATE_READ_COUNT	The number of times the document template was read from the source. This read happens on the first use, including the first reference after deletion from the cache, or by a SET DOCTEMPLATE NEWCOPY command. Reset characteristic: reset to zero
Cache copy used	DHD_TEMPLATE_CACHE_USED	The number of times an application used the cached copy of the document template. Reset characteristic: reset to zero
Cache copy deleted	DHD_TEMPLATE_CACHE_DELETED	The number of times the cached copy of the document template was deleted because of a short-on-storage condition. Reset characteristic: reset to zero
Not in DFHSTUP report	DHD_TEMPLATE_DEFINE_SOURCE	The source of the resource definition. Its value depends on the change agent. For more information, see Summary of the resource signature field values. Reset characteristic: not reset
Not in DFHSTUP report	DHD_TEMPLATE_CHANGE_TIME	The time stamp (STCK) in local time of the CSD record change. Reset characteristic: not reset
Not in DFHSTUP report	DHD_TEMPLATE_CHANGE_USERID	The user ID that ran the CHANGE_AGENT. Reset characteristic: not reset
Not in DFHSTUP report	DHD_TEMPLATE_CHANGE_AGENT	The agent that was used to make the last change. Reset characteristic: not reset
Not in DFHSTUP report	DHD_TEMPLATE_INSTALL_AGENT	The agent that installed the resource. Reset characteristic: not reset
Not in DFHSTUP report	DHD_TEMPLATE_INSTALL_TIME	The time stamp (STCK) in local time when the resource was installed. Reset characteristic: not reset
Not in DFHSTUP report	DHD_TEMPLATE_INSTALL_USERID	The user ID that installed the resource. Reset characteristic: not reset

The resource statistics fields for the resource signature

The resource signature captures details about when the resource is defined, installed, and last changed. The resource statistics field names for the resource signature end in CHANGE_AGENT, CHANGE_TIME, CHANGE_USERID, DEFINE_SOURCE, INSTALL_AGENT, INSTALL_TIME, and INSTALL_USERID. For detailed information about the content of the resource signature fields, see Summary of the resource signature field values.