Skip to main content
 

How can we help?

Search

Connect to an External Targets Database

  • Updated

You can connect Acrolinx to a database other than the freely distributed database formats that come with the Acrolinx Platform.

To configure the connection, you should be familiar with the operating system in use, Kubernetes, TCP/IP networks, client-server systems, and the necessary communication protocols.

Major Steps

To connect to an external Targets 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 Targets database, make sure to back up your data first.

To connect to an external Targets database, follow these major steps:

  1. If you’re migrating Targets from a native Acrolinx Targets database, export all your Targets to a backup file.

  2. 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.

  3. Prepare the external Targets database.

  4. Change the database credentials in your Acrolinx installation.

  5. If you’re migrating Targets from a native Acrolinx Targets database, import your database backup file.

Supported Database Formats

For an up-to-date list of supported database formats, visit the Standard Stack Compatibility Guide.

Prepare an External Targets Database

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

  1. 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.

  2. Configure a user that has full write permissions on your new database.

    Notice

    If you use an Oracle database to store Targets data:

    • Make sure that the user for the Targets 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>;

Change the Targets Database Credentials in your Acrolinx Installation

The credentials for all databases (reporting, Terminology, Analytics, Targets, Reuse) are kept in a separate section in the helm configuration of the Acrolinx Platform and can not be edited separately.

Please visit Set Custom Database Credentials for details.