Edit online

Upgrading

Every new version of Oxygen XML Web Author comes with a lot of new features, improvements, bug fixes, and security upgrades. Therefore, you should always use the latest version. However, you may want to perform some internal tests before allowing the users to use the new features. For example, you may want to disable some of the new features to keep the UI simple or to tweak some of the settings.

It is recommended that you make a separate deployment of the new version on a different VM, perform some acceptance tests, and then switch all of your users to the new deployment.

Before You Start

Important:
Oxygen XML Web Author configuration (options), custom plugins, and custom frameworks are stored in Web Author's Oxygen Data Directory. If you install a new version without migrating the content of the previous data directory, the configuration will be reset to defaults and your plugins/frameworks will not be available in the new installation.

Upgrade Procedure

To upgrade Oxygen XML Web Author, follow these steps:
  1. Deploy the new version of Oxygen XML Web Author on a separate virtual machine and connect it to your existing license server. The two deployments will work in parallel, both using the same license pool.
  2. Copy the relevant content from the old data directory into the new data directory so that your customizations are preserved:
    • Custom plugins from the user-plugins folder.
    • Custom frameworks from the user-frameworks folder.
      Note:
      Only custom frameworks and plugins should be copied. This should not be confused with the frameworks and plugins directories, which contain the built-in frameworks and plugins.
    • The options.xml file, which stores manually configured options.
    • The license.properties file, which contains the connection details for the licensing server.

      From details about the complete contents of the data directory, see: Oxygen Data Directory.

  3. It might be necessary to update your license key. If you receive an error message regarding the license key version, follow this procedure. Your existing Oxygen XML Web Author deployment will continue to work with a license for the newer version.
  4. Review the settings in the Administration Page and confirm that your deployment-specific configuration is correct.
  5. Switch all of the users to the new version. This can be achieved either by changing the DNS entry or configuring the Load Balancer to use the new deployment.