Skip to main content

getServiceNowEnrichment

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

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

This function does not make use of workflowContext.

This function is available as a feature of the Add-ons v1.4 download and later.

This function is available for ServiceNow Enrichment workflows only.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function getServiceNowEnrichment takes the following arguments:

Name

Required

Type

Description

tableDefName

Yes

String

Name of the table definition from the ServiceNow CMDB integration

value1

No

String

Alert property to use in the Query field of the table definitions in the ServiceNow CMDB 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 ServiceNow CMDB integration. For example, "source", or "custom_info.host_name".

Example

The following example demonstrates typical use of Workflow Engine function getServiceNowEnrichment. It assumes you have set up and configured the ServiceNow CMDB integration with:

  • A database definition of "localmdb".

  • A table definition name of "ci"

See Enrich Alerts with ServiceNow Data 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:

  • 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": {
    "Services": {
      "Client Services": {
        "Apps": "Client Services",
        "SupportGroup": "ITSM Engineering",
        "Class": "Service"
      },
      "Bond Trading": {
        "Apps": "Bond Trading",
        "SupportGroup": "IT Securities",
        "Class": "Service"
      }
    }
  },
  "mooghandling": {
    "isEnriched": true
  }
}