Setting Up Lookups

This topic describes how to add and change values that appear in lookup lists. Lookup lists are referenced by various fields in the application that display a static set of values from which the end user can select a value.

Lookup Types and Lookup Values Overview

Lookup types in applications are used to represent a set of codes and their translated meanings. To the end users, a lookup type displays a list of values from which they select values.

You use the Lookup Types page to access lookup types, and you use the Lookup Type Details page to modify lookup types, add lookup values, and add lookup types, where authorized.

When working with lookups, you deal with lookup types and lookup values.

Lookup Element	Description
Lookup Type	A lookup type is a static list of values users view to make entries in the application. The application references a lookup type to display its list of values.
Lookup Value	A lookup value is a single item contained within a lookup type. For example, Paid is a lookup value for the Fee Status lookup type. Lookup types typically contain numerous lookup values.

Lookup types are delivered as seed data for your service. You can only modify selected lookup types, such as Business Type, UOM Type, Standard Code Type, and so on. Most lookup types are read-only.

Modifying Lookup Types

Lookup types can be associated with lookup lists on:

Pages in your offering.
Predefined field groups added to intake forms.
User-defined fields added to intake forms.

Note: Lookup lists created for user-defined fields in an intake form can only be viewed from the Lookup Type page after the form has been published. Managing lookup lists for user-defined fields should be completed only within the Intake Form Designer.

To modify a lookup type:

Select Common Setup > Lookups.
On the Lookup Types page use the Search box to filter the lookup types by keyword.
For example, to view the Business Type lookup type, enter business in the Search box.
Click on the row for the lookup type you want to view.

View the contents of the Lookup Type Details page.

Page Element	Description
Lookup Type	Identifies the lookup type within the application.
Application	Identifies the application that uses the lookup type. For example, Permits, Common Components, and so on.
Meaning	The actual UI display name used to represent the list of values contained in the lookup type.
Configuration Level	Indicates at what level the lookup can be modified. Options are: System: Only Oracle development teams can modify lookup types at this configuration level. Extension: Customers can perform minimal tasks, such as add lookup values. User: Customers can add lookup values, delete lookup values, update the meaning, and update the description.
Module	The internal application module using the lookup type, such as Billing Entry, Billing Setup, and so on.
Description	Identifies the purpose and use of the lookup type.

If you need to add lookup values, refer to the following section for steps for that task.
Click Cancel to close the lookup type, or click Save if you made any changes.

Adding Lookup Values

This example illustrated the Lookup Value Details page. Details are in the surrounding text.

You can add lookup values to lookup types with a configuration level set to User or Extension.

To add lookup values:

Select Common Setup > Lookups.
On the Lookup Types page use the Search box to filter the lookup types by keyword.
For example, to view the Business Type lookup type, enter business in the Search box.
Click on the row for the lookup type you want to view.
On the Lookup Type Details page, click Add under Lookup Value Type.

On the Lookup Value Details page, enter these values:

Page Element	Description
Lookup Code	An internal application code for each lookup value that is not visible to users. It is typically a shorter, less user-friendly representation of the item. For example, ORA_DRIVER_LIC for State Driver’s License, or LEN for Length, if listing units of measurement. Note: Lookup lists created in the designer for user-defined fields on an intake form begin with PSC.
Display Sequence	Control in what sequence the lookup value appears in the list displayed to users, where 2 appears above 3. If you do not specify a sequence, the application displays the items in the order they were entered.
Enabled	Turn on to make a lookup value active. If a lookup value is not enabled, then the application does not display it to the end user in the list of values for that lookup type. Note: It is not recommended to disable lookup values once your implementation is in production because this can invalidate existing transaction data.
Start Date	Set a start date for the lookup value to become active. Even if the lookup value is enabled, if a start date is set, the application does not display the lookup value until the start date is reached.
End Date	Set an end date for a lookup value to no longer be displayed in a list of values.
Meaning	The display name for the lookup value. End users see this value in the list of values displayed at run time. They do not see the Lookup Code value.
Description	Provide any additional information to help identify the purpose of the lookup value or clarification regarding what it represents.
Tag	Tags allow you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.

Click Save.

Working with Configuration Levels

The configuration level attribute determines who can modify a lookup type and what can be modified. The configuration levels are:

System: Only Oracle development teams can modify lookup types at this configuration level.
Extension: Customers can perform minimal tasks, such as add lookup values.
User: Customers can add lookup values, delete lookup values, update the meaning, and update the description.

Task	User	Extension	System
Add a lookup type	Yes	No	No
Delete a lookup type	Yes	No	No
Modify lookup type meaning	Yes	No	No
Modify lookup type description	Yes	No	No
Add lookup values	Yes	Yes	No
Delete lookup values	Yes (if you created it)	Yes (if you created it)	No
Modify lookup value attributes	Yes (except for Lookup Code)	Yes (if you created it, and except for Lookup Code)	No

Note: You can add values to lists defined in the designer for user-defined fields. Values entered through the Lookup Type page become available at runtime as soon as they are saved. Values added to lookup lists through the Intake Form Designer display at runtime only after the intake form is published.

Adding Lookup Types

To add a lookup type:

Select Common Setup > Lookups.
On the Lookup Types page click Add for the Lookup Type grid.
On the Lookup Type Details page, enter these values:
- Lookup Type (The value you enter must be uppercase and can’t begin with the prefix ORA_, which is used to distinguish your custom lookup types from delivered lookup types.)
- Meaning
- Module
- Description
Click Add for the Lookup Value grid for each lookup value you need to add to the lookup type.
Click Save.