Working with Common Components

This chapter provides an overview of PeopleSoft HRMS common components and discusses how to:

Configure direct reports functionality.
Configure person search.
Configure the HR notepad.
Set up the text catalog.

Understanding PeopleSoft HRMS Common Components

This section lists common elements and discusses common component pages.

Common Elements Used in this Chapter

Object Owner ID	Identifies the application in which a common component is used. You must configure the component to enable the application before the application can call the component.
Sub ID	Used to further partition application entries by function. This field is called Sub Application in the Invoke Person Search API page.

Common Component Pages

PeopleSoft provides common pages to perform functionality across multiple Human Capital Management (HCM) applications. These pages are implemented as plug-in applications that you can easily configure and imbed into a application via provided APIs.

These applications are typically used to capture, store and present information for a particular generic function within the context of a calling application (for example, a application such as eRecruit, ePerformance or Benefits Administration).

Data Structures

Each plug-in application manages its own data source. All applications that embed the plug-in share the same data structure that uses a configurable key structure to accommodate the different requirements that each application has for organizing this data. Each application defines, or registers, the actual keys that are used when the plug-in runs within the context of the application that has embedded it. You register the keys by making an entry for the application in the plug-in's configuration page, which is keyed by the object owner ID of the embedding application.

User Interface

The use of plug-ins enables all applications that embed a plug-in to present the data consistently. For example, the same format is used to capture and present context-sensitive notes, whether the user is in eRecruit, ePerformance, Payroll for North America, or Benefits. To provide context-sensitive instructional text, labels, and so forth, each of the plug-in applications uses the text catalog to provide context sensitivity while maintaining a consistent style across all of HCM.

Configurable Behavior

Some embedding applications need the ability to enable, disable, or modify the plug-in functionality. Applications register these configuration options inside the plug-in's configuration page—the same place it registers its keys.

HCM plug-ins, except the text catalog, are embedded in an application by placing a graphic button on a page, and a simple API call on the button's FieldChange PeopleCode. The Text Catalog is generally invoked via an API in component-build, and/or PageActivate code.

Warning! Be careful when modifying configurations. PeopleSoft does not support some modifications, for example changing key values, that might cause other functionality in the application to not work as intended.

Configuring Direct Reports Functionality

To configure direct reports functionality, use the Configure Direct Reports UI (HR_DR_UI_CFG) and component.

This section provides an overview of direct reports and discusses how to:

Configure components and transactions for direct reports functionality.
Select the actions and fields that appear on the direct reports UI.
Test the direct reports API.
View exceptions and data returned by a method.
View the trace log of method executions.
Test the direct reports user interface.

See Also

Generating Documents for Direct Reports

Understanding Direct Reports Functionality

Direct reports information is used throughout HCM applications, especially in the manager self-service applications. Typically, direct reports information is used in a way that involves navigating an organizational hierarchy. You can use direct report information in:

Drill-down mode, enabling managers to select workers for processing in a self-service application.
Chain of command mode, which determines workflow for approvals and notifications.

There are two major components that implement direct reports functionality:

Data service.

The data service navigates an organization structure and returns a list of workers that report to a particular manager or a management hierarchy for a particular worker. The data service is completely unaware of its context, which enables to service both online and batch requests.
User Interface.

This is a common, configurable user interface (UI) that is totally de-coupled from data management. It receives information from the data service and presents it in a streamlined, consistent, reusable UI that enables users to visually navigate an organization structure and select one or more workers for processing.

Note. You should have a good understanding of PeopleTools and PeopleCode before you attempt to configure direct reports for use by applications.

Direct Reports for Self Service Applications

There are two methods of setting up direct report functionality. If you are setting up direct reports for the following applications, use the Direct Reports Setup (SS_LINK_TBL) component:

PeopleSoft Enterprise eDevelopment
PeopleSoft Enterprise eCompensation
HRMS Portal Pack
PeopleSoft Enterprise ePay
PeopleSoft Enterprise Stock Administration

Note. Otherwise, use the Configure Direct Reports UI component described in this section.

Pages Used to Configure Direct Reports Functionality

Page Name	Object Name	Navigation	Usage
Manager Desktop Transactions	HR_DR_UI_CFG_1	Set Up HRMS, Common Definitions, Direct Reports for Managers, Configure Direct Reports UI, Manager Desktop Transactions	Configure the components and transactions that include the direct reports data functionality.
Configure Direct Reports: Configure	HR_DR_UI_CFG_2	Set Up HRMS, Common Definitions, Direct Reports for Managers, Configure Direct Reports UI, Manager Desktop Transactions Click the Configure button for an application on the Configure Direct Reports UI page.	Select the actions and fields that appear on the direct reports UI for a transaction.
Invoke Direct Reports API - Set/Execute	HR_DRPT_API_EXEC	Set Up HRMS, Common Definitions, Direct Reports for Managers, Invoke Direct Reports API, Set/Execute	Test the direct reports API.
Invoke Direct Reports API - Execution Results	HR_DRPT_API_RSLTS	Set Up HRMS, Common Definitions, Direct Reports for Managers, Invoke Direct Reports API, Set/Execute Select the Execution Results tab on the Invoke Direct Reports API - Set/Execute page.	View the exceptions and data returned by a method.
Invoke Direct Reports API - Trace Results	HR_DRPT_API_TRACE	Set Up HRMS, Common Definitions, Direct Reports for Managers, Invoke Direct Reports API, Set/Execute Select the Trace Results tab on the Invoke Direct Reports API - Set/Execute page.	View the trace log of a method execution.
Invoke Direct Reports UI API	HR_DRPT_API_UITEST	Set Up HRMS, Common Definitions, Direct Reports for Managers, Invoke Direct Reports UI API, Invoke Direct Reports UI API.	Test the direct reports user interface.

Configuring Components and Transactions for Direct Reports Data Functionality

Access the Manager Desktop Transactions page.

Displays a list of components and transactions for which direct reports functionality is enabled. You can add a new component and transaction or click the Configure button to specify how the direct reports API and UI function within the context of the component and transaction.

Selecting the Actions and Fields that Appear on the Direct Reports UI

Access the Configure Direct Reports: Configure page.

Processing Rules

Access Type	Select the reporting relationship to use for determining who reports to whom. This field defines the reporting relationship used by the Select Employee page for this transaction component and determines which method is used to identify who approves the transaction. Available options are: By Department Manager ID: Defines the reporting relationship based on information in the Manager ID field on the Department Profile page (DEPARTMENT_TBL_GBL ). For users who are department managers, the system displays a list of the workers who are in the user's department. By Dept Security Tree: Determines person data access using information from the security tree. The system presents the user with a list of people whose data the user has access to, based on the security tree. By Group ID: Determines data access using the Group ID set up in the group build feature. By Part Posn Mgmt Dept Mgr ID: Defines the reporting relationship by the Reports To field on the Work Location page (JOB_DATA1) and the information in the Manager ID field on the Department Profile page. This is designed for the organizations that use Partial Position Management. The system searches for reporting relationship based on Report To first, and then for Department Manager ID. By Part Posn Mgmt Supervisor: Defines the reporting relationship by both the Reports To and the Supervisor ID fields on the Work Location page. This is designed for the organizations that use partial Position Management. The system searches for reporting relationship based on Report To first, and then for Supervisor ID. By Reports To Position: Defines the reporting relationship based on information in the Reports To field on the Work Location page. The system presents the user with a list of people whose job record indicates that they report to that user's position. By Supervisor ID: Defines the reporting relationship based on information in the Supervisor ID field on the Work Location page. The system presents the user with a list of people whose job records indicate that they are supervised by the user.
Update Own Info	Select to indicate that the user can update their own records. When you select this check box, the user's information is returned in the results list along with their direct reports or management hierarchy.
Allow Indirect Reports	Select to return indirect reports of the user. This navigates down the organizational hierarchy and returns direct reports of direct reports and so forth until the lowest reporting level is reached.
Select Multiple Employees	Select to enable the user to select more than one worker from the search results. If this field is selected, a check box appears next to the names in the results list, otherwise a radio button appears. Note. You should not modify this value on delivered transactions, as they are built for selection of single or multiple values and if you change the setting, the transaction might not work.
Force Group Refresh	Select to run the Group Build process (GBP002 ) to refresh the group membership prior to displaying direct reports. If you do not select this check box, the group members as of the last scheduled run of the process appear on the page. The system only makes this check box available if you select the access type By Group ID.

Displayed Fields

Select one or more fields to appear on the direct reports list within when rendered by the application.

Testing the Direct Reports API

Access the Set/Execute page.

Class Method

Select a method from the available options:

GetSupervisor()

Gets the supervisor for the target worker. This method is useful if the application needs to determine the target worker’s supervisor, but not the supervisor’s direct reports. For example, to send a notification to an worker’s supervisor, the application must determine the identity of the supervisor.

DrillDown()

Logically navigates down one level in the reporting structure to expose all of the direct reports for the worker . This is the most common use of the application class — this method returns the direct reports for an worker/job.

DrillUp()

Logically navigates up one level in the reporting structure to expose the worker's supervisor and all the supervisor’s direct reports.

GetPeers()

Invokes the GetSupervisor() method for the target worker, and then invokes DrillUp() to expose all of the direct reports for this supervisor (which is the same as returning all the peers for a particular person).

Execute Method

Click to execute the method using the class properties you set.

Class Properties

The properties and their default values, if any, of the selected class appear in this page region. You can change any of these before executing the method.

Viewing Exceptions and Data Returned by a Method

Access the Execution Results page.

This page enables you to view results of the method execution.

Viewing the Trace Log of Method Executions

Access the Trace Results page.

Data appears on this page only if you select True for the Trace class property.

Testing the Direct Reports User Interface

Access the Invoke Direct Reports UI API page

Select a Component Name and click Execute API. The direct reports plug-in executes within the context of the component and returns the results to the API Results grid.

For example, the results shown above were returned by selecting Cynthia Franks from within the Location Change component.

Configuring Person Search

To configure the person search, use the Configure Person Search (HR_PSS_CONFIG) component

This section provides an overview of simple person search and discusses how to:

Configure components for simple person search.
Test simple person search.

Understanding Simple Person Search

This page enables users of an application to search for and select a person to process. Using this application, an application can easily render a UI that prompts the user for partial names and displays a list of candidates from which the user can select. Additional features include optional drill-down to additional non-sensitive data.

Pages Used to Configure Simple Person Search

Page Name	Object Name	Navigation	Usage
Configure	HR_PSS_CONFIG	Set Up HRMS, Common Definitions, Person Search Match, Configure Simple Person Search, Configure	Configure components for simple person search.
Invoke Person Search API	HR_PSS_TEST_API	Set Up HRMS, Common Definitions, Person Search Match, Invoke Person Search API, Invoke Person Search API	Test the simple person search within the context of an application.
Person Search - Simple	HR_PSS_SEARCH	This page is invoked from several calling applications.	Search for and select a person.

Configuring Components for Simple Person Search

Access the Configure page:

You select the options that govern how an application searches for and returns person information on the Simple Person Search page within an application.

Maximum # of Results Rows	Enter the maximum results rows to return to the calling application. Any rows that meet the search criteria are returned and appear in the results list. If a search returns more than the maximum number of rows is found, the user prompted with a message that the search returns more than the maximum number of people and asking them to narrow the search.
HR Status	Select one of these values: Hidden HR status values for the persons found by the search do not appear in the results list. Display Only HR status values for the persons found by the search appear in the results list. Enterable Enables the user to search by HR status values. These appear as check boxes on the Person Search page.
HR Status Active	Select to return rows for active workers. This check box is selected by default.
HR Status Inactive	Select to return rows for inactive workers.
Select Multiple Employees	Select to enable the user to select more than one person from the search results. If you select this field, a check box appears next to the names in the results list, otherwise a radio button appears.
Alternate Character Names	Select to enable the user to search for names by entering the search string in alternate character format. If you configured the system to enable the entry of names in alternate character format, this check box is selected by default.
Expose Employee IDs	Select to have the person's ID appear in the results details. This field is clear by default.
Per Org(Person Organizational Relationship)	Select one of these values to control how the person's relationship to the organization is used on the Person Search page: Hidden The organization relationship do not appear in the results list. Display Only The organization relationship appears in the results list. Enterable Enables the user to select the person organization relationships to include in the search. These appear as check boxes on the Person Search page.
Employees	Select to return employees in the search results. This field is selected by default.
Contingent Workers	Select to return contingent workers, for example, temps or contractors, in the search results. This field is clear by default.
Persons of Interest	Select to return other persons of interest, for example, retirees or job applicants, in the search results. This field is clear by default.

See Also

Organizational Relationships

Testing Simple Person Search

Access the Invoke Simple Person Search page.

This page enables you to test the configuration of the Simple Person Search page within the context of an application and sub application that you select. When you click Execute API the search page is rendered as you configured it for the application. You can enter any search criteria to view how the results appear.

Configuring the HR Notepad

To configure the HR Notepad, use the HR Notepad Configuration (HR_NP_CONFIG) component.

This section provides an overview of the HR Notepad and discusses how to:

Configure HR Notepad for application use.
Set up keys for storing notes.
Configure application note page links.
Test the Notepad configuration.

Understanding the HR Notepad

A notepad is a logical grouping of text-based notes, or a collection of notes that a user has entered within the context of an application. For example, an employee might have a performance notepad within the context of ePerformance, and a manager might have a recruiting notepad within the context of eRecruit.

You can integrate the plug-in application that maintains the HR Notepad (Notepad) into any HCM application. This application enables the user to record logical notes that are relevant to a row of application data. A common data structure, partitioned by application, is used to store notes.

The Notepad provides a consistent user interface (UI) that enables users to create, edit, view, and delete text-based notes. The Notepad UI is a single component that contains two pages for selecting and maintaining notes, a secondary page for displaying warnings and errors, and a secondary page for viewing note history. All text elements on the pages are defined in the text catalog, which enables you to easily configure the pages. You can enable access to Notepad functions from within an application’s online components or directly from the application or menu.

Although the Notepad UI is consistent across all applications, detailed Notepad presentation and behavior specific to a given application are defined in a configuration table entry for the application. This entry defines the behavior of the Notepad UI and the keys that are used for the particular application. You can use this configuration table to integrate the Notepad pages into applications for which PeopleSoft does not currently deliver Notepad functionality, add Notepad functionality to applications that you build with PeopleTools, or modify the appearance of Notepad pages.

Pages Used to Configure the HR Notepad

Page Name	Object Name	Navigation	Usage
HR Notepad Configuration - Select Application	HR_NP_CONFIG_HDR	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure HR Notepad, HR Notepad Configuration	Configure the HR Notepad for use by an application.
HR Notepad Configuration - Configure Keys	HR_NP_CONFIG2	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure HR Notepad, HR Notepad Configuration Click the Configure link for an application on the HR Notepad Configuration page.	Set up the keys for storing notes.
HR Notepad Configuration - Configure Links	HR_NP_CONFIG3	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure HR Notepad, HR Notepad Configuration Click the Configure link for an application on the HR Notepad Configuration page.	Configure the links that appear on application note pages.
Invoke HR Notepad API	HR_NP_TEST_API	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure HR Notepad, HR Notepad Configuration	Test the notepad configuration.

Configuring the HR Notepad for Application Use

Access the HR Notepad Configuration - Select Application page.

Privacy

Select from these options:

Private: Only the owner of the note can access the note.

Others Can View: Anyone can view existing notes in this partition, but only the note owner can update an existing note.

Others Can Edit: Anyone can view and edit existing notes in this partition.

Allow Deletions

Select to permit users delete a notes.

Allow Transfers

Select to permit users who entered and therefore are the owner of a note to transfer ownership of a note to another individual.

Audit

When selected, this check box enables the Audit Changes feature for the partition. The system will automatically retain a history of all changes made to existing notes, including transfers and deletions.

Configure

Click to access to the Configure Keys page.

Setting Up Keys for Storing Notes

Access the HR Notepad Configuration - Configure Keys page.

This page consists of four regions, one for each of the context keys. The description and use of these fields are identical to the Key 1 fields described below.

Key 1 Used	Select to indicate that the partition uses this particular context key. When selected, all of the controls in the Key 1 page region are enabled.
Key 1 Prompt Table	Select the table that is used to provide a prompt list and validate the entry when a user enters a value into the Key 1 search field in the UI.
Key 1 Prompt Field	Select the field within the prompt table that is used to provide the values in the prompt list. You must enter a value in this field if you enter a value in the Key 1 Prompt Table field.
Key 1 Display Field	Select the field in the prompt table that appears in the UI as a related field for the value of Key 1. This field is optional. If not specified, then there is no related-display field for the context key. For example, you do not specify a Display Field for a date or number context key.
Hidden	Select to indicate whether this key field is exposed on the UI pages. This field is selected by default.
Required	Select to indicate that this key field is required when adding a note. This field is clear by default.
Enterable	Select to indicate that the user is permitted to enter a value into this key field in the UI search criteria. This field is selected by default. You might clear this field in cases which the key is automatically populated by the API and exposed on the UI, but you do not want the user to change it.
Required for Query	Select to indicate that the user must populate the key in the UI search criteria to see the list of notes that meet the search criteria, or to add a new note. This field is clear by default.
Display in Grid	Select to display the context key value in the list of notes that meet the search criteria. You usually select this check box for any context key that has Required for Query cleared.

Configuring Application Note Page Links

Access the HR Notepad - Configure Links page.

Use this page to define the navigation that takes place when the user clicks one of the navigation links at the bottom of the Notepad UI.

Link Field Name	Select the name of the navigational link. The prompt table for this field is a view of the four navigational fields that are provided on the Note Detail UI. If you do not add a row for a link in the prompt table, the link does not appear on the UI for the application.
Menu Name	Select the name of the menu to which the user is transferred when they click the link. The prompt table for this field is a view of all menus in the database.
Bar Name	Select the name of the menu bar to which the user is transferred when they click the link. The prompt table for this field is a view of all menu bars for the menu specified in the Menu Name field.
Bar Item Name	Select the name of the menu bar item to which the user is transferred when they click the link. The prompt table for this field is a view of all items for the menu bar specified in the Bar Name field.
Panel Item Name	Select the name of the page to which the user is transferred when they click the link. The prompt table for this field is a view of all pages for the bar item specified in the Bar Item Name field.
Mode	Select the operation mode for the page from the values Add, Update/Display, and Correction.

Testing the Notepad Configuration

Access the Notepad API page.

Use this page to test the Notepad configuration for an application and sub-ID, if applicable.

The application keys that appear on this page are the ones that are defined for the Object Owner ID and Sub-ID. When you first access this page, only the Object Owner ID field is enterable. After you enter the Object Owner ID, the Sub-Id field is populated with any sub ids for the application. The application keys that appear correspond to the application keys that you configure on the HR Notepad Configuration - Configure Keys page

API Method

Select the method to test.

Add()
Edit()
InvokeNotepad()
View()

Execute API

Click to execute the API method with the keys you entered.

Setting Up the Text Catalog

To set up the text catalog, use the Configure Text Catalog (HR_SSTEXT_CFG) and Translate Text Catalog (HR_SSTEXT_TEXT) components.

This section provides an overview of the text catalog, lists common elements, and discusses how to:

Configure the text catalog.
Designate keys for text catalog entries.
Define text catalog entries.
View text catalog entries as HTML.
Define translation for text catalog entries.
Test text retrieval.
View effective dates and context keys for a text ID.

Understanding the Text Catalog

The Text Catalog feature stores standard text that appears on the self-service pages within HRMS applications, including field labels, button names, links, page instructions, and warnings. It also includes the text and subject lines of automated email notifications. PeopleSoft HCM provides predefined text entries, but you can modify them by using the Text Catalog feature.

Entries in the Text Catalog feature are context-sensitive, meaning that a particular piece of text on a page can vary depending upon the page's usage or context. In this way, For example, instructional messages that appear for managers can differ from the messages that appear for workers.

Text Catalog Keys

Context-sensitivity is accomplished through the use of keys that enable the application to retrieve applicable text catalog entries. The keys for each application differ to meet the needs of the application.

Although you can have multiple versions of the same text, you do not have to set up a separate entry for every possible scenario. You can create one generic entry where all key values are blank, and then add entries for the situations that vary from the norm. Blank key values function as wildcards.

Warning! When the system looks for a match, it stops searching if the search keys narrow the possible choices to a single row—the lower-order search keys are ignored. If you do not set things up correctly, the system may return the wrong results. Plan ahead before making changes, particularly for complex scenarios. Random changes can lead to errors that are difficult to debug later.

You can test changes by using the Test Text Catalog page. To test an entry, enter the text ID that is associated with the text, plus any combination of key values, and click the Test button to view the text that the system retrieves for the keys values you entered.

Text IDs

To update a text entry, you need its ID. Use the Display Text ID option on the Configure page to find this information. When you activate this option, the text IDs appear in place of the corresponding text on self-service pages, warnings, and emails.

To view the correct text IDs, you need to create the conditions that cause the page, warning, or email to appear. For example, you might need to sign in using a particular role.

Note. You may want to activate this option, print a copy of the self-service pages, and then deactivate it. This provides a hardcopy reference of all the text IDs used on each self-service page.

Common Elements Used in this Section

Text ID

The unique identifier that you entered to access entries in the text catalog.

Usage

The place where the entry is used: Email Body, Email Subject, Error/Warning, Field Label, Grid/Scroll Heading, Groupbox Title, Hyperlink/Button, Page Instructions, or Page Title. The only text entries that you cannot modify are translate values and error messages that appear in Microsoft Windows error boxes. You can use this field to search the Maintain Text Catalog page when you don't have the text ID, but you do have the specific text.

Effective Date

The date on which a particular text catalog entry becomes active. Delivered text is defined as system data in the PeopleSoft HRMS database and has an effective date of 1/1/1900.

Important! To prevent future updates to PeopleSoft ePerformance from overwriting any text entries that you add or modify, use a later effective date when you add new text entries, and insert a new effective date when you modify delivered text.

Pages Used to Work with the Text Catalog

Page Name	Object Name	Navigation	Usage
Configure Text Catalog: General	HR_SSTEXT_CFG	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure Text Catalog, Configure Text Catalog	Configure the text catalog for an application.
Configure Text Catalog: Key 1 Configure Text Catalog: Key 2 Configure Text Catalog: Key 3 Configure Text Catalog: Key 4	HR_SSTEXT_CFG	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure Text Catalog, Configure Text Catalog Select the Key 1, Key 2, Key 3, or Key 4 tab on the Configure Text Catalog: General page.	Designate keys that are used to store and retrieve text catalog entries.
Maintain Text Catalog	HR_SSTEXT_TEXT	Set Up HRMS, Product Related, ePerformance, Text Catalog, Maintain Text Catalog, Maintain Text Catalog Set Up HRMS, Common Definitions, Text Catalog and Notepad, Maintain Text Catalog, Maintain Text Catalog	Define text catalog entries, and define the values for context-sensitive keys.
Maintain Text Catalog	HR_SSTEXT_HTML	Set Up HRMS, Product Related, ePerformance, Text Catalog, Maintain Text Catalog, Maintain Text Catalog Click the View / Edit as HTML link on the Maintain Text Catalog page. Set Up HRMS, Common Definitions, Text Catalog and Notepad, Maintain Text Catalog, Maintain Text Catalog Click the View / Edit as HTML link on the Maintain Text Catalog page.	View text catalog entries as HTML.
Text Catalog - View All Keys	HR_SSTEXT_ALLKEYS	Set Up HRMS, Product Related, ePerformance, Text Catalog, Maintain Text Catalog, Maintain Text Catalog Click the link on the Maintain Text Catalog page or the Test Text Catalog page. Set Up HRMS, Common Definitions, Text Catalog and Notepad, Maintain Text Catalog, Maintain Text Catalog Click the link on the Maintain Text Catalog page or the Test Text Catalog page.	View versions and context-key entries for a particular text ID and effective date combination.
Self-Service Text Translation - Descriptions	HR_SSTEXT_LANG	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Translate Text Catalog, Self-Service Text Translation, Descriptions	Select and describe the languages into which a text catalog entry is translated.
Self-Service Text Translation - Catalog Test	HR_SSTEXT_LANG2	Set Up HRMS, Common Definitions, Text Catalog and Notepad, Translate Text Catalog, Self-Service Text Translation, Catalog Text	Enter translations for text catalog entries
Test Text Catalog	HR_SSTEXT_TEST	Set Up HRMS, Product Related, ePerformance, Text Catalog, Test Text Catalog	Test the text retrieval for a text ID, using any combination of key values.

Configuring the Text Catalog

Access the Configure Text Catalog: General page.

Use this page to add or remove applications from the text catalog and to configure options that affect the operation of the text catalog within an application. The page shot above shows the PeopleSoft HCM applications that are delivered with the text catalog feature enabled.

Allow Cache	Select this check box to load the entire contents of the text catalog into cache upon access to the application. This enhances system performance because the system does not have to do a database call every time it needs to retrieve a text catalog entry.
Display Text ID	Select to have the system identifiers of the text entry appear instead of the corresponding text. You can use this option to find out which text ID corresponds to a particular piece of text that you want to modify.

Designating Keys for Text Catalog Entries

Access the Configure Text Catalog: Key 1 page.

Note. The Key 2, Key 3, and Key 4 pages are identical in appearance and usage to the Key 1 page.

Key 1 Prompt Table

Select the object name of the prompt table that defines the values by which the text catalog is partitioned for an application.

The values in this prompt table appear when a text catalog entry is defined and modified. You select the value that pertains to the context in which the entry appears on self-service pages or notifications.

Key 1 Field Name

Select the field in the prompt table that contains the value that appears in the prompt list for this key.

Note. If you enter a value for the prompt table, you must also enter a value for the field name in the same row.

Defining Text Catalog Entries

Access the Maintain Text Catalog page.

Context Keys and Text

The context keys that appear on this page are determined by the text catalog configuration for the application. Use the context keys to target the message or text to a particular audience or specify the conditions under which the text is appropriate.

Note. A blank value for any key is a wildcard and means that the entry appears in all contexts of the key.

For example, the page shot above shows a configuration of a button for the ePerformance application. The button text that is defined in the text box applies only to employees and only when the evaluation status is In Progress.

For each text ID and effective date combination, define a complete wildcard entry in which you leave all key fields blank. This entry, known as the root entry, is the default text entry that's used when no section type, author type, user role, or document status is specified.

View/Edit as HTML

Click to view and edit the HTML tags if the text will appear in an HTML area on the page.

Text Substitution

The text strings that are substituted for specific tokens, such as %1 and %2, are different for each application that uses substitution in the text catalog. They are delivered with the application.

Token substitution in the text catalog works in the same way as in the PeopleTools Message Catalog. You supply the values for the tokens in a PeopleCode function call at runtime. The values are replaced by parameters in the PeopleCode when the text is rendered on performance documents. To use this feature, you must know PeopleCode.

If you want to update the delivered text IDs such that the substitution tokens take on a different meaning or are resequenced, you also need to make corresponding changes to the PeopleCode that calls the text catalog feature retrieval functions, since this copies supplier values to use in place of the tokens.

See Also

Enterprise PeopleTools PeopleBook: PeopleCode Developer's Guide

Viewing HTML for Text Catalog Entries

Access the Maintain Text Catalog: HTML View page

Text Style

Select the style to apply to the text. After you apply a style (for example, Bold or Error to a text entry, the HTML View page region shows how the text will appear on self-service pages.

Viewing Effective Dates and Context Keys for a Text ID

Access the Text Catalog - View All Keys page.

The Versions group box lists all effective-dated versions of the selected text ID.

Click the View Keys link to list each set of context keys that is associated with the selected version. Click the language link to view the text that is associated with the context keys for the indicated language.

Viewing Effective Dates and Context Keys for a Text ID

Access the Text Catalog - View All Keys page.

The Versions group box lists all effective-dated versions of the selected text ID.

Translating Text Catalog Entries

Access the Translate Text Catalog page.

Use this page to view a text catalog entry and the languages into which it is translated. The Collapse all Languages and Expand All Languages enable you to control the way the list of languages appears. You can add and remove languages on this page, but you cannot enter translation text.

Use this page to enter translations into the text catalog. The Collapse all Languages and Expand All Languages enable you to control the way the list of languages and translation entries appears. You can add and remove languages on this page and view the text you are translating.

Testing Text Retrieval

Access the Test Text Catalog page.

This page enables you to enter parameters for testing how the entries in the text catalog appear on self-service pages, given a set of parameters that you enter.

To test the text retrieval:

Enter the text ID for the text.
(Optional) Enter values for any key fields.
- If you leave all key fields blank, the system returns the root text when you click the Test button.
- If you enter values for key fields, the system searches for the text with the best fit.
(Optional) Enter values in one or more of the Substitution Variable fields.

When you click the Test button, the system replaces the variable (%1, %2, %3, %4, and %5) in the text entry with the value that you enter here.
(Optional) Select a text style to see the returned text rendered in a particular HTML style.

This features helps you visualize how the text appears on the self-service page. Values are Add'l Inst (additional instructions), Bold, Error, Page Inst (page instructions), and Page Title.
Click the Test button.

The text entry that best matches the search criteria and context keys for the selected text ID appears.

Privacy	Select from these options: Private: Only the owner of the note can access the note. Others Can View: Anyone can view existing notes in this partition, but only the note owner can update an existing note. Others Can Edit: Anyone can view and edit existing notes in this partition.
Allow Deletions	Select to permit users delete a notes.
Allow Transfers	Select to permit users who entered and therefore are the owner of a note to transfer ownership of a note to another individual.
Audit	When selected, this check box enables the Audit Changes feature for the partition. The system will automatically retain a history of all changes made to existing notes, including transfers and deletions.
Configure	Click to access to the Configure Keys page.