Megaphone icon.

We are proactively implementing preventative security measures for certain users. As a result, some users may be prompted to reset their passwords. We appreciate your patience and partnership.  Password reset issue or no reset link? Call Support at 888-228-2233

Create and 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. Sign in to your site

  2. Navigate to Developer Tools and select Dynamic Lookups Developer tools navigation highlighting dynamic lookups.

  3. Click the + button in the bottom right of the screen Button to create a new dynamic lookup.

  4. Choose either the Element Lookup or Data Lookup type New Dynamic Lookup options for Element and Data Lookup.

  5. Select a Lookup Source Dynamic Lookup options including Custom URL, Hosted API, and Built In features.

    • 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

  6. Add a Lookup LabelInput field for Lookup Label with an option to exclude form definition from lookup.

  7. 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 Settings panel showing option to exclude form definition from lookup.

  8. Choose the appropriate Environment Various environments available for the dynamic lookup.

  9. Enter the URL or API for the Lookup Blake test section with a lookup URL highlighted for user input.

    Note:

    This field will differ depending on the Lookup Source you chose

  10. Toggle on Run Lookup on Clear if you wish to run the lookup when the user clears the input or deselect the option(s) Interface showing 'Run Lookup On Clear' option in Knowledge Management settings.

  11. Select SaveThe Save button on the dynamic lookup screen.

  12. You can now Enable a Lookup on a Form Settings for License Number with options for data and element lookup enabled.


Delete a Dynamic Lookup

Important Note

Lookups that are in use cannot be deleted

  1. Sign in to your site

  2. Navigate to Developer Tools and then Dynamic LookupsDeveloper tools navigation highlighting dynamic lookups.

  3. Click Delete next to the Lookup you wish to remove The Delete button on a dynamic lookup card.

  4. Click Delete on the pop-up that says "Are you sure you want to delete [Name of Lookup]?" Confirmation dialog asking to delete 'Playgrounds' with options to cancel or delete.