IBM z/OS Connect capabilities compatibility

IBM z/OS Connect license options and capabilities

zosConnect-3.0

z/OS Connect provides alternative pricing metrics depending on which license is purchased. Table 1 illustrates the capabilities that are provided by each license. For more information about the Program IDs, Component IDs, and FMIDs for these products, see the relevant Program Directory that is listed in Installing IBM z/OS Connect with SMP/E.

Table 1. z/OS Connect license options and capabilities
Capability	Simultaneous Instance license (5655-CE3)	Unlimited license (5655-CE5)
Number of possible server instances	Determined by license	Unrestricted
Product FMIDs	HZC3000 JZC3002	HZC3000 JZC3002 JZC3003
Supports OpenAPI 2.0 specification (zosConnect-2.0)	Yes	Yes
Supports OpenAPI 3.0 specification (zosConnect-3.0)	Yes (from 3.0.72)	Yes
z/OS native deployment	Yes	Yes
z/OS Connect Server containerized deployment (zos/s390x, linux/s390x and linux/amd64)	No	Yes
z/OS Connect API toolkit (zosConnect-2.0)	Yes	Yes
z/OS Connect Designer (zosConnect-3.0) (linux/s390x and linux/amd64)	Yes (from 3.0.72)	Yes
Deploy Designer-created API projects	Yes (from 3.0.72)	Yes
SMF record for registration	SMF record type 89 subtypes 1 and 2.	SMF record type 89 subtype 1.

Note:

zosConnect-3.0 Applies to zosConnect-3.0.

The z/OS Connect Designer is the no charge web-based API development tool that enables users to develop and test API projects for deployment in an IBM z/OS Connect instance that supports the OpenAPI 3.0 specification. For more information, see Download the IBM z/OS Connect Designer image.

Find out more about licensing and ordering IBM z/OS Connect on the A launch icon to indicate a link opens a new tab or window. z/OS Connect Product Page. If you have questions about IBM z/OS Connect, you can chat to one of the Sales team. Open the Product Page in your browser and click Chat with us.

zosConnect-3.0 artifact compatibility

zosConnect-3.0 Applies to zosConnect-3.0.

Identify which versions of the z/OS Connect Gradle plug-ins are compatible with which version of z/OS Connect Server and z/OS Connect Designer.

zosConnect-3.0 artifacts (WAR files) can be deployed in the z/OS Connect Designer or z/OS Connect Server that is at the equivalent release level or later than the equivalent release level of the z/OS Connect Gradle plug-in that generated the artifacts.

Important:

zosConnect-3.0 artifacts (WAR files), can be deployed in a z/OS Connect Server that is a container image or a started task that is at the same release level or later than the release level of the z/OS Connect Designer or z/OS Connect Gradle plug-ins that were used to generate the artifacts. For more information, see z/OS Connect artifact compatibility.

Restriction: zosConnect-3.0 artifacts (WAR files) should not be deployed to a z/OS Connect Server that is a container image or a started task that is an older release version than the release version of the z/OS Connect Designer, the z/OS Connect API provider Gradle plug-in or the z/OS Connect API requester Gradle plug-in.

Table 2. z/OS Connect zosConnect-3.0 artifact compatibility
z/OS Connect release version	API provider Gradle plug-in version	Gradle versions that are supported by the API provider Gradle plug-in	API requester Gradle plug-in version	Gradle versions that are supported by the API requester Gradle plug-in
3.0.100	1.5.0	7.6.1 to 9.0.0	1.3.0	7.6.1 to 9.0.0
3.0.99	1.5.0	7.6.1 to 9.0.0	1.3.0	7.6.1 to 9.0.0
3.0.98	1.4.11	7.6.1 to 9.0.0	1.2.6	7.6.1 to 9.0.0
3.0.97	1.4.11	7.6.1 to 9.0.0	1.2.6	7.6.1 to 9.0.0
3.0.96	1.4.11	7.6.1 to 9.0.0	1.2.6	7.6.1 to 9.0.0
3.0.95	1.4.10	7.6.1 to 8.12.1	1.2.5	7.6.1 to 8.12.1
3.0.94	1.4.10	7.6.1 to 8.12.1	1.2.5	7.6.1 to 8.12.1
3.0.93	1.4.10	7.6.1 to 8.12.1	1.2.4	7.6.1 to 8.12.1
3.0.92	1.4.9	7.6.1 to 8.12.1	1.2.3	7.6.1 to 8.12.1
3.0.91	1.4.9	7.6.1 to 8.12.1	1.2.3	7.6.1 to 8.12.1
3.0.90	1.4.8	7.6.1 to 8.12.1	1.2.2	7.6.1 to 8.12.1
3.0.89	1.4.8	7.6.1 to 8.11.1	1.2.2	7.6.1 to 8.11.1
3.0.88	1.4.7	7.6.1 to 8.11.1	1.2.1	7.6.1 to 8.11.1
3.0.87	1.4.6	7.6.1 to 8.10	1.2.0	7.6.1 to 8.10
3.0.86	1.4.5	7.6.1 to 8.10	1.1.7	7.6.1 to 8.10
3.0.85	1.4.5	7.6.1 to 8.9	1.1.7	7.6.1 to 8.9
3.0.84	1.4.4	7.6.1 to 8.9	1.1.6	7.6.1 to 8.9
3.0.83	1.4.4	7.6.1 to 8.9	1.1.5	7.6.1 to 8.9
3.0.82	1.4.3	7.6.1 to 8.8	1.1.4	7.6.1 to 8.8
3.0.81	1.4.3	7.6.1 to 8.7	1.1.4	7.6.1 to 8.7
3.0.80	1.4.3	7.6.1 to 8.7	1.1.4	7.6.1 to 8.7
3.0.79	1.4.2	7.6.1 to 8.5	1.1.3	7.6.1 to 8.5
3.0.78	1.4.1	7.6.1 to 8.5	1.1.2	7.6.1 to 8.5
3.0.77	1.4.0	7.6.1 to 8.5	1.1.1	7.6.1 to 8.5
3.0.76	1.4.0	7.6.1 to 8.5	1.1.0	7.6.1 to 8.5
3.0.75	1.3.0	7.6.1 to 8.5	1.0.6	7.6.1 to 8.5
3.0.74	1.3.0	7.6.1 to 8.5	1.0.5	7.6.1 to 8.5
3.0.73	1.2.0	7.6.1 to 8.5	1.0.5	7.6.1 to 8.5
3.0.72	1.1.2	7.6.1 to 8.5	1.0.4	7.6.1 to 8.5
3.0.71	1.1.2	7.6.1 to 8.5	1.0.4	7.6.1 to 8.5
3.0.70	1.1.1	7.6.1 to 8.5	1.0.3	7.6.1 to 8.5
3.0.69	1.1.0	7.6.1 to 8.5	1.0.3	7.6.1 to 8.5
3.0.68	1.0.2	6.8.3 to 8.0.2	1.0.2	6.8.3 to 8.0.0
3.0.67	1.0.2	6.8.3 to 8.0.2	1.0.1	6.8.3 to 8.0.0
3.0.66	1.0.2	6.8.3 to 8.0.2	1.0.1	6.8.3 to 8.0.0

Note: On z/OS, API provider Gradle plug-in 1.1.0 and later versions and API requester Gradle plug-in 1.0.3 and later versions support Gradle 7.6.1 to 8.3 and 8.8 and later

zosConnect-3.0 API project file compatibility

zosConnect-3.0 Applies to zosConnect-3.0.

With some enhancements to z/OS Connect there is a need to update the format, and thus the version, of the files that are contained within an API project to enable new function. The server continues to support older mapping files versions. This table shows the file version for specific API project files and the minimum z/OS Connect release version that is required to use these files. For more information on how API project files are updated, see Updating z/OS Connect API project files. Only z/OS Connect release versions that are listed change the API project-mapping file versions.

Table 3. z/OS Connect API project file compatibility
request.yaml and response_nnn.yaml version	Minimum required z/OS Connect release version	Minimum required API provider Gradle plug-in version	Minimum required API requester Gradle plug-in version
1.2	3.0.91	1.4.9	1.2.3
1.1	3.0.87	1.4.6	1.2.0
1.0	3.0.55	1.0.0	1.0.0

IBM z/OS Connect Operator and CASE version compatibility

zosConnect-3.0 Applies to zosConnect-3.0.

Containers Applies to z/OS Connect container deployments.

Note: The IBM z/OS Connect Operator can only be installed in an OCI-compliant container platform.

Identify which versions of the IBM z/OS Connect Operator are compatible with which version of Container Application Software for Enterprises (CASE).

Table 4. IBM z/OS Connect Operator version compatibility
z/OS Connect release version	IBM z/OS Connect Operator version	CASE version
3.0.100	1.0.14	1.0.15
3.0.99	1.0.13	1.0.14
3.0.98	1.0.12	1.0.13
3.0.97	1.0.12	1.0.13
3.0.97	1.0.12	1.0.13
3.0.96	1.0.12	1.0.13
3.0.95	1.0.11	1.0.12
3.0.94	1.0.11	1.0.12
3.0.94	1.0.11	1.0.12
3.0.93	1.0.11	1.0.12
3.0.92	1.0.10	1.0.11
3.0.91	1.0.10	1.0.11
3.0.90	1.0.9	1.0.10
3.0.89	1.0.8	1.0.9
3.0.88	1.0.8	1.0.9
3.0.87	1.0.8	1.0.9
3.0.86	1.0.8	1.0.9
3.0.85	1.0.8	1.0.9
3.0.84	1.0.8	1.0.9
3.0.83	1.0.8	1.0.9
3.0.82	1.0.8	1.0.9
3.0.81	1.0.8	1.0.9
3.0.80	1.0.8	1.0.9
3.0.79	1.0.7	1.0.8
3.0.78	1.0.7	1.0.8
3.0.77	1.0.7	1.0.8
3.0.76	1.0.7	1.0.8
3.0.75	1.0.7	1.0.8
3.0.74	1.0.7	1.0.8
3.0.73	1.0.6	1.0.7
3.0.72	1.0.6	1.0.7
3.0.71	1.0.6	1.0.7
3.0.70	1.0.6	1.0.7
3.0.69	1.0.5	1.0.6
3.0.68	1.0.5	1.0.6
3.0.67	1.0.5	1.0.6
3.0.66	1.0.4	1.0.5
3.0.65	1.0.3	1.0.4
3.0.64	1.0.2	1.0.3
3.0.63	1.0.2	1.0.3
3.0.62	1.0.2	1.0.3
3.0.61	1.0.2	1.0.2
3.0.60	1.0.1	1.0.1
3.0.59	1.0.0	1.0.0

zosConnect-2.0 capability compatibility

zosConnect-2.0 Applies to zosConnect-2.0.

When you deploy an API or service, a compatibility check is made to ensure that the capabilities of the z/OS Connect API toolkit and IBM z/OS Connect server are compatible. When capabilities are not compatible, IBM z/OS Connect runtime messages BAQR7086E or BAQR7085E are issued.

Note:

All the z/OS Connect API toolkit capabilities are supported from IBM z/OS Connect 3.0.90 with Aqua 3.4.
Support for Aqua 3.2 (IBM Explorer for z/OS) will be withdrawn on 30 April 2025. For more information, see Product lifecycle: IBM Explorer for z/OS. Users are encouraged to move to the latest Aqua 3.4 platform that is built on Eclipse 4.31 and Java 17.
Aqua 3.1 support for the API toolkit was removed from IBM z/OS Connect 3.0.68. Users are encouraged to use Aqua 3.3.

If you aren't using 3.3, the following list contains the minimum versions of the z/OS Connect API toolkit and z/OS Connect Server runtime that is required for a given capability. Use this list to determine the level of support for capabilities you are using.

Table 5. zosConnect-2.0 capability compatibility
Capability	API Toolkit version	Server runtime version	Description
`ibm.services.wvservice.` `truncateInputLastCharField`	3.2.9.9, 3.3.0.0 and 3.4.0.0	3.0.58	Supports the truncation of the last fields of COBOL data structures for IMS Large Data Structure or IMS message segments.
`ibm.apis.multipleResponseCodes`	3.0.6	3.0.16	Supports the definition of multiple response codes for a service based on conditional processing.
`ibm.services.wvservice.arrayCounter`	3.2.6.7, 3.3.0.0 and 3.4.0.0	3.0.23 + APAR PH15332 See note.	Supports the definition of array counters for service fields.
`ibm.services.wvservice.overrideBoolean`	3.2.6.10, 3.3.0.0 and 3.4.0.0	3.0.26	Supports the definition of service fields as a Boolean data type.
`ibm.services.wvservice.overrideDate`	3.2.8.3, 3.3.0.0 and 3.4.0.0	3.0.34	Supports date type service field overrides in the API toolkit.
`ibm.apis.formatDate`	3.2.8.3, 3.3.0.0 and 3.4.0.0	3.0.34	Allows services to be imported into APIs by using the properties `type:string`, `format:date`.
`ibm.apis.contactInfo`	3.2.8.3, 3.3.0.0 and 3.4.0.0	3.0.34	Supports the specification of API contact information by using the API editor.
`ibm.services.wvservice.redefineAsChar`	3.2.8.3, 3.3.0.0 and 3.4.0.0	3.0.34	Supports the Redefine as CHAR function, allowing STRUCT field groups to be represented as characters.
`ibm.services.wvservice.` `inImsLdsStartsWithLlZzTrancodeFields`	3.2.8.7, 3.3.0.0 and 3.4.0.0	3.0.38	Supports the Imported IMS large data structure starts with LLZZTRANCODE fields advanced service data conversion option. This option allows for the tolerance of imported request IMS large data structures with leading `LL`, `ZZ`, and `TRANCODE` fields. These fields are used when creating message segments to send to IMS.
`ibm.services.wvservice.` `outImsLdsStartsWithLlZzFields`	3.2.8.7, 3.3.0.0 and 3.4.0.0	3.0.38	Supports the Imported IMS large data structure starts with LLZZ fields advanced service data conversion option. This option allows for the tolerance of imported response IMS large data structures with leading `LL` or `ZZ` fields, with response data starting at the fifth byte of the DATA portion of the first message segment received from IMS.
`ibm.services.wvservice.cicsBidi`	3.2.9.3, 3.3.0.0 and 3.4.0.0	3.0.46	Enables CICS® SOR service support for bidirectional (bidi) text, allowing the visual order of bidi text in services to be preserved.
`ibm.services.imsdb.arraySupport`	3.2.9.14, 3.3.0.3 and 3.4.0.0	3.0.76	Enables z/OS Connect IMS database service provider support for nonnested ARRAY fields without requiring a flattened view.

Note: Do not deploy services that use the ibm.services.wvservice.arrayCounter capability in production until you have the fix for PH15332 applied. If you have either version 3.0.6.7 or 3.2.6.7 or later of the z/OS Connect API toolkit, you can avoid using this capability when editing an Array field in the service interface editor, by not using the Array Properties section. This section includes labels Counted by: and Minimum items.