What Is New in yuuvis® RAD 7.0

yuuvis® RAD 7.0 is the newest major version of our rapid application development tool for content-centric applications. It brings several new functions and technical improvements. Here is a brief overview:

• Update of the database drivers
• Update of Elasticsearch 
• Update of the client and its libraries to a newer version of Angular
• Optimizations of system maintenance 
  

Technical Improvements

We have updated the current drivers of the supported databases:

• Microsoft® JDBC Driver 8.4.1 for SQL Server 2019 and former versions
• PostgreSQL JDBC Driver 42.2.18 for PostgreSQL 12 and former versions

We have updated the Search Service, Index Service, and Structure Service for the Elasticsearch version 7.9.3. No reindexing is necessary, but your installed Elasticsearch must be updated as well.

We have updated the client including its library to Angular 11. Be aware that you have to update your custom client and adapt your own components as well.

Performance improvement of the BPM-Service due to upgrading the core-service to Java JDK Version 11.0.9.11. 

Technical Changes

• The URL for calling yuuvis® RAD client as well as yuuvis® RAD management-studio has changed. See here what to do while updating to version 7.0: How to upgrade to yuuvis RAD 7.0
• Changed body for OperationService.listRunningTasks and OperationService.getRunningTask. The produced JSON schema is available as endpoint documentation (REST-WS).

Changes of Labels

• Some labels were changed due to user feedback.

New Maintenance Features

• The session handling is optimized. Current sessions can be monitored on the REST-WS status page. To avoid DOS attacks, the maximum number of sessions for one user can be configured in yuuvis® RAD management-studio.

• You can monitor the technical update tasks on the REST-WS status page.

New Features in yuuvis® RAD designer

• A workflow model can be saved with a single click including all changes in all scripts and forms.

New Features in yuuvis® RAD client

• The decimal values in the CSV export for form table data are formatted according to the language the user has set.
• It is possible to format the process variables that are shown in the title and/or description of a business process, in the same manner as for DMS fields in the title of a document. The default formatting for some fields may be changed in comparison to yuuvis® RAD 6.16, so we advise to doublecheck the titles and descriptions of existing models and processes.
• After successfully saving metadata, no notifications are displyed any longer and do not block certain buttons for a short preiod of time.

Deprecated Functions and Removed Features

• With version 6.0 we announced to deprecate the ETL functionality with version 7.0. It is still available for the SAP integration, but the XML file extraction and script execution functionalities have been removed. You have to migrate your import process to a Talend import process.
  Notice: If you try to import with your old process, you will see an error stating the "Driver can not be loaded" in the ETL log.
  With version 8.0, the entire ETL functionality will be removed because the SAP integration will not rely on ETL anymore.
• Binary fields have been deprecated, since it is better to keep binary content as document payload (its content is searchable, can be rendered) of an object, so its use in projects was extremely rare. Projects that use this type will receive a deprecation warning. The field type will be removed with the next major version of yuuvis® RAD.
• The deprecated functional rights "Assign global roles" and "Edit roles related to global domain" have been removed. These rights will be automatically removed from the server during an update to version 7.0. and they will no longer be included in  system snapshots created from an updated server. However, they may still exist in older projects located on local filesystems. In case that they are still present and an administrator attempts to activate such schemas, the schema and role set validation will show an error – they must be removed from the rights system prior to activating the schema and role set in a yuuvis® RAD 7.0 system or later (or a snapshot of an already updated system should be taken in order to create a project without these rights).
• BPM Script: the deprecated script property process.responsible has been removed. It had been deprecated with the introduction of process.owners which can also be changed (unlike process.responsible which was read-only).
• BPM-Service
  • The deprecated optional parameter "maindoc" has been removed in  the following endpoints of the bpm-service:

    • GET api/bpm/process/{processId}/file - get process file

    • POST /process/{processId}/file/{elementId} - create process file

    • PUT /process/{processId}/file/{elementId} - update element of process file

    • POST api/bpm/process"- get list of process instances that include documents (parameter of call) in their files

  • The following deprecated methods have been removed:

    • GET /api/bpm/process

      • The method GET /api/bpm/processes should be used instead 

    • GET /api/bpm/process/user 

      • core-service method BpmProcessService.getProcesses should be used instead 
• Core-Service

  • The locationinfo parameter for DmsService.getItem has been removed. Use the contextinfo parameter instead.

  • The renditionType parameter for MediaManagementService.assignBinding has been removed. This parameter is no longer necessary and has not been handled in previous versions.

  • The csmeta parameter for ResultService.getEsqlResult has been removed. Use the datameta parameter instead.

  • The internal endpoint InterProcessResourceService.getRendition has been removed.

The focus of yuuvis® RAD version 7.0 were updates of relevant 3rd party components. Additionally, some new features and changes took place that will be described in this documentation.

 yuuvis® RAD designer

While saving a changed workflow model, changes in all scripts and forms are saved as well.

 yuuvis® RAD client

CSV export of form tables

The decimal values are formated according to the language the user has set.

If the decimal delimiter is a dot the column separator is a colon. 
If the decimal delimiter is a colon the column separator is a semicolon.

Notifiers are reduced

In case of a successful saving of metadata changes, notifiers are no longer shown. This prevents buttons from being blocked for the time the notifier is visible. 

Changed labels

• Instead of index data, the more widely known term metadata is used (in  yuuvis® RAD management-studio as well)
  In German: 'Indexaten' → 'Metadaten'
• We received the feedback that the label 'Context folder' is confusing, so we decided to remove the label Context and use Folder instead.
  In German: 'Kontextordner' → 'Ordner'
• The button labels of the drop-zone for creating new documents with a file are optimized.
  The first button shows the folder type the new object should be filed in.
  The second button shows the selected element of the folder structure. We removed the term 'selected tree item'.
  

yuuvis® RAD agent 6.3.1

While initiating the sending of a specific e-mail via a custom action the bcc address can be set as well.

yuuvis® RAD management-studio

In the system settings, it is possible to set for the core service at how many sessions per user no further session will be accepted so that 'OutofMemory' can be avoided. Default is 1000.
If this number of sessions is reached, the core-service API throws error code 429 (Too Many Requests).

REST-WS Interface

• The technical update operation tasks can be monitored on the Monitor page.
• It is possible to remove an active session on the  Monitor page as well.
  

yuuvis® RAD repository-manager 4

yuuvis® RAD repository-manager has been renewed and extended. It covers the SAP-archivelink-interface as it did earlier. Additionally, it covers the SAP-ILM-interface. Please note that ILM requires a separate license which needs to be bought.
The version completely replaces the former implementation. This means that uninstalling any older version is necessary before installing the new version incase of an update. The KGS configuration inside yuuvis® RAD repository-manager needs to be done from scratch, because yuuvis® RAD repository-manager now contains the current version of KGS content manager.
There is no need to adapt the configuration in SAP, update the data model for archive link or migrate data.

Fuzzy Search (Search Service)

Beginning with this version, it is possible to enable a fuzzy logic in the the search service. This allows users to mistype their search terms and still find what they were looking for. However, activating this feature has the following consequences:

• The fuzzy search will find more relevant objects.
• The performance will decrease slightly.
• The standard search will find objects for more than one term, i.e., search strings such as "term1 term2", where term1 is in the metadata and term2 in the content, or where term1 is in one field and term2 in another. The fuzzy search will only find objects where both terms are in the same field.
• Terms like e-mail addresses cannot be found if they are separated by a colon.

Please refer to the documentation on how to configure the fuzzy search: https://help.optimal-systems.com/yuuvisRAD/v70/admin/de/administration/installation/inst_tsk_elasticsearch.htm?Highlight=fuzzy

Retention Management

The retention management has been extended by the following features:

yuuvis® RAD management-studio

• You can schedule operations to delete objects, e.g., objects that have reached their retention date, by configuring an ESQL statement.
• All available operations are listed in the clean-up history instead of only those that have been carreid out. This way, it is possible to also schedule the clean-up of operations for those that have not been used yet.
• The report of the object deletion operation shows a detailed error message as well.

yuuvis® RAD client

When trying to delete an object set for retention, a confirmation dialog will appear informing about the active action. This dialog does not contain a Delete button.

Custom Client Development

The BPM process file can be forced to be refreshed using an event trigger. Use case: In the Inbox, a user clicks a custom or plug-in object action that adds new objects to the process file and forces the process file list to show the new objects as well.

Documentation for Developers

The localization of history endpoints is possible via the backend. By default, the history endpoints are delivered in English and German. If you need translations for other languages in your own client, you may use the keys of the history events. A list of those keys can be found in the REST-WS endpoint getAuditItem.

yuuvis® RAD repository-manager

After starting the repositorymanager service, the object definition can be found in the workdir (per default <servicemanager-data>\rm).

Blocking User Accounts Temporarily

Administrators can configure the maximum number of login attempts as well as the timeout for blocking the account in the system view of yuuvis® management-studio. If the time is set to -1, the user will be blocked until an administrator unblocks the account.

The blocking status of a user can be checked in the organization view. The account can be unblocked here as well:

In addition, the REST-WS Sessions Monitor has been extended. The number of temporarily blocked accounts is shown here as well.

In case a login to yuuvis® RAD was not successful, the user will receive a corresponding error message on the login page, informing about a possible blocking of the account.

Documentation for Developers

In the REST-WS interface, developers can obtain a list of all possible error codes including a short description. This data can be copied for translation purposes if needed.

To do so, open the new list of errors via the hompage of the REST-WS interface. The URL follows the following pattern: http://myDomain:8080/rest-ws/#PAGE:error_codes

yuuvis® RAD repository-manager

After starting repositorymanager service, the object definition can be found in the workdir (per default <servicemanager-data>\rm).

Blocking User Accounts Temporarily

Administrators can configure the maximum number of login attempts as well as the timeout for blocking the account in the system view of yuuvis® management-studio. If the time is set to -1, the user will be blocked until an administrator unblocks the account.

The blocking status of a user can be checked in the organization view. The account can be unblocked here as well:

In addition, the REST-WS Sessions Monitor has been extended. The number of temporarily blocked accounts is shown here as well.

In case a login to yuuvis® RAD was not successful, the user will receive a corresponding error message on the login page, informing about a possible blocking of the account.

Documentation for Developers

In the REST-WS interface, developers can obtain a list of all possible error codes including a short description. This data can be copied for translation purposes if needed.

To do so, open the new list of errors via the hompage of the REST-WS interface. The URL follows the following pattern: http://myDomain:8080/rest-ws/#PAGE:error_codes

Localization of Server-Side Messages

Administrators can have client's the language files translated into other languages than the default ones, which are English and German. However, some messages have not been part of these language files in the past. These messages are part of the history of objects and processes, and were handled as server-side resources. We have now added new keys to the client's language files that include these server-side messages. This way it is possible to also have them translated into any desired language.

Core-Service Security

The initial core service setup writes the database password as encrypted into the configuration file and the consuming services decrypt it.
You do not have to encrypt your password when updating. However, you are able to encrypt it using an additional tool, see Necessary Actions When Updating or Upgrading to 7.12.

Searchservice

The scoring is optimized for non-system parameters: the fields configured for scoring are higher rated than content.

yuuvis® RAD client

Searching for Table Cells with no Values

It is now possible to search for table cells that do not have values. This can be done just like for regular fields by clicking on the field label. In case of a table cell the tableform has to be opened before. After closing the form, the corresponding table column is flagged accordingly.

Connecting yuuvis® RAD agent 

As an administrator, you can configure the setting for the use of yuuvis® RAD agent. If this configuration is set, users are no able to configure the setting themselves. The following options are available:

• Disallow or force the connection to yuuvis® RAD agent
• Set locking behavior if the connection is forced

Please refer to our documentation for detailed information..

Filtering in the Create Object Dialog

In the Create object dialog, a filter has been added to quickly find the correct object type, in case the list of availble object types is very long.

yuuvis® RAD repository-manager

The installation of yuuvis® RAD repository-manager is part of the installation or update of yuuvis® RAD service-manager.
There is no need to adapt the configuration on SAP side. However, make sure the the port and context are correct. Default values are 8010 and /cs respectively.

System

The system can be set up with a different context path (base href). This way it can be used in, e.g., a portal environment.

yuuvis® RAD client

Full-text Search

The search dialog has been extended with an additional setting for full-text search. It is now possible to either search only in document files or in metadata. The default is as it was: search in document files and metadata.
To support this feature, the search API has been extended as well.

Inbox

If more than one filter term is used to reduce the list of tasks, the terms are combined with an AND operator. This means that both terms have to either be found in the title or the subject.

yuuvis® RAD agent

yuuvis® RAD agent can be used in an OAuth2 environment.

yuuvis® RAD repository-manager

Security issue: The password for the technical user who connects to the backend can be held encrypted in the configuration file.

Addendum

The potential security issue that was reported for the Postgres database under CVE-2022-21724 is fixed by updating the JDBC driver to version 42.3.3 for core-service and service manager (bpm-service / inbox-service) 7.16.17. 

Extraction

The extraction-service supports invoices in PDF format. This includes the XML file based on the ZUGFeRD version 2.1.1 format (similar to ZUGFeRD version 1.x).

Breaking Change

We have corrected a typo in the properties. Some properties contained the wrong spelling 'aggreement'. In the future, it will be correctly spelled as 'agreement'.

Action: If you have used a property of the old form for mapping, you need to adapt your mapping.

Infrastructure

Context Path

When installing the system, a customized context path can be defined which deviates from the standard, and under which the services will be available.

For example, the URL for the client can look like this: https://mydomain/myContextPath/app/client/

Authentication via OAuth2

The system supports OAuth2 as an authentication method. You need Keycloak as a proxy for LDAP-based Identity Providers that maintain the common user data. Nevertheless, the users of this LDAP system must be synchronized with yuuvis® RAD.

yuuvis® RAD agent, which connects the client with Windows applications, has been adapted as well to support OAuth2.

Sharing Objects

The endpoint that allows to share folders and objects has been adapted. Now you can define whether all children of a folder should be shared or not. The current default is to share all objects assigned to the folder. In specific circumstances, you may not want to share them all.

Upcoming Update of the Workflow Scripting Engine

Starting with version 8, our workflow engine will switch from the Nashorn Script engine to the newer GraalVM engine. The new engine brings full support for the ECMAScript2 specification.

Since the Nashorn engine pre-dates the ECMAScript21, we recommend to test existing worfklow models prior to upgrading to version 8, and if necessary, the syntax of scripts to be updated to the new standard. 
This is to be executed only in development/test systems as a preparation for migration to yuuvis® RAD 8, since GraalVM is not yet officially supported in yuuvis® RAD 7.16 LTS and should not be used in productive systems.

In order to test the new script engine, the core-service has to be started with the following parameter:

-Dcom.os.ecm.workflow.scriptEngineType=GraalVM

The Nashorn engine is used, regardless of the core-service having been started with the -Dcom.os.ecm.workflow.scriptEngineType=Nashorn or without it. 

Deprecated Methods in $.http in Workflow Scripts

Until version 7.16 LTS, $.http has been giving access to the singleton class HttpClient. On this singleton, an HTTP request could be configured and executed. As HttpClient is implemented as a singleton, all functions of this class are modifying the very same HTTP request. This semantic is error-prone because configurations of sequential HTTP requests could easily get mixed up unintendedly.
To improve this, the new HttpRequest class has been introduced. Instances of this class allow configuration and execution of HTTP requests. Multiple instances of HttpRequest can be created using functions like get() or post() of the HttpClient singleton.

• The following methods in the HttpClient class (accessible by the $.http object) are deprecated:
  
  • service()
  • path()
  • raw()
  • header()
  • param()
  • query()
  • body()
  • clear()
  • execute()
• Starting with version 7.16 LTS the HttpRequest class is introduced in workflow scripting.
  • Instances of HttpRequest can be created using these functions of the $.http object: get(), post, put, delete, patch.
  • Instances of HttpRequest offer the following methods that are deprecated on HttpClient, such as service(), path(), body(), etc.

Both approaches are supported in version 7.16 LTS 

• It is recommended to use the new class to configure and execute HTTP requests from version 7.16 LTS on
• Starting with version 8.0 and later, this will be the only supported approach

HttpClient example (prior to 7.16 LTS)

this.$.http.get();
this.$.http.path("/service/organization/role/{id}").param("id", roleId); //This configures the http singleton. These methods on $.http are deprecated for removal in 8.0
var response = this.$.http.query("orgobjects", true).execute(); // This executes the singleton HttpClass.

HttpRequest example (from 7.16 LTS onwards)

var getRequest =this.$.http.get(); //This creates a new request instance.
var response = getRequest.path("/service/organization/role/{id}").param("id", roleId).query("orgobjects", true).execute(); //Configuration is executed on the getRequest object, no longer on the $.http singleton
//The methods for request instance configuration can be safely used in 7.16 LTS and onwards.

Changes in the Response Format of BpmProcessService.getDataFields due to a Bugfix

Due to a bugfix (ERA-8384 - Model datafields of type List<ID> are returned in wrong format), the format of the response body of the BpmProcessService.getDataFields endpoint changed. 

Up to version 7.14, the service delivered the IDs in the wrong format (for instance "l_workflowFileIds.item: OsId[id=97DC54B56A844F9EBB198935476F15B5]"), so the response format has been corrected (for the same example, the response would be "l_workflowFileIds.item: 97DC54B56A844F9EBB198935476F15B5").

Custom microservices that use this endpoint need to adapt to this change before updating to version 7.16.