Managing PeopleSoft Personalizations

This chapter provides an overview of personalizations and discusses how to:

• Work with personalization options.

• Define personalization options.

• Work with category groups.

• Work with categories.

• Work with locale-based personalizations

• Add personalizations to permission lists.

• Create custom personalization options.

• Work with the My Personalizations interface.

Understanding Personalizations

PeopleSoft software offers a variety of options that enable end users, especially power users, to complete business transactions in a more efficient manner. These options improve a user's navigation speed through the system and enable users to select international preferences, such as date and time formats. You select, customize, and define personalizations using the Personalization pages.

To access the Personalization pages, select PeopleTools, Personalization.

Personalizations are grouped in three levels of categories to aid in development, organization, and deployment:

• The first level is the Option Category level.

  This level divides personalizations between functional area, such as PeopleTools personalizations and HCM personalizations. Also, there is a category for custom personalizations, which are those personalizations you develop and deploy in addition to the delivered personalizations.

• The second level is the Category Groups, which represent individual products within a Category Level.

  For example, within the PeopleTools Category Level some Category Groups are Application Designer, Process Scheduler, Security, and so on. Or, within the HCM Category Level one Category Group could be Payroll.

• The third level is the Personalization Categories themselves.

  This is the level that the end user sees. A category represents a product feature, such as navigation or system messages. A category contains a set of related personalizations.

After you have selected the personalizations for your site, you assign them to a user or role, using the Personalizations page of the permission lists component in PeopleTools Security. The Personalizations page enables the security administrator to assign role-based personalizations and enable user control for selected personalization options, if needed.

End users can view and modify their available personalization options from the My Personalization component (USER_SELF_PERSONAL).

The following sections provide more details on defining, customizing, and deploying PeopleSoft personalizations.

Working with Personalization Options

Before you begin defining and deploying personalization options, you need to be familiar with the personalization option categories delivered with PeopleSoft software, and the pages used to view and modify them. This section discusses:

• Navigation personalizations.

• Regional settings.

• General options.

• System messages.

• Internally controlled options.

• Pages used to define and modify personalizations.

Note. PeopleSoft Mobile applications use the standard personalizations.

PeopleSoft Mobile Agent is a deprecated product. Mobile personalization features exist for backward compatibility only.

Understanding Navigation Personalizations

The following table presents the delivered navigation personalization options.

Note. PTPT1000 is a delivered permission list that you can use as a starting point for a user permission list. The column shows whether PTPT1000 allows a user to set the option.

Understanding Regional Settings

The following table presents the delivered regional settings.

Note. PTPT1000 is a delivered permission list that you can use as a starting point for a user permission list. The column shows whether PTPT1000 allows a user to modify the option.

Locale-Based Regional Settings

Some of the regional settings, as noted in the table, are locale-based. Their values can be determined based on the locale setting of the user's browser. Because this is one of three sources that can determine which value applies, it's important to understand which source takes precedence:

• In the Define Personalizations component (PSUSEROPTNDEFINE), you can specify default values for locale-based settings, which apply in the absence of any overriding setting.

• The user's browser locale setting is used by the PeopleSoft system to invoke the default values of regional settings for that locale, which you can configure on the Locale Defaults page. Each setting for which you configure a value overrides any default value that's specified for that setting in the Define Personalizations component.

• If a user specifies a value for a locale-based setting in the My Personalizations component, that value overrides any value configured for that setting for the user's browser locale on the Locale Defaults page. That value also overrides any default value that's specified for that setting in the Define Personalizations component.

See Also

Working with Locale-Based Personalizations

Understanding General Options

The following table presents the delivered general options.

Note. PTPT1000 is a delivered permission list that you can use as a starting point for a user permission list. The column shows whether PTPT1000 allows a user to modify the option.

See Also

Using Portal Caching Features

Understanding System Messages

System messages are those that the system displays for the user when certain events occur, such as a save or a request to view another page. The following table presents the options for system messages.

Note. PTPT1000 is a delivered permission list that you can use as a starting point for a user permission list. The column shows whether PTPT1000 allows a user to modify the option.

Understanding Internally Controlled Options

Internally controlled personalization options are different from the other personalization option categories. Although they're defined in the Define Personalizations component (PSUSEROPTNDEFINE), they never appear in My Personalizations, even if you assign them to a permission list.

Instead of accessing these options in My Personalizations, users access and configure them at other locations; the location depends on the individual option. These options are always enabled and can't be disabled, but you can specify their default settings in the Define Personalizations component.

Query Preferences

You specify the default values of the Query preference options in the Define Personalizations component, and individual users can modify those values in Query preferences. The following personalization options are used by PeopleSoft Query:

See Specifying Query Preferences.

Portal Preference

The following personalization option is used by PeopleTools portal technologies:

Tree Manager Preference

The following personalization option is used by PeopleSoft Tree Manager:

Pages Used to Define and Modify Personalizations

Defining Personalization Options

This section provides an overview of the Search page and discusses how to:

• Use the Definition tab.

• Use the Format tab.

• Use the Explanation tab.

Note. Adding personalization options involves setting up your options in the Personalizations component, implementing the behavior using PeopleCode, and adding the appropriate permissions through PeopleTools Security. Adding a row to the table using the following interface is only one part of the process.

Understanding the Search Page

To access the personalization definition pages, select PeopleTools, Personalization, Personalization Options. On the search page, you have the option to search by Option Category Level or Description. If you select Option Category Level and click Search, the following result set appears:

• Customer Relationship Management (CRM).

• Custom (CSTM).

• Enterprise Performance Management (EPM).

• Financials (FIN).

• Human Resources (HCM).

• Learning Solutions (LS).

• PeopleTools (PPTL).

• Supply Chain Management (SCM).

Note. These are the only available Option Category Levels. You can't add custom Option Category Levels.

This list corresponds directly to the collection of PeopleSoft applications. In addition, there is a Custom category where you store any personalization options you create for applications you have built using PeopleTools. You can also add, or extend, the personalizations for each category. For example, if you wanted to add a new personalization to the HCM category, you add it to the list and define it.

This high-level separation of the personalization options enables you to take a modular approach in deploying the options to your user base. It also helps you to avoid collisions by separating equivalent personalization options by application. For example, you can assign different default values for the same personalization for your Human Resources and Financials applications.

Before adding or modifying personalizations, you select the appropriate category. For example, for CRM personalizations, select the CRM category.

Note. Whether you have installed all of the applications listed in the Option Category Level options, the same category levels appear. Ignore any category levels that do not apply to your site.

You add and modify the delivered personalization options using the Define Personalizations component.

Access the Define Personalization page (PeopleTools, Personalization, Personalization Options). This grid contains the following tabs:

• Definition

• Format

• Explanation

You use this grid to view and to modify the personalizations within the Category Level you selected on the search page.

Using the Definition Tab

Click the Definition tab.

User Option	Displays the code associated with the user option. This is the code that the system (PeopleCode) recognizes at run time.
Description	This is the description of the option that the end user sees on the My Personalizations interface. The description should be unique within the same category. When adding custom personalizations, special attention needs to be paid to this field. Make sure the description is meaningful to end users.
Option Category Group	Specify the product or functional groupings of options. This value acts as an administrative attribute providing ownership for maintenance purposes. It further divides the Option Category Level.
Option Category	Categorizes and encompasses a set of options for the end user. The option you select determines the button the end user clicks to view and modify the option. You add new Categories using the Category page.
User Option Type	Enables you to set where an option is exposed to the end user for override purposes. There are two options: Functional: Options that users set within an application or tool, such as the Application Designer preferences. Functional personalizations are not exposed to the end user through the personalizations pages. If the users have access to the tool or component, then they are able to override the settings. System: Options that are exposed directly to the user through the personalization pages. A user can override default values if permission lists grant they authority.
Locale Based	Indicates that the option derives the default values based on the Locale of the browser.

To add an option, use the insert row (+) button. To delete an option, use the delete row (-)button.

Note. If you add any custom values for these fields, complete all the appropriate planning beforehand. There is no built-in mechanism to prevent collisions.

Note. In the My Personalizations interface, end users see only options that posses the following attributes: the User Option Type is set to System, and permission to override that option is granted by one of the users' assigned permission lists.

Using the Format Tab

Click the Format tab.

User Option	Shows the code associated with the option.
Field Format and Field Format Length	Specify the field characteristic of the option. Used for the Option Default Value for options that are not validated against the database.
Record (Table) Name	Specifies the lookup table that holds the personalization options values.
Field Name	Specifies the field on the lookup table containing the valid option values.
Option Default Value	Shows the current default for the option. This value is set through the Set Option Default Value.
Set Option Default Value	This is a link to the secondary page used to set Option Default Values.

Set Option Default Value

The following items appear on the Set Option Default Value page:

Using the Explanation Tab

The Explanation tab enables you to reference the message text and the image (if needed) that the end user sees after clicking the Explain button in the My Personalizations interface.

If you are adding a custom personalization, you'll need to create the message in the message catalog and create the image (if needed).

Click the Explanation tab.

User Option	Displays the code associated with an option.
Message Set Number	Specify the message set containing the message that contains the explain text.
Message Number	Specify the message number of the message containing the explain text.
Image Name	Points to the image that the system presents to the end user to provide clarification and context for the personalization. For example, for the "Tab over add button" option, the image of the add button is included so the user can recognize the object.

Working with Category Groups

Category groups can represent products, such as Query or Tree Manager, or functional groupings. A category group is an attribute that enables you to designate ownership of personalizations for administrative duties, such as maintenance.

Note. By default, all options created within the category level of Custom appear in the Custom category group.

Access the Category Group page (PeopleTools, Personalization, Category Groups).

Option Category Group	Displays the name of the category group.
Object owner identifier	Displays the name of the group responsible for the maintenance of the category group.
Description	Provides a description of the category group for identification purposes. This field has a 30-character limit.

Working with Categories

Categories are the way that you group and present personalization options to your end users. For example, for the Navigation option category, the end user sees the description (Navigation Personalizations) on the My Personalizations page. When the end user clicks the adjacent Personalize Options button, they access the options you have grouped in the Navigation category.

Access the Category page (PeopleTools, Personalization, Categories).

Option Category	Shows the name of the category in which options are displayed on the My Personalizations page.
Object owner identifier	Displays the name of the group responsible for the maintenance of the category group.
Description	Provides a description of the category for identification purposes. This field has a 30-character limit. Important! This is the text that appears on the My Personalization page. If you add custom categories make sure the text is meaningful for end users.

Working with Locale-Based Personalizations

Locale-based personalizations enable you to handle settings for globalization. Locale-based personalizations are treated separately than the other personalizations.

You use the following pages to manage these personalization options:

• Locale Definition.

• Locale Defaults.

The system derives the locale information based on the locale specified in the browser. PeopleSoft software provides these pages populated with the codes that represent the current browser locales.

This topic is discussed in more detail in the PeopleTools 8.52: Global Technologies PeopleBook.

See Also

Setting Up Locale-Based Formatting for the PeopleSoft Pure Internet Architecture

Adding Personalizations to Permission Lists

You assign personalizations to users by way of permission lists in PeopleTools Security. Before doing so, make sure you have added or modified all the necessary personalizations in the Define Personalizations pages. PeopleTools Security only recognizes personalizations that have been defined in the Define Personalizations interface. This topic is covered in the PeopleTools Security documentation.

See Also

Setting Personalization Permissions

Creating Custom Personalization Options

Creating custom personalization options involve the following steps:

1. Define the option using the Define Personalization interface.

   See Defining Personalization Options.

2. Implement the behavior using PeopleCode personalization options (discussed in the following section).

   See Working with the My Personalizations Interface.

3. To enable users to control the personalization, you need to make the option accessible on the appropriate permission list through PeopleTools Security.

Personalization PeopleCode Functions

There are two PeopleCode functions related to personalizations. These functions are:

• GetUserOption.

• SetUserOption.

If you intend to modify or create custom personalizations, you may need to employ the use of these functions. Refer to the PeopleCode documentation for use and syntax.

See Also

PeopleCode Built-in Functions

Working with the My Personalizations Interface

This section discusses how to:

• Use the Personalizations page.

• Set personalize options.

• Use the Personalization Explanation page.

• Modify a personalization option.

Using the Personalizations Page

Select My Personalizations to access the Personalizations page.

Description	The description column contains a brief description for identifying a particular category of personalization options.
Personalize Options	Click this button to view and modify the options within a category.
Restore Defaults	Click this button to restore the default values for all options in each personalization category. Defaults refer to the initial values that your system administrator has set for each available option—before you modified the option. So, you only use this feature if you have modified one or more personalization option and you want to revert to the initial settings.

Setting Personalize Options

Access the My Personalizations - Personalize Options page (From the homepage, click My Personalizations, then click the Personalize Options button in the General Options row).

Option Category	Shows the description of the category of personalizations. This helps you to make sure that you have the correct category open.
Personalization Option	This column lists all of the personalization options available for you to modify. The text that appears in the list is a brief description of the option. For more information on the option, click the Explain link.
Default Value	Refers to the initial settings that your administrator has specified for the option. If you do not modify the default value, the option assumes the value provided by the system administrator.
Override Value	Enter any custom value you want to assign to the personalization option. To override a default setting means to use the new value in place of the default setting.
Explain	Click this link to view more information on what the personalization option provides. See the following section for more information on the Explanation page.
Restore Category Defaults	Returns all modified options to the default values. This button applies only to the current category, as in the category you have open.
OK/Cancel	After you have made any modifications, click OK so that the system records your changes. If you do not want your changes recorded click Cancel. If you have not made any changes and just viewed the options, you can use either button to return to the Personalizations page.

Using the Personalization Explanation Page

Access the Personalization Explanation page (click the Explain link on the Option Category page).

Personalization Name	The name of the individual personalization appears at the top of this page so that you can make sure you are viewing or modifying the appropriate option.
Default Value	Shows the value that your system administrator has set as the default value for an option. The personalization assumes the default value unless you override it.
Override Value	Overrides the default value. For example, if the default value for an option is No, you can override the default value to be Yes.
Restore Option to Default	Enables you to change any option value that you've modified to assume the original default value specified by your system administrator.
Explanation	Contains the description of what the personalization option provides when activated. For longer descriptions, use the scroll bar to view. This box is read-only.
Image	In many cases, especially with the Navigation options, an image appears to provide further clarification as to a specific control or item that the option affects. For example, on the explanation page for the Tab Over Toolbar option, an image of the toolbar appears in the image section to show exactly the area on the page that the personalization affects.
OK/Cancel	Returns you to the current Option Category page. If you've made changes to the personalization option that you want to keep, click OK. If you do not want to keep the changes you have made, click Cancel. If you have made no changes, use either button.

Modifying a Personalization Option

The following procedure describes the steps you need to complete to modify a personalization option.

To modify a personalization option:

1. Select My Personalizations from the portal menu.

2. On the Personalizations page, click the Personalize Options button adjacent to the category of personalization options you want to modify.

3. In the Personalization Option list, locate the option you want to modify.

4. In the corresponding Override Value edit box specify the appropriate override value.

   Depending on the option, you will see one of the following controls.

   • A drop-down list box.

     Select the appropriate option from the drop-down list.

   • An edit box.

     Manually enter an override value.

5. Click OK.

   This saves the change to the system.

6. Sign out and then sign in again to view your changes.