Zum Hauptinhalt gehen
 

Wie können wir helfen?

Suche

[en] Connect to an External Analytics Database

  • Aktualisiert

[en] 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.

[en] Create three new databases and a database user for Acrolinx, and configure the persistence properties file in your Acrolinx Platform installation. You can also use database backups to migrate any existing data to the new database format.

[en] Supported Database Formats

[en] For an up-to-date list of supported database formats, see the Standard Stack Compatibility Guide.

[en] Create Three New Databases

[en] Create three new empty databases on your database server with names of your choice, for example, analytics-realm, analytics-sys, and analytics-prof.

[en] To prepare the three external Analytics databases for Acrolinx, follow these steps:

  1. [en] We recommend selecting UTF-8 encoding for the database as this encoding type guarantees the ability to store terms in any language.

  2. [en] Configure a username and password, which has full write permissions on your new database.

    Hinweis

    [en] If you use an Oracle database to store analytics, reporting and terminology data:

    • [en] Make sure that the username for the terminology database is different to the username for the reporting and Analytics databases. In Oracle databases, usernames are associated with a specific database schema.

    • [en] The user for the terminology database has no permissions on the reporting and Analytics databases and the other way round.

    • [en] 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>;

[en] Edit the Database Configuration Properties

[en] If you need to configure the connections to the three external Analytics databases, you can create an overlay of the installed persistence properties file. Update the persistence properties overlay with the connection details for your databases and restart Acrolinx.

[en] Optional: If you don't want to create three separate external databases for analytics, you can create just one. You still need to configure all three JReport connections, and point the jdbcUrl to the same database in all three connections.

[en] To configure Acrolinx to connect to your external Analytics database, follow these steps:

  1. [en] Stop the Acrolinx Platform.

  2. [en] Open your overlay of the following file: persistence.properties

    [en] If you haven't yet created an overlay of this file, create a new version of the file at the following location:

    [en] <config directory>/server/bin/

    [en] Don't edit the installed version of the file. Instead, always edit your overlay copy in the configuration directory.

  3. [en] 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>?<EXTRA_PARAMETERS>

    [en] Replace the placeholder values with the connection details for your database:

    • [en] Replace the placeholder <JREPORT_DATABASE> with sys, realm, prof.

    • [en] Replace the placeholder <DATABASE_TYPE_SHORTNAME> with POSTGRES or Oracle.

    • [en] Replace the placeholder <DATABASE_USERNAME> with the username that you defined in Preparing a Database.

    • [en] Replace the placeholder <DATABASE_PASSWORD> with the password that you defined in Preparing a Database.

    • [en] Replace the placeholder <DATABASE_URL> with the location of your database.

      Anmerkung

      [en] 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.

      [en] The following table lists the standard syntax of the jdbcUrl parameter for PostgreSQL and Oracle:

      [en] Database Type

      [en] Syntax of the jdbcUrl Parameter

      [en] Example

      [en] Oracle 19c

      [en] jdbc:oracle:thin:@<IP_ADDRESS>:<DB_PORT>/<DB_NAME>

      [en] jdbc:oracle:thin:@192.168.0.37:1521/TERMS

      [en] PostgreSQL

      [en] jdbc:postgresql:<DB_NAME>

      [en] jdbc:postgresql:terminology

  4. [en] Save your changes and start the Acrolinx Platform.

  5. [en] Check the log files for any errors or warnings.