You use the Atom configuration editor in CICS Explorer® to amend existing data
or add additional data to Atom configuration files. You update or
add information in the editor, save the changes, and the XML of the
Atom configuration file is updated.
About this task
The Atom configuration editor is the default editor for editing
Atom configuration files. If you use this editor you have to enter
only the attribute values, because the editor creates the XML automatically.
Alternatively, you can use a text editor to edit the XML directly.
The following steps describe how to edit an Atom configuration file
using the Atom configuration editor.
Procedure
Double-click the Atom configuration file in the Project
Explorer in CICS Explorer.
By default, the file opens in the Atom configuration editor.
Enter the values for the additional attributes listed in
the editor. Alternatively, you can edit the fields that have been
populated by the Atom configuration wizard. The Atom
wizard fields table describes the fields that are populated
by the Atom configuration wizard. Table 1 describes the additional
fields in the Atom configuration editor. Figure 1 shows the Atom
configuration editor in CICS
Explorer with all fields completed based on the XML elements
in the filea.xml sample Atom configuration file.
Table 1. Atom configuration editor
fields
Field
Description
Root XML Element
The name of the top-level data structure
in the XML binding. This optional attribute is only required if there
is more than one set of conversions in the XML binding.
Feed - Link URI
The complete path that a web client
can use to retrieve the Atom feed. The beginning of the path must
match the partial path stated in the URIMAP resource definition for
the Atom feed. You can omit the scheme and host components of the
URI, and specify only the path component. CICS adds the scheme and
host components to the URI when it returns the Atom feed to the client,
to comply with the Atom format specification.
Window Size
The default number of entries that
CICS returns in the Atom feed. If you leave this field blank, the
default window size of 8 is used. The window size applies only when
a web client makes a request using the feed link URI, or a navigation
URI for a partial list of Atom entries.
Entry - Link URI
A standard URI path that can be extended
to apply to any Atom entry documents, and that enables a web client
to retrieve these documents individually. The beginning of the path
must match the partial path that you specified in the URIMAP resource
definition for the Atom. The remainder of the standard path must be
different from the complete path specified in the feed link URI. You
can omit the scheme and host components of the URI, and specify only
the path component. CICS adds the scheme and host components to the
URI when it returns the Atom feed to the client, to comply with the
Atom format specification.
URI
The common partial path to the Atom
feed. The wizard populates this field with the same value as thatentered
in the Default URI field. The wizard then appends
the value with /*. If you use the value entered by
the wizard or enter a different URI, CICS creates the URIMAP resource
definition dynamically. If you want to use a URIMAP resource that
exists, you can clear this field, however, you must manage the URIMAP
resource manually.
Transaction ID
The name of an alias transaction for
the Atom feed. If you do not specify a transaction ID, the default
alias transaction ID for Atom feeds, CW2A, is used.
User ID
A
default user ID under which the alias transaction can be attached.
When authentication is required for the connection, so that CICS requests
an authenticated user ID directly from the client, the default user
ID is not used. The authenticated user ID of the client is used instead,
or if authentication fails, the request is rejected. If authentication
is not required and you do not supply a default user ID, the CICS
default user ID is used.
Figure 1. The Atom configuration editor in CICS Explorer with all fields completed
based on the XML elements in the filea.xml sample
Atom configuration file
Click the Save icon to save your
changes.
The following code shows the XML elements
generated by the Atom configuration editor with all fields completed
based on the filea.xml sample Atom configuration
file.
The Atom configuration file is updated with the changes
made using the editor.
What to do next
The Atom configuration editor is only a basic starter editor and does not support all the
possible attributes in an Atom configuration file. If you want to add attributes that are not
displayed in the Atom configuration editor, you must use an XML editor or a text editor. For more
information about the XML elements that can be configured for your Atom feed using an XML editor or
text editor, see Atom elements.
If no further
editing is required, you can either export the Bundle project as a
.zip file to the local file system for deployment to a CICS system,
or you can export the project directly to z/OS UNIX.