Range Filter Documentation

Version: 2.1.2

Retrieved: 2025-10-09 15:16:13

Range Filter

The module is used to filter out messages based on a numeric range. It can either filter out messages with values in the range our outside the range. Messages that are not filtered out will pass the module untouched.

Settings

Lower Limit and Upper Limit controls the range used for filtering. Source Property specifies from which property on the incoming message to get the values used for filtering. Select Mode controls if messages with a value inside or outside the range will be filtered out.

Input

The input is required to have a numeric value for the Source Property.

Output

• If Select Mode is Inside range and the input data is within the range, the input will be sent to the next module unchanged, otherwise no output data.

• If Select Mode is Outside range and input data is outside of the range, the input will be sent to the next module, otherwise no output data.

Examples

Example 1 - Message Property Within Filter Range

Range only let data within [1,5] through.

# Settings:
Source Property = Container.data
Lower Limit = 1
Upper Limit = 5
Select Mode = Inside range

# Incoming message:
{
    "data": 4
}

# Outgoing message:
{
    "data": 4
}

Example 2 - Message Property Outside Filter Range

Range only let data within [1,5] through.

# Settings:
Source Property = Container.data
Lower Limit = 1
Upper Limit = 5
Select Mode = Inside range

# Incoming message:
{
    "data": 6
}

# Outgoing message:
# NOTE: No outgoing message since property value is outside filter range.