INQUIRE XMLTRANSFORM

Description

Use the INQUIRE XMLTRANSFORM command to retrieve information about an installed XMLTRANSFORM resource. This information can include the state of the XMLTRANSFORM resource and details about the conditions under which the XMLTRANSFORM resource was installed, such as which mapping level was used.

Browsing

You can browse through all the XMLTRANSFORM resources installed in your system by using the browse options, START, NEXT, and END, on the INQUIRE XMLTRANSFORM command.

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

BUNDLE(data-area)

Returns the 8-character name of the bundle from which the XMLTRANSFORM was installed.

CCSID(data-area)

Returns the coded character set identifier (CCSID) that is used to encode the character data in the application data structure at run time. This value is set using the optional CCSID parameter in the XML assistant when the XML binding file is generated. The CCSID is a value of up to 8 characters. If CCSID value is not specified, CICS® uses the default CCSID that is specified by the LOCALCCSID system initialization parameter.

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 an ATOMSERVICE resource.

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.

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.

ENABLESTATUS(cvda)

Returns a CVDA indicating the state of the XMLTRANSFORM.

DISCARDING

A DISCARD command has been issued for the XMLTRANSFORM.

ENABLING

The XMLTRANSFORM is in the process of being enabled.

ENABLED

The XMLTRANSFORM is enabled and available for use.

DISABLING

The XMLTRANSFORM is in the process of being disabled. It is not available for further use, but inflight activity will be allowed to complete.

DISABLED

The XMLTRANSFORM is disabled and is not available for use.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. The possible values are as follows:

BUNDLE

The resource was installed by a bundle deployment.

DYNAMIC

The resource was installed by an ATOMSERVICE resource.

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.

MAPPINGLEVEL(data-area)

Returns an 8-byte character string of the mapping level that was used when the XML binding file was produced. The value of the mapping level is 1.0, 1.1, 1.2, 2.0, 2.1, 2.2, 3.0, 4.0, or 4.1.

MAPPINGRNUM(data-area)

Returns a fullword binary value of the release number for the mapping level that was used when the XML binding file was produced. The value of the release number is 0, 1, or, 2.

MAPPINGVNUM(data-area)

Returns a fullword binary value of the version number for the mapping level that was used when the XML binding file was produced. The value of the version number is 1, 2, 3, or 4.

MINRUNLEVEL(data-area)

Returns an 8-byte character string of the minimum runtime level that is required to install the XMLTRANSFORM in CICS. The value of the runtime level is 3.0, 4.0, or 4.1.

MINRUNRNUM(data-area)

Returns a fullword binary value for the release number for the minimum runtime level that is required to install the XMLTRANSFORM in CICS. The value of the release number is 0, or 1.

MINRUNVNUM(data-area)

Returns a fullword binary value for the version number for the minimum runtime level that is required to install the XMLTRANSFORM in CICS. The value of the version number is 3, or 4.

VALIDATIONST(cvda)

Indicates whether full validation is enabled for the XMLTRANSFORM resource. CVDA values are as follows:

VALIDATION

Full validation is enabled.

NOVALIDATION

Full validation is disabled.

Because validating an XML message against its schema incurs considerable processing overhead, typically you will specify VALIDATIONST(NOVALIDATION). If VALIDATIONST(NOVALIDATION) is specified, checking is performed to ensure that the message contains well-formed XML, but with no guarantee that the XML is valid.

Full validation ensures that the XML in the message is valid with respect to the XML schema; you might want to specify VALIDATIONST(VALIDATION) when you are developing an application.

XMLTRANSFORM(data-value)

Specifies the 1- to 32-character name of the XMLTRANSFORM about which you are inquiring.

XMLSCHEMA(data-area)

Returns the name of the associated XML schema file. The data area is 255 characters long. If the name is shorter than 255 characters, CICS pads the data area with trailing blanks.

XSDBIND(data-area)

Returns the name of the XML binding file. The data area is 255 characters long. If the name is shorter than 255 characters, CICS pads the data area with trailing blanks.

Conditions

NOTAUTH

RESP2 values are:

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 particular resource in the way required by this command.

NOTFND

RESP2 values are:

3

The XMLTRANSFORM cannot be found.