IBM Support

CA8K: CICS TS for z/OS: Delivering Atom feeds from CICS

Downloadable files


This SupportPac provides sample code to demonstrate how to generate Atom feeds to publish data contained within CICS resources or obtained by running a CICS application.

Download Description

Atom is a protocol for publishing syndicated feeds and similar documents over HTTP. It is described in the following Request For Comment (RFC) documents:

If you have CICS Transaction Server for z/OS (CICS TS) V4.1 or higher, you will no longer need this SupportPac because CICS provides support for Atom feeds within the base code. See Atom feeds from CICS in the CICS TS V4.1 information center for more details.

This SupportPac provides sample code to do the following in CICS TS V3.2 and V3.1:
  • Generate Atom feed documents and Atom entry documents in response to HTTP requests directed to CICS.
  • Configure a CICS PIPELINE definition to map HTTP requests into requests to access particular CICS resources. The requests may conform to the REST style, in which URLs identify specific resources. The four HTTP methods correspond to specific operations on the resources:
    • GET retrieves an item from the resource
    • POST creates a new item within the resource
    • PUT updates an existing item within the resource
    • DELETE deletes an item within the resource.

There are specific interfaces to interact with CICS Temporary Storage queues. There are also interfaces that link to customized service routines that can be used to access other resources and services within CICS, including an example that accesses the CICS sample file FILEA.

This SupportPac consists of the following sample programs:

A High Level Assembler (HLASM) program that runs as a terminal handler program in a non-SOAP provider-mode pipeline to deliver Atom feeds and Atom entries. It reads specific Atom metadata from the PIPELINE configuration file and drives an auxiliary service program to construct the Atom content element.

A HLASM program that runs as an auxiliary service program for DFH$W2FD specifically to interact with an arbitrary CICS Temporary Storage queue, whose characteristics are described in the PIPELINE configuration file.

A COBOL program that runs as an auxiliary service program for DFH$W2FD and serves as an example of how to interact with other resources. This sample interacts specifically with the sample CICS file known as FILEA.

A HLASM program that suggests how you might construct an Atom Publishing Protocol service document using data from the a PIPELINE configuration file.

The SupportPac also contains a JavaScript program dfh$w2w2.js that can be used to generate Atom requests into CICS from a Web browser, using Ajax technology, and sample HTML pages that can be used to drive that JavaScript.

Possible uses:
This SupportPac allows you to investigate the provision of feeds containing CICS data to external requesters using REST protocols. These might include feed aggregator applications, or mashup services on highly dynamic Web pages.

Skill level required:
Users of this SupportPac must:
  • Be able to use HLASM to assemble sample programs
  • Be able to modify and compile COBOL sample programs
  • Be familiar with CICS Web Support
  • Understand the requirements of the Atom protocol
  • Be familiar with creating HFS files and configuring PIPELINE definitions

Author: CICS Development, IBM Hursley Park, UK.
Category: 2
Released: 20Mar08
Current Version: 1.0

An IBM teleconference was broadcast on June 11, 2008, entitled "Extending SOA and CICS with Web 2.0". This teleconference explained how, with SupportPac CA8K, you can use existing CICS Web support facilities to deliver atom feeds containing data from CICS. To listen to the replay, go to Education replay: Extending SOA and CICS with Web 2.0.


CICS Transaction Server for z/OS (CICS TS) V3.1 or V3.2

  • PTF UK34429 on CICS TS V3.1 or PTF UK34459 on CICS TS V3.2, for APAR PK58721
  • PTF UA31443 on z/OS V1.7, for APAR OA16303, or a later release of z/OS
  • High Level Assembler V1.5.0
  • IBM Enterprise COBOL for z/OS V3

Installation Instructions

1. Unzip the file to a suitable directory on your workstation.

2. Use the File Transfer Program (FTP) to transfer the files to the z/OS UNIX system where your CICS region runs.

  1. Transfer the files in the images and pdf directories as binary files.
  2. Transfer all other files in character format.
  3. Transfer the files load/ca8k.unload and load/ca8k.uncopy as z/OS sequential files, by entering the following commands (where userid is replaced with your own z/OS user ID):

    cd //userid
    quote site blksize=3120 lrecl=80 recfm=FB
    put ca8k.unload
    put ca8k.uncopy

3. Use the TSO RECEIVE command to reload the ca8k.unload and ca8k.uncopy files:


Entering these commands reconstructs the CA8K.LOAD and CA8K.COPYLIB libraries.

4. Edit the source/dfh$web2.dat.

The dfh$web2.dat file contains definitions for the SupportPac sample programs and CICS resources in the DFH$WEB2 RDO group. The definitions in the file contain several references to subdirectories of /u/uuuuuuuu/supportpac/ca8k/. Before using this file as input to DFHCSDUP, you should edit these instances to match the directories into which you have actually installed the SupportPac files with FTP in the steps described above. Ensure that the HOSTCODEPAGE specification for character format files matches the actual codepage of the uploaded files, especially for the JavaScript file.

5. Use the contents of source/dfh$web2.dat file as input to the DFHCSDUP utility to create the required resource definitions.

6. Refer to the ca8k.pdf file for more details about this SupportPac.

Download package

Download RELEASE DATE LANGUAGE SIZE(Bytes) Download Options 20/03/2008 US English 491000 HTTP
ca8k.pdf 20/03/2008 US English 293000 FTP

Technical support

Category 2 SupportPacs are provided in good faith and AS-IS. There is no warranty or further service implied or committed and any supplied sample code is not supported by IBM product service channels.

Please read the license file that accompanies the SupportPac, to determine if you want to use it.

Other CICS SupportPacs
To view the complete portfolio of CICS SupportPacs, go to the CICS SupportPacs Home Page

Product Alias/Synonym

CICS/TS CICS TS CICS Transaction Server

Document information

More support for: CICS Transaction Server
CICS Web support

Software version: 3.1, 3.2

Operating system(s): z/OS

Reference #: 4018619

Modified date: 30 June 2008

Translate this page: