INQUIRE ATOMSERVICE

Browsing

You can browse through all the ATOMSERVICE definitions installed in the region, using the browse options, START, NEXT, and END, on INQUIRE ATOMSERVICE commands.

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

ATOMSERVICE(data-value)

Specifies the name of the ATOMSERVICE resource about which you are inquiring. The name can be up to 8 characters in length.

ATOMTYPE(cvda)

Returns a CVDA value indicating the type of Atom document that is produced by this ATOMSERVICE definition. CVDA values are as follows:

CATEGORY

An Atom category document, which lists the categories of documents in a collection.

COLLECTION

An Atom collection document, which contains a group of entry documents that can be edited.

FEED

An Atom feed document, which describes the metadata for a feed and contains entry documents that provide data for the feed.

SERVICE

An Atom service document, which provides information about the collections of entry documents that are available on the server and can be added to or edited.

UNKNOWN

The ATOMTYPE cannot be determined, this is probably because the associated configuration file cannot be read.

BINDFILE(data-area)

Returns a 255-character data area containing the fully qualified (absolute) or relative name of the XML binding specified in this ATOMSERVICE definition. The XML binding is stored in z/OS® UNIX System Services, and it specifies the data structures used by the CICS resource that supplies the data for the Atom document that is returned for this resource definition. Service and category documents do not use an XML binding, so, if ATOMTYPE is SERVICE or CATEGORY, BINDFILE returns blanks.

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.

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.

CONFIGFILE(data-area)

Returns a 255-character data area containing the fully qualified (absolute) or relative name of the Atom configuration file specified in this ATOMSERVICE definition. The Atom configuration file is stored in z/OS UNIX System Services, and it contains XML that specifies metadata and content for the Atom document that is returned for this resource definition.

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 value indicating the status of this ATOMSERVICE definition. CVDA values are as follows:

ENABLED

The ATOMSERVICE definition is enabled.

DISABLED

The ATOMSERVICE definition is disabled. An ATOMSERVICE definition with this status can be discarded.

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.

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.

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.

RESOURCENAME(data-area)

Returns the 16-character name of the CICS resource that provides the data for this Atom feed or collection. This option does not apply for an Atom service or category document.

RESOURCETYPE(cvda)

Returns a CVDA value indicating the type of CICS resource that provides the data for this Atom feed or collection. This option does not apply for an Atom service or category document. CVDA values are as follows:

FILE

A CICS file.

PROGRAM

A service routine, which is a CICS application program written to supply content for Atom entries.

TSQUEUE

A temporary storage queue.

NOTAPPLIC

If the value of ATOMTYPE is SERVICE or CATEGORY, the resource type is not applicable.

URIMAP(data-area)

Returns the 8-character URIMAP name that indicates the URI associated with this ATOMSERVICE definition. If there is no auto-generated URIMAP associated with this ATOMSERVICE definition, this field is empty.

XMLTRANSFORM(data-area)

Returns the 32-character name of the XMLTRANSFORM resource associated with the ATOMSERVICE definition. If the value of ATOMTYPE is SERVICE or CATEGORY, this field is empty.

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

NOTFND

RESP2 values:

3

The ATOMSERVICE cannot be found.