contextFilter

A Workflow Engine function that filters a workflowContext object for a specified name field. Returns true if the function finds the field under the workflowContext object.

This function is available as a feature of the Add-ons v1.3 download. See Install Moogsoft Add-ons for information on how to upgrade.

This function is available for event, alert, enrichment, and Situation workflows.

The workflow sweep up filter applies to this function.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function contextFilter takes the following arguments:

Name

Required

Type

Description

field

Yes

String

Name of the field to filter by.

Example

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

You want to filter a workflowContext object for a field called "visualize.my_cookbook". Set the following:

  • field: visualize.my_cookbook

The UI translates your settings to the following JSON:

{ “field”:”visualize.my_cookbook”}

If the "visualize.my_cookbook" field is present under the workflowContext object, the function returns true. If the field does not exist, the function returns false.