Product Version 2022 Winter LTS
- Technische Redaktion
If you are using yuuvis® Momentum version 2021 Winter LTS, the update to version 2022 Winter LTS will also provide features introduced in the following product versions:
Features
Here you will find some of the new release's highlights. Check out the Change Log for further information on all changes.
Please also pay attention to the Breaking Changes and Update Instructions 2022 Winter LTS or Update Instructions 2021 - 2022 Winter LTS.
Infrastructure
Support of Keycloak Version 19
Customers using Keycloak as identity provider for yuuvis® Momentum can now update to Keycloak version 19. With the new version, users are no longer redirected back to the login page after a successful logout.
Note: It is required to manually adjust the endSessionUri parameter for each tenant in the application-oauth2.yml configuration file.
>> Breaking Changes
Core
Deduplication in Rendition Repository
For each binary content file that is imported to yuuvis® Momentum, a digest is calculated. Identical binary content files have the same digest. This digest is now used as primary key for the storage of a corresponding PDF rendition. In case the digest cannot be calculated from the binary content file, the content stream properties are used for the calculation as soon as a PDF rendition is retrieved.
Thus, if PDF renditions are requested for multiple DMS objects within the same tenant with identical binary content files, a new rendition file is created only for the first request. The rendition file will be stored with the digest of the binary content file. All following requests will be much faster and do not need further space in the storage as they return the already existing rendition file with the corresponding digest.
Binary content files stored in different tenants get their own rendition files even if they have the same digest as it should be possible to maintain them separately.
PDF Rendition for Object Versions
It is now possible to retrieve the PDF rendition for old object versions as well. The rendition that corresponds to the binary content file assigned to the specified object version is returned.
>> GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/pdf
Webhook Entry Point before Content Retrieval
A new webhook type is available to configure webhooks that can be triggered by content retrieval requests. The webhook entry point is reached before the actual content retrieval. Thus, e.g., it is possible to allow or prohibit the content retrieval based on custom rules that cannot be implemented in a yuuvis® Momentum role set.
>> POST dms.request.objects.contents
Handling of Errors thrown by Webhooks
If a webhook throws an error matching the yuuvis® Momentum error format, it is wrapped as JSON substructure in the error that users get as response body.
>> Error Handling
Storing only Specified Audit Entries
In the default configuration, all actions on an object that trigger the creation of an audit entry are documented in the database. It is now possible to specify a selection of audit entry types to be stored for each object. Other audit entries are not stored in the database in order to save resources.
>> serviceConfiguration.json
Audit Entries for Rendition Management
Operations on renditions are now more conveniently documented in the audit trail:
| Operation | New action code (subaction) | New detail value | Previous action code | Previous detail value |
|---|---|---|---|---|
| Get text rendition | 402 (1) | RENDITION_ACCESSED | 402 | RENDITION_TEXT_ACCESSED |
| Get PDF rendition | 402 (2) | RENDITION_ACCESSED | 403 | RENDITION_PDF_ACCESSED |
| Post text rendition | 306 (1) | RENDITION_CHANGED | - | - |
>> Audit Trail - an "Object's History"
Combining Operators in Full-text Queries
It is possible to use round brackets within a CONTAINS statement in order to specify the order of evaluation of operators now.
>> Search Query Language
Tenant-specific Database Configuration
It is now possible to configure different databases to be used for storing metadata of individual tenants. The structure of the application-dbs.yml configuration file has been refactored. Configurations for previous product versions are not supported any longer. Please adjust your configuration.
>> Breaking Changes
Database Connections Optimizations (KDDA)
In the context of resources optimization measures, the number of database connections within the cluster is reduced. The individual services do not use their own database connection pools anymore. Instead, the connections are centralized now. The new default configuration is documented here:
>> application-dbs.yml
Note: This feature has been subsequently added to yuuvis® Momentum product versions 2023 Spring and 2022 Winter LTS.
Support of Azure Blob Storage
Azure Blob Storage can be connected via ARCHIVE service.
>> application-storage.yml
Note: This feature has been subsequently added to yuuvis® Momentum product versions 2022 Winter LTS with 2023 Summer.
Object Lock Configuration for S3 and Azure Archives
For the archive drivers s3, ecs-s3 and azure_objectretention, the retention mode can be configured in the application-storage.yml configuration file. Thus, you can decide to allow the manipulation of objects under retention by an archive administrator or not.
>> application-storage.yml
Note: This feature has been subsequently added to yuuvis® Momentum product versions 2022 Winter LTS with 2023 Autumn.
Client Services & Client Development
Web-API Gateway
Business Process Management
Tasks can be retrieved with a reduced set of properties in order to save processing time.
Note: The feature has been subsequently added to the 2022 Autumn version as well.
>> GET /api-web/api/bpm/tasks
>> GET /api-web/api/bpm/tasks/{taskId}
Export of Search Results
A new endpoint in the dms-controller allows to search and retrieve the result list as CSV file.
>> POST /api-web/api/dms/objects/export
Multiple Search Conditions on Table Rows
It is now possible to set multiple filter conditions on table fields connected via logical AND operator. The conditions have to match in the same table row.
>> Search via Web-API Gateway
Dynamic Catalogs
In the default configuration, any logged-in user can apply changes to dynamic catalogs. However, the access can be limited to specified conditions via AUTHENTICATION Service configuration.
>> POST /api-web/api/dms/catalogs/{qname}
>> PATCH /api-web/api/dms/catalogs/{qname}
Developer Libraries
Business Process Management
- The ProcessDetailsComponent can display comments that are assigned to a process instance.
- The retention component illustrates the retention state of listed objects via status icons.
- The task list does not change if the currently logged-in user accepts or returns a task.
Customizable Dashboard – Saved Searches
As an ALPHA version, the @yuuvis/widget-grid developer library allows users to individually customize the client's dashboard according to their preferences. Especially, often needed searches can be configured, saved, and displayed on the dashboard.
Note: The feature is still in a testing phase. We reserve the right to apply any changes to its functionality.
>> Customizing the Dashboard
A demo application shows how to configure widgets and how to use them to provide saved searches for the client user.
>> Example Code on gitHub
Extension Possibilities via Plug-ins
- In the content preview, buttons can be displayed via which the next/previous object in the hit list can be selected and its content preview displayed.
The search filter panel can be extended by a plugin that offers a facet depending on selected object types that lists the values of a specified catalog. It is possible to type a string and get the matching values.
- In datetime fields, an icon allowing to click through configured time ranges can be displayed. You can configure values like Today, This year, ... but also values like Today-7 to indicate the day exactly one week ago.
- In fields specifying a user, an icon can be displayed to quickly select the currently logged-in user.
yuuvis® architect
Process Administration
As a first step of BMP integration, users with the YUUVIS_TENANT_ADMIN role are allowed to view all processes in their tenant. The development will continue during the next releases to provide management of tasks and process variables as well.
>> Process Management (BPM)
Tenant Management
METRICS Service
New Database Configuration
The METRICS Service uses a different configuration file for its database connection.
>> Breaking Changes.
Business Process Management
BPM Engine
Custom Functionality Extension
It is now possible to add custom functionality to process definitions that is not supported by Flowable, e.g., notifying a logger. The custom extension is integrated as delegation in service tasks or event listeners.
>> Modeling and Deployment of Process Definitions
Artificial Intelligence Plattform
Restructuring and Official Release
The endpoints of the services within the platform are restructured and extended in order to adapt the endpoint pattern convention for yuuvis® Momentum services. Please consider the update instructions 2022 Winter (or 2021 - 2022 Winter).
>> Artificial Intelligence Platform
Release Candidates
The Release Candidates (Alpha) provide the preliminary results expected to be ready at the corresponding date.
>> Version Tags Services - Release Candidates
Alpha1 - 12 SEP 2022
Core
Deduplication in Rendition Repository
- The digest of binary content files is now used as primary key for the storage of a corresponding PDF renditions. (internal: OKTO-5357)
PDF Rendition for Object Versions
- It is now possible to retrieve the PDF rendition for old object versions as well. The rendition that corresponds to the binary content file assigned to the specified object version is returned. (internal: OKTO-5372)
Client Services & Client Development
Developer Libraries
Business Process Management
- The ProcessDetailsComponent can display the comments that are assigned to a process instance. (internal: BUD-1815)
- The retention component illustrates the retention state of listed objects via status icons. (internal: BUD-1826)
The task list does not change if the currently logged-in user accepts or returns a task. (internal: BUD-1860)
Widgets and Saved Searches
- A demo application shows how to configure widgets and how to use them to provide saved searches for the client user. (internal: BUD-1809)
Web-API Gateway
The Web-API Gateway tasks endpoint offers a new parameter
briefRepresentationthat allows getting the task list without variables and forms for each task but with the subject. This leads to more performance when loading the task list in the inbox. Available also for version Winter 2021 LTS. (internal: BUD-1858)
yuuvis® architect
Process Administration
- Users with the YUUVIS_TENANT_ADMIN role can see all running and completed processes in their tenant. (internal: ERA-8468)
Artificial Intelligence Plattform
Restructuring and Official Release
- The endpoints of the services within the platform are restructured and extended in order to adapt the endpoint pattern convention for yuuvis® Momentum services.
Alpha2 - 26 SEP 2022
The two weeks from 07 to 20 SEP 2022 will be our innovation sprint that allows us to try out new ideas and explore new ways for the future. We do not plan to deliver new features in this sprint, but we will fix the appearing bugs if possible.
Core
Deduplication in Rendition Repository
- For each binary content file that is imported in yuuvis® Momentum, a digest is calculated. In case the digest cannot be calculated from the binary content file, the content stream properties are used for the calculation as soon as a PDF rendition is retrieved. (internal: OKTO-5368)
Storing only Specified Audit Entries
- It is now possible to specify a selection of audit entry types that should be stored for each object. Other audit entries are not stored in the database in order to save resources. (internal: OKTO-5300)
Alpha3 - 10 OCT 2022
This version contains only bug fixes.
Alpha4 - 24 OCT 2022
This release candidate is only for internal tests.
Alpha5 - 07 NOV 2022
Core
Combining Operators in Full-text Queries
- It is possible to use round brackets within a CONTAINS statement in order to specify the order of evaluation of operators now. (internal: OKTO-5361)
Client Services & Client Development
Web-API Gateway
Export of Search Results
- A new endpoint in the dms-controller allows to search and retrieve the result list as CSV file. (internal: BUD-1525)
Multiple Search Conditions on Table Rows
- It is now possible to set multiple filter conditions on table fields connected via logical AND operator. The conditions have to match in the same table row. (internal: BUD-2079)
Developer Libraries
Extension Possibilities via Plug-ins
- In the Content preview, buttons can be displayed via which the next/previous object in the hit list can be selected and its content preview displayed. (internal: BUD-1955)
The search filter panel can be extended by a plugin that offers a facet depending on selected object types that lists the values of a specified catalog. It is possible to type a string and get the matching values. (internal: BUD-1867, BUD-1960)
- In datetime fields, an icon allowing to click through configured time ranges can be displayed. (internal: BUD-2016)
- In fields specifying a user, an icon can be displayed to quickly select the currently logged-in user.
Customizable Dashboard – Saved Searches
- The @yuuvis/widget-grid developer library allows users to individually customize the client's dashboard according to their preferences. Especially, often needed searches can be configured, saved, and displayed on the dashboard. (internal: BUD-1878)
Note: The feature is still in a testing phase. We reserve the right to apply any changes to its functionality.
yuuvis® client as reference implementation
- Export of hit list is available in Hit list view as well as in Retention management view.
- As an ALPHA feature, the customizable dashboard is available.
- Plug-in extensions are implemented.
yuuvis® architect
Process Administration
- Users with the YUUVIS_TENANT_ADMIN role can apply filters to running and completed processes in their tenant in order to find the process they would like to manage. (internal: ERA-8469)
- Individual process instances can be displayed in a detailed view. (internal: ERA-8470)
- Tasks belonging to individual process instances can be displayed. (internal: ERA-8471)
Business Process Management
BPM Engine
Custom Functionality Extension
- It is now possible to add custom functionality to process definitions that is not supported by Flowable. (internal: ERA-8992)
Final - 25 NOV 2022
Infrastructure
Support of Keycloak Version 19
- Customers using Keycloak as identity provider for yuuvis® Momentum can now update to Keycloak version 19. (internal: OKTO-5365, ERA-8804, BUD-1813)
Note: Manual configuration due to Breaking Changes is required.
Core
Tenant-specific Database Configuration
- It is now possible to configure different databases to be used for storing metadata of individual tenants. (internal: OKTO-4955)
Note: Manual configuration due to Breaking Changes is required.
Webhook Entry Point before Content Retrieval
- A new webhook type is available to configure webhooks that can be triggered by content retrieval requests. The webhook entry point is reached before the actual content retrieval. (internal: OKTO-5420, OKTO-5421)
Handling of Errors thrown by Webhooks
- If a webhook throws an error matching the yuuvis® Momentum error format, it is wrapped as JSON substructure in the error that users get as response body. (internal: OKTO-5431)
Tenant Management
METRICS Service
New Database Configuration
- The METRICS Service uses a different configuration file for its database connection, see Breaking Changes.
Postponed Features
These initially planned features could not be realized. Some of them are planned for the next version 2023 Spring.
Core
Synonym Search
String properties can be configured such that they support synonym search. The synonym search functionality is available for query requests.
New Service for Scripting of Webhooks
This new service is a tool to simplify the implementation and deployment of custom webhooks.