getJDBCEnrichment

A JDBC Enrichment Workflow Engine function that adds data to alerts from a JDBC database.

This function relates directly to the database and table definitions from your JDBC Enrichment integration.

This function does not make use of workflowContext.

This function is available as a feature of the Workflow Engine v1.3 download. See Update the Workflow Engine for information on how to upgrade.

This function is only available for JDBC Enrichment workflows.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function getJDBCEnrichment takes the following arguments:

Name

Required

Type

Description

databaseDefName

Yes

String

Name of the database definition from the JDBC Enrichment integration.

tableDefName

Yes

String

Name of the table definition from the JDBC Enrichment integration

value1

No

String

Alert property to use in the Query field of the table definitions in the JDBC Enrichment integration. For example, "source", or "custom_info.host_name".

value2

No

String

Alert property to use in the Query field of the table definitions in the JDBC Enrichment integration. For example, "source", or "custom_info.host_name".

Example

The following example demonstrates typical use of Workflow Engine function getJDBCEnrichment. It assumes you have set up and configured the JDBC Enrichment integration with:

  • A database definition of "localmdb".

  • A table definition name of "ci"

See Enrich Alerts Using a JDBC Data Source for the full workflow.

To retrieve data from a record in an external database and store specific columns in the alert’s custom_info, set the following:

  • databaseDefName: localcmdb

  • tableDefName: ci

The UI translates your settings to the following JSON:

{"databaseDefName":"localcmdb","tableDefName":"ci"}

The function retrieves the data and adds it to custom info:

{
  "enrichment": {
    "HostDetails": {
      "OS Version": "2.6.9-22.0.1.ELsmp",
      "SupportGroup": "Linux Server",
      "Class": "Linux Server"
    }
  },
  "mooghandling": {
    "isEnriched": true
  }
}