To use an external analytics database, confirm that we support your database format. The analytics database needs three connections for its JReport internal databases. These databases are called 'system', 'realm' and 'profiling', and in the persistence properties file you'll find them as 'sys', 'realm' and 'prof' respectively. Create three new databases and a database user for Acrolinx, and configure the persistence properties file in your Acrolinx Server 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" tab of the Acrolinx compatibility guide .
Preparing Existing Data for Migration to an External Analytics Database
If you have used the default Derby database to store your analytics data, you can migrate this data to an external analytics database. You migrate the data by creating a database backup before you switch to the external analytics database. Once the external analytics database is ready, you can restore the backup you created.
To prepare your existing data for migration to an external analytics database, follow these steps:
- Click Create New Backup .
When the backup process completes, the new backup is displayed in the Available Backups table.
We save the backup file on the server computer at the following location:
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.
To prepare the three external analytics databases for the Acrolinx Server, follow these steps:
- Create three new empty databases on your database server with names of your choice, for example, analytics-realm, analytics-sys and analytics-prof.
- 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 "latin1_general_ci" collation for the database.
- If you use a DB2 database, you must have a page size of at least 8k.
- Configure a user name and password that has full write permissions on your new databases.
- If you use an Oracle database to store analytics, reporting and terminology data, ensure that the user name for the analytics database is different to the user name for the reporting and terminology databases. In Oracle databases, user names are associated with a specific database schema.
Preparing the External Analytics Database
Editing the Database Configuration Properties
You can configure the connections to the three external analytics databases by creating an overlay of the installed persistence properties file. You update the persistence properties overlay with the connection details for your databases and restart the Acrolinx Server.
To configure the Acrolinx Server to connect to your external analytics database, follow these steps:
- Stop the core server.
- Open your overlay of the following file: persistence.properties
If you haven't yet created an overlay of this file, create a new version of the file at the following location:
Don't edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory.
- Each of the three JReport internal databases connections needs the following properties:
jreport.<JREPORT_DATABASE>.dbType=<DATABASE_TYPE_SHORTNAME> jreport.<JREPORT_DATABASE>.jdbcUser=<DATABASE_USERNAME> jreport.<JREPORT_DATABASE>.jdbcPassword=<DATABASE_PASSWORD> jreport.<JREPORT_DATABASE>.jdbcUrl=<DATABASE_URL>
Replace the placeholder values with the connection details for your database:
- Replace the placeholder <JREPORT_DATABASE> with sys , realm , prof .
- Replace the placeholder <DATABASE_TYPE_SHORTNAME> with one of the following values:
DERBY , ORACLE , MSSQL , POSTGRES , DB2 , MYSQL .
- 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.
Note: The syntax of the jdbcUrl parameter can vary depending on the database format. To help you understand the syntax, we've provided sample values for the jdbcUrl parameter in the installed persistence properties file. The jdbcUrl parameter usually requires the IP address, the port, and the name of the database.
For example, to connect to a database on a MySQL Server, update the properties to resemble the following example:
jreport.sys.dbType=MYSQL jreport.sys.jdbcUser=root jreport.sys.jdbcPassword=admin jreport.sys.jdbcUrl=jdbc:mysql://220.127.116.11:32772/analytics-sys jreport.realm.dbType=MYSQL jreport.realm.jdbcUser=root jreport.realm.jdbcPassword=admin jreport.realm.jdbcUrl=jdbc:mysql://18.104.22.168:32772/analytics-realm jreport.prof.dbType=MYSQL jreport.prof.jdbcUser=root jreport.prof.jdbcPassword=admin jreport.prof.jdbcUrl=jdbc:mysql://22.214.171.124:32772/analytics-prof
- Save your changes and restart the core server.
- Check the core server log file for any errors or warnings.
Migrating Existing Data to the External Analytics 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 analytics database, follow these steps:
- Locate the backup in the Available Backups section, and in the Actions column, click Restore .
To restore a backup that you've stored on your computer or at a network location, upload the backup file to your server first .
- In the security dialog that appears, enter the word yes and click OK .
Tip: This type of dialog is an extra precaution to prevent you from overwriting your database unintentionally. When you restore a database backup, all data is overwritten with the data from the backup.