Lookup

Lookup is a component that matches input records with records from another data source and adds columns of the matched records to the scope.

To configure Lookup, you need to specify Behavior, Scope, Property and select a Connection to get data from. Afterwards, select and configure the action to perform in order to obtain data and map its parameters if needed. You can also give Name to the component displayed on the diagram.

Behavior defines what property types and values you get in the Lookup component’s output.

There are five Behaviour types:

  • FirstOrDefault — if there are multiple matches, lookup takes the first value. If there are no matches, property values are set to Null.
  • First — if there are multiple matches, lookup takes the first value. If there are no matches, input properties are sent to the error output.
  • SingleOrDefault — if there is a single match, lookup takes it and sends it as an output. If there are multiple matches, input properties are sent to the error output. If there are no matches, property values are set to Null.
  • Single — if there is a single match, lookup takes it and sends it as an output. If there are multiple matches or no matches, input properties are sent to the error output.
  • Array — if there are matches, lookup takes all the values and add them to the array type property in the output. If there are no matches lookup returns an empty array.

If you want to create a new nested type property that will contain lookup results, define its name in the Property field. Note that Property value is required if lookup Behaviour is set to Array.

If you do not want to create a new nested type property but want to use the existing one instead, enter its name in Scope and it will be extended with the lookup results.