You can connect Acrolinx to a database other than the freely distributed database formats that come with the Acrolinx Platform.
To configure the connection, make sure you're familiar with the operating system in use, Kubernetes, TCP/IP networks, client-server systems, and the necessary communication protocols.
To connect to an external reuse database, confirm that Acrolinx supports your database format. After that, you can create a new database and database user for Acrolinx and adjust database credentials in your Acrolinx installation.
Tip
If you need to migrate an existing reuse database, make sure to back up your data first.
To connect to an external reuse database, follow these major steps:
-
If you’re migrating phrases from a native Acrolinx reuse database, export all your replacements to a backup file.
-
If you’re installing the Acrolinx Platform on a new computer, install Acrolinx and guidance packages according to the standard installation procedures under Install Acrolinx for the First Time.
-
Prepare the external reuse database.
-
Change the database credentials in your Acrolinx installation.
-
If you’re migrating phrases from a native Acrolinx reuse database, import your database backup file.
For an up-to-date list of supported database formats, visit the Standard Stack Compatibility Guide.
Want to migrate an existing Acrolinx reuse database to an external database? To get started, create a database backup from your existing Acrolinx Platform instance.
To create a database backup, follow these steps:
-
On the Reuse page, click the Export replacements button.
-
Confirm the export in the dialog window that appears.
The file that contains all replacements will download with a file name like replacements-export-YYYY-MM-DD.csv
.
To prepare an external reuse database for Acrolinx, follow these steps:
-
Create a new empty database on your database server with the name of your choice.
We recommend that you select UTF-8 encoding for the database. This encoding type guarantees that you can store terms in any language.
-
Configure a user that has full write permissions on your new database.
Notice
If you use an Oracle database to store reuse data:
-
Make sure that the user for the reuse database is different from the users for the other databases. In Oracle databases, usernames are associated with a specific database schema.
-
You also need the following user permissions for an Oracle database:
grant create session to <USER>; grant create table to <USER>; grant create sequence to <USER>; grant create view to <USER>; grant create procedure to <USER>; grant execute on SYS.DBMS_LOCK to <USER>; grant select on SYS.GV_$LOCK to <USER>; grant select on SYS.GV_$SESSION to <USER>;
-
The credentials for all databases (reporting, Terminology, Analytics, Targets, Reuse) are kept in a separate section of the Acrolinx Platform's Helm configuration and can't be edited separately.
For more details, visit Setting Custom Database Credentials.
Want to use existing Reuse phrases in a newly configured database? You can easily restore a backup from your original database.
To restore a database backup, follow these steps:
-
On the Reuse page, click the Import replacements button.
-
Click Select File to locate the database backup file.
-
Click Import.
-
Click Close in the import result dialog.