Editing an Atom configuration file

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.

Before you begin

You must have an Atom configuration file in a bundle project in the Project Explorer view in CICS Explorer.

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

  1. Ensure that the Atom configuration file is open in the Atom configuration editor. If it is not, double-click the file to open it.
  2. 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 following table describes the additional fields in the Atom configuration editor.
    Option Description
    Root XML element The name of the top-level data structure in the XML binding. This attribute must be defined if you have 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 stated 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 that entered 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 clear this field, a URIMAP must already exist in the CICS region.
    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 The user ID under which the alias transaction is attached. The ID specified in this field is overridden by the authenticated user ID that is obtained from the web client. If no user ID is specified in either way, the CICS default user ID is used.
  3. Click the Save icon to save your changes.

Results

The Atom configuration file is updated with the changes made using the editor.

What to do next

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. The Atom configuration editor is only a basic starter editor and does not support all the possible attributes in an Atom configuration file. For further information on additional attributes that can be added to Atom configuration files, see Creating an Atom configuration file. 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. For more information see Deploying a CICS bundle or the following related links.