Lookup

Overview

The Lookup module lists all the lookup fields used by API services of the RIA Framework. A lookup field is a dropdown list that allows you to select a value from a predefined set of options. The options for a lookup field are in the Lookup Values table.

All the items listed in this module are part of the RIA Framework package. You cannot create or delete a lookup field. You can only modify display names or lookup values. For more information, see Edit lookup.

Views

List View

Field Description
Lookup Field Unique identifier of a lookup.

The lookup field should match a column name in an Ocular table. Lookup values defined under the lookup will be used as data for that column.
Name Label name of the field as displayed in the application.
Numeric Value Indicates if a numeric value is required for the lookup field.
System Defined

Indicates if the lookup field is system-defined.

If a field is system-defined, you cannot add or delete a new lookup value. However, you can do the following:

  • Edit the display names of a lookup field and its values. See Edit lookup.
  • Hide a lookup value by ticking the icon.
Actions

Displays that allows you the following:

  • View the details and the lookup values of a lookup field. See Lookup values.
  • Edit the display name of a lookup and the configured lookup values. See Edit lookup.

Lookup Values

The Lookup module allows you to view the details and the lookup values of a lookup field by clicking in the Actions column.

A lookup value is a pre-defined option for a lookup field. The Edit Lookup window displays a Lookup Values table listing all the configured lookup values for the selected lookup field.

Field Description
Add Values Allows you to add lookup values for lookup fields that are not system-defined.

This button is disabled for lookup fields that are system-defined.
Value Value in the lookup field as stored in the database.
Name Name of the values as displayed in the UI.
Actions

Displays the following icons:

  • — Edit icon that allows you to edit the display name of a lookup value.
  • — Delete icon that allows you to delete a lookup value. This is only enabled for lookup fields that are not system-defined. Otherwise, a disabled trash icon is displayed.
  • — Button that allows you to hide a lookup value from the options. When ticked, it will look like .

Edit lookup

The Lookup module allows you to edit a lookup field by clicking in the Actions column.

For lookup fields that are not system-defined, you can do the following:

  • Edit the display name of a lookup field by updating the Name field.
  • Edit the display name of a lookup value by clicking in the Actions column of the Lookup Values table and updating the Name column value.
  • Add a lookup value by clicking Add Values and entering valid values in the Value and Name columns.

  • Hide a lookup value by ticking .
  • Remove a lookup value from the list by clicking .

For lookup fields that are system-defined, you can do the following:

  • Edit the display name of a lookup field by updating the Name field.
  • Edit the display name of a lookup value by clicking in the Actions column of the Lookup Values table and updating the Name column value.

To search for an item on the Lookup page, enter a keyword for a Lookup Field or Name.

You can input a valid lookup field to search for an itemv or you can input a partial lookup name to search for an item.

Filter

The following filters are available:

  • Description
  • Lookup Field

Sort

The following columns on the list view can be sorted:

  • Lookup Field
  • Name
  • Numeric Value
  • System Defined