Using lookup tables in Flows

You can read lookup tables in Flows to reuse centrally defined data.

Creating a flow with the Perform Lookup step

To use a lookup table, first create one as described in the Managing lookup tables page.

1. Navigate to the "Process Automation" suite

2. Select the "Flows" option from the menu

3. Create an initial flow using a trigger type of your choosing.

Configuring the Perform Lookup step

Add a new Perform Lookup step to your flow. Click on Add New Action and either select it from the Lookup Tables group or search for it using the Search capability on the right:

Search for Perform Lookup and click it to add it to your flow.

You'll be shown a configuration screen where you can select the table to read from and configure how exactly you want to perform this lookup:

The Perform Lookup configuration page.

You'll see three components you can configure:

1. Lookup Table Slug indicates what table you want to look at. By clicking in this field, Flows will show you the available lookup tables:
2. Lookup lets you determine what to retrieve and you can use the various variables available to you to construct this lookup key. Default operation is to return the value your look up points to as the root level value, but if you want to create an object of data - you can use the As capability to load it into a specific property:
3. Replace lets you replace variables in a returned lookup results with either a static value or a value that is defined somewhere in your lookup table. The following example would replace the text {{ MyVariableName }} in any item returned with the Lookup action with the value it finds under key replacements.<locale>.MyVariableName:

By then clicking the Test button will let you see the resulting data:

Reviewing results from the test

Configuring which table to read from required and you must add at least oneLookup action. You're not required to add any Replace actions.