Create & Manage Dynamic Lookups

Prev Next

This article will show you how to create a Dynamic Lookup to query external content. There are two types of dynamic lookups, Data Lookup and Element Lookup. Data Lookups are used to dynamically populate existing form elements with data. Element Lookups are used to dynamically generate form elements.

You can also create and store a table of contents in Process Automation and Digital Services that can be looked up against in a form. Learn more on the Lookups article.

Create a Dynamic Lookup

  1. Navigate to Developer Tools and select Dynamic Lookups developer tools menu on left side with dynamic lookups selected.

  2. Click the + button in the bottom right of the screen plus sign in bottom right corner.

  3. Choose either the Element Lookup or Data Lookup type element or data lookup options.

  4. Select a Lookup Source lookup source options.

    • Custom URL: Provide the URL for the specific API endpoint that you want the form data to be pushed to

    • Hosted API: Use our API Hosting service to create your own custom hosted APIs for your Lookups to point to

    • Built In: Use Built-in data as the source of your lookup

  5. Add a Lookup Labellookup label text field.

  6. If applicable, toggle on Exclude Form Definition from Lookup to reduce the size of the lookup payload and ensure that only the form submission data is passed through to your lookup endpoint Exclude Form Definition toggle.

  7. Choose the appropriate Environment environment options.

  8. Enter the URL or API for the Lookup environment lookup URL text field.

    Note: This field will differ depending on the Lookup Source you chose

  9. Toggle on Run Lookup on Clear if you wish to run the lookup when the user clears the input or deselect the option(s) Run Lookup on Clear toggle.

  10. Select SaveSave button in the bottom right corner of the lookup screen.

  11. You can now Enable a Lookup on a Form enable lookup toggles on form element.

Delete a Dynamic Lookup

Important Note

  • Lookups that are in use cannot be deleted

Instructions

  1. Navigate to Developer Tools > Dynamic LookupsDeveloper Tools menu with Dynamic Lookups selected.

  2. Click Delete next to the Lookup you wish to remove trashcan icon on lookup.

  3. Click Delete on the pop-up that says "Are you sure you want to delete [Name of Lookup]?" Confirm delete pop-up.

Supporting Articles