Update Scenarios for Windows-based Servers

Updating the Core Platform in an Existing Installation Directory

Install to an existing installation directory if you’re updating the Core Platform only and want to simplify the installation process. Uninstall the previous Core Platform and guidance package, install the new Core Platform, and reinstall your current guidance package.

Any files that you’ve changed are retained in the installation directory after you’ve uninstalled the older version of the Core Platform. After you deployed your previous Core Platform, new files such as Acrolinx Scorecards and Dashboard settings were probably created in your installation directory. These files are also retained after you uninstall the Core Platform.

When you install the newer version, all of your changed files are moved to the backup directory: <INSTALL_DIR>\server\bin\backup-<TIMESTAMP>. Update the new installation files with any changes you’ve made to the previous versions of those files. New files that were created during normal usage, such as Acrolinx Scorecards and Dashboard settings, are retained in their original location.

To install a new version of the Acrolinx Core Platform in an exiting installation directory, follow these steps:

  1. Check the major and minor version numbers of the Core Platform and the guidance package installers to make sure they’re compatible.

    For example: A guidance package with the version number 2019.04.x should not be used with Core Platform versions 2019.05.x or later.

    If you're not sure whether your current guidance package is compatible with your updated Core Platform, 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 old Core Platform.
  4. Remove the old Core Platform.
  5. Install the new Core Platform.
  6. Reinstall the guidance package.
  7. Restart the servers.
  8. Check the log files for errors or warnings.

Updating the Core Platform to a New Directory

Install to a new installation directory if you’re updating both your guidance package and your Core Platform. You'll usually do this when you’re upgrading from a legacy version of Acrolinx to the latest version.

Uninstall the old Core Platform and guidance package, then install the Core Platform and new guidance package into the new directory. Copy all changed files and settings from your previous installation to a new installation directory. You might also copy any new files that were created during normal usage, such as Acrolinx Scorecards and Dashboard settings.

Install into a new installation directory to ensure that your installation contains the newest versions of all Acrolinx software files.

If you’re installing the Core Platform to a directory on a new computer, copy your configuration directory from the old computer to the new computer.

To update 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 Core Platform and guidance package.
  3. Install the new Core Platform version 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 Core Platform and is unaffected by updates. Unless you’ve explicitly disabled the configuration directory, you can go to the next step.

  7. If you have made changes to files in your previous installation that aren’t 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 Core Platform 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 Change or Remove Programs.
  3. Browse the list of installed programs and click the Acrolinx guidance package for (your company) entry.
  4. Click Remove, and then click Yes 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 Core Platform

Before you install a new version of the Core Platform:

  1. Remove your guidance package.
  2. Remove the existing Core Platform version.

To remove the Core Platform, 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 Core Platform entry, click Remove, and confirm that you want to remove the Core Platform.

    The Core Platform is removed from your computer. However, the configuration directory for the Core Platform 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.