Atom element reference for CICS
These tables provide a reference for the relationships between the elements used in an Atom feed document; the elements used in an Atom entry element; the attributes of the <cics:fieldnames> element; and the parameters that CICS can pass to a service routine for resource handling.
When you create an Atom feed document in CICS, you can specify the elements that are defined by the Atom format specification in RFC 4287. Some of these elements are used as child elements of the <atom:feed> element to supply metadata for the whole of the Atom feed, such as the title for the feed. Some of the elements are used as child elements of an <atom:entry> element to supply metadata or content for an individual entry. The majority of the elements are specified for the feed and specified again for the individual entries; for example, each entry has a unique identifier specified by the <atom:id> element, and the feed also has a unique identifier. For the complete descriptions of each element, read RFC 4287.
In an Atom feed document in CICS, CICS uses a single prototype <atom:entry> element to generate the individual entries. If you specify child elements in this element, the metadata there applies to all entries by default. However, if the CICS resource that you are using to supply the content for the Atom feed contains suitable metadata, you can use attributes of the <cics:fieldnames> element to tell CICS if and where the data for the child elements is present in the resource record. For example, you can specify a field in the resource record that supplies the title for the entry that is contained in the resource record. If your resource records do not contain certain metadata, such as the author's name, you can omit that attribute for the <cics:fieldnames> element. CICS either supplies that item of metadata from the corresponding element in the prototype <atom:entry> element in the configuration file or omits it. If your resource records do not contain any suitable metadata, you can omit the <cics:fieldnames> element completely, and CICS publishes the whole of the resource record as the content of the entry.
The parameters that CICS passes to a service routine include parameters corresponding to the attributes of the <cics:fieldnames> element. You can use these resource handling parameters if you want to write a service routine that obtains its information about resource structures from the Atom configuration file, rather than having this information coded directly in the service routine. With this method, you can create a generic service routine that is capable of handling multiple resources.
| Element | Meaning | For feed | For entries | <cics:fieldnames> attribute (for entries) | Service routine parameter (for entries) |
|---|---|---|---|---|---|
| <app:edited> | Time when entry was last edited | Not used | Required if in collection, produced by CICS | edited | ATMP_ EDITED |
| <atom:author> | Principal author's details | Required unless all entries have this element | Optional if feed has this element | Not applicable (data is in child elements) | Not applicable (data is in child elements) |
| <atom:category> | Category classifying feed or entry | Optional | Optional | category | ATMP_ CATEGORY_ FLD |
| <atom:content type=" "> | Content of entry | Not used | Required | content, content_type | ATMP_ CONTENT_ FLD and ATMP_ CONTENT_ TYPE_FLD |
| <atom:contributor> | Subsidiary author's details | Optional | Optional | Not applicable (data is in child elements) | Not applicable (data is in child elements) |
| <atom:email> | Email address of author or contributor | Optional | Optional | email (for author only, contributors not supported) | ATMP_ EMAIL_ FLD |
| <atom:generator> | Agent that generates the feed | Produced by CICS | Not used | Not applicable (not used for entries) | Not applicable (not used for entries) |
| <atom:icon> | Icon representing feed | Optional | Not used | Not applicable (not used for entries) | Not applicable (not used for entries) |
| <atom:id> | Unique identifier for feed or entry | Required, CICS produces if you specify <cics: authority> element | Required, CICS produces if you specify <cics: authority> element | atomid | ATMP_ ID_ FLD |
| <atom:link rel="self"> | URL for retrieving feed or entry document | Required | Required by CICS | Not applicable (not stored in resource) | Not applicable (not stored in resource) |
| <atom:link rel="edit"> | URL for editing entry in a collection (Member URI) | CICS produces for collections | CICS produces if entry is in collection | Not applicable (not stored in resource) | Not applicable (not stored in resource) |
| <atom:logo> | Logo for feed | Optional | Not used | Not applicable (not used for entries) | Not applicable (not used for entries) |
| <atom:name> | Name of author or contributor | Required in author or contributor element | Required in author or contributor element | author (for author only, contributors not supported) | ATMP_ AUTHOR_ FLD |
| <atom:published> | Time when entry was first created or published | Not used | Optional | published | ATMP_ PUBLISHED_ FLD |
| <atom:rights> | Intellectual property rights for feed | Optional | Optional | Not supported in resource | Not supported in resource |
| <atom:source> | Metadata from use of the entry in another feed | Not used | Optional, but not supported by CICS | Not supported | Not supported |
| <atom:subtitle> | Subtitle for feed | Optional | Not used | Not applicable (not used for entries) | Not applicable (not used for entries) |
| <atom:summary> | Short description of entry content | Not used | Required if content not text or XML | summary | ATMP_ SUMMARY_ FLD |
| <atom:title> | Title for feed | Required | Required | title | ATMP_ TITLE_ FLD |
| <atom:updated> | Time when feed was last updated | Required, produced by CICS | Required, produced by CICS | updated | ATMP_ UPDATED_ FLD |
| <atom:uri> | URL for author or contributor website | Optional | Optional | authoruri (for author only, contributors not supported) | ATMP_ AUTHORURI_ FLD |