Document Templates report

The Document Templates report is produced using the EXEC CICS EXTRACT STATISTICS DOCTEMPLATE command and the EXEC CICS INQUIRE DOCTEMPLATE command. The statistics data is mapped by the DFHDHDDS DSECT.

Table 1. Fields in the Document Templates report
Field Heading	Description
DOCTEMPLATE Name	The name of the DOCTEMPLATE resource definition. Source field: EXEC CICS INQUIRE DOCTEMPLATE
Template Name	The name by which the template is known to application programs (the TEMPLATENAME attribute in the DOCTEMPLATE resource definition). Source field: DHD-TEMPLATE-NAME
Append crlf	Whether CICS appends carriage-return line-feed to each logical record of the template. Source field: DHD-APPEND-CRLF
Template contents	The format of the contents of the template, either binary or EBCDIC. Source field: DHD-TEMPLATE-CONTENTS
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. Source field: DHD-TEMPLATE-CACHE-SIZE
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, a zFS file, a member of a PDS, a program, a transient data queue, or a temporary storage queue. Source field: DHD-TEMPLATE-TYPE
[Template type] name	The name for the source of the document template, such as a program name or z/OS UNIX file name. Source field: one of 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
Data set name	Only for document templates of type "File". The name of the data set containing the document template. Source field: EXEC CICS INQUIRE FILE() DSNAME()
PDS Data set name	Only for document templates of type "PDS". The name of the partitioned data set containing the document template. Source field: EXEC CICS INQUIRE DOCTEMPLATE() DSNAME()
Use count	The total number of times the document template was referenced for any reason. Source field: DHD-TEMPLATE-USE-COUNT
Newcopy count	The number of times the SET DOCTEMPLATE NEWCOPY command was issued for this document template. Source field: DHD-TEMPLATE-NEWCOPIES
Read count	The number of times the document template was read from the source. This happens on the first use (including the first reference after deletion from the cache), or by a SET DOCTEMPLATE NEWCOPY command. Source field: DHD-TEMPLATE-READ-COUNT
Cache copy used	The number of times an application used the cached copy of the document template. Source field: DHD-TEMPLATE-CACHE-USED
Cache copy deleted	The number of times the cached copy of the document template was deleted because of a short-on-storage condition. Source field: DHD-TEMPLATE-CACHE-DELETED