ServiceNow Enrichment Reference
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.
Integration Name
Name of the ServiceNow Enrichment integration instance.
Type | String |
Required | Yes |
Default | ServiceNowEnrichment1 |
Instance URL
ServiceNow instance URL.
Type | String |
Required | Yes |
Default | N/A |
CMDB User
ServiceNow CMDB username.
Type | String |
Required | Yes |
Default | N/A |
CMDB User Password
ServiceNow CMDB user password.
Type | String |
Required | Yes |
Default | N/A |
Proxy settings
Specifies connection details for a proxy server if you want to connect to the external system through a proxy.
Use proxy in request
Property description.
Type | Boolean |
Required | Yes |
Default | No |
Proxy host
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy user
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy port
Property description.
Type | Integer |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy password
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Cache Settings
Enable Cache Results
Whether to enable cached results.
Type | Boolean |
Required | Yes |
Default | False |
Cache Results For
How long to cache results for, in seconds.
Type | Integer |
Required | Yes |
Default | 900 |
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:
Table Definition Name
Name of the table definition.
Type | String |
Required | Yes |
Default | N/A |
Table
Database table name.
Type | String |
Required | Yes |
Default | N/A |
Custom Info Path
Path in custom_info.enrichment to store the results.
Type | String |
Required | Yes |
Default | N/A |
Query
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
Fields to query and include in results.
ServiceNow Field Name
Name of the ServiceNow field.
Type | String |
Required | Yes |
Default | N/A |
UI Alias
Table field alias. If unspecified, defaults to the value of Table Field Name.
Type | String |
Required | No |
Default | N/A |
Summarize This Field As A List
Whether to create an array of the values from this under custom_info.enrichment.
Type | String |
Required | Boolean |
Default | False |
Advanced Table Definition Settings
Properties to handle results that return multiple records, for example Applications or Business Services.
Return All Columns
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 |
Query Results Limit
Specifies whether to limit the query results to a certain number of records.
Type | String |
Required | No |
Default | 1 |
Summarize Multi Result Details
Specifies whether to separately store each record under the custom_info path.
Type | Boolean |
Required | Yes |
Default | No |
Source field to summarize multiple results
Type | String |
Required | Yes, if Summarize Multi Result Details is enabled |
Default | N/A |
Exclude from multiple result details
Comma-separated list which specifies items not to store.
Type | List |
Required | Yes |
Default | N/A |
Return false if no results
Type | Boolean |
Required | Yes |
Default | No |