Managing User Preferences

You can use preferences to store values for a specific Application Express user across distinct sessions. Once set, these preferences can be removed programmatically or manually. You can set user preferences by creating a page process, by the calculation of a preference Item Source Value, or programmatically by using a PL/SQL API.

Topics:

Viewing and Resetting Preferences for the Current User
Viewing Preferences by User
Setting User Preferences
Removing User Preferences Programmatically
Resetting User Preferences Using a Page Process
Purging Preferences for a Specific User

Viewing and Resetting Preferences for the Current User

To manage user preferences for the current user:

Navigate to the Workspace home page.
Click Manage Services on the Administration list.

The Manage Services page appears.
Under Session State, click Manage Preferences.

The Manage Preferences page appears.
To view preference information about the current user, click Report Current User Preferences.

The Current User Preferences page appears.
To view and reset preferences for the current user, click Purge Preferences for Current User. On the Purge Preferences page, click the appropriate button:
- Reset Preferences
- View Preferences

Viewing Preferences by User

To view the preferences for specific users:

Navigate to the Workspace home page.
Click Manage Services on the Administration list.

The Manage Services page appears.
Under Session State, click Manage Preferences.

The Manage Preferences page appears.
To view preference information about a specific user, click Preferences by User.

Use the search bar at the top of the page to narrow the display.
To view and reset preferences for the current user:
1. Click Purge Preferences by User.
2. Select a user from the list and click Report.
  
  A report appears.
3. To purge user preferences, click Purge User Preferences.

Setting User Preferences

You can set user preferences within your application through the creation of a page process, by creating a preference item, or programmatically.

Topics:

Setting User Preferences Using a Page Process
Setting the Source of an Item Based on a User Preference
Setting User Preferences Programmatically

Setting User Preferences Using a Page Process

To set user preference values by creating a page process:

Navigate to the appropriate Page Definition. See "Accessing a Page Definition" in Oracle Application Express Application Builder User’s Guide.
Under Processes, click the Create icon.

The Create Page Process Wizard appears.
For the process category, select Session State.
For the process type, select one of the following:
- Set Preference to value of item
- Set Preference to value of item if item is not null
Specify a process name, sequence, and processing point.
Specify the preference value in the field provided using the format:
```
PreferenceName:Item
```
Click Page Items to see a list of available items.
Click Create Process.

Setting the Source of an Item Based on a User Preference

You can set the source of an item based on a user preference by defining the item source type as Preference.

To define the source of item based on a user preference:

Navigate to the appropriate Page Definition. See "Accessing a Page Definition" in Oracle Application Express Application Builder User’s Guide.
Under Items, click the Create icon.

The Create Item Wizard appears.
For the item type, select Hidden.
Specify the Item Name, sequence, and region.
From the Item Source list, select Preference.
In Item Source Value, enter the name of the preference.
Click Create Item.

Setting User Preferences Programmatically

To set or reference user preferences programmatically, you must use a PL/SQL API. User-level caching is available programmatically. You can use the SET_PREFERENCE procedure to set a user level preference called NAMED_PREFERENCE. For example:

APEX_UTIL.SET_PREFERENCE(
 p_preference=>'NAMED_PREFERENCE',
 p_value =>:ITEM_NAME);

You can reference the value of a user preference using the function GET_PREFERENCE. For example:

NVL(APEX_UTIL.GET_PREFERENCE('NAMED_PREFERENCE'),15)

In the previous example, the preference would default to the value 15 if the preference contained no value.

Removing User Preferences Programmatically

To remove user preferences programmatically, you must use a PL/SQL API. You can use the REMOVE_PREFERENCE procedure to remove a user level preference called NAMED_PREFERENCE. For example:

APEX_UTIL.REMOVE_PREFERENCE(
p_preference=>'NAMED_PREFERENCE');

Resetting User Preferences Using a Page Process

You can reset user preferences by creating a page process and selecting the Reset Preferences process type.

To reset user preferences using a page process:

Navigate to the appropriate Page Definition. See "Accessing a Page Definition" in Oracle Application Express Application Builder User’s Guide.
Under Processes, click the Create icon.

The Create Page Process Wizard appears.
For the process category, select Session State.
From Type, select Reset Preferences.
Specify a process name, sequence, and process point.
Follow the on-screen instructions.

Purging Preferences for a Specific User

You can purge preferences for a specific user on the Purge Preferences page.

To purge preferences for a specific user:

Navigate to the Workspace home page.
Click Manage Services on the Administration list.

The Manage Services page appears.
Under Session State, click Manage Preferences.
Click Purge preferences by User.

The Purge Preferences page appears.
Select a specific user and click Report.

A report appears at the bottom of the page.
To purge the displayed user preferences, click Purge User Preferences.