Skip to main content

getAssociatedDetails

A Workflow Engine function that extracts an attribute value from the Swept Up objects (Associated Alerts or Situations) and copies this to a destination field, either in the workflowContext or the triggering CEvent object. Values will be returned as a list, and if no values are returned, an empty list ' [ ] ' will be set. Null values (where an Associated object does not have the attribute set) are ignored.

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

This function is available for alert and Situation workflows.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function getAssociatedDetails takes the following arguments:

Name

Required

Type

Description

attribute

yes

string

The attribute (field) name to extract from the Associated CEvent objects.

destination

yes

string

The destination for the results - either in the workflowContext or triggering CEvent.

Example

The following example demonstrates typical use of Workflow Engine function getAssociatedDetails.

Use case: When a triggering alert arrives of a certain type, we want to sweep up alerts from the same source and send them to a different workflow.

In the Alert Workflow Engine:

  • Create a workflow with a suitable entry filter and a sweep up filter of “source = ‘$source’”

  • getAssociatedDetails

    • attribute : alert_id

    • destination : workflowContext.alert_ids

  • iterate

    • data : workflowContext.alert_ids

    • engineName : Alert Inform Engine

    • workflowName : <the workflow name>

    • context : <optional context - for example the triggering alert_id>

In this section: