CEMT INQUIRE DOCTEMPLATE
Retrieves information about a DOCTEMPLATE resource definition for a CICS® document template.
In the CICS Explorer, the Document templates operations view provides a functional equivalent to this command.
Description
INQUIRE DOCTEMPLATE returns information about any currently installed document templates.
The resource signature
You can use this command to display the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Auditing resources. The resource signature fields are CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.
Input
Press the Clear key to clear the screen, and type CEMT INQUIRE DOCTEMPLATE (or suitable abbreviations for the keywords). The resulting display lists the names and status of any document templates. You cannot change the displayed information.
Displayed fields
- APPENDCRLF
- Returns
whether CICS deletes trailing
blanks from, and appends carriage-return line-feed to, each logical
record of the template.
- APPEND
- Append carriage-return and line-feed.
- NOAPPEND
- Do not append carriage-return and line-feed.
- CHANGEAGENT(value)
- Displays a value that identifies the agent that made the last change to the resource definition.
You cannot use CEMT to filter on some of these values because they are duplicated. The possible
values are as follows:
- CREATESPI
- The resource definition was last changed by an EXEC CICS CREATE command.
- CSDAPI
- The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.
- CSDBATCH
- The resource definition was last changed by a DFHCSDUP job.
- DREPAPI
- The resource definition was last changed by a CICSPlex SM BAS API command.
- DYNAMIC
- The resource was defined by the CICS system for a template being used through the CICS template manager, DFHWBTL.
- CHANGEAGREL(value)
- Displays the 4-digit number of the CICS release that was running when the resource definition was last changed.
- CHANGETIME(date time)
- Displays the date and time when the resource definition was last changed. The format of the date depends on the value that you selected for the DATFORM system initialization parameter for your CICS region. The format of the time is hh:mm:ss.
- CHANGEUSRID(value)
- Displays the 8-character user ID that ran the change agent.
- DDNAME
- Returns the DD name of the PDS containing the template. The DD name applies only to a template of type PDS. If a member name is supplied without a value for DDNAME, the default value DFHHTML is used.
- DEFINESOURCE(value)
- Displays the source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT option. For details, see Summary of the resource signature field values.
- DEFINETIME(date time)
- Displays the date and time when the resource was created. The format of the date depends on the value that you selected for the DATFORM system initialization parameter for your CICS region. The format of the time is hh:mm:ss.
- DOCTEMPLATE
- Returns the name of this DOCTEMPLATE resource definition.
- DSNAME
- Returns the DS name of the PDS containing the template.
- HFSFILE
- Returns the fully qualified name of the z/OS® UNIX file in which the template resides. The HFSFILE attribute applies only to a template of type zFS. It can be up to 255 characters in length.
- INSTALLAGENT(value)
- Displays a value that identifies the agent that installed the resource. You cannot use CEMT to
filter on some of these values because they are duplicated. The possible values are as follows:
- CREATESPI
- The resource was installed by an EXEC CICS CREATE command.
- CSDAPI
- The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.
- DYNAMIC
- The resource was installed by the CICS system for a template being used through the CICS template manager, DFHWBTL.
- GRPLIST
- The resource was installed by GRPLIST INSTALL.
- INSTALLTIME(date time)
- Displays the date and time when the resource was installed. The format of the date depends on the value that you selected for the DATFORM system initialization parameter for your CICS region. The format of the time is hh:mm:ss.
- INSTALLUSRID(value)
- Displays the 8-character user ID that installed the resource.
- NAME
- Returns the name of the location defined in TEMPLATETYPE.
- SIZE
- Returns the amount of storage, in bytes, used by the cached copy of the document template. A value of zero is returned if there is no cached copy of the template at the time of the inquiry.
- TEMPLATENAME
- Returns the extended template name by which the document template is known outside the resource definition function (the TEMPLATENAME attribute of the DOCTEMPLATE resource definition).
- TEMPLATETYPE
- Returns
the type of resource with the name returned in NAME.
- EXITPGM
- An exit program.
- FILE
- A CICS file name for a data set.
- zFS
- A z/OS UNIX file.
- MEMBER
- A name of the member in the PDS described in DDNAME.
- PROGRAM
- A program.
- TDQUEUE
- A TD queue.
- TSQUEUE
- A TS queue.
- TYPE
- Returns
the format of the template contents.
- BINARY
- When the template is loaded from the template library, no parsing of the template contents takes place.
- EBCDIC
- When the template is loaded from the template library, the contents are parsed as EBCDIC text.