Retrieve data

The Retrieve data flow block pulls data from your CRM system. When you create a flow, the system automatically adds a Retrieve data flow block for every standard data set attached to the selected template. You can then link these Retrieve data flow blocks to your Generate document flow block.

Only one record will be returned at any given time. If multiple records are found for a specified filter, the first one will be used.

Parameters

The dropdown menus below provide all of the Retrieve data flow block configuration options with detailed information and recommendations to help you configure your flow block.

You can further customize your flow block's parameters in several ways

  • Users can use linked fields to map data from your data set(s)

  • User can use edit fields to customize the flow block

  • Using delayed output settings to wait for signatures or file names of completed documents

Basic settings functions

Index No.

Field name

Description

1

Data set

Defines the data set to use for structuring the data. Every Generate document flow block requires one Retrieve data flow block. If you are adding additional Generate document and Retrieve data flow blocks, we recommend using matching data sets on your Generate document and Retrieve data flow blocks. The Generate document flow block data set is set by the system when you create the template and the flow.

2

Query type

Sets how flow block pulls data from your CRM with the following options: By id(Default), By field.

Only one record will be returned at any given time. If multiple records are found for a specified filter, the first one will be used.

3

Record

Defines the record to pull data from within the data set. This setting is only available when the query type is By id. The selected record is automatically linked to the Start this flow from the flow block after you create the flow. The selected record is a field in the data set that allows for different uses.

You could use the User field from your data set to get the current user's data.

 

4

Data set field

Defines the data set field to use when querying data. This setting is only available when the Query type is "By field."

5

Field value

Defines the value the system should use for your selected field when querying data. This setting is only available when the Query type is 'By field'.

6

Fail the flow if multiple references are returned

When checked, the flow fails if multiple references are returned from the query. When not checked, only the first record returned by the query is considered. This setting is only available when the Query type is 'By id.'

See Also

Generate document flow block