Skip to main content

filterByRecipe

A Workflow Engine function that allows you to filter inscape Situations (trigger and swept up) based on their Visualize data. These are inclusive filters and return true if the Visualize data for the Situation matches the recipe name.

This function is available as a feature of the Workflow Engine v1.1 download and later.

This function is available for Situation workflows only.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function filterByRecipe takes the following arguments:

Name

Required

Type

Description

recipe

Yes

String

Name of the recipe to filter by.

Example

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

If you want to check if the recipe name is "Description", enter the following:

  • recipe: Description

The UI translates your settings to the following JSON:

{"recipe":"Description"}

Given a Situation with the following Visualize data:

{
    "visualize": {
        "origin": "Cookbook",
        "cookbook_name": "Default Cookbook",
        "recipe_name": "Description"
    }
}

The function returns true, since the value of recipe matches the Visualize data.

Now consider this filter:

{"recipe":"Source"}

In this case the function returns false, since the value of recipe does not match the Visualize data.

In this section: