Installing the Event Engine

As a Automation Engine user, this section provides you with a guide to installing the Event Engine. The Event Engine is an optional part of the Automation Engine and consists of several components.

Note: If you have previously installed Analytics, you do not need to install the Datastore and Backend. Proceed to install the Rule Engine and the Steaming Platform .

The Event Engine

The Event Engine can be installed with Analytics, and as it uses the same datatore as Analytics, it is obligatory that you install the Analytics Datastore and Backend prior to installing the Event Engine. 

Installing the Event Engine (Rule Engine)

The Event Engine installation is fully integrated with the Automation Engine. Events can trigger actions using rules and past values. It is also possible to create Custom Rules tailored to your organizations' needs, poll external resources and implement customer-specific sensors and rules on site.

Installing the Datastore

Skip this step if you have already installed Analytics.

PostgreSQL must be installed and configured for Analytics to run. The PostgreSQLAnalytics datastore extracts the data to be used for reporting purposes. If you have not already done so, install the appropriate PostgreSQL version now. Download it from www.postgresql.org/download/

When installing PostgreSQL, you will have to set the super user password. Keep this password at hand, you will need it later.

This topic does not cover the PostgreSQL installation procedure. It only touches on aspects of the installation that are relevant for Analytics and describes how to configure it. For information about the PostgreSQL installation, please refer to the official PostgreSQL documentation.

Important! Use the compatibility matrix to find the relevant information on supported versions, setup, or prerequisites. For more information, see compatibility matrix.

Note: To optimize database performance and efficiency, see: Maximizing Efficiency with the Datastoreat Automic Automation System Requirements and Sizing.

PostgreSQL on Windows

  • The PostgreSQL installer for Windows can be run in graphical or in silent install mode.

  • It is not necessary to install the Stack builder.

PostgreSQL on Linux

Make sure that the tcp/ip connection is enabled (localhost).

To Configure PostgreSQL

  1. Configure PostgreSQL so that it can accept connections from any user and host. You do this in the pg_hba.confPostgreSQL file.

    1. Go to PostgreSQL/<version number>/data and open pg_hba.conf.

      Note: By default, the PostgreSQL files are stored in Program Files.

    2. In pg_hba.conf, add the following:

      TYPE: host

      DATABASE: all

      USER: all

      ADDRESS: 0.0.0.0/0

      METHOD: md5

  2. To upload the Analytics data structures to PostgreSQL, execute a script called setup.psql that is provided with the Analytics installation package. The script is located under <installation directory>\Automation.Platform\Analytics\Datastore\setup.psql.

    Execute the setup.psql script from the Analytics datastore directory using the following PostgreSQL psql command:


    [path to postgres bin]\psql -h vmwin -p 5432 -U postgres -W -v username="analytics" -v password="'analytics'" -v db_name="analytics" -f setup.psql

    Where:

    • -h is the host where the database is

    • -p is the port (by default, this is 5432)

    • -U is the super user

    • -W means no super user password

    • -v are the script parameters for the database username, the password and the name of the database

    • -f designates the script that will be executed.

    Tip: Keep the Analytics defaults, all in lowercase

    When executing the script you will be prompted to enter the PostgreSQL super user password.

    The script creates the following:

    • A role

    • A database, including the following tables: ah, ah_cleaned, an_enricher, api_key, ara-execution, ara-execution_cleaned, ara-execution_enricher, configuration, lasim, lasim_cleaned, schema_version, scoped_api_key, shared_dashboard, status.

      The setup.psql script creates the initial api_key table, and the rest are created when the sync starts.

    • The rest of the datastore

    • The backend API key

      This is the key that secures the communication between the different components and the Analytics backend.

Important! Copy the contents of the command window to a text file. You will need the API key as well as the datasource URL, username and password later.

The datastore is installed and configured. You must install and configure the Analytics backend now.

Installing the Backend

Skip this step if you have already installed Analytics.

The Analytics backend pulls the data from the Automation Engine and makes it available to the web interface. You need to configure the backend so that the data exchange is possible.

Note: If your organization is using the Event Engine, the Analytics is already installed. If this is the case, you can skip this section of the installation. If not, these topics will guide you through the installation of the Analytics Backend.

To Install the Analytics Backend

  1. Unzip the content of the deployment package (Analytics.On.Premise_Analytics.Backend_ .zip) into the folder where you want to run the backend.

    Package content

    • analytics-backend.jar

    • application.properties.sample

    • logging.xml

    • README.txt

    • THIRD-PARTY-LICENSES.txt

    • UC.msl

    • UCXedda.ini

  2. Configure the backend to connect to the Analytics datastore and the Automation Engine database.

    The backend has a configuration file called application.properties.sample in the Analytics/backend folder. You configure the connection here.

    1. Copy application.properties.sample and rename it to application.properties to keep the original file and do the configuration in the renamed one.

    2. To specify the connection to the Analytics datastore, open application.properties and enter the datastore URL, username and password. You find these values in the text file where you stored content of the command window after executing the setup.psql script.

      Example:

    3. (For PostgreSQL you can skip this step, as the driver is included and loads automatically).

      To enable the connection to the Automation Engine database, create a jdbc folder and copy the correct JDBC driver from AutomationEngine/bin/lib available in your Automic Automation installation directory to that jdbc folder.

      The JDBC drivers are:

      • MSSQL:./jdbc/sqljdbc4.jar

      • Oracle:./jdbc/ojdbc7.jar

      • DB2: ./jdbc/db2jcc-4.jar

    4. To specify the JDBC connection to the Automation Engine database in application.properties enter the database URL, username and password.

      Oracle

      1. Specify a read-only user for the Oracle schema. For this purpose, create a text file in the Analytics backend directory. You can call it AE schema.sql, for example.

      2. In the text file, write the following:

        ALTER SESSION SET CURRENT_SCHEMA=automic

        This will set the schema to automic while retaining the already configured database username and password.

      3. In application.properties enable the following setting:

        datasource.AE.schema=file:AE_schema.sql

      Important! In some Oracle versions the user name and password are case-sensitive.

      DB2

      1. Specify a read-only user for the DB2 schema. For this purpose, create a text file in the Analytics backend directory. You can call it AE schema.sql, for example.

      2. In the text file, write the following:

        SET SCHEMA=automic

        This will set the schema to automic while retaining the already configured database username and password.

      3. In application.properties enable the following setting:

        datasource.AE.schema=file:AE_schema.sql

      PostgreSQL

      You find the database URL in the sqlDriverConnect= parameter in the Automation Engine's UCSrv.ini file. The username and the password were set when the Automation Engine database was created.

    5. Save the changes to application.properties.

  3. Connect the Analytics backend to the Automation Engine.

    For this purpose, enter the Automation Engine system, host and port in the ucxedda.ini file that is available in the Analytics backend directory.

    Example:

    ; system: AE system name

    ; The name can consist of a maximum of 8 characters. Allowed are the upper-case letters A to Z, numbers and "_".

    system=<name of your AE system>

    ...

    ; jcp: Address of the java communication process in the AE system to which the component should connect.

    ; Allowed formats:

    ; DNS Name:Port number

    ; TCP/IP Address:Port number

    jcp=<host>:8443

  4. Configure the Service Manager to be able to control Analytics and to set it to start automatically at boot. For this purpose, you must update the UC4.smd and UC4.smc files located in the ServiceManager/bin folder in your Automic Automation installation directory.

    1. Stop the Service Manager.

    2. Open the UC4.smd file and enter the following:

      DEFINE ANALYTICS-BACKEND;C:\Program Files\jdk-14.0.2\bin\java -Xmx2g -Xms512m -XX:+UseG1GC -jar analytics-backend.jar;C:\<Analytics installation directory>\Analytics\backend

      Where:

      • DEFINE ANALYTICS-BACKEND is an AE instruction to create the Analytics service

      • C:\Program Files\jdk-14.0.2\bin\java -Xmx2g -Xms512m -XX:+UseG1GC -jar analytics-backend.jar is a Java command from the Java bin directory with some standard arguments. Keep them as they are.

      • C:\<Analytics installation directory>\Analytics\backend is the directory from which analytics-backend.jar is executed

    3. Save and close UC4.smd.

    4. Open the UC4.smc file. It contains the autostart and timing instructions.

      Enter the following:

      WAIT 3

      CREATE ANALYTICS-DATASTORE

      WAIT 14

      CREATE ANALYTICS-BACKEND

      For information about how to secure the backend, see Securing Connections to the AE (TLS/SSL).

    5. Save and close UC4.cmd.

  5. Configure the Web UI plug in.

    1. Copy the webui-analytics-plugin.jar file from the Analytics/plugin folder in your Analytics installation directory into the AWI web application directory in Tomcat.

    2. Configure the plugin so that it can access the backend. For this purpose, you use the plugin.properties file.

      Populate the following:

      • backend.api_key=

        This key secures access to the backend REST API. It was generated by the setup.psql script when you set up the datastore. When setting up the datastore, you copied this key to a text file.

      • backend.endpoint=

Further Installation Steps

To continue installing Event Engine, refer to the following links:

See also: