Input-only parameters in DFHATOMPARMS container

Each of the input-only parameters in the DFHATOMPARMS container is the address of a double word containing a pointer to an area and the current length of the data in the area. Your service routine must not change these pointers, lengths, or storage.

The parameters ending in FLD are used for handling resources. CICS uses these resource handling parameters to supply information about the fields in resource records to a CICS-supplied service routine that is handling a CICS resource such as a temporary storage queue. CICS obtains the names of the fields from the attributes that you specify for the <atom:content> element and the <cics:fieldnames> element in the Atom configuration file, and from the XML binding for the resource. You can use these 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. If you use these parameters, you must create an XML binding for the resource that contains the data.

ATMP_RESNAME

The name of the CICS resource that supplies the data for the Atom feed. For your service routine, this is always the name of the service routine. CICS requires this parameter for the CICS-supplied service routines that handle various resources directly. CICS obtains this information from the cics:resource attribute of the <atom:content> element.

ATMP_RESTYPE

The type of the CICS resource in uppercase. The resource type can be PROGRAM, TSQUEUE, or FILE. For your service routine, the resource type is always PROGRAM. CICS requires this parameter for the CICS-supplied service routines that handle various resources directly. CICS obtains this information from the cics:type attribute of the <atom:content> element.

ATMP_ATOMTYPE

The type of Atom document being processed, in lowercase. The value of the type string is feed, collection, or entry. feed indicates that the client has requested a number of entries from an Atom feed. collection indicates that the client has requested a listing of entries in a collection. entry indicates that the client has requested a single, specified Atom entry, in either a feed or a collection.

ATMP_HTTPMETH

The HTTP method for the client request, padded. The HTTP method is one of GET, POST, PUT, or DELETE.

ATMP_TAG_AUTHORITY

The authority name specified in the name attribute of the <cics:authority> element in the Atom configuration file. The authority name is a fully qualified domain name or email address that can be used to construct tag URIs. The authority name forms part of the prototype Atom ID if you have selected this format.

ATMP_TAG_DATE

The date specified in the date attribute of the <cics:authority> element in the Atom configuration file. The date is used with the authority name to construct tag URIs. The date forms part of the prototype Atom ID if you have selected this format.

ATMP_XMLTRANSFORM

The name of an XMLTRANSFORM resource. The XMLTRANSFORM resource is created when you produce the XML binding for a CICS resource and install an ATOMSERVICE resource definition that specifies it. The XMLTRANSFORM resource describes the layout of the records in the resource as an XML structure. If the length of this name is zero, no XML binding was created for the resource, and the service routine must perform its own mapping between the resource records and the elements of the Atom entries.

ATMP_ROOT_ELEMENT

The name of the root element of the XML structure that is mapped by the XMLTRANSFORM resource.

ATMP_MTYPEIN

The media type of the body of the web client's HTTP request. A request body is present only when the HTTP method, as specified by the ATMP_HTTPMETH parameter, is POST or PUT. The media type is always "application/atom+xml", which indicates an Atom entry. CICS passes the request body to the service routine in the DFHREQUEST container. GET and DELETE requests have no request body, so for these HTTP methods the pointer and length are both zero.

ATMP_MTYPEOUT

The media type for the expected content of the Atom entry, as specified in the type attribute of the <atom:content> element in the Atom configuration file for the Atom feed. As in RFC 4287, the media type "text" is used for plain text instead of the IANA media type "text/plain", "html" is used instead of "text/html", and "xhtml" is used instead of "application/xhtml+xml". If the Atom configuration file does not contain this information, CICS passes the default media type "application/xml" to the service routine. The service routine can use the media type to determine suitable markup for the data that it returns in the DFHATOMCONTENT container. If you are using the resource handling parameters and you have a field in your resource records to store a media type for individual Atom entries, the ATMP_CONTENT_TYPE_FLD parameter contains the name of this field.

ATMP_WINSIZE

The feed window size. The value is a numeric string that contains either the default number of entries to be returned in each feed or an alternative number of entries that the web client has requested. This parameter is for information only, because CICS makes a series of requests to the service routine for individual entries.

ATMP_ID_FLD

The name of a field in your resource records that contains the Atom ID of the Atom entry. CICS obtains the name of the field from the atomid attribute of the <cics:fieldnames> element in the Atom configuration file for the Atom feed. If CICS passes this information to the service routine, the service routine can use this named field to store or locate the Atom ID for the entry, and return it in the ATMP_ATOMID parameter. This data is used in the <atom:id> element for the entry.

ATMP_PUBLISHED_FLD

The name of a field in your resource records that contains the time when the resource was last published. CICS obtains the name of the field from the published attribute of the <cics:fieldnames> element in the Atom configuration file for the Atom feed. If CICS passes this information to the service routine, the service routine can use this named field to locate the value of the timestamp or ABSTIME value that can be used to construct the value returned in the ATMP_PUBLISHED parameter. This data is used in the <atom:published> element for the entry.

ATMP_UPDATED_FLD

The name of a field in your resource records that contains the time when the resource was last updated. CICS obtains the name of the field from the updated attribute of the <cics:fieldnames> element in the Atom configuration file for the Atom feed. If CICS passes this information to the service routine, the service routine can use this named field to locate the value of the timestamp or ABSTIME value that can be used to construct the value returned in the ATMP_UPDATED parameter. This data is used in the <atom:updated> element for the entry.

ATMP_EDITED_FLD

The name of a field in your resource records that contains the time when the resource was last edited. CICS obtains the name of the field from the edited attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the value of the timestamp or ABSTIME value that can be used to construct the value returned in the ATMP_EDITED parameter. This data is used in the <app:edited> element for the entry.

ATMP_TITLE_FLD

The name of a field in your resource records that contains the title of the requested Atom entry. CICS obtains the name of the field from the title attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the title for the entry and return it in the DFHATOMTITLE container. The data from the DFHATOMTITLE container is used in the <atom:title> element for the entry.

ATMP_SUMMARY_FLD

The name of a field in your resource records that contains the summary of the requested Atom entry. CICS obtains the name of the field from the summary attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the summary for the entry and return it in the DFHATOMSUMMARY container. The data from the DFHATOMSUMMARY container is used in the <atom:summary> element for the entry.

ATMP_CONTENT_FLD

The name of a field in your resource records that contains the whole content of the requested Atom entry. CICS obtains the name of the field from the content attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the content for the entry and return it in the DFHATOMCONTENT container. The data from the DFHATOMCONTENT container is used in the <atom:content> element for the entry.

ATMP_CONTENT_TYPE_FLD

The name of a field in your resource records that contains the media type for the content of the Atom entry, such as application/xml or text. As for the ATMP_MTYPEOUT parameter, the media types "text", "html", and "xhtml" are used in place of the full IANA media types. The media type is specified in the type attribute of the <atom:content> element for an Atom entry. CICS obtains the name of the field from the content_type attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the media type for the content and determine suitable markup for the content in the DFHATOMCONTENT container. If the resource records do not have a field to store the media type for the content of the Atom entry, the media type specified in the type attribute of the <atom:content> element in the Atom configuration file applies. CICS passes this media type to the service routine in the ATMP_MTYPEOUT parameter.

ATMP_CATEGORY_FLD

The name of a field in your resource records that contains a category term that applies to the requested Atom entry. CICS obtains the name of the field from the category attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the category and return it in the DFHATOMCATEGORY container. The data from the DFHATOMCATEGORY container is used in the <atom:category> element for the entry.

ATMP_AUTHOR_FLD

The name of a field in your resource records that contains the name of the principal author of the Atom entry. CICS obtains the name of the field from the author attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the author's name and return it in the DFHATOMAUTHOR container. The data from the DFHATOMAUTHOR container is used in the <atom:name> element for the entry.

ATMP_AUTHORURI_FLD

The name of a field in your resource records that contains the URI of a website associated with the principal author of the Atom entry. CICS obtains the name of the field from the authoruri attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the URI and return it in the DFHATOMAUTHORURI container. The data from the DFHATOMAUTHORURI container is used in the <atom:uri> element for the entry.

ATMP_EMAIL_FLD

The name of a field in your resource records that contains the email address of the principal author of the Atom entry. CICS obtains the name of the field from the email attribute of the <cics:fieldnames> element. If CICS passes this information to the service routine, the service routine can use this named field to locate the email address and return it in the DFHATOMEMAIL container. The data from the DFHATOMEMAIL container is used in the <atom:email> element for the entry.