Upgrade WebOffice 10.9 R2 SP1 to 10.9 R3

This chapter describes a step-by-step guide and VertiGIS recommendations for upgrading to the latest version of WebOffice. The new release package is available in the Download Center.

 

icon_warning

ATTENTION!

Please note the compatibility between WebOffice 10.9 R3 and the basic software of Esri ArcGIS:

oArcGIS 2021 (ArcGIS Enterprise 10.9.1, ArcMap 10.8.2, ArcGIS Pro 2.9.x) is the last supported ArcGIS release of WebOffice.

oArcGIS 2022 (ArcGIS Enterprise 11.x, ArcGIS Pro 3.x) will be not be supported in future WebOffice versions not.

VertiGIS recommends the Esri product versions ArcGIS Desktop (ArcMap) 10.8.2 and ArcGIS Enterprise 10.9.1 as these are Long term releases from Esri Inc. Furthermore, it is recommended to use ArcGIS Pro 2.9.x.

For the installation of the WebOffice extensions and WebOffice usermanagement at least Windows .NET Framework 4.8 is required. See also Microsoft .NET Framework.

WebOffice 10.9 R3 supports the ArcGIS versions listed in Server-Side Requirements as well as the browser versions listed in Client-Side Requirements.

If WebOffice and VertiGIS GeoOffice is installed, you must make sure that outdated GeoOffice modules are updated or, if no longer needed, uninstalled. Otherwise you may experience problems when using WebOffice.
If after the upgrade you still have problems with the WebOffice extensions, it helps to uninstall the existing GeoOffice components on the machine, then reinstall the WebOffice extensions with the repair option and then restart the server.

icon_comment

WebOffice 10.9 R3 is released with ArcGIS Maps SDK for JavaScript 4.27 (before known as ArcGIS API for JavaScript 4.27).

The JDBC driver for MS SQL Server has been updated to version 11.2.0. Therefore it is important to add ;trustServerCertificate=true to the DB-Connection parameter (e.g. jdbc:sqlserver://hostsde;DatabaseName=MyDatabase;trustServerCertificate=true).

 

When upgrading your existing WebOffice application to version 10.9 R3, upgrades of the individual software components must be performed. VertiGIS recommends performing the upgrade steps in the following order:

1. Backup the following information

1.Save the WebOffice usermanagement database using User Management Database: Export.

2.Optional: Export configuration files and custom files from your WebOffice application.

icon_cross-reference

For further information see chapter Export Customized Files.

3.Optional: Export your WebOffice author standalone application profiles from Settings.

4.Optional: If multiple WebOffice FTS-Index Cores are used, they can be backed up before uninstalling from WebOffice FTS-Index and be used again after reinstallation.

icon_cross-reference

More details can be found in the chapter Set Up Multiple Cores in the WebOffice FTS-Index.

5.Optional: If you want to update Apache Tomcat, a backup of the entire Apache Tomcat folder is recommended.

6.Important: Save the existing WebOffice applications from C:\Tomcat\webapps\<WebOffice application> and copy them to a secure location.

2. Deinstallation of WebOffice author standalone

Uninstall WebOffice author standalone via Control Panel\Programs\Programs and Features.

icon_cross-reference

See chapter Upgrade WebOffice author standalone.

icon_comment

Since WebOffice 10.8 the working directory of the WebOffice author standalone has changed. In order to continue using existing profiles, they must be exported before uninstallation and imported again after reinstallation. If a staging mapping is saved for taking projects productive, the corresponding .json files must be transferred from %APPDATA%\Roaming\SynerGIS\WebOfficeAuthorStandalone\UIData\GoLiveStagging to %APPDATA%\Roaming\VertiGIS\WebOfficeAuthorStandalone\UIData\GoLiveStagging.

3. Deinstallation of WebOffice extensions

Uninstall WebOffice extensions via Control Panel\Programs\Programs and Features.

icon_cross-reference

See chapter Upgrade WebOffice extensions.

icon_comment

WebOffice extensions can also be uninstalled via Command Prompt or BAT files. See chapter WebOffice Extensions Silent Deinstallation.

All ArcGIS Desktop Applications have to be closed during this process.

4. Deinstallation of VertiGIS Printing

If VertiGIS Printing is installed, uninstall it via Control Panel\Programs\Programs and Features.

icon_cross-reference

More details about the upgrade in the Installation with Setup chapter, and general information about VertiGIS Printing in the chapter VertiGIS Printing.

5. Deinstallation of WebOffice FTS-Index

Uninstall WebOffice FTS-Index via Control Panel\Programs\Programs and Features.

icon_cross-reference

See chapter Uninstall WebOffice FTS-Index.

icon_comment

All FTS-subindices calculated so far will be removed and must be recalculated after installation of the new version of WebOffice FTS-Index in the WebOffice Administration Page (Full text search Tab).

6. Optional: Update servlet engine (reinstallation of Java and Tomcat)

VertiGIS recommends an update of Java und Apache Tomcat to the most recent (and approved by VertiGIS) versions.

icon_comment

WebOffice 10.9 R3 is certified for Java OpenJDK 11.0.23+9, Apache Tomcat 9.0.54 and Apache Tomcat Connector 1.2.49.

VertiGIS recommends the use of Java Eclipse Temurin by Adoptium.

If you want to update Apache Tomcat, a backup of the entire Apache Tomcat folder is highly recommended!

 

First uninstall the installed versions of Apache Tomcat and then Java JDK11.

icon_cross-reference

For a new installation of Java follow the steps in chapter Java.

For a new installation of Apache Tomcat follow the steps in the chapter Installing Apache Tomcat.

After a new installation of Apache Tomcat and simultaneous use of Apache Tomcat Connector the connector files may have to be moved to the directory Tomcat\conf. Please refer to the chapter Installation of the Apache Tomcat Connector.

icon_warning

ATTENTION!

After an update of Apache Tomcat and when using Apache Tomcat Connector, check if a read access for the local user IIS_IUSRS is set to folder \Tomcat\conf.

If you have imported one or more security certificates in the Java Truststore, you must import the security certificates into the Java Trust Store of the new Java directory after updating Java OpenJDK 11. This can be done using the Import SSL Certificates in SynAdmin function.

7. Optional: Upgrade ArcGIS

icon_warning

ATTENTION!

VertiGIS recommends the Esri product versions ArcGIS Desktop (ArcMap) 10.8.2 und ArcGIS Enterprise 10.9.1 (as these are Long term releases from Esri Inc. Furthermore, it is recommended to use ArcGIS Pro 2.9.x.

Please ensure BEFORE upgrading of ArcGIS Desktop (ArcMap and ArcGIS Pro) as well as ArcGIS Enterprise, that the WebOffice extensions and WebOffice author standalone have been uninstalled correctly. After that you can continue updating ArcGIS Desktop or ArcGIS Enterprise. If this step is forgotten and you encounter problems uninstalling the WebOffice author standalone, the chapter Problems Uninstalling Author Standalone can help.

icon_comment

With WebOffice 10.9 SP2 and ArcGIS Desktop 10.8.2 ArcGIS Enterprise 10.9.1 is fully supported again. The Special Installation Scenario is not applicable in this case, since all components can be installed again on a single machine (Single Server Scenario).

When using the VertiGIS Printing with ArcGIS 10.8.1 the installation of Patch ArcGIS Server 10.8.1 Print Service Patch and ArcGIS Server 10.8.1 Print Service and Text Element Patch is necessary!

icon_cross-reference

See chapter Upgrade ArcGIS.

 

WebOffice 10.9 R3 supports the following ArcGISversions:

Esri ArcGIS Enterprise

Esri ArcGIS Desktop

 

If ArcGIS is also updated from version lower than 10.6 to a version higher during the WebOffice upgrade, then existing user-defined VertiGIS Printing templates must be changed from ArcMap-based to ArcGIS Pro-based print templates (.pagx), i.e. open the MXD in ArcGIS Pro, and right-click Save as layout file.

icon_cross-reference

For detailed instructions, see chapter Migration of Layout Templates to ArcGIS Pro.

For details on using VertiGIS Printing in WebOffice, see chapter VertiGIS Printing.

8. Installation of WebOffice author standalone

Follow the steps in WebOffice Author Standalone Setup.

icon_warning

ATTENTION!

Please ensure BEFORE upgrading ArcGIS Desktop (ArcMap and ArcGIS Pro) as well as ArcGIS Enterprise to uninstall WebOffice extensions and WebOffice author standalone. After that you can continue updating ArcGIS Desktop or ArcGIS Enterprise.

If this step is forgotten and you encounter problems uninstalling the WebOffice author standalone, the chapter Problems Uninstalling Author Standalone can help.

icon_cross-reference

Alternatively a Quiet Installation of WebOffice author standalone. See chapter Quiet Installation.

9. Installation of WebOffice extensions

Follow the steps in chapter Upgrade WebOffice extensions.

icon_warning

ATTENTION!

If after the upgrade you still have problems with the WebOffice extensions, it helps to uninstall the existing GeoOffice components on the machine, then reinstall the WebOffice extensions with the repair option and then restart the server.

At least Windows .NET Framework 4.8 is required for installation.

icon_cross-reference

Alternatively a Quiet Installation of the WebOffice extensions is also available. See chapter WebOffice Extensions Silent Installation.

10. Installation of VertiGIS Printing (optional)

Follow the steps in VertiGIS Printing.

icon_warning

ATTENTION!

As of version WebOffice 10.9 R3 the name of the geoprocessing service changes for VertiGIS Printing:
Old: VertiGISPrinting_Tools
New: VertiGIS_Printing_Tools

This means that after upgrading from an older version to the latest version, in the WebOffice author standalone all project configurations, in the VertiGIS Printing tool is configured, the GP service URL has to be adjusted if necessary; for more details see Configure as Tool in WebOffice.

icon_comment

WebOffice additionally offers a Geoprocessing (Python) based printing with the name VertiGIS Printing in addition to the already known WebOffice extensions. Therefore, this installation is an optional option.

To use the VertiGIS Printing, at least ArcGIS 10.8.1 is required. VertiGIS recommends the Esri product versions ArcGIS Desktop (ArcMap) 10.8.2 and ArcGIS Enterprise 10.9.1 (as these are Long term releases from Esri Inc. Furthermore, it is recommended to use ArcGIS Pro 2.9.x.

Due to known technical limitations an error-free installation as well as use of VertiGIS Printing on ArcGIS 10.8.1 and older versions can no longer be guaranteed.

When using the VertiGIS Printing with ArcGIS 10.8.1 the installation of Patch ArcGIS Server 10.8.1 Print Service Patch and ArcGIS Server 10.8.1 Print Service and Text Element Patch is mandatory!

11. Installation of WebOffice FTS-Index (full text search)

WebOffice 10.9 R3 uses the version 9.3.0 of WebOffice FTS-Index.

Follow the steps in the chapter Installation of WebOffice FTS-Index or Installation of Solr Cloud in a Loadbalancing-Scenario.

icon_comment

If WebOffice FTS-Index (standalone) was already installed and Java was updated to a current version, the system variable JAVA_HOME must be adapted accordingly before installing WebOffice FTS-Index (the path to the installation directory of Java must be changed to the path of the current version). See the section Setting JAVA_HOME as a System Variable in the chapter Installation of WebOffice FTS-Index.

After successful installation, all FTS subindices of the search layers in the WebOffice Administration Page (Ful Text Search tab) must be recalculated.

12. Installation of WebOffice usermanagement Admin Web

Follow the steps in the chapter Upgrade UserManagement Admin Web.

icon_warning

ATTENTION!

For the Installation, the use of Windows .NET Framework 4.8 is needed. See also Microsoft .NET Framework.

Afterwards, an update of the User Management database is necessary in order to upgrade the data model to the current version. To do this, open UserManagement Admin Web and log in with your user; you will then be prompted to update the data model if it is no longer up-to-date.

13. Update of the Server Object Extension and the WebOffice system directory

Update the ArcGIS Server Object Extension for WebOffice as described:

1.In ArcGIS Server Manager under Site/Extensions choose VertiGIS Server Object Extension (SOE) to edit and select the new SOE file (syn_soe_ao_gateway.soe file) from WebOffice10.9R2-DVD\Software\ArcGIS for Server Object Extension to upload.

icon_warning

ATTENTION!

Don't use uninstall and install the extension, because else you have to set the properties for VertiGIS Server Object Extension again!

Update Server Object Extension (SOE) in ArcGIS Server Manager

Update Server Object Extension (SOE) in ArcGIS Server Manager

icon_comment

After replacing the SOE file, SynOutputService and any other services with activated Server Object Extension are stopped. These services must remain stopped, otherwise the next step can not be performed.

2.Replace the WebOffice files in C:\arcgisserver\directories\WebOfficeSystem with the files from WebOffice10.9R2-DVD\Software\WebOffice directories\WebOfficeSystem.
 

Replace WebOffice files in directory WebOfficeSystem

Replace WebOffice files in directory WebOfficeSystem

 

3.Start the map service SynOutputService (or all services, where Server Object Extension is activated). If you have activated the SOE file on other services as well, you will need to restart those services as well.
 

Restart SynOutputService in the ArcGIS Server Manager

Restart SynOutputService in the ArcGIS Server Manager

14. Update WebOffice application

Below you will find the necessary installation steps for manually installing your WebOffice application:

1.Stop the Apache Tomcat service (via Start/Programs/Administrative Tools/Services).

icon_cross-reference

For further information see chapter Apache Tomcat Maintainance.

2.Delete the working directory of Apache Tomcat at e.g. C:\Tomcat\work\Catalina\localhost\<WebOffice web-application>

3.Delete the existing WebOffice applications (don't forget a Backup!) from the directory C:\Tomcat\webapps\<WebOffice application>.

icon_comment

With a major release upgrade, the entire WebOffice application must be replaced.

4.Copy the zipped file of the new WebOffice 10.9 R3 application from WebOffice10.9R3-DVD\Software\WebOffice Web Application\unpackaged into the WebOffice application directory (e.g. C:\Tomcat\webapps\<WebOffice application>) and unpack it in the new WebOffice 10.9 R3 application at this point.

5.Copy the backed up application and project configurations of section 1 into the respective directory of your new WebOffice 10.9 R3 application.

icon_cross-reference

For further information see chapter Export Customized Files.

6.Start Apache Tomcat (via Start/Programs/Administrative Tools/Services).

7.Import the new WebOffice 10.9 R3 license.

icon_cross-reference

For further information see chapter Licensing WebOffice.

8.Start WebOffice author standalone and open the Application ConfigurationIt's possible that the application configuration may have to be saved once again.

9.Finally all project configurations should be validated in WebOffice author standalone using the functionality Check all Projects. If one or more projects are invalid the project configuration can be repaired using the Repair projects button.

"Verify all projects" function in WebOffice author standalone

"Verify all projects" function in WebOffice author standalone

 

icon_comment

It is recommended to clear the browser cache with Delete Browser Cache.

When using the JavaScript clients WebOffice core Client andWebOffice flex Client using a reverse proxy can cause problems in the map display if a forward slash / is set at the end of the ProxyPass and ProxyPassReverse lines in the code. In this case please remove the slash at the end of the lines. For more details see chapter Apache Reverse Proxy.

icon_cross-reference

If you have problems during or after the WebOffice update, please contact the WebOffice Support Team.

15. Checks after the upgrade

Check all WebOffice applications and projects with the checklist in this chapter: Checks after an Update.