Product Version 2023 Autumn
Table of Contents
Features
Here you will find some of the new release's highlights. Check out the Change Log for further information on all changes.
Infrastructure
Support of Keycloak Version 22
Customers using Keycloak as identity provider for yuuvis® Momentum can now update to Keycloak version 22.
>> yuuvis® Momentum Requirements
Breaking Change
The update of Keycloak requires configuration adjustment.
The core system does not necessarily need an update of the Keycloak version. In contrast, the following services do not support previous Keycloak versions:
tenant-management
Servicekeycloak-proxy
Service
Support of Elasticsearch 7.17.x
yuuvis® Momentum supports Elasticsearch version 7.17.x now. A docker image including the required plugins is available.
>> yuuvis® Momentum Requirements
Core
Support of multiple Elasticsearch Instances (KDDA)
To realize high performance while the workload increases, it is now possible to configure multiple Elasticsearch instances in the application-es.yml configuration file. Furthermore, the connection to Elasticsearch can now be secured by username and password.
Breaking Change
The configuration structure is changed. Even if you continue using only one Elasticsearch instance, you need to adjust your application-es.yml configuration file.
Audit Entry for Deletion of an Object Version (KDDA)
The deletion of an object version is now documented in the audit trail with a specific audit entry.
>> Audit Trail - an "Object's History"
Schema Label
A new label
String field can be specified in a schema XML file. It can be used to specify a project-specific schema versioning information.
>> Schema - Defining Object Types
Selection of Repository by Condition
It is now possible to configure a predicate
for each repository to realize, e.g., a tenant-specific storage for binary content files. Thus, the used repository can be selected not only for each single content file during the import but also by configured conditions.
>> application-storage.yml
Full-text in Search Results
It is possible to display the text rendition for individual DMS objects in result lists if available. Client applications, e.g., may display a full-text excerpt that contains the search term in in result lists of full-text search queries. Thus, the users can better evaluate the relevance of individual search results.
>> Search Query Language
Reduction of Header Size (KDDA)
In order to reduce the header size for requests to the API gateway, the user roles and other project-specific information are not anymore part of the internal JWT.
>> AUTHENTICATION Service
- The feature is disabled in the default configuration. Manual configuration adjustments are required.
- The feature is NOT YET supported by the BPM Engine and the client-side Developer Libraries.
Extending the Core API
It is possible to add custom endpoints to the API provided via API gateway. The API gateway forwards the requests to the configured custom URL including the assigned JWT.
It ist NOT possible to overwrite existing endpoints of the API gateway.
>> API Gateway
SUM() Function for Search Queries
The new SUM()
function for search queries allows to retrieve the sum of integer property values in a single result.
>> Search Query Language
Archive Driver for Azure using Object Retention
The new archive driver azure_objectretention
allows storing binary content files with retention times specified by the metadata of the corresponding DMS objects.
>> application-storage.yml
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
This feature has been subsequently added to version 2022 Winter as well.
Client Services & Client Development
Web-API Gateway
Web API Full-text Search on Specified Field
The Web API query language provides a search operator to force the search for the field to be a full-text search, even if it contains wildcards. Thus, these searches are case-insensitive and wildcard-capable.
>> Search via Web-API Gateway
yuuvis® architect
New Tasks List View
The Process Management (BPM) part of yuuvis® architect offers a tasks list view in addition to the processes list view for tenant administrators.
>> Process Management (BPM)
USERSERVICE
Tenant-specific Database Connections
It is now possible to configure multiple database connection to realize tenant-specific data storage. The configuration has to be formatted like the storage
section in the application-dbs.yml configuration file for the core system.
>> USERSERVICE
Business Process Management
BPM Engine
Options for Task Lists
The endpoint for the retrieval of task lists accepts two new query parameters.
isCompleted
filters running and/or completed tasks.visibleTo
allows to display only the tasks that are visible for a specified user.
Furthermore, the task's metadata contain the endTime
property.
Tenant Management
Tenant Management API
Replaced Metrics Endpoints
The core API offers metrics endpoints with the information but improved processing as of 2023 Summer. The METRICS service is no longer used and can be removed from installation. Thus, the following metrics endpoints of the Tenant Management API are deprecated and will not be available anymore in product version 2023 Winter:
>> Breaking Changes 2023 Winter
Release Candidates
The Release Candidates (Alpha) provide the preliminary results expected to be ready at the corresponding date.
>> Version Tags Services - Release Candidates
Alpha1
Core
Support of multiple Elasticsearch Instances
- To realize high performance while the workload increases, it is now possible to configure multiple Elasticsearch instances. (internal: OKTO-5603)
Tenant Management
Tenant Management API
Replaced Metrics Endpoints
- The core API offers metrics endpoints with the information but improved processing as of 2023 Summer. Thus, the metrics endpoints of the Tenant Management API are deprecated and will be removed with product version 2023 Winter. (internal: BUD-2368)
Alpha2
Core
Schema Label
- A new
label
String field can be specified in a schema XML file. (internal: OKTO-5659)
Audit Entry for Deletion of an Object Version
- The deletion of an object version is now documented in the audit trail with a specific audit entry. (internal: OKTO-5640)
Client Services & Client Development
yuuvis® architect
New Tasks List View
- The Process Management (BPM) part of yuuvis® architect offers a tasks list view in addition to the processes list view for tenant administrators. (internal: ERA-8472)
Business Process Management
BPM Engine
Options for Task Lists
- The endpoint for the retrieval of task lists accepts two new query parameters for filtering. (internal: ERA-9221)
Alpha3
Core
Selection of Repository by Condition
- It is now possible to configure a predicate for each repository automatically select a storage for binary content files controlled by conditions. (internal: OKTO-5679)
Hotfix for Alpha3
Alpha4
Core
Full-text in Search Results
- It is possible to display the text rendition for individual DMS objects in result lists if available. (internal: OKTO-5628)
Final
Core
SUM() Function for Search Queries
- The new
SUM()
function for search queries allows to retrieve the sum of integer property values in a single result. (internal: OKTO-5680)
Support of Elasticsearch 7.17.x
- yuuvis® Momentum supports Elasticsearch version 7.17.x now. A docker image including the required plugins is available. (internal: OKTO-5709)