Update Scenarios for Windows-based Servers

Updating the Server in an Existing Installation Directory

To install a new version of the Acrolinx Server software, follow these steps:

  1. Check the major version numbers of the Acrolinx Server and the guidance package installers to ensure that they’re compatible.

    For example: Guidance package with the version number 2.x should not be used with server versions 3.x or later.

    In some circumstances, it’s possible to use a guidance package with an earlier version number than the server, but it’s recommended that you update to the same major version as the server. If you are unsure whether your current guidance package is compatible with your updated server, contact your Acrolinx project consultant.

  2. Make sure your database administrator has made native backups of your existing terminology database, your reporting, and Analytics databases. The update automatically migrates your data but it’s a good idea to keep regular backups in case you’ll need a fallback.
  3. Remove the guidance package files for the Acrolinx Server.
  4. Remove the old Acrolinx Server software.
  5. Install the new Acrolinx Server software version.
  6. Reinstall the guidance package files.
  7. Restart the servers.
  8. Check the log files for errors or warnings. 

Updating the Server to a New Directory

To move or copy an installation to a different computer or directory, follow these steps:

  1. Make sure your database administrator has made native backups of your existing terminology database, your reporting, and Analytics databases. The update automatically migrates your data but it’s a good idea to keep regular backups in case you’ll need a fallback.
  2. If you’re installing into a new directory on the same computer, stop all servers, make a backup of your current installation directory, and remove the Acrolinx Server software and guidance package .
  3. Install the Acrolinx server and guidance package in the new directory according to the first-time installation procedure.

    A new license is necessary when installing on a new computer.
  4. If you started the servers during the installation, stop all servers again.
  5. If you’re installing the server to a directory on a new computer, copy your configuration directory from the old computer to the new computer.
    On the new computer, ensure that the value of the environment variable ACROLINX_CONFIGURATION_ROOT matches the location where you copied the configuration directory.
  6. If you’ve disabled the configuration directory, but have made changes to files in your previous installation, add your changes to the new installation.

    The configuration directory is enabled by default when you install the Acrolinx Server and is unaffected by server updates. Unless you have explicitly disabled the configuration directory, you can proceed to the next step.

  7. If you have made changes to files in your previous installation that are not stored in the configuration directory, add your changes to the new installation.
  8. Check the log files for errors or warnings.

Updating Your Guidance Package - Happy Path

The Acrolinx linguistic team can provide updates to your guidance package in response to the changing requirements of your organization.

In most cases, updating your guidance package is simple. You uninstall the previous version, then install the new guidance package version. There are some situations that make it more complicated. You’ll need to manually back up and restore some files if you use a H2 database for your terminology, use Acrolinx Reuse, or if you’ve modified configuration files directly in your installation directory. Read the section Updating Your Guidance Package - Special Cases below for more details.

To update your guidance package in the majority of cases, follow these steps:

  1. Make sure your database administrator has made native backups of your existing terminology database, your reporting, and Analytics databases. The update automatically migrates your data but it’s a good idea to keep regular backups in case you’ll need a fallback.
  2. Stop all servers, and back up both your entire install directory and your configuration directory.
    The default location of your configuration directory is:
    C:\ProgramData\Acrolinx\ServerConfiguration\

    Again, this step is just a precaution and you hopefully won't need to use these backups. But skip it at your own risk!

  3. Remove the old guidance package like any other Windows program. For detailed steps, see the section below on removing guidance package files.

  4. Install the new guidance package by running the installer and following the on-screen instructions.
  5. Check the log files for errors or warnings.

Updating Your Guidance Package - Special Cases

If you use a H2 database for your terminology, use Acrolinx Reuse, or if you’ve modified configuration files directly in your installation directory, you’ll need to manually back up and restore some files in your installation directory.

  • You use a H2 database for your terminology.
    Back up and restore your terminology database. You can find it under <INSTALL_DIR>\db\terminology

    Using a H2 database for your terminology is not recommended or supported.

  • You’ve modified configuration files directly in your installation directory.
    Back up and restore the files that you’ve modified.

    Where possible, it's best to modify configuration files in the configuration directory to avoid this process.

  • You use Acrolinx Reuse.
    Back up and restore your reuse files. You can find them under <INSTALL_DIR>\data\reuse

Removing Guidance Package Files

Before installing a new version of the Acrolinx guidance package files, the existing guidance package files must first be removed.

Guidance packages can be installed and removed without affecting the Acrolinx Server installation.

To remove the guidance package files, follow these steps:

  1. Open the Change or Remove Programs panel of the Add or Remove Programs window.
  2. In the Control Panel, click the Change or Remove Programs button.
  3. Browse the list of installed programs and click the Acrolinx guidance package for (your company) entry.
  4. Click the Remove button, and then click the Yes button in the confirmation dialog box.
  5. If your guidance package contains a terminology database, choose whether to remove the terminology database.

    Important: Make a backup copy of your terminology database if you want to remove it.

    The Acrolinx guidance package is now removed from your computer.

Removing the Acrolinx Server

Before you install a new version of the Acrolinx Server, remove the existing server.
Before you remove the Acrolinx Server software:

  • Uninstall your guidance package.
  • Check the User Sessions screen to make sure that no client is connected to the Acrolinx Server.

To remove the Acrolinx Server, follow these steps:

  1. In the Windows control panel, open the Add or Remove Programs window.
  2. Browse the list of installed programs, select the Acrolinx Server entry, click Remove , and confirm that you want to remove the server.

    The Acrolinx Server is removed from your computer. However, the configuration directory for the Acrolinx Server is retained at the original location. If you’ve moved your configuration directory to another computer or don’t plan to reinstall Acrolinx on the current computer, you can also delete this directory.