<cics:fieldnames> element

Contained by:

• <cics:resource> element

Attributes

To support the use of the <cics:fieldnames> element, you must have an XML binding for the resource that contains the data for your Atom entries. Generate mappings from language structures explains how to create this. In the <cics:fieldnames> element, specify the names of the fields using the XML names that are produced by the CICS XML assistant when you create the XML binding, not the original field names as stated in the high-level language structure, or copybook, that describes the structure of the resource.

For CICS resource types of files or temporary storage queues where CICS extracts the data for the Atom entries directly from the resource, you must use the <cics:fieldnames> element if the records in your file or temporary storage queue include any fields that hold metadata for the Atom entries, such as titles or time stamps. If your records contain any metadata, add the <cics:fieldnames> element, and use the attributes of the element to specify the fields in the records in your CICS resource that provide metadata for the Atom entries. If the records in your CICS resource contain only the content of the entries and do not have any metadata, omit the <cics:fieldnames> element.

If you are using a program, known as a service routine, to provide the Atom entries, add the <cics:fieldnames> element if you are using the resource handling parameters in the DFHATOMPARMS container to pass the field names to the program. Use the attributes of the element to name the fields in the records in the resource that the program accesses to obtain metadata and content for the Atom entries. You must have an XML binding for the resource in order to do this. If your program holds its own information about the resource structure and does not use the resource handling parameters, omit the <cics:fieldnames> element.

All of the attributes of the <cics:fieldnames> element are optional. If you do not specify a particular attribute, such as the author's name, CICS either supplies that item of metadata from the corresponding element in the <atom:entry> element in the configuration file or omits it. If you omit all the attributes, you can also omit the <cics:fieldnames> element.

atomid="fieldname"

The name of a field in the resource record that contains the unique identifier for the Atom entry.

author="fieldname"

The name of a field in the resource record that contains the personal name of the principal author of the Atom entry. You cannot provide the details of additional authors or contributors from fields in the CICS resource record. You can provide these in the <atom:feed> element in the configuration file, but they apply to all the entries. If you provide author details from the CICS resource using the <cics:fieldnames> element, and also specify one or more instances of <atom:author> in the configuration file, the author details from the CICS resource are placed before the author details from the configuration file.

authoruri="fieldname"

The name of a field in the resource record that contains a URL associated with the principal author of the Atom entry, such as a blog site or a company website.

category="fieldname"

The name of a field in the resource record that contains a category that classifies the entry.

content="fieldname"

The name of a field in the resource record that contains the entire content to be published in the Atom entry. The name can be that of a substructure within the record, in which case the whole substructure is propagated into the published content as an XML element with child elements, if necessary. If you omit this attribute, CICS publishes the whole of the resource record as the content of the entry.

content_type="fieldname"

The name of a field in the resource record that contains the media type for the content of the Atom entry.

edited="fieldname"

The name of a field in the resource record that contains the timestamp that indicates when the record was last edited. The data type of the named field is obtained from the description in the XML binding specified by the BINDFILE attribute of the ATOMSERVICE resource definition. If the named field is a character string of length at least 20, CICS assumes that it contains a timestamp in the XML dateTime format, as described in RFC 3339; for example, "2008-05-20T11:39:50.325Z". If the named field is a packed decimal field of length 8, and the optional DATETIME=PACKED15 parameter was used when the XML binding was prepared, CICS assumes that the field contains a CICS ABSTIME value.

email="fieldname"

The name of a field in the resource record that contains the e-mail address of the principal author of the Atom entry.

published="fieldname"

The name of a field in the resource record that contains the timestamp or ABSTIME value that that indicates when the record was first published. CICS identifies the format of the data in the same way as for the edited attribute.

title="fieldname"

The name of a field in the resource record that contains the title for the Atom entry.

summary="fieldname"

The name of a field in the resource record that contains the summary for the Atom entry.

updated="fieldname"

The name of a field in the resource record that contains the timestamp or ABSTIME value that indicates when the record was last updated. CICS identifies the format of the data in the same way as for the edited attribute.