This is a reference for the JDBC Enrichment integration. This integration uses a hierarchy of settings and definitions.
See the JDBC documentation for details on JDBC components.
Name of the JDBC Enrichment integration instance.
Type | String |
Required | Yes |
Default | JDBCEnrichment1 |
Each database definition contains the following settings:
JDBC Integration instance which the workflow engine actions reference by its Database Definition Name.
Type | String |
Required | Yes |
Default | N/A |
Type of database you want to connect to.
Type | List |
Required | Yes |
Default | N/A |
Database hostname.
Type | String |
Required | Yes |
Default | N/A |
Port to connect to the database over.
Type | Integer |
Required | Yes |
Default | N/A |
Name of the database you want to connect to.
Type | String |
Required | Yes |
Default | N/A |
Username to connect to the database.
Type | String |
Required | Yes |
Default | N/A |
Password to connect to the database.
Type | String |
Required | Yes |
Default | N/A |
Map of key-value pairs of properties to specify the connection properties. See the "Database Specific Information" section in ExternalDb for more information.
Type | String |
Required | No |
Default | N/A |
Whether to enable cached results.
Type | Boolean |
Required | Yes |
Default | False |
How long to cache results for, in seconds.
Type | Integer |
Required | Yes |
Default | 900 |
Within each Database Definition you can additionally configure Table Definitions. You can configure multiple Table Definitions as long as each table alias is unique across all of the definitions for this integration.
Each Table Definition contains the following settings:
Name of the table definition.
Type | String |
Required | Yes |
Default | N/A |
Database table name.
Type | String |
Required | Yes |
Default | N/A |
Path in custom_info.enrichment
to store the results.
Type | String |
Required | Yes |
Default | N/A |
Represents the WHERE clause of the database request. You can use $property
to reference alert properties. SQL syntax requires quotes around the value. For example, a query where the value for the table.name
field is equal to the alert source
:
name = "$source"
To reference custom info properties, use $custom_info.<path>.<key>
. For example "custom_info.enrichment.environment"
.
To reference values from the workflow, use $$params.value1
or $$params.value2
. To treat the value as a literal, prefix the property with '$' instead of '$$'. For example "$$params.value1"
.
Type | String |
Required | Yes |
Default | N/A |
Fields to query and include in results.
Name of the table field.
Type | String |
Required | Yes |
Default | N/A |
Table field alias. If unspecified, defaults to the value of Table Field Name.
Type | String |
Required | No |
Default | N/A |
Whether to create an array of the values from this under custom_info.enrichment
.
Type | String |
Required | Boolean |
Default | False |
Properties to handle results that return multiple records, for example Applications or Business Services.
Specifies whether to return all data rather than the fields you have configured in the UI.
Type | String |
Required | Yes |
Default | No |
Specifies whether to limit the query results to a certain number of records.
Type | String |
Required | No |
Default | 1 |
Specifies whether to separately store each record under the custom_info
path.
Type | Boolean |
Required | Yes |
Default | No |
Type | String |
Required | Yes, if Summarize Multi Result Details is enabled |
Default | N/A |
Comma-separated list which specifies items not to store.
Type | List |
Required | Yes |
Default | N/A |
Type | Boolean |
Required | Yes |
Default | No |
To connect to a database with properties that are not in the UI, define the properties in this field. For example, if you use advanced features of a new JDBC driver. This field overrides the properties within Database Definitions.
Type | String |
Required | No |
Default | N/A |
{
"jar_files": ["/usr/share/moogsoft/lib/cots/sqljdbc4.jar"],
"class_name": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"url": "jdbc:sqlserver://172.16.87.248:1433;databaseName=moog",
"properties": { user: "sa", password: "password" }
}
The overriding database type.
Type | Drop-down |
Required | No |
Default | N/A |