Data Source Lookup lets people search for and select records from a connected data source in real time, directly within a form. Builders configure a reusable list that presents recognizable labels and supporting details, helping people identify the correct record without leaving the workflow.
Who Has Access?
| Role | Default access |
|---|---|
| Admin | View, create, and edit lists; connect lists to form fields; control list permissions |
| Manager | View, create, and edit lists; connect lists to form fields |
| Builder | View lists and connect an existing list to a form field; cannot create or edit lists by default |
A person's effective access can differ when an Admin changes permissions.
Key Capabilities
- Live record lookup: People filling out a form can search records from a connected data source in real time.
- Reusable lists: Configure a lookup list once and use it across multiple forms and workflows.
- Configurable record display: Choose which source fields appear as the label and supporting description for each record.
- Search as you type: Type part of a name or other searchable value to narrow the results.
- Filtered results: Show only records that match values entered elsewhere in the form.
- Record ID storage: Store the selected record's ID for submission and later workflow steps.
- Prefill by ID: Display a previously selected record when its source record ID is already known.
Before You Begin
You need:
- A connected data source.
- A dataset for that connected data source with the primary entity and fields you want to use.
Part 1: Create a Reusable Lookup List
Lookup lists are managed under Assets because they are reusable. Configure a list once, then connect it to Data Lookup fields across multiple forms and workflows.
- Open Assets, then Lists.
- Create a new list and enter a descriptive name.
- Select the dataset you prepared.
- Configure the option label by combining the fields, text, and separators that help end users recognize the correct record.
- Optionally configure the description with additional fields and text that provide supporting context.
Note: Labels and descriptions can combine multiple fields from the primary entity and directly related entities. You can also add typed text or separators between fields. For example, combine first name, a space, and last name for the label, then show a role and department separated by a hyphen in the description. A list can use fields from multiple direct child entities, but not from a grandchild entity.
- Review the option preview.
- Choose whether options appear when the field opens or only after the participant starts typing.
- Save the list.
Important: Streamline uses the selected primary record ID as the value carried through the workflow and delivered to later steps or connected systems. The label and description are for display only.
Part 2: Add Data Source Lookup to a Form
- Open the project and workflow you want to edit.
- Add or open a Form step.
- Add a field and select the Data Lookup field type.
- Select Connect list, then choose the reusable lookup list you want to use.
- Optionally configure filters to narrow the available records. For each condition, select a dataset field, an operator, and the workflow field that supplies the filter value.
- Configure the field label, required setting, and other form behavior.
- Finish configuring the Form step and publish the workflow.
Note: A lookup works only with the Data Lookup field type.
Part 3: Search for and Select a Record
- Start a session for the published workflow.
- Open the lookup field.
- If the list does not display options immediately, enter a search term.
- Review each option's label and description.
- Select the correct record.
- Submit the form or continue to the next step.
The selected primary record ID becomes the value carried through the workflow and delivered to later steps or connected systems. The label and description are for display only.
Prefill a Data Lookup Field
You can prefill a Data Lookup field when the workflow already has the source record ID.
- Map the record ID to the Data Lookup field.
- Run the workflow.
- Streamline resolves the ID and displays the configured label.
Important: Prefill requires the source record ID. A display label, such as a person's name, does not work as the prefill value.
Feature Considerations
- Supported sources: Data Source Lookup is available for connected data sources that support lookup search. Unsupported datasets do not appear as selectable options.
- Relationship depth: A list can use fields from the primary entity and multiple directly related child entities, but not from a grandchild entity.
- Related records: If a primary record has multiple related rows, label and description values use the first related row returned by the provider. Other related rows are not combined.
- Workflow value: Streamline carries the selected primary record ID through the workflow and delivers it to later steps or connected systems. The label and description are for display only.
- Create records: Participants cannot create a new source record when a search returns no match.
- Logic: A Data Lookup field can be used in a logic condition. Logic treats its value as a string containing the selected record ID. Enter the record ID as the comparison value instead of selecting a displayed lookup option.
- Search behavior: Most text fields support partial matching. Number and UUID fields require an exact value. Some provider-specific field types may not be searchable even when they can be displayed.
- Record ID filters: Provider record IDs must use the provider's valid full ID format. Partial ID matching is not supported.
- Multi-select: A Data Lookup field stores one selected record.
Compliance
Data Source Lookup queries the connected source live. Results are limited by the connected integration credentials and the dataset's configured access. Labels and supporting details are used to display options during lookup, but they are not carried into later workflow steps. The selected primary record ID is used as the workflow value.
Troubleshooting
The lookup list is unavailable in Form Builder
- Confirm that the list has been created and saved under Assets > Lists.
- Confirm that the list uses a dataset supported by Data Source Lookup.
- Confirm that you have permission to view and connect the list.
Search returns no results
- Confirm that the connected integration is available and its credentials can access the records.
- Check whether a filter is excluding the expected record.
- Try searching a configured text label or description field.
- For number, UUID, or record ID fields, enter the complete value.
The prefilled label does not appear
- Confirm that the prefill value is the primary record ID, not the display label.
- Confirm that the integration credentials and dataset still provide access to that record.
A Data Lookup logic condition does not match
A Data Lookup field is treated as a string in logic conditions. Enter the source record ID as the value for logic condition. The logic editor does not provide a dropdown for selecting one of the lookup's displayed options.
The workflow fails when it reaches the Form step
Confirm that every Data Lookup field in the form is connected to a reusable list. A Data Lookup field without a connected list causes the workflow to fail when it runs.
Display information is missing in a later step
The lookup retains the selected primary record ID. Its label and secondary text are display-only and are not retained for later steps.
Comments
0 comments
Please sign in to leave a comment.