Skip to Content

List control bindings in Jitterbit App Builder

List control bindings provide specialized functionality for List controls within the UI layer. These bindings allow developers to refine user interaction through two distinct methods: List Filter, which restricts the options available in a dropdown, and List Retrieve, which automatically populates other fields on the page based on a selection.

List filter

A List filter dynamically limits the options displayed in a list by binding the control to another field on your panel's business object. For a List filter to function correctly, the field you are binding on must exist in both the business object the panel is built upon and the List object itself. The behavior of the list is then governed by setting the binding direction to filter.

How to configure a List filter

  1. Open the desired page and select Action Drawer > Live Designer. Alternatively, open the desired page's edit screen by going to App Workbench > Pages.

  2. If you're using the Live Designer, select the panel containing the List control and go to the All Controls tab. If you're in the App Workbench, select the panel containing the List control and click its Controls button.

  3. Locate the List control. If you're in the Live Designer, click its Open record icon. If you're in the App Workbench, click its Open record icon. A dialog opens.

  4. In the resultant dialog, open the List Options tab.

  5. In the List Options field group, find the Panel and List Interactions field and click the Filters button. A dialog opens.

  6. In the resultant dialog, click + Filter.

  7. Select a Panel Column and a corresponding (List Source) Column.

  8. Click the save icon to save your changes.

  9. Exit out of the dialog, refresh the application page, and test your filters.

List retrieve

While a standard List control typically only captures a single ID, List Retrieve allows you to "pull back" additional values from the list into your current record. A common use case is selecting a Product from a list and automatically retrieving its Unit Price into an Order record. This requires augmenting the existing List rule to include the extra columns and then mapping them in the UI.

How to configure a List retrieve

  1. Open the desired page and select Action Drawer > Live Designer. Alternatively, open the desired page's edit screen by going to App Workbench > Pages.

  2. If you're using the Live Designer, select the panel containing the List control and go to the All Controls tab. If you're in the App Workbench, select the panel containing the List control and click its Controls button.

  3. Locate the List control. If you're in the Live Designer, click its Open record icon. If you're in the App Workbench, click its Open record icon. A dialog opens.

  4. In the resultant dialog, open the List Options tab.

  5. In the List Options field group, find the Panel and List Interactions field and click the Retrievals button. A dialog opens.

  6. In the resultant dialog, click + Retrieval.

  7. Select a Panel Column and a corresponding (List Source) Column.

  8. Click the save icon to save your changes.

  9. Exit out of the dialog, refresh the application page, and test it.

Once configured, selecting an item from the list will automatically populate the corresponding retrieved values on your panel.