Product Version 2022 Autumn
- Technische Redaktion
- Black Team
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.
Please also pay attention to the Breaking Changes and Update Instructions.
Core
Internal Tokens for Custom Services
Custom services running in the yuuvis® Momentum Kubernetes cluster can use a new internal endpoint of the AUTHENTICATION Service to get a valid internal JSON Web Token (JWT).
>> GET /authentication-internal/jwt/token
Efficient Refresh of the Tenant Configuration
A new internal endpoint can be used to activate changes in the tenant configuration instead of the conventional refresh endpoint. Only changes in the authentication.oauth2.tenants list in the application-oauth2.yml configuration file are considered. Thus, the creation or manipulation of tenants can be carried out much faster. However, tenants that were removed from the configuration are NOT automatically deleted.
>> GET /authentication-internal/manage/refreshTenants
Managing Secondary Object Types via Webhook
Secondary object types (SOTs) can be added or removed via the POST dms.request.objects.upsert.database-before webhook if they are referenced as floating in the corresponding object type definition. For the related properties, the following behavior is implemented now:
- If the webhook removes an SOT from an object, all properties that were provided by the SOT are automatically removed from that object as well.
- If the webhook adds an SOT to an object, all properties provided by the SOT can be added to that object by the webhook as well. If those properties are not added by the webhook, they will be automatically added with their default values afterwards (if available).
>> POST dms.request.objects.upsert.database-before
Parameter 'waitForSearchConsistency' for Endpoints with Effect on the Search Index
Some processes that lead to an update of the index of the search engine can be called with the new parameter waitForSearchConsistency.
| Processing | Description | Advantage | Disadvantage |
|---|---|---|---|
| synchronous | The success response of the corresponding endpoint is returned after the successful update of search index. | The changes are available even for search requests that are sent immediately after the synchronous processing. | The waiting time before the response is rather long. |
| asynchronous | The success response of the corresponding endpoint does not wait for the update of the search index. | The waiting time for the response is far shorter. | Search requests sent immediately after the change request may be processed before the search index is updated. |
The update and import endpoints listed below accept an optional query parameter waitForSearchConsistency. The default value corresponds to the behavior of previous product versions.
| Endpoints | Default for waitForSearchConsistency |
|---|---|
| Import: POST /api/dms/objects | false |
| Metadata update: POST /api/dms/objects/{objectId} PATCH /api/dms/objects/{objectId} PATCH /api/dms/objects | true |
| Content update: POST /api/dms/objects/{objectId}/contents/file | true |
| Restore: POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore | true |
Tagging: | true |
| Text rendition: POST /api/dms/objects/{objectId}/contents/renditions/text | true |
Management of Tenant-specific Role Sets
New endpoints allow for the management of the tenant-specific role set for any tenant by a system integrator:
- GET /api/system/tenants/{tenant}/permissions – Retrieve the role set of a tenant.
- POST /api/system/tenants/{tenant}/permissions – Update the role set of a tenant.
- POST /api/system/tenants/{tenant}/permissions/validate – Validate the role set of a tenant.
Support of DELL EMC ECS via S3 Protocol
The ARCHIVE Service can be connected to a Dell EMC ECS as repository via S3 protocol. Archive-internal retention is supported as well.
Support of Redis Version 7.0.4
yuuvis® Momentum has been tested with Redis version 7.0.4. This version is now also used in the infrastructure Helm chart for test installations.
>> yuuvis® Momentum Requirements
Support of Elasticsearch version 7.16
yuuvis® Momentum has been tested with Elasticsearch version 7.16. This version is now also used in the infrastructure Helm chart for test installations.
>> yuuvis® Momentum Requirements
Comparing Database and Search Index
The the maintain-compare command provided by the COMMANDER Service is improved in terms of available parameters and output data.
>> maintain-compare Command
Client Services & Client Development
Developer Libraries
Angular Version Update
The client libraries now use Angular 14. In case you extended your client with further libraries, please ensure that they are compatible with Angular 14.
>> Breaking Changes
BPM Forms
It is possible to configure BPM forms such that fields containing IDs of processes display the corresponding process titles.
Comments on Tasks
Comments on tasks can be added by users via the actions menu. Those comments become part of the process history to which the corresponding task belongs.
Process Aspect Area
BPM variables can be displayed or hidden in the process aspect area for client users.
Predefined Filters for the Inbox View
It is possible to specify a filter configuration for the inbox view via the filter query parameter in the URL. Thus, you can provide a link to users that opens the inbox view with predefined filters. In the inbox view itself, the filters will be applied and visualized for the users in the graphical user interface. However, they are not specified in the URL that is visible in the browser. If the users reload the web page, the filter configuration is removed.
Hit Lists
- In mixed hit lists containing folder and document objects, the folder objects are displayed as first items and in bold to be easily identified.
- Hit lists containing objects of the same type but having different floating secondary object types assigned to them use the column configuration of the common object type.
Filter Values
Users can set the following filter values:
currentUserfor fields classified withid:organizationtoday,yesterday,tomorrowetc. for date fields
Those values can be saved in the default filter configuration as well.
Libraries for Creating a Custom Dashboard
Two new developer libraries are available on NPM. Those libraries allow for the creation of a custom dashboard with configurable widgets. With these widgets, e.g., frequently used search requests can be saved to the dashboard.
- The widget-grid library can be installed for creating custom dashboards. Widgets can be registered and afterwards configured by users.
>> www.npmjs.com/package/@yuuvis/widget-grid - The widget-grid-widgets library contains a set of suitable widgets to be used with the widget-grid library.
>> www.npmjs.com/package/@yuuvis/widget-grid-widgets
Version View
Table properties are supported in the object version comparison.
yuuvis® Momentum client as reference implementation
All new library features are introduced.
Web-API Gateway
Tenant-specific Resources (KDDA)
The endpoints for text, form, icon and configuration management of the system-controller accept an optional query parameter tenant now. If this parameter is set, the endpoint retrieves/updates the corresponding resource of the specified tenant instead of the global resource.
Business Process Management
Tasks can be retrieved with a reduced set of properties in order to save processing time.
Note: The feature has been added subsequently via version fix.
>> GET /api-web/api/bpm/tasks
>> GET /api-web/api/bpm/tasks/{taskId}
yuuvis® architect
Schema Management
- The Model mode allows to specify classifications for object type definitions and property definitions.
- Users with the YUUVIS_SYSTEM_INTEGRATOR role can create app schemata.
User Management
Users with the YUUVIS_MANAGE_SETTINGS role are allowed to manage users of their own tenant.
>> Rights and Roles
Catalog Management
Users with the YUUVIS_SYSTEM_INTEGRATOR role are allowed to manage tenant-specific catalogs for all tenants.
Configuration Management
As a Beta version, the Client configuration tile is available on yuuvis® architect's dashboard. Configuration files including plug-in configurations can be managed.
SOTHOOK
Stability Improvement
The service uses the webhook type dms.request.objects.upsert.database-before instead of dms.request.objects.upsert.storage-before. With this improvement, the service can handle old objects with metadata properties that are no longer defined in the current schema.
Note: Your system hook configuration has to be adjusted manually.
>> SOTHOOK
Tenant Management
Tenant Management API
admin-controller Endpoints
In the default configuration, users with the YUUVIS_MANAGE_SETTINGS role are allowed to manage users of their own tenant. They have access to all endpoints /tenant-management/api/admin/users/**. However, the following operations are not allowed for them:
- Assigning the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR roles.
- Editing the data of users having the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR role.
- Deleting users having the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR role.
>> admin-controller Endpoints (TENANT-MANAGEMENT)
idm-controller Endpoints
- The optional query parameter
briefRepresentationis available for the endpoint GET /tenant-management/api/idm/users. The response will contain only a reduced data set in order to reduce the processing time.
Note: Per default, the endpoint returns the reduced data set now. This might lead to a breaking change in your system if you use specific information from the endpoint's response.
Metrics Endpoints
The two endpoints for retrieval of global or tenant-specific metrics also provide the current number of folder objects now.
- GET /tenant-management/api/system/tenants/{tenant}/metrics – Retrieve the current global metrics.
- GET /tenant-management/api/admin/metrics – Retrieve the current tenant-specific metrics.
KEYCLOAK-PROXY Service
Operation of Multiple Instances
It is possible to run multiple instances of the KEYCLOAK-PROXY service in parallel (horizontal scaling) in order to support very high work loads.
>> KEYCLOAK-PROXY Service
Business Process Management
BPM Engine
Connecting an Identity Provider or Tenant Management API
It is possible to configure the BPM Engine such that it connects to any identity provider supporting the Custom IDM API or the idm-controller endpoints of the Tenant Management API. Thus, it does not have to be directly connected to the identity provider anymore and therefore does not necessarily require Keycloak.
>> BPM-ENGINE Service
However, it is still possible to connect Keycloak or the KEYCLOAK-PROXY Service to the BPM Engine.
Release Candidates
The Release Candidates (Alpha) provide the preliminary results expected to be ready at the corresponding date.
>> Version Tags Services - Release Candidates
Alpha1 - 06 JUN 2022
Core
Internal Tokens for Custom Services
- Custom services running in the yuuvis® Momentum Kubernetes cluster can use a new internal endpoint of the AUTHENTICATION service to get a valid internal JSON Web Token (JWT). (internal: OKTO-5207)
Parameter 'waitForSearchConsistency' for Endpoints with Effect on the Search Index
- Some processes that lead to an update of the index of the search engine can be called with the new parameter
waitForSearchConsistency. (internal: OKTO-5204)
Managing Secondary Object Types via Webhook
- Secondary object types can be added or removed via the POST dms.request.objects.upsert.database-before webhook if they are referenced as floating in the corresponding object type definition. (internal: OKTO-5254)
Client Services & Client Development
Developer Libraries
BPM Forms
- It is possible to configure BPM forms such that fields containing IDs of processes display the corresponding process titles now. (internal: BUD-529, BUD-1390)
Hit Lists
- In mixed hit lists containing folder and document objects, the folder objects are displayed as first items and in bold to be easily identified. (internal: BUD-1186)
yuuvis® Momentum client as reference implementation
- All new library features are introduced.
Web-API Gateway
Tenant-specific Resources
- It is possible to manage tenant-specific resources via system-controller. (internal: BUD-367)
yuuvis® architect
Schema Management
- Users with the YUUVIS_SYSTEM_INTEGRATOR role can create app schemata. (internal: BUD-367)
User Management
- Users with the YUUVIS_MANAGE_SETTINGS role are allowed to manage users of their own tenant. (internal: BUD-1373)
Alpha2 - 20 JUN 2022
Core
Management of Tenant-specific Role Sets
New endpoints allow for the management of the tenant-specific role set for any tenant by a system integrator. (internal: OKTO-5243)
Efficient Refresh of the Tenant Configuration
A new internal endpoint can be used to activate changes in the tenant configuration instead of the conventional refresh endpoint. (internal: OKTO-5273)
Client Services & Client Development
Developer Libraries
Predefined Filters for the Inbox View
- It is possible to specify a filter configuration for the inbox view via the
filterquery parameter in the URL (internal: BUD-1433)
SOTHOOK
Stability Improvement
- The service uses the webhook type
dms.request.objects.upsert.database-beforeinstead ofdms.request.objects.upsert.storage-before. With this improvement, the service can handle old objects with metadata properties that are no longer defined in the current schema. (internal: OKTO-5235)
Alpha3 - 04 JUL 2022
The two weeks from 15 to 28 JUN 2022 are 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 appearing bugs if possible.
Core
Support of DELL EMC ECS via S3 Protocol
- The ARCHIVE Service can be connected to a Dell EMC ECS as repository via S3 protocol. (internal: OKTO-5234)
Client Services & Client Development
Developer Libraries
Comments on Tasks
- Comments on tasks can be added by users via the actions menu. Those comments become part of the process history to which the corresponding task belongs. (internal: BUD-1429)
Alpha4 - 18 JUL 2022
Client Services & Client Development
Developer Libraries
Angular Version Update
- The client libraries use Angular 14 now. (internal: BUD-1491)
>> Breaking changes
Process Aspect Area
- BPM variables can be displayed or hidden in the process aspect area for client users. (internal: BUD-1521)
Hit Lists
- Hit lists containing objects of the same type but having different floating secondary object types assigned to them use the column configuration of the common object type. (internal: BUD-1187)
Version View
- Table properties are supported in the object version comparison. (internal: BUD-1490)
yuuvis® Momentum client as reference implementation
- All new library features are introduced.
yuuvis® architect
Angular Version Update
- With regards to the update of the client libraries to Angular 14, yuuvis® architect was updated as well. (internal: BUD-1491)
Schema Management
- The Model mode allows to specify classifications for object type definitions and property definitions. (internal: BUD-1203)
User Management
- Users with the YUUVIS_MANAGE_SETTINGS role are allowed to manage users of their own tenant. (internal: BUD-1526)
Catalog Management
- Users with the YUUVIS_SYSTEM_INTEGRATOR role are allowed to manage tenant-specific catalogs for all tenants. (internal: BUD-1391)
Business Process Management
BPM Engine
Connecting an Identity Provider or Tenant Management API
- It is possible to configure the BPM Engine such that it connects to any identity provider supporting the Custom IDM API or the idm-controller endpoints of the Tenant Management API. (internal: ERA-8451)
Tenant Management
KEYCLAOK-PROXY Service
Operation of Multiple Instances
- It is possible to run multiple instances of the KEYCLOAK-PROXY service in parallel (horizontal scaling). (internal: ERA-8636)
Alpha5 - 01 AUG 2022
Core
Comparing Database and Search Index
- The the
maintain-comparecommand provided by the COMMANDER Service is improved in terms of available parameters and output data. (internal: OKTO-5338)
Tenant Management
Tenant Management API
Security
- This service is updated to use SpringBoot version 2.7.1 so that known critical and high CVEs are eliminated.
idm-controller Endpoints
- The optional query parameter
briefRepresentationis available for the endpoint 'GET /tenant-management/api/idm/users'. The response will contain only a reduced data set in order to reduce the processing time. (internal: BUD-1488)
Metrics Endpoints
- The two endpoints for retrieval of global or tenant-specific metrics now also provide the current number of folder objects. (internal: ERA-8808)
Web API Gateway
Security
- This service is updated to use SpringBoot version 2.7.1 so that known critical and high CVEs are eliminated.
Client Services & Client Development
Developer Libraries
Filter Values
- Users can set the filter value to
currentUserfor user-specific fields, and totoday,yesterday,tomorrowetc. for date fields and save them as default query parameters. (internal: BUD-73)
Libraries for Creating a Custom Dashboard
- Programmers are supported by a library that allows for the implementation of a cockpit view for users. This cockpit view includes statistics the user's frequently used searches. (internal: BUD-1424)
Task Sequences
- Programmers are supported by a control that handles task sequences with tasks containing a name, a recipient, and an optional due date. This control also allows to save task sequences as templates and reuse them. (internal: BUD-1533)
yuuvis® Momentum client as reference implementation
- Query parameters are introduced.
yuuvis® architect
Configuration Management
- As a Beta version, the Client configuration tile is available on yuuvis® architect's dashboard. Configuration files including plug-in configurations can be managed.
Final - 29 AUG 2022
Core
Support of Redis Version 7.0.4
- yuuvis® Momentum has been tested with Redis Version 7.0.4. This version is now also used in the infrastructure Helm chart for test installations. (internal: OKTO-5069)
Support of Elasticsearch version 7.16
- yuuvis® Momentum has been tested with Elasticsearch version 7.16. This version is now also used in the infrastructure Helm chart for test installations. (internal: OKTO-5314)
Postponed Features
These initially planned features could not be realized. Some of them are planned for the next version 2022 Winter (LTS).
Client Services & Client Development
yuuvis® architect
Process Administration
As a first step of BMP integration, users with the YUUVIS_TENANT_ADMIN role are allowed to manage processes in their tenant. The development will be continued for the next releases to provide management of tasks and process variables as well.
Changelog
Bugfixes
Hotfixes
Below you can find information about the provided hotfixes. The latest status of all artefacts can be found here: "Version Tags Services".