Upgrade WebOffice 10.9 SP1 to 10.9 SP2
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 and also via Update Site.
|
CAUTION! •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 necessary in this case, since all components can be installed on a single machine (single server scenario) again. •WebOffice 10.9 SP2 is released with ArcGIS API for JavaScript 4.22. In this version, Internet Explorer 11 is no longer supported. •At least Windows .NET Framework 4.8 is required to install the WebOffice extensions. •WebOffice usermanagement requires .NET 4.6.2 (minimum requirement); however, VertiGIS recommends using .NET 4.8. See also Microsoft .NET Framework. •Since the major release of WebOffice 10.9 the default path for all relatively included pages changes. Therefore, changes in the configuration are necessary when upgrading. The base path has moved up one level, so ../ must be removed from any links. •If WebOffice and VertiGIS GeoOffice is installed, you must make sure that outdated GeoOffice modules are updated or, if no longer needed, uninstalled. Otherwise, problems may occur during operation with WebOffice: oWebOffice extensions 10.9 SP2 are compatible with the latest GeoOffice version (as of May 2022). oIf 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. |
When upgrading your existing WebOffice application to version 10.9 SP2, upgrades of the individual software components must be performed. VertiGIS recommends performing the upgrade steps in the following order:
1. Backup the following information
•Save the WebOffice usermanagement database using User Management Database: Export.
•Optional: Export your WebOffice author standalone application profiles from Settings.
•If you want to update Apache Tomcat, a backup of the entire Apache Tomcat folder is highly recommended!
•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.
|
See chapter Upgrade WebOffice author standalone. |
|
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.
|
See chapter Upgrade WebOffice extensions. |
|
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 Studio Printing Engine (optional, if installed)
If VertiGIS Studio Printing Engine is installed, uninstall it via Control Panel\Programs\Programs and Features.
|
More details about the upgrade in the Installation with Setup chapter, and general information about VertiGIS Studio Printing Engine in the chapter VertiGIS Printing (optional). |
5. Deinstallation of WebOffice FTS-Index
Uninstall WebOffice FTS-Index via Control Panel\Programs\Programs and Features.
|
See chapter Uninstall WebOffice FTS-Index. |
|
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. Update Servlet Engine (Reinstallation Java, Tomcat)
VertiGIS recommends an update of Java und Apache Tomcat to the most recent (and approved by VertiGIS) versions.
|
•WebOffice 10.9 SP2 is certified for Java OpenJDK 11.0.15, Apache Tomcat 9.0.62 and Apache Tomcat Connector 1.2.48. •If a new installation of Apache Tomcat is to be performed, a backup of the entire Apache Tomcat folder is strongly recommended. |
First uninstall the installed versions of Apache Tomcat and then OpenJDK11.
|
•To reinstall Java, follow the steps in the Java chapter. •For a new installation of Apache Tomcat, follow the steps in 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 redistributed to the Tomcat\conf directory. For this, refer to chapter Installation of the Apache Tomcat Connector. |
|
CAUTION! •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. Upgrade ArcGIS (optional)
|
CAUTION! •VertiGIS recommends 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. •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. |
|
•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 necessary in this case, since all components can be installed on a single machine (single server scenario) again. •When using the VertiGIS Studio Printing Engine 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! |
|
See chapter Upgrade ArcGIS. |
WebOffice 10.9 SP2 supports the following ArcGIS versions:
If ArcGIS is also updated from version lower than 10.6 to version 10.6 or higher during the WebOffice upgrade, then existing user-defined Esri print 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.
|
For detailed instructions, see chapter Migration of Layout Templates to ArcGIS Pro. For details on using Esri Print in WebOffice, see chapter Esri Print. |
8. Installation of WebOffice author standalone
Follow the steps in WebOffice Author Standalone Setup.
|
Alternatively a Quiet Installation of WebOffice author standalone. See chapter Quiet Installation. |
|
CAUTION! Since version WebOffice 10.8, the working directory of 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. Since version WebOffice 10.8, WebOffice author standalone is delivered as a 64-Bit application. It should be noted that the ArcMap connector, which is responsible for the connection to MXDs, is still delivered as a 32-bit application, since it is based on the 32-bit ArcObjects. When using an Oracle database, a 64bit Oracle client database driver is required. |
9. Installation of WebOffice extensions
Follow the steps in chapter Upgrade WebOffice extensions.
|
CAUTION! •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. |
|
WebOffice extensions 10.9 SP2 are compatible with the latest GeoOffice version (as of May 2022). |
|
Alternatively a Quiet Installation of the WebOffice extensions is also available. See chapter WebOffice Extensions Silent Installation. |
10. Installation of VertiGIS Studio Printing Engine (optional)
Follow the steps in VertiGIS Printing (optional).
|
•In addition to the already known WebOffice extensions printing functions, WebOffice offers a geoprocessing (Python) based printing named VertiGIS Studio Printing Engine. Therefore, this installation is an optional possibility. •When using the VertiGIS Studio Printing Engine 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! |
11. Installation of WebOffice FTS-Index (full text search)
WebOffice 10.9 SP2 uses the version 8.11.x of WebOffice FTS-Index.
Follow the steps in the chapter Installation of WebOffice FTS-Index or Installation of Solr Cloud in a Loadbalancing-Scenario.
|
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.
|
CAUTION! 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. |
|
WebOffice usermanagement requires .NET 4.6.2 (minimum requirement); however, VertiGIS recommends using .NET 4.8. |
13. Update of Server Object Extension (SOE) 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.9-DVD\Software\ArcGIS for Server Object Extension to upload.
|
CAUTION! 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
|
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.9-DVD\Software\WebOffice directories\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
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).
|
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.Copy the patch file (WO109_patch_yyyymmdd.exe) to the directory of your WebOffice application directory (e.g. C:\Tomcat\webapps\<WebOffice application>)
4.Execute the current patch as administrator (replace all existing files if necessary)
5.Delete the patch file (WO109_patch_yyyymmdd.exe)
6.Start Apache Tomcat (via Start/Programs/Administrative Tools/Services).
7.Start WebOffice author standalone and open the Application ConfigurationIt's possible that the application configuration may have to be saved once again.
8.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
|
•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. |
|
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.