IBM Support

SupportPac CA1A: REST API for CICS Interdependency Analyzer for z/OS

Download


Abstract

SupportPac CA1A can be used to demonstrate how runtime data collected by the CICS IA host collectors can be exposed as REST endpoints. These can then be integrated into a web application and other client applications.

Download Description

IBM CICS Interdependency Analyzer for z/OS (CICS IA) produces runtime data collected from a CICS Application. The CICS IA plug-in visualizes that data in the form that is meaningful to the user. However, the integration of this data with other tools can be difficult to achieve. At present, users must accept whatever views and reports CICS IA provides by default.

REST endpoints to the data collected by CICS IA can make more sense in such integrations or by any application that would like to read the runtime data collected by CICS IA. JavaScript Object Notation (JSON) data is easy to parse and can be integrated into any tool that supports the HTTP protocol. Users can bring data together and build their own views and reports to meet their needs.

Benefits

  • Enables use of modern UI libraries for better visualization of data
  • REST API architecture enables loose-coupling between UI and business logic
  • Enables easy integration with other tools
  • Generation of complex reports is possible by using modern reporting frameworks
  • Create test cases for user applications based on the data collected by CICS IA

 

Important notes

  • This SupportPac is secured using JWT token-based authentication. Users are required to generate and provide a valid token with each API request to ensure authorized access.
  • The IBM Db2 Connect JARs are not included with this SupportPac. Users will need to reference the JARs that are part of the Db2 installation on IBM z/OS.

 

Skill level required

  • A basic understanding of CICS IA and the runtime data that it collects
  • Understanding of JSON and how to interpret the JSON data
  • Understanding of how to consume the API response from the existing application, if users want to integrate the CICS IA API into an existing project
  • A basic understanding of Apache Tomcat, its important configuration files, and how to configure it with the CICS IA REST API

 

Details
Category: 2 (non-warranted)
Released: January 29, 2021
Last release: October 28, 2025
Current Version: 1.1.0

Prerequisites

 

  • Apache Tomcat should be running on any machine where it is configured to connect with the CICS IA Db2 database
  • Db2 database schema contains the data collected by the CICS IA collector
  • Db2 Connect jars (db2jcc4.jar and db2jcc_license_cisuz.jar), which are present in the Db2 directory

 

Installation Instructions

To download the SupportPac:

  1. Click on the download link below save the file to your local machine.
  2. Extract the saved file to a temporary directory on your local machine. This will create the necessary installation, documentation, and license files.
  3. Follow the instructions in the included documentation to complete installation of this SupportPac on your host system.

[{"INLabel":"CA1A Installation and User Documentation","INLang":"US English","INSize":"426570 B","INURL":"https://public.dhe.ibm.com/software/htp/cics/support/supportpacs/individual/ca1a.pdf"}]
Off
[{"DNLabel":"CA1A.zip","DNDate":"28 Oct 2025","DNLang":"US English","DNSize":"42675155 B","DNPlat":{"label":"z/OS","code":"PF035"},"DNURL":"https://www14.software.ibm.com/cgi-bin/weblap/lap.pl?popup=Y&li_formnum=L-SPYZ-7EYDEE&accepted_url=https://public.dhe.ibm.com/software/htp/cics/support/supportpacs/individual/ca1a.zip","DNURL_FTP":"","DDURL":null}]

Technical Support

BY DOWNLOADING, INSTALLING, COPYING, ACCESSING, OR OTHERWISE USING THE FREE-OF-CHARGE SUPPORTPAC, YOU AGREE THAT THE SUPPORTPAC IS COPYRIGHTED AND LICENSED BY INTERNATIONAL BUSINESS MACHINES CORPORATION, OR ITS AFFILIATE, SOLELY FOR YOUR INTERNAL USE, AND IS NOT SOLD. THE SUPPORTPAC IS PROVIDED ‘AS IS’ WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IBM PRODUCT SUPPORT IS NOT OFFERED FOR THE SUPPORTPAC. OTHER IBM LICENSE TERMS MAY ALSO APPLY TO THE SUPPORTPAC AND IN THE EVENT (AND TO THE EXTENT ONLY) OF ANY CONFLICT, THOSE LICENSE TERMS WILL APPLY. IF YOU ARE ACCEPTING THESE TERMS ON BEHALF OF ANOTHER PERSON OR A COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT AND WARRANT THAT YOU HAVE FULL AUTHORITY TO BIND THAT PERSON, COMPANY, OR LEGAL ENTITY TO THESE TERMS. IF YOU DO NOT AGREE TO THESE TERMS:

  • DO NOT DOWNLOAD, INSTALL, COPY, ACCESS, CLICK ON AN "ACCEPT" BUTTON, OR USE THE SUPPORTPAC; AND
  • PROMPTLY DESTROY ALL COPIES OF THE SUPPORTPAC AND RELATED DOCUMENTATION.
 
To view the available collection of CICS SupportPacs, visit the CICS SupportPacs Home Page

[{"Type":"MASTER","Line of Business":{"code":"LOB70","label":"Z TPS"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSPPUS","label":"CICS Interdependency Analyzer for z\/OS"},"ARM Category":[{"code":"a8m0z0000001f6mAAA","label":"CICS Interdependency Analyzer"}],"ARM Case Number":"","Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"5.3.0;5.5.0;6.1.0"}]

Product Synonym

CICS IA CICS Interdependency Analyzer

Document Information

Modified date:
28 October 2025

UID

ibm16378374

Page Feedback