When you update your Acrolinx Core Platform or guidance package to a newer version, it’s important that you plan the update thoroughly to ensure that all of your customizations are retained.
Before you start an update, you should discuss the best installation procedure with your Acrolinx project consultant. When updating an installation of Acrolinx that is hosted on a Windows computer, there are several possible installation procedures.
- Installing a new server to the existing installation directory.
You install to an existing installation directory if you’re updating the server only and want to simplify the installation process. You uninstall the previous server and guidance package, install the new server, 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 Acrolinx software. After you deployed your previous server, 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 server.
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 server usage, such as Acrolinx Scorecards and Dashboard settings, are retained in their original location.
- Installing new guidance package to the existing installation directory.
Before you update your guidance package, we recommend that you keep a back-up of the previous guidance package version. To update your guidance package, first uninstall the previous version, then install the new guidance package version.
- Installing the new server and guidance package to a new installation directory.
You install to a new installation directory if you’re updating both your guidance package and your server. You usually use this procedure when you’re upgrading from a legacy version of Acrolinx to the latest version.
You uninstall the old server and guidance package, then install the server and new guidance package into the new directory. You 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 server usage, such as Acrolinx Scorecards and Dashboard settings.
You 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 server to a directory on a new computer, copy your configuration directory from the old computer to the new computer.
Planning an Acrolinx Software Update
If you plan to update to a newer version of Acrolinx, your Acrolinx project consultant can help you ensure that all changes and customizations made to your current installation are retained after you update your Acrolinx software. There are several themes that you can discuss with your Acrolinx project consultant before you start your update.
If you plan to update your Acrolinx Server version and have made extensive changes to your guidance package, your Acrolinx project consultant can arrange to have any changed components added to an updated guidance package. If your latest changes are included in an updated guidance package, you don’t have to retain the individual files from your previous installation when performing the update.
Additionally, if you use the Reuse or Terminology Manager modules, you can discuss the best method for updating your terminology database and reuse repositories.
When you update the Acrolinx Server, the new server version might contain new features that are only available when they’re activated in your license. If your server update includes new features that you’ve purchased, contact your Acrolinx project consultant to ensure that the features are added to your license.
You'll need to request a new license from your project consultant if one or more of the following conditions apply, because the hardware ID of the computer will change:
- You plan to install your new server version on a new computer.
- You made changes to the hardware configuration of your computer.
- You upgrade your server software files from 32-bit to 64-bit.
Installation Update Checklist
The Acrolinx Server contains many components that you can edit and customize to the requirements of your organization. When configuring the server, most administrators create overlays of the required configuration files in the configuration directory. The configuration directory is unaffected when you install or uninstall Acrolinx software. If you use configuration overlays, most of your changes are automatically retained when you install a new version of the server. However, there are some important components in the standard installation directory that are also updated when users work with Acrolinx.
It's good practice to make backups of all your databases when you update, just in case you might need a fallback. Make a backup of your existing terminology database, and your reporting and analytics databases. The update automatically migrates your data and you won’t need to restore these backups.
Configuration Files and Components That Are Stored in the Installation Directory
The following tables show the configuration files and components that might have changed since you installed Acrolinx for the first time. Review the lists for files and components that you want to retain in your new server installation.
- If you’re installing the server in the same directory as your previous server, updated files and components should be automatically retained. However, it’s good practice to create backups of any files and components that you want to retain before you install the new server version.
- If you’re installing the server in a new installation directory, identify the files and components that you want to retain and copy them to the new installation directory.
TABLE 1. CONFIGURATION FILES IN THE INSTALLATION DIRECTORY
|Filter files for loading complex term sets|
|Reuse repository to writing guide assignments (configured in the Dashboard)|
|Terminology import transformation files|
|Checking score threshold configuration file|
TABLE 2. STANDARD ACROLINX COMPONENTS IN THE INSTALLATION DIRECTORY
|Reuse repository files|
|Sentence bank files for reuse|
|Findability database files|
|Reporting database files|
|Terminology database files|
You can also retain your terminology database by making a database backup in the Dashboard (for more information see the topic "Managing Database Backups" in the Acrolinx Terminology Manager User Guide )
|Guidance Wizard database files|
|Acrolinx Scorecard files|
|Term harvesting report files|
Configuration Files and Components That Are Stored in the Configuration Directory
The following table shows the configuration files and components that you can save in the server configuration directory. You can use this list as a reference if you’re unsure what files to save to the configuration directory.
- If you’re installing the new server on the same computer as the previous server, all files and components in the configuration directory are automatically retained for your new installation. No further action is necessary.
- If you’re installing the server on a new computer, copy the contents of the configuration directory to the configuration directory on the new computer.
- If you’ve disabled the configuration directory, review the list for files that might have changed and ensure that each file is retained at the equivalent location in the new server installation directory.
TABLE 3. FILES
|Integration user profiles and model user settings|
|Master language configuration file|
|Term help template files|
|"Add comment" template for the term contribution page|
|Template for the custom document information section of the custom information form|
|Main template for the term contribution page|
|Template for the term help page|
|Template for the custom user information section of the custom information form|
|Language configuration file|
|User spelling exception list file for the "Add as spelling exception" feature|
|Enabled guidelines (configured in the Dashboard)|
|Standard term sets (configured in the Dashboard)|
|Term Browser properties|
|License database file with license, user, and roles data|
|Analytics server properties file|
|Analytics server wrapper configuration file|
|Core server properties file|
|Core server wrapper configuration file|
JAAS configuration file for external user authentication
Logging configuration file
The format of this file might have been updated in your newer server version. To ensure that you receive the updates, copy your changes to the updated version of this file.
|Language server wrapper configuration file|
|Language server properties file|
|Persistence properties file that defines the connection to an external terminology or reporting database|
Remember: If the new update contains a database schema change, your database administrator should ensure that Acrolinx has the required privileges to update the database schema.
Customized guideline help HTML files
You can also arrange to have the guideline help files included in your guidance package.
|User-uploaded term images|
|Files that control the styling of Acrolinx, for example the Dashboard.|
As a rule, you can save all files in the configuration directory that have the extension