IBM MQSeries Integrator Agent for CICS Transaction Server integrates CICS and IMS applications to create high-performance, scalable solutionsIBM United States Software Announcement 204-040
March 16, 2004
|At a glance|
MQSeries Integrator Agent for CICS Transaction Server provides:
- Application integration on the mainframe with CICS and IMS applications
- Functional migration from the existing MDp product
- A build time component (the MQSI Agent for CICS Adapter Builder) that runs on Windows, using tools with a look and feel similar to those of IBM WebSphere MQ Integrator for z/OS
- Newly introduced at this time, a Link3270 Bridge adapter program
With Adapter Builder, adapters can be:
- Built to the MQSI Agent for CICS Adapter run time environment
- Deployed as CICS applications on the z/OS server
For ordering, contact:
Your IBM representative, an IBM Business Partner, or IBM Americas Call Centers at
Back to top
The IBM MQSeries® Integrator Agent for CICS® Transaction Server (MQSI Agent for CICS) is a product for application integration, running on z/OS®. It enables functional migration from the Message Driven processor (MDp) product delivered by IBM as PRPQ 5799-A66. Functional enhancements to MQSI Agent for CICS are being introduced, delivered by the service channel.
The MQSI Agent for CICS consists of two components:
- MQSI Agent for CICS Adapter Builder: A build time component, runs on Windows and uses tools that look and feel similar to those of WebSphere® MQ Integrator® Broker V2.1.
- MQSI Agent for CICS Server run time: A run time component, runs with CICS Transaction Server for z/OS V2.2 or V2.3 as a CICS application on a z/OS server. MQSI Agent for CICS Server run time uses CICS Business Transaction Services (BTS) to manage the interrelationship, commit scope, recovery, and restart of the actions that make up a business transaction.
Used together, the build time and run time components of MQSI Agent for CICS enable the construction and execution of adapters to process requests from client applications for business applications running on host systems, in particular CICS and IMS.
The adapter runs when the MQSI Agent for CICS server run time receives a request from the client application. If the client application is WebSphere MQ-enabled, the request is in the form of a WebSphere MQ message. WebSphere MQ-enabled applications use the IBM WebSphere MQ-CICS bridge as the interface between a WebSphere MQ-enabled client application and CICS. Any other client application capable of initiating a CICS program can use a CICS-supplied interface to pass a request to run the adapter. A CICS-supplied interface can be ECI, EXCI, EXEC CICS LINK, or SOAP for CICS.
Target IMS applications may be driven via FEPI. Target CICS applications may be 3270 applications
driven via FEPI or Link3270 Bridge, or COMMAREA applications driven through a Distributed Program
Link (DPL). MQSI Agent for CICS contains server adapter programs that handle these four classes of
Back to top
For run time, the following are required:
- OS/390® V2.10, or z/OS V1.2, or later
- CICS Transaction Server for z/OS V2.2 or V2.3
- MQSeries for OS/390 V2.1, or later, or WebSphere MQ for z/OS V5.2, or later
For build time, the following are required:
- Windows 2000 or Windows XP
- IBM Object REXX for Windows V2
|Planned availability date|
April 30, 2004
MQSeries Integrator Agent for CICS Transaction Server (MQSI Agent for CICS) was originally announced by Software Announcement 201-059 , dated March 13, 2001. MQSI Agent for CICS is the successor to the Message Driven processor (MDp) product (originally available from Early, Cloud & Company, and more recently delivered by IBM as a PRPQ (5799-A66)). It provides a range of requirements identified by MDp customers as important for sustaining their MDp investment. Significant functional enhancements are now being provided to MQSI Agent for CICS.
MQSeries Integrator Agent for CICS Transaction Server consists of two components, the MQSI Agent for CICS Adapter Builder, and the MQSI Agent for CICS Server run time. Used together, the MQSI Agent for CICS build time and run time components enable the construction and execution of sophisticated adapters to process requests (business transactions) from client applications.
Using the build time component, the user performs a series of processes, including microflow modeling, to build an adapter. As output from the build time, an adapter consists of COBOL (source and copybooks) and JCL.
After an adapter has been built, the user moves it from the build time environment to a z/OS server, where it is compiled as a CICS application. In its final form, the adapter consists of COBOL and CICS executables.
The adapter runs when the MQSI Agent for CICS server run time receives a request message from a client application. Requests from client applications must be contained in a CICS communication area (COMMAREA). A client application can be any WebSphere MQ-enabled application, or any application capable of initiating a CICS program through a CICS-supplied interface (that is, ECI, EXCI, or EXEC CICS LINK). Examples of client applications include:
- WebSphere Business Integration Message Broker V5.0.1
- WebSphere MQ Workflow V3.4
- Local, remote, or Client CICS applications
- Applications running under WebSphere Application Server (any platform) and using Java connectors to access CICS programs
- Web Services clients using Simple Object Access Protocol (SOAP)
If the client application is WebSphere MQ-enabled, the request is in the form of a WebSphere MQ message, and the application uses the WebSphere MQ-CICS bridge to pass the request message to the run time. The target application is driven via the WebSphere MQ server adapter program through MQPUT and MQGET commands. Other client applications (as long as they can initiate a CICS program) use a CICS-supplied interface to pass the request message to the run time.
MQSI Agent for CICS may also be used to support federated business process integration, where another product such as WebSphere Business Integration Message Broker is responsible for the overall business flow, managing business context state, multiple request and reply interactions, asynchronous processing, overall business flow compensation, and the continuation of one logical request through multiple requests, if required.
Adapter request processing can invoke server adapter programs in any sequence. The sequence is determined using the Adapter Builder component.
- Existing CICS transactions (including custom programs) via a Distributed Program Link (DPL)
- Existing CICS or IMS (or other) applications via a 3270 data stream using CICS Front End Programming Interface (FEPI)
- Existing CICS or IMS (or other) applications via application data structure using Link3270 bridge
- WebSphere MQ-enabled applications via WebSphere MQ
MQSI Agent for CICS Server run time
The run time component contains the following elements:
- The server adapter programs: Any one of four types of programs in the run time component that perform the business transaction activity defined within a microflow at build time
- The navigator programs: Perform adapter request processing, manage states during the microflow and invoke the server adapter programs
- Support for custom programs: Custom programs must be written according to a specification that is part of MQSI Agent for CICS
- An error logging program
- Support for compensation flows, journaling, and audit levels using the BTS facilities of CICS
- A range of utility programs to support the run time component
MQSI Agent for CICS server adapter programs perform the processing modeled in the microflows (also sometimes referred to as connector flows, micro-flow scripts, navigation scripts, or micro-control flows). The server adapter program processing may:
- Initiate local programs using EXEC CICS Link.
Perform screen navigation, by way of an interactive request and reply dialog with a 3270-type CICS
or IMS application. This can be accomplished in either of two ways:
- Using the FEPI function of CICS, automatically parsing 3270 screens sent by the application, identifying their fields, attributes, and data, constructing and sending suitable replies including keystrokes based on the modeling and simple business logic
- Using the Link3270 bridge, intercepting terminal-related commands, since there is no real 3270, using the input supplied in the COMMAREA to satisfy input commands (RECEIVE, RECEIVE MAP, and so forth), and collecting the output from output commands (SEND, SEND MAP, and so on) in buffers, based on the modeling and simple business logic
- Synchronously perform WebSphere MQ PUT and GET commands, enabling the client application to maintain responsibility for the overall business flow.
- Initiate remote CICS programs via DPL using EXEC CICS Link. These programs may include complex logic rules.
To do this, there are four types of server adapter programs:
- The FEPI server adapter program, which interfaces to 3270-type CICS and IMS applications, and performs screen navigation
- The Link3270 Bridge adapter program, newly introduced at this time
- The CICS server adapter program that interfaces to CICS transactions via DPL, and can also include custom programs developed to augment the supplied function
- The WebSphere MQ server adapter program that interfaces with WebSphere MQ enabled applications
The server adapter programs are generated as a result of modeling using the build time component of MQSI Agent for CICS.
The navigator programs, like the server adapter programs, are generated as a result of modeling via the build time component.
MQSI Agent for CICS Adapter Builder: The build time component of the product runs on Windows. It is provided on CD-ROM for installation using InstallShield.
It consists of the following elements:
- A Control Center, similar to the Control Center of the IBM WebSphere MQ Integrator and to that of the IBM WebSphere MQ Adapter Offering, with the addition of support for the flow components and additional primitives of MQSI Agent for CICS. It supports the modeling and definition of the navigators and of the four types of server adapter programs. Definitions are stored as eXtensible Markup Language (XML) documents in the Control Center's repository.
- Importers that collect modeling information from 3270 data streams, from COBOL record descriptions, and from BMS source files (a facility newly introduced at this time), and represent them as structured data types in the repository of the control center. The structured data types can then be used during modeling. A subset of IBM Host On-Demand is used to perform the build time 3270 terminal emulation function for the capture of the 3270 dialogs.
- A Generator facility running in the same system as the control center, that enables the run time component to behave as modeled in the build time. This reads from the XML documents in the repository the definitions of the navigators and the four types of server adapter programs, and from them generates source code in COBOL (source and copybooks), together with the corresponding Job Control Language (JCL) for installation in the run time environment. The generator sends these to the system containing the run time component, and initiates the compilation in the run time machine of the source code into the executables of the navigators and the server adapter programs.
- A Repository, a directory in the builder's file system that contains the messages and models.
Delivery: The enhancements described in this announcement are delivered by the service channel, as PTF for APAR PQ84425. The Adapter Builder, with this level of service, is at V1.1.3. The Server run time at V1.1.0, with successive service up to this level, remains at V1.1.0. For convenience, the product with these enhancements is referred to as V1.1.3.
As was stated in Software announcement
, dated October 28, 2003, CICS Transaction Server for z/OS V2.3, IBM intends to include
the run time functions of this product in a future release of CICS Transaction Server.
Back to top
MQSeries Integrator Agent for CICS Transaction Server enables migration from the MDp product, and enables these customers to migrate to a business integration solution based on CICS, while protecting the investment they have made in MDp task objects.
With MQSI Agent for CICS, customers can also create adapters for integrating business applications across Enterprise Information Systems, such as CICS and IMS, providing effective re-use of existing assets such as 3270 applications. Consolidating the integration activities in the host environment helps reduce the risk, complexity, and cost of creating point-to-point integration solutions. Thus, integration solutions can be created with high performance, scalability, and availability by exploiting the robust infrastructure provided by CICS Transaction Server for z/OS. It enables these applications to be combined into larger units which perform a useful business service. These services may be invoked via any supported access interface to CICS, including JCA, IIOP and SOAP.
MQSI Agent for CICS creates adapters that are intelligent and that use a standard interface that remains stable even though the application changes. It provides the programs and environment that enable adapters to run, manage, and fulfill business transactions. It controls the execution of complex business transactions and assists in managing the interrelationship, commit scope, recovery, and restart of the actions that make up the business transaction.
MQSI Agent for CICS may use both 3270 Bridge and FEPI together as an integration point for accessing new CICS BMS and older 3270 data stream applications.
IBM Host Integration products are commonly marketed as providers of general purpose 3270 emulators to replace real 3270 hardware or 3270 emulators. Neither the CICS 3270 Bridge technology, nor FEPI technology can be used to provide a general purpose 3270 emulation solution.
Since Host Integration products process a 3270 data stream, the application, or CICS, must generate a 3270 data stream. CICS 3270 Bridge technology intercepts the application at the API level. With CICS BMS, the overhead of generating a 3270 data stream is avoided.
Using MQSI Agent for CICS with either CICS 3270 Bridge technology or FEPI technology, the following performance benefits are provided:
- 3270 screen navigation can be provided within CICS. A single business-client request can result in multiple 3270 transactions being run to satisfy the business response. This can greatly reduce the number of interactions between the business client and CICS, and avoids the navigation overhead, resulting in improved response time.
- 3270 emulation at the terminal level, including field attribute and modified data tag processing, as well as merging a SEND, NO ERASE data stream with the current screen contents, can be provided by MQSI Agent for CICS running under CICS. This 3270 emulation avoids the 3270 emulation overhead.
In summary, the IBM Host Integration products provide the best general purpose 3270 emulation
solution, and these products can be customized to provide refacing for 3270 and 5250 applications on
any platform. MQSI Agent for CICS with CICS Bridge Technology provides the best performing
solution, in terms of response time and scalability, for accessing CICS 3270 applications on z/OS.
Back to top
For the original announcement information of MQSeries Integrator Agent for CICS Transaction Server, refer to Software Announcement 201-059 , dated March 13, 2001.
Back to top
Product information will be available through the Offering Information Web site at
Back to top
The publications for this product comprise the following books:
Order Title number MQSeries(R) Integrator Agent for CICS(R) SC34-5899 Transaction Server: Run Time User's Guide MQSeries Integrator Agent for CICS SC34-5901 Transaction Server: Using the Control Center
These are provided in softcopy only. They are available in HTML format, using the Control Center when the product is installed. They are also available in PDF format, either by download from the CICS Web site
or from the IBM Publications Center, at
Note that these books are no longer available in hardcopy. If hardcopy is required, it should be printed from the PDF files.
Delivered with the product in hardcopy is:
Publication Title number Program Directory: MQSeries Integrator GI10-2534 Agent for CICS Transaction Server
Back to top
Specified operating environment
MQSeries Integrator Agent for CICS Transaction Server run time requires a processor capable of supporting the operating system, together with CICS Transaction Server and all other software being run. It also requires 6 MB DASD.
MQSI Agent for CICS build time requires:
- Any Intel machine capable of supporting the operating system
- Any communications hardware supporting SNA LU6.2 and TCP/IP
- A minimum of 256 MB of RAM
- Approximately 250 to 750 MB of disk space, depending on installation options
MQSeries Integrator Agent for CICS Transaction Server at this level requires:
OS/390® V2.10, or z/OS® V1.2, or later
- With Enterprise COBOL for z/OS and OS/390 V3, or COBOL for OS/390 and VM V2.2.1
CICS Transaction Server for z/OS (CICS TS) V2.2 or V2.3 (5697-E93)
- Business Transaction Services must be configured in the run time region
- CICS TS V2.2 requires PTF UQ80313 for APAR PQ77666 and PTF for APAR PQ79804
- Optionally: CICS Front End Programming Interface (FEPI) installed and configured for region-to-region communications
- Optionally: Link3270 bridge mechanism (as shipped with CICS TS 2.2), if creating Link3270 bridge adapters
Optionally: External Security Manager support for FEPI pass-tickets
- This includes RACF®, delivered with OS/390 V2.10 in the OS/390 Security Server, and with z/OS V1.2, or later, in the SecureWay® Security Server for z/OS.
MQSeries for OS/390 V2.1 (5655-A95), with APAR PQ23961, or WebSphere® MQ for z/OS V5.2, or later
- Note that this product includes the WebSphere MQ-CICS Bridge
For build time, MQSI Agent for CICS requires:
- Windows XP or Windows 2000
- IBM Object REXX for Windows V2
MQSeries Integrator Agent for CICS Transaction Server may be used via FEPI with CICS 3270 applications running under CICS Transaction Server for OS/390 V2.2 or V2.3, and with IMS 3270 applications running under IMS Transaction Manager V7.1, or later.
The following items are delivered:
- IBM International Program License Agreement (IPLA) in multilingual booklet (Z125-3301)
- License Information for MQSeries Integrator Agent for CICS Transaction Server (GC34-5902) in multiple languages
- Proof of Entitlement (PoE)
- Program Directory for MQSeries Integrator Agent for CICS Transaction Server (GI10-2534)
- A CBPDO or other Customized Offering delivery of the runtime component of the product on a 3480 1/2-inch tape cartridge
- The Adapter Builder product component on a CD-ROM
Security, auditability, and control
MQSeries Integrator Agent for CICS Transaction Server uses the security and auditability features of the base operating system under which it is operating. It also produces its own audit logs, providing a full audit trail for all users.
The customer is responsible for evaluation, selection, and implementation of security features,
administrative procedures, and appropriate controls in application systems and communication
Back to top
MQSeries Integrator Agent for CICS Transaction Server is licensed under the IPLA. It has a single "per install" charge unit. There is no change to its ordering information, as described in Software Announcement 201-059 , dated March 13, 2001.
Product media is shipped only via Customized Offerings (CBPDO, ServerPac, Systempac®).
Non-customized items (documentation as defined in the
section) are shipped via the stand-alone product.
Back to top
|Terms and conditions|
Licensing: IBM IPLA. Proofs of Entitlement are required for all authorized use.
The following agreements apply for maintenance and do not require customer signatures:
- IBM Agreement for Acquisition of Support (Z125-6011)
- Addendum for Support for Application and Integration Middleware for S/390®, Z125-6435
Limited warranty applies: Yes
Warranty: This program has warranty for a minimum of one year from acquisition from IBM or authorized Business Partner. The warranty provided to the customer, for at least one year from acquisition, is access to databases (read Web sites) for program information, FAQs, including any known fixes to defects, which the customer can download or obtain otherwise and install at their leisure.
Program services: Note that the statement in the original announcement of this product that program services would be available until December 31, 2005, is no longer applicable. As with all IBM IPLA products, discontinuance of program services will be in accordance with the policies announced by IBM in Software Announcement 203-204 , dated August 12, 2003. In addition, the actual date of discontinuance of program services for this product will not be earlier than that originally announced.
Program technical support: Technical Support of a program product will be available for a minimum of three years from the general availability date, as long as your Software Maintenance is in effect. This Technical Support allows you to obtain assistance (via telephone or electronic means) from IBM for product-specific, task-oriented questions regarding the installation and operation of the program product. Software Maintenance also provides you with access to updates, releases, and versions of the program. Customers will be notified, via announcement letter, of discontinuance of support with 12 months notice. If you require additional technical support from IBM, including an extension of support beyond the discontinuance date, contact your IBM representative or Business Partner. This extension may be available for a fee.
Money-back guarantee: If for any reason you are dissatisfied with the Program, return it within 30 days from the invoice date, to the party (either IBM or its reseller) from whom you acquired it, for a refund. This applies only to your first acquisition of the Program.
Copy and use on home/portable computer: No
Volume orders (IVO): No
Passport Advantage® applies: No
Usage restriction: Yes
Licensing of MQSeries Integrator Agent for CICS Transaction Server Adapter Builder: A license for MQSeries Integrator Agent for CICS Transaction Server includes the right to make and use without additional charge, within the same enterprise, any number of copies of the MQSI Agent for CICS Adapter Builder, subject to their use being with the licensed MQSI Agent for CICS Adapter run time.
Software Maintenance applies: No
For Operating System software, the revised IBM Operational Support Services SoftwareXcel offering will provide support for those operating systems and associated products that are not available with the newly announced Software Maintenance offering. This will ensure total support coverage for your enterprise needs, including IBM and selected non-IBM products. For complete lists of products supported under both the current and revised SoftwareXcel offering, refer to our Web site at
For additional information on the revised IBM Operational Support Services, refer to Services Announcement 601-023 , dated July 10, 2001.
IBM operational support services SoftwareXcel: Yes
AIX®/UNIX® Upgrade Protection applies: No
Entitled Upgrade for current AIX/UNIX Upgrade Protection licensees: No
iSeries Software Subscription applies: No
Variable charges apply: No
Educational allowance available:
Yes, 15% education allowance applies to qualified education
Back to top
There is no change to the existing pricing for MQSeries Integrator Agent for CICS Transaction
Back to top
To order, contact the Americas Call Centers, your local IBM representative, or your IBM Business Partner.
To identify your local IBM representative or IBM Business Partner, call 800-IBM-4YOU (426-4968).
Phone: 800-IBM-CALL (426-2255) Fax: 800-2IBM-FAX (242-6329) Internet: firstname.lastname@example.org Mail: IBM Americas Call Centers Dept: IBM CALL, 6th Floor 105 Moatfield Drive North York, Ontario Canada M3B 3R1 Reference: LE001
The Americas Call Centers, our national direct marketing organization, can add your name to the mailing list for catalogs of IBM products.
Note: Shipments will begin after the planned availability date.
Back to top