z/OS Connect Enterprise Edition change history

Use this information to discover the enhancements in each refresh of IBM® z/OS Connect Enterprise Edition.
Note:
  1. As stated in the license agreement, IBM provides fixes only for the current release and the two previous releases.
  2. Best practice is to apply the latest release as soon as it is available, but some releases are the minimum required to resolve specific issues. Similarly, statically linked API requester programs must be relinked to pick up new function and fixes.
  3. This documentation describes the latest release of z/OS Connect EE V3.0. If you have an earlier release, some of the features and functions described in this documentation might not be available.
  4. Before you apply the latest release, check the list of functions that are to be removed. See the table in Removal notices.
  5. For a list of the minimum versions of the z/OS Connect EE API toolkit and z/OS Connect EE server runtime required for a particular capability, see Capabilities compatibility.
Table 1. Enhancements and fixes.

The following table lists the maintenance level and the changes in each level for both the server code and the API toolkit.

Maintenance level Enhancements and fixes
May 2021
V3.0.45 (APAR PH36068)

Server code update

Enhancements
  • You can now configure z/OS Connect EE to record SMF 123 subtype 2 version 2 records, which provide more detailed information about API requester requests. Do not enable recording of subtype 2 version 2 records until all the products you use to process your SMF records support this new subtype. For more information, see API requester data from SMF type 123 subtype 2 version 2 records.
  • You can now format all SMF 123 records as a comma-separated file (CSV) for importing into a desktop spreadsheet application. This new utility is delivered as a load module called BAQSMFX and supersedes BAQS123A. For more information, see Sample JCL to format SMF records.
  • The pre-existing SMF sample BAQSMFP, used to format all SMF 123 records to STDOUT, is now delivered as a load module called BAQSMFP. For more information, see Sample JCL to format SMF records.
  • The SMF123S1_TRACKING_TOKEN is now padded with spaces (0x40) in the SMF 123 subtype 1 version 2 record instead of nulls (0x00). This change allows much simpler comparison with the OADATA1 fields of the DFHCICS group in the PERFORMANCE class of SMF 110 subtype 1 records. For more information, see API provider data from SMF type 123 subtype 1 version 2 records.
  • The z/OS Connect EE API requester is enhanced to allow you to specify the following attributes:
    • The requireSecure attribute on the zosconnect_apiRequesters element for all API requesters. For more information about the attribute, see zosconnect_apiRequesters
    • The idAssertion attribute on the zosconnect_apiRequesters > apiRequester subelement for individual API requesters. For more information, see apiRequester
  • The build toolkit (zconbt) is updated to V1.4.
Fixes
  • PH29630 - Message BAQR7074E The mandatory JSON response property <property_name> is missing. does not identify the invoked API.
  • PH29808 - Message DFHPI9740E, reported by the z/OS Connect EE build toolkit, does not provide enough debug information. When the PTF for this APAR is applied, the build toolkit is updated to Version 1.4.
  • PH32736 - Client secret is incorrectly required for OAuth 2.0 token with resource owner password credentials grant type.
  • PH33401 - z/OS Connect EE reports messages BAQR0430W and BAQR0436W from V3.0.39.0 and later for mapped user names.
  • PH33807 - The z/OS Connect EE build toolkit incorrectly detects a reference loop in a Swagger document.
  • PH36138 - An IMS API receives an array index out of range error with a COBOL copybook on z/OS Connect EE V3.0.40.0.
  • PH36635 - A data misalignment occurs in memory when a COBOL copybook with multiple REDEFINES with DEPENDING ON verbs is processed.
  • PH36717 - Invoking an IMS service with PassTicket failed with PASSWORD/PASSWORD PHRASE NOT AUTHORIZED.
April 2021
V3.0.44 (APAR PH35528)

Server code update

Enhancements
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V21.0.0.3. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.

    Liberty V21.0.0.3 includes a fix that prevents HTTP return code 404 during server start up. Therefore you no longer need to pause your endpoint ports during the start up of your server to prevent HTTP return code 404.

  • A new topic shows how you can use z/OS Workload Management (WLM) to classify API requests and the Resource Management Facility (RMF) to measure z/OS Connect EE API workloads. For more information, see Measuring API workloads with WLM
Fixes
  • PH35756 - z/OS Connect EE does not start when TCP/IP resolver trace is enabled.
March 2021
V3.0.43 (APAR PH34379)

Server code update

Enhancements Fixes
  • PH25575 - The z/OS Connect EE runtime and build toolkit cannot support alternative MIME types defined in a Swagger document.
  • PH26053 - A NullPointerException is reported when non-JSON strings are configured in the tokenRequest requestBody attribute.
  • PH30400 - z/OS Connect EE incorrectly transforms some numbers with a lot of digits after the decimal point.
  • PH32251 - z/OS Connect EE reports BAQR1150E: An internal error occurred during the HTTP mapping. when running a new API.
  • PH31224 - A java.lang.UnsatisfiedLinkError is reported when using PassTickets with both IMS and Db2® in a z/OS Connect EE server.
    Attention: Users of the IMS database service provider who specify the location of their UTC jars with a resourceAdapter element in server.xml. The resourceAdapter element must be replaced by the imsDbUtcPaths attribute of the zosconnect_dbServices element. For more information, see Configuring user type converter support for IMS database services.
API toolkit
V3.0.9.1 and V3.2.9.1
z/OS Connect EE V3.0.43 is compatible with API toolkit V3.0.9.1 and V3.2.9.1.
February 2021
V3.0.42 (APAR PH32853)

Server code update

Enhancements
  • The IBM MQ service provider is enhanced to write the following fields to the Data SPI: TIME_SOR_SENT, TIME_SOR_RECV, SOR_IDENTIFIER, SOR_REFERENCE, and SOR_RESOURCE. This data can be written to SMF 123.1 records and consumed by monitoring interceptors.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V21.0.0.1. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
    Attention: WebSphere® Liberty Profile 21.0.0.1 includes the fix for APAR PH34376. This fix corrects the processing of the realm derived from JWT which is used in subsequent RACMAP processing. For more information, see How to configure JWT authentication and APAR PH34376.
Fixes
  • PH31935 - Message BAQR7095E is reported when installing an API which was built using the z/OS Connect EE build toolkit on z/OS.
  • PH33129 - Running ws-schemagen.jar with z/OS Connect EE configuration files produces messages CWWKG0073W and CWWKG0030E.
  • PH33240 - Message BAQR7085E reports that capabilities are not supported for the z/OS Connect EE MQ service provider.
January 2021
V3.0.41 (APAR PH32637)

Server code update

Enhancements
  • The RESTful service administration interface is updated to version 1.2.0 and adds version information to services for all service providers. This new version also adds connectionRef, transid, transidUsage, and ccsid information for services that use the CICS® service provider. For more information, see Administering services with the administration interface.
Fixes
  • PH30899 - Using JWTs with z/OS Connect EE API requesters reports an UnsupportedEncodingException with runtimeCodePage=1208.
API toolkit
V3.0.9.0 and V3.2.9.0
Fixes
  • PH32226 - An incomplete or empty response is received for a service after re-importing a data structure in the z/OS Connect EE API toolkit.
December 2020
V3.0.40 (APAR PH30597)

Server code update

Enhancements
  • The IMS service provider has been enhanced to enable Policy override of the interaction properties imsInteractionTimeout, imsLtermOverrideName, and imsTranExpiration. To learn more about these new policy overrides, see Valid properties for use in policy rules.
  • z/OS Connect EE is enhanced so a policy rule can be configured to perform an action when a specific header is present on an API request, regardless of the value of that header. For more information, see example 5 in Format of a rule set.
API toolkit
V3.0.8.9 and V3.2.8.9
Fixes
  • PH30073 - Swagger UI does not prompt for z/OS Connect EE credentials with CORS request when testing POST method.
    Note:

    The Try It Out function causes a cross-origin (CORS) request to be made from the workstation to the z/OS Connect EE server. Swagger UI is changed to use browser credentials in CORS requests if an Authorization header value is not manually specified. This change allows the browser to prompt for credentials for CORS requests if the browser supports it and allowCredentials="true" is configured in the cors element of the server.xml configuration file.

    Due to limitations of the Eclipse internal web browser, configure Eclipse to use an external web browser. Click Preferences > General > Web Browser > Use external browser. The following browsers correctly prompt for both Basic Authentication and Client Authentication credentials with the Try It Out function: Internet Explorer 12+, Edge (Windows), Chrome, (Windows, macOS, Linux®), Firefox (Windows, macOS, Linux).

November 2020
V3.0.39 (APAR PH30278)

Server code update

Enhancements
  • z/OS Connect EE policies can now alter the following IBM MQ service properties: mqConnectionFactory, mqDestination, and mqReplyDestination. For more information, see Valid properties for use in policy rules.
  • New interceptor interfaces are added that enable monitoring support for API requester. Request data is available on the request origin and the target endpoint. Timestamps enable the calculation of the z/OS Connect EE processing time, the time spent connecting to the endpoint, and the time taken to retrieve access tokens. Monitoring of inflight requests and requests failing early is also enabled. Interceptor writers can take advantage of these new capabilities by implementing the InterceptorRequester interface and optionally the EndpointInterceptor and EarlyFailureInterceptorRequester interfaces. For more information, see Intercepting API requester calls.
Fixes
  • PH29643 - Message BAQR0407W is written after z/OS Connect EE is updated to version 3.0.30.0 or later.
API toolkit
V3.0.8.8 and V3.2.8.8
Fixes
  • PH31252 - The z/OS Connect EE API toolkit does not remove multi-dimensional array/occurs fields from the response.
October 2020
V3.0.38 (APAR PH29265)

Server code update

Enhancements
  • The z/OS Connect EE API toolkit and server runtime have been enhanced to support COBOL and PL/I data structures for IMS messages longer than 32 K that have LL, ZZ, and TRANCODE fields in the request and LL and ZZ fields in the response data structures. To learn more about these options, see Service-level data conversion customization.
  • The z/OS Connect EE API requester CICS communication stub is updated to generate CICS application user trace, which can be enabled by using the trace facilities of the CICS region in which the stub runs. This trace capability is useful for problem determination. For more information, see Enabling trace in communication stubs.
Fixes
  • PH15844 - When HTTP request header Transfer-Encoding: chunked is specified, request data is not passed to the SOR.
  • PH25870 - A CICS service remains in stopped state after it is updated by the z/OS Connect EE RESTful administration PUT method.
  • PH26128 - z/OS Connect EE incorrectly logs message BAQR7004E when installing an API.
  • PH26260 - z/OS Connect EE reports messages BAQR7033E and SRVE8025E when redeploying an IMS service.
API toolkit
V3.0.8.7 and V3.2.8.7
Enhancements
  • The z/OS Connect EE API toolkit and server runtime are enhanced to support COBOL and PL/I data structures for IMS messages longer than 32 K that have LL, ZZ, and TRANCODE fields in the request and LL and ZZ fields in the response data structures. To learn more about these options, see Service-level data conversion customization.
September 2020
V3.0.37 (APAR PH28518)

Server code update

Enhancements
  • When a CICS application is developed to call a RESTful service, the z/OS Connect EE server that is used to process the request can be chosen at run time within the CICS application. This option allows for splitting of workloads between servers, for example, based on business area. This dynamic routing capability is available for CICS applications only. For more information, see Overriding the URIMAP in a CICS application
  • The REST client service provider that is supplied with z/OS Connect EE to connect to an HTTP endpoint such as a Db2 native REST service, has been enhanced to provide improved performance.
API toolkit
V3.0.8.6 and V3.2.8.6
Fixes
  • PH27287 - z/OS Connect EE reports a COBOL parsing error caused by a J2C COBOL importer defect.
August 2020
V3.0.36 (APAR PH27162)

Server code update

Enhancements Fixes
  • PH15594 z/OS Connect EE and IMS Connect encounter issues when a session connected via a persistent socket drops or is canceled.
  • PH26697 The z/OS Connect EE IMS database service provider causes a NullPointerException in method sqlResourceAdapter.
  • PH26836 The z/OS Connect EE build toolkit reports a NullPointerException while processing the security field of a swagger document.
  • PH25101 An ephemeral port listening on 127.0.0.1 is opened when a z/OS Connect EE server is started.
    Attention: Installing the PTF for this APAR will change the default behavior of z/OS Connect EE to not open the Liberty command listener port. If required, the Liberty command listener port can be specified in the server's bootstrap.properties. See APAR PH25101 for details.
API toolkit
V3.0.8.5 and V3.2.8.5
Fixes
  • PH26129 - The z/OS Connect EE API toolkit does not copy business descriptions specified for fields to the generated Swagger file.
July 2020
V3.0.35 (APAR PH26291)

Server code update

Enhancements
  • The text of messages BAQR0417W and BAQR0418W has been updated. For more information, see z/OS Connect EE Runtime Messages.
Fixes
  • PH21761 A CICS region reports SOS DFHSM0133 WBSETBUF when z/OS Connect EE requester is in use.
  • PH25345 Passing user credentials in the request body to the authentication server to obtain a JWT causes a NPE in z/OS Connect EE.
  • PH21819 z/OS Connect EE sets some CORS headers automatically.
    Attention: When this fix is applied, additional CORS configuration is required in server.xml to enable connections from the z/OS Connect EE API toolkit and JavaScript clients. For more information, see Configuring Cross-Origin Resource Sharing on a z/OS Connect Enterprise Edition Server
API toolkit
V3.0.8.4 and V3.2.8.4
Fixes
  • PH25185 The Authorization header is not present in the swagger.json when there is a slash before the query parameters.
  • PH25451 Inconsistent swagger is generated by the z/OS Connect EE API toolkit when creating a multi-path API.
June 2020
V3.0.34 (APAR PH25369)

Server code update

Enhancements
  • z/OS Connect EE has been enhanced with the capability to expose service fields as OpenAPI 2.0 Specification compliant dates. Specifying host date patterns defines how date values are represented in system of record (SOR) fields, and enables conversion between SOR date values and OpenAPI 2.0 compliant date values. For more information, see Defining Date fields.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V20.0.0.6. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
Fixes
  • PH10474 Generating API requesters for PL/I and COBOL using the same swagger results in duplicate API name.
  • PH17588 z/OS Connect EE reports an FFDC event when processing an API requester status code that has no mapping defined.
API toolkit
V3.0.8.3 and V3.2.8.3
Enhancements
May 2020
V3.0.33 (APAR PH24143)

Server code update

Enhancements
  • z/OS Connect EE has been enhanced to support the use of PassTicket authentication for IMS services. Using PassTickets allows for z/OS Connect EE to enable SAF authentication for IMS without access to the SAF password. For more information, see Configuring PassTicket support for IMS services.
Fixes
  • PH15192 The IMS service provider causes message CWYBS0497E The resource bundle locale en_us cannot be loaded when processing DFS error.
  • PH21070 Message BAQR0558E is reported when a message greater than 4KB in length is sent to Db2.
  • PH21577 There is inconsistent behavior between deploying z/OS Connect EE .aar or .ara files and .sar files in an HA environment.
  • PH21965 Timeouts are reported when multiple requests are sent via the z/OS Connect EE IMS service provider Keyring.
  • PH23181 NullPointerExceptions are reported with z/OS Connect EE IMS service provider when pinging IMS Connect.
  • PH23267 Message BAQR1143E Internal server error reported when changing the status of API requesters.
  • PH24239 A NullPointerException is reported when an incorrect PSB name is supplied with the IMS DB service provider.
  • PH24563 A NullPointerException is reported in the IMS database service provider setResourceFactoryRef method.
  • PH24608 The build timestamp of the IMS service provider is not reported correctly.
  • PH24677 The z/OS Connect EE build toolkit zconbt reports different version numbers depending on how it is run.
April 2020
V3.0.32 (APAR PH23299)

Server code update

Enhancements
  • The IBM MQ service provider with z/OS Connect EE is enhanced to provide advanced data transformation options for IBM MQ services, and the capability to send and receive IBM MQ messages up to 100MB in length for services that were created with the API toolkit. Services created with the build toolkit are limited to a message size of 32KB. For more information, see Create a two-way IBM MQ service.
  • z/OS Connect EE is enhanced to allow users to specify a custom CCSID when creating a CICS service. To use the custom CCSID, you implement your own CharsetProvider and Charset classes to extend the Java Runtime Environment (JRE). For more information, see How to specify a custom CCSID for a CICS service.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V20.0.0.3. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
Fixes
  • PH22476 The order of fields in the JSON response is not preserved by the IMS service provider.
API toolkit
V3.0.8.1 and V3.2.8.1
Enhancements
  • The z/OS Connect EE API toolkit is enhanced to support the creation of IBM MQ services in z/OS Connect EE service projects using the service project editor. For more information, see Create a two-way IBM MQ service.
March 2020
V3.0.31 (APAR PH22287)

Server code update

Enhancements
  • z/OS Connect EE has been enhanced to support the creation of IMS database services. IMS database services are created in the API toolkit by specifying IMS database connection information, an IMS database name, and SQL query. For more information, see Using the IMS database service provider.
Fixes
  • PH22959 The API_SERVICE_NAME field in SMF 123 subtype 1 V1 records always contains the service name.
  • PH18222 When an API is deleted from the file system, the API cannot be redeployed to another z/OS Connect EE server sharing the same zFS.
  • PH16762 Message BAQR7004E is written when an API is updated using the RESTful administration interface.
API toolkit
V3.0.8.0 and V3.2.8.0
Enhancements
  • The API toolkit is enhanced to support the creation of IMS database services by specifying IMS database connection information, an IMS database name, and SQL query. For more information, see Using the IMS DB Service provider.
Fixes
  • PH21858 PICTURE '999V99' fields in PL/I structures are imported as CHAR fields by the z/OS Connect EE API toolkit.
February 2020
V3.0.30 (APAR PH19977)

Server code update

Enhancements
  • You can now configure z/OS Connect EE to record SMF 123 subtype 1 version 2 records, which provide more detailed information about API provider requests. The version 2 records are not an extension of the version 1 records. Therefore, do not enable recording of version 2 records until all the products you use to process your records support this new version. For more information, see API provider data from SMF type 123 subtype 1 version 2 records.
  • Since z/OS Connect EE V3.0.16.0, a tracking token has been included on every request sent to CICS over IPIC. The tracking token is now moved from the USERCORRDATA field of the CICS task association data to the ODADPTRDATA1 field of the task association data. You must modify any CICS programs that use this field. For more information, see Tracking selected requests. If you are using IBM Z® APM Connect to monitor z/OS Connect EE, you must apply the IBM Z® APM Connect PTF UJ01628 before upgrading to z/OS Connect EE V3.0.30.0.
  • Both of the communication stubs for the z/OS Connect EE API requester are updated to set a return code, which is available to COBOL applications in the special variable RETURN-CODE. For more information, see Error handling for API requester calls.
  • To ensure that all error messages from the z/OS Connect EE API requester CICS communication stub can be accommodated in the TD queue, you must ensure that your BAQQ TD queue definition is set with the attributes RECORDSIZE=508 and BLOCKSIZE=512. The CICS BAQAPIR.CSD sample is updated accordingly.
  • The build toolkit is enhanced to check the presence of mandatory description fields and to detect errors in the Responses section of the Swagger document when building API requester artifacts. The enhanced build toolkit is V1.2. If you rebuild existing API requester artifacts with the new build toolkit, parsing of the Swagger document might now fail where it previously succeeded. For more information, see The z/OS Connect EE build toolkit
  • If you use the build toolkit in your DevOps automation, note that the text of the following messages has changed: BAQB0003, BAQB0022, BAQB0025 and message BAQB0012 has changed from type E to W. For more information, see z/OS Connect EE Build Toolkit Messages.
Fixes
  • PH04288 z/OS Connect EE API requester returns an incorrect BAQ-STATUS-MESSAGE-LEN value when using the CICS communication stub.
  • PH10042 BAQZCBT fails with message JVMCFRE003 bad major version.
  • PH10398 Message BAQB0017E Failed to process operation is issued when the + character is used in a property name.
  • PH10611 The z/OS Connect EE build toolkit does not report that the apikey is not supported in the path.
  • PH16570 The z/OS Connect EE build toolkit zconbt completes with code 0 even when some errors or warnings are reported.
  • PH16590 The z/OS Connect EE build toolkit reports "unsupported schema type:" for integer or boolean values.
  • PH19390 The z/OS application and IMS API requester communication stub truncates OAuth headers.
  • PH19824 Unexpected data is returned to an interceptor when querying HTTP headers.
API toolkit
V3.0.7.1
Enhancements
  • URL and DOC links can now be copied from the properties view of APIs and services within the API toolkit so that they can be easily pasted as text.
API toolkit
V3.2.7.1
Enhancements
  • URL and DOC links can now be copied from the properties view of APIs and services within the API toolkit so that they can be easily pasted as text.
January 2020
V3.0.29 (APAR PH19949)

Server code update

Enhancements
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V19.0.0.12. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
  • The z/OS Connect EE API requester is enhanced to allow you to specify the requireAuth attribute on the zosconnect_apiRequesters element for all API requesters. For more information about the attribute, see zosconnect_apiRequesters.
Fixes
  • PH15842 Message BAQR0553E does not give enough information when a connectionRef is defined in a SAR but the relevant connection is not.
  • PH20674 Message CWWKE0701E and a Java.lang.NullPointerException are reported in ApiManagerImpl after applying V3.0.28.0.
API toolkit
V3.0.7.0
Enhancements
  • The z/OS Connect EE API toolkit is enhanced to support the creation of Db2 service projects. The service can be defined by importing a Db2 service from the Db2 service manager. For more information, see Db2 services.
Fixes
  • PH17905 - The API toolkit allows an API with a base path containing only space characters to be deployed.
API toolkit
V3.2.7.0
Enhancements
  • The z/OS Connect EE API toolkit is enhanced to support the creation of Db2 service projects. The service can be defined by importing a Db2 service from the Db2 service manager. For more information, see Db2 services.
Fixes
  • PH17905 - The API toolkit allows an API with a base path containing only space characters to be deployed.
December 2019
V3.0.28 (APAR PH19001)

Server code update

Enhancements
  • z/OS Connect EE API requester is enhanced to support JWT caching. For more information, see JSON Web Token (JWT) caching.
  • New interceptor interfaces are added that enable monitoring of API requests between z/OS Connect EE and the system of record, and requests that fail early before interceptors are currently invoked. Interceptor writers can take advantage of these new capabilities by implementing either or both of the new interfaces ServiceProviderInterceptor and EarlyFailureInterceptor. For more information, see Creating a monitoring interceptor
  • The credentials stored in a SAF cache can now be cleared by using a new parameter on the modify command. SAF credentials can also be made to expire automatically by setting a new attribute on the zosconnect_authorizationInterceptor configuration element.
  • z/OS Connect Enterprise Edition Unlimited, V3 delivers a new pricing metric option to clients who might want to enable the deployment of unlimited server instances for a set price. It includes the same features as z/OS Connect Enterprise Edition V3. For more information, see Announcement letter 219-467
Fixes
  • PH02075 The z/OS Connect EE API toolkit fails to deploy AAR files containing clashing variable and fixed elements.
  • PH18448 BAQR1145E API endpoint connection error , followed by CEE3500S Not enough storage was available to load module.
  • PH18497 Performance issue with API requester ID assertion for user IDs which are in a large number of SAF groups.
  • PH16753 z/OS Connect EE service requests fail with message BAQR0452E after WOLA service archive file update of a COMMAREA service.
November 2019
V3.0.27 (APAR PH18365)

Server code update

This refresh contains maintenance fixes only.
October 2019
V3.0.26 (APAR PH16810)

Server code update

Enhancements
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V19.0.0.9. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
Fixes
  • PH15486 - Policy definitions do not modify the IMS transaction code when invoking IMS large data services.
End of support
  • Support for Java™ 7 and the IBM SDK and JRE for Java 7 is removed. For more information, see Requirements.
API toolkit
V3.0.6.10
Enhancements
  • The z/OS Connect EE API toolkit has been enhanced with the capability to expose service fields in JSON payloads as a Boolean data type. By defining specific request and response conditions to process true or false values for a given service field, the definition of the underlying COBOL or PL/I application field remains unchanged. For more information, see Defining service fields.
    Note: z/OS Connect EE Version 3.0.26 or later is required.
Fixes
  • PH15899 - A negative time error is reported when importing a SAR file and then setting the Windows locale to Thai.
API toolkit
V3.2.6.10
Enhancements
  • The z/OS Connect EE API toolkit has been enhanced with the capability to expose service fields in JSON payloads as a Boolean data type. By defining specific request and response conditions to process true or false values for a given service field, the definition of the underlying COBOL or PL/I application field remains unchanged. For more information, see Defining service fields.
    Note: z/OS Connect EE Version 3.0.26 or later is required.
Fixes
  • PH15899 - A negative time error is reported when importing a SAR file and then setting the Windows locale to Thai.
September 2019
V3.0.25 (APAR PH15511)

Server code update

Enhancements Fixes
  • PH00006 - Message DFHPI9730E is misleading when a field greater than 32KB is created using the z/OS Connect EE build toolkit.

    PH15332 - z/OS Connect EE transformation array counter functionality thread safety issue can cause incorrect values.

    PH16284 - z/OS Connect EE API requester receives 403-Authorization error when invoking an API configuration to support identity assertion.

API toolkit
V3.0.6.9
Fixes
  • PH15332 - When processing multiple concurrent requests using the array counter functionality that was introduced in z/OS Connect EE V3.0.23, they could interact causing incorrect values to be used. z/OS Connect EE transformation array counter functionality thread safety issue can cause incorrect values.
API toolkit
V3.2.6.9
Fixes
  • PH15332 - When processing multiple concurrent requests using the array counter functionality that was introduced in z/OS Connect EE V3.0.23, they could interact causing incorrect values to be used. z/OS Connect EE transformation array counter functionality thread safety issue can cause incorrect values.
August 2019
V3.0.24 (APAR PH14597)

Server code update

Enhancements
  • z/OS Connect EE supports identity assertion for API requesters. With the identity assertion support, you can invoke an API requester from a z/OS application with an identity that is provided in the application context. For more information, see Identity assertion for API requesters.
  • If you use an interceptor to monitor requests, the Data Interface in the z/OS Connect EE SPI is updated to provide system of record information for the REST and WOLA service providers. In addition, the SAF mapped user identity associated with a request can now be obtained, if one exists. For more information, see com.ibm.zosconnect.spi (z/OS Connect SPI) in the Reference section.
  • The REST client service provider now sends the User-Agent HTTP header on requests to identify the client as z/OS Connect EE with the version number.
Fixes
  • PH14220 - Using z/OS Connect EE policies to alter the IMS transaction code causes IBM OMEGAMON® for JVM on z/OS to report incorrect data.
  • PH13803 - An API requester program receives message BAQI0005E after applying the PTF for APAR OA56234.
  • PH11435 - Message BAQR0409W does not identify the resource that could not be accessed.
July 2019
V3.0.23 (APAR PH13344)

Server code update

Enhancements
  • Customers using API requester can now call the BAQCTERM function from their IMS applications to close and clear the cached connection used by z/OS Connect EE.
    Attention: If you use API requester and cached connections with IMS, you must add a call in your IMS application to close and clear the cached connection. Failing to do this will lead to memory not being reusable until the IMS process terminates.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V19.0.0.6. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
Fixes
  • PH09124 - Class loading issue for com.ibm.jsse2 when enabling an AT-TLS connection for the IMS service provider.
  • PH09275 - z/OS Connect EE does not correctly apply updates to zosConnectAPI sub elements.
  • PH11409 - An API or service request with a Accept-Encoding:gzip,deflate header fails with HTTP response code 500 and message BAQR0429W.
  • PH12685 - A monitoring interceptor throws a NullPointerException for an unauthorized z/OS Connect EE user ID.
API toolkit
V3.0.6.7
Enhancements
  • The API toolkit is enhanced to allow numeric service fields to be defined as counters for fixed and variable-length arrays. These array counters are used to optimize both the necessary service data required for an API request, as well as the JSON payload issued from an API response. To learn more about array counters, see Defining service fields.
    Note: Check compatibility for this feature in Capabilities compatibility.
API toolkit
V3.2.6.7
Enhancements
  • The API toolkit is enhanced to allow numeric service fields to be defined as counters for fixed and variable-length arrays. These array counters are used to optimize both the necessary service data required for an API request, as well as the JSON payload issued from an API response. To learn more about array counters, see Defining service fields.
June 2019
V3.0.22 (APAR PH11931)

Server code update

Fixes
  • PH11690 - Calling a non-existent service causes an FFDC record to be written for each service called.
  • PH09188 - The z/OS Connect EE built toolkit creates an invalid service archive file on z/OS.
  • PH08996 - Message DFS064 does not provide enough information to identify the cause of the problem.
API toolkit
V3.0.6.6
Fixes
  • PH11166 - Existing CICS and IMS data structures cannot be re-imported using the z/OS Connect EE API toolkit.
  • PH12148 - Using Microsoft Windows Group Policies to customize the Internet Explorer UserAgent string results in an unsupported configuration for Swagger UI.
API toolkit
V3.2.6.6
Fixes
  • PH11166 - Existing CICS and IMS data structures cannot be re-imported using the z/OS Connect EE API toolkit.
  • PH12148 - Using Microsoft Windows Group Policies to customize the Internet Explorer UserAgent string results in an unsupported configuration for Swagger UI.
May 2019
V3.0.21 (APAR PH11043)

Server code update

Enhancements
  • The IBM MQ service provider is now built into the z/OS Connect EE server, so you do not need to copy it from an IBM MQ installation data set. The new IBM MQ service provider adds support for generating service archive files with the Build Toolkit. The resulting .sar files can then be deployed directly to the z/OS Connect EE server. For more information, see Using the IBM MQ service provider.
  • The Security section of the IBM Knowledge Centre has been enhanced for API requesters to provide more information about the security methods supported by z/OS Connect EE. The new content provides more conceptual information that will help you to choose the most suitable configuration for your installation. For more information, see Securing z/OS Connect EE resources.
Fixes
  • PH08317 - z/OS Connect EE does not provide sufficient diagnostic information for Db2 RESTful service failures.
  • PH08248 - When an .ara file was updated on the file system, z/OS Connect EE did not check whether the updated .ara file was a duplicate of an API requester already loaded into the z/OS Connect EE server's memory. This resulted in the API requester in the z/OS Connect EE server's memory being corrupted.
  • PH08140 - z/OS Connect EE build toolkit reports a "main" java.lang.StackOverflowError.
  • PH07028 - z/OS Connect EE API requester calls are repeated after a timeout failure.
  • PH05927 - The ws-schemagen.jar tool generates an incorrect schema for a z/OS Connect EE installation.
API toolkit
V3.0.6.5
Fixes
  • PH09920 - The IMS service provider does not support space delimited IMS transaction codes which are less than 8 bytes in length. A new API toolkit option, Space delimited, is added to the Service Editor to allow space delimited IMS transaction codes to be defined.
  • PH10952 - The Swagger UI "Try it out!" function in the API toolkit returns cached data from the browser if parameters are not changed between function calls.
April 2019
V3.0.20 (APAR PH09950)

Server code update

Enhancements
  • A new capability is available that enables monitoring products to implement selective tracking of z/OS Connect EE requests in the System of Record that processes the request. This capability is currently limited to API provider requests that are sent to CICS and IMS systems. To take advantage of this capability, interceptor writers must implement the new TrackingInterceptor interface. For more information, see Tracking selected requests.
  • Multiple group names can now be specified for the invoke, operations and reader authorization groups. This enhancement applies to both the global authorization attributes on the zosconnect_zosConnectManager element, as well as for specific authorization attributes on the zosconnect_zosConnectAPIs > zosConnectAPI, zosconnect_services > service, zosconnect_zosConnectService and zosconnect_apiRequesters > apiRequester elements. Multiple group names were already supported for the administration authorization groups. See Configuration elements.
    Important: If you upgrade to 3.0.20.0 and you are currently using the Authorization interceptor with an LDAP registry, even if you do not use multiple groups, you must change the values of admin, invoke, operations, and reader group attributes to escape the commas in LDAP group names.
Fixes
  • PI97411 - Specifying JSON-SCHEMA-CODEPAGE=UTF-8 corrupts the JSON schemas in generated SAR files.
  • PH06013 - globalAdminGroup and adminGroup attributes do not work when an LDAP registry is specified.
API toolkit
V3.0.6.4
Fixes
  • PH10225 - SAR files containing double byte characters cannot be imported into the API toolkit.
  • PH09240 - Using the z/OS Connect EE API toolkit with invalid credentials causes the user ID to be revoked unexpectedly.
  • PH07557 - The JSON RESPONSESCHEMA reported by DB2 service DISCOVER is incorrect.
March 2019
V3.0.19 (APAR PH08861)

Server code update

Fixes
  • PH08209 - Adds support for CICS 5.5 to WebSphere Optimized Local Adapters.
API toolkit
V3.0.6.3
Fixes
  • PH08772 - When the API toolkit is installed into IBM Developer for z Systems (IDz), "project xx not open" errors are logged by the z/OS Connect EE project builders.
February 2019
V3.0.18 (APAR PH07350)

Server code update

Enhancements
  • Diagnostics in the IMS or z/OS applications stub is improved with the addition of new messages and trace information. For more information, see Error handling for API requester calls.
  • The Security section of this IBM Knowledge Center is extensively rewritten to provide more information about the supported security methods when z/OS Connect EE is used as an API provider. The new content provides more conceptual information and improved samples that helps you to choose the most suitable configuration for your installation. See Securing z/OS Connect EE resources.
  • When interceptors that are defined globally or specifically for APIs or services, are activated and deactivated, messages are now written to the messages.log file to provide verification of interceptor configuration.
Fixes
  • PH00662 - Message BAQI0004E is received in response to an API requester call from an IMS or z/OS application.
  • PH00704 - Unhelpful messages are issued by the z/OS Connect EE API requester communication stub for IMS and z/OS applications.
  • PH03346 - Failed updates to an API can cause the .aar file to be deleted from the z/OS Connect EE server.
  • PH03436 - A message "Retrieving network security from interaction spec" is written to the messages.log for each IMS SP request.
  • PH04711 - A GMOMW0005E data conversion error message is reported for a field that is defined as PIC V9(8) by z/OS Connect EE.
  • PH05135 - The z/OS Connect EE build toolkit, zconbt, reports BAQB0038E: Unexpected error has occurred during an .aar build: No space left on device.
  • PH08237 - A z/OS Connect EE API requester application received return code BAQ-SUCCESS when the request was not successful.
  • Resolution of memory problems in the z/OS Connect EE API requester communication stub for IMS and z/OS applications.
API toolkit
V3.0.6.2
Fixes
  • PH03342 - An API created with invalid duplicate paths using API toolkit earlier than V3.0.5.1 is deployed despite reported errors.
  • PH04314 - The z/OS Connect EE API toolkit allows the user to set a default value for the response service interface.
January 2019
V3.0.17 (APAR PH06570)

Server code update

Enhancements
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V18.0.0.4. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
Fixes
  • PH00368 - The z/OS Connect EE build toolkit generates copybooks with illegal nesting levels.
  • PH03485 - The z/OS Connect EE build toolkit generates API archives with COBOL data structure field names that end with hyphens.
  • PH05307 - Message BAQR1140E is written when a z/OS Connect EE RESTful API with OAuth configured is invoked.
  • PH06095 - An API passes index value array fields but the program receives spaces.
December 2018
V3.0.16 (APAR PH05647)

Server code update

Enhancements
  • The format of DateTime output of the file system logger has been corrected to give the time in 24-hour rather than 12-hour format, and the precision is extended to include milliseconds. For more information, see Configuring the file system logger interceptor.
  • The Data SPI that provides request-specific data to both interceptors and services, is enhanced to provide additional data.

    API, service, and administration requests are now clearly distinguished. Timestamps enable the calculation of the z/OS Connect EE processing time and the time spent connecting to the system of record. Other information now available includes data about the system of record when using the CICS or IMS service provider and the HTTP response code. In addition, a unique correlator is sent on each request to CICS and IMS systems to enable monitoring products to track z/OS Connect EE requests.

    For more information, see z/OS Connect EE SPI Javadoc in the Reference section.

  • The Security Overview topic in the IBM Documentation has been rewritten to provide more information useful to solution architects and security administrators. See Overview of z/OS Connect EE security.
  • The IBM Documentation has a new section to provide information about improving the performance of z/OS Connect EE servers, APIs and services. See Performance considerations.
Fixes
  • PH04997 - Adding the zosLocalAdapters-1.0 feature to the z/OS Connect EE server configuration causes message CWWKE0701E.
  • PH05806 - z/OS Connect EE service specific interceptors are not used for some administration options.
  • PH06538 - Messages BAQR7057E and BAQR7033E are written when deploying an API with the updated API toolkit V3.0.6.0.
API toolkit
V3.0.6.1
Fixes
  • PH07327 - Authorization interceptors do not correctly handle RACF® reader group which results in message BAQR0428W being written.
API toolkit
V3.0.6.0
Enhancements
  • The API toolkit is enhanced to allow the definition of multiple response codes for an API operation. Rules that are specified for each response code are used to determine the HTTP status code, and unique response mapping, that are returned in the HTTP response. For more information, see How to define multiple response codes

    Support for the multiple response codes capability provided in this release requires V3.0.16 of the z/OS Connect EE server runtime. If you plan on upgrading the API toolkit to V3.0.6, ensure that you also upgrade the z/OS Connect EE server runtime to V3.0.16.

Fixes
  • PH03360 - A blank path prevents Swagger from working in the API toolkit Swagger UI.
November 2018
V3.0.15 (APAR PH05461)

Server code update

Enhancements Fixes
  • PI98283 - z/OS Connect EE setting preserveJsonObjectPayloadOrder="true" is not honored for APIs.
  • PH04287 - z/OS Connect EE API requester archives (ARAs) are not loaded and applications receive message BAQR1131E.
  • PH04600 - z/OS Connect EE message BAQR1106E <filename> is incomplete. Missing file: api//POST/mapping.xml is issued.
October 2018
V3.0.14 (APAR PH03400)

Server code update

Enhancements
  • The RESTful administration interface for API requesters is enhanced to add the POST, PUT, and DELETE methods to support API requester deployment, API requester update, and API requester removal. For more information, see How to use the RESTful administration interface to manage API requesters.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V18.0.0.3. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
  • When services and APIs are deployed, a compatibility check is made to ensure that the capabilities of the service or API are compatible with the current release of the z/OS Connect EE runtime. Messages BAQR7085E and BAQR7086E are issued if a compatibility issue is found.
Fixes
  • PI95793 - Services cannot be displayed via HTTP when requireSecure="true" is set on one of the zosconnect_zosConnectService definitions.
  • PH02634 - Message BAQR0666E is reported on startup when IPIC connections to CICS over SSL are in use.
  • PH02652 - Base64 encoded basic auth data is present in z/OS Connect EE trace.
  • PH04052 - Intermittently, no response is received when using z/OS Connect EE API requester from a CICS transaction.
September 2018
V3.0.13 (APAR PH02414)

Server code update

Fixes
  • PI90297 - When a SAR file causes a problem in the z/OS Connect EE SAR loader, the loader stops, preventing further attempts to load SAR files. As a result, services cannot be displayed by the z/OS Connect EE API toolkit nor can they be started.
Technotes
August 2018
V3.0.12 (APAR PH01052)

Server code update

Fixes
  • PI99540 - A CICS service provider service does not return a response if the CICS container is deleted and added again.
  • PI92644 - z/OS Connect EE reports a NullPointerException on SAR update when multiple zosconnect_services elements are defined.
Technotes
API toolkit
V3.0.5.3
Fixes
  • PI93123 - The payload on a request is corrupted because z/OS Connect EE generates an incorrect length field used in the schema.
July 2018
V3.0.11 (APAR PI99563)

Server code update

Enhancements
  • z/OS Connect EE policies can now be applied to specific APIs. You define the policy to use in the zosconnectAPI element of the configuration file. For more information, see Configuring z/OS Connect EE policies
  • Server templates now use setUTF8ResponseEncoding="true" on the server configuration file element zosconnect_zosConnectManager to set the response character encoding to UTF-8 for newly created server instances. The default setting has not changed, so existing servers are not affected.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V18.0.0.2. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
    Note: Liberty V18.0.0.2 is only compatible with the Angel process included with Liberty V18.0.0.2. For more information, see Compatibility issue with Liberty V18.0.0.2 and the Angel process.
Fixes
  • PH00403 After many requests are made to BAQCSTUB, message BAQI0902E is issued to indicate insufficient storage.
API toolkit
V3.0.5.2
Fixes
  • Hover help in service interface editor does not highlight the behavior and precedence of field value.
  • Service and API project wizards do not check that an API or service name is POSIX portable. Service names, API names, AAR file names, and SAR files names are now all checked to be POSIX portable to prevent z/OS UNIX file system errors.
  • Minimum array occurrences for a response are not enforced. A new advanced option Enforce minimum array occurrence is added in the Service Editor to enable validation of minimum array occurrences for response interfaces.
  • Meaningful error messages are not provided on copybook import for service project. When importing source that contains COBOL or PL/I data structures, the UI now displays detailed information on structures that were omitted due to having unsupported data types.
  • z/OS Connect actions still show for both API and Service options in right-click menu after right-clicking to close a service or API project in Project Explorer. No z/OS Connect actions appears on closed projects now.
  • Exporting an API with no services in methods still creates a .aar file on disk.
June 2018
V3.0.10 (APAR PI98232)

Server code update

Enhancements Fixes
  • PI97371 - URISyntaxException: Illegal character in path is returned if a z/OS Connect EE service with a space in the name is deployed.
API toolkit
V3.0.5.1
Fixes
  • APAR PI76190: An API exported to an AAR file has a different name when deployed using the REST interface.
  • Service information is incorrectly generated when the service project name contains a space.
  • API toolkit incorrectly allows APIs with duplicate paths.
  • API operations in generated Swagger should be tagged with the API title.
  • The API toolkit does not remember the last export location for service archive and API archive.
  • The API editor does not remember the last service import location.
  • Editors in the API toolkit are not clearly labeled to ease communication. Titles are now added or modified in the service project editor, service interface editor, and API editor. The Overview tab in the service project editor is renamed to Definition to more appropriately reflect the purpose of the page.
May 2018
V3.0.9 (APAR PI96947)

Server code update

Enhancements
  • Support for array type query parameters, path parameters, and HTTP headers for APIs is added. This feature requires API toolkit V3.0.5 or later. For more information, see Defining and mapping headers, query parameters, or path parameters.
  • When a request times out due to the setting of the asyncRequestTimeout attribute on the zosconnect_zosConnectManager element in server.xml, the client now receives a 503 HTTP response code, instead of a 500 HTTP response code, see Configuration elements.
  • The CICS service provider is updated so that if a request is timed out during asynchronous processing, the request is terminated and the associated IPIC session is freed. Previously the request would be left to attempt to run to completion in the server. For more information, see Handling request timeouts.
  • The requestStateMap parameter that is passed on the invoke method of the com.ibm.zosconnect.spi.Service interface has been updated to contain a new key, IBM_ZOS_CONNECT_TIMEOUT, which contains the time remaining for an asynchronous request. This enables service providers to terminate processing and free resources when a request is timed out.
  • The Welcome page of this product documentation has been enhanced with links to the most important topics so you can easily find what you need. We welcome your comments or suggestions for improvement of the documentation. Use the comments box at the base of each page to provide feedback.
Fixes
  • APAR PI90630: Message GMOBA0113E is not written to the z/OS Connect EE messages.log file.
  • APAR PI94737: z/OS Connect EE does not honor preserveJsonObjectPayloadOrder="true".
  • APAR PI97210: A z/OS Connect EE service receives an incomplete response and message BAQR0404W is reported.
API toolkit
V3.0.5
Enhancements
  • For request and response message mapping in the mapping editor, the data type for HTTP headers, query parameters, and path parameters can now be set to array. When the data type is set to array, you must specify the array data type (string, integer, boolean or number) and array format, which defines how the values in the parameter or header are delimited. This new feature requires server code V3.0.9 or later. For more information, see Defining and mapping headers, query parameters, or path parameters.
Fixes
  • APAR PI97244: The API toolkit throws an exception when a service project is exported to a service archive (.sar) file from a directory that is different from the current workspace. The API toolkit has been updated to support service project export from a location that is different from the current workspace.
  • APAR PI97413: When the base path of an API is specified with an ending slash ("/"), calling the deployed API from the embedded Swagger UI resulted in a BAQR7040E error message stating that the resource is not found. The API toolkit has been updated to not allow an ending slash in the API base path.
April 2018
V3.0.8 (APAR PI95501)

Server code update

Enhancements
  • The build toolkit is updated to V1.1 to support the generation of the service archive (.sar) file and API archive (.aar) file from project directories created in the API toolkit. After a service project or API project is created or modified in the API toolkit, you can run the build toolkit to generate the service archive or API archive with the project directory as the input. This functionality enables continuous integration and delivery of services and APIs in a DevOps environment. For more information, see DevOps with z/OS Connect EE.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V18.0.0.1. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
  • For users generating artifacts for an API requester, the z/OS Connect EE build toolkit can now process the allOf keyword in a Swagger file.
Fixes

This release addresses the following issue:

  • PI92773 SAR file changes are not retained on z/OS Connect EE server restart.
API toolkit
V3.0.4.1
Fixes

This release addresses the following issues:

  • Unable to open an API in the Swagger UI when the API name contains special characters.
  • The help button in the Import Input or Output Message Data Structures dialog does not link to the correct topic.
  • No service deployment icon in the Configuration tab in the service project editor for ease of service deployment.
  • The buttons for adding and removing context containers HTTP headers in the Configuration tab for CICS channel services need appropriate tool tips.
March 2018
V3.0.7 (APARs PI88452, PI89182, PI91663, PI93350)

Server code update

Enhancements
  • CICS service provider services can now be configured to send context containers to CICS programs, providing the program with information about the context in which the service was invoked. The use of context containers can be configured in both the API toolkit and the build toolkit. For more information, see Context containers.
Fixes
  • The IMSPingService service that tests if the IMS service provider is configured correctly for communication with IMS Connect was throwing a NullPointerException. This issue is addressed. For more information about the IMS Ping service, see Verifying server communication with IMS.
  • The z/OS Connect EE server tried to process integer fields even though they were not requested and not sent. This caused a NullPointerException and message BAQR7020E was written to the messages.log.
  • Data conversion problems returned an HTTP 500 error with no error details. This fix now returns an HTTP 400® bad request error, with the data conversion error details included in the JSON response. Some GMOMW messages for the data conversion function have been updated to use the correct term service interface instead of transaction message. See GMOMW messages for the updated message texts.

API toolkit

V3.0.4

Enhancements
  • CICS channel services can now be configured to send context containers to the target CICS program. This includes the ability to name specific HTTP headers to be sent when they are present on the request. Properties in the configuration tab have also been enhanced to use tool tips and provide context sensitive help.
Fixes
  • Tool tips are added to clarify the usage of the Container name and Interface rename fields for CICS channel services.
February 2018
V3.0.6 (APAR PI93830)

Server code update

Enhancements
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V17.0.0.4. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
  • The Scenario section of this IBM Knowledge Center is enhanced to make it easier for you to start using the features of z/OS Connect EE. See Quick Start Scenarios and Calling an API from a System of Record (SoR).
  • You can now use polling or MBeans to dynamically update and activate changes made to rule sets used by policies without needing to restart your server. Alternatively you can use the Refresh Modify command to apply changes to your policies and rules sets. For more information, see Administering z/OS Connect EE policies.
  • z/OS Connect EE now supports API key authentication. When calling APIs that are protected by API keys, your z/OS application can send the API key credentials through z/OS Connect EE either in a query string or as a request header. For more information, see Call an API secured with an API key.
Fixes
  • Previously the generated ims-connections.xml file upon initial creation of a server instance based on the imsmobile template contained the connectionTimeout and connectionType attributes that have no effect in z/OS Connect EE V3. However, if the connectionTimeout attribute was removed from the ims-connections.xml file, a CWWKG0058E error was incorrectly thrown upon server startup, complaining that the required connectionTimeout attribute was missing. These issues are now corrected. The generated ims-connections.xml file no longer contains these two extraneous attributes, and the connectionTimeout attribute is not expected to be present upon server startup.

API toolkit
V3.0.3.1

Fixes

For service creation, FIXED BINARY and UNSIGNED FIXED BINARY (UBYTE) data types in PL/I were incorrectly converted to a data type of string in the generated JSON schema. They are now correctly converted to the data type of integer. This fix requires server code V3.0.6.

January 2018
V3.0.5 (APAR PI92254)

Server code update

Enhancements
  • z/OS Connect EE build toolkit is enhanced to support JSON additional properties that are not explicitly defined in the properties section of a Swagger file. A new attribute additionalPropertiesSize is added in the build toolkit properties file. You can use this attribute to specify the maximum size for each JSON additional property when you use the build toolkit to generate artifacts for an API requester.
  • A sample COBOL application that calls out to a REST API through the API requester is provided in the hlq.SBAQSAMP data set. Two versions of the sample application are available: BAQPHBKI (IMS transaction) and BAQPHBKB (z/OS application). These samples are used in the Call an API from an IMS or z/OS application scenario, which provides step-by-step instructions on the required configuration, artifact generation, and client application development.
  • z/OS Connect EE build toolkit has been enhanced for the API Requester to support multidimensional arrays defined in Swagger files.
  • The version of Liberty that is embedded in z/OS Connect EE is upgraded to V17.0.0.3. For more information, see What is new in this release of Liberty in the WebSphere Application Server for z/OS Liberty documentation.
December 2017
V3.0.4 (APAR PI90096)

Server code update

Enhancements
  • The RESTful service administration interface is updated to version 1.1.0. This new version adds the support for POST, PUT, and DELETE methods to support service deployment, service updates, service status updates, and service removal. You can also retrieve the service request schema and response schema with the GET method by using a URI without the action=getRequestSchema query string. For more information, see Administering services with the administration interface.
  • z/OS Connect EE is enhanced to support OAuth 2.0 to allow a z/OS application to call an API that is protected by OAuth 2.0 on a request endpoint. For more information, see Call an API secured with OAuth 2.0.
  • By using variable substitution in policy rules, you can override the IMS transaction code (imsTranCode) that the service invokes at run time. For more information, see Valid properties for use in policy rules.

API toolkit
V3.0.3

Enhancements
  • API toolkit V3.0.3 adds the support for deploying services directly from your service project without having to export the project to a service archive. You can view all deployed services, examine service properties, update a service, and start and stop a service directly from within the API toolkit. Server code V3.0.4 is required.
November 2017

Server code update

V3.0.3 (APAR PI88611)

Enhancements
  • You can use CICS IPIC high availability to provide a single point of access from a z/OS Connect EE server to a cluster of CICS regions via a TCP/IP network. For more information, see CICS IPIC high availability.
  • The global admin group and admin group of a specific resource (services/ APIs/ API requesters) are enhanced to support multiple groups. You can set the value of the globalAdminGroup or adminGroup attribute in the server.xml file to a group name list with separating comma. The administration requests that are submitted by a user who belongs to any group listed in globalAdminGroup or adminGroup can be processed.
  • You can now use z/OS Connect EE policies to adjust how an API request is processed in z/OS Connect EE, based on the HTTP header values sent in by the client. For more information, see Administering z/OS Connect EE policies.
Fixes

Empty array elements from service-level data conversion based on the settings in the Advanced Service Data Conversion Options dialog (by clicking Advanced Options in the service project editor in the API toolkit) are now correctly removed from the JSON output. If no valid array elements were converted, the array is completely removed from the JSON. For more information about advanced data conversion options, see Service-level data conversion customization.

API toolkit
V3.0.2.1

Fixes

This release includes minor fixes, including better user input validation of the value type for CCSID (CICS services) and the maximum length for transaction code (IMS services).

October 2017

API toolkit
V3.0.2

Enhancements
  • When customizing service interfaces, you can now use the Code page conversion option in the Edit Field dialog to indicate whether data of the CHAR type should be converted between UTF-8 and the host code page (such as IBM-1140) for the request and response interfaces.
    • By default, for the request interface, the JSON property value is converted from UTF-8 to the host code page prior to being placed in the respective field.
    • By default, for the response interface, the field value is converted from the host code page to UTF-8 prior to being placed in the respective JSON property value.

    This default behavior can be turned off by clearing the Code page conversion option.

Fixes
  • The mapping editor no longer interprets JSON properties of type number as integers when the number type has no fraction digits. The previous behavior was causing incorrect validation where incoming numeric quantities were limited to 10 digits.
  • When you right-click a server in the z/OS Connect EE Servers view and select Refresh, the result now returns noticeably faster when you have more than a few deployed APIs.
  • The mapping editor now correctly populates Swagger with type information for query parameters, path parameters, and headers that are mapped to float or double type service fields.
September 2017

Server code update

V3.0.2 (APARs PI85054 and PI87854)

Enhancements
  • The CICS service provider is enhanced to support distributed identity propagation to CICS during CICS authorization and for subsequent accountability and trace purposes. Distributed identities must be defined in an LDAP user registry and mapped to one or more SAF user IDs. Alternatively, an authenticated SAF user ID associated with the current request, can be passed to CICS for use during CICS authorization. The SAF user ID can originate from basic SAF credentials, an SSL client certificate, or other credential such as a JWT token, associated with A SAF user ID. Distributed identity support requires an IPIC connection that is configured with Userauth=Identify. For more information, see Configuring security for an IPIC connection.
  • The IMS service provider is enhanced to support distributed identity propagation to IMS Connect V15 for subsequent accountability and trace purposes. A distributed identity consists of a user ID and a network session ID (or realm). The user ID must be defined in an LDAP user registry, basic registry, or SAF registry. When the IMS service provider detects that the IMS Connect it is connecting to is V15, it sends the distributed identity by default. This distributed identity is not used by IMS for authentication or authorization purposes. For more information, see Configuring distributed identity propagation to IMS.
  • A PL/I sample is added to demonstrate how to handle large IMS data structures. The entire set of samples is also enhanced to allow setting and experimenting with different data structure sizes.
    • A sample PL/I transaction program, its copybook, and related utilities and JCLs are added to the SBAQSAMP sample data set.
    • This set of samples is enhanced to allow you to set the size of the data structure that is sent to and received from IMS by changing the number of IO_RECORD array objects in the provided sample JSON documents. The existing COBOL sample is updated to work with this enhancement.
    For more information, see Handling large IMS data structures.
    Note: Three member names for the existing COBOL sample have changed. The letter P in the following member names are removed: BAQLDSP (sample transaction) is now BAQLDS, BAQLDSPC (sample copybook) is now BAQLDSC, and BAQLDSPJ (sample JCL) is now BAQLDSJ. The letter P is used only in members that are for the PL/I sample.
  • The API requester is enhanced to support connection pooling in z/OS Connect EE to improve the efficiency of resource access to the request endpoints. For more information, see Connection pooling.
  • The API requester is enhanced to support specifying an additional domain path in a URL for an API that your z/OS applications plan to call. For more information, see Setting the domain base path.
  • New features are provided in the z/OS Connect EE product documentation:
    • With the addition of two new languages, Spanish and Traditional Chinese, the IBM Documentation for z/OS Connect EE is now translated into 14 languages.
    • Where a code example is provided, you can now click "Copy to Clipboard" icon to copy the code into your clipboard.
    • APARs included in this release are listed in the documentation. They include links to the full description of the APAR.
APARs
  • Fixes for the following APARs are included in this release.
    • PI83974 Message BAQR7019E is returned when a value longer than 10 digits is specified in an API GET request.
    • PI84080 ERROR 400 BAQR7018E: The HTTP request is missing parameter <parm_name>
    • PI84077 z/OS Connect EE always uses channel JSONCHANNEL with the CICS service provider
    • PI85476 The z/OS Connect EE IMS SP issues a NullPointerException when requireAuth="false" is set and a service is invoked
    • PI85913 Updates to IMS service provider SARs are not processed
    • PI83974 z/OS Connect EE writes unnecessary information to SMF
Other fixes
  • For the IMS service provider, additional issues are addressed:
    • Setting a transaction code in the imsTranCodeOverride attribute in the server.xml file for an IMS service resulted in a NullPointerException error.

      This issue is addressed. You can now specify the transaction code to invoke at run time by using the imsTranCodeOverride attribute for IMS services in the server.xml file. This transaction code takes precedence over the transaction code that is contained in the service archive, as defined in the z/OS Connect EE API toolkit during development time. For more information, see Transaction code override precedence.

    • The default value for the imsConnectTimeout property in the IMS interaction profile is changed from 0 (wait indefinitely) to 30,000 milliseconds (30 seconds). This change helps prevent an API call from waiting indefinitely for a transaction call that never returns if the default value for imsConnectTimeout is left as-is, or the property is simply not specified.

API toolkit
V3.0.1

Enhancements
  • A new service type IMS Large Data Structure Service is added to support importing a program with large data structures into the service interface editor for effective service interface definition.
Fixes
  • API toolkit V3.0.1 addresses the following issues:
    • When COBOL copybooks or full programs or PL/I includes or full programs contain POINTER types, the import wizard does not tolerate POINTER types even though they are not part of the data structure the user selects. For COBOL, the message "POINTER not yet supported" is displayed and the data structure name remains disabled. For PL/I, the message "POINTER not yet supported" is displayed, and the user is allowed to select a structure. However, when the structure is expanded in the service interface editor, a null pointer exception occurs. This issue is addressed, and data structures containing POINTER types are now omitted from the data structure selection, allowing the user to proceed to select the structure to import.
    • PL/I leaf arrays are not converted correctly for REFER statements, with minItems incorrectly set to 1 and maxItems set to 2 in the JSON schema. This issue is addressed. minItems is now set to 0 unless an LBOUND exists for the REFER array, whereas maxItems is always unbounded.
    • PL/I string type leaf arrays are not converted correctly in the maxLength facet in the JSON schema. For example, an array of 5 items of a total of 255 characters, as shown in the following sample, is generate with a maxLength of 1275, when the maxLength should be 255.
      04 String_Array(5) CHARACTER(255)
      This issue is addressed.
July 2017

Server code update
V3.0.1  
(APAR PI83949)

Enhancements
  • A new feature, API requester, is now available in z/OS Connect EE. The new API requester feature allows z/OS applications to call REST APIs through z/OS Connect EE. You can use the build toolkit to generate the required artifacts based on the API description file of the REST API you plan to call. For more information, see z/OS applications to call REST APIs.
Fixes
  • Stopping an IMS service resulted in an IMSGatewayException error, stating that "the creation or change to the <serviceName> configuration element SERVICE was not processed by the server." This issue is addressed.

API toolkit
V3.0.0.1

Enhancements
  • The Remote Systems view is now available in the z/OS Connect EE perspective to ease service deployment. For more information about creating a connection to a remote system, see Creating a connection to a z/OS system (IBM Explorer for z/OS V3.1 product documentation).

New features introduced in z/OS Connect Enterprise Edition V3.0

z/OS Connect Enterprise Edition V3.0 builds upon the capabilities in IBM z/OS Connect Enterprise Edition V2.0 with these new features.

API toolkit

  • The new IBM z/OS Connect Enterprise Edition V3.0 API toolkit simplifies the definition and deployment of application services for CICS and IMS environments. Previously known as the z/OS Connect Enterprise Edition API editor in V2, the z/OS Connect Enterprise Edition API toolkit now provides additional functions for service creation.
  • The API toolkit provides a new type of project for services to complement the API projects, enabling end-to-end creation of z/OS Connect EE API and dependent services from within the same Eclipse-based environment.
  • The new service projects that are introduced with the Service Interface Editor in the API toolkit, increase the number of eligible z/OS-based applications that can be API-enabled to include those with complex data structures, such as REDEFINES and OCCURS DEPENDING ON clauses for COBOL, and REFER in PL/I. See COBOL to JSON schema mapping and PL/I to JSON schema mapping.
  • The Service Interface Editor in the API toolkit enables the creator of the service project to perform renaming, redaction, and remarking for data fields that are used at the service level, encapsulating unique working knowledge of the target business logic that can greatly assist API creators to understand and use the true value of underlying services. See Customizing the service interface.

API requester

  • A new feature, API requester, is now available from z/OS Connect Enterprise Edition V3.0.1. The API requester feature allows z/OS applications to call REST APIs through z/OS Connect EE. For z/OS applications, both COBOL and PL/I are supported.
  • The new z/OS Connect EE build toolkit provides the ability to generate artifacts for an API requester based on the API description file of the REST API you plan to call. These artifacts include an API requester archive (.ara) file to be deployed to the z/OS Connect EE server, API information file and data structures that you use in your z/OS application program for calling REST APIs.

CICS service provider

  • The new CICS service provider uses IP interconnectivity (IPIC) to connect to a remote CICS region, or an optimized direct link can be used when z/OS Connect EE is deployed to a CICS Liberty JVM server.
  • Both COMMAREA and channel based CICS programs are supported. This includes channels with multiple containers and channels with both BIT and CHAR type containers, further expanding the applications that can be API enabled.
  • The CICS service provider supports the automatic deployment of services (service archive files) when copied to the services directory. See Automated service archive management.

WOLA service provider updates

  • The WOLA service provider supports the automatic deployment of services (service archive files) when copied to the services directory.

IMS service provider updates

  • Programs running in IMS that are written in COBOL and PL/I, with data structures that exceed traditional message segment limits, are now supported, allowing more applications to be API enabled. For an IMS COBOL sample, see Handling large IMS data structures.
  • The IMS service provider supports the automatic deployment of services (service archive files) when service archive files are copied to the services directory.
  • Use the z/OS Connect EE API toolkit to create IMS services. The API toolkit now provides a consistent and integrated service creation experience for both the IMS service provider and the CICS service provider.
    Important: As a result of the consolidated processes for service creation, deployment, and management:
    • IMS Explorer for Development is not compatible and cannot connect to a z/OS Connect EE V3 server.
    • IMS services that are created for V3 servers are not compatible with V2 servers. See Upgrading from z/OS Connect EE V2 for IMS service compatibility and migration issues if you are upgrading from V2.

Product documentation

  • z/OS Connect EE V3.0 product documentation that is available in the online IBM Documentation can now be installed on a workstation for local access. You can install z/OS Connect EE product documentation from an installation repository. For more information, see https://www.ibm.com/support/pages/node/733167Installing and deploying IBM Documentation on IBM Intelligent Operations Center Windows and Linux Development Environments.

Other enhancements

  • Use the REFRESH MODIFY command to refresh the z/OS Connect EE server artifacts such as Bindfiles, .aar, .sar, and .ara files, and the server.xml configuration file.