Get Records by Criteria Builder

The Get Records by Criteria Action Builder will retrieve all records that match a criteria.

Loop through each record and get all properties specified.


Select the Business Object Type that will be retrieved.

Click the arrow on the right to select from a list of object types.

Click next once one is selected.


The Record Criteria will be used to ascertain which records to retrieve from the database.


Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.


If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.



Select the properties, of the object type, that will be retrieved.

Select the Property.

Type in a Variable name or select from a list of existing Variables that will hold the value of the property.

Click the Plus button to add that property to the list to be retrieved.

Click Finish once all property values have to be retrieved have been added.

Created Script


Add Text Parameter – maps a Criteria Parameter to a value to be substituted with.

Get Records – retrieves all records that matches a Criteria and sets the record collection to a variable.

Loop Record Collection – loops through the record collection to process each record contained. The variable that holds the current record is CurrentItem.

Get Property (Get Product) – this retrieves the value of the property and puts that value into a variable. There will be a Get Property action for each property that was added.