Preparing your MySQL Database
To prepare an external MySQL database for storing terminology, follow these steps:
- Create a new empty database on your database server with the name of your choice.
It's important to select UTF-8 encoding and a case-insensitive UTF-8 collation when doing this. It guarantees the ability to store terms in any language, and avoid problems that Acrolinx might run in to.
Here's an example of how to do this:
CREATE DATABASE <database_name> CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;Note that MySQL 5.6 is a special case and you can't use
utf8mb4. We recommend using MySQL 5.7.
- Configure a username and password which has full write permissions on your new database.
Editing the Acrolinx Database configuration properties
You can configure a connection to an external terminology 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 the Acrolinx Server.
To configure the Acrolinx Terminology Manager to connect to your database, follow these steps:
- Stop the core server.
- 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:
You can copy the installed version of this file from the following location:
Do not edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory.
- Add the following properties:
terminology.dbType=MYSQL terminology.jdbcUser=<DATABASE_USERNAME> terminology.jdbcPassword=<DATABASE_PASSWORD> terminology.jdbcUrl=jdbc:mysql://<DB_SERVER_ADDRESS>:<DB_PORT>/<DB_NAME>?<EXTRA_PARAMETERS>
Ensure that you use UTF-8 character encoding when configuring the connection to your database server. You configure UTF-8 character encoding by adding the parameters character_set_server=utf8mb4 to the database URL. The persistence.properties file contains an example of a MySQL database URL that you can use as a reference.
terminology.dbType=MYSQL terminology.jdbcUser=termadmin terminology.jdbcPassword=jama7UrU terminology.jdbcUrl=jdbc:mysql://192.168.0.37:3306/TERMINOLOGY?character_set_server=utf8mb4
- Save your changes and restart the core server.
- Check the core server log file for any errors or warnings.