You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
1. New
1.1. Deprecate elements in Encore
It is now possible to manage the evolution of a model by deprecating elements in Blueriq Encore using the built-in label called "Deprecated". A deprecation will generate a validation warning for each usage of the deprecated element. This signal can be used by business engineers to other business engineers to communicate that an element will be removed in a future version.
1.2. OpenAPI feed improvements part 2
Continuing on the OpenAPI feed improvements that have been made in the Blueriq release 17.4 to provide standardized and clear documentation on Blueriq web services and thereby improve collaboration with consuming parties, the Blueriq 17.5 contains two more improvements:
- You can now exclude specific operations from the OpenAPI documentation if you do not want to disclose this information.
- Validations on fields and parameters are communicated automatically and as clearly as possible using JSON schema semantics in the OpenAPI feed.
1.3. Process messages for a deleted case in DCM Lists
Sometimes a message is processed in the DCM Lists for a case that has just been deleted. The reason for this is that messages can be processed out of order, especially when using multiple consumers. This used to lead to an exception, which would cause the message to be retried until it fails definitively in the maintenance app. There it would then have to be manually removed. To address this, cases are now no longer directly removed from the case engine, but instead get a flag that they are marked for removal. These cases are then ignored by the DCM Lists application, unless a message is processed that relates to that specific case. The DCM Lists application can then process that message by discarding it with a corresponding log entry instead of the exception.
Due to these changes, cases are no longer removed from the database causing the database to grow and negatively affect performance. To prevent such degradation, a cleanup mechanism runs at a specified interval to clean up cases marked for deletion before a specific time. For more information, see Case deletion in DCM Lists [editor].
1.4. Validations on uploaded files
The AQ_File_Upload container provides the ability to upload files and store an instance containing upload details in the profile. While this works well, it is often required to not only upload but also reason over the files that are uploaded. For instance for an application, you may require a document of type A and a document of type B. This is difficult to express in Blueriq, as the files uploaded are roaming somewhere in the profile and you cannot attach validations to it. To improve this, a parameter is added to the container which allows to designate in which relation file details should be stored. This makes reasoning over uploaded files much easier and allows for adding validations on the relation attribute, so you can validate not only if a document is uploaded, but also the type of document, the name, etc. etc.
The new parameter is optional, so no migration is required (except for updating the Blueriq libraries).
2. Enhancements
Enhancement | Details |
---|---|
Displaying all attributes and relations within an entity in Encore |
An entity that is defined in, and opened from a lower level module scope now displays attributes and relations that are defined in a higher level module. Such attributes are preceded with an upward arrow indicating their higher level of definition. In such cases an eye-icon is present near the entity name as well that can be clicked on to toggle the scoped view. |
Validation rules with invalid parameters may now be reported in the project initialization report. |
Parameters of a validation type are now supplied to the validation type implementation during project initialization, such that failures during creation of the validation rule (e.g. because the parameters are invalid) are now included in the project validation report as error. |
OpenID Connect has been consolidated into a separate component |
The OpenID Connect feature has been consolidated into a separate component. See OpenID Connect Component [editor] for details, and read the upgrade instructions for this release to enable it if you need it. |
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:
- Added support for Oracle JRE 22 and Azul Zulu OpenJDK 22
5. Upgrade Instructions
The Upgrade Instructions for this release can be found here: Release 17.5 Upgrade Instructions [editor].
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.
Artifacts
The Blueriq artifacts are available under name: 17.5.0.154
This release includes these versions of Blueriq components with a separate life cycle:
Component |
Version |
---|---|
Customer Data Service | 5.0.4 |
DCM Lists Service | 4.0.5 |
Material Theme | 1.3.4 |
Development tools frontend | 2.0.1 |
DCM Maintenance App | 5.0.4 |
Audit Consumer | 1.0.5 |
DCM Dashboard Service | 2.0.3 |
Gateway Service | 1.1.1 |
Document Renderer | 2.2.2 |
6. Blueriq Libraries
For this release, the BlueriqBasicModelling Library 1.3.0 has been updated. Please upgrade to the latest BlueriqCompleteLibraries Package.
7. 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.
8. Retirement announcement
There are no specific retirement announcements.
For a full list of deprecated features, go to Deprecated features.
9. Bug fixes
10. Known issues
For an overview of known issue please refer to: Known issues