Technical Release Notes 6.0
This document gives an overview of new features, changes and removed components of yuuvis® RAD 6.0.
Core Service (formerly known as DMS-Service, including BPM-Engine)
The application server of the service has been updated to WildFly 18.0.1
The new WildFly build brings the usual batch of security patches and enhancements as well as further improvements to custom logging (and clustering features that will be mentioned later). This version also introduces the basis for a potential upgrade of the Core Service to Java 11 or later.
For updates: It is necessary to deinstall the old Wildfly 9 based installation. For more information, click here.
PostgreSQL 11 Support
As of this version, PostgreSQL 11 is added to the list of the supported databases.
New Features in Core Service
Setup
The setup is optimized. In the beginning, you are asked whether you are updating the system or installing a new one. In the case of updating, you are no longer asked for special known parameters.
ETL configuration for the SAP interface
The necessary ETL configuration for the SAP interface can be loaded using a new REST-WS interface:
Configuration of logging
The REST-WS interface supports the settings of the logging packages. This feature was part of the enterprise-manager.
The logging configuration can be reached in the rest-ws monitor page or by using this URL: http://<core-service-ip>:8080/rest-ws/#PAGE:monitor/logging
State snapshot
To shorten the time for system analyses, it is possible to create a state snapshot of the system at this moment. Use the download link 'Create system snapshot' on the Monitor view of the REST-WS interface to get a ZIP file with the most important system information.
The Monitor view can be reached via this URL: http://<core-service-ip>:8080/rest-ws/#PAGE:monitor → System State Snapshot → Download System State Snapshot
Import with existing full text
During the import of objects, it is possible to provide their full text to the rendition service. This reduces system resources if the full text was extracted before.
See the tag 'text' in the documentation of the corresponding endpoint at http://<core-service-ip>:8080/rest-ws/#ENDPOINT:DmsBatchService.createObjects
Request for product information
It is possible to retrieve the Core Service's product information which is shown in the System info of the REST-WS user interface. For example, this information can be displayed on the workstations of development and test systems.
The REST-API endpoint is http://<core-service-ip>:8080/rest-ws/#ENDPOINT:SystemService.getInfo
Changes in Workflow Scripting
The variable $.process.responsibles has been deprecated. To work with process owners, user the variable $.process.owners instead.
The dedicated script debug log that was deprecated as of version 3 is no longer available. In versions 4, 5 and 6, the script logs are written to the standard log of the workflow engine.
Index Service, Search Service and Structure Service
Upgrade to Elasticsearch 7.2
These services are based on Elasticsearch 7.2 now. This version offers more secure processing, much more performant autocomplete functionality and optimizations for search including special characters.
For updates: It is necessary to uninstall the old Elasticsearch 6.3 installation. For more information, click here.
New Features and Improvements
Thanks to the Elasticsearch upgrade
- the search results are much better
- the autocomplete functionality can now be used in systems with more than 20 million objects without loss of performance
- security aspects are optimized
- While updating to yuuvis RAD 6.0 the existing autocomplete index is migrated automatically to a new and better structure after the restart of the system. On average, it takes 1 hour to process 2 million objects. The newest objects are processed first.
Reindexing the Elasticsearch index
The Swagger UI (REST API) of the Index Service allows starting the reindexing of the Elasticsearch index. Monitoring is possible by observing the log file of the Index Service. On average, it takes 1 hour to process 2 million objects. The newest objects are processed first. Be careful when using this feature, because the system performance is affected.
The REST-API endpoint is /api/reindex (POST). To use the Swagger UI, go to http://<service-manager-ip>:7291/swagger-ui.html, select "index-api" from the dropdown menu at the top and click "/api/reindex"
Creating the autocomplete index subsequently
The Index Service allows starting the creation or subsequent completion of the Elasticsearch autocomplete index. Monitoring is possible by observing the log file of the Index Service. On average, it takes 1 hour to process 0.5 million objects.
The REST-API endpoint is /api/autocomplete/complete (POST). To use the Swagger UI, go to http://<service-manager-ip>:7291/swagger-ui.html, select "index-api" from the dropdown menu at the top and click "/api/autocomplete/complete"
Configuring Elasticsearch shards
Starting with Elasticsearch 7, the Elasticsearch team recommends using only one shard per node as long as possible. One shard can handle 40 to 70 GByte of index data. Previous versions of the yuuvis® RAD Index Service defaulted to creating four shards per index. Starting with 6.0, the default is now one shard per index. You can specify the number of shards osfts.number-of-shards in index-prod.yml. If you want to change the number of shards of the already existing index, you need to adjust the osfts.number-of-shards and then reindex the data. For reindexing use the new reindexing endpoint as described above.
Search API: Breaking change
In the search response, hits.total is an object instead of a number now. The total hits that match the search request are now returned as an object with a value and a relation.
The value indicates the number of matching hits and the relation indicates whether the value is accurate (eq) or a lower bound (gte):
{
"hits": {
"total": {
"value": 1000,
"relation": "eq"
},
...
}
}
The total object in the response defines that the query matches exactly 1,000 documents ("eq"). The value is always accurate ("relation": "eq") when track_total_hits is set to true (default) in the request.
Gateway Service: Header Authentication
The "authentication.filter.header.name" gateway property can be set to enable header authentication. This allows callers to set the user context as a request header. The property value contains the context header's name. It is disabled by default and already existing installations are not affected.
management-studio
'Use template service' Capability
The new 'Use template service' capability controls whether the template service should be used for Word templates or not. Customers who do not use Word templates can reduce system resources now.
User profile image
It is possible to save an image to the user profile. While selecting this image, a validation takes place to only save JPG or PNG files with a file size smaller than or equal to 512 Kbyte.
Archive Operation
It is possible to configure whether the archive operation counts the affected objects prior to processing. This is only necessary for displaying the progress but it is an expensive action.
To enable or disable this action, go to Operations > Repository operations > Archiving, select an operation and enable or disable the 'Count objects before executing the operation' checkbox.
BPM Service
The /api/bpm/process and /api/bpm/process/user API endpoints of the BPM service have been marked as deprecated. Please use the /api/bpm/processes endpoint instead. It offers the same functionality.
Inbox Service
The Inbox Service no longer stores its data in Elasticsearch. Instead, its data is stored in the in-memory cache of the service. In case the memory dedicated to this service is consumed, the service will switch to a mode where the data is persisted to disk storage. The swap data is stored in the temporary storage of the service-manager by default. No further configuration of the service is necessary.
Inbox Service API will be refactored in the next major version. Use of its endpoints in scripting or in custom microservices should be reduced to user-related endpoints only, not to endpoints for internal use (such as POST /api/inbox/{userid}/refresh or DELETE /api/inbox/{userid}/remove).
Client
Performance
- A better caching of definition data and a reduction of backend calls leads to a better performance of the client and backend.
- For an economical use of resources, the hit list loads new objects in chunks of usually 20 objects. This number can be configured to reflect system-specific needs.
Result list: paging and column menu
The way to browse through the list in the result view has been changed to reduce backend calls and improve performance: instead of infinite scrolling, the user can now go from page to page by clicking on icons in the list footer. Please note: The page size can be configured by an administrator:
Copy the file <service-manager-data>\webresource\public\client\assets\_default\config\main.json to <service-manager-data>\webresource\resources\client\assets\_default\config\main.json and edit it as follows
"search": {
...
"limit": 50
},
The menus of columns have been reduced: only filtering is now offered. All other features like removing or pinning a column are available by drag and drop.
Custom client build
Due to the changes to the result list (paging, filtering), there is no further need for the enterprise license for ag-Grid in case of building a Custom Client.
Viewing area
- Besides undocking the complete object details area, it is possible to only undock the viewer area of the 'Content' aspect. This way, the result list and object details with focused index data are shown on one screen, and a second screen can be used for the preview of the document file.
- You can configure dynamic viewing plugins without building a Custom Client to optimize the viewing for special mime-types which are not supported by our standard viewers. So external viewers can be reused as well.
Download document file
For quick viewing access, the download icon is offered in the title of the object details even though the agent is connected.
Open document file
In case the user decided to always be asked whether to lock an object or not, the 'Open document file' a dialog is opened when he calls this action and offers the option to lock the document or not. Now, this dialog is also opened when clicking on the pencil icon.
Preview area
As of yuuvis RAD 6.0, an alternative undocking feature is available to support the work on two monitors: the preview area can be undocked. This feature will replace the undocking of the object details area and is the next step towards having a window that will remain where it is when changing the application state (e.g. from result state to object state).
After installing version 6.0, the undock icon in the small dialog that controls the hiding of view areas is hidden. To unhide it, do the following:
Copy the file <service-manager-data>\webresource\public\client\assets\_default\theme\theme.css to <service-manager-data>\webresource\resources\client\assets\_default\theme\theme.css and edit it as follows
.undock-button {
display: block !important;
}
PDF preview shows digital signature annotations
The preview shows digital signature annotations without validation information. For validation of such integrated signatures, the original file has to be downloaded and opened in e.g. Acrobat Reader.
Please note that we cannot guarantee that all annotations can be displayed.
Search dialog
In the search dialog, the search fields for 'Created' and 'Modified' are supporting the time as well in case of ranges so the results can be filtered in smaller time ranges.
Browser tab labels
All labels have been optimized. The focused information is more readable and it is easier for the user to find the relevant tab.
References aspect
The focused type of references is remembered. This way, users do not have to focus again every time they want to view an object's references.
Discontinued Components and Features and Resulting Todos
Functional rights "Create subscriptions for other users" and "Create follow-ups for other users" have been removed
The functional rights "Create subscriptions for other users" and "Create follow-ups for other users" are no longer in use by client and backend services and are removed from version 6.0.
The functionality of the system will not be affected in case they continue to be used in an active system schema after updating to 6.0. However, we recommend removing these rights from roles when updating to version 6.0.
enterprise-manager
With the release of enaio® redline 5.0 this component was announced to be discontinued in version 6.0.
Most of the enterprise-manager functionalities were migrated to management-studio in versions 5.0 or later.
Three features are migrated to the REST-WS user interface: the system monitoring, the configuration of logging, and the configuration of the necessary ETL configurations for the SAP interface. See the information in the section New Features in Core Service.
template-service and template-editor
We reevaluated our decision to discontinue these two components and will keep them as licensable parts of the product yuuvis® RAD 6.0, as is. For system integrators who wish to customize or extend the functionality, we will still offer the sources, as announced earlier.
Status service
The functionality of this service has been moved to other components, therefore it is removed from the services stack. When updating to version 6.0, this service must be manually removed as described here.
rendition-plus
Conversion by OpenOffice is no longer supported.
Documentation
The admin and user documentation for yuuvis® RAD 6.0 is now available in our help portal in both German and English.