To install DocuWare as an on-premise system, you need the DocuWare software package in the form of the ZIP file and your license file, which you have received by email from DocuWare.
During installation, you have to select at least one of four roles for the server machine on which you are installing it. The role determines the tasks that the server machine should perform in the DocuWare system.
Frontend role: Providing services for clients and users, includes Web Client, Platform Services, and DocuWare Configuration.
Backend role: Providing services for background processing, e.g. workflows, processes, and email capture.
Full text role: Providing services for full-text processing.
Messaging service role: Providing services for server and application communication.
You also have to select a setup mode:
New installation: to install a completely new DocuWare system with a new database.
Extension: to install additional server machines for an existing DocuWare system with an existing database. For example:
- to extend the existing system to another machine.
- to restore the system after a machine failure (if there is a database)
- to update DocuWare while moving to a new serverUpdate: to update or reinstall the DocuWare components on the current server machine and to add one of the above roles to an existing server machine
Uninstall: to uninstall all DocuWare services and applications from the current server machine
Installation comprises several steps. Every step can be repeated if it fails. The setup is logged in detail. The corresponding log files can be found in the directory <%AllUsersProfile%\DocuWare\SetupLogs>.
DocuWare services run under Windows Users. To be able to specify the Windows User(s) as part of the DocuWare setup, you should first create them.
Information about individual setup options can be obtained directly from within the dialog via the info icons.
Information on DocuWare version 7.13
Find a complete list of all the new features of DocuWare version 7.13 in the DocuWare Knowledge Center iin the What's new in DocuWare version 7.13 section.
Before upgrading to version 7.13, please check the extent to which the changes with DocuWare version 7.13 are relevant to your system.
For the update to DocuWare version 7.13 you need at least DocuWare version 7.8.
If you do not have it, please follow this update path:
Versions 6.6 - 6.11 > Update to 6.12 > Update to 7.1 > Update to 7.4 > Update to 7.9 > Update to 7.13
Please also check the system requirements.
To implement the update, please contact your authorized DocuWare partner. This is especially recommended if you are not updating directly from the previous version.
Check your DocuWare Platform configurations
Most of the configurations of the DocuWare Platform are moved from the file Web.config to the DocuWare.Platform.Web.dll.config
For more information, see also the Technical Release Notes for version 7.11.
For details on the configuration files, see the setup help for DocuWare verison 7.11.
Windows User for DocuWare Server
DocuWare servers must be able to log in to the Windows system. For this, they require a Windows User with local administrator rights. During setup, you must specify a corresponding Windows User; either choose an existing one or create a new one. We recommend using a special Windows User exclusively for DocuWare services.
Ports used
DocuWare uses the following ports by default:
Authentication Server: 9000
Full-text server: 9012
Transformation Service: 5050
Server Messaging Service: 6379
If no other programs on the server machines used communicate via the preselected ports, no change is necessary.
DocuWare Server Messaging
In DocuWare 7.13 server-to-server messaging is changed to an approach based on the Redis protocol (RESP). This is called DocuWare Server Messaging. It replaces the MSMQ-based communication used so far as this technology is no longer supported by Microsoft.
The change effectively is twofold:
The DocuWare components participating in DocuWare Server Messaging are the RESP-protocol clients. They require a connection string to access the RESP-based Messaging service. You will be asked for this connection string during installation.
Communication is backed by a service providing the server-side implementation of the RESP-protocol. For this you have two options:
Install DocuWare’s Server Messaging role on one machine. The messaging component installed by this role is based on Microsoft’s implementation of the Redis-protocol called Garnet. The implementation only supports a single instance of the service.
If you want to overcome this limitation, for example if you want to provide a failsafe setup, go with the next option.Provide your own Redis-cluster or just use your existing one. Prepare the connection string to that system to provide it when asked by DocuWare Setup.
The connection string should have this format: “{host}:{port},password={your password},ssl={true|false},sslProtocols={protocol}”.
You can add more {key}={value} pairs separated by commas.
Password, ssl, sslProtocol are optional, but recommended to be used.
An example connection string may look like this: “localhost:6379,password=xxxx,ssl=True,sslProtocols=Tls12”.
Installing DocuWare Server Messaging
During setup, the new role Server Messaging can be selected during install, update, extend and modify or re-install.
During an upgrade, you must explicitly select the role Server Messaging Service for installation. The installer updates only roles that already exist. It will not add new roles to the system unless you choose them manually.
.png)
When you install the role on a machine, the server is first configured with its TCP port. The default port is 6379).
.png)
The second part of the configuration involves setting the password and generating the corresponding connection string. All machines that host DocuWare server roles need this connection string; you can copy it from the second configuration page:
.png)
Pausing setup for the installation of Server Messaging Service
If the Server Messaging service is not installed locally, the update wizard will prompt you to enter the connection string.
.png)
When the update wizard reaches the “Connection String” page, you can leave the wizard open (effectively “pausing” it) and start DocuWare Setup on another machine—or on the same machine in Modify/Extend mode—to install the Server Messaging role. After Server Messaging is installed, copy the generated connection string back into the first wizard and continue the installation.
Important: The setup will not proceed until you supply a valid connection string, because it must verify a live connection to the Server Messaging instance.
This workflow is the same for both upgrades and fresh installations. During a new installation, the first role you install is typically Frontend Services. As soon as the connection string is available, run DocuWare Setup on an additional machine, extend it with the Server Messaging role, and then enter the connection string in the original wizard.
Where the string is stored: The connection string is written in plain text to %AllUsersProfile%\DocuWare\ServerConfig\dwmachine.config
Note: Because the string contains an equals sign (=), it cannot currently be written to dwmachine.config with DocuWare.Setup.Server.Cmd.exe. This limitation may be removed in a future release.
The password used in the Server Messaging connection string must contain only ASCII characters.
Upgrade Simulation
DocuWare setup offers an upgrade simulation for the system database (DWSYSTEM):
It is checked whether the database of your existing DocuWare system can be updated. The productive DocuWare system will not be changed.
We recommend running the simulation to avoid problems during setup and system downtime. If the simulation is successful, you may go with the system upgrade. If errors are thrown, you should cancel the setup and contact your DocuWare sales partner or DocuWare Support.
Notes:
Discontinuation of Oracle as a supported database: With DocuWare 7.10 Oracle as a database is not supported anymore. If the DocuWare Server Setup detects an Oracle database server, the update is aborted with an error message. DocuWare will offer a migration from an Oracle to a Microsoft SQL Server database.
MySQL databases earlier than version 8.0 are no longer supported. The DocuWare 7.13 setup will stop if it detects a MySQL database prior to version 8.0 and will not continue until the database is upgraded.
If you are using a MySQL database server and run the update by remote, none of the upgrade simulation options are available.
Wildcards in IIS configuration not supported: Internet Information Server 10 (IIS 10) allows the use of wildcards in the host name binding of the website configuration. Such wildcards are not supported by DocuWare. To ensure that wildcards are not used, the DocuWare Server Setup prevents the user from selecting the websites configured with wildcards during any installation and displays an error message.
As of DocuWare Version 7.8, Dell EMC Centera and Dell EMC ECS systems are no longer supported as storage media. If such a storage location is found during an upgrade, the setup is aborted and a corresponding error message is displayed. A simulation can be run despite the error message.
Customer Experience Improvement Program
Using the Customer Experience Improvement Program (CEIP), DocuWare would like to gain more information about use of DocuWare software for further improving user-friendliness and customer experience, from which you can then also benefit.
When setting up/upgrading, the "Customer Experience Improvement" component is installed. This creates an additional database table called DWAnalytics in the database used for your DocuWare system in which the statistical information is stored. You can also see the information in the database table using the normal database tools.
Even if you do not take part in CEIP, the "Customer Experience Improvement" component is installed, the database created, and the corresponding information written there. However, the data are then not transferred to DocuWare.
More information about CEIP, e.g. what kind of data is collected?