You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

1. Highlights

Our goal is to swiftly introduce new features, prioritizing speed over waiting for major releases unless absolutely necessary. This approach ensures a gradual impact and shortens time to market. Unlike minor updates, major releases may involve breaking changes like removing outdated features or upgrading technology.

Highlights of release 17.0:

  • Technology upgrades (JDK 21, OpenAPI 3.1, KeyCloak 24.0, .NET core 8) keeping Blueriq secure and stable.
  • Removal of deprecated features, toggles, and properties marking the end of a transition period.
  • Improved flexibility for secured REST connections using OAuth2
  • Improved readability of logging

2. Enhancements

Enhancement Details
REST service call OAuth2 custom parameters

It is now possible to add any parameter to an OAuth2 token request that is being executed during a REST service call. This allows you to send extra data in the OAuth2 token request that you configured, if needed.

blueriq:
  connection:
    my-connection:
      http:
        url: https://some.domain.com/resource
        authentication: oauth2
        oauth2-request-parameters
          param1: some-value
          param2: some_other_value123
OAuth2 clients ala Spring Security

We changed the way you configure an OAuth2 client on REST connections. Now you can define OAuth2 clients separately and reference them from multiple connection if you so wish.

In the old situation you would need to do something like this.
blueriq:
  connection:
    my-connection:
      http:
        url: https://some.domain.com/resource
        authentication: oauth2
        oauth2-client-id: my-client-id
        oauth2-client-secret: secret-password-text
        oauth2-grant-type: client_credentials
        oauth2-token-endpoint: https://identity.provider.com/token

Now you can define OAuth2 clients separately and reference them from multiple connection if you so wish:

spring:
  security:
    oauth2:
      client:
        registration:
          my-oauth2-client:
            provider: my-auth-server
            client-id: my-client-id
            client-secret: secret-password-text
            authorization-grant-type: client_credentials
        provider:
          my-auth-server:
            token-uri: https://identity.provider.com/token
blueriq:
  connection:
    my-connection1:
      http:
        url: https://some.domain.com/resource1
        authentication: oauth2
        oauth2-client-registration: my-oauth2-client
    my-connection2:
      http:
        url: https://some.domain.com/resource2
        authentication: oauth2
        oauth2-client-registration: my-oauth2-client
Default HTTP timeouts

The default read timeout for AQ_RestServiceCall and AQ_SoapServiceCall has been changed to 5 seconds (was 15 seconds). The advantage is that a request will now fail faster if it takes long, so that the user doesn't have to wait so long. If you have service calls that take longer than 5 seconds, you can override the timeout per connection. See Connections Properties for more information.

Timeouts for CMIS

We introduced properties to set the connection timeout and the read timeout for CMIS. Both default to 5 seconds. See CMIS Properties on how to change them.

3. Documentation

Documentation on the new features and improvements of this release is linked in the respective topics.

4. Changes Platform Support

Our Platform support is updated.

Changes are:

  • Blueriq Java components now requires Java 21 to run.
  • Blueriq 17 introduces support for OpenAPI v3.1, in addition to v3.0 for the OpenAPI specification feed. 

4.1.  Discontinued

  •  Java x support is stopped, from Blueriq 17 on Java 21 or higher is mandatory.

5. Upgrade Instructions

OAuth2 token support on REST connections

In order to use your REST connections that use a OAuth2 token to authenticate correctly after the upgrade you will need to migrate all the properties to the new structure as described in the "OAuth2 clients ala Spring Security" enhancement.

Please review the Release 17.0 Upgrade Instructions.

As a best practice

  • backup your repository
  • backup your database before running scripts
  • backup your spring.config.additional-location directory ([Blueriq installation directory]\Runtime)
  • backup any config files you have altered under [Blueriq installation directory]\Services

before you start the upgrade.

6. Artifacts

 The Blueriq artifacts are available under name: 17.0.0.xxxx

This release includes these versions of Blueriq components with a separate life cycle:

Component

Version

Customer Data Service 4.2.x
DCM Lists Service 3.0.x
Material Theme 1.1.x
Development tools frontend 1.5.x
DCM Maintenance App 3.0.x
Audit Consumer 0.2.x
DCM Dashboard Service 0.2.x
Gateway Service 0.1.x
Document Renderer 2.1.x

7. Blueriq Libraries

There are no specific Library updates for this release.

8. Libraries

In this release, the set of third party libraries that is used by Blueriq was updated. When your installation of Blueriq includes custom components (artifacts that do not ship with Blueriq, such as proprietary plugins), those components should be tested for compatibility with these changes.

ArtifactId GroupId License Version in 17.x.x Version in 17.x.x
ArtifactId GroupId License Version in 4.2.x (Blueriq 17.x.x)

Version in 4.2.x (Blueriq 17.x.x)

9. Retirement announcement

For a full list of deprecated features, go to Deprecated features.

Removed legacy properties can be found in the Release 17.0 Upgrade Instructions.

10. Bug fixes

Unable to render {include} The included page could not be found.

11. Known issues

For an overview of known issue please refer to: Known issues

12. Security notification



  • No labels