This is a reference for the ServiceNow Enrichment integration. This integration uses a hierarchy of settings and definitions.
See the ServiceNow documentation for details on ServiceNow components.
Name of the ServiceNow Enrichment integration instance.
Type | String |
Required | Yes |
Default | ServiceNowEnrichment1 |
ServiceNow instance URL.
Type | String |
Required | Yes |
Default | N/A |
ServiceNow CMDB username.
Type | String |
Required | Yes |
Default | N/A |
ServiceNow CMDB user password.
Type | String |
Required | Yes |
Default | N/A |
Specifies connection details for a proxy server if you want to connect to the external system through a proxy.
Property description.
Type | Boolean |
Required | Yes |
Default | No |
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Property description.
Type | Integer |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
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 |
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 selection criteria for the ServiceNow query in ServiceNow query language. You can use $property
to reference alert properties. For example, the default query where the value for the cmdb.install_status
shows the asset as active and cmdb.name
field is equal to the alert source
:
install_status=1^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 ServiceNow 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. You should only use this setting to find column names or field names in ServiceNow; do not enable it by default.
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 |