New in the 10.5.x CD stream

The IBM® DataPower® Gateway 10.5.x CD stream offers the following new features and enhancements.

For a list of resolved APARs, see Update packages for DataPower Gateway 10.5.x.

  • New in 10.5.4
    The 10.5.4 CD release replaces the 10.5.3 CD release.
    • Added the wizards for the web service proxy to the new UI. Technology preview
    • Added support for an API definition to control whether to resolve and populate the form data parameter.
    • Added support for an API definition to control whether SOAP 1.1 faults always return HTTP 500.
    • Added support for a JWT generate action to add the value of the kid claim in the JWT for JWE and JWS.
    • Added support for more JSONata functions for use by assembly actions.
    • Added GatewayScript API to retrieve an API gateway context.
    • Added support for an HTTP and HTTPS handle to control the idle timeout for HTTP/2 connections.
    • Added eb:MessageProperties support to the ebMS3 settings of external B2B partner profiles.
  • New in 10.5.3
    The 10.5.3 CD release replaces the 10.5.2 CD release.
    • Added GitOps integration for configuration management by using version control.
    • Added an assembly action to compute the cost analysis of a GraphQL target query and response.
    • Added support for more JSONata string functions.
    • Added the $apiCtx() JSONata extension.
    • Added support to manage distributed variables from the CLI.
    • Added support to manage distributed variables in XSL stylesheets.
  • New in 10.5.2

    The 10.5.2 CD release replaces the 10.5.1 CD release.

    • Added an assembly action to return details about rate limit, burst limit, and count limit definitions.
    • Added ability to enable cost analysis of GraphQL queries in the GraphQL execute assembly action.
    • Added settings to the parameter property for an API operation and API path.
    • Added ability to use the $distinct() array function in JSONata expressions.
    • Added a setting to control the value of the SNI header to establish a secure connection to the IBM MQ v9+ server.
    • Added more cipher suite to support secure operations with the IBM MQ v9+ queue manager.
    • Added ability to secure connections to IBM Db2® data sources.
    • Added ability to manage distributed variables.
    • Added a utility to check file systems for their usage and generate warning and critical events at defined thresholds.
    • Added settings to the destination property of B2B partner profiles.
    • Added GatewayScripts APIs to check whether Content-Type in a message is a JSON or XML media type.
    • Added an HTTP header to support the kid claim for signing.
    • Added support for IBM Security Verify Access version 10.0.5 to the Access Manager client.
  • New in 10.5.1
    The following features are new to customers who upgrade to the 10.5.x CD stream.
    • Changed the new UI to full support.
    • Added the probe utility to the new UI.
    • Added ability to flush the buffer for analytics endpoints.
    • Upgraded support for IBM Sterling Transformation Extender.

For more information about the new features, see the linked information.

10.5.4

The following information is a summary of the new features in 10.5.4. The 10.5.4 CD release replaces the 10.5.3 CD release.
Added the wizards for the web service proxy to the new UI. Technology preview
As a technology preview, you can use the new UI to create and manage a web service proxy with the wizards. If you must access the WebGUI because the new UI has a functional problem, change the browser URL from http://<hostname>:<port>/ui/<path> to http://<hostname>:<port>.
Added support for an API definition to control whether to resolve and populate the form data parameter.
When you configure an API definition, you can control whether to resolve and populate the form data parameter when the Content-Type header is application/x-www-form-urlencoded or multipart/form-data. For more information, see Creating API definitions.
Added support for an API definition to control whether SOAP 1.1 faults always return HTTP 500.
When you configure an API definition, you can control whether SOAP 1.1 faults always return HTTP 500. For more information, see Creating API definitions.
Added support for a JWT generate action to add the value of the kid claim in the JWT for JWE and JWS.
When you add a JWT generate action to an assembly, you can specify the value of the kid claim in the JWT for JWE and JWS. For more information, see Adding a JWT generate assembly action.
Added support for more JSONata functions for use by assembly actions.
When you use JSONata in assembly functions, you can now use the following functions from the JSON function libraries.
  • The array $shuffle() function
  • The date/time $millis() function
  • The number $random() function
Added GatewayScript API to retrieve an API gateway context.
When you create the GatewayScript file for an assembly GatewayScript action, you can use the apigw.context API to retrieve the API Gateway context. This API is used by CommonJS modules that require access to the API gateway context. For more information, see apigw module.
Added support for an HTTP and HTTPS handle to control the idle timeout for HTTP/2 connections.
When you create an HTTP or HTTPS handle, you can set the maximum idle duration in seconds to allow before the handler closes the HTTP/2 connection. Enter a value in the range 0 - 3600000, where a value of 0 disables the timer. The default value is 0.
HTTP handler
See Configuring an HTTP handler.
HTTP handler
See Configuring an HTTPS handler.
Added eb:MessageProperties support to the ebMS3 settings of external B2B partner profiles.
When you define an external B2B partner profile, you can define message properties to add to the eb:MessageProperties node. For more information, see Defining ebMS3 settings for external partners.

10.5.3

The following information is a summary of the new features in 10.5.3. The 10.5.3 CD release replaces the 10.5.2 CD release.
Added GitOps integration for configuration management by using version control.
With GitOps integration, you can populate the DataPower configuration from a version control system and declaratively deploy the DataPower configuration and files to multiple systems. For more information, see GitOps integration.
Added an assembly action to compute the cost analysis of a GraphQL target query and response.
When you configure an assembly, you can define an assembly action to compute the cost analysis of a GraphQL target query and response. For more information, see Adding a GraphQL cost analysis assembly action.
Added support for more JSONata string functions.
For assembly actions that support JSONata notation, you can now use the following JSONata string functions.
  • $base64decode(str)
  • $base64encode(str)
  • $decodeUrl(str)
  • $decodeUrlComponent(str)
  • $encodeUrl(str)
  • $encodeUrlComponent(str)
Added the $apiCtx() JSONata extension.
When you configure an extract assembly action or a switch assembly action, you can use the $apiCtx() JSONata extension. The $apiCtx() extension gives generic access to an API context.
  • For an extract action, the Transform field.
  • For a switch action, the condition of the case.

If used elsewhere, the API cannot be published.

Added support to manage distributed variables from the CLI.
You can use the CLI to create, get the value of, or delete a distributed variable. For more information, see Distributed variables.
Added support to manage distributed variables in XSL stylesheets.
You can use DataPower extension elements and functions to create, get the value of, or delete a distributed variable. For more information, see Distributed variables.

10.5.2

The following information is a summary of the new features in 10.5.2. The 10.5.2 CD release replaces the 10.5.1 CD release.
Added an assembly action to return details about rate limit, burst limit, and count limit definitions.
When you configure an assembly, you can define an assembly action that uses a GraphQL query to return details about rate limit, burst limit, and count limit definitions. For more information, see Adding an assembly action to return rate limit details.
Added ability to enable cost analysis of GraphQL queries in the GraphQL execute assembly action.
When you configure a GraphQL execute assembly action, you can specify whether to enable cost analysis of GraphQL queries. When enabled, introspection can be used to analyze the cost of queries. For more information, see Adding a GraphQL execute assembly action.
Added settings to the parameter property for an API operation and API path.
When you define a parameter for an API operation or API path, you can now define the following settings.
  • The uppermost limit of the parameter. This setting applies to integer, number, and string parameter types.
    • An integer or number instance is valid when its value is less than or equal to this value.
    • A string instance is valid when its length is less than or equal to this value.
  • The lowermost limit of the parameter. This setting applies to integer, number, and string parameter types.
    • An integer or number instance is valid when its value is greater than or equal to this value.
    • A string instance is valid when its length is greater than or equal to this value.
  • The pattern as a valid regular expression of the parameter. A string instance is valid when the pattern matches the instance.
  • The allowed values of the parameter. A string instance is valid when its value matches at least one element in the array. To specify an array of elements, separate each element with the + character.
Added ability to use the $distinct() array function in JSONata expressions.
When you use JSONata notation in assembly actions, you can use the $distinct() array function to return an array that contains all values from the array parameter where the duplicates are removed.
Added a setting to control the value of the SNI header to establish a secure connection to the IBM MQ v9+ server.
When you configure a local IBM MQ queue manager, you can control whether the value of the SNI header uses the channel name or hostname. For more information, see Configuring an IBM MQ queue manager.
Added more cipher suite to support secure operations with the IBM MQ v9+ queue manager.
When you configure a local IBM MQ queue manager, you can now use the following cipher suites.
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • ECDHE_ECDSA_AES_256_CBC_SHA384
  • ECDHE_ECDSA_AES_128_GCM_SHA256
  • ECDHE_ECDSA_AES_256_GCM_SHA384
  • ECDHE_RSA_AES_256_CBC_SHA384
  • ECDHE_RSA_AES_128_GCM_SHA256
  • ECDHE_RSA_AES_256_GCM_SHA384
  • TLS_AES_128_GCM_SHA256 (TLSv1.3)
  • TLS_AES_256_GCM_SHA384 (TLSv1.3)
  • TLS_CHACHA20_POLY1305_SHA256 (TLSv1.3)
  • TLS_AES_128_CCM_SHA256 (TLSv1.3)
  • TLS_AES_128_CCM_8_SHA256 (TLSv1.3)
Added ability to secure connections to IBM Db2 data sources.
When you configure a Db2 data source, you can define how to secure connections to the remote server. For more information, see Creating a Db2 data source.
Added ability to manage distributed variables.
Distributed variables provide you with a mechanism to read from or write to DataPower facilities across transactions or domains. During document processing, you can use distributed variables in the distributed store. The distributed store is the gateway-peering instance. Distributed variables are an alternative to system variables. For more information, see Distributed variables.
Added a utility to check file systems for their usage and generate warning and critical events at defined thresholds.
The file system monitor is a utility that checks the defined usage threshold for file systems. When a file system reaches its defined usage thresholds, the utility generates an event. By default, the utility checks system storage, temporary storage, and RAID storage. When a file system is 75% full, a warning event is generated. When a file system is 90% full, a critical event is generated. For more information, see File system monitor.
Added settings to the destination property of B2B partner profiles.
For AS4 compliance, added the following settings when you configure a destination that uses the ebms3:// or ebms3s:// scheme.
  • For ebMS3 connections, specify the reference to the agreement that governs this message exchange. This value maps to eb:AgreementRef in the message header.
  • For ebMS3 connections, specify the PMode identifier for the convenience of PMode management. When specified, the AgreementRef/@pmode attribute value is expected in associated messages.
  • For advanced ebMS3 when compression is not enabled, specify whether to send messages in the SOAP Body.
For more information, see Defining destinations for external partners.
Added GatewayScripts APIs to check whether Content-Type in a message is a JSON or XML media type.
When you use a GatewayScript file to manage context for an API gateway, you can use the following APIs to check the media type of the Content-Type header in a message.
  • context.isJSON()
  • context.isXML()
For more information, see APIs to manage messages.
Added an HTTP header to support the kid claim for signing.
The kid value for signing can be separated from the kid header that is injected into the resultant signed JWT (JWS) by using the X-IBM-Custom-Kid HTTP header value.
Added support for IBM Security Verify Access version 10.0.5 to the Access Manager client.
When you configure the Access Manager client, you can specify Security Verify Access version 10.0.5 as the client version. For more information, see Specifying the client version.

10.5.1

The following information is a summary of the new features in 10.5.1.
Changed the new UI to full support.
Previously, the new UI was a technology preview. The new UI is functionally equivalent to the WebGUI. The WebGUI is announced for deprecation.
Added the probe utility to the new UI.
The probe in the new UI is a different implementation than the probe in the WebGUI. As different implementation, each has a different setup to enable the capture of transaction data for diagnostics. As different implementations, they are incompatible. For more information, see The probe.
Added ability to flush the buffer for analytics endpoints.
When you view the status provider for analytics endpoints, you can flush the buffer for specific analytics endpoints. The buffer contains the collected API event data to send to the analytics server. For more information, see Viewing details about analytics endpoints.
Upgraded support for IBM Sterling Transformation Extender.
The IBM DataPower Gateway supports Transformation Extender version 10.1.2 and the following version of extender packs.
  • Financial Payments 10.2.1
  • Financial Payments PLUS 10.2.1
  • Healthcare 10.2.1
  • Supply Chain EDI 10.2.1