Connect to an External Reporting Database

To use an external reporting database, confirm that your database format is supported, create a new database and database user for Acrolinx, and configure the persistence properties file in your Acrolinx Core Platform installation. You can also use database backups to migrate any existing data to the new database format.

Supported Database Formats

For an up-to-date list of supported database formats, see the "Database" section of the Core Platform compatibility guide.

As of Core Platform 5.5 we no longer ship the DB2 driver.

Preparing Existing Data for Migration to an External Reporting Database

If you have used the default H2 database to store your reporting data, you can migrate this data to an external reporting database. You migrate the data by creating a database backup before you switch to the external reporting database. Once the external reporting database is ready, you can restore the backup you created.

To prepare your existing data for migration to an external reporting database, follow these steps:

  1. Navigate to Analytics Administration Backup and Restore.
  2. Click Create New Backup.

    When the backup process completes, the new backup is displayed in the Available Backups table.

    The backup file is saved on the server computer at the following location:

    <INSTALL_DIR>\server\www\output\reporting\backup

    If you prefer to store your backup somewhere other than the server computer, click Download in the Actions column.

    To cancel the backup task, click the Cancel button next to the progress bar.

Preparing the External Reporting Database

To prepare an external reporting database for Acrolinx, follow these steps:

  1. Create a new empty database on your database server with the name of your choice.
    • We recommend selecting UTF-8 encoding for the database as this encoding type guarantees the ability to store terms in any language.
    • If you use a Microsoft SQL Server database, you must select a case-sensitive collation such as "SQL_Latin1_General_CP1_CS_AS" for the database. The default case-insensitive collation can cause problems with Acrolinx.
    • If you use a MySQL database, you must select a case-insensitive UTF-8 collation for the database. Case-sensitive collations can cause problems with Acrolinx.
  2. Configure a user name and password which has full write permissions on your new database.
    • If you use an Oracle database to store reporting and terminology data, ensure that the user name for the reporting database is different to the user name for the terminology database. In Oracle databases, user names are associated with a specific database schema

Editing the Database Configuration Properties

You can configure a connection to an external reporting database by creating an overlay of the installed persistence properties file. You update the persistence properties overlay with the connection details for your database and restart Acrolinx.

To configure Acrolinx to connect to your external reporting database, follow these steps:

  1. Stop the core server.
  2. Open your overlay of the following file: persistence.properties

    If you have not yet created an overlay of this file, create a new version of the file at the following location:

    %ACROLINX_CONFIGURATION_ROOT%\server\bin\ $ACROLINX_CONFIGURATION_ROOT/server/bin/

    Do not edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory.

  3. Add the following properties:

    reporting.dbType=<DATABASE_TYPE_SHORTNAME>
    reporting.jdbcUser=<DATABASE_USERNAME>
    reporting.jdbcPassword=<DATABASE_PASSWORD> 
    reporting.jdbcUrl=<DATABASE_URL>

    Replace the placeholder values with the connection details for your database:

    • Replace the placeholder <DATABASE_TYPE_SHORTNAME> with one of the following values:

      DERBY ORACLE MSSQL POSTGRES DB2

    • Replace the placeholder <DATABASE_USERNAME> with the user name that you defined in the procedure 'Preparing a Database'.
    • Replace the placeholder <DATABASE_PASSWORD> with the password that you defined in the procedure 'Preparing a Database'.
    • Replace the placeholder <DATABASE_URL> with the location of your database.

      The syntax of the jdbcUrl parameter can vary depending on the database format. To help you understand the syntax, sample values for the jdbcUrl parameter have been provided in the installed persistence properties file. The jdbcUrl parameter usually requires the IP address, the port, and the name of the database.

    If you want to connect to a database on a Microsoft SQL Server, change your properties to look something like the example properties below. Be sure to adjust the user, password, and jdbcUrl values, which are specific to your environment: 

    reporting.dbType=MSSQL
    
    reporting.jdbcUser=admin
    
    reporting.jdbcPassword=jama7UrU
    
    reporting.jdbcUrl=jdbc:jtds:sqlserver://101.101.101.101:1433/REPORTS
  4. Save your changes and restart the core server.
  5. Check the core server log file for any errors or warnings.

Restoring Existing Data to the External Reporting Database

You migrate your existing data by restoring a database backup you created from the previous database format.

To migrate existing data to the external reporting database, follow these steps:

  1. Navigate to Analytics Administration Backup and Restore.
  2. Locate the backup in the Available Backups section, and in the Actions column, click Restore.

    To restore a backup that is stored on your computer or at a network location, upload the backup file to your server first.

  3. In the security dialog that appears, enter the word yes and click OK.

    This type of dialog is an extra precaution to prevent you from overwriting your reporting database unintentionally. When you restore a database backup, all reporting data is overwritten with the data from the backup.