# checkFloodEvent

A Workflow Engine function that performs a rudimentary flood check against an alert triggered by an incoming event. If an alert has a count over the specified threshold, all events for that alert will be dropped for a specified period. This action (checkFloodEvent) needs to be used in conjunction with the “dropEvent” action to achieve this (see example below)..

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

This function is available for event workflows only.

## Arguments

Workflow Engine function checkFloodEvent takes the following arguments:

Name

Required

Type

Description

countThreshold

yes

number

The alert count to start the flood control.

dropPeriod

yes

number

The number of seconds to return true once the countThreshold has been reached.

## Example

The following example demonstrates typical use of Workflow Engine function checkFloodEvent. This action should be combined with the “dropEvent” action to achieve the flood control use case.

Define an Event workflow:

• Entry Filter - a suitable entry filter to define the events that will be examined.

• Action 1 : checkFloodEvent

• countThreshold : 100

• dropPeriod : 60

• Ensure the forwarding action is “Stop This Workflow”

• Action 2 : dropEvent

• Ensure the forwarding action is “Stop All Workflows”