Lookup List

BCM offers a variety of option fields that can be added to any form for data collection - like checkbox, dropdown, radio button, etc.

Updated over a week ago

Attention: Apricot is now Bonterra Case Management. Please bear with us as we update our screenshots to match our new name.

Without using a Lookup List, these types of fields require that an Administrator type up each list of options as needed for each individual field. If the options "yes," "no," "maybe" were needed in ten individual radio button fields, the Administrator would have to type out the same list ten separate times.

However, with Lookup Lists, these option lists can be typed out once and saved in a central location. They can be applied into fields as many times as needed without retyping.

When to Use Lookup List

Lookup List can save you time when

  • You have a list that will be used on multiple fields

  • You have a list that will be used on multiple forms

  • You have a list that needs to be the same in multiple locations but it may also need to be changed at some point (all at the same time)

Creating a New Lookup List

  1. To access Lookup Lists, click on the Administrator tab.

  2. In the left hand menu, select Lookup Lists.

  3. Expand the black arrow next to the category name to see the names of lists that have already been created.

  4. Select Create New Lookup.

  1. Select Simple or Masked. A simple lookup list will allow you to create one display value for each option in the list. A masked lookup list will allow you to create one display value and one masked (hidden numeric only) value for each option in the list.

  2. Select a category.

  3. Name your list.

  4. Create.

Build a Lookup List

  1. Type in the display values you would like to have available for your option fields.

  2. You can move from line to line by hitting the tab or enter keys after you finish entering each option. There will always be one empty row at the bottom; empty rows will not be displayed when this list is added to a form.

  1. If you would like to add more than one empty row to your list, to facilitate entering more options, select Add Rows at the top of the section.

  2. You can choose to add the rows to the bottom or the top of your existing list.

  3. Type in the number of rows you would like to add.

  4. Select Add Rows.

Empty rows will not be displayed when this list is added to a form.

Bulk Entry (Copy and Paste)

  1. To open a text box where you can paste in bulk options, click Enable Bulk Entry.

  1. Paste any amount of text into this text box to create options in bulk. In a simple (not masked) lookup list, each line of text will be its own option.

  2. Drag this corner to increase the size of the text box, if necessary, to see more text at once.

  3. Select Save Lookup List and anything entered into the text box will replace the options in the rows listed below the green Display Value bar.

Re-Order Options

  1. To re-order a list, click the gray arrows. Options will be put into alphabetical order or (click the gray arrows twice) reverse alphabetical order.

  2. To manually change the order of options, click on the gray box to the right of the option you wish to move and drag it into the desired location.

  3. When you are finished making adjustments to a list, select Save Lookup List.

Edit an Existing Lookup List

  1. To edit an existing look up list, select the Administrator tab.

  2. In the left hand menu, select Lookup Lists.

  3. To the right of the list you would like to edit, hover your mouse over the Actions tab.

  4. Select Edit.

A list can be edited by:

  1. Adding rows by clicking the Add Rows button and entering additional options.

  2. Click the Enable Bulk Entry button and paste in new options.

  3. Clicking on the gray box to the right of an option and moving it to a new location within the list.

  4. Selecting the text of an option and deleting or editing the text.

  5. When you are finished making edits, select Save Lookup List.

Note: If you are making changes to a lookup list that has already been added to a field in a form, the options available in that field will be immediately updated to reflect your edits. However, records that were created with the old options will retain the old options as they were saved in that record, but new records and new edits to old records will only have the current lookup list options available.

Creating a Lookup List with Masked Values

  1. You can also create a lookup list with masked values (suitable for use with masked radio button and masked dropdown fields, for example). This will allow you to create a list that has both displayed and hidden (numeric) values for each option. Select Create New Lookup.

  2. Select Masked.

  3. Select Category.

  4. Name your list.

  5. Select Create.

  1. As when you create a simple (not masked) lookup list, you can type your values into the rows provided.

  2. But in addition, you are required to provide a hidden or back-end value for each option. (These back-end values must be numeric and unique in each list. You cannot create a lookup list, or any masked option field, that has duplicate back-end numerical values)

  3. Clicking Add Rows allows you to add additional rows to the top or bottom of the list.

  4. Clicking Enable Bulk Entry allows you to paste in values in bulk.

  1. When entering masked values in bulk, you will need to separate the display value from the backend value with a "pipe." A pipe is a character on your keyboard, usually between the Backspace key and the Enter Key. When you type it, it looks like this: |

  2. When you select Save Lookup List, the options entered in the text box will replace any rows below the green "Display Value" bar.

Adding a Lookup List to an Option Field

  1. To add a lookup list to an option field in a form, open a form for editing and add a new option field.

  2. Open the field gear box to access properties.

  3. To use a lookup list you already created, select "Use Lookup List."

  1. After you have selected Use Lookup List, a dropdown menu will appear. Expand the black arrow.

  2. Select the lookup list you would like to add to your field.

  3. Select Apply.

  1. After you select apply, the lookup list options will appear in the field.

  2. If you open the green gear box again,

  3. You have the option to Edit Lookup List. Click this button will open a new tab and take you to the Lookup List page where you can edit the list and save changes.

Note: Changes made to a lookup list will go into effect immediately and will be reflected in any field that uses the edited lookup list.

Updating a Traditional Option List with a Lookup List

In the above example, we see a traditional radio button with a list of options that was typed in manually before the lookup list feature was available.

  1. To change this list to a lookup list, select Use Lookup List and you will be able to use a lookup list that has already been created and saved.

  2. To convert these options into a new lookup list, select Bulk Entry. Select the options, copy them, create a new lookup list via the Lookup Lists tab in the left hand Administrator menu and paste in the options.

Did this answer your question?