You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
1. New
1.1. OpenAPI feed brought to the next level
It is now easier than ever to connect to a Blueriq API. For all REST web services in a project, Blueriq already generated a feed using the OpenAPI standard to communicate the interface to its consumers. The result of this feed could, for example, be used in a store with public APIs that can be consumed. In order to make the consumption of Blueriq REST services a smoother experience, the feed now consists of more information:
- The title and description of the info object can now be edited in Blueriq Encore as demonstrated in the figure below.
- You can now add an OpenAPI description to fragments, arguments, and headers.
- All operations within a REST services are grouped, using tags as demonstrated in the figure below. Additionally, a description can be added to these tags.
- Business Engineers are offered more insight into which for fields in a domain schema a description is present, using the OpenAPI icon in the tree view in domin schema's.
Click here for an overview of how the Blueriq model is mapped to the OpenAPI specification and stay tuned for even more OpenAPI feed improvements in Blueriq 17.5.
An example of the OpenAPI specification of a Blueriq service using swagger UI: old (left) vs. new (right).
1.2. Outbox poller improvements
There are two processes ensuring that the outbox gets emptied. The first is a transactional listener that empties the outbox after an action on the Case Engine for a specific case ID. The second process is a poller that, scheduled with an interval, empties messages that are not picked up by the transactional listener.
The first poller exists for messages that were missed, so it can have a large interval. This could happen during a restart, for example. The second will ensure that messages, like the delete case messages, are picked up. This has a shorter interval by default. Those intervals are set with default values, so there is no need to change anything. The process outbox will remain almost empty under normal circumstances. When this is not the case in your situation, it is possible to configure the pollers. You can find more information on this topic at https://my.blueriq.com/x/twDv
1.3. Improved AQ_File_Move performance
The performance of the AQ_File_Move service call has been improved by introducing new underlying API to the Content Managers. These new adjustments should make the move of a file instantly when moving said file on the same disk or memory connection. Furthermore we have introduced a new Channel API and deprecated the old Inputstream API of the IContentManager. More information on how to implement the a custom content manager can be found here. Look at the upgrade instructions to see which methods have been replaced.
2. Enhancements
| Enhancement | Details |
|---|---|
| Multi delete and move for globals in Encore | Multi select is now available in the globals overview in Encore allowing to delete/move multiple globals at once. |
| Cursor automatically set in Encore | Blueriq Encore now sets the cursor automatically to a field so that the user can immediately start typing. Examples are: adding a value list item, pressing the globals button, adding a new element to a container, and more. |
| Display version of Document Renderer Service | Starting version 2.2.1 and 1.1.3 the Document Renderer Service now displays its version on startup and when running the executable with a `-v` or `--version` command. |
3. Documentation
Documentation on the new features and improvements of this release is linked in the respective topics.
4. Upgrade Instructions
See Release 17.4 Upgrade Instructions for the upgrade instructions for this release.
As a best practice
- backup your repository
- backup your database before running scripts
- backup your
spring.config.additional-locationdirectory ([Blueriq installation directory]\Runtime) - backup any config files you have altered under [Blueriq installation directory]\Services
before you start the upgrade.
5. Artifacts
The Blueriq artifacts are available under name: 17.4.0.114
This release includes these versions of Blueriq components with a separate life cycle:
Component | Version |
|---|---|
| Customer Data Service | 5.0.3 |
| DCM Lists Service | 4.0.2 |
| Material Theme | 1.3.4 |
| Development tools frontend | 2.0.1 |
| DCM Maintenance App | 5.0.5 |
| Audit Consumer | 1.0.3 |
| DCM Dashboard Service | 2.0.2 |
| Gateway Service | 1.1.0 |
| Document Renderer | 2.2.1 |
6. Blueriq Libraries
There are no specific Library updates for this release.
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
Identifier | Component | Issue | Solution |
|---|---|---|---|
BQ-23628 | Encore | A CVE was reported on the NPM library fast-xml-parser | Upgraded fast-xml-parser to 4.4.1 which contains a fix for the CVE |
CSD-5464 | Java Runtime, Studio | Creating a project export would consume significantly more memory and take longer than versions before 17.1 | When creating an unencrypted project export, memory usage has been reduced to be similar or even less than it was before 17.1. Memory usage of loading projects in the runtime has also been reduced. Encrypting a project export remains to require more resources than it used to. |
CSD-5465 | Studio | Unit tests would inadvertently fail for multivalued attributes that evaluate to unknown. | Testing a multivalued attribute for unknown is not correctly handled when comparing the actual value against the expected value. |
CSD-5461 | Java Runtime | Rendering a page as XML would fail for unnamed inline text items | Unnamed inline text items are now correctly rendered to XML |
BQ-23569 | Encore | Usages of flow events and process events from flows and task mappings may not be listed as a dependency. | Flow and process event usages in flows and task mappings will now show up as dependency. This also addresses incomplete rename operations for those elements. |
BQ-23544 | Java Runtime | When JWT type login is used in conjunction with Audit logging, every keep-alive request would be logged as successful login, polluting the audit log. | We have removed JWT token validation from the audit log. |
BQ-23533 | Maintenance App | The Maintenance app would end up in an infinite loop when an unexpected error happens during processing of a dead letter message. | Added a RetryOperationsInterceptor that will make sure that messages will send to an error exchange when an unexpected error during processing of a dead letter message happens. |
CSD-5427 | Java Runtime | AquimaSessionMap.getAvailableSessionIds(…) can cause a lot of “scan“ requests to Redis wich decrease performance | The AquimaSessionMap.getAvailableSessionIds(…) now uses the "keys" method which should be faster in this particular case. |
CSD-5389 | Java Runtime | There was a difference in the behavior of the old StartController and the new (JSON) StartController, which lead to unexpected behavior when switching from the built-in theme to a hosted theme. | The workings of the StartControllers has been corrected to match again. |
CSD-5328 | Java Runtime | An exception is not caught when the Redis CONFIG command is not enabled, resulting in the runtime to not start. | This issue has been resolved and added to our automated tests. |
BQ-23068 | Java Runtime | A user could upload a file with an extension that didn't match the file content, when an extension that was present in the allowed extensions did match the file content. | Because of security reasons, the Blueriq Runtime from now on refuses file uploads where the file content and the file extension do not match. The user will get an error stating this fact. The error message in customizable in |
CSD-5117 | Gateway | The Identity Provider selection page for the Blueriq Gateway contained CSS resources from the internet, causing the page to be unformatted in environments that do not have internet access. | The resources have been made available locally. |
10. Known issues
For an overview of known issue please refer to: Known issues
11. Security notification
Overview
Content Tools