This post addresses DocuWare administrators: Check the technical notes before your DocuWare Cloud is updated or before you manually update your locally installed DocuWare (on-premises).
All articles apply to both Docuware Cloud and on-premises. Exceptions are marked accordingly.
Modified system requirements
Read the system requirements and limitations before updating.
Switch to oAuth2 authentication
To further increase the security, DocuWare is switching with the update from version 7.10 to 7.11 the authentication for third-party applications from cookie authentication to the modern and secure oAuth2 authentication.
To ensure that your DocuWare system continues to operate as usual, note the following points:
The installed DocuWare Desktops Apps must be updated on all clients.
The DocuWare Mobile App must be updated on all mobile devices. (The DocuWare Mobile Classic App does not support oAuth2 and can therefore not be used with DocuWare version 7.11 anymore.)
Third-party applications must be adapted. More information on the DocuWare Product Blog
Obsolete methods in Platform Service
Breaking change
Because cookie-based authentication has been discontinued and replaced by the modern and secure OAuth 2, several previously used methods of cookie-based authentication and endpoints are no longer supported.
Make sure that your integrations with Platform Service do not use any of these methods anymore, as they will no longer work after the update.
Methods:
rel="loginCookie" href="/DocuWare/Platform/Home/Token"
rel="login" href="/DocuWare/Platform/Account/Logon"
rel="guestLogin" href="/DocuWare/Platform/Account/LogOnGuest"
rel="trustedLogin" href="/DocuWare/Platform/Account/TrustedLogOn"
rel="windowsLogin" href="/DocuWare/Platform/Account/LogonNTLM"
rel="tokenLogin" href="/DocuWare/Platform/Account/TokenLogOn"
rel="jwtLogin" href="/DocuWare/Platform/Account/JwtLogOn"
Endpoints
rel="changePassword" href="/DocuWare/Platform/Account/ChangePassword"
rel="resetPassword" href="/DocuWare/Platform/Account/ResetPassword"
In addition to that, the method 'GetFileName' from Platform.ServerClient NUGET package will return invalid values for names that contain non-ascii characters
Changes in Platform Service configuration files
For on-premises only
Breaking change
Check if your configuration files need to be adpated.
Web.config is no longer the main Platform configuration file. Most of the configurations are moved to the DocuWare.Platform.Web.dll.config - except for IIS configurations (system.webServer section) like RequestLimits, UrlCompression, HttpCompression, etc.
The DocuWare.Platform.Web.dll.config contains the ClientConfig (DocuWare.Platform.Model.Implementation config), Caching configuration, Imaging Toolkit settings, Waf Service settings and most of the appSettings
Changes in appSettings in DocuWare.Platform.Web.dll.config:
SessionCookieExpiration and UseDomainAuthCookie settings are removed as they are not needed anymore
UnauthorizedRequestDelay is moved to the new file appsettings.json (see below)
There is a new configuration file called appsettings.json, which now contains the following configurations:
WebClientSettings
CacheProfiles
LongRunning operations
MessageBus
UnauthorizedRequestDelay
Read a detailed documentation of the files appsettings.json and Platform app.config
Update Platform.ServerClient to version 13
Breaking change
To use your integrations with DocuWare Platform Service further, you need to update your Platform.ServerClient. The minimum required version is version 13, for optimal performance 13.37.1 is required.
New component: oAuth2 Application Registration
Applications that are integrated into DocuWare via the DocuWare API must now authenticate themselves using oAuth2. There is a new component within the DocuWare configuration for registering these applications.
Currently the registration of applications is optional, at a later date it will become mandatory.
This applies equally to DocuWare Cloud and On-Premises installations.
The new App Registration module is located in the DocuWare Configuration in the Integrations area. In the first step, select the type of application for which you want to create an app registration: Web Application, Single Page Application or Native Application. In the second step, you receive the endpoints for the integration and define values such as the validity of the tokens.
Workflow Designer: NULL values are assigned to all types of variables
NULL values are now assigned to all types of variables within the web service activity in a DocuWare workflow.
Previously, NULL values were not assigned to variables of types such as user, role, date, dateTime, numeric or decimal. Instead, an exception was thrown.
Review and adjust any existing checks that relied on the previous exception behavior to ensure workflows continue functioning correctly.
Password is changed via Identity Service
To change their password, the user switch in the Web Client to the Profile & Settings > Security tab as before. But the link Change Password now opens a page provided by the Identity Service in a new browser tab.
Refresh connection manually in Windows Explorer Client
Windows Explorer Client will not automatically react on adding a new DocuWare Desktop connection anymore. In order to synchronize the Windows Explorer Client with the selected DocuWare Desktop connection use the Restart / Refresh Settings option in the context menu of Windows Explorer Client.
Deletion policies: behaviour of impersonation user aligned
Editing a deletion policy using an impersonation user is now aligned with other automated job configurations in DocuWare like, for example, Autoindex:
Users without appropriate permissions will no longer be able to see file cabinets, which are assigned to the impersonation user.
In detail:
Users who access the configuration of a deletion policy using an impersonation user can now only change the settings of this configuration if they have permissions for the assigned file cabinet.
If they do have not this permission, the user can only execute the deletion policy. Editing the deletion job is only possible, if they select a file cabinet for which they have permissions.
In this case, the original filter conditions for the deletion policy would be reset and need to be defined again.
To save a deletion job configuration as an impersonated user, the user must have the permission for the selected file cabinet.
To save a configuration as an impersonated user, the current user need to enter the credentials of the impersonated user every time they press the Save button.
Minor changes:
Substitution rules and lists: They are now configured in DocuWare Configuration > User administration instead of in DocuWare Administration.
Workflow Server removed - For DocuWare on-premises only
Workflow Server is no longer installed by Server Setup or displayed in the DocuWare Service Control. When updating DocuWare to Version 7.11, the module and all obsolete components are removed.New guide for system backup - For DocuWare on-premises only
The backup menu in DocuWare Administration has been removed. Instead, follow the instructions provided in DocuWare Administration.New location for Document Tool: For DocuWare on-premises only
After the setup the Document Tool is located in the PowerTools folder.