You are on page 1of 14

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.

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

Pages Used to Configure Direct Reports Functionality


Page Name Object Name Navigation Usage

Manager HR_DR_UI_CFG_1 Set Up HRMS, Common Configure the


Desktop Definitions, Direct Reports components and
Transactions for Managers, Configure transactions that
Direct Reports UI, include the direct
Manager Desktop reports data
Transactions functionality.

Configure HR_DR_UI_CFG_2 Set Up HRMS, Common Select the actions


Direct Definitions, Direct Reports and fields that
Reports: for Managers, Configure appear on the direct
Page Name Object Name Navigation Usage

Configure Direct Reports UI, reports UI for a


Manager Desktop transaction.
Transactions
Click the Configure button
for an application on the
Configure Direct Reports
UI page.

Invoke Direct HR_DRPT_API_EXE Set Up HRMS, Common Test the direct


Reports API - C Definitions, Direct Reports reports API.
Set/Execute for Managers, Invoke
Direct Reports API,
Set/Execute

Invoke Direct HR_DRPT_API_RSL Set Up HRMS, Common View the exceptions


Reports API - TS Definitions, Direct Reports and data returned by
Execution for Managers, Invoke a method.
Results Direct Reports API,
Set/Execute
Select the Execution
Results tab on the Invoke
Direct Reports API -
Set/Execute page.

Invoke Direct HR_DRPT_API_TR Set Up HRMS, Common View the trace log of
Reports API - ACE Definitions, Direct Reports a method execution.
Trace Results for Managers, Invoke
Direct Reports API,
Set/Execute
Select the Trace Results
tab on the Invoke Direct
Reports API - Set/Execute
page.

Invoke Direct HR_DRPT_API_UIT Set Up HRMS, Common Test the direct


Reports UI API EST Definitions, Direct Reports reports user
for Managers, Invoke interface.
Direct Reports UI API,
Invoke Direct Reports UI
API.

Configuring Components and Transactions for Direct Reports Data Functionality


Selecting the Actions and Fields that Appear on the Direct Reports UI
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 Select to indicate that the user can update their own records. When you select this
Info check box, the user's information is returned in the results list along with their
direct reports or management hierarchy.
Allow Indirect Select to return indirect reports of the user. This navigates down the organizational
Reports hierarchy and returns direct reports of direct reports and so forth until the lowest
reporting level is reached.
Select Select to enable the user to select more than one worker from the search results.
Multiple If this field is selected, a check box appears next to the names in the results list,
Employees 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 Select to run the Group Build process (GBP002 ) to refresh the group membership
Refresh 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.

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 Object Name Navigation Usage
Name

Configure HR_PSS_CONFI Set Up HRMS, Common Configure


G Definitions, Person Search components for
Match, Configure Simple Person simple person
Search, Configure search.

Invoke HR_PSS_TEST_ Set Up HRMS, Common Test the simple


Person API Definitions, Person Search person search within
Search API Match, Invoke Person Search the context of an
API, Invoke Person Search API application.

Person HR_PSS_SEARC This page is invoked from Search for and select
Search - H several calling applications. a person.
Simple
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 HR_NP_CONFIG_ Set Up HRMS, Common Configure the HR


Configuration - HDR Definitions, Text Catalog Notepad for use
Select and Notepad, Configure HR by an application.
Application Notepad, HR Notepad
Configuration

HR Notepad HR_NP_CONFIG2 Set Up HRMS, Common Set up the keys


Configuration - Definitions, Text Catalog for storing notes.
Configure Keys and Notepad, Configure HR
Notepad, HR Notepad
Page Name Object Name Navigation Usage

Configuration
Click the Configure link for
an application on the HR
Notepad Configuration
page.

HR Notepad HR_NP_CONFIG3 Set Up HRMS, Common Configure the


Configuration - Definitions, Text Catalog links that appear
Configure Links and Notepad, Configure HR on application
Notepad, HR Notepad note pages.
Configuration
Click the Configure link for
an application on the HR
Notepad Configuration
page.

Invoke HR HR_NP_TEST_API Set Up HRMS, Common Test the notepad


Notepad API Definitions, Text Catalog configuration.
and Notepad, Configure HR
Notepad, HR Notepad
Configuration

Configuring the HR Notepad for Application Use


Access the HR Notepad Configuration - Select Application page.

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 Select to permit users delete a notes.
Deletions
Allow Select to permit users who entered and therefore are the owner of a note to transfer
Transfers 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 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.

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 The date on which a particular text catalog entry becomes active. Delivered text is
Date 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 HR_SSTEXT_CFG Set Up HRMS, Common Configure the text


Text Catalog: Definitions, Text Catalog catalog for an
General and Notepad, Configure application.
Text Catalog, Configure
Text Catalog

Configure HR_SSTEXT_CFG Set Up HRMS, Common Designate keys that


Text Catalog: Definitions, Text Catalog are used to store
Key 1 and Notepad, Configure and retrieve text
Configure Text Catalog, Configure catalog entries.
Text Catalog: Text Catalog
Key 2 Select the Key 1, Key 2,
Configure Key 3, or Key 4 tab on the
Text Catalog: Configure Text Catalog:
Key 3 General page.
Configure
Text Catalog:
Key 4

Maintain Text HR_SSTEXT_TEXT • Set Up HRMS, Define text catalog


Catalog Product Related, entries, and define
ePerformance, Text the values for
Catalog, Maintain context-sensitive
Text Catalog, keys.
Maintain Text
Catalog
• Set Up HRMS,
Common
Definitions, Text
Catalog and
Notepad, Maintain
Text Catalog,
Maintain Text
Catalog

Maintain Text HR_SSTEXT_HTML • Set Up HRMS, View text catalog


Catalog Product Related, entries as HTML.
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
Page Name Object Name Navigation Usage

Definitions, Text
Catalog and
Notepad, Maintain
Text Catalog,
Maintain Text
Catalog
Click the View / Edit
as HTML link on the
Maintain Text
Catalog page.

Text Catalog HR_SSTEXT_ALLK • Set Up HRMS, View versions and


- View All EYS Product Related, context-key entries
Keys ePerformance, Text for a particular text
Catalog, Maintain ID and effective date
Text Catalog, combination.
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.

Self-Service HR_SSTEXT_LANG Set Up HRMS, Common Select and describe


Text Definitions, Text Catalog the languages into
Translation - and Notepad, Translate which a text catalog
Descriptions Text Catalog, Self-Service entry is translated.
Text Translation,
Descriptions

Self-Service HR_SSTEXT_LANG Set Up HRMS, Common Enter translations for


Text 2 Definitions, Text Catalog text catalog entries
Translation - and Notepad, Translate
Catalog Test Text Catalog, Self-Service
Text Translation, Catalog
Text
Page Name Object Name Navigation Usage

Test Text HR_SSTEXT_TEST Set Up HRMS, Product Test the text


Catalog Related, ePerformance, retrieval for a text
Text Catalog, Test Text ID, using any
Catalog combination of key
values.

Configuring the Text Catalog


Access the Configure Text Catalog: General page.
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 Select this check box to load the entire contents of the text catalog into cache upon
Cache 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 Select to have the system identifiers of the text entry appear instead of the
Text ID 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.

Defining Text Catalog Entries


Access the Maintain Text Catalog page.

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 Click to view and edit the HTML tags if the text will appear in an HTML area on
HTML 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.

You might also like