Skip to main content

matchFilter

A Workflow Engine function that evaluates CEvent filters configured in the Filter Matcher integration tile. This action supports evaluating multiple filters across multiple filter groups within a single action, reducing the administrative overhead of creating a separate workflow for each condition. See the Filter Matcher documentation for configuration details.

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

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

The workflow sweep up filter applies to this function.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function matchFilter takes the following arguments:

Name

Required

Type

Description

filterGroups

no

object

A list of filter groups to evaluate. If no groups are specified, all groups configured as "Include by Default" will be evaluated.

[ "group1", "group2" ]

Note

The order specified in this list does not affect the evaluation sequence. Groups are evaluated based on their configured priority.

destination

no

string

Overrides the configured destination field with a new field. This override is applied to all groups during evaluation.

Example

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

To evaluate only the "Network" and "Server" filter groups, and write the results to a workflowContext field, overriding the configured group destination.

matchFilter.png