Retrieve Records Step

You can use a  Retrieve Records step to perform a search on a Collection that will return all records which match your search criteria.

If you want the Action to search for a set of records, a Collection Variable is required to hold all of the records. It is usually followed by a For Each Step which contains the steps to be performed on each of the records returned by the search.

If you want the Action to search for single record then the resulting record can be stored in a Record Variable for further manipulation and you do not need a For Each step.

To summarize, setting up a Search in an action requires two main components:

  • Collection Variable or Record Variable to contain the results of your search criteria.
  • Retrieve Records step to set up the filtering criteria and execute the search.

In addition, if you want the action to do anything to the records returned by a multiple record search a For Each step is also required to contain the steps that should be performed on each of the records.

To Add a Retrieve Records:

  1. Drag and drop a Retrieve Records step from the palette onto the process flow in the desired position.
  2. Double-click the magnifying glass icon to open the Retrieve Records Properties window.
  3. Click on the button next to Collection Type, select a collection and click Select.
  4. Click on the button next to Filter to set the filter criteria in the Filter and Sort window. If multiple records fit the criteria of a single record search, only the first record found will be place in the resulting Record Variable.
  5. For single record searches check the Retrieve Single Record checkbox, for multiple record searches leave this checkbox unselected.
  6. Under Resulting Variable select a custom variable or click on New Variable to create a Record Variable for single record searches or a Collection Variable for multiple record searches. Your new variable will be formatted after the collection specified in the Collection Type section of your Retrieve Record variable.
  7. Once you define your Resulting Variable click Ok to save the Retrieve Record step.