IBM Support

CA1T: High availability exits for use with CICS TG



SupportPac CA1T provides sample CICS request exits to be used with IBM CICS Transaction Gateway (CICS TG), to create high availability and request validation rules

Download Description

SupportPac CA1T provides sample exits to enable a high availability infrastructure to be created quickly, using rules defined in a simple text based configuration file. On z/OS, a highly available Gateway group can be sysplex-wide, presenting a single entry point to external applications, backed by multiple Gateway daemons and CICS regions acting as together. These rules define a set of policies to validate and workload balance External Call Interface (ECI) requests across defined CICS servers, providing increased availability to CICS applications accessed from remote clients using the facilities of the CICS TG.

Version 1 of this SupportPac provides a set of sample CICS request exits to be used with the CICS Transaction Gateway for z/OS V7.2. Three different CICS request exit implementations are provided to perform either round-robin or failover-based workload balancing, or alternatively perform request validation. Only one CICS request exit can be deployed at any one time, and each exit must be configured using an HFS configuration file as described in the supplied documentation.

Version 3 of this SupportPac provides a combined validation and workload balancing infrastructure to be used with:
  • CICS Transaction Gateway for z/OS V8.0, or later
  • CICS Transaction Gateway for Multiplatforms V8.1, or later
  • CICS Transaction Gateway Desktop Edition V8.1, or later

Note: Version 3 of this SupportPac supersedes Version 2, but remains fully compatible. The same configuration file from CA1T V2.x can be used with CA1T V3.x.

Configuration is based on a flexible set of rules defined in a configuration file. On z/OS, the configuration file can reside either on HFS or in an MVS dataset. Rules for workload balancing can be generic per Gateway, based on server aliases, or on the payload type (for example, channel or commarea). Rules for request validation can be specified based on user IDs, transaction IDs, or program names, and operate as either a allowlist (INCLUSIVE) or blocklist (EXCLUSIVE). All rules can be dynamically updated while the Gateway daemon is running. A configurable retry interval is provided to improve the efficiency of request distribution when using workload balancing.

New in release V3.0.0:
  • EXCLUSIVE validation mode that allows ECI requests to be rejected based on user ID, transaction ID, or program name
  • Support for CICS TG for Multiplatforms V8.1, or later
  • Support for CICS TG Desktop Edition V8.1, or later

What's new in this release (V3.0.1)?
  • Added support for CICS TG V9.1

Possible Uses
Creation of CICS Transaction Gateway high availability configurations or request validation policies.

Skill level required
System administrator with understanding of the configuration of the CICS Transaction Gateway.

Authors: Andrew Smithson, Phil Wakelin, and Rob Jones. CICS TG Development, Hursley
Category: 2
Released: 16Jul10
Last updated: 29Sep14
Current Version: V3.0.1


Installation Instructions

To download the SupportPac, using secure HTTP:
    1. Click on the link below for the relevant version of the SupportPac and save the compressed 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":"CA1T V1.1 ReadMe PDF","INLang":"US English","INSize":"30499 B","INURL":""},{"INLabel":"CA1T V3.0.1 ReadMe PDF","INLang":"US English","INSize":"205486 B","INURL":""}]

Download Package

Two versions of this SupportPac are available*:
    • CA1T V1.x is compatible only with CICS TG for z/OS V7.2
    • CA1T V3.x is compatible only with CICS TG for z/OS, CICS TG Multiplatforms, and CICS TG Desktop Edition V8.0, or later.
*Note that Hypertext Transfer Protocol Secure (HTTPS) is used to transfer the files to your local machine. 

[{"DNLabel":"CA1T V1.1","DNDate":"21 May 2010","DNLang":"US English","DNSize":"129304 B","DNPlat":{"label":"z/OS","code":"PF035"},"DNURL":"","DNURL_FTP":"","DDURL":null},{"DNLabel":"CA1T V3.0.1","DNDate":"29 Sep 2014","DNLang":"US English","DNSize":"419112 B","DNPlat":{"label":"z/OS","code":"PF035"},"DNURL":"","DNURL_FTP":"","DDURL":null}]

Technical Support

SupportPacs in this category are available at no charge to all licensed users of the CICS family products on the platforms specified in the SupportPac description. These SupportPacs are provided "AS-IS" (under the terms and conditions of the IBM International License Agreement for Non-Warranted Programs and of the associated License Information and other documentation). The terms and conditions of this license DO NOT provide for any entitlement to defect correction.

To determine if you want to use this SupportPac, read the accompanying license file.

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

[{"Product":{"code":"SSGMJ2","label":"CICS Transaction Gateway"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Component":"CTG","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF035","label":"z\/OS"}],"Version":"9.2;9.1;9.0;8.1;8.0","Edition":"","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Product Synonym

CTG CICS TG CICS Transaction Gateway

Document Information

Modified date:
27 April 2021