setCustomInfoJSONValue
A Workflow Engine function that adds or updates a custom info key to the specified JSON value. Accepts complex keys: a.b.c.d. The value must be a JSON object. Use the setCustomInfoValue function for to set string values.
This function is available for alert, enrichment, and Situation workflows.
The workflow sweep up filter applies to this function.
Back to Workflow Engine Functions Reference.
Arguments
Workflow Engine function setCustomInfoJSONValue takes the following arguments:
Name | Required | Type | Description |
|---|---|---|---|
| Yes | String | Custom info key for which to set the JSON. Complex keys are allowed. Do not include "custom_info" in the key. |
| Yes | Object | JSON value that you want to set. |
Example
The following example demonstrates typical use of Workflow Engine function setCustomInfoJSONValue. If you want to set the JSON value for the custom_info.services key, set the following:
key: services
value: {"service_list":["Network","Database"]}
The UI translates your settings to the following JSON:
{"service_list":["Network","Database"]}The Workflow Engine updates the object fields as follows:
"custom_info":
{"services":
{"service_list": ["Network","Database"]}
}