Capabilities compatibility

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 V3.0.67 with Aqua V3.3.
  • Aqua v3.1 support for the API toolkit was removed from IBM z/OS Connect V3.0.68. Users are encouraged to use Aqua v3.3.

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

Capability API Toolkit version Server runtime version Description
ibm.services.wvservice.truncateInputLastCharField V3.0.9.9 and V3.2.9.9 V3.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 V3.0.6 V3.0.16 Supports the definition of multiple response codes for a service based on conditional processing.
ibm.services.wvservice.arrayCounter V3.0.6.7 and V3.2.6.7 V3.0.23 + APAR PH15332 See note below. Supports the definition of array counters for service fields.
ibm.services.wvservice.overrideBoolean V3.0.6.10 and V3.2.6.10 V3.0.26 Supports the definition of service fields as a Boolean data type.
ibm.services.wvservice.overrideDate V3.0.8.3 and V3.2.8.3 V3.0.34

Supports date type service field overrides in the API toolkit.

ibm.apis.formatDate V3.0.8.3 and V3.2.8.3 V3.0.34

Allows services to be imported into APIs using the properties type:string, format:date.

ibm.apis.contactInfo V3.0.8.3 and V3.2.8.3 V3.0.34

Supports the specification of API contact information by using the API editor.

ibm.services.wvservice.redefineAsChar V3.0.8.3 and V3.2.8.3 V3.0.34

Supports the Redefine as CHAR function, allowing STRUCT field groups to be represented as characters.

ibm.services.wvservice.inImsLdsStartsWithLlZzTrancodeFields V3.0.8.7 and V3.2.8.7 V3.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 LLL, ZZ, and TRANCODE fields. These fields are used when creating message segments to send to IMS.

ibm.services.wvservice.outImsLdsStartsWithLlZzFields V3.0.8.7 and V3.2.8.7 V3.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.0.9.3 and 3.2.9.3 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.3.0.3 and 3.2.9.14 3.0.76 Enables z/OS Connect IMS database service provider support for non-nested ARRAY fields without requiring a flattened view.
Note: Do not deploy services using the ibm.services.wvservice.arrayCounter capability in production until you have the fix for PH15332 applied. If you have either version V3.0.6.7 or V3.2.6.7 or later of the 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 at the bottom. This section includes labels ‘Counted by:’ and ‘Minimum items".