Install, Uninstall, or Update Acrolinx for Oxygen XML Web Author

What You Should Know Before Installing

Check our Compatibility Guide if you want to know whether Acrolinx for Oxygen XML Web Author works with your local platforms.

Before you install Acrolinx for Oxygen XML Web Author, make sure that you've installed the following:

ProductVersion
Acrolinx2018.12 or later (2019.10 for DITA reference support)
Oxygen XML Web Author20.0, 20.1.1, 21.0, 21.1

Install

First, make sure you've installed everything you need - see the section What You Should Know Before Installing above.

Also, check the admin guide for technical steps that you'll need to take to use Acrolinx for Oxygen XML Web Author. For example, enabling single sign-on, and configuring the connection to Acrolinx.


There are two ways to install Acrolinx for Oxygen XML Web Author. You can upload and install the Acrolinx installation package from the Oxygen XML Web Author administration page. You can also install Acrolinx for Oxygen XML Web Author using a hosted instance with the Oxygen SDK.

Install from Oxygen XML Web Author Administration Page

To upload and install the Acrolinx package from the Oxygen XML Web Author Administration Page, follow these steps:

  1. Open the Administration Page in Oxygen XML Web Author.
  2. On the Administration Page, navigate to Settings > Plugins, then click Upload plugin.
  3. In the dialog box that appears, select the Acrolinx for Oxygen XML Web Author installation package and click OK. Acrolinx for Oxygen XML Web Author should appear in the list on the Plugins page.
  4. Restart your Oxygen Web Application server, or restart your CMS.

Install Using a Hosted Instance with the Oxygen SDK

To install Acrolinx for Oxygen XML Web Author using a hosted instance with the Oxygen SDK, follow these steps:

If you've already set up the Oxygen SDK and Oxygen XML Web Author component, ignore steps 1, 2 and 3.

  1. Set up the Oxygen SDK.
  2. Set up Oxygen XML Web Author.
  3. Add connectors like WebDAV or Git if you need them.
  4. Navigate to bundle-plugins in the dropins directory and extract the Acrolinx installation package.
  5. Build your application as a Maven build. Go to Run As > Maven build... and in Goals enter the following:

    install -pl oxygen-sample-webapp –am

    Then, click Run. Acrolinx for Oxygen XML Web Author will be part of the generated Web Author archive.

    For more information on customizing the Oxygen XML Web Author and installing Oxygen plugins, take a look at the Oxygen documentation on Customizing the Oxygen XML Web Author.

  6. Deploy the Web Archive (WAR) on your web server.

Update

To update to a newer version of Acrolinx for Oxygen XML Web Author, you first need to uninstall the previous version. You can follow the standard Oxygen XML Web Author uninstall procedure.

Make sure that the uninstall instructions are for your version of Oxygen XML Web Author.

After you've uninstalled the old version, you can install the newer version as described above.

Uninstall

To uninstall Acrolinx for Oxygen XML Web Author, you can follow the standard Oxygen XML Web Author uninstall procedure.

Make sure that the uninstall instructions are for your version of Oxygen XML Web Author.