INQUIRE DOCTEMPLATE

Description

Use the INQUIRE DOCTEMPLATE command to determine whether a particular DOCTEMPLATE resource definition is installed (defined in the current execution of your CICS system).

Browsing

You can also browse through all of the DOCTEMPLATE resource definitions installed in your system by using the browse options, START, NEXT, and END, on INQUIRE DOCTEMPLATE commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The resource signature

You can use this command to retrieve 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 BUNDLE, 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.

Options

APPENDCRLF(cvda)

Returns a CVDA value identifying whether CICS is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template. CVDA values are as follows:

APPEND

Delete trailing blanks from and append carriage-return line-feed to each logical record of the template.

NOAPPEND

Do not delete trailing blanks from or append carriage-return line-feed to each logical record of the template.

CACHESIZE(data-area)

Returns a fullword binary field giving 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.

CHANGEAGENT(cvda)

Returns a CVDA value that identifies the agent that made the last change to the resource definition. 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(data-area)

Returns a 4-digit number of the CICS release that was running when the resource definition was last changed.

CHANGETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.

CHANGEUSRID(data-area)

Returns the 8-character user ID that ran the change agent.

DDNAME(data-area)

Returns the 8-character DD name of the PDS containing the document template. The DD name applies only to a template of type PDS.

DEFINESOURCE(data-area)

Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.

DEFINETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was created.

DOCTEMPLATE(data-value)

Specifies the 8-character identifier of the DOCTEMPLATE resource definition about which you are inquiring.

DSNAME(data-area)

Returns the 44-character data set name of the PDS containing the document template. It applies only to a template of type PDS.

EXITPGM(data-area)

Returns the 8-character name of the exit program to be called when a request is made for this document template. The exit program is passed an architected commarea containing the address and length of a buffer into which the exit program returns the template.

FILE(data-area)

Returns the 8-character name of the CICS file definition for the data set containing the document template.

HFSFILE(data-area)

Returns the fully qualified name of the z/OS® UNIX System Services file where the document template resides. This name can be up to 255 characters in length.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. 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(data-area)

Returns an ABSTIME value that represents the time stamp when the resource was installed.

INSTALLUSRID(data-area)

Returns the 8-character user ID that installed the resource.

MEMBER(data-area)

Returns the 8-character name of the member in the PDS containing the document template. MEMBER applies only to a template of type PDS.

PROGRAM(data-area)

Returns the 8-character name of the program in which the document template data is stored. CICS loads the program and takes all data after the entry point to be the template.

TDQUEUE(data-area)

Returns the 4-character name of the TD queue on which the document template is stored.

TEMPLATENAME(data-area)

Returns the extended template name by which the document template is to be known outside the resource definition function; that is, the TEMPLATENAME attribute of the DOCTEMPLATE resource definition. The name can be up to 48 characters long.

TEMPLATETYPE(cvda)

returns a CVDA value identifying the type of the source of this document template. CVDA values are as follows:

EXIT

An exit program

FILE

A CICS file name for a data set

HFSFILE

A z/OS UNIX System Services file

PDSMEMBER

A name of the member in the PDS described in DDNAME

PROGRAM

A program

TDQ

A TD queue

TSQ

A TS queue

TSQUEUE(data-area)

Returns the 16-character name of the TS queue on which the document template is stored.

TYPE(data-area)

Returns a CVDA value identifying the format of the template contents. CVDA values are as follows:

BINARY

EBCDIC

Conditions

END

RESP2 values:

2

There are no more resource definitions of this type.

ILLOGIC

RESP2 values:

1

You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.

NOTAUTH

RESP2 values:

100

The user associated with the issuing task is not authorized to use this command.

101

The user associated with the issuing task is not authorized to access this DOCTEMPLATE resource definition in the way required by this command.

NOTFND

RESP2 values:

1

The DOCTEMPLATE specified cannot be found.