Lookups

Search

The search feature allows you to search for a specified text string anywhere within the following Lookup fields: Display Name, Internal Name, or Status.

1. Optionally, in the search field near the top of Lookups screen, enter the desired text string.

2. Press Enter, or click the search button (magnifying glass icon).

3. The Lookups screen is refreshed to show only the Lookup tables that meet your search criteria. 

4. To remove all search criteria, click the remove button ("X" icon).

Sort

The "Sort" drop-down menu allows you to sort the Lookup tables on a variety of different fields. To sort the list of Lookup tables, select the desired sort option from this menu.

• Lookup table ID (default)

• Name

• Created Date

• Updated Date

To create a new Lookup table: 

1. Enter the Display Name for the new Lookup table.

2. Click create. The "Edit Lookup" pop-up window is displayed. 

3. The "Name" field is populated with the value you entered above; optionally edit this value.

4. The "Internal Name" is automatically populated based on the "Name" value. This field is disabled by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

5. Optionally enter a description in the "Description" field.

6. From the "Status" drop-down menu, select the Lookup table status -- Draft, Published, or Archived. 

7. Select the Lookup table's effectivity period. Valid values are:

• Always: This Lookup table doesn't expire.

• Scheduled: Enter a start date and end date, and select a time zone. Optionally, check "Recurring" to use a recurring schedule. Select the desired schedule from the "Recurring Schedule" drop-down menu, or define a new recurring schedule (see below for details on that process).

8. Click save.  

Define a Recurring ScheduleDefine a Recurring Schedule

To view or edit the details of a Lookup table:

1. Search, sort, or filter the Lookups screen as described above.

2. Click on the desired Lookup table name.

3. The Lookup Details screen is displayed and populated with all of the information about this Lookup table. See Lookup Details for more information.

After you've created a Lookup table, you must deploy the Lookup table metadata.  

1. From the "Actions" menu in the top-right corner, select "Validate Lookups Metadata."

Note: You can deploy metadata immediately, but the best practice is to validate the Lookup table logic before deploying metadata to ensure no incorrect expression code gets deployed to the server that could cause issues.

2. If the validation step passes, you'll see a message that says, "Lookups metadata is valid." If the validation step fails, you'll receive an error message; review and correct your Lookup table, then retry the validation step.

3. Click deploy lookups metadata.

4.  A confirmation dialog box is displayed; click confirm.

5. If the deployment was successful, you'll see a message that says, "Lookups metadata has been deployed."

To see the details of what Lookup table metadata has been deployed:

1. From the "Actions" menu in the top-right corner of the screen, select "View Deployed Lookups." The "View Snapshot" pop-up window is displayed.

2. Click the plus-sign to expand the message to view additional details, such as the total number of deployed Lookup tables. You can also drill in deeper, to see details of each deployed Lookup table.

3. When finished, click the "X" icon to close the pop-up window.