Product Version 2022 Summer
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 some Update Instructions.
Core
Deleting a Tenant (KDDA)
A tenant including all saved objects can be deleted from the yuuvis® Momentum system via the COMMANDER service.
>> maintain-tenant-data-delete Command
Invalidation of User Sessions (KDDA)
Active sessions of logged-in users can be invalidated via a new internal endpoint of the AUTHENTICATION service.
>> GET /session/invalidateAll/{userId}
Validation of Internal JSON Web Tokens
The internal endpoint of the AUTHENTICATION service for the validation of internal JSON Web Tokens (JWTs) is now available via a different URL.
>> Breaking Changes | GET /jwt/verify
Audit Entry for Content Retrieval via Chunks
Only one audit entry is created for the retrieval of a binary content file even if it is retrieved in chunks.
>> Audit Trail - an "Object's History"
Audit Entries for Text and PDF Renditions
An audit entry with action code 402/403 is created if a user retrieves a text/PDF rendition of a document object. If the user retrieves the text or PDF rendition of the same object multiple times within 10 minutes, only the first retrieval is documented in the audit trail.
>> Audit Trail - an "Object's History"
Available Endpoints for Cross-Tenant Service Accounts
The endpoint PATCH /api/dms/objects/{objectId} is enabled for access via cross-tenant service accounts now.
>> Cross-Tenant Service Accounts
Global and App-specific System Hook Configuration
The systemHookConfiguration.json
configuration file can be retrieved and updated via the yuuvis® Momentum endpoints listed below. The changes are applied immediately after a successful update of the configuration.
- GET /api/system/systemhooks - Retrieves the global
systemHookConfiguration.json
. - POST /api/system/systemhooks - Updates the global
systemHookConfiguration.json
. - POST /api/system/systemhooks/validate - Validates the global
systemHookConfiguration.json
.
Furthermore, it is now possible to define app-specific system hook configurations.
- GET /api/system/apps/{app}/systemhooks - Retrieves the app-specific
systemHookConfiguration.json
. - POST /api/system/apps/{app}/systemhooks - Updates the app-specific
systemHookConfiguration.json
. - POST /api/system/tenants/{tenant}/apps/validate - Validates the app-specific
systemHookConfiguration.json
.
>> systemHookConfiguration.json
Options for Restoring old Versions of Objects (KDDA)
The endpoint for restoring an old version of a DMS object accepts an optional query parameter that is relevant for objects with a system:parentId
property. This property indicates that the object is considered as a child object of a folder object. The old version of the child object to be restored might have a different value for the system:parentId
property. Thus, you might want to keep the current value for the system:parentId
property of the child object even after restoring an old version. The new query parameter can be used to specify whether to keep the current system:parentId
or to use the value of the respective old version.
>> POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore
Synchronization of CONFIGSERVICE and Git Server (KDDA)
It is possible to synchronize the local resources of the CONFIGSERVICE and the remote resources on the git server via the endpoint POST
<host>:<port_of_configservice>/manage/refresh
at any time now. This synchronization is additional and independent of the automated synchronization every 5 minutes.
>> CONFIGSERVICE
Client Services & Client Development
Developer Libraries
Form Fields for User Names
Properties that store a user ID and appear with the corresponding user name can be specified via id:organization
classification. As soon as users start typing in the form field, a selection list with user names is provided for which the entered term was found in the user name, name, surname or e-mail address. It is now possible to specify roles as filter condition. Only user names of users having at least one of those roles are offered for the corresponding form field. The feature is available in DMS forms as well as in BPM forms.
>> Defining Object Types for a Library-based Client
Object Type Classification via Secondary Object Type (KDDA)
Classifications specified in the schema definition of a secondary object type (SOT) have impact on all object types that have a static reference on the SOT in their schema definition. The feature is of special interest for the usage of multiple schema files where the SOT is defined in a different schema than the referencing object types. In this case, it is sufficient to update the classifications in the schema containing the SOT in order to apply the classification changes to the object types as well without updating the corresponding schemata.
These classifications control the availability of the corresponding object types in different views and menus, such as the object creation view or the filter configuration menu.
>> Defining Object Types for a Library-based Client
Filtering Processes and Tasks
The Inbox, My Processes and My Follow-ups views allow for filtering the displayed tasks or processes respectively.
Localization and Language-specific Time and Number Formats (KDDA)
- Swiss German is supported as
de-CH
. In contrast to German, the decimal separator is a dot instead of a comma whereas the thousand separator is an apostrophe instead of a dot. In order to define specific terms in Swiss German that differ from German terms, save a corresponding localization configuration file. If node-CH.json
file is available, the German localization filede.json
is used as default. - The framework library supports the specific time and number formats for Finnish (
fi
), Norwegian (nb
), Thai (th
) and Vietnamese (vn
).
Note: The feature has been subsequently added to the versions 2021 Winter and 2022 Spring as well.
Icon Management via Object Type Classification
It is possible to assign a global icon to an object type via a classification. Thus, the icon can be reused in multiple tenant schemata in order to reduce the number of stored icons.
>> Defining Object Types for a Library-based Client
Retention Management
Users with a specific role can manage retention for document objects via a client application now. The role can be configured in the main configuration.
- The new Retention management view lists objects with retention properties assigned to them. The list can be filtered by Nextmonth (default) and To be removed.
- The object actions menu allows to assign a retention to a document object. For objects that are already under retention, an action is offered to extend the retention time.
Object Summary Aspect Area (KDDA)
- The Summary Aspect Area of objects in a client application can now display table properties.
- Properties can be classified such that they are not displayed in the Summary Aspect Area.
Restoring old Versions (KDDA)
The behavior of client applications takes advantage of the new possibility to restore an old object version including binary content file and all metadata except its value for the system:parentId
property. This property indicates that the object is considered a child object of a folder object. Client applications always keep the current value for this property now. Hence, the restored object will not appear in its former parent folder but will stay in the same folder where the current version is stored.
>> Options for Restoring old Versions via Core API
yuuvis® Momentum client as reference implementation
All new library features are introduced.
>> Structure and Features of the Client
Web-API Gateway
Performance Optimization (KDDA)
All schemata retrieved via Web-API Gateway are cached and can thus be reached more quickly. Furthermore, the frequency of requests to the core system's CONFIGSERVICE is reduced.
Schema Management
You can use the graphical user interface provided by yuuvis® architect to define object types and their properties for the business objects in your client application. The object types and properties are defined in schema structures. Depending on the roles assigned to the currently logged-in user, it is possible to manage the global schema, app schemata and/or tenant schemata.
>> Schema Management
Localization
In the localization view, the list of languages contains only those that are prepared to be supported by the corresponding client application. The local variant for German de-CH
is not included.
>> Localization
Tenant Management
Tenant Management API
Support of other Identity Providers than Keycloak
An example custom IDM Proxy Service demonstrates how to connect a different identity provider than Keycloak that supports the idm-controller endpoints. The example microservice connects the web identity management system Auth0. The service is available as a beta version on request.
>> TENANT-MANAGEMENT Service
Deletion and Deactivation of Users
The deletion/deactivation of users leads to an invalidation of all their active sessions. Thus, the deleted/deactivated users are not able to use yuuvis® Momentum anymore. The following endpoints are affected.
Deletion:
- DELETE /tenant-management/api/admin/users/{id} - Deletes the specified user from the active tenant.
- DELETE /tenant-management/api/system/tenants/{tenant}/users/{id} - Deletes the specified user from the specified tenant.
- DELETE /tenant-management/api/system/tenants/{tenant} - Deletes a specified tenant including all users.
Deactivation (if the enabled
property is changed to false
):
- PUT /tenant-management/api/admin/users/{id} - Updates the data of the specified user.
- PUT /tenant-management/api/system/tenants/{tenant}/users/{id} - Updates the data of the specified user of the specified tenant.
User Retrieval
Users with the YUUVIS_SYSTEM_INTEGRATOR role are excluded from user lists that can be retrieved via the endpoint GET /tenant-management/api/idm/users.
Note: This feature is added to the version subsequently.
KEYCLOAK-PROXY Service
Connection of Missing Instances
The KEYCLOAK-PROXY service establishes connections to all Keycloak instances that were configured. If a configured Keycloak instance is not available, it is ignored during service initialization and marked in red on the graphical user interface. The KEYCLOAK-PROXY service automatically tries to establish missing connections during requests that concern multiple tenants.
>> KEYCLOAK-PROXY Service
Release Candidates
The Release Candidates (Alpha) provide the preliminary results expected to be ready at the corresponding date.
>> Version Tags Services - Release Candidates
Alpha1 - 28 FEB 2022
Core
Invalidation of User Sessions
- Active sessions of logged-in users can be invalidated via a new endpoint. (internal: OKTO-5054)
Client Services & Client Development
Developer Libraries
Filtering Processes and Tasks
- The My Processes view allows for filtering the displayed processes respectively. (internal: BUD-1007)
yuuvis® Momentum client as reference implementation
- All new library features are introduced.
Alpha2 - 14 MAR 2022
Core
Available Endpoints for Cross-Tenant Service Accounts
- Further endpoints are enabled for the access via cross-tenant service accounts. (internal: OKTO-5113)
Client Services & Client Development
Web-API Gateway
Performance Optimization
- All schemata retrieved via Web-API Gateway are cached. (internal: BUD-515)
Developer Libraries
Object Type Classification via Secondary Object Type
- Classifications specified in the schema definition of a secondary object type (SOT) have an impact on all object types that have a static reference on the SOT in their schema definition. They control their availability in different views and menus. (internal: BUD-1025)
Retention management
- The Retention management view lists objects with a retention property. The list can be filtered by Next month (default) and To be removed. (internal: BUD-996)
- The object actions menu allows to assign a retention to a document object. For objects that are already under retention, an action is offered to extend the retention time. (internal: BUD-977)
yuuvis® Momentum client as reference implementation
- All new library features are introduced.
yuuvis® architect
Schema Management
- A new Schema management tile provides the following features for users with the corresponding role. (internal: BUD-14)
- Users with the YUUVIS_TENANT_ADMIN role can manage the tenant schema.
- Users with the YUUVIS_SYSTEM_INTEGRATOR role can manage all tenant schemata, the global schema as well as the app schemata.
- A schema can be saved as a draft even if it is not yet valid.
- The differences between the currently deployed schema and a draft schema can be visualized in an XML view.
- The schemata can be exported and imported as files.
Alpha3 - 28 MAR 2022
Client Services & Client Development
Developer Libraries
Viewer Service
- For PDF files, the print action is offered together with additional page alignments.
yuuvis® Momentum client as reference implementation
- All new library features are introduced.
Alpha4 - 12 APR 2022
Core
Audit Entry for Content Retrieval via Chunks
- Only one audit entry is created for the retrieval of a binary content file even if it is retrieved in chunks. (internal: OKTO-5096)
Audit Entries for Text and PDF Renditions
- An audit entry with action code 402/403 is created if a user retrieves a text/PDF rendition of a document object. If the user retrieves the text or PDF rendition of the same object multiple times within 10 minutes, only the first retrieval is documented in the audit trail. (internal: OKTO-5195)
Global and App-specific System Hook Configuration
- App-specific webhooks can be configured via an API endpoint. (internal: OKTO-5132)
- The global system hook configuration can be managed via API endpoints. (internal: OKTO-5133)
Client Services & Client Development
Developer Libraries
Filtering Processes and Tasks
- In the Inbox, My Processes and My Follow-ups views, users can reduce the list of displayed processes/tasks by specifying a search term to be matched. (internal: BUD-1051, BUD-976)
Form Fields for User Names
- A form field of type string and classification
id:organization
can be configured such that its value can only be a user with a specific role. (internal: BUD-411)
Localization and Language-specific Time and Number Formats
- Swiss German is supported as
de-CH
. In contrast to German, the decimal separator is a dot instead of a comma whereas the thousand separator is an apostrophe instead of a dot. In order to define specific terms in Swiss German that differ from German terms, save a corresponding localization configuration file. If no filede-CH.json
is available, the German localization filede.json
is used as default. (internal: BUD-1109)
Note: The feature has been subsequently added to the versions 2021 Winter and 2022 Spring. - The framework library supports the specific time and number formats for Finnish, Norwegian and Thai. (internal: BUD-1114)
Icon Management via Object Type Classification
- It is possible to assign a global icon to an object type via classification. Thus, the icon can be reused in multiple tenant schemata in order to reduce the number of stored icons. (internal: BUD-1116)
yuuvis® Momentum client as reference implementation
- All new library features are introduced.
yuuvis® architect
Localization for Swiss German
- In the localization view, the list of languages contains only those that are prepared to be supported by the corresponding client application. However, Swiss German (
de-CH
) is NOT included. (internal: BUD-1138).
Alpha5 - 25 APR 2022
The two weeks from 06 APR to 19 APR 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.
Client Services & Client Development
Developer Libraries
Localization and Language-specific Time and Number Formats (KDDA)
- The framework library supports the specific time and number formats for Finnish (
fi
), Norwegian (nb
), Thai (th
) and Vietnamese (vn
). (internal: BUD-1189, BUD-1194, BUD-1114)
Deleting a Tenant
- A tenant including all saved objects can be deleted from the yuuvis® Momentum system. (internal: OKTO-5037)
Final - 25 MAY 2022
Core
Options for Restoring old Versions of Objects
- The endpoint for restoring an old version of a DMS object accepts an optional query parameter that can be used to specify whether to keep the current
system:parentId
or to use the value of the respective old version. (internal: OKTO-5169)
Synchronization of CONFIGSERVICE and Git Server (KDDA)
- It is possible to synchronize the local resources of the CONFIGSERVICE and the remote resources on the git server at any time. (internal: OKTO-5221)
Tenant Management
Tenant Management API
Deletion and Deactivation of Users
- The deletion of users leads to an invalidation of all their active sessions. (internal: BUD-451)
- The deactivation of users leads to an invalidation of all their active sessions. (internal: BUD-1305)
KEYCLOAK-PROXY Service
Connection of Missing Instances
- The KEYCLOAK-PROXY service automatically tries to establish missing connections during requests that concern multiple tenants. (internal: ERA-8567)
Client Services & Client Development
Developer Libraries
Object Summary Aspect Area
- The Summary aspect area of objects in a client application can now display table properties. (internal: BUD-1239)
- Properties can be classified such that they are not displayed in the Summary aspect area. (internal: BUD-1310)
Restoring Old Versions
- If an old version is restored, it is still stored in the parent folder of the current version. (internal: BUD-1291)
yuuvis® Momentum client as reference implementation
- The new library feature is introduced.
Postponed Features
These initially planned features could not be realized. Some of them are planned for the next version 2022 Autumn.
Core
Redis Version Update
A newer Redis version is supported and included in the example infrastructure.
Client Services & Client Development
yuuvis® architect
Selecting the Target Tenant
System integrators cannot only maintain tenant-specific resources of their own tenant but can select a target tenant now.
Configuration Management
Administrators can set up the standard column and filter configuration for their client application as well as its plug-ins.
Changelog
Bugfixes
Hotfixes
Below you will find information about the provided hotfixes. The latest status about the atrefacts can be bound here: "Version Tags Services".