ATOMSERVICE attributes

Describes the syntax and attributes of the ATOMSERVICE resource.

Syntax

Resource attributes

Attributes

ATOMSERVICE(name)

Specifies the 8-character name of this resource definition.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

ATOMTYPE({FEED|SERVICE|COLLECTION|CATEGORY})

Specifies the type of Atom document that is returned for this ATOMSERVICE definition.

CATEGORY: An Atom category document, which lists the categories for entries in a collection. You can set up a category document if you want to use the same categories to define multiple collections.
COLLECTION: An Atom collection document, which contains a group of Atom entries that can be edited by Web clients using HTTP POST, PUT, and DELETE requests, as well as being retrieved using HTTP GET requests. The Atom configuration file for a collection must begin with the root element <cics:atomservice type="collection">.
FEED: An Atom feed document, which describes the metadata for a feed, and contains Atom entries that provide data for the feed. An Atom feed can be retrieved using HTTP GET requests, but it cannot be edited by a Web client. The Atom configuration file for an Atom feed must begin with the root element <cics:atomservice type="feed">.
SERVICE: An Atom service document, which provides information about the editable collections that are available on a server.

BINDFILE(name)

Specifies the fully qualified (absolute) or relative name of an XML binding stored in z/OS® UNIX System Services. This attribute is not used for an Atom service or category document. You create an XML binding using the CICS® XML assistant program DFHLS2SC.

For resource types FILE and TSQUEUE, the XML binding is required, and it specifies the data structures used by the resource named in RESOURCENAME, which supplies the data for the Atom document.

For resource type PROGRAM, an XML binding is optional, and you create it using the resource that the program accesses to obtain the data for the Atom entries, not the program itself. You must specify an XML binding for resource type PROGRAM if you are using the resource handling parameters in the DFHATOMPARMS container to pass information from the Atom configuration file to the program. If you are not doing this, do not specify an XML binding.

The name of the XML binding can be specified as an absolute path including all directories and beginning with a slash, for example, /u/atom/atomictest.xsdbind. Alternatively, it can be specified as a path relative to the HOME directory of the CICS region user ID; for example, atom/atomictest.xsdbind (with no leading forward slash). Up to 255 characters can be used.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

CONFIGFILE(name)

Specifies the fully qualified (absolute) or relative name of an Atom configuration file stored in z/OS UNIX System Services. The Atom configuration file contains XML that specifies metadata and field names for the Atom document that is returned for this resource definition. For details, see Creating an Atom configuration file.

The name can be specified as an absolute path including all directories and beginning with a slash, for example, /u/atom/myfeed.xml. Alternatively, it can be specified as a path relative to the HOME directory of the CICS region user ID, for example, atom/myfeed.xml (with no leading forward slash). Up to 255 characters can be used.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

DESCRIPTION(text)

You can provide a description of the resource that you are defining in this field. The description text can be up to 58 characters in length. There are no restrictions on the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right parenthesis. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.

GROUP(groupname)

Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.

Acceptable characters: `A-Z 0-9 $ @ #` Any lowercase characters you enter are converted to uppercase.

The GROUP name can be up to eight characters in length. Lowercase characters are treated as uppercase characters.

RESOURCENAME(name)

Specifies the 1 - 16 character name of the CICS resource that provides the data for this Atom feed or collection. If the data for your Atom entries is held in a resource that is accessed by a service routine, specify the name of the service routine here. This attribute is not used for an Atom service or category document.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

RESOURCETYPE({FILE|PROGRAM|TSQUEUE})

Specifies the type of CICS resource that holds the data for this Atom feed or collection. This attribute is not used for an Atom service or category document. TSQUEUE is the default for this attribute.

FILE: A CICS file. A single record in the file provides the data for a single Atom entry. A file that holds Atom entries must have a unique key for the records, and you cannot use an alternate index file that has been defined with the NONUNIQUEKEY attribute. You can use any type of VSAM file to hold Atom entries, but note that ESDS (entry-sequenced data set) files are not suitable for a feed that you might want to set up as an editable collection, because you cannot delete records in an ESDS. You cannot use a BDAM file.
PROGRAM: A service routine, which is a CICS application program written to supply content for Atom entries.
TSQUEUE: A temporary storage queue. A single record in the temporary storage queue provides the data for a single Atom entry.

STATUS({ENABLED|DISABLED})

Indicates whether the Atom document specified by this resource definition is available or unavailable.