Create the Enrichment API Data Store

Before you install the Enrichment API Integration for Moogsoft Onprem, set up the data store for the API.

Note

Update the Enrichment API data store

To support age scoped deletion via the API, the moog_enrichment database schema has been amended to add a lastupdate column to the data table that is auto-populated with the time that the row was created or updated.

On a new install, the latest bundled version of the moog_enrichment_utils.zip includes an updated moog_init_enrichmentdb.sh that will create the moog_enrichment schema.

On an existing install, a new -s option has been included to just perform a schema update. To perform a schema update:

$MOOGSOFT_HOME/contrib/moog_enrichment_utils/bin/moog_init_enrichmentdb.sh \
-u <database root user> \
-p <optional database root user password> \
-d <database host>:<database port> \
-s

The add-ons includes the Enrichment API Integration that lets you store enrichment data in a database for use with the Enrichment Workflow Engine. Before you can use the integration, create the data store from one machine with access to the database as follows:

Extract the utilities. For example:

unzip -x $MOOGSOFT_HOME/contrib/moog_enrichment_utils.zip -d $MOOGSOFT_HOME/contrib/

Run the script to create the database and the enrichment user:

$MOOGSOFT_HOME/contrib/moog_enrichment_utils/bin/moog_init_enrichmentdb.sh \
-u <database root user> \
-p <optional database root user password> \
-d <database host>:<database port> \
-e <enrichment user password>

For example to initialize the moog_enrichment database on a database host named my_database_host with an enrichment user password of 'password123':

$MOOGSOFT_HOME/contrib/moog_enrichment_utils/bin/moog_init_enrichmentdb.sh \
-u root \
-d my_database_host:3306 \
-e password123

In this case, when prompted for the password, enter the root database user password.

In addition to the database script, the Add-ons include the following utilities to help you load and test enrichment data:

moog_send_event is a node.js script that sends test events to the Enrichment API after you set up the integration. For usage information run: ./moog_send_event -h .
moog_enrichment_util is a node.js script that loads data into the Enrichment API after you set up the integration. You can supply enrchment data in JSON, CSV, or TSV format. For usage information, run ./moog_enrichment_util -h.
moog_enrichment_util.sh is a Bash version of the data loader. It is slower than the node.js scripts, but works on systems where you can't install node.js. For usage information, run ./moog_enrichment_util.sh -h.

After you have installed the latest add-ons and created the data store for the Enrichment API, you can install the Enrichment API Integration.

In this section:

Create the Enrichment API Data Store

Note

Search results