Update Information

enaio® 12.0

As usual, all components must be updated simultaneously – server, clients, services, and microservices.

Both functional and security-related errors may occur when accessing data if some components have not been updated.

Create regular backups of all components involved, especially prior to updates.

The installation data can be obtained via the Service Portal. There, you can also request test licenses.

Clauses for Access Rights – Old Syntax

The old clause format was discontinued with version 11.10. If an enaio® system still contains clauses in the old clause format, it cannot be updated to version 12.0. The server update is aborted, with a corresponding message being shown.

Kerberos/NTLM

With NTLM being discontinued by Microsoft and NTLM for enaio® version 13 also being discontinued, we recommend switching to Kerberos.

It is not yet necessary to make the switch with regard to enaio®; NTLM authentication is still possible.

As a central new feature for the switchover, the user name in the user administration has been supplemented by the login name, which can therefore be added as the user principal name for existing users.

Kerberos authentication can already be configured in enaio® enterprise-manager and enaio® gateway.

In the asinit.cfg configuration file, which defines the connection to enaio® server in the installations of enaio® client and the administrative components, the fully qualified domain name (FQDN) of enaio® server including port needs to be specified.

A switch must be made across all components.

Licenses

The introduction of the new universal client license (CLU) has resulted in changes to the licensing system.

It is possible to update to version 12.0 without a new license file.

New licenses are typically created with the new universal client license.

Licenses from version 11.10 or earlier versions may not be imported into enaio® version 12.0.

enaio® service-manager

Updating

Updating from a version lower than 9.10 is not possible with the enaio® service-manager setup for version 12.0. To update enaio® service-manager, version 9.10 must be installed at minimum. Otherwise, a setup dialog will inform the user that the update cannot be carried out and the setup is automatically aborted once the dialog is confirmed.

JDK 21

enaio® service-manager is delivered with JDK version 21.

Customer- and project-specific services based on JDK 17 may need to be adapted.

Spring Boot 3.5

The frameworks of enaio® service-manager services have been upgraded to Spring Boot 3.5. Project-specific services may need to be adapted.

The configuration file for the 'gateway-ng' service must be adapted.

Certificates

Certificates that are integrated in enaio® service-manager must be re-integrated after the update.

Configuration Files

Microservice configuration files are no longer merged during updates.

If configuration files contain new parameters, these are saved in a backup<timestamp> directory and assigned the dist extension. Changes must be made manually if necessary. Any necessary changes are documented in the service portal for the components and in these Technical Release Notes.

Configuration Files – Git

If configuration files are managed via Git, an additional start parameter for enaio® service-manager must be added:

--spring.cloud.config.server.git.basedir=file:<path_dir>

The parameter specifies a directory in which the Git repository is cloned locally.

Microservices

'gateway-ng' Microservice

The following changes were already necessary with service release 1.4 for version 11.10.

Connection Data

The connection data for enaio® appconnector, enaio® documentviewer, and enaio® rendition, which had to be entered for the configuration, must be deleted from the gateway-ng-prod.yml configuration file. All pre-entered routes must also be deleted.

The microservice automatically receives connection data via enaio® server.

Spring Boot 3.5

The following extension in the gateway-ng-prod.yml configuration file is necessary because of the update to Spring Boot 3.5:

version 11.10

spring:
  cloud:
    gateway:
      routes: 
                                                                            

version 12.0

spring:
  cloud:
    gateway:
      server:
        webflux:
          routes:
                                                                            

Blacklist

If project-specific routes have been specified in the gateway-ng-prod.yml configuration file, then 'blacklist' entries must also be created for these services.

Example:

endpoints:
  blacklist: 'service1,service2'
                                                            

'colab' Microservice

The 'colab' microservice is now installed and updated via enaio® service-manager. coLab dashlet has been integrated into the microservice since the last service releases. In previous versions, the coLab dashlet was integrated into the 'restdashlet' microservice. If this has not already been done, it may be necessary to make changes to the dashlet configuration.

Further changes are necessary for enaio® coLab.

'restdashlet' Microservice

The 'restdashlet' microservice is no longer used and is automatically uninstalled as part of the update process.

The enaio® kairos dashlet was integrated via the microservice. The dashlet is now integrated via the 'ai-connector' microservice.

For the enaio® kairos dashlet, the dashlet configurations in enaio® enterprise-manager and the dashlet.json file must be adapted, if this has not already been done for previous service releases.

'office365-dashlet' Microservice

The 'office365-dashlet' microservice is no longer used and is automatically uninstalled as part of the update process.

The dashlet is now integrated into the 'office365-client' microservice. The dashlet configuration for enaio® client in enaio® enterprise-manager must be adapted. Changes for enaio® webclient are not necessary.

'users' Microservice

The 'users' microservice is no longer used and is automatically uninstalled as part of the update process.

Changes are only necessary if project-specific endpoints of the 'users' microservice have been used. Connections via enaio® gateway are automatically forwarded.

Functions of the 'users' microservice are performed by the new 'system' microservice, which must be reinstalled.

'data-transfer' Microservice

The microservice has integrated enaio® data-transfer-ng (beta). enaio® data-transfer-ng (beta) has been discontinued. The microservice is automatically uninstalled.

Templates that have been integrated for purposes of data transfer with enaio® data-transfer-ng (beta) can no longer be used and must be deleted.

'dms' Microservice – Routing

To improve security, only one route to the 'dms' service is supported: /api/dms.

If a different route was previously used for a specific project, the route must be adapted.

enaio® services-admin

enaio® services-admin is accessed via a modified address:

<service-manager-IP>:<Port>/sma

enaio® service-manager default port: 7273

enaio® web-admin-shell

It is also possible to access enaio® services-admin via the new enaio® web-admin-shell.

Address: <gateway-IP>/admin or <gateway-ng-IP>/admin

enaio® web-admin-shell will become the main home screen for web-based administrations in enaio®.

Currently, the new enaio® administrator-for-workflow (web) can be called from the enaio® web-admin-shell in addition to enaio® services-admin.

enaio® webclient

Updating enaio® webclient

To update version 10.0 or previous versions, follow the instructions from the TRNs of version 10.10. The 'osweb' service can be installed directly in the version for 12.0.

You can update version 10.10, version 11.0, and version 11.10 without having to make any changes.

Discontinuation of the MSI package for the installation of enaio® webclient as a desktop application

The MSI package for installing enaio® webclient as a desktop application was already discontinued with the previous version.

With version 11.10, only the NSIS installer enaio-webclient-app.exe is available for installation.

Profile allocation is also possible for user-specific installations with the NSIS installer.

Authentication via OpenResty/Keycloak

The previous connection of Keycloak as an identity provider via OpenResty for authentication using OpenID Connect/OAuth2 is no longer supported since version 11.10 and has been replaced by the 'gateway-ng' service.

Limiting Hit Lists

Since service release 11.10.15 for enaio® webclient, a distinction has been made between index data queries and full-text queries when limiting the hit list. A new parameter for full-text queries has been introduced for this purpose. The parameter is not added automatically as part of the update process; if it has not already been added, this must be done manually in the osweb-prod.yml configuration file.

enaio® coLab

enaio® coLab-Project-Room-Creator

enaio® coLab-Project-Room-Creator has been discontinued. This means that the option to create colab project rooms in enaio® client and in enaio® webclient by calling up enaio® coLab-Project-Room-Creator is no longer available.

However, project rooms can still be created using the colab dashlet.

Integrations of enaio® coLab-Project-Room-Creator in enaio® client and in enaio® webclient must be removed.

No coLab project spaces can be created in enaio® mobile 12.0, as enaio® mobile does not support dashlets.

enaio® coLab-Project-Room-Creator has been discontinued since the last service release of enaio® coLab.

'colab' Microservice

Automatic Actions/Maximum Number of Hits

The following automatic actions are no longer limited by the setting 'Maximum number of hits'; default: 50000.

Delete objects: axacdel.dll
Professional storage management: axacaret.dll
Empty recycle bin: axaccleantrash.dll
History maintenance: axachist.dll

Configurations of these automatic actions should be checked with regard to runtime and system load.

enaio® Outlook Add-In NG

A standard converter was used in previous versions in enaio® Outlook Add-In NG. With the latest service releases and with version 12.0, the Outlook converter is used to boost performance. This converter is activated via the following registry entry:

HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\OPTIMAL SYSTEMS\enaio\enaio Outlook Add-In NG > SaveAsConverter > 1030

This change has an impact on the syntax of transferred e-mail addresses and thus potentially on the sorting in hit lists.

Example:

Standard converter: First name Last name <firstname.lastname@domain.com>

Outlook converter: "First name Last name" <firstname.lastname@domain.com>

The MSI installation parameter SaveAsConverter=1031 can be used to keep the standard converter activated or to re-activate it.

Cache mode can also be enabled in Microsoft Outlook to improve performance.

enaio® capture-pro

enaio® capture-pro-sod has been discontinued.

Install enaio® capture-transfer-module on the computer of the enaio® capture-pro installation.

The MSI for installation can be found in the installation data under the \Frontend\Capture-Transfer-Module directory.

This is where you will also find the ZIP archive capture-transfer-plugin.zip. Unzip the archive to the \Plugins\KCBOFAPI directory of the enaio® capture-proinstallation.

In enaio® capture-pro, the enaio® capture-transfer-plugin is selected as the target via the job setup and configured via Setup.

When specifying the export target for further processing of the data, choose between enaio® kairos, enaio® classify, and mailbox distribution: CSV or TR-Resiscan.

enaio® capture-iis

For enaio® capture-iis, also install enaio® capture-transfer-module as well as the enaio® capture-transfer-service.

The enaio® capture-transfer-service is installed via the capture-transfer-service.msi MSI located in the \Frontend\Capture-Transfer-Module directory.

The Windows service is used to monitor folders for further processing of data in enaio® kairos or enaio® classify.

Configuration is carried out via enaio® capture-transfer-module.

Elasticsearch

Elasticsearch is updated to version 8.19 using the elasticsearch_setup.exe setup.

Elasticsearch version 7.17.8 of enaio® version 11.0 is required for the update.
Update to this version first if it is not already installed.

Create a backup of the previous Elasticsearch installation before installing it. To create a backup, the Elasticsearch service must be stopped or read-only mode must be enabled.

The following steps are necessary to carry out the update:

Stop the Elasticsearch service.
Run setup and select update mode.
Specify a new directory that is outside the previous Elasticsearch installation as the installation directory.
Enter the index directory of the previous Elasticsearch installation as the index directory.
Modify the service configuration to match the previous Elasticsearch installation via elasticsearch-8-service-x64w.exe.

The user and password are imported automatically. No changes have to be made to the application-es.yml configuration file located in the \services\service-manager\config directory.

Index directory data is modified when the update is performed and is therefore no longer compatible with Elasticsearch 7.

Elasticsearch multitenancy solutions

We offer Elasticsearch multitenancy solutions to our partners who host multiple separate enaio® installations. Please contact OPTIMAL SYSTEMS for further information.

ABBYY FineReader

The Finereader setup 12.5.15.7 must be run twice. The first time ABBYY Finereader is uninstalled, while the second time ABBYY Finereader is reinstalled with modified registry entries.

If these actions have already been carried out for service release 20.2.0 of the 'ocr' service, it is not necessary to repeat this step.

Standard Ad-hoc Workflow and Taskflow

The osdefaultmodels.xml workflow model with the default ad-hoc workflow and taskflow has been updated and must be re-imported into enaio® editor-for-workflow.

enaio® repository-manager Client Components

The enaio® repository-manager client components have been discontinued. Replacements for version 12.0 must be implemented on a project-specific basis. Get in touch with your customer representative at OPTIMAL SYSTEMS.

System Role for Running Server Scripts

A new system role has been introduced for running server scripts: Server: Run script (ID 109).

This system role is automatically assigned to all users with the 'DMS: Supervisor' system role. This system role was previously required for running server scripts.

The evaluation of the system role for running server scripts and the 'Server: Run Ado jobs' system role were disabled by default in previous versions via the registry entry: Security\SecureJobs=0. The entry is not modified when updates are performed.

For security reasons, the evaluation of these system roles must be checked and activated: Security\SecureJobs=1. This may only be disabled in the project upon prior consultation.

This registry entry manages the evaluation of these system roles as well as the execution of other security-related administrative jobs.

Rights System: Moving Documents

Starting from version 12.0, the 'Write index data (W)' right is required on the source documents to move documents to another filing location in the cabinet.

Previously, documents could only be moved if the user had the 'Show index data (R)' right.

LDAP

The configuration of the LDAP version from the server properties in enaio® enterprise-manager has been removed. Only LDAP v3 is supported, as LDAP v2 is no longer officially available.

To ensure backward compatibility, however, the registry setting is still available as is integration in enaio® administratorand enaio® server for LDAP v2.