General information:
DocuWare can be installed in so many variations and environments. Therefore, there are no set procedural instructions on how to do an upgrade. However, we have compiled some essential information before performing an upgrade in a DocuWare system.
DocuWare upgrades are not part of the standard support; therefore, if you want us (the DocuWare Support Department) to perform an upgrade for you, we will do this as a Professional Service task for a fee.
DocuWare can be installed in so many variations and environments. Therefore, there are no set procedural instructions on how to do an upgrade. However, we have compiled some essential information before performing an upgrade in a DocuWare system.
DocuWare upgrades are not part of the standard support; therefore, if you want us (the DocuWare Support Department) to perform an upgrade for you, we will do this as a Professional Service task for a fee.
Before commencing the upgrade process, please consider KBA-34774 to properly identify the upgrade path to the desired DocuWare version you wish to reach.
Recommended steps and notes regarding the upgrade of DocuWare:
- Download links for the desired DocuWare version can be obtained from DocuWare Support Portal-Updates. We suggest that you use a download manager to avoid interruptions during the download, e.g. http://www.freedownloadmanager.org/
- Once the file has been downloaded, ensure the zip file is not blocked. Refer to KBA-36834 for more on unblocking zip files.
- Once the contents of the zip file have been unblocked, please extract it to a folder on a local drive (not Desktop or My Documents).
- Download the DocuWare license for the proper version of DocuWare.
- Windows updates must be installed before DocuWare can be installed. The latest version of DocuWare is always tested with the latest Windows updates.
- Silverlight and .NET Framework have to be installed. Check the required versions in the system requirements.
- Check the WMI (Windows Management Instrumentation) service and make sure it is working. This service interacts with the Windows installer to provide environmental information about the machine.
Repair Windows Management Instrumentation (WMI) - Windows User Account Control (UAC) and DEP (Data Execution Prevention) might be disabled. Sometimes, they cause issues when installing DocuWare.
- Ensure Internet Information Services (IIS) is installed, and all necessary components are enabled. You'll find the required components in the system requirements.
- You will need the credentials (user-name/passwords) for three accounts to be able to upgrade the current system:
- Database (user/password):
You will need this account to access the database to take backups and some of the new services will ask for this information during the upgrade. - Windows Account (user/password):
You need this information to be able to install new DocuWare services. This account has to have local administrative rights. However, it could be a domain account or a local account. - DocuWare Account (user/password):
You need this account to upgrade the current system. Only DocuWare system and organization administrator users can modify the system.
- Database (user/password):
- From the DocuWare Administration Tool and the DocuWare Web Client, check the following items and ensure that they are accessible and valid. If you have an orphaned configuration, reconfigure it or delete it.
- Database connection. The user assigned to this database connection has to be the owner of the database in MSSQL. If you are using MySQL, then it should be fine.
- Check the Storage Location for images
- Check the External Directory connection
- Check the File Cabinets and Document Trays
- Check the select lists
- Check stamps
- Check File Connections
- If DocuWare is installed under MSSQL:
- Make sure that your transaction log file is not bigger than your database. If you have not done any database maintenance, then your transaction log file may be larger than your data file. You may have to run a shrink command first: How to shrink the transaction log
- If you are using an MSSQL database with replication or mirroring, please turn them off before upgrading DocuWare. They may prevent the required database update.
- Take a backup of all DocuWare databases. This would be all DocuWare databases that begin with the prefix DW.
- In MySQL you can use the MySQL Administration tool, select all DocuWare databases, and create a backup file
- In MSSQL, you can use SQL Server Management Studio, select individual databases, and create multiple backup files (for each database).
- In Oracle, ask the DBA to take a backup of the schema where DocuWare objects are located.
- Find the user that is connecting to the database under DWAuthenticationServer.exe.settings. It should be located under <Connection> tag towards the bottom of the file. This user has to be the owner of the DocuWare databases in MSSQL (if you are using MSSQL). In MySQL it should be fine but make sure it is accessible.
- Make sure the Windows user login in the machine has rights to install application/programs. In particular, when using Remote Desktop, be sure to attach to the console of the server: Start > Run > MSTSC /console
Running a remote desktop session as a normal user can be a serious point in software installation problems. - The DocuWare server may require a reboot. You or the customer has to be willing to restart the machine when DocuWare installation requests a restart.
- Ensure that the ports which are used by DocuWare are available. Some DocuWare ports can be changed during the installation. However, we recommend keeping the default ports see Ports used by DocuWare to identify which ports will be used by DocuWare.
- If you are running in a virtual machine environment, take a snapshot of the virtual machine before attempting to upgrade.
- Please Note! In a production environment you must also be sure to have sufficient backups of the Server Environment. If there are problems encountered that are so severe that the upgrade cannot proceed, you may need to restore back to the original system state prior to starting the upgrade. While this is simple enough in a virtual environment with a snapshot, it is a far more serious exercise with a physical machine. Consult with your IT department on the status of the bare-metal restore ability BEFORE starting the upgrade.
Troubleshooting Guide
- Setup log files are located in %temp% or %ALLUSERSRPROFILE%
- If DocuWare services are not starting, you can check the Windows Event Viewer under Application logs and see if there are errors (clues).
- If you are experiencing issues logging in after the upgrade, see KBA-36616
- To check the ports currently being used in that machine, use the command: NETSTAT –ANO > C:\TEMP\PORTS.TXT . This will generate a text file with a list of ports being used in that machine.
- Windows Firewall and antivirus may cause issues.
- If you are unable to access the select list after the upgrade, please see KBA-36418
- Some operating systems tend to place a “locked” attribute in the zip file where it copied or moved between machines, therefore, when you extract all files the “protected” or “locked” attribute is set on each file. Remove the locked or protected attribute from the zip file first before extracting (KBA-36834). If all fails, then you may have to install a clean copy of DocuWare and use the upgrader tool to upgrade the database manually. Please contact the DocuWare Support Department for advice before proceeding further.
- How to change/alter database port DocuWare system KBA-35694
KBA is applicable to On-premise Organizations ONLY.