This chapter provides an overview on implementing the Administer Compensation- Total Rewards Statement and discusses how to:
Define reward data source information.
Define reward items.
Define total reward templates.
Define external reward data.
Administer the total rewards statement process.
View and print the my total rewards statement.
Employers recognize that compensation and benefits are integral to their ability to keep and attract employees who foster excellence in their jobs. A total rewards statement is used to increase the employee’s awareness of the total value of compensation (both salary and benefits).
Here is an example of a total rewards statement:
A total rewards statement shows the employee’s full value of their rewards including employer contributions to benefits, cash compensation, non-cash compensation, perks, and so on. This new functionality provides:
A summary of an employee’s total rewards at a glance.
A breakdown of an employee’s total rewards, including explanations and content information, links to existing employee reward details or third party vendors, and analytic charts.
A view of all rewards, including non-cash compensation.
The ability to generate and print a total rewards statement.
From the My Total Rewards self service application, employees can optionally print a paper copy of their total rewards statement. In addition, managers have the ability to view the total reward statements of their direct reports through manager self service.
Here is a graphic that shows the process for defining and administering a total rewards statement:
To implement the Total Rewards feature you use these building blocks:
Reward Data Source definition - a menu, component, pages, and tables that store information about the attributes of a reward data source. The reward data sources that are currently used include:
North American Payroll Earnings.
North American Payroll Deductions.
North American Payroll Taxes.
Benefit Leave Balance.
Stock Administration.
External Compensation Data.
External Reward Data Definition - A component that enables the compensation administrator to define external reward data that is loaded into PeopleSoft.
Reward Item - Table containing multiple items of reward data retrieved from a reward data source. Reward items are displayed on a total reward statement.
Reward Template - Table containing multiple templates detailing the structure and layout of reward items displayed on a total reward statement.
Reward Extract Process - An application engine process that extracts reward data for specific total reward statements.
Reward Build Process - An application engine process that builds and summarizes sections in the total reward statement. This process also performs any currency conversions to display the employee’s total reward statement in the currency defined on the employee’s HR primary job record.
Administer Statement Component - A component that enables the compensation administrator to manage the end-to-end process of generating total rewards statements.
The key challenge in generating a total rewards statement is the ability to combine information from a wide variety of sources, and then combine those sources into a meaningful context with instructional text and analytics. In addition to this, the extracted compensation ultimately needs to be formatted, organized, and summarized into a total rewards statement. The business process of generating total rewards statements is to first identify the source of compensation, then retrieve data from the source, and finally display the information, which is configured through a template definition. This feature primarily deals with the business process to extract and summarize compensation data for a total rewards statement. This component covers these elements:
Foundational components to support the data extract mechanism.
Data extraction processes that retrieve compensation data for a single total rewards statement.
Administrative console to initiate and monitor the process of generating a total rewards statement.
The current Total Compensation Reporting functionality retrieves its compensation data through multiple Application Engine and COBOL programs built to extract and calculate data from specific areas of a PeopleSoft application:
North American Payroll,
Variable Compensation, and
Benefit Enrollments
The multiple programs make the process cumbersome for the customer and inflexible to retrieve data from other areas of the PeopleSoft application, such as Stock Administration, Global Payroll, or from an external system. One of the primary goals for the new Total Rewards functionality is to streamline the overall process and provide a more configurable table driven solution that enables the customer to define and extract employee level rewards data that is required for their total rewards statements.
In future releases, PeopleSoft plans to provide a set of reward items that map to a delivered set of data sources for existing data within the HCM application suite. This will allow you to quickly create a total rewards statement based on known data in the HCM system. Reward items will be considered system data.
The building blocks of the total rewards solution include:
Reward Data Source - Table containing multiple sources of reward data.
Reward Items - Table containing multiple items of reward data retrieved from a reward data source. Reward items are displayed on a total reward statement.
Reward Template - Table containing multiple templates detailing the structure and layout of reward items displayed on a total reward statement.
Reward Statement - Table containing multiple statements detailing the parameters used to generate a total reward statement for a specific group of employees for a particular reward template and period of time.
The goal of the reward data source is to provide a common definition (or set of metadata) that will be utilized by a single Reward Extract program to generate SQL to retrieve and load reward data for the total reward statement being processed.
To generate the SQL, the reward data source definition will take into consideration the parameters used for the total reward statement being processed.
Since a reward statement can be processed for a group of employees or an individual employee, different SQL criteria is generated based upon the run parameters to process a total reward statement. In addition to this, the values of the run parameters may be incorporated into the SQL differently based upon the reward data being extracted.
Moreover, there are other controls that can be put into place to enable the compensation administrator to specify the reward data they want to retrieve, For example, instead of defining a separate reward data source to retrieve earnings from North American Payroll for each configured earning code, the compensation administrator can specify the earning code as a reward item filter that they want to retrieve from the reward data source.
In addition, there are other ways to define a generic reward data source with some ability to enable the compensation administrator to specify parameters to control the data to be extracted.
Finally, the extracted data needs to be mapped into a set of common reward results tables to store the rewards data that will be displayed on the total rewards statement. The reward data source configuration is broken down into the following elements:
Element |
Description |
Extract Temporary Table |
The system extracts a temporary table that will initially store extracted rewards data retrieved for a specific total reward statement. The Extract Temporary table has a key structure that uniquely identifies rows of reward data being retrieved. The Extract Temporary table is created in Application Designer. |
Extract Table |
The system creates one or more records or record views that are used to retrieve data that will be loaded into the Extract Temporary table. Similar to a query, record views are utilized because they provide the ability to combine data from multiple tables. Record views are defined through Application Designer. |
Extract Filters |
The system appends standard filter types to an SQL SELECT statement against the Extract table. Extract filters only incorporate reward statement run parameters to extract the reward data for the total reward statement being processed. |
Reward Item Filters |
The system uses additional filters that can be specified at the reward item level. This provides additional control to the compensation administrator to specify the data that the system will extract from the data source. |
Reward Item Outputs |
The system maps extracted data from the Extract Temporary table to the Statement Reward Item Detail table. Numeric reward data is mapped to these columns:
Other detail fields can be used to display additional reward data when the employee drills down into a specific reward item. Some detail fields will require a description to be displayed instead of a code; therefore the Detail Record and Description fields can be specified. For example, the system extracts the field COMPANY code, but you want to display Company description from the PS_COMPANY_TBL. To do this, specify the column heading description for an output field in the detail rewards data. |
Reward Item Calculations |
The system performs calculations on data in the Statement Reward Item Detail table to calculate final rewards data. Application Packages are also used to manage reward item calculations. |
Note. The expectation is that most reward data being extracted for a total reward statement has been calculated. However, reward item calculations provide the ability to use Application Packages to create additional calculations that can be performed against the extracted reward data.
This chapter provides an overview of the common elements that comprise a Reward Data Source and discusses how to:
Define general information of reward data source.
Define reward data source extract tables.
Define reward data source extract filters.
Define reward data source reward filters.
Define reward data source reward output.
Define reward data source reward calculations.
Test reward source data.
Data Source ID and Description |
Enter an abbreviation that uniquely identifies the Reward Data Source. Then enter a description of the Reward Data Source. These fields become display only on the other pages within the component. |
Extract Temporary Table |
The Extract Temporary table is a temporary table defined in Application Designer. It will be populated with data retrieved from the Extract tables. It is the table that the system will use as the reward data source. In addition, reward item filters are created from the fields on the Extract temporary table. |
Page Name |
Definition Name |
Navigation |
Usage |
Define Reward Data Source - General |
TRW_DATASRC_GNRL |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, General |
Enables the user to enter a general description, a detail description, and a high level data source category for the reward data source. |
Define Reward Data Source – Extract Tables |
TRW_DATASRC_EXTBL |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Extract Tables |
Enables users to setup the Extract tables for the reward data source. Users will have the ability to enter a record name defined in Application Designer. They also can view the SQL text for the record view. |
Define Reward Data Source - Extract Filters |
TRW_DATASRC_EXFIL |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Extract Filters |
Enables users to define extract filters that are used to retrieve reward data for the statement being processed. The extract filters are used during the extract process to retrieve data from extract tables into extract temporary table. A link initiates a secondary page allowing the user to enter the extract filter for a specific extract filter type. |
Define Reward Data Source – Reward Filters |
TRW_DATASRC_RIFIL |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Reward Filters |
Enables users to create reward item filters from a field in the Extract table. Reward item filters are additional filters defined at the reward item level that enable the compensation administrator to control the rewards data that is extracted. |
Define Reward Data Source - Reward Output |
TRW_DATASRC_RIOUT |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Reward Output |
Enable users to map fields from the Extract temporary table to the Statement Reward Item Detail table. Users can also control the selection of the table to retrieve the description for a detail data field along with the Detail Grid Column label. |
Define Reward Data Source – Reward Calculations |
TRW_DATASRC_RICALC |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Reward Calculations |
Enables users to specify the path to an application class that will perform a calculation. This page also displays the configurable matrix if the application class is retrieving rate information to perform a calculation. |
Test Reward Data Source |
TRW_TEST_DATASRC |
Set Up HRMS, Product Related, Compensation, Total Rewards, Total Reward Utilities, Test Reward Data Source |
Enables the user to enter reward statement run parameters to test if the reward data source is working correctly. |
Access the Define Reward Data Source - General page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, General).
Detail Description |
A detail description providing a functional explanation of where the rewards data is being extracted. |
Data Source Category |
A high level category assigned to the Reward Data Source. Listed below are the data source categories that can be entered:
Note. This category is useful in validating if external data has been loaded for the reward data source. This validation is confirmed by the compensation administrator through the Administer Statement component. |
Access the Define Reward Data Source – Extract Tables page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Extract Tables).
Reward Data Source Extract Tables
Extract Table |
The Extract Table is defined in the Application Designer and designed to extract rewards data from PeopleSoft. |
Description |
Displays the table description defined in Application Designer. |
View SQL |
This link is enabled when the table is defined as a view in Application Designer. Click the View SQL link to display a secondary page that will show the SQL statement used by the view. |
Access the Define Reward Data Source – Extract Filters page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Extract Filters).
Reward Data Source Extract Filters
Filter Type |
The filter type controls the Reward Statement run parameters that will be included in the Extract Filter. Listed below are the delivered filter types:
|
Extract Filter |
Display only field. The extract filter is the filter text specified for the filter type. The filter parameters are the variables that need to be included in the extract filter. These variables are required to substitute the variable with the reward statement run parameter at runtime. Listed below are the filter types and the associated substitution variables when a filter type is selected:
|
Edit Filter |
Click to display a secondary page that enables users to enter extract filters. |
Access the Define Reward Data Source – Reward Filters page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Reward Filters).
Reward Item Filters
Field Name |
Select a field name from the Extract temporary table to define a reward item filter. Certain fields that should not be used as reward item filters include:
|
Required |
Click this check box to mark a reward item filter as required. This will require the compensation administrator to configure the reward item filter when using this reward data source to define a new reward item. |
Edit Type |
To ensure that the compensation administrator enters a valid value, when configuring the reward item filter at the reward item level, an edit type can be associated to the Reward Filter field. Listed below are the valid edit types:
If the edit type of Prompt Table is chosen, then a prompt table must be specified to retrieve valid values for the Field Name when the compensation administrator configures the reward item filter at the reward item level. Note. If the field is not the highest key on the prompt table, then a view against the prompt table will need to be created in order to select the Reward Item Filter value when defining a reward item. |
Access the Define Reward Data Source – Reward Output page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Reward Output).
Reward Item Output Fields
Field Description |
Display only field that displays the field description of a field in the Extract temporary table. Fields are populated when the Extract Temp table is entered on the Rewards Data Source - Extract Tables page. |
Field Name |
Display only field that displays the field name of a field in the Extract temporary table. Fields are populated when the Extract Temp table is entered on the Rewards Data Source - Extract Tables page. |
Key |
Display only field that displays if the field name is a key in the Extract temporary table. Fields are populated when the Extract table is entered on the Rewards Data Source - Extract Tables page. |
Detail Output Column |
Fields from the Extract table can be mapped to a Detail Output Column that exists in the Statement Reward Item Detail table. The fields mapped to a Detail Output Column are the valid fields that can appear in the Reward Item Detail grid displayed in the My Total Rewards statement. Listed below are the valid values for the Detail Output Column:
A Detail Output Column can only be mapped to one field from the Extract temporary table. In addition to this, one or more of the numeric reward data fields must be mapped (for example, Employee Paid, Employer Paid, Units, or Company Provided). |
Detail Description Table |
In order to translate a field value into a description to be displayed on the Reward Item Detail grid, a Detail Description table must be specified. |
Detail Description Field |
In order to translate a field value into a description to be displayed on the Reward Item Detail grid, a Detail Description field must be specified from the Detail Description table selected. |
Detail Grid Column Label |
For every field mapped to a Detail Output Column, a Detail Grid Column Label must be specified. |
Access the Define Reward Data Source – Reward Calculations page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Data Source, Reward Calculations).
Reward Item Calculations
Sequence |
Multiple calculations can be specified for the reward data source. The Sequence field controls the order in which the reward item calculations will be performed. For example, a reward data source for stock administration may require the calculation of exercisable shares, and then a calculation to calculate the estimated value of the exercisable shares. |
Application Class Path |
Enter the path of the application class to retrieve the calculation. Application classes are used to perform reward item calculations. |
Description |
Description of the application class. |
Method Name |
Enter the name of the method within the application class that will perform the calculation. |
Matrix Name |
Depending upon the selected application class, a matrix may be used to retrieve a rate the calculation requires. The matrix is specific to the application class and will require the user to specify a rate in that table for the reward statement being processed. |
Note. Application Class must be registered under Application Class Registry found under Set Up HRMS, Product Related, Compensation, Utilities with the Class Usage set to REWARD CALCS.
The extraction of reward data for a total reward statement can be challenging to set up and validate. The Test Reward Data Source component assists in validating and reviewing how data is extracted from a reward data source.
This component will accept test parameters similar to the test parameters to run a total reward statement. It will generate the SQL use to extract reward data into the Extract Temporary table. If you specify a reward item, it will also generate the SQL to extract data for the reward item.
On this page you will be able to view and execute the SQL, as well as view that data populated in the tables.
If the reward data source has reward calculations, then they will display when you test the reward data source. Reward calculations can only be executed if you have specified a reward item as a test parameter.
Note. If SQL errors are encountered on this page, then the error messages that are generated may not be specific to the actual problem with the SQL statement. Therefore, use the View SQL link to review the SQL statement generated and copy it into a SQL tool to identify the exact problem with the SQL statement.
Access the Test Reward Data Source page (Set Up HRMS, Product Related, Compensation, Total Rewards, Total Reward Utilities, Test Reward Data Source).
Test Parameters
From Date |
The start date that you want the system to use to test the reward data source. |
Thru Date |
The end date that you want the system to use to test the reward data source. |
Group ID |
The group ID that you want the system to use to test the reward data source. Note: If the group ID is specified, then the employee ID and employee record are disabled. |
Employee ID |
The Employee ID that you want the system to use to test the reward data source. Note: If the employee ID is specified, then the group ID will be disabled. |
Employment Record |
The employment record that you want the system to use to test the reward data source. |
Reward Item ID |
The Reward Item that you want the system to use to test the reward data source. |
Test Reward Data Source |
This button enables the user to submit the Reward Extract process in test mode through the Process Scheduler. |
Delete Test & Reset Parameters |
This button enables the user to delete the current reward data source test data. Clicking this button deletes the Extract SQL, Reward Item SQL, Reward Item Calculations, test data populated in the Extract Temporary table or Employee Statement Reward Item table, and any temporary queries. |
View Extract Temporary Table |
Clicking this button will create a temporary query and open a new browser to allow the user to view the data populated in the Extract Temporary table. |
View Employee Reward Item Table |
Clicking this button will create a temporary query and open a new browser to allow the user to view the data populated in the Employee Statement Reward Item table. Note: To generate the temporary query, the user needs to have proper query access to the Extract Temporary table and the Employee Reward Item table. |
Refresh |
When the Reward Extract process is running in test mode, this button is enabled to allow the user to refresh the test reward data source page. When the Reward Extract process is not processing, this button is disabled. |
Check Messages |
If the Reward Extract process or a Reward Calculation generates a warning or error to the Statement Message log table for the data source test processed, then the system enables the Check Message link. This enables the user to access a subpage to view the messages. |
Generated Extract SQL
Description |
A description of the Extract SQL generated for the reward data source test. |
View SQL |
Click this link to view the extract SQL generated for the reward data source test. |
Execute SQL |
Click this link to execute the SQL to populate either the Extract Temporary table or the Employee Statement Reward Item table. Extracting SQL based on an Extract table populates the Extract Temporary table. Extracting SQL based on a reward item populates the Employee Statement Reward Item table. |
SQL Status |
A description of the current status of the SQL statement displayed. Listed below are the valid SQL statuses:
|
Rows |
Displays the number of rows inserted into the Extract Temporary table or the Employee Statement Reward Item table. |
Reward Item Calculations
Application Class Name |
Displays the application class for the reward calculation. |
Description |
Displays the description of the application class. |
Method Name |
Displays the method name within the application class that will be executed to perform the reward calculation. |
Execute Calculation |
Click this link to enable the user to execute the reward calculation. |
Calculation Status |
Displays a description of the current status of the reward calculation. Listed below are the valid calculation statuses:
|
Note. Depending upon the design of the reward calculation, messages may be written out to the Statement Message Log table when an error is encountered. In this scenario, the Check Message link is activated to allow the user to view any warning or error messages.
This section provides information on understanding reward items, common elements, examples, and describes how to define reward items.
A reward item not only identifies the data source to the system, it provides the properties and behaviors that are used by the data source when generating results data for the employee. In this application, for every reward item there must be a corresponding data source.
Beyond a basic ID and description, a reward item essentially provides the ability to configure three pieces of metadata that are used by the Generate Statements process:
The identifier of the data source.
The input filters to be applied by the data source to retrieve the correct rows of data.
The target output column that will be used to displayed the retrieved values. A reward item can support one, two or three possible output columns:
Employer Paid
Employee Paid
Company Provided This is controlled by data source definition.
This table highlights a series of typical examples that represent likely combinations of the three possible columns that can be configured:
Reward Item Name |
Employer Paid |
Employee Paid |
Company Provided |
Base Salary |
Payroll for North America Earnings 85,000.00 USD |
||
Medical Benefits |
Payroll for North America Deductions 2,500.00 USD |
Payroll for North America Deductions 2,500.00 USD |
|
Stock Options |
Stock Administration 12,000.00 USD |
||
Holidays |
(Default Values Only) 260.00 USD |
||
Leave Accrual |
Benefit Leave Accrual 390.00 USD |
||
Company Provided Phone/Service 500.00 USD |
External Source |
||
Free Parking |
Notice that the majority of examples only display a value in one column. It is very unlikely that there will be any scenario that will use all three columns.
Reward Item |
A specific item of compensation displayed on the employee’s total compensation statement. |
Data Source |
A setup component that defines how the data loads to the Extract temp table. It also further defines filter and output fields that can be used in the Reward Item setup. |
Page Name |
Definition Name |
Navigation |
Usage |
Define Reward Item |
TRW_RW_ITEM_DEFN |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Item |
Enables users to create new reward items or modify existing reward items. Note: Access should be provided to only those designated as compensation administrators. |
Access the Define Reward Item page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Reward Item).
Reward Item ID |
A unique, user-specified identifier for the reward item, this field can support a maximum of 15 characters. This value is read-only on the page as it is entered by the user on the Add a New Value tab on the Search Dialog page. |
Effective Date |
The initial default value is today’s date. The effective dated reward items work together with the effective dated template to generate a statement for a certain period. The statement through date is used as the As of Date to retrieve the effective dated template. The effective date on the template is, in turn, used to retrieve effective dated items. Usually statements are generated with begin and through date in the past, so most likely the administrator will use an effective date that is in the past but before the through date. |
Status |
Indicates the effective date status. This field uses one of two values: Active or Inactive. The initial, default value is Active. |
Name |
A short description that identifies a reward item. This field supports a maximum of 25 characters. |
Description |
A long description name that provides details regarding a reward item. This field supports a maximum of 50 characters. |
Always Display |
An indicator that specifies if the reward item must be displayed on the total rewards statement, even if there are no results found for the employee in the result table. The initial default value for this indicator is FALSE or deselected. |
Exclude From Manager View |
An indicator that specifies if the reward item is excluded from the manager view. When the check box is selected, managers are not able to see the reward item when viewing the direct report’s total reward statement. By selecting this indicator, this item will only display for the employee’s My Total Reward statement. The initial default value for this indicator is FALSE or deselected. |
Data Source ID |
This is a prompt view that lists all of available data sources that can be selected for the reward item. All data sources that are configured in Define Reward Data Source setup component are valid data sources in the prompt. A data source can be configured to contain the employer paid amount, employee paid amount, company provided amount, or any combination of the three. It will be listed in the Detail Output Fields grid. If the Reward Item Filters and Detail Output Fields have not been previously specified, changes to the data source will load the Data Source Filters and Detail Output Fields grids without error. Changes to the data source, when rows exist in any of the Reward Item Filters or Detail Output Fields grid, will cause the following warning message to occur: Reward Item Filters/Detail Output Fields have been defined for the Data Source. This action will reload specified Reward Item Filters/Detail Output Fields based on newly selected Data Source. Do you want to continue? If you acknowledge Yes, the Reward Item Filters and Detail Output Fields are repopulated based on the new data source selected. If you do not wish to continue, you can cancel the action. The Reward Item Filters and Detail Output Fields stay the same, and the data source is not changed. |
Reward Item Filters
This grid enables you to specify the filter criteria values that need to be applied to properly retrieve the correct data from the data source. Data source specifies what fields can be configured as filter fields, whether it’s a required filter, and the prompt view of the filter field.
Reward Item Filter Name is systematically populated after a data source has been selected. Rows cannot be added or deleted manually from the grid. Filter values are entered by clicking the Edit icon.
Filter Field Name |
The long label associated with the Filter field that requires some filter criteria. This field is read-only. The label is displayed based on user language. |
Filter Values |
A simple, concatenated list of the filter criteria or key values that have been specified by the user. This field is read-only. Click the Edit link to enter or modify the value. Filter values include different operators such as In List, Not In List, Equal to Blank, Not Equal to Blank, and so on. Concatenated strings are displayed with values – without quotation markings – and are separated with a comma. The system wraps long, concatenated strings within the column width. |
Required |
This field displays either Yes or No to indicate if the filter field requires at least one filter value. It is read-only. Data source specifies whether a filter field is required or not. If a filter field is required, the administrator has to specify at least one value in the reward item setup; or specify that the value is not empty from the operator. You cannot save the page if the value is left blank. |
|
Click to launch a dialog box that enables you to specify filter values. This icon is always enabled for selection. |
Detail Output Fields
The Output grid enables you to select the fields (grid columns) that will be visible when displaying the results details on the total rewards statement.
The results output fields are defined by data source. This grid displays all of the available output fields that can be applied when presenting the results data from the reward item on the My Total Rewards statement. The administrator can further select what fields to display on reward item details.
Note. The display order of fields is controlled from the data source definition. Reward item setup can’t rearrange the position of each output column to display on the My Total Rewards statement.
Output fields are controlled by selected data source. Rows cannot be added or deleted from the grid.
The default for output fields is to have the check box selected but you can decide whether to exclude it on the Reward Item Detail page or not.
All rows are displayed on the page. The View All configuration option is not visible.
Output Field Name |
Display grid column label of the field name defined in the data source. The label is configured in the data source definition. The value is displayed based on the user’s language. |
Display |
A check box that can be selected to enable the display of the column on the My Total Rewards Item Details grid. The default value is set to TRUE (selected). A data source can apply to Employer Paid, Employee Paid, Company Provided, or any combination of the above. At least one Employee Paid, Employer Paid, or Company Provided amount field has to be selected. When you click Save, the system makes sure at least one amount is selected, otherwise the system displays an error message. |
This section provides an understanding section and discusses how to:
Define Total Reward templates.
Review the Total Rewards Statement charts.
On the Define Total Rewards Template page, compensation administrators design the layout of Total Rewards Statement. These designs are called templates. The system uses them in the processes that generate the Total Rewards statement for an employee population.
When a new template is created, the system automatically enters the statement’s sections and all the labels texts. Because the system does this for you, you can create a template very quickly. All a compensation administrator would need to do after this process has completed, would be to select a compensation item for each non-summary section. Compensation administrators can remove or add sections, change the section label text, change the section sequence, remove or add sections, and set a summary section.
The template elements that are defaulted in include:
All header area label texts.
Six sections sets:
Summary
Cash Pay
Health and Wellness
Retirement Savings
Company Stock
Other Benefits
Label texts for all sections.
Editable chart types set to 2D Pie for the Summary section.
Chart check boxes deselected for all non-summary sections.
Grid columns label texts for all grids.
Note. All the label texts are defaulted in as Other Benefits when a new section is added by the compensation administrator.
The template elements that must be added by the administrator when adding or creating new templates include:
Template identification.
Template description.
Reward items.
Note. Reward items must be unique for the combined sections. For example, if reward item Regular Salary is selected in the Cash Pay section, then this same item cannot exist in any other section.
A Total Rewards Template defines how a total rewards statement will be presented to the employee in self service.
Page Name |
Definition Name |
Navigation |
Usage |
Define Template |
TRW_TEMPLATE_DEFN |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define Template |
Enables compensation administrators to configure the layout of the total rewards statement. |
My Total Rewards |
TRW_SS_STMT_TABS |
Click the Preview Statement link on the Define Template page. |
Preview the Total Rewards Statement for a particular employee. |
Access the Define Template page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Template).
Template ID |
Specified by the compensation administrator, the Template ID field identifies the total rewards statement configuration and is a key element needed when processing or generating statements for an employee population. A template ID is entered in the Add Search page when creating a new template or in the Search page when looking for an existing template. |
Display Expanded View Only |
Select this check box to enable employees to view the tabbed or expanded page format. The default value for this field is deselected. If this check box is cleared, the employee will be able to view the statement in the tabbed format or online view, and there will be a link on the statement that toggles between Tabbed View and Expanded View. If this check box is selected, the employee can view the statement in expanded format only. |
Preview Statement |
Specified by the compensation administrator to set how the statement will display to employees in self service. Two formats or styles of the My Total Rewards statement are available. It is up to the compensation administrator to specify whether to display the tabbed or expanded page format only. The default value for this field is deselected:
|
Description |
Specified by the compensation administrator to describe the template, the description can be changed at any time. |
Statement Period Label |
The default statement period label for the rewards period. |
Statement Introduction |
The default statement introduction text is displayed in the edit box. The administrator may change it. All statement attributes that are configurable are in this scroll area. |
Statement Sections
Section Label |
Describes the section. Note. For the pre-defined sections (Cash Pay, Health and Wellness, Retirement Savings, Company Stock, and Other Benefits) the fields are essentially the same except the field values correspond to each section type. |
Section Order |
The section sequence determines the order in which the sections will appear in the My Total Rewards statements. When new templates are created, section sequence is the same as the scroll row number. The default is the scroll row number. |
Summary |
The summary check box identifies the section that will be designated as the statement summary section. Only one section can have the summary check box selected. Summary sections summarize the contents of the other sections, so if a summary section is defined, then there must be at least one other non-summary section defined in the template. When the Summary check box is selected, then the Reward Items grid is disabled. Chart Settings are only enabled for summary section. |
Statement Information |
The default statement introduction text that is displayed in the edit box. The administrator may change it, however. |
Grid Total Label |
The default grid total label for the section. This is the label for displaying the total line of the section. For instance, Summary Section has Summary Total as default label for the total line. |
Grid Label |
The default grid label for the section grid title. |
Grid Labels for Expanded View |
For Expanded View, there is a limitation. The system can’t display different grid labels for different sections. Select this check box so the system will use the labels defined in this section to display the grid labels in the expanded view. |
Chart Settings
Display Chart |
Select this check box if you want to display a chart on the My Total Rewards statement. This is only available in the Summary Section. |
Chart Type |
Select one of these values to indicate the type of chart that you want the employees to view:
|
Section Grid
Column |
List columns in the section grid. |
Label Text |
Enter the text that you want the system to display for each grid column header on the My Total Rewards statements for the employees. You can change these labels for each section. |
Reward Items
This section is used to identify the reward items for each section grid. When you select the Summary check box, the Reward Items grid is disabled since the content is derived from the non-summary sections.
Always Display |
This will be defaulted in from the Reward Item definition into the non-summary sections. |
Order |
The grid order determines the order in which the reward items will appear in the grid. For the Summary section, the order will be set to match the order of the non-summary sections. |
Access the Define Template page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define Template) and then click the Preview Statement link.
The labels defined in the template are displayed in the statement. Also a BI publisher report is launched when you click the View Printer Friendly Version link or the Printer icon on the Total Rewards Statement page.
See Also
PeopleTools 8.52: BI Publisher for PeopleSoft PeopleBook
This section provides information on how to:
Define external reward data.
Update external reward data.
Page Name |
Definition Name |
Navigation |
Usage |
Define External Reward Data |
TRW_EXTDATA_TBL |
Set Up HRMS, Product Related, Compensation, Total Rewards, Define External Reward |
Enables the user to define an External Data ID that will identify the external data loaded into the External Rewards Data table. |
Update External Reward Data |
TRW_EXTERNAL_DATA |
Compensation, Total Rewards, Update External Rewards Data |
Enables the user to enter a general description, a detail description, and a high level data source category for the reward data source. |
Access the General Information page (Set Up HRMS, Product Related, Compensation, Total Rewards, Define External Reward).
External Data ID |
An abbreviation that uniquely identifies external rewards data. |
Description |
A description of the external reward data that will be displayed in the total rewards detail. |
Detail Description |
A detail description providing a functional explanation of the external rewards data that is being loaded into the External Rewards Data table. |
Access the General Information page (Compensation, Total Rewards, Update External Rewards Data).
External Data ID |
An abbreviation that uniquely identifies external rewards data. |
Description |
A description of the external reward data ID. |
Rewards Date |
Date the reward was granted to the employee. |
Employee Paid Amount |
The amount the employee paid or contributed to for the external reward data. |
Employer Paid Amount |
The amount the employer paid or contributed to for the external reward data. |
Company Provided Amount |
The amount the company provided for the external reward data. |
Units |
The number of units for the external reward data. Unit of Measure The Unit of Measure that displays for the external rewards data. The following is a list of the units of measures delivered:
|
Currency |
The currency for the external reward data. |
This chapter provides two understanding section and discusses how to:
Define and processing rewards statements.
Validate external data.
Run the rewards extract run control process.
Run the rewards build run control process.
Publish statement summary information.
Amend total reward statements.
Review warnings and error messages.
View statement summary information.
PeopleSoft enables the compensation administrator to manage the end-to-end process of generating a total rewards statement after they have defined and setup these data elements:
Group ID Definition - Group IDs are used to identify the employee population that will receive a total reward statement
Reward Items - Represent an item of compensation received by the employee. Reward items are associated with a reward data source that contains attributes about how that reward data is extracted. Depending upon the reward data source definition, the compensation administrator can specify reward item filters to further control the reward data extracted. Finally, the reward item controls the detailed output columns that are displayed in the My Total Rewards page.
Template ID – These IDs organize and format reward items that appear in a total rewards statement.
The end-to-end process of generating a total rewards statement includes:
Validating that external rewards data has been populated.
Initiating the Application Engine Rewards Extract process.
Reviewing any Rewards Extract warnings or errors.
Initiating the Application Engine Rewards Build process.
Reviewing any Rewards Build Process warnings or errors.
Publishing the total rewards statement to My Total Rewards self service.
Amending total reward statements, if necessary
Here is a detailed explanation of what the system does when the Reward Extract Process is generated:
Step |
Actions |
Performs critical validations against reward data sources |
The reward data sources utilize records and views defined in Application Designer. The system performs validations to ensure that records and views exist and are defined properly to retrieve reward data. |
Processes group IDs |
Retrieves the employee population for the statement being generated. |
Initializes employee reward statement tables |
The system populates the these tables:
|
Performs employee validations |
If the employee has multiple statements, the system validates the From and Thru date being processed. If true, the system generates warnings. If the employee has one HR primary job, the system performs a validation. If true, the system generates an error. The system uses the primary job to retrieve the currency the employee’s statement is displayed in. |
Sets Multiple Jobs Indicator |
If an employee has multiple jobs, the system displays the job title in the reward item detail. |
Generates SQL for the Extract table |
For each unique reward data source associated with the template, the Reward Extract process constructs SQL to extract reward data from the Extract table(s) defined in the reward data source. The SQL constructed uses the extract filters to only retrieve rewards data for the statement being processed. The SQL also populates the Extract Temporary table defined in the reward data source. |
Executes SQL for the Extract table |
For each unique reward data source, the system populates the respective Extract Temporary table. |
Generates SQL for reward items |
For each reward item in the template, the system generates SQL to the extract reward item from the Reward Data Source Extract Temporary table The SQL, when constructed, uses the reward item filters to only retrieve reward data for the specific reward item. This SQL also populates the Employee Statement Reward Item table (TRW_EE_STMT_ITM). |
Executes SQL for reward items |
For each reward item SQL generated, the system executes the statement to populate the Employee Statement Reward Item table (TRW_EE_STMT_ITM). |
Calculates reward items |
The system performs any reward item calculations against the Employee Statement Reward Item table (TRW_EE_STMT_ITM). Note: The system deletes the data in the Extract Temporary tables for the statement being processed. |
Validates rewards item details |
The system generates warning messages for reward items that were not extracted for the statement. |
Updates extract statistics |
The system populates the Reward Summary table (TRW_STMT_RWDSUM). The system counts and summarizes the number of employees with extracted reward items. |
Updates the statement status |
If errors occurred, the system sets the Statement Status to Reward Extract Error. The system also enables the Check Messages link on the Administer Statement page. If there are no errors, the system sets the Statement Status set to Reward Extract Complete. |
Generates a detailed output log file accessible through Process Monitor |
See TRW_RWD_EXTRACT_INFO.txt |
Note. When initiating the Reward Extract process to amend a specific list of employee’s, the steps are basically the same except for the status the statement assigned. The Statement Status assigned will be Amend Extract Error or Amend Extract Complete.
Page Name |
Definition Name |
Navigation |
Usage |
Administer Statement |
TRW_ADM_STMT |
Compensation, Total Rewards, Administer Statement |
Enables the compensation administrator to define and process a total rewards statement. As the compensation administrator performs the main process steps to generate a total rewards statement, the statement status is updated and certain data fields and buttons are enabled or disabled based on the status. |
Validate External Data |
TRW_STMT_VAL_EDATA |
Click the Validate button on the Administer Statement page. |
Identifies any external reward items associated with the specified template ID. An external reward item is defined as any reward item associated to a reward data source that has the data source category set to EXT for External Rewards. |
Extract Total Rewards Data |
TRW_EPRC_RUNCTL |
Click the Extract button on the Administer Statement page. |
Extract reward data for specific total rewards statement by generating SQL that extracts rewards data based on the reward data source attributes. |
Rewards Build Run Control |
TRW_BPRC_RUNCTL |
Click the Build button on the Administer Statement page. |
Identify issues with processing an employee’s statement. |
Publish Statement |
TRW_STMT_PUBLISH |
Click the Publish button on the Administer Statement page. |
This page is used to publish all built total rewards statements to the employee self service My Total Rewards page. |
Amend Statement |
TRW_STMT_AMEND |
When the statement has reached the Published status stage, click the Amend Statement button on the Administer Statement page. |
This page enables the compensation administrator to amend or cancel individual employee total rewards statements. |
Administer Statement Messages |
TRW_STMT_MESSAGES |
Click the Check Messages link on the Administer Statement page. |
Displays any warnings or errors generated by the Rewards Extract and Rewards Build processes. The compensation administrator is expected to review warnings and error messages and cancel the statement to make any adjustments to the configuration or data to correct the problem. |
Statement Summary |
TRW_STMT_SUMMARY |
Click the View Statement Summary link on the Administer Statement page. |
Displays statistical summary information on what has been processed to date for the statement. |
Access the Administer Statement page (Compensation Total Rewards Administer Statement).
The Compensation Administrator can add a new Statement ID and specify the following fields:
Statement ID |
An abbreviation that uniquely identifies the total rewards statement to be generated. |
Description |
A description of the total rewards statement. |
From Date and Thru Date |
These fields are enabled if the Status field is Defined or External Data Validated. The From and Thru Date fields identify the period use by the Rewards Extract process to extract rewards information that will be displayed on the total rewards statement. |
Group ID |
Group ID defines the population of employee who will be processed for the My Total Rewards statement. |
Template ID |
This field identifies the structures of the total rewards statement; specifically, the reward items that will be extracted and displayed on the total rewards statement. |
Statement Status |
This is a display-only field. As the rewards statement is processed, the Status field will change to one of the following:
|
Refresh |
Displayed, when the Rewards Extract or Rewards Build process is running. The compensation administrator can click this link to see if the process has completed. |
Check Message |
Displayed if the Reward Extract or Rewards Build process generated a Warning/Error message. The system transfers the compensation administrator to the Statement Messages page, which displays any warning or error messages that require the attention of the compensation administrator. |
View Statement Summary |
Displayed if the statement status is not defined or cancelled. The system transfers the compensation administrator to the Statement Summary page, which details various statistics for the statements being processed. |
Main Steps
|
Enabled if the statement status is Defined or Statement Cancelled. The system transfers the compensation administrator to the Validate External Data page, which will identify reward items from the specified Template ID that is associated to a data source that is external to PeopleSoft. If external reward items exist, then the compensation administrator must confirm that all external data has been loaded into PeopleSoft. |
|
Enabled if the statement status is Defined (no external data is validated), External Data Validated, or the amended employee is set to Amend Indicator of Extract. The system transfers the compensation administrator to the Rewards Extract Run Control component so they can submit the Rewards Extract process through the PeopleSoft Process Scheduler. |
|
Enabled if the statement status is Rewards Extract Complete, or the amended employee is set to Amend Indicator of Build. The system transfers the compensation administrator to the Rewards Build Run Control component so they can submit the Rewards Extract process through the PeopleSoft Process Scheduler. |
|
Enabled if the statement status is Build Rewards Complete, or the amended indicator is set to Amend Indicator of Publish. The system transfers the compensation administrator to the Publish Statement page, which will enable the compensation administrator to publish total rewards statements to My Total Rewards. Note. There is an order of precedence for enabling the main process steps when amending employees. For example, if an employee has Amend Indicator of Extract and another employee has Amend Indicator of Build, then extract will be enabled first, and the build will be enabled after the extract completes. |
Exception Steps
|
Enabled if the statement status is not equal to Defined, The system displays a statement confirmation page indicating to the compensation administrator the impact of canceling the statement. |
|
Enabled if the statement status is Rewards Statement Published. The system transfers the compensation administrator to a page, which will enable the compensation administrator to cancel and reprocess an employee’s total rewards statement. |
Access the Validate External Data page (click the Validate push button on the Administer Statement page).
This page serves as a reminder to the compensation administrator that external reward items are associated to the template being used to generate a total reward statement and to verify that external rewards data has been loaded into PeopleSoft.
External Reward Items
Reward Item ID |
An abbreviation that uniquely identifies the total rewards statement to be generated. |
Description |
A description of the total rewards statement. |
Access the Extract Total Rewards Data page (click the Extract icon on the Administer Statement page).
Note. If the compensation administrator has amended individual total rewards statements for the Extract Process, the system displays a grid detailing the amended employees who are ready to be extracted.
Reward Statement ID |
An abbreviation that uniquely identifies the total rewards statement to be generated. |
Description |
A description of the total rewards statement. |
Amend Statement for Employees
Employee ID |
Displays the ID of the employee who is ready to be extracted. |
Name |
Displays the name of the employee. |
Statement Status |
Displays the current status of the employee’s total reward statement |
Amend Status |
Displays the amend statement status. For pages that contain specific employee information, it should only display those amended employees that are ready to be extracted. |
Access the Build Total Reward Statements page (click the Build icon on the Administer Statement page).
Note. If the compensation administrator has amended individual total rewards statements for the Build Process, the system displays a grid detailing the amended employees who are ready to have their total reward statements built.
Rate Type |
A required field that specifies the currency conversion rate to use if a reward items requires currency conversion to the employee’s primary job currency. |
Market Rate Index |
A required field that details the currency conversion index to use if a reward item requires currency conversion to the employee’s primary job currency. For more information, see PeopleSoft HCM 9.1 PeopleBook: Components, Working With Currencies and Market Rates, Understanding Currencies and Market Rates. |
Amend Statement for Employees
Employee ID |
Displays the ID of the employee who is ready to have their Total Reward Statements built. |
Name |
Displays the name of the employee. |
Statement Status |
Displays the current status of the employee’s total reward statement. |
Amend Status |
Displays the amend statement status. For pages that contain specific employee information, it should only display those amended employees with Build Reward Statements. |
Here is a high level overview of the Reward Extract process:
Step |
Description |
Perform currency conversion |
The system:
Note. If the currency conversion rate cannot be retrieved for the Rate Type and Market Rate Index specified, then the Reward Build process generates an error message. |
Inserts Reward Items that are configured to Always Display |
The system inserts zero reward item detail for Reward Items that are not extracted, but configured to Always Display. |
Populates the Statement Section Summary |
The system populates the Employee Statement Section Summary table (TRW_EE_STMT_SEC). |
Performs build validations |
The system identifies employees who have a missing section. Note. Reward items that were not extracted may have a section with zero numeric reward amounts. This can occur if Reward items are configured with the Always Display option. |
Updates the Statement Status |
If errors occurred, the system:
|
Generates a detailed output log file accessible through Process Monitor. |
The file name is TRW_RWD_BUILD_INFO.txt. |
Note. When processing the Reward Build to amend a specific list of employee’s, the steps are basically the same except the statement status assigned. The Statement Status assigned will be Amend Build Error or Amend Build Complete.
Access the Publish Statements page (click the Publish icon on the Administer Statement page).
Manage Exceptions
Employee ID |
Displays the ID of the employee who is ready to be published. |
Name |
Displays the name of the employee. |
Statement Status |
Displays the current status of the employee’s total reward statement. Amend Status For this page, it should only display those amended employees that are ready to be published. |
When the compensation administrator clicks OK, all reward statements with reward data are published and available through:
Employee Self Service, My Total Rewards
Manager Self Service, View Total Rewards
Administer My Total Rewards
Reward statements with no rewards data will be placed into a Publish Error status, which generates an error message.
Access the Amend Statements page (click the Amend Statement icon on the Administer Statement page when the statement has reached the Published status stage).
This page enables the compensation administrator to amend or cancel individual employee total rewards statements.
Amend Statement for Employees
Employee ID |
Edit field that allows the Compensation Administrator to select the employee they want to amend. |
Name |
Displays the name of the Employee. |
Statement Status |
Displays the current status of the Employee’s total reward statement. |
Amend Indicator |
Based on the statement status, this drop down menu displays the valid Amend Indictor that can be selected. For example, if the employee’s statement is Built, the Amend Indicator can only be set to Extract, Publish, or Cancel. Listed below are the Amend Indicators:
If an employee’s statement is set to the Amend Indicator of Cancel, then the total reward statement status will be set to Cancelled and it will no longer be accessible. A cancelled reward statement can be set to the Amend Indicator of Extract to process it and make it accessible again. Note: When a reward statement is being amended, it will not be accessible. |
Access the Administer Statement Messages page (click the Check Messages link on the Administer Statement page).
Messages
Employee ID |
Display-only field that identifies the Employee ID to which the message refers. Note: The employee ID field is hidden if no employee ID is populated. |
Message Set Number |
Display-only field that displays the Message Set Number of the message. |
Message Number |
Display-only field that displays the Message Number of the message. |
Description |
Display-only field that displays the long description of the Message Catalog entry for the Message Set Number and Message Number displayed. |
Access the Statement Summary page (click the View Statement Summary link on the Administer Statement page).
Employee Process Counts
Processed |
Displays the total number of employees who have a row in the Employee Statement record for the statement ID displayed. |
Extracted |
Displays the total number of employees who have the reward extract date populated in the Employee Statement record for the statement ID displayed. |
Built |
Displays the total number of employees who have the statement build date populated in the Employee Statement record for the statement ID displayed |
Published |
Displays the total number of employees who have the statement published date populated in the Employee Statement record for the statement ID displayed. |
Cancelled |
Displays the total number of employees who have an employee statement status set to CAN for Canceled for the statement ID displayed. |
By Reward Item
Section Label |
Description of the section. |
Reward Item ID |
ID of the reward item. |
Reward Item |
Description of the reward item. |
Total Extracted Employees |
Displays the total number of distinct employees who have extracted data for the reward item. |
This section provides an understanding section and discusses how to:
View and print the My Total Rewards statement.
View reward item details.
The My Total Rewards is the communication tool used to inform employees or make them aware of their total rewards. This on-line transaction is a self service application available to every employee with security access. It is similar to viewing payroll information such as pay checks or W-2 documents.
The My Total Rewards application retrieves the employee’s information from the login credentials (user ID and password). The layout and content of these pages is defined by the compensation administrator.
When selected, each reward item that is displayed as a link takes the user to a details page that contains further information about the item. The additional information consists of the individual pay items that make up the reward item. The displayed data is configured by the administrator in the Define Reward Data Source and Define Reward Item pages. Typically, the compensation administrator will configure the Holiday Pay reward item in the Cash Rewards grid in the Cash Pay tab.
Employees with Multiple Jobs
The My Total Rewards page is also available for employees with multiple jobs to review their total rewards in a single statement. This on-line transaction functions exactly the same for employees with a single job.
For example, an employee with multiple jobs will see in the Reward Item details of his Total Rewards Statement his or her job titles and the associated reward amounts. All amounts are converted to the employee’s current primary job’s currency.
Page Name |
Definition Name |
Navigation |
Usage |
My Total Rewards |
TRW_SS_STMT_TABS |
Self Service, Payroll and Compensation, My Total Rewards |
Review compensation and benefit summary information for a particular reward period. You can also view a summary chart that shows graphical representation of compensation and benefit summary information. |
View Total Rewards |
TRW_SS_STMT_TABS |
Manager Self Service, Compensation & Stock, View Total Rewards |
Review compensation and benefit summary information for a manager’s direct report employees for a particular review period. Managers will have access to view all total rewards. |
Administer My Total Rewards |
TRW_SS_STMT_TABS |
Compensation, Total Rewards, Administer My Total Rewards |
Review compensation and benefit summary information for the compensation administrator. The compensation administrator will have access to the same view of the employee’s total reward statement. |
Reward Item Details |
TRW_SS_STMT_DETAIL |
Click one of the links under the Item column on the My Total Rewards page. |
View details for each Reward Item that is displayed as a link. When selected, the system takes the user to a pop-up window that contains further information about the Item. The additional information consists of the individual pay items that roll into the Reward Item. The data displayed here is configured by the administrator in the Define Reward Data Source and Define Reward Item pages. |
Access the My Total Rewards page (Self Service, Payroll and Compensation, My Total Rewards).
Rewards Period |
A date range that represents the time boundaries for the summary amounts that are displayed on the page. You can use this field to toggle between the available total rewards statements. The Rewards Period label is configured by the compensation administrator. |
Printer Friendly Version |
When you click this link, a long page view replaces the tab view and a new browser page opens. |
Expanded View and Tabbed View |
Use these links to toggle between an expanded long page view and a tabbed view of the page. |
View Summary Chart |
A View Summary Chart icon is displayed if a chart was configured in the template. The compensation administrator determines whether or not to display a chart and the chart type. When you click this link, the system displays a configured chart image. The system displays the tabs and sections depicting the various groupings of rewards available in the total rewards statement. The number of tabs, tab labels, and tab order are all configured by the compensation administrator. |
Access the Reward Item Details page (Click one of the links under the Item column on the My Total Rewards page).
The system displays this particular window if you click the Health Insurance link that appears under the Health and Life Benefits tab on the My Total Rewards page.
Note. When the rewards statements are processed, all amounts are converted to the primary Job record’s currency so that the amounts may be summed up for each section as well as for the statement’s summary.