Professional Documents
Culture Documents
Hrms91hhaf b1110 PDF
Hrms91hhaf b1110 PDF
1
Application Fundamentals
PeopleBook
November 2010
PeopleSoft Enterprise HRMS 9.1 Application Fundamentals PeopleBook
SKU hrms91hhaf-b1110
Copyright 1988, 2010, Oracle and/or its affiliates. All rights reserved.
Trademark Notice
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their
respective owners.
Warranty Disclaimer
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find
any errors, please report them to us in writing.
Preface
Chapter 1
Chapter 2
Chapter 3
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. iii
Contents
Chapter 4
Chapter 5
iv Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. v
Contents
Chapter 6
Chapter 7
vi Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 8
Chapter 9
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. vii
Contents
Chapter 10
Chapter 11
viii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. ix
Contents
Chapter 12
Chapter 13
x Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 14
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xi
Contents
Pages Used to Run the Federal HRMS Setup Reports .......................................................................... 385
Viewing the Project Costing and General Ledger Business Unit Tables ................................................... 386
Chapter 15
Chapter 16
Setting Up and Working with ChartFields and ChartField Combinations ......................................... 405
xii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Pages Used to Review or Update the Standard ChartField Configuration Template ........................... 414
Importing the ChartField Configuration From PeopleSoft Enterprise Financials ................................ 415
Reviewing or Updating the Standard ChartField Configuration Template ........................................... 415
Entering and Maintaining ChartField Values .............................................................................................. 418
Understanding ChartField Import from Financials ............................................................................... 418
Understanding ChartField Values for Other Financials Systems ......................................................... 420
Understanding Affiliate ChartFields ..................................................................................................... 421
Understanding Project Costing ChartFields .......................................................................................... 421
Pages Used to Set Up and Review ChartFields ..................................................................................... 422
Adding Project and Grant Values .......................................................................................................... 427
Adding Alternate Account Values ........................................................................................................ 428
Entering and Maintaining Valid ChartField Combinations ........................................................................ 430
Understanding Combination Codes ...................................................................................................... 430
Understanding Valid Combination Table Loading ............................................................................... 431
Understanding Speed Types .................................................................................................................. 433
Pages Used to Enter and Review ChartField Combinations ................................................................. 433
Running the Load Combination Code Process .................................................................................... 434
Defining Combination Codes ................................................................................................................ 435
Reviewing and Maintaining ChartField Transactions ................................................................................ 437
Understanding the ChartField Transaction Search Page ....................................................................... 438
Understanding the ChartField Transaction Table ................................................................................. 438
Pages Used to Review and Maintain ChartField Transactions ............................................................. 438
Reviewing and Maintaining ChartField Transactions .......................................................................... 439
Editing ChartField Combinations in HRMS Transactions .......................................................................... 440
Understanding ChartField Validation ................................................................................................... 440
Pages Used to Edit ChartField Combinations in HRMS Transactions ................................................. 441
Editing or Reviewing ChartField Details .............................................................................................. 441
Searching by Combination Code ........................................................................................................... 443
Searching by Speed Type ...................................................................................................................... 443
Chapter 17
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xiii
Contents
Chapter 18
xiv Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 19
Chapter 20
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xv
Contents
Establishing the Locations for Which You Process Payroll and Taxes ............................................... 520
Associating Provinces, States, and Localities with the Tax Location Code ........................................ 520
Chapter 21
Chapter 22
xvi Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 23
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xvii
Contents
Chapter 24
xviii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 25
Chapter 26
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xix
Contents
Chapter 27
xx Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 28
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxi
Contents
Chapter 29
xxii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 30
Chapter 31
Chapter 32
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxiii
Contents
Chapter 33
Chapter 34
xxiv Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 35
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxv
Contents
Chapter 36
xxvi Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Chapter 37
Working with PeopleSoft Directory Interface for PeopleSoft HRMS ................................................. 931
Chapter 38
Chapter 39
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxvii
Contents
Chapter 40
Appendix A
Building Applications or Batch Programs that Include Group Build Functions ........................................ 995
Implementing PeopleCode API Calls .................................................................................................. 995
Implementing PeopleSoft Application Engine API Calls .................................................................. 1001
xxviii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Appendix B
Appendix C
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxix
Contents
xxx Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxxi
Contents
Appendix D
xxxii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Contents
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxxiii
PeopleSoft Enterprise HRMS Application
Fundamentals Preface
This preface discusses:
PeopleSoft products.
Additional resources.
Deferred processing.
Note. PeopleSoft Enterprise HRMS Application Fundamentals PeopleBook provides you with essential
information describing the setup and design of your HRMS system. For information about how to implement
and process information for specific products, see the individual PeopleBooks for the appropriate HRMS
application.
PeopleSoft Products
This PeopleBook refers to the following PeopleSoft product suite: PeopleSoft Enterprise HRMS.
Deferred Processing
Several pages in PeopleSoft HRMS applications operate in deferred processing mode. Most fields on these
pages are not updated or validated until you save the page or refresh it by clicking a button, link, or tab. This
delayed processing has various implications for the field values on the page. For example, if a field contains a
default value, any value that you enter before the system updates the page overrides the default. Another
implication is that the system updates quantity balances or totals only when you save or otherwise refresh the
page.
Address 1, Address 2, Freeflow text entry fields that enable you to describe street, street number,
Address 3 apartment number, and other address information.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxxv
Preface
As of Date The last date for which a report or process includes data.
Block (Bloque) In Spanish addresses, a building or buildings that are close together may be
called a Block (Bloque). Include the Block name in the address, if necessary.
Country Country for address. Other address fields will be adjusted to reflect Country
choice. Select a country from the list of valid values and press TAB to move
through the field. The system automatically displays the appropriate address
fields using the standardized address formats previously set up in the Country
Table. Enter the appropriate address data in the fields that appear.
Description Freeflow text up to 36 characters that describes what you are defining.
Effective Date Date on which a table row becomes effective; the date that an action begins. For
example, if you want to close out a ledger on June 30, the effective date for the
ledger closing would be July 1. This date also determines when you can view and
change the information. Pages or panels and background processes that use the
information use the current row.
EmplID (employee ID), Unique identification code for an individual associated with your organization.
Person ID, and ID
Empl Rcd# (Employee A system-assigned number that indicate a person has more than one job data
Record Number) record in the system.
Fax (also Fax Number) The fax number for a person or organization.
xxxvi Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Preface
Language or Language The language in which you want the field labels and report headings of your
Code reports to print. The field values appear as you enter them. Language also refers
to the language spoken by an employee, contingent worker, person of interest, or
applicant.
Last Run On The date that a report or process was last run.
National ID Identification code used by countries to track information on their residents for
payroll, identification, benefits, and other purposes. For example, for US
residents this would be their Social Security Number; for German residents it
would be their Social Insurance Number, and for UK residents it would be their
National Insurance Code.
Number The number related to a street, avenue, or other address field in Spanish
addresses. When an address has no number, enter s/n (sin numero) to indicate
that there is no number.
Phone Type Identifies the type of phone number entered in the Telephone field. Valid values
are Business, Campus, Cellular, Dormitory, FAX, Home, Other, Pager 1, Pager
2, or Telex.
Prefix Prefix for individual (such as Mr., Ms., Mrs., Dr., and so on.)
Process Frequency group Designates the appropriate frequency in the Process Frequency group box: Once
box executes the request the next time the background process runs. After the
background process runs, the process frequency is automatically set to Don't
Run. Always executes the request every time the background process runs. Don't
Run ignores the request when the background process runs.
Process Monitor Click this button to access the Process List page, where you can view the status
of submitted process requests.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxxvii
Preface
Regulatory Region A regulatory region can be any region where there are specific laws and
regulations that are addressed by functionality in PeopleSoft Enterprise Human
Resources. Many country-specific transactions are driven by regulatory
requirements where Regulatory Region is used for transaction processing.
Report ID Identifies a report. Report Manager Click this button to access the Report List
page, where you can view report content, check the status of a report, and see
content detail messages (which show you a description of the report and the
distribution list).
Request ID A request identification that represents a set of selection criteria for a report or
process. Run Click this button to access the Process Scheduler request page,
where you can specify the location where a process or job runs and the process
output format.
Run Date The date that a process was run or a report was generated.
Run Time The time that a process was run or a report was generated.
SetID An identification code that represents a set of control table information. SetIDs
enable the sharing of a set of control table information across two or more
Business Units.
Street Type Identifies whether an address is a place, street, avenue, road, or so on. Spanish
law requires addresses in official documents to include the Street Type.
User ID The system identifier for the individual who generates a transaction.
See Also
xxxviii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Preface
Format Using Select the country with name format appropriate for this person. The system will
display the appropriate fields for this format in the Person Name group box.
Refresh the Name Field Click to refresh the Name field after you've edited any of the name fields. The
system will refresh the name field when you save.
The following fields appear in the Person Name group box. You will not see all of the fields listed below at
any one time. The system displays the fields necessary for the country you select in the Format Using field.
Title Select a title. If you are reporting workforce information under the German
Duevo Directive, this field is required and must be completed according to the
Duevo rules.
Preferred First Name For The Netherlands, enter the person's preferred first name, if different from the
First Name. The system will use the preferred name when you generate form
letters or mailing labels for this person.
Last Name Preference For the Netherlands, choose this link to provide additional name information for
married people. The Last Name Preference page contains three fields: Last Name
Partner,Prefix Partner, and Last Name Preference.
Second Last Name For Spanish persons, enter the second surname (mother's surname).
Alternate Character Use this field to enter the person's name using alternate characters (such as
Name Japanese phonetic characters).
Note. You can enter names using Japanese characters with or without a space
between the surname and given name. Names using Roman alphanumeric
characters require a comma delimiter.
Warning! Be sure to select the correct character set on the Installation Table
Alternate Characters page. Using the wrong character set generates an error
message.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xxxix
Preface
Royal Suffix Select the appropriate royal suffix. If you are reporting workforce information
under the German Duevo Directive, this field is required and must be completed
according to the Duevo rules.
Name The system displays the person's name as it will appear in the system.
Pages that display personal name fields usually display them in First Name, Last Name order. When the
country is Japan, however (JPN in the Format Using field), those fields appear in the Last Name, First Name
order.
Another difference is that the Name field displays "Last Name[space]First Name," not "Last Name,First
Name"; that is, a space separates the last and first names, not a comma.
See Chapter 8, "Setting Up and Working with Languages," Working with Alternate Character Sets, page 193.
Amounts Tab
Rate Code Rate codes are IDs for pay components. The system inserts any compensation
information associated with this rate code in the compensation grid.
Note. If a seniority rate code is inserted as a default value on the Job Data -
Compensation page, the values for these rate codes are unavailable for entry.
Seq (sequence) The sequence number of the rate code if it is used more than once.
Comp Rate The compensation rate, its currency, and the frequency (for example, annually,
(compensation rate), weekly, or hourly) the comp rate will be paid.
Currency, and
Frequency
Points The salary points associated with this rate code, if any.
xl Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Preface
Percent If the rate code rate type is Percent, the system displays the percent to be applied
to the job compensation rate or to a rate code group if you are using rate code
groups.
Rate Code Group A rate code group enables you to be more specific when calculating percentages
based components as part of your workforce compensation package.
Controls Tab
Source The system displays the source of the rate code, such as Absorbing Premium,
Seniority Pay, Job Code, or Manual.
Manually Updated The system selects this if you have manually updated the pay components.
Default Without Selected if the worker's compensation package cannot be manually updated on
Override the Job Data - Compensation page.
Changes Tab
Change Amount The overall change amount to this pay component rate.
Change Points The overall change amount (in points) to this pay component, if applicable.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xli
Preface
Change Percent The overall percentage change to this pay component, if applicable.
Conversion Tab
Converted Comp Rate Displays the converted compensation rate for this pay component. The system
converts all base pay components to the Job currency and compensation
frequency.
Apply FTE If selected, the system multiplies the rate code value by the FTE factor for
annualization and deannualization. FTE is the percent of full time the worker
should normally work in the corresponding job. This field isn't available for
Percent rate codes.
See Also
How to access hosted PeopleBooks, downloadable HTML PeopleBooks, and downloadable PDF
PeopleBooks as well as documentation updates.
xlii Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Preface
Navigating the PeopleBooks interface and searching the PeopleSoft online library.
How to manage the locally installed PeopleSoft online library, including web site folders.
Understanding documentation integration and how to integrate customized documentation into the library.
You can find PeopleBooks and the PeopleSoft Online Library in the online PeopleBooks Library for your
PeopleTools release.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. xliii
Chapter 1
The sophisticated features and collaborative, self-service functionality available in PeopleSoft HRMS enable
you to manage your human resources from recruitment to retirement while aligning your workforce initiatives
with strategic business goals and objectives.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1
Getting Started with PeopleSoft Enterprise HRMS Chapter 1
PeopleSoft HRMS also provides component interfaces to help you load data from your existing system into
PeopleSoft HRMS tables. Use the Excel to Component Interface utility with the component interfaces to
populate tables.
This table lists all of the components documented in the PeopleSoft Enterprise HRMS Application
Fundamentals PeopleBook that have component interfaces:
Job Code Task Table component JOBCODE_TASK_TABLE See Chapter 13, "Setting Up Jobs,"
(JOBCODE_TASK_TABLE) Defining Job Tasks, page 354.
Job Code Table component CI_JOB_CODE_TBL See Chapter 13, "Setting Up Jobs,"
(JOB_CODE_TBL) Classifying Jobs, page 334.
Pay Run Table (PAY_RUN_TABLE) PAY_RUN_TABLE See Chapter 19, "Setting Up Pay
Calendars," Creating Pay Run IDs,
page 486.
See Also
2 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 2
Understanding HRMS
This chapter discusses:
Effective dates.
Note. This chapter introduces you to some of the basic concepts used through PeopleSoft HRMS.
Tables that are central to PeopleSoft HRMS include control tables, transaction tables, and prompt tables.
Control Tables
Control tables store information that is used to process and validate the day-to-day business activities
(transactions) users perform with PeopleSoft HRMS applications.
The information stored in control tables is common and shared across an organization, for example, master
lists of customers, vendors, applications, items, or charts of accounts. By storing this shared information in a
central location, control tables help to reduce data redundancy, maintain data integrity, and ensure that users
have access to the same basic information.
The information stored in control tables is generally static and is updated only when fundamental changes
occur to business policies, organizational structures, or processing rules.
Note. Control tables are tables that include the SETID key field (setID). As you set up control tables, you'll
notice that it is the setID that enables control table information to be shared across business units.
Transaction Tables
Transaction tables store information about the day-to-day business activities (transactions) users perform with
PeopleSoft HRMS applications.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 3
Understanding HRMS Chapter 2
The information stored in transaction tables often changes and is updated more frequently than the
information stored in control tables.
Note. Transaction tables are tables that include the BUSINESS_UNIT field (which may or may not be used
as a key field).
Prompt Tables
Prompt tables are tables that are associated with fields on PeopleSoft application pages and which display
valid data values for those fields when a user selects a prompt or search option.
The data values stored in prompt tables are retrieved from control tables, transaction tables, or other
PeopleSoft tables.
See Also
Business Units
Business units are logical units that you create to track and report specific business information. Business
units have no predetermined restrictions or requirements; they are a flexible structuring device that enable
you to implement PeopleSoft HRMS based on how your business is organized.
You must define at least one business unit. The BUSINESS_UNIT field is included on all transaction tables.
Tablesets and setIDs are devices that enable you to share or restrict information across business units. For
example, with tablesets and setIDs you can centralize redundant information such as country codes while
keeping information such as departments and job codes decentralized. The overall goal of tablesets and setIDs
is to minimize data redundancy, maintain data consistency, and reduce system maintenance tasks.
You must define at least one tableset (setID). The SETID key field is included on all control tables.
See Also
4 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 2 Understanding HRMS
Effective Dates
PeopleSoft HRMS uses effective dates to store historical, current, and future information. Effective dates
enable you to:
Maintain a chronological history of your data. By storing effective-dated information in tables, the system
enables you to review past transactions and plan for future events. For example, you can roll back your
system to a particular time to perform historical analyses for your company. Or, you can set up tables and
data ahead of time without using tickler or pending files.
Maintain the accuracy of your data. By comparing the effective dates in prompt tables to the effective
dates on application pages, the system displays only those values that are valid for the current time period.
For example, you create a new department code with an effective date of May 1, 2008. Then, on the Job
Data pages, you enter a new data row for an employee with an effective date before May 1, 2008. When
you select the prompt for the department field, you won't see the new department code because it is not in
effect.
See Also
When you drive PeopleSoft Human Resources by person, you use job codes to classify job data into groups.
You use those codes to link person data to job data. When you drive PeopleSoft Human Resources by
position, you still use job codes to create general groups, or job classifications, in your organization, such as
EEO (equal employment opportunity) and salary survey data, but you also uniquely identify each position in
a job code and link people to those positions.
Job codes primarily have a one-to-many relationship with workers. Many workers share the same job code,
even though they might perform the work in different departments, locations, or companies, as shown in the
diagram below. You identify the job that a worker performs through the data that you enter in the worker's
job records:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 5
Understanding HRMS Chapter 2
In contrast, positions usually have a one-to-one relationship with workers. However, you can have several
positions with the same job code; positions track details of a particular job in a specific department or
location. For example, in job code 1020, Administrative Assistant, you can define different administrative
assistant positions with different position numbersposition 15 in accounting, position 16 in the human
resources department, position 17 in your marketing department, and position 18 in your production group.
Workers are then assigned to these specific positions. The following diagram represents this method:
6 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 2 Understanding HRMS
When you drive your system by position, you define specific attributes of various positions and then move
workers in and out of those positions. You track specific information that is related to a position, such as a
phone number or mail stop, regardless of whether a person actually fills that position. And you use data that is
specific to each position as the basis for organization planning, recruitment, career planning, and budgeting.
You won't see much difference between the two methods as you work with pages and tables, but the system
processes the data differently according to whether you drive it by person or position. That affects how and
where you enter and maintain data for people and positions (or jobs).
To determine whether you should drive your system by person or position, consider the following:
If your organization is fluid (that is, if you tend to look at broader groups of workers and create new jobs
often), then driving the system by person is probably best for you.
This method is useful if your organization is continually expanding or if new projects require that you
create new jobs or job types regularly.
If your organization is fairly static (that is, if jobs and job descriptions are mostly fixed, and people move
in and out of the same positions), then driving the system by position is probably best for you.
For example, government agencies and hospitals, which plan positions based on budgets (often well in
advance of filling the positions), find this method very useful.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 7
Understanding HRMS Chapter 2
If you find that both methods work well in different areas of your organization, you can drive PeopleSoft
Human Resources both ways.
For example, you might find that driving the system by position works well for some departments or
management levels in your company and that driving the system by person works well for others. If so,
you can use both methods with a setting called partial position management.
Note. This decision doesn't affect your PeopleSoft payroll system. No matter which method you choose,
using PeopleSoft Enterprise Payroll for North America or PeopleSoft Enterprise Global Payroll is not a
problem.
If you use PeopleSoft Enterprise Pension Administration, you track your pension payeesretirees,
beneficiaries, and QDRO (qualified domestic relations order) alternate payeesusing the same tables that
you use to track your workers. You want to drive your retiree organization by person (or in this case, by
payee), rather than by position, so that you don't have to establish a different position for each payee in the
system. To drive your worker organization by position and your payee organization by person, use the partial
position management option.
This also applies to organizations that use PeopleSoft Global Payroll and PeopleSoft Payroll for North
America. If your organization uses the PeopleSoft Human Resources Manage Base Benefits business process
or PeopleSoft Enterprise Benefits Administration, you can set up your position management options using
full or partial position management.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the Workforce"
8 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3
PeopleSoft HRMS system data is regulated through the use of business units, tablesets and setIDs, and
tableset sharing. Business units are logical devices that enable you to implement PeopleSoft HRMS based on
how your business is organized. Tablesets, setIDs, and tableset sharing are organizational devices that enable
you to share or restrict the information stored in your HRMS system across business units:
TableSet Set of rows on a control table, grouped by setID, that is available to specific
business units.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 9
Working with System Data Regulation in HRMS Chapter 3
Component Location
Org Defaults by Permission Lst component Set Up HRMS, Foundation Tables, Organization, Org
(OPR_DEF_TBL_HR) Defaults by Permission Lst
See Chapter 11, "Setting Up Organization Foundation
Tables," Setting Up Primary Permission List
Preferences, page 312.
Business Unit Options Defaults component Set Up HRMS, Foundation Tables, Organization,
(BUS_UNIT_OPT_HR) Business Unit Options Defaults
See Chapter 11, "Setting Up Organization Foundation
Tables," Setting Business Unit Defaults, page 241.
Prerequisites
Before you implement PeopleSoft HRMS, take a close look at how your business operates and analyze how
you want to map your organization's business structures, practices, and procedures.
You can set up business units and tableset IDs before or after setting up the Installation Table component
(INSTALLATION_TBL) and entering companies on the Company component (COMPANY_TABLE).
However, you should set up the Installation Table component and Company component before continuing on
to the TableSet Control component, Business Unit Options Defaults component, and Org Defaults by
Permission Lst component.
10 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
Business units share processing rules and you can create them at any level of the organization that makes
sense and that reflect the needs of your internal human resources departments. If you use the same processing
rules across the organization, it may make sense to have a single business unit; if you use different rules in
different companies, countries, or functional areas, you may choose to create multiple business units.
Because PeopleSoft HRMS doesn't offer any predetermined definition for a business unit (as it does for a
department and a company), you can implement this organizational level in your PeopleSoft HRMS
applications to reflect your own enterprise's structure. You can share business units across any combination of
PeopleSoft Enterprise HRMS, Financials, Manufacturing, and Distribution applications or define them in just
one PeopleSoft Enterprise application.
Note. For PeopleSoft HRMS, you must establish at least one business unit.
You have complete control over how you define business units in your PeopleSoft HRMS system, as well as
how you use them to facilitate the handling of data in your data organization. For example, you could set up a
business unit for each legal entity in your organization, all to be processed by a central human resources
department that interfaces with and manages each business unit's information, workers, and processes.
Alternatively, you could set up one business unit for each company, location, or branch office in your
enterprise, enabling each unit to manage its own human resources information independently, while sharing
data with a central, parent business unit.
While each business unit maintains its own human resources information, your organization can maintain a
single, centralized database, reducing the effort of maintaining redundant information for each business unit.
More importantly, as this diagram illustrates, you can produce reports across business units, enabling you to
see the big picture and to compare the finest details.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 11
Working with System Data Regulation in HRMS Chapter 3
See Also
Chapter 2, "Understanding HRMS," Control Tables, Transaction Tables and Prompt Tables, page 3
With business unit functionality, you have another level for associating a person with your company's
organizational scheme.
Business units are always associated with a job, position, and a person's job record.
Business units have no predetermined definition (unlike department and a company). You can implement
this new organizational level as you determine its usefulness to your enterprise.
Business units are not legal entities, but a way of tracking specific business information for reporting and
other rollup data collection.
Work closely with your PeopleSoft implementation partner early in your design to determine how best to
define the business units for your PeopleSoft HRMS system. Every organization has different requirements,
and it's not possible to cover all the variables that you might encounter. However, once you've identified your
business unit structures and made a tentative decision about how many business units you'll need, take a step
back and ask the following questions:
Are the business unit structures and number of business units correct?
Will these structures preclude me from taking advantage of some functionality that I might want to use?
Will these structures cause me to process more than I want to process on any particular night?
How you define a business unit depends on your industry, statutory requirements, regulatory reporting
demands, or how you've organized operating responsibilities. Consider the following scenarios and the
supporting diagram below:
789 Inc. chooses to organize information by functionality or purpose, such as what is going on in Sales
versus Customer Service. It has created business units that reflect the administrative needs of their human
resources, benefits, and payroll departments.
LGC Banking treats each branch as a business unit, which means that the bank could do reporting for its
people within each branch.
12 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
123 Global Business is a multinational company that separates its operations geographically because of
the necessities of conducting business abroad. What is more important to this organization may not be
each office, but each location. What's happening in their American facility versus their European or Asian
market? Then they can track their business requirements and business needs accordingly.
XYZ Entertainment has subsidiary companies. A highly diversified organization like this one might
choose to define each subsidiary company or cost center as a business unit. They might have a hotel
business as well as a retail business and they might want to keep this information separate, yet still be able
to roll everything up into one database and maintain it in a single location.
Business units can be set up to represent functional areas, branches, regions, subsidiaries, or what best fits
your organization's needs
You can also use a combination of all of these methods, or any other entity or entities that makes sense for
your organization. You can have as many business units as you need, although the more business units you
establish, the more information you need to maintain. You do, however, need to have at least one business
unit in the system.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 13
Working with System Data Regulation in HRMS Chapter 3
While you can implement one business unit for your entire organization, establishing multiple business units
can offer important reporting and data control options. Multiple businesses units enable you to:
For large or multinational companies, this feature of business unit functionality in PeopleSoft HRMS is
useful for controlling data flow across different parts of the enterprise.
Note. If you implement PeopleSoft Enterprise Benefits Administration, you can define eligibility rules that
determine workers' benefits eligibility based on their business unit affiliation.
Understanding Tablesets
To work with tablesets, you need to be able to distinguish between tablesets, setIDs, and tableset sharing:
tableset A set of data rows in a control table that is identified by the same highlevel key.
setID The highlevel key that identifies a set of data rows. There are two types of
setIDs:
Physical SetIDs
Logical SetID
A logical setID that is generic and determined by business rules other than
business unit. Logical setIDs enable you to share rows of data across multiple
business units.
tableset sharing Sharing rows of data in a tableset across business units or limiting rows to a
single business unit.
14 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
Note. The terms tableset and setID are sometimes used interchangeably. In many cases, this is correct, but it
can cause some confusion.
You can define as many tablesets as you like, but the more you create, the more complex tableset sharing
becomes. Some organizations need only one tableset.
Note. For PeopleSoft HRMS, you must create at least one tableset and setID.
Since you use setIDs to distinguish sets of rows in a table, you will always have the same number of setIDs as
you have tablesets. For example, the following diagram shows four control tables. Each color within the table
represents a setID, and all rows with the same color represent a tableset. Tables A and B are made up of three
tablesets each, and tables C and D consist of four different tablesets, but there is a total of five setIDs, or
tablesets, between the four tables:
SetIDs differentiate rows of data in a table and identical setIDs make up tablesets
PeopleSoft Enterprise Human Resources control tables that are keyed according to setID include the:
Location component.
Department component.
Tableset Sharing
Tableset sharing enables you to share some or all of your control table data from business unit to business
unit, instead of having to enter the same data multiple times. The key to sharing that information is
determining which rows of data can be shared across business units, which should be shared across some
business units but not others, and which should be restricted.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 15
Working with System Data Regulation in HRMS Chapter 3
For example, you can centralize redundant information such as country codes in a setID that is shared while
keeping information such as departments and job codes decentralized amongst different setIDs. The goal of
tableset sharing is to minimize data redundancy, maintain data consistency, and reduce system maintenance
tasks.
Tablesets form the building blocks of your HRMS system. You populate the individual tables in the tableset
according to your particular business rules or processing options. You can also mix and match tablesets by
updating tableset assignments for a business unit using the TableSet Control component (SETID_TABLE).
You aren't required to share all tables in a tableset. With PeopleSoft HRMS, you can share any combination
of tables with any number of business units, according to your needs. Use the TableSet Control page to
identify which data should be shared and how it should be shared for each business unit.
This diagram shows how one tableset is shared across all three business units in an organization for one group
of records, the job code records, and for another group of records, the location records, each business unit
uses it's own setID. For the third group of records, salary plans, one table set is shared between two business
units, ABC and QRS, but the third business unit, XYZ, uses the values created under another setID:
Table sets can be shared across business units or be unique to a business unit
For the purpose of tableset sharing, control tables are divided into record groups. A record group is a set of
control tables and views that use the same group of setIDs in the same manner.
They save time by enabling you to set up tableset sharing without an enormous amount of redundant data
entry.
They act as a safety net by ensuring that tableset sharing is applied consistently across all related tables
and views in your system.
A record group can contain a single table or many tables and views. You can update or modify which tables
and views are included in each record group by using the Record Group component.
When you create a business unit, you must assign to it a default setID. You have two options:
16 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
If you want to create rows of data in the control tables that should be used only by this new business unit,
create a setID for the business unit when you create the business unit.
You can create a setID at the time you create a business unit by accepting the business unit code in the
SetID field. When you do this, the system creates a record setID on the TableSet IDs component when
you save the business unit.
Note. This is the best option if you are only using one business unit.
If you want the business unit to share rows of table data (tableset sharing) with other business units, select
the existing setID that is or will be associated with the data rows you want to make available to this
business unit.
Regardless of which option you choose, when you save the business unit the system creates an entry in the
Tableset Control component for that business unit and associates with each record group the default setID you
selected for the business unit. You can change the setID assignment in the TableSet Control component.
This diagram shows the relationship between setIDs and business units and illustrates the information the
system creates for the business unit in the TableSet Control component where you can change some or all of
the setID assignments:
Tableset controls determine which tableset a business unit uses for which record group
Record groups
Business units
SetIDs
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 17
Working with System Data Regulation in HRMS Chapter 3
When you create and save a business unit, the system creates a record in the TableSet Control component for
the business unit (the Set Control Value) and populates the setID for each record group with the setID you
selected for the business unit. If you want the business unit to have access to the rows in other setIDs for
certain record groups, change the default setID to the appropriate setID. This means that a lot of tableset
sharing setup is done for you behind the scenes.
USA
JOBCODE_TBL
HR_02
4. What setID is assigned to that record group for this business unit?
SHARE
5. What rows in the control table (Job Code Table) are keyed by that setID?
a. The system looks only for the job code with the SHARE setID values.
b. The system makes available to the user only the rows keyed by the SHARE setID.
This diagram shows the tableset controls for the USA business unit and illustrates how the system determines
which job code values to display for that business unit, as described above:
18 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
Retrieving valid control table values for a field based on business unit tableset control setIDs
If the user were accessing a field whose control table was in record group HR_01, the system would display
the values keyed by the setID USA from the corresponding control table. The data the system makes available
to the user depends on the setID specified in the TableSet Control component for the record group that
contains the control table the user is accessing.
Two scenarios exist in PeopleSoft HRMS where a table that is keyed by one setID also has fields that prompt
onto another setID table:
Scenario 1: A Control Table with Multiple SetIDs, but No Defaults Based on Those SetIDs
An example of a control table that is associated with multiple setIDs is the Departments component
(DEPARTMENT_TBL). The record for the component, DEPT_TBL, has two setIDs: the setID for the
department and the setID for the department's location. The setID for the location prompt comes from the
LOCATION_TBL record.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 19
Working with System Data Regulation in HRMS Chapter 3
In this situation where this is a department setID and a location setID, you can set up the component so that
the system makes available in the Location field:
Locations that share the same setID and the department's setID.
Making all locations available may cause problems if a user creates a department with a location in a setID
that is not used by any business unit with access to the department's setID. Making only one location setID
available could cause problems if business units with access to the department's setID use different location
setIDs.
For example, an organization has the following tableset controls set up for its four business units for the
DEPT and LOCATION record groups:
If you limited the location setID to the setID of the department, you would not be able to set up departments
with a valid location for the ASIA and RUSS business units. If you made all locations in all setIDs available,
you run the risk of users creating a department in setID USA with a location in setID EURO.
To limit the locations available to a department, while still accommodating the different tablesharing
arrangements, you could limit the location setIDs to USA and ASIA when the department setID is USA and to
RUSS and EURO when the department setID is EURO.
20 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
Scenario 2: A Transaction Table with Multiple SetIDs Controlling Defaults Across the
Transaction Record
An example of a transaction table that has multiple setIDs controlling defaults across the record is the Job
Data component (JOB_DATA).
When you create a job data record for someone, you select a business unit on the Work Location page
(JOB_DATA1). The system uses the business unit's tableset controls to determine which values to make
available in other fields on the component and when to use established defaults.
The system only displays departments that are in the setID selected for the business unit and defaults in the
department's location only if the location is in a valid setID for the business unit. Locations have associated
salary plans, and the system defaults in the location's salary plan only if the salary plan is in a valid setID for
the business unit. If a default value is not in a valid setID for the selected business unit, the system leaves the
field blank and the user selects a value from the options in the valid setID.
For example, in the Job Data component, select the business unit, such as PDEV as shown in this diagram.
The system references the tableset controls for that business unit to determine the valid setIDs for many of the
other fields on the component, such as Department, Location, and Salary Plan:
Select the business unit, which determines the valid setIDs for many fields in the component
When you select the Department lookup button in the Job Data component, the system references the
TableSet Control table for the record group row that determines which department setID is available for this
business unit. Since USA is the designated setID for the department record, the system only displays in the
search list those departments with the USA setID. In the diagram below this would be departments USA-
00001 and USA-00002:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 21
Working with System Data Regulation in HRMS Chapter 3
The system only displays values keyed by the designated setID identified for this field's prompt table for this
business unit
The system also checks to see if the setID of the location associated with the department is valid for this
business unit. In this example, only locations with the setID USA should be valid for the PDEV business unit.
When the location associated with the department uses the setID USA, such as department USA-00001,
which is associated with location USA-NY, the system enters the default location in the Location field. If you
were to select department USA-00002, the location associated with this department, with the setID ASIA,
will not default into the Location field. The system leaves the Location field blank:
22 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
The system only enters the default location value from the Department table if it is in a valid setID for the
person's business unit
If the salary plan is associated with the location, the system checks the TableSet Control record for the
business unit, in this example PDEV, to see if the setID of the salary plan associated with this location is valid
for this business unit. Since valid values for this business unit should be associated with the USA setID, and
the salary plan associated with the USA-NY location uses a salary plan setID of SHARE, the salary plan will
not be provided by default into the worker's record:
The system does not enter the default value if the value's setID is not valid for the business unit
When you select a salary plan, the system will only retrieve those rows from the Salary Plan table that begin
with setID USA, as defined on the tableset controls for business unit PDEV:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 23
Working with System Data Regulation in HRMS Chapter 3
You can only view and select from values with the valid setID as defined for the field
Note. Many of the setID driven control tables enable you to review which business units have access to the
selected setID so that, as you set up your control values, you can confirm that they will be available to the
appropriate business units.
One of these permission lists, the primary permission list, determines which default values the system enters
for the user (among other things). On the Org Defaults by Permission List component (OPR_DEF_TBL_HR)
set up primary permission lists with:
24 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
Business Unit
SetID
Company
Country
Regulatory Region
To Currency
When a user logs onto the system, the system references the user's primary permission list to determine which
settings to apply and which values to enter as defaults on components that support primary permission list
defaulting. This helps to ensure that users are entering the right information for the kind of work that they do.
Note. Not all components use the defaults from the primary permission list.
Warning! Not associating system users with permission lists can result in serious data errors in PeopleSoft
Human Resources.
See Also
Using the tableset controls and business unit default options you set up, the system determines the default
values to enter in select fields on the transaction component. The system uses these defaults only on
components where the system identifies the business unit field as a source for default values.
1. On the Tableset Control Record Group page (SET_CNTRL_TABLE1), select the setID that controls
business unit defaulting for this business unit.
2. Enter the setID's default values on the Business Unit Options Defaults component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 25
Working with System Data Regulation in HRMS Chapter 3
When a user accesses a component, which is driven by business unit defaulting, and selects a business unit,
the system determines which setID drives defaulting for that business unit by referencing the record group
BU Defaults on Tableset Control table. For example, for business unit PDEV, the setID for the record group
BU Defaults row is SHARE. The system references the Business Unit Options Defaults component for setID
SHARE to retrieve the default values and then enters those values in the transaction component, as this
diagram illustrates:
The system determines the defaults for a selected business unit by referencing the tableset controls and the
business unit default options
Note. The record group containing the Business Units Options Default record (BUS_UNIT_OPT_HR) is
HR_06.
Setting up business unit defaults on the Business Unit Options Defaults page makes sense when you have
multiple business units that share the same kind of defaults; but shared defaults are not readily organized by
permission list but rather setID.
26 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 3 Working with System Data Regulation in HRMS
This table lists the four most common scenarios in which the system must determine which default values to
use, either the defaults that you defined on the Business Unit Options Defaults component or on the Org
Defaults by Permission List component:
Select a business unit. The system enters the default values from the Business
Unit Default Options component.
Select an EmplID value, but no business unit value. The system determines the person's business unit by
checking the person's JOB record for that EmplID/ERN
combination and then enters the default values from the
Business Unit Default Options component.
The component does not have either the Business Unit The system enters the default values from the Org
or EmplID fields. Defaults by Permission List component.
The component uses a setID without an associated The system enters the default values from the Org
business unit or EmplID value. (This is the situation on Defaults by Permission List component.
most setup and control components, such as the
Location and Department components.)
Warning! The paradigm above isn't strictly followed in the system and should be used as a guideline only.
Actual defaulting at the page level is governed primarily by page functionality.
Note. Some degree of flexibility has been incorporated for exceptions to those pages that don't fall into either
of these categories.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 27
Chapter 4
A regulatory region can be any region where there are specific laws and regulations that are addressed by
functionality in PeopleSoft Human Resources. Many country-specific transactions are driven by regulatory
requirements where Regulatory Region is used for transaction processing. These requirements include areas
such as ethnicity, disability, and health and safety. When driven by Regulatory Region, the regulatory codes,
PeopleCode edits, and set processing in the system can vary by country and for each transaction .
When your system users enter data into PeopleSoft Human Resources, you want them to use the codes and
data that are applicable to the regulatory region that they are working with. Using the Regulatory Region
feature helps ensure that your users focus on the correct data sets, making their data entry faster and more
accurate.
This functionality is especially helpful for organizations that have a multinational workforce. Consider the
following examples where the Regulatory Region concept would be useful for organizing your business data:
An employee officially works in the U.S., but has a health and safety-related incident occur during a
business trip in Canada. Using Regulatory Region in the Incident Details component, your users work
with incident data and codes (body parts, dangerous occurrences, diagnosis codes, and so forth), that are
applicable to the country in which the incident occurred.
Your organization has implemented PeopleSoft Enterprise Benefits Administration and would like to use
its automatic eligibility processing capabilities to determine the benefits enrollment options for your U.S.
and Canadian employees. Because benefits rules in Canada and the United States vary, you can use the
Regulatory Region on the Eligibility Rules table to set up two sets of benefits eligibility rules: one set for
your Canadian workers and another for your U.S. workers.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 29
Working with Regulatory Regions Chapter 4
Transaction (REG_TRX)
Use the Regulatory Region page to view or modify existing regulatory regions and to establish additional
regulatory regions. The regulatory regions you create can be based on countries or regions within countries,
such as states or provinces.
Use the Transaction page to view and modify existing transaction types or to establish and describe new
regulatory transaction types.
Use the Regions In Transaction page to view and modify the regulatory regions that define existing regulatory
transaction types and to establish the regions that define the new transaction types that you create.
The following table shows the relationships between the regulatory region pages that you use to define and
administer regulatory regions in PeopleSoft Human Resources:
These pages do not have an Effective Date or an Effective Status. Both REG_REGION_TBL and REG_TRX
have Related Language tables. You can hide data that you don't want by either making the REG_AVAIL =
NOT or removing it from the transaction's region list.
Note. During configuration, you must create regulatory regions before you can create transactions and
establish the relationship between them. A regulatory region can be used by many transactions.
30 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 4 Working with Regulatory Regions
Note. You don't have to create new regulatory regions. You create new regulatory regions only if there is a
special need, perhaps to accommodate specific local regulations. You do have to use the existing regulatory
regions that are already in the system. If you have operations in only one country, and you want to limit the
impact of Regulatory Region on your data entry users, then you can assign your one region as the default
region in the Org Defaults by Permission Lst component (OPR_DEF_TBL_HR).
Note. Although the scope of a regulatory region can be smaller than a country, PeopleSoft recommends that
the standard Regulatory Region be at the country level.
To simplify matters and provide consistency, we recommend that you use the following naming standard
when creating new regulatory regions:
For new country-level regulatory regions, use the 3-character, ISO-certified country code found in the
Country Table component (COUNTRY_TABLE).
For regions that are smaller than a country, use the 3-character country code and concatenate a 2-character
unique regional identifier. For example, use CCCSS for state-level or province-level regions, where CCC
is the country code and SS is the state or province code. Using this system, the regulatory region code for
Canada - British Columbia is CANBC.
See Also
Chapter 6, "Setting Up and Installing PeopleSoft HRMS," Establishing Regulatory Transaction Types, page
160
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 31
Working with Regulatory Regions Chapter 4
PeopleCode is used to associate the desired Regulatory Transaction type or view with the specific
transactions that are processed on a page. Regulatory Region fields have an edit prompt off the transaction
specific view. The view displays to a user only those countries that are available for that Regulatory
Transaction type and for which the user has security access.
A system of standard defaults assists the user in selecting the appropriate regulatory region and transaction.
Note. Usually you can override the defaults to ensure that the proper regulatory region is assigned to a
transaction.
You can create additional transaction or application views that display only the applicable regions for that
transaction. Place the Regulatory Region field on that transaction record and define an edit prompt in the
transaction-specific view. The view should display only those countries that are available to the user (either
Available to All or With Global Security Only, joined with user Global Security). For example, the
following table shows some regulatory regions that are already in the system:
Transaction Type Reg Region (Char Description (Descr) Country Code Security
10) (Alt-Search) Availability
Status
32 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 4 Working with Regulatory Regions
Transaction Type Reg Region (Char Description (Descr) Country Code Security
10) (Alt-Search) Availability
Status
You can add regulatory regions for your own configuration. For example, you can add the 50 U.S. states and
differentiate at that level for most transactions.
For PeopleSoft Human Resources business process functions that need a different regulatory region for a
transaction than is generally associated with a person, add Regulatory Region to that transaction. Use a
Transaction view (normally STANDARD) from the Regulatory Region table to provide the appropriate
prompt of Regulatory Regions for that transaction.
Once REG_REGION is in a page buffer, you can perform regional edits and set processing.
Note. Be sure to use the Country field (related display) of the region for all country specific edits to ensure
that the user can go to a finer level of detail for other edits.
Job Data (JOB_DATA) Position Data (if the worker is assigned to a position)
or
Org Defaults by Permission Lst (if the worker is not
assigned to a position)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 33
Working with Regulatory Regions Chapter 4
Job Openings (HRS_JOB_OPENING) Position Data (if the job opening is assigned to a
position)
or
Org Defaults by Permission Lst (if the job opening is
not assigned to a position)
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Monitor Health and Safety, "Creating and
Tracking Incidents"
Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List Preferences,
page 312
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Entering Additional Data
in Human Resources Records," Tracking Disabilities
Chapter 11, "Setting Up Organization Foundation Tables," Defining Establishments, page 273
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions,"
Creating Positions
Note. The Regulatory Region field is required on the Job Data pages. On the Job Data pages, you see only the
STANDARD list of regulatory regions to which you have security access.
For Health and Safety transactions or incidents, the Regulatory Transaction type HANDS is used because it
includes the Canadian provinces as regulatory regions. The Regulatory Region value on the Org Defaults by
Permission Lst component appears by default on the Incident Data and Incident Reporting pages.
34 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 4 Working with Regulatory Regions
SELECT
S.OPRID,
R.REG_REGION,
R.DESCR50,
R.COUNTRY
FROM PS_REG_REGION_TBL R,
PS_REG_TRX_REGION T,
PSOPRDEFN S
OR (R.REG_AVAIL = 'GBL'
REG_HANDS_VW
SELECT
S.OPRID,
R.REG_REGION,
R.DESCR50,
R.COUNTRY
FROM PS_REG_REGION_TBL R,
PS_REG_TRX_REGION T,
PSOPRDEFN S
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 35
Working with Regulatory Regions Chapter 4
OR (R.REG_AVAIL = 'GBL'
Note. You can create new transaction views by doing a Save As and changing the hard-coded transaction
name.
3. After adding the field to the record, define a prompt edit from the standard view
(REG_STANDARD_VW).
Now, when you prompt on the Regulatory Region, you see only those Regulatory Regions to which you
have security access.
We associated Regulatory Region with incidents in Health and Safety. Regulatory Region is a required field
that controls the values that are returned by all the Health and Safety setup pages that have SetID as their
primary key. For example, if the Regulatory Region for an incident is specified as GBR (United Kingdom),
then only GBR codes for Dangerous Occurrences appear on the Incident Details - Description page
(HS_INC_DESCRIPTION). Health and Safety incidents have REG_HANDS_VW as the prompt edit.
Warning! All linked setup values for an incident must belong to the same regulatory region. If the
Regulatory Region is altered (such as when you are operating in update/display mode), and the SetID for the
new Regulatory Region is different from the original, all linked setup fields and values are deleted to prevent
inconsistent data. For example, the SetID for the Regulatory Region USA is USA, and for GBR it is GBR..
If the Regulatory Region for an already established USA incident is changed to GBR, then all of the linked
details on the Incident Details pages are lost. The system prompts you that the Regulatory Region is about to
be changed, and you can choose whether to proceed before the values are deleted or not.
In Health and Safety, the following SetIDs are mapped for each regulatory region, as shown:
36 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 4 Working with Regulatory Regions
BEL STD
CANAB CAN
CANBC CANBC
CANMB CAN
CANNB CAN
CANNF CAN
CANNS CAN
CANON CAN
CANQC CAN
CANSK CAN
DEU DEU
FRA FRA
GBR GBR
JPN STD
NLD STD
USA USA
These regulatory regions were mapped to these SetIDs on the TableSet Control Record Group page
(SET_CNTRL_TABLE1).
All regulatory regions that have region-specific sets of codes or values in the Health and Safety system are
mapped to a SetID of the same name. This group includes CANBC, DEU, FRA, GBR, and USA.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 37
Working with Regulatory Regions Chapter 4
The other regulatory regions that aren't mapped to a SetID of the same name fall into two additional
categories. Except for British Columbia, the Canadian provinces have no specific provincial codes or values
in the system and are mapped to the SetID CAN.
All the other countries that are supported directly in PeopleSoft Human Resources and that don't have any
region specific codes or values in the system are mapped to a generic SetID value of STD. This group
includes JPN, BEL, and NLD.
We've added Regulatory Region to the following PeopleSoft Human Resources components:
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions,"
Creating Positions.
See PeopleSoft Enterprise Talent Acquisition Manager 9.1 PeopleBook, "Creating Job Openings."
See Chapter 11, "Setting Up Organization Foundation Tables," Defining Establishments, page 273.
See Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List
Preferences, page 312.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Entering Additional
Data in Human Resources Records," Tracking Disabilities.
38 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5
Note. Self Service transactions use both data permission security (discussed in this chapter) and security
features unique to Self Service, depending on the transaction.
See Also
Chapter 34, "Setting Up and Working with Self-Service Transactions," page 831
PeopleSoft Enterprise Talent Acquisition Manager 9.1 PeopleBook, "Defining Installation Options for
Recruiting"
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 39
Setting Up and Administering HRMS Security Chapter 5
To administer security:
3. Create user IDs and attach permission lists and roles to user IDs.
Create permission lists and assign to them access to menus, components, component interfaces, pages, global
functionality, along with other information. Permission lists are assigned to roles; however, some permission
lists are assigned directly to the user.
Important! Be sure to start with a thorough analysis of your security requirements. For example, if a user has
access to a position management page that uses a component interface to update the job data tables, then the
user needs permissions for the job data component interface as well as for the position management page.
Create permission lists using the Permission Lists component (ACCESS_CNTRL_LISTX) or Copy
Permission Lists component (PERMISSION_SAVEAS) by navigating to PeopleTools, Security, Permissions
& Roles and selecting the appropriate component.
40 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Create permission lists in the Permission Lists component or Copy Permission Lists component
Note. Assign data permission to permission lists on the Security by Dept Tree page (SCRTY_TABL_DEPT)
and the Security by Permission List page (SCRTY_CLASS) by navigating to Set Up HRMS, Security, Core
Row Level Security and selecting the appropriate component.
Create Roles
Create roles and assign permission lists to the roles. The access you granted to the permission lists combines
under the role. For example, you would assign the permission lists required by your workforce's managers to
the role of Manager which, combined, give your managers security access to all elements of the system that
managers need. Roles are assigned to the user.
Create roles using the Roles component (ROLEMAINT) or Copy Roles component (ROLE_SAVEAS) by
navigating to PeopleTools, Security, Permissions & Roles and selecting the appropriate component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 41
Setting Up and Administering HRMS Security Chapter 5
Create user IDs and assign to user IDs roles and permission lists to give them access to the system as
appropriate.
In addition to the permission lists assigned to roles, the following four specific permission lists are assigned
directly to the user on the User Profile - General page (USER_GENERAL) by navigating to PeopleTools,
Security, User Profiles, User Profiles, General. Unlike the permission lists assigned to roles, users can have
only one each of these four permission lists:
Navigator Homepage
Process Profile
Primary
Row Security
Row Security permission lists grant data-permission security based on a department security tree. Assign
data permission to permission lists on the Security by Dept Tree page.
Note. On the Security by Permission List page you can assign data permission to permission lists that you
attach to roles.
42 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Create user IDs in the User Profiles component or Copy User Profiles component and assign the Navigator
Homepage, Process Profile, Primary, and Row Security permission lists directly to the user profile on the
General page
Roles and permission lists combine under the user ID to give users their security access. For example, the HR
Training Manager would have the roles of manager, instructor, and employee to meet her access needs as a
manager, instructor, and employee. Managers in different departments would have the same manager and
employee roles, in addition to other roles that meet their needs.
Assign roles to users using the User Profiles - Roles page (USER_ROLES) by navigating to PeopleTools,
Security, User Profiles, User Profiles, Roles:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 43
Setting Up and Administering HRMS Security Chapter 5
This diagram illustrates how a user's security profile is made up of assigned roles, and the permission lists
assigned to those roles, as well as permission lists assigned directly to the user:
44 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
User security profiles are made up of the combined permissions of the roles and permission lists assigned to
them
See
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 45
Setting Up and Administering HRMS Security Chapter 5
People.
Employees.
Contingent workers.
Note. The data of people of interest without jobs is secured differently from the data of people with
jobs.
Departments.
Note. Row security for departments secures department budgets and positions, if you are using Manage
Positions. The Departments component is not secured by data permission so control access to department
definitions by restricting access to the component or change the search record to DEPT_SEC_SRCH.
When you open a component in PeopleSoft HRMS the system displays a search page. The search page
represents the search record and the fields that appear are the search keys and alternate key fields that
uniquely identify each row of data. The system uses the information that you enter in the key or alternate key
fields to select the rows of data that you want to view or manipulate (except for the Add action, where you
enter a key and the system creates a new data row). For example, a search page may have EmplID as a key
field and Name as an alternate key. If you enter Smith in the Name field, the system retrieves all data rows
with Name field data that matches Smith.
The system also uses search records to enforce data permission security. Search views for components that
contain sensitive data also contain a security view to control data access.
The system adds the user's security profile, including their user ID and the values of the permission lists
attached to their user profile, to the SQL (Structured Query Language) select statement along with the values
that the user entered on the search page. The system retrieves the data that matches the criteria from the
search page and the user's data permission lists. The system doesn't retrieve data for people to whom you
haven't granted the user's permission lists data access.
Using the above example, if you enter Smith in the Name alternate key field, the system retrieves data only
for the people with the name Smith to whom you have access, which are workers in department 123. Workers
with the name of Smith outside of your security permission, department 123, are not retrieved or accessible to
you as the user. This diagram illustrates the data retrieval process:
46 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
User profile information, search criteria, and the security view enforce data permission security
Note. Security for process and queries is enforced in much the same way.
Not all PeopleSoft HRMS components require data permission security. Their security requirements can be
met using application security (restricting access to the entire page, component, or menu). Only components
containing sensitive information, such as salary information, use the security search views. If necessary, you
can add data permission security to any component that accesses person data, as long as the search records are
defined as SQL views (some search records are defined as SQL tables).
A component can have only one search record. To associate more than one search record with a component
(for example, data level security for some users and not for others), you reinstall the component on different
menus, one for each search record, and grant access to the appropriate component using application security.
PeopleSoft delivers the following core security views for components tracking people:
Component search view Yes PERALL_SEC_SRCH One row per EMPLID and
distinct search items.
Includes future-dated rows.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 47
Setting Up and Administering HRMS Security Chapter 5
Component search view Yes PERS_SRCH_GBL One row per EMPLID and
EMPL_RCD combination,
effective date, and distinct
search items. Includes
future-dated rows.
Component search view Yes PERS_SRCH_EMP One row per EMPLID for
employees only. Includes
future-dated rows.
Security Views for Components Storing People With Potentially More Than One Job Data Record
Component search view Yes EMPLMT_SRCH_GBL One row per EMPLID and
EMPL_RCD combination,
effective date, and distinct
search items. Includes
future-dated rows.
Component search view Yes EMPLMT_SRCH_EMPbe One row per EMPLID and
EMPL_RCD combination
for employees only.
Includes future-dated rows.
48 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Security Views for Components Storing People With Potentially More Than One Job Data Record
Security Data
Data permission is controlled on two sides: transaction and user.
Transaction data is the data that is being secured. Certain transaction fields on a transaction data row are used
to secure access to that row. The data in these fields is called transaction security data. When the value of the
transaction security data matches the value that a user can access (user security data), the system makes the
entire row of data available to the user.
When the user accesses the component search page the security search view filters the data rows, displaying
only the rows of data with the same transaction security values that the user has access to.
This diagram shows the Department field being used as transaction security data to secure the data of people
in the organization in which the user only has security access to the workers in department 123:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 49
Setting Up and Administering HRMS Security Chapter 5
The department field is the transaction value securing the data rows
This table lists where you enter and maintain transaction data, to which record the transaction data is saved,
and which fields can be used as transaction security data:
DeptID
Location
50 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Note. All people, regardless of type, are first entered in the Add a Person component (PERSONAL_DATA),
where you enter their personal information and assign them an ID. These pages do not capture any transaction
security data. Transaction security data is captured on the components that you use to enter details about the
person's relationship to the organization.
Note. If you create a person but do not create a job data record or POI type record for them the system will
save the person as a POI without job with a POI Type of Unknown. Somebody in your organization must
have data permission access to unknown POIs in order to access their data and create either a job data or POI
type record for them, otherwise the data is inaccessible.
Make sure that users who enter people into the system understand the consequences of not creating and
saving a Job Data or POI type record for new people at the time the person is entered in the system.
When a transaction record is successfully completed and saved for the person on the Add an Employment
Instance component, Add a Contingent Worker component, Add a POI Instance component, or Add a POI
Reltn. component, the system deletes the Unknown POI instance for that person.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Adding a Person in
PeopleSoft Human Resources," Adding a Person.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 51
Setting Up and Administering HRMS Security Chapter 5
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Adding a Person in
PeopleSoft Human Resources," Controlling Data Access for POIs Without Jobs.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the
Workforce," Adding Organizational Instances for Employees, Contingent Workers, and POIs.
User security data is the data about a user's security access. It enables the system to ensure that users have
access only to that which you have granted them access. User security data for HRMS data permission is the
data permission that you assign to permission lists and the roles and users to whom you assign the permission
lists.
Data permission is granted to row security (tree-based) permission lists (ROWSECCLASS) and regular (role-
based) permission lists (CLASSID). Both permission lists are created using the Permission Lists component
and Copy Permission Lists component.
When you create a permission list on the Permission Lists component you can assign security to a number of
different aspects of the application. Data permission is assigned separately on the Security by Dept Tree page
and Security by Permission List page.
Note. When you add a permission list to the Security by Dept. Tree component, the system saves it as
ROWSECCLASS.
This diagram shows that permission lists are created, assigned data permission (using either security by
department tree or security by permission list), and then assigned to a user directly on the User Profile -
General page as the Row Security permission list or assigned to a user on the User Profile - Roles page by
assigning roles to the user, which are associated with permission lists:
Create permission lists, assign to them data permission, and assign them to users
This table lists the key differences between role-based permission lists with data permission and row security
permission lists:
Are assigned to users on the Row Security field on the Are assigned to users by way of roles.
User Profile General page.
52 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Are limited to one per user. Users can have multiple role-based permission lists and
the combined data permission access of each list.
Bring with them only the data permission assigned to the Bring with them data permission access assigned to them
user on the Row Security field on the User Profile - on the Security by Permission List page and any
General page. application security access granted to the permission list
on the Permission Lists component.
The user will not have access to any data permission
assigned to them on the Security by Dept Tree page.
Should have only department security tree-based security. Can have only non-department tree-based security.
Note. You can use the same permission list as a row security permission list and a role-based permission list
by adding it to both the Security by Dept Tree component and Security by Permission List component and
then adding them to the user on the User Profile - General page and by way of roles.
Note. The system recognizes non-tree based security associated with row security permission lists. Customers
who modified the system to use non-tree based security in previous releases only have to import the
customized table capturing the row security permission lists and security definitions into SJT_CLASS. You
can continue to assign the permission lists to users in the Row Security field on the User Profile - General
page.
New customers, or customers using non-tree based security for the first time, should use role-based
permission lists. This will provide you much greater flexibility.
This diagram shows the search page determining which permission lists a user has and what data permission
the list gives the user. The user, TRN, is associated with the permission list TRAIN for both row security and
permission lists through roles. Since permission list TRAIN is granted access to worker's records in
department 123 only, the search results will display only those workers from this department:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 53
Setting Up and Administering HRMS Security Chapter 5
The system determines which permission lists a user has and what data permission is granted by the
permission list before retrieving the matching data rows
This table lists where you enter and maintain user security data and to which record the user security data is
saved:
Data Type Security Page in which Data is Record Storing User Security Data
Entered or Maintained
54 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Data Type Security Page in which Data is Record Storing User Security Data
Entered or Maintained
Note. The data from PSROLECLASS, PSROLEUSER, and PSOPRDEFN is loaded into SJT_OPR_CLS
either automatically by the system, when you enable the USER_PROFILE and ROLE_MAINT messages, or
when you run the Refresh SJT_OPR_CLS process.
See Chapter 5, "Setting Up and Administering HRMS Security," Understanding PeopleSoft Security, page 39
.
See Chapter 5, "Setting Up and Administering HRMS Security," Setting Up and Assigning Tree-Based Data
Permission, page 81.
See Chapter 5, "Setting Up and Administering HRMS Security," Assigning Role-Based Data Permission
Security to Permission Lists, page 90.
This graphic shows the search page determining which permission lists a user has and what data permission
the list gives the user using either the transaction or user security join tables. The transaction security join
table is determined by the type of data stored in the component:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 55
Setting Up and Administering HRMS Security Chapter 5
The core security view uses the security data stored in the security join tables to determine which rows of
data the user can access
Each transaction security join table stores the transaction data required to secure each row of data. The
security join tables store one row of data for each unique combination of key fields.
56 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Security access types indicate which field is used for transaction security data. For example the security
type 002 enables you to secure person data by location.
The key security fields uniquely identify the security transaction data securing a row of data. The system
determines the key fields by the security access type. For example, if person data is secured by location,
then the key security fields are BUSINESS_UNIT (the prompt value for location) and LOCATION (the
third key field isn't required for this example).
EMPLID
A person's unique identifying number that is assigned to them on the Personal Data pages.
HRS_JOB_OPENING_ID
A job opening's unique identifying number, which is assigned to it on the Job Opening page.
Each table stores additional fields depending on the type of security you are using.
For example, if you are securing the data of people with jobs using the security access type Job Department
Tree (001), the key fields of the security join table SJT_PERSON looks like this:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 57
Setting Up and Administering HRMS Security Chapter 5
If you used two security access types, for example Job Location (002) and Job Department Tree,
SJT_PERSON looks like this:
Note. Locations and departments do not need three key fields to uniquely identify them so the third security
key field isn't necessary for this example.
When you first enable a security access type, load the transaction data into security join tables using the SJT
Refresh process. After the initial load, the system updates the tables using SavePostChange PeopleCode when
you make a change to the transaction security data in the transaction components. You can also capture any
changes the PeopleCode misses by running the SJT Refresh process as needed or the Nightly Refresh process.
Note. The SavePostChange PeopleCode on the transaction component subpage SCRTY_SJT_SBP updates
the security join tables.
This graphic illustrates how the transaction security join tables are kept up to date, as described above:
58 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Keep the transaction security join tables up to date through refresh processes
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Nightly Refresh Process, page
99.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Transaction Security Join Table
Refresh Process, page 100.
The user security join tables store the user security data required to determine users' data permission. The
security join tables store one row of data for each unique combination of key fields.
User Security Join Table Description Stores Data From: Key Fields
In addition to the security access type field and security key fields, the user security join tables store the
following fields:
A security set is a set of data secured in HRMS. For example, PPLJOB is the security set for the data of
people with jobs and DEPT is the security set for the department data. Each security set has security
access types.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 59
Setting Up and Administering HRMS Security Chapter 5
OPRID
CLASSID
Note. The security join tables store row security permission lists (ROWSECCLASS) as CLASSID
permission lists but identify them using a row security flag.
SCRTY_TBL_DEPT
When you add tree-based data permission to a permission list, you use the Security by Dept Tree page and
the system saves the permission list information to the SCRTY_TBL_DEPT record.
SJT_CLASS
When you add non-tree based data permission to a permission list, you use the Security by Permission
List page and the system saves the permission list information to the SJT_CLASS record.
For example, if you are securing the data of people with jobs using the security access type Job Department
Tree (001), the key fields of the SCRTY_TBL_DEPT table look like this:
To load the data from the SCRTY_TBL_DEPT table, you need to run the Refresh SJT_CLASS_ALL
process. In SJT_CLASS_ALL, the Refresh SJT_CLASS_ALL process:
Creates a row of data for each enabled, tree-based security access type (and it's security set) with the data
permission you set up on the Security by Dept Tree page.
For example, if you enable security access type 012 (RS Dept Id) and security access type 001 (Job
Department Tree) and grant the row security permission list TRAIN data permission to department 123,
the process will create a row for each security access type and the permission will have access to people
with jobs in department 123 and job openings in department 123.
If you are securing the data of people with jobs using the security access type Job Location (002), the key
fields of the security join table SJT_CLASS look like this:
60 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
When you save your changes on the Security by Permission List page, SavePostChange PeopleCode
automatically updates the data to the security join table SJT_CLASS_ALL.
If you are using both security access types, SJT_CLASS_ALL looks like this after you have run the Refresh
SJT_CLASS_ALL process and the PeopleCode has updated it:
This graphic illustrates how the permission list user security join tables are kept up to date, as previously
described:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 61
Setting Up and Administering HRMS Security Chapter 5
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refreshing SJT_CLASS_ALL
Process, page 102.
The security join table SJT_OPR_CLS stores the relationship between User IDs and permission lists with
data permission. The data in SJT_OPR_CLS comes from three sources:
PSOPRDEFN
This record contains the relationship between the User ID and row security permission list from the User
Profile - General page.
PSROLEUSER
This record contains the relationship between the User IDs and roles from the User Profile - Roles page.
PSROLECLASS
This record contains the relationship between roles and permission lists from the Roles - Permission Lists
page.
To update SJT_OPR_CLS with the data from PSOPRDEFN, PSROLECLASS, and PSROLEUSER, run the
Refresh SJT_OPR_CLS process whenever you add a permission list with data security to a user profile (either
by adding a row security permission list on the User Profile - General page, by adding a role-based
permission list with data permission to a user-assigned role on the Roles - Permission Lists page, adding a
role with data permission on the User Profile - Roles page, or by creating a new user profile by copying an
existing one) or delete one from a user profile.
This graphic illustrates this process of when to update the user profile security join table:
62 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Note. You can enable the USER_PROFILE message and the local subscription
HCM_Refresh_SJT_OPR_CLS and the ROLE_MAINT message and the local subscription
HCM_Role_Refresh_SJT_OPR_CLS to automatically update SJT_OPR_CLS. PeopleSoft does not deliver
the system with these messages enabled.
The Refresh SJT_OPR_CLS process loads the OPRID and ROWSECCLASS values from PSOPRDEFN
directly into SJT_OPR_CLS, saving the row security permission list as CLASSID.
To establish the relationship between user profiles and role-based permission lists, the process first loads the
OPRID and ROLENAME from PSROLEUSER and the ROLENAME and CLASSID from PSROLECLASS
into a temporary table (ROLEUSER_ROLECLASS) and then loads the OPRID and CLASSID, and the
relationship between them, into SJT_OPR_CLS.
This diagram illustrates the data stored in SJT_OPR_CLS and their source as described above:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 63
Setting Up and Administering HRMS Security Chapter 5
SJT_OPR_CLS stores the relationship between user profiles and permission lists
Note. The SEC_RSC_FLG field indicates if the CLASSID was originally a ROWSECCLASS permission list
by flagging it with a value of Y.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refresh SJT_OPR_CLS
Process, page 103.
64 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Note. PeopleSoft has delivered all the security sets you are likely to need. If you add new sets, it is considered
a customization.
See Chapter 5, "Setting Up and Administering HRMS Security," Viewing Security Sets, page 75.
Security access types are ways of securing the data within a security set. Each security set has a number of
security access types that you can choose to enable. Among other things, security access types determine:
Note. You can only set up department hierarchies on security trees and you can only grant security access
by department tree to row security permission lists.
Security access types that don't use a department security tree do not have a hierarchical structure and
require that you list each field value individually for each permission list.
The following table lists the security access types by security set:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 65
Setting Up and Administering HRMS Security Chapter 5
RS Dept Id (012)
RS Location (013)
Note. PeopleSoft has delivered all the security access types you are likely to need. You can add new types but
it requires a very good knowledge of the application and of SQL.
Security administrators can only assign data permission using the security access types that you enable.
See Chapter 5, "Setting Up and Administering HRMS Security," Enabling Security Types, page 77.
When you grant a permission list access to data in a security set using more than one security access type the
security access creates a union, not a join or an intersect, with the two types. For example, if you enable the
Job Company and Job Business Unit security access types for the PPLJOB security set and grant a permission
list access to people in company A and people in business unit B, users with the permission list can access
people in company A or people in business unit B; their access is not restricted to people in both business unit
B and company C.
Note. See the security white paper posted on My Oracle Support for information about creating security
access types that join transaction fields to secure data.
66 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 67
Setting Up and Administering HRMS Security Chapter 5
2. Set the security installation settings on the Security Installation Settings component.
If you are using security tree-based security access types, set up a security tree, assign data permission
on the Security by Dept Tree component, and refresh SJT_CLASS_ALL.
If you are using non-tree based security access types, assign data permission on the Security by
Permission List component.
6. Assign permission lists to users (by way of roles if you are using role-based permission lists or directly to
the user profile if you are using row security permission lists).
7. Refresh SJT_OPR_CLS.
JobByDept Security by Dept Tree page Job Department Tree (001) department 10100
(you must select setID
SHARE as the first key)
MyJobs Security by Dept Tree page Job Department Tree (001) department 11000
(setID SHARE )
68 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Grant the following row security permission lists and roles to users:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 69
Setting Up and Administering HRMS Security Chapter 5
The system normally secures data using the current transaction security data. Only users with data permission
access to the transaction security data on the current row can access the person's data
When you include future-dated transaction security data rows the system uses both the current data and the
future-dated values to secure the data. This gives users with data permission access to the transaction security
data on the current row and users with data permission access to the transaction security data on the future-
dated row access to the person.
The system only creates future-dated security rows in SJT_PERSON when you:
Note. This enables you to use future-dated security with some types but not others.
3. Create and save a future-dated row in a component that uses the JOB record using one of the actions you
selected on the Security Installation Settings page.
If you have selected the action of Transfer in the Actions that trigger Future Dated Security Rows grid, then
when you create a future-dated Job Data row with the action of Transfer for a person, the system will add a
row to the SJT_PERSON with the transaction data from the new row. Users with data permission to the
future-dated transaction security data will have access to the person's data.
For example, as of January 1, 2005 Kenny Wong works in department 42000. Starting July 1, 2006 he will
transfer to department 44000. On April 15, 2006, in anticipation of the transfer, the HR administrator enters a
future-dated job data row for the transfer.
Julie Sparrow manages department 42000 and Barry Deere manages department 44000 and each has data
permission to the people in their departments.
As of April 15, 2006 Kenny Wong has the following two job data rows:
The data permission depends on if you are using future-dated security for that security access type and if you
have selected the action of Transfer on the Security Installation Settings page:
70 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
The SavePostChange PeopleCode does not update SJT_PERSON with the new department
information from the future-dated row because it is not yet effective.
Note. When the transfer row does become effective, the Nightly SJT Update process updates
SJT_PERSON, overwriting the old row with the new row.
Julie can access Kenny's data until June 30, 2006 and Barry can access it starting July 1, 2006.
The SavePostChange PeopleCode creates a new row in SJT_PERSON with the future-dated
transaction security data. The system identifies this row as future-dated.
Note. When the transfer row becomes effective, the Nightly SJT Update process updates
SJT_PERSON, removing the old row and making the future-dated row current.
Note. Search views that don't use future-dated security will not use the future security row when
enforcing data permission.
Julie can access Kenny's data until June 30, 2006 and Barry can access it starting April 15, 2006.
For example, if you are securing data by department and have enabled people with access to the home job
data record to view the host job data record but are not allowing people with access to the host job data record
to view the home job data record, the system will create the following three rows of data in SJT_PERSON
(only the relevant columns are shown) for a person whose home job data record (employee record number 0)
is in department 25000 and whose host job data record (record number 1) is in department 20000:
The system creates the row marked Home-Host to grant the special job security option. By creating a row for
the host record with the department value of the home record, people with data permission to the home record
can access the host record.
The system works the same way for the other special security options, creating an additional row and
inserting the key values that enable the access.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 71
Setting Up and Administering HRMS Security Chapter 5
Security Installation SCRTY_INSTALL Set Up HRMS, Security, Choose the HRMS security
Settings Core Row Level Security, settings for your
Security Installation installation.
Settings, Security
Installation Settings
Security Set Table SCRTY_SET_TBL Set Up HRMS, Security, Review existing security
Core Row Level Security, sets and the security access
Security Sets, Security Set types you've attached to
Table them.
Security Update Groups SCRTY_SJT_UPD Set Up HRMS, Security, Define the data groups that
Core Row Level Security, can be updated by the SJT
Security Sets, Security Refresh process.
Update Groups
Security Type Table SCRTY_TYPE2_TBL Set Up HRMS, Security, Use to enable or modify
Core Row Level Security, existing security access
Security Access Type, types or create new ones.
Security Type Table
Security Type SQL SCRTY_TYPE2_SQL Set Up HRMS, Security, Use to enter the SQL
Core Row Level Security, statements for the new
Security Access Type, security types.
Security Type SQL
72 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
The options you select here will be available for your installation but will not be enabled unless you select
them again for the security access types you are using. This enables you to use the security versions for some
security access types and not others.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 73
Setting Up and Administering HRMS Security Chapter 5
Include Home/Host This option is for tracking global assignments. When an employee is on
Access? assignment they have a host record and a home record. Select one of the
following options:
Home can see Host: Select to enable a person with data permission that
enables them to view the home record to also view the employee's host
record. A person with just data permission to the host record will not be able
to see the employee's home record.
Host can see Home: Select to enable a person with data permission that
enables them to view the host record to also view the employee's home
record. A person with just data permission to the home record will not be able
to view the host record.
Both: Select to enable a person with data permission to the home record to
view the host record and a person with data permission to the host record to
view the home record.
If you do not select Include Home/Host Access? then regular data permission
rules apply.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Track Global
Assignments, "Tracking Assignments."
Incl. Additional This option is for workers with additional assignments added using the Job Data
Assignments? Concurrent component (JOB_DATA_CONCUR).
When a worker has an additional assignment, they have a controlling employee
or contingent worker instance with an active job data record and an additional
assignment job data record. Select one of the following options:
Assignment can see Instance: Select to enable a person with data permission
that enables them to view the assignment job data record to also view the
person's controlling instance job record. A person with data permission to the
controlling instance job data record will not be able to see the worker's
assignment job data record.
Instance can see Assignment: Select to enable a person with data permission
that enables them to view the controlling instance job record to also view the
person's assignment job data record . A person with data permission to the
assignment job data record will not be able to see the worker's controlling
instance job data record.
Both: Select to enable a person with data permission that enables them to
view the controlling instance job record to also view the assignment job data
record and a person with data permission that enables them to view the
assignment job data record to also view the controlling instance job record.
None: Select to make additional assignments job data records available to all
users.
If you do not select Incl. Additional Assignments? then regular data permission
rules apply.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer
Workforce, "Increasing the Workforce," Adding Additional Assignments.
74 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
JPN Appointment (JPN) Select so that users who have access to the additional appointment of a
worker can access the main appointment record for that worker.
The system assigns some additional assignments (Kenmu) to a particular EmplID
and record called a main appointment, the job you can access through the Job
Data pages.
If you do not select JPN Appointment? then regular data permission rules apply.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer
Workforce, "(JPN) Tracking Additional Appointments (Kenmu)," Setting Up
Security for Tracking Additional Appointments.
Select the actions that will trigger the SavePostChange PeopleCode in the components using the JOB record
to create a future-dated security row in SJT_PERSON when they are used in a future-dated row in the Job
Data pages. The system will not create security rows for future-dated rows with actions other than those listed
here.
To create future-dated rows, you need to select the Include Future Dates check box on the Security Type
Table. This enables you to use future-dated security for some security access types and not others.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 75
Setting Up and Administering HRMS Security Chapter 5
Object Owner ID Security sets with a PeopleSoft Object Owner ID are system data and not
available for modification on this page. You can still modify the Security Update
Groups of delivered security sets.
Transaction Sec Join The security join table that stores the transaction data for this security set.
Table
Note. If you are creating a new security set, you must have created this table in
Application Designer before creating the security set.
Creating a new security set requires modification of the system. Please refer to
the Security white paper on My Oracle Support for directions.
SJT Temp Table (for The temporary record used for PeopleSoft Application Engine. It is a copy of the
AE process) transaction security join table and also contains the Application Engine process
fields. This table updates the transaction security join field using the Application
Engine process.
SQLID for Value Field The list of fields (not including the key fields) that are in the transaction security
List join table.
76 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Generate SQL Click to generate the SQL and SQLID for the value field list.
The system lists the security access types for this security set and indicates which ones are enabled. Enable or
disable security access types on the Security Type Table page.
See Chapter 5, "Setting Up and Administering HRMS Security," Enabling Security Types, page 77.
Select which refresh options to make available when updating the security set using the SJT Refresh process.
The system makes the options you select here available for this security set on the Refresh SJT page, enabling
you to select portions of the security join table to update.
For example, you could refresh all the rows for external instructors by selecting the refresh option Person of
Interest Type and the POI Type External Instructors.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 77
Setting Up and Administering HRMS Security Chapter 5
You can enable more than one security access types for a security set and you can assign data permission
access to a permission list using more than one access type.
Note. PeopleSoft has delivered the most asked for security access types and you should not need to create
new types. Enable or disable the types your installation requires.
Please refer to the Security white paper on My Oracle Support for directions on how to create new security
types.
Note. The more security access types you enable and options you use, the more rows of data the system stores
in the security join tables. This affects system performance. PeopleSoft advises you to enable only the
security types and options required to manage your data permission needs.
Transaction Label Enter a field label. The system will display this label on a transaction page when
the security access type is used as a field to gather data.
For example, if you are using fields in addition to POI type to control access to
the data of POIs without jobs, the system will use the label you enter here on the
Add a POI Type page and Edit POI Relationship page to prompt for security
transaction values.
78 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Security Set and The security set whose data you are securing and the security join table
Transaction Sec Join associated with the security set.
Table See Chapter 5, "Setting Up and Administering HRMS Security," Viewing
Security Sets, page 75.
Include Future Dates Select to enable the security join tables to store future-dated security rows for this
type. The system will only update the security join tables with the future-dated
rows that have the actions you selected on the Security Installation Settings page.
Use Dept Sec Tree?(use Select if this security type uses the department security tree.
department security tree?)
You can only create department security trees for departments and can only grant
data permission based on department security trees to row security permission
lists.
Transaction Table The transaction table that stores the field or fields that will control security for
this type.
Special Job Security If you enable special job security versions on the Security Installation Settings
Versions page, enable the options for this security access type.
See Chapter 5, "Setting Up and Administering HRMS Security," Installing
HRMS Security, page 72.
Security Key 1, Prompt Define the security data fields for this type. The fields need to be on the
Rec for Sec Key 1 Transaction Table record.
(prompt record for The prompt record is the record the prompt field values come from when you are
security key 1), Security assigning values to a permission list. You must select all the records and fields
Key 2, Prompt Rec for necessary to make a unique qualification here.
Sec Key 2 (prompt record
for security key 2), For example, to select a location (key 2), you first need to select a business unit
Security Key 3. and (key 1). The prompt record for the BUSINESS_UNIT field is
Prompt Rec for Sec Key BUS_UNIT_TBL_HR and the prompt record for the LOCATION field is
3 (prompt record for LOCATION_TBL.
security key 3)
You should refresh the transaction security join tables whenever you:
Change the special job security versions for an enabled security access type.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Transaction Security Join Table
Refresh Process, page 100.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 79
Setting Up and Administering HRMS Security Chapter 5
80 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
The Application Engine uses the SQL fragments on this page to build the update and insert statements to
update the transaction security join table.
You can use any SQLID but when you click the Generate SQL buttons, the system generates unique IDs
based on the security set and/or type.
Warning! This page should only be used by users with a strong understanding of SQL joins and the table
relationships.
This section provides an overview of the data permission security by department security trees and discusses
how to:
Refresh SJT_CLASS_ALL with tree and row security permission list data.
Note. After you assign a row security permission list to a user, you must run the Refresh SJT_OPR_CLS
process.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refresh SJT_OPR_CLS
Process, page 103.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 81
Setting Up and Administering HRMS Security Chapter 5
You use PeopleSoft Tree Manager to build a hierarchy of department security for an organization. A security
tree provides a graphic means to grant and restrict access to data. The security tree doesn't have to represent
your organization's hierarchy exactly, although it is usually very close.
To grant a row security permission list access to a group of departments, you grant access to the department
to which all of those departments report. You can restrict access to individual departments or to a group of
departments if you need to. This is an example of a department security tree for the SHARE setID:
Using this security tree you could, for example, grant a row security permission list access to department
13000 and the system includes department 13000 and all the departments that report to it, giving the
permission list access to everyone in all fourteen finance departments.
82 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
You can also restrict access to one of the branch entities. For example, if a row security permission list needs
access to everyone in Finance except for Business Services, grant access to department 13000, but restrict
access to department 15000, giving access to departments 13000, 20000, 22000, 25000, 27000, and 31000.
Note. You can only grant tree-based data permission to row security permission lists.
Before you work with data security and PeopleSoft Tree Manager, make sure that human resources data is
defined in the PeopleSoft HRMS control tables.
Warning! Before you create or modify a security tree, we recommend that you review the Enterprise
PeopleTools PeopleBook: PeopleSoft Tree Manager for a detailed discussion of using PeopleSoft Tree
Manager because this section does not provide a complete overview of the application. Security is an
important component of your system, and it is crucial that you understand all aspects of PeopleSoft security
and its tools before you implement it.
See Chapter 5, "Setting Up and Administering HRMS Security," Setting Up and Assigning Tree-Based Data
Permission, page 81.
See Chapter 5, "Setting Up and Administering HRMS Security," Assigning Role-Based Data Permission
Security to Permission Lists, page 90.
For the purpose of building department security trees, PeopleSoft defines all entities in an organizationfrom
companies to departmentsas departments. The department data is created and stored in the Departments
component (DEPARTMENT_TBL), which you can access from PeopleSoft Tree Manager or the Set Up
HRMS menu. You assign security access based on these departments so define each entity in your
organization in the Departments component so that you can add its department ID code to the security tree.
Nodes, representing organizational entities, are added at different levels to indicate their place in the
hierarchy.
For example, the first level of your tree might be the company level. The second level might be the regional
level. A node that is added at the first level is a company-level node and represents the company department.
A node that is added at the second level is a regional-level node and represents a regional department, such as
an office. The first node in your organization is the root node. This is the highest node in the hierarchy. All
other nodes (departments) report up to the root node.
Access to data is based on the hierarchy that you create. If you grant access to a department, you also grant
access to each department that reports to that department.
Note. You should include inactive departments on your security tree; otherwise, data for retired, terminated,
or transferred people who used to be in inactive departments will be inaccessible.
See Chapter 11, "Setting Up Organization Foundation Tables," Maintaining Departments, page 299.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 83
Setting Up and Administering HRMS Security Chapter 5
All security trees are called DEPT_SECURITY. Security trees are uniquely identified by their setID and
effective date.
You can create future-dated trees to reflect a change in your reporting structure and you may want to grant
access using the newer tree (or, perhaps, to a historical tree).
When you assign data to a permission list on the Security by Dept Tree page select the date as of which you
want the trees to be effective. When you add a row in the Define Security Profile grid on the Security by Dept
Tree page and select the setID of the security tree, the system references the security tree that is effective as
of the date you selected in the As of Date for the Trees field.
For example, it is now April, 2005 and you have created a future-dated security tree for the SHARE setID
dated January 1, 2006. You wish to try out the data permission using the new tree. On the Security by Dept
Tree page, enter January 1, 2006 (or a higher date; the date does not have to be the exact effective date of the
tree) in the As of Date for the Trees field. Add a row in the Define Security Profile grid and select the
SHARE setID. The system displays January 1, 2006 in the Effective Date field in the grid and uses the future-
dated tree to enforce data permission for that permission list.
When the future-dated tree becomes effective, the system does not automatically update the security profiles
of permission lists referencing the old tree. For example, on January 1, 2006, the system continues to use the
previous SHARE tree to enforce data permission for all the permission lists that were referencing it.
To update the permission lists so that they reference the new tree, enter the Security by Dept Tree page, enter
the date January 1, 2006, and click the Refresh Tree Effective Date button. The system will update the
effective dates of all the trees referenced by that permission list to the dates the trees effective as of January 1,
2006.
Security Tree Audit Report RUNCTL_PER506 Set Up HRMS, Security, Use to create a list of
Core Row Level Security, discrepancies between the
Security Tree Audit Report, data you've entered in the
Security Tree Audit Report Departments component
and the departments you've
added to the current security
tree.
Security by Dept Tree SCRTY_TABL_DEPT Set Up HRMS, Security, Grant tree-based department
Core Row Level Security, data access to row security
Security by Dept Tree, permission lists.
Security by Dept Tree
84 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
The steps for creating a tree manually are described in the Enterprise PeopleTools PeopleBook: PeopleSoft
Tree Manager. When you create a security tree, enter the following data on the Tree Definition and Properties
page (PSTREEDEFN):
Field Description
SetID Select the setID of the departments that you will add to
the tree.
Effective Date Enter the date that the tree becomes effective. Add only
the departments that are effective on or before this date.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 85
Setting Up and Administering HRMS Security Chapter 5
Field Description
Loosely Enforced
Not Used
Once you've created the basic tree structure, you begin to add nodes. In a security tree, each node represents a
business entity in your organization. You define nodes on the Departments component, creating a department
for each business entity in your organization.
You must have a node for every department in the setID. You can add nodes to your trees as you add
departments to your organization.
To add a new, future-dated departments in order to maintain data security for people added to the new
departments, create a future-dated security tree. This will enable you to add people to the new department
before it becomes effective and still be able to control access to their data in the present.
You can create a security tree using an existing organizational structure. Use the following Structured Query
Report (SQR) procedure to import the existing hierarchy and build your security tree. You import your
department data into a temporary Department Table, and the system uses that data to build the security tree.
To set up a hierarchy of departmental entities and build your data security tree automatically:
86 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Import the entity data into the temporary table R_PER507 using the PeopleSoft Import utility, a
Structured Query Report (SQR), or another batch facility. You load department data into this temporary
table, so before you use this utility, you must establish the reporting hierarchy for all the departments in
your organization. To do this, use the REPORTS_TO_DEPT field in the R_PER507 temporary table.
R_PER507 is included with PeopleSoft HRMS; it looks like DEPT_TBL, but it includes the following
additional columns:
Run PER507 to set up the reporting hierarchy of your tree. This utility determines whether a department is
active or inactive as of the date that you enter when you run the utility, and populates the ORGFLAG
column in R_PER507 accordingly. The utility creates a structured organization code based on the
REPORTS_TO_DEPT field values that you loaded and populates ORGCODE accordingly. This utility
uses the ORGCODE values to set up the department hierarchy.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 87
Setting Up and Administering HRMS Security Chapter 5
Run PER508 to build your DEPT_SECURITY tree. The effective date of the tree is the latest effective
date of the departments that were processed in step 2.
Note. To set up multiple trees to represent security or organizational structures at different points in time,
perform step 2 for each tree, setting the As of Date each time, and perform this step again.
Run PER509 to transfer the information that you set up in R_PER507 into DEPT_TBL. You can't view or
update the Department component until you run this utility.
Run PTUGAPTR.SQR to renumber the nodes in your tree and insert numbered gaps between the nodes.
You can modify an existing tree by changing either the nodes or the levels. When you modify a security tree,
the tree node numbers usually change, so you need to refresh the numbers. You also need to run the Refresh
SJT_CLASS_ALL process to update the data access profiles and security join tables.
See Chapter 5, "Setting Up and Administering HRMS Security," Refreshing SJT_CLASS_ALL with Tree
and Row Security Permission List Data, page 90.
PeopleTools assigns each node a number and reserves a series of unused numbers, called gaps, which the
system uses to make changes to sections of a security tree. When you move a node, the system renumbers the
nodes that appear to the right of the node that you moved (the children of the node that you moved). When
you save changes to a tree, the system saves only the parts of the tree that have changed.
To refresh the unused numbers in the gaps between nodes, run the PTUGAPTR.SQR utility. Refresh unused
numbers when:
88 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Refresh Tree Effdts by The system will reference the trees that are effective as of this date when you
(refresh tree effective select a tree setID in the Define Security Profile grid. Select a date in the future
dates by) to reference a future-dated tree.
For example, to use the department security trees that are current as of today's
date, enter today's date in this field.
Refresh Tree Effective Select to refresh the trees listed in the Define Security Profile grid to trees that
Dates are effective as of the date in the As of Date for Trees field.
Note. To ensure that your row security permission lists use the current trees you
must enter the appropriate as of date and click this button whenever you create a
more recent version of a setID's security tree.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 89
Setting Up and Administering HRMS Security Chapter 5
Set ID and Dept ID Enter the tree setID and the ID of the department that you are granting access to.
(department ID) The row security permission list has access to each department ID that reports up
to this one on the security tree (unless you specify otherwise) so you don't have
to select each department ID individually.
Access Code Indicate what kind of access the row security permission list has to the data for
this department ID.
To restrict access to one or more departments that report up to a department ID
that you've granted access to, insert a row and select the restricted department's
ID and then select an Access Code of No Access.
You need to restrict access explicitly only for department IDs that report up to
the department ID to which you want to grant access. Otherwise, the row security
permission list doesn't have access to a department unless it or the department to
which it reports has been granted access on this page.
Effective Date of Tree Displays this setID's tree effective date. Make sure that the effective date of the
tree is accurate. The system will not update the effective date automatically if
you make a newer version of a tree.
To update trees, enter the date as of which the tree is effective in the Refresh
Tree Effdts by field and click the Refresh Tree Effective Dates button.
You can access the new or modified tree on the Security by Dept Tree page before you run this process so if
you are creating a tree and then using it on a new or existing permission list you only need to run the process
once, as long as you refresh the appropriate rows.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refreshing SJT_CLASS_ALL
Process, page 102.
This section discusses how to assign data permission security by field value to permission lists.
90 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Security by Permission List SCRTY_CLASS Set Up HRMS, Security, Grant data permission
Core Row Level Security, security by field values to
Security by Permission List, role-based permission lists.
Security by Permission List
Security Set
Select the security set whose data you want to secure with this permission list. To secure the data of more
than one set, add more security set rows.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 91
Setting Up and Administering HRMS Security Chapter 5
Security Type
Access Type Select the security access type. The system only lists those types enabled for the
security set.
You can use more than one access type to set data permission for a permission
list.
Note. The security access type 031 (Recruiting Team) works with the
assignments on a job opening to grant access.
Key 1, Key 2, and Select the transaction security value to which this permission list has access. You
Security Key 3 may have to select one, sometimes two, key prompts before you can select the
transaction value.
For example, to give this permission list data permission access to people with jobs in location UK1, select
the security set PPLJOB and the security access type Job Location. To select a location, you first must select
a business unit, so in the Key 1 field, select the business unit GBR01 and in the Key 2, select the location
UK1.
To use more than on access type, enter a row and select a different access type and select the field values for
the type's security keys.
This section describes when to use the refresh processes and discusses how to:
92 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Important! The refresh processes are designed to refresh each row included in the process definition in
sequence, causing the system to take an exceptionally long time to run the process when there are a large
number of rows. To improve performance, we recommend clearing the Refresh All Rows check boxes on the
run control pages and creating more defined run controls to run concurrently. (For example, create a run
control for each permission list and run them simultaneously, rather than refreshing all permission lists under
a single run control). You can save the run controls and use them as often as necessary.
Run the Nightly Refresh SJT process nightly to refresh the transaction security join tables. The nightly refresh
process:
Updates the transaction security join tables with any changes to transaction security data that bypassed the
SavePostChange PeopleCode.
The system automatically updates the transaction security join tables when you make and save a change
on the transaction components, either by manual entry or a mass update that triggers the component
interface. If you bypass the PeopleCode, you will need to capture the changes using a refresh process.
Updates the security join table with future-dated security rows that have become current (when the current
calendar date matches up with the effective date of the transaction record) because SavePostChange
PeopleCode is not triggered when a future-dated row becomes current.
If you are using future-dated security rows deletes the old security row and makes the future-flagged row
the current row.
Run this process nightly for every security set you are using.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Nightly Refresh Process, page
99.
SJT Refresh
Run the SJT Refresh process to refresh the transaction security join tables.
You will need to refresh the tables using this process when you:
When you enable a security access type, you need to load the transaction security data for that type into
the security join table.
You need to run it when you disable a security access type in order to clear the security join table of the
transaction security data. You won't compromise your security if you don't run it but you will improve
performance by removing the unnecessary rows.
Update the transaction components using a process that bypasses the component interfaces.
The Nightly Refresh SJT process also captures this data but you may want to refresh the tables
immediately rather than waiting for a scheduled run.
You can run this process for all security sets at once, individually, or by a smaller grouping of data.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Transaction Security Join Table
Refresh Process, page 100.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 93
Setting Up and Administering HRMS Security Chapter 5
You will need to refresh SJT_CLASS_ALL using this process when you:
Modifications include selecting to use future-dated security rows or changing the job data security
options.
Create or modify a row security permission list on the Security by Dept Tree component.
Modifications include adding or removing data permission and refreshing the effective dates of trees.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refreshing SJT_CLASS_ALL
Process, page 102.
Refresh SJT_OPR_CLS
You will need to refresh SJT_OPR_CLS whenever you create or change the relationship between a user
profile and a permission list with data permission. Run the process when you:
Add a row security permission list that has data permission to, or delete one from, a user on the User
Profile - General page.
Add a role with permission lists with data permission to, or delete one from, a user.
Add a permission list with data permission to, or delete one from, a user-assigned role
Note. SavePostChange PeopleCode on the Security by Dept Tree component and the Security by Permission
List component updates SJT_OPR_CLS when you add a permission list to either component for the first time.
If you add a permission list to the user first, either in the Row Security field or by way of a role, and then add
it to the Security by Dept Tree page or Security by Permission List page, you do not need to run the process.
You can enable the USER_PROFILE message and the local subscription HCM_Refresh_SJT_OPR_CLS and
the ROLE_MAINT message and the local subscription HCM_Role_Refresh_SJT_OPR_CLS to automatically
update SJT_OPR_CLS.
PeopleSoft does not deliver the system with these messages enabled in order to prevent unnecessary
publishing. If you would like to use them, follow these steps:
94 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
2. Use PeopleSoft Application Designer to activate the USER_PROFILE and ROLE_MAINT messages by:
3. Use PeopleSoft Application Designer to activate the handler/application class for the USER_PROFILE
and ROLE_MAINT messages:
b. On the Monitor Message - Channel Status page (AMM_CHNL_STATUS), scroll down until you
locate both the USER_PROFILE and ROLE_MAINT channels.
5. Make the USER_PROFILE and ROLE_MAINT messages active on the HRMS node by:
On the Node Definitions - Transaction page (IB_NODETRXLIST), change the status of each message
to Active.
See Chapter 38, "Working with Integration Points in Enterprise HRMS," Working with HRMS Local
Integrations, page 942.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refresh SJT_OPR_CLS
Process, page 103.
This table indicates which refresh processes you should run when implementing HRMS security:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 95
Setting Up and Administering HRMS Security Chapter 5
This table indicates which refresh processes you should run when using security trees and creating and
modifying row security permission lists:
Note. You do not need to refresh SJT_CLASS_ALL yet because you'll have
to update the data permission lists to reference the new tree. You'll run the
SJT_CLASS_PROCESS then.
Modify a department security tree without changing the effective date. Run
Add a new permission list to the Security by Dept Tree page and add to it Run
data permission.
Modify the data permission of a permission list on the Security by Dept Tree Run
page.
Refresh the effective date of the trees on the Security by Dept Tree page Run
because you created a new effective-dated version of an existing tree.
This table indicates which refresh processes you should run when creating and modifying row security
permission lists:
Add a new permission list to the Security by Permission List page and add to
it data permission.
96 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
This table indicates which refresh processes you should run when you add, delete, or modify a user's data
permission:
Note. This table assumes that you have not enabled the USER_PROFILE message and the local subscription
HCM_Refresh_SJT_OPR_CLS and the ROLE_MAINT message and the local subscription
HCM_Role_Refresh_SJT_OPR_CLS to automatically update SJT_OPR_CLS. PeopleSoft does not deliver
the system with these messages enabled.
If these messages are enabled, the system updates SJT_OPR_CLS and you do not need to run the refresh
process following any of these actions.
Add a row security permission list to a user profile on the User Profile Run
General page.
Delete a row security permission list from a user profile on the User Profile Run
General page.
Change a row security permission list on a user profile on the User Profile Run
General page.
Create a new user profile by copying an existing profile that has permission Run
lists with data permission (whether by the Copy User Profiles page, the
Create Users process, or the Create Row Security - Dept Mgr process).
Add a role-based permission list (one that has data permission from the Run
Security Permission List page) to a role that is already assigned to a user.
Delete a role-based permission list (one that has data permission from the Run
Security Permission List page) from a role that is already assigned to a user.
Add a role that has one or more role-based permission lists (permission lists Run
that have data permission from the Security Permission List page) to a user
profile.
Delete a role that has one or more role-based permission lists (permission Run
lists that have data permission from the Security Permission List page) from
a user profile.
Add a permission list that is already assigned to a user (by way of a role) to
the Security by Permission List page and give it data permission.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 97
Setting Up and Administering HRMS Security Chapter 5
Add a permission list that is already assigned to a user on the User Profile
General page to the Security by Dept Tree page and give it data permission.
This table indicates which refresh processes you should run when you add, delete, or modify the following
transaction security data:
Department.
Job opening.
Using a mass update process that triggers the component interfaces, create,
delete, or modify multiple transaction records
Using a mass update process that does not trigger the component interfaces Run
(or otherwise bypass the component interface on the transaction record),
create, delete, or modify multiple transaction records.
Nightly SJT Refresh SCRTY_SJTDLY_RC Set Up HRMS, Security, Refresh the transaction
Process Core Row Level Security, security join tables to
Nightly SJT Refresh capture data changes that
Process, Nightly SJT were not automatically
Refresh Process loaded into the table. Run
shortly after midnight to
capture effective-dated
changes.
Refresh Trans. SJT tables SCRTY_SJT_RC Set Up HRMS, Security, Refresh some or all of the
Core Row Level Security, data in the transaction-based
Refresh Trans. SJT tables, security join tables to
Refresh Trans. SJT tables capture data changes that
were not automatically
loaded into the table.
98 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Refresh SJT_CLASS_ALL SCRTY_OPR_RC Set Up HRMS, Security, Refresh some or all of the
Core Row Level Security, data in the
Refresh SJT_CLASS_ALL, SJT_CLASS_ALL table to
Refresh SJT_CLASS_ALL capture changes to
permission lists that were
not automatically loaded
into the table.
Refresh SJT_OPR_CLS SCRTY_OPRCLS_RC Set Up HRMS, Security, Refresh some or all of the
(security operator class) Core Row Level Security, data in the SJT_OPR_CLS
Refresh SJT_OPR_CLS, to capture the current
Refresh SJT_OPR_CLS relationship between user
profiles and permission
lists.
Set up this process to run every night shortly after midnight using a recurring schedule and leaving the As Of
Date field empty. By running the process shortly after midnight, you capture the formerly future-dated rows
that have just become effective.
Transaction Sec Join Select the transaction security join table to update.
Table
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 99
Setting Up and Administering HRMS Security Chapter 5
Include yesterday's Select to include the previous day's changes. The program searches the system
changes? for any changes to the transaction records on the previous day and updates the
transaction security join tables with those changes. This ensures that any changes
that were made to the data outside of components or component interfaces are
captured.
If you do not select this check box, the process will only update the transaction
security join tables with the changes made on the as of date.
Note. It is recommended that you select this option every time you run this
process to guarantee that you are updating the transaction security join tables
with the latest information. Only deselect the check box if you are experiencing
performance issues and you are certain that the records are not being updated
outside of the regular user interface or component interfaces.
As Of Date Leave the as of date blank when you schedule this run control ID to run on a
recurring basis. The system will use the current, system date each time it runs.
100 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Refresh All Sets? Select All Security Sets to refresh all security sets.
Select One Security Set to refresh one security set.
Security Set and SJT If you are refreshing one security set, select the set. The system displays the
Table transaction security join table associated with the security set.
Refresh All Rows? Select to refresh every row in the security join table.
Deselect to refresh select rows in the security join table. The system displays the
Rows to Update grid.
Rows to Update Select the rows to update. The options available are the ones you selected for the
security set on the Security Sets component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 101
Setting Up and Administering HRMS Security Chapter 5
Rows to Update
The fields and buttons in the Rows to Update grid will vary depending on the rows you select to update in the
Rows to Update field. Enter the rows of data you want to update.
For example, if you select Security Type in the Rows to Update field, select the security types whose
transaction data you want to refresh.
Refresh Set Select the set of rows to refresh. The system displays the Set of Security to
Refresh grid.
You can select to refresh:
All Trees.
Permission List
Security Type
Specific Tree
102 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Refresh Tree Effdts by Select the date as of which you are refreshing the table. The process will refresh
(refresh tree effective the table with the security data that is effective as of this date.
dates by)
Set of Security to Select the values to refresh.
Refresh For example, if you've modified a row security permission list, rather than
refreshing the entire table, select Permission List in the Refresh Set field and
select the permission list you modified here.
If you've modified a specific tree, select Specific Tree in the Refresh Set field and
select the setID's to refresh for that tree.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 103
Setting Up and Administering HRMS Security Chapter 5
Select to refresh the table with the selected row security or role-based
permission lists IDs of users to whom they are attached.
Orpid
Select to refresh the table with the selected user IDs and the permission lists
assigned to them.
104 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Page Description
Find Search View Use this page to review details about the security search
view used by a component. There are a number of
different search views and even the same component can
use a different view, depending on which menu it is on.
The security view text tells you which security set the data
in the component falls into and if there is any special
selection criteria.
To use query search views you need to know the:
Component name.
Market.
Menu name.
Display Security Data Use this page to review security data for the selected
security set and security access type. You can further
refine the query by selecting a user ID, permission list, or
security key value, or a combination of the three.
Review both the permission list access and the transaction
data secured by the parameters.
For example, you can review the data permission assigned
to the permission list MyJobs for security set PPLJOB and
security access type 001 (department 11000). Or you can
review the transaction data available to permission list
MyJobs for security set PPLJOB and security access type
002 (112 people with jobs).
To compile a list of access for more than one access type,
download the data in the grids to Microsoft Excel
User Security Data Review a user's data permission profile, including his or
her roles, role-based permission lists, and row security
permission lists, and the data permission associated with
them.
The query only includes the roles and role-based
permission lists that contain data permission security.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 105
Setting Up and Administering HRMS Security Chapter 5
Page Description
Find in SJT_PERSON Use this page to review the access to transaction data. You
can review:
Find in SJT_DEPT
The data securing transaction records.
Find in SJT_PERSON_USF
Which permission list has data permission access to
Find in HRS_SJT_JO selected records.
Find Search View SCRTY_CLASS_DISP Set Up HRMS, Security, Use this page to query the
Core Row Level Security, actual view SQL text used
Security Data Inquiry, Find in a specific component.
Search View Enter the name of the view
you want to query in the
View Name field. You can
use the SQL Object ID to
view the definitions of the
SQL objects used in the
view.
Display Security Data SCRTY_TRANS_DISP Set Up HRMS, Security, Use this page to display the
Core Row Level Security, security data for a selected
Security Data Inquiry, security set and access type.
Display Security Data You can view the user
security data using the type
and the transaction data
secured by the type.
User Security Data SCRTY_OPR_DISP Set Up HRMS, Security, Use this page to query and
Core Row Level Security, review a user's security
Security Data Inquiry, User data, including assigned
Security Data roles and permission lists.
Find in SJT_PERSON SCRTY_SJT_PERSON Set Up HRMS, Security, Use this page to review the
Core Row Level Security, transaction data used to
Security Data Inquiry, Find secure a person's data and
in SJT_PERSON the permission lists and
users who have access the
person.
Find in SJT_DEPT SCRTY_SJT_DEPT Set Up HRMS, Security, Use this page to review the
Core Row Level Security, transaction data used to
Security Data Inquiry, Find secure a department's data
in SJT_DEPT and the permission lists and
users who have access the
department.
106 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Find in SJT_PERSON_USF SCRTY_SJT_PER_USF Set Up HRMS, Security, (USF) Use this page to
Core Row Level Security, review the transaction data
Security Data Inquiry, Find used to secure a person's
in SJT_PERSON_USF data and the permission lists
and users who have access
the person.
Find in HRS_SJT_JO SCRTY_SJT_RSOPN Set Up HRMS, Security, Use this page to review the
Core Row Level Security, transaction data used to
Security Data Inquiry, Find secure a job opening and the
in HRS_SJT_JO permission lists and users
who have access the job
opening.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 107
Setting Up and Administering HRMS Security Chapter 5
To review the view and SQL text used in a security search view indicate which search view to search by
entering the:
Component name
Market
Menu name
Search Record Name Displays the component's default search record when you access the component
in update or display mode.
Note. You can assign an override search record to a component at the menu
level. If the component uses an override search record, the search record
displayed in the Override Search Record will be different from this one and you
should search it instead.
Add Search Displays the component's search record when you access the component in add
mode.
Override Search Record Displays the component's override search record when you access the component
in update or display mode.
108 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
View Name and View To review the text from a search record view, enter it into the View Name field.
Text The system displays the view text when you tab out of the View Name field.
SQL Object ID and To review the SQL text within an SQL Object used by the view, enter the SQL
SqlText object ID into the SQL Object ID field. The system displays the SQL text when
you tab out of the SQL Object ID field.
For example, the security search view for the Personal Data component on the Administer Workforce menu,
when accessed in Update mode, is PERALL_SEC_SRCH. This search view uses the security sets PPLJOB
and PPLPOI and the transaction security join table SJT_PERSON. The view text has a special selection
criteria to not return rows where the APPT_TYPE (appointment type) is equal to 1.
You can use this information to review the security data in greater detail. Perhaps to see what data is secured
in security set PPLPOI or if the record a user is trying to access in this component has an appointment type
value equaling 1 and that is why the record is unavailable.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 109
Setting Up and Administering HRMS Security Chapter 5
Click the Clear All Entries button to clear the search value fields.
Security Set, Select the security set and security access type whose security data you want to
Transaction Sec Join review. The system displays the transaction security join table used by the
Table, and Security security set.
Access Type
110 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Note. If you want to review date permission security data for more than one security access type or for more
than one of the additional parameters below, down the results in the Show Security Definitions and View the
Transaction Data grids to Microsoft Excel and add to them as you perform your search.
To further refine the search within the selected security set or security access type, enter one or more values
in these fields:
User ID and ID/Name To review a user's data permission security data, select the user ID. The system
displays the ID and name of the person assigned to the selected profile.
Row Security To review the data permission security data of a row security permission list,
select the permission list.
When you select a tree-based security access type and enter a user ID, the system
enters the row security permission list associated with the user ID.
This field is only available when you select a tree-based security access type.
Security Key 1, Security To review the data permission security data for a selected security key, select the
Key 2, and Security Key values (for example, to review the security data for department 10000, enter the
3 department setID SHARE in Security Key 1 and the department id 10000 in
Security Key 2).
Expand the Show SQL group boxes in the Show Security Definitions group box and the Viewing Transaction
Data group box to review the SQL used to query SJT_CLASS_ALL table and transaction security join table
for this query.
See Chapter 5, "Setting Up and Administering HRMS Security," Understanding Data Permission Security for
HRMS, page 45.
Click the Show Security Definitions button to display the user security data that meets the search criteria.
The grid displays the permission list and the security key values that the permission list can access.
Tree The system selects this check box for row security (tree-based) permission lists.
Click the Show Transaction Data button to display the transaction data stored in the transaction security join
table of the selected security set. The rows in the grid vary depending on which security set you are querying.
Security Key 1 or Key 1, Displays the transaction security data (and the necessary key values) used to
Security Key 2 or Key 2, secure this row of data.
and Security Key 3 or
Key 3
SetID, Department, For rows of department transaction data, displays the set ID and the department
Effective Date, and whose data is secured.
Description
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 111
Setting Up and Administering HRMS Security Chapter 5
Job Opening ID For rows of recruiting solutions job openings, displays the ID of the job opening
whose data is being secured.
Empl ID, Empl Record, For rows of person transaction data, displays the ID, employee record number (if
and Name applicable), and the name of the person whose data is secured.
A person with more than one unique empl ID and employee record number
combination will have more than one row of data.
Home/Host This field is for global assignments and indicates if the transaction row is from
the home or the host assignment job data record. Only job data records for the
global assignment will display Host.
See Chapter 5, "Setting Up and Administering HRMS Security," Installing
HRMS Security, page 72.
Intl Type (international If you are using special security options for global assignment job data records,
type) this field indicates if this row was created by the system to enable special job
security.
See Chapter 5, "Setting Up and Administering HRMS Security," Understanding
Special Job Security Options, page 71.
Future? This field indicates of the row comes from a future-dated transaction row.
See Chapter 5, "Setting Up and Administering HRMS Security," Understanding
Future-Dated Security, page 70.
Addl Appt (additional (JPN) Indicates if this is an additional appointment transaction row.
appointment)
See Chapter 5, "Setting Up and Administering HRMS Security," Installing
HRMS Security, page 72.
WIP Status, Retirement, (USF) displays additional information about the job data row. These values are
NOA Code, and Stat not used to secure data.
Type
112 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
User ID Select the user ID of the person whose data permission access you want to query.
The system displays the user's name and his or her row security permission list.
Click the Show Security Definitions button to populate the grids on the page.
Displays the roles assigned to the user and the permission lists with data permission assigned to those roles.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 113
Setting Up and Administering HRMS Security Chapter 5
Note. The SCRTY_OPR_ROLE table only stores the roles that have permission lists with data permission.
The grid does not list roles that do not have data permission .
Displays the data permission of the role-based permission lists associated with this user's roles.
Displays the permissions of the row security permission list assigned to this user.
See Also
114 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Note. The Find in SJT_PERSON_USF page does not have the option to search for POIs.
Select the EmplID of the person whose transaction security data you want to review. To limit the search to a
single job data record, enter the employee record number. To limit the search to a specific person of interest
type, select the type.
Click the Show Security Definitions button to populate the Security Data - SJT_PERSON grid with the
transaction security data securing this person's record or records.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 115
Setting Up and Administering HRMS Security Chapter 5
Click the Show Security Definitions button to populate the Security Data - SJT_PERSON grid.
The system lists the rows in SJT_PERSON that match the search criteria you entered. Review the security
keys on the Security Key Data tab. Access the Special Job Flags tab to review special security job option
data, such as if a row is a future-dated row or if it was created to enable home/host access or additional
assignment access.
To review which permission lists have data permission access to one or more of these rows, select the rows
and click the Show Permission Lists button.
For each security set and security access type, the system lists the permission lists that can access the
transaction rows you selected.
To review which users are assigned to one or more of these permission lists, select the rows and click the
Show Users button.
Operator Data
The system displays each user assigned to the permission list or lists that you selected and indicates if the
permission list is assigned to the user as a row security permission list or role-based (role-class) and, if the
permission list is role-based, which role it is assigned to on the user's profile.
116 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Select the setID and department ID of the department whose transaction security data you want to review.
Click the Show Security Definitions button to populate the Security Data - SJT_DEPT grid with the
transaction security data securing this department's record or records.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 117
Setting Up and Administering HRMS Security Chapter 5
Select the ID of the job opening whose transaction security data you want to review.
Click the Show Security Definitions button to populate the Security Data - HRS_SJT_JO grid with the
transaction security data securing this job opening's record or records.
This section provides an overview of data permission for managers and discusses how to create data
permission for managers.
118 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Create a user profile if the manager is new and has no user profile.
Create or update an existing row security permission list for each department manager, giving them access
to the data in the departments that they manage.
Delete the row security permission list for a user if it is obsolete (for example, the employee is no longer a
manager).
The system uses the MgrID value from the Department Profile page (DEPARTMENT_TBL_GBL) to
determine a department's manager. Managers will be given access to every department for which their ID is
listed in the MgrID field.
Since you can list only one department manager per department, you will have to manually update the
profiles of additional department managers. You can do this by assigning the row security permission list the
system creates for the official manager to the unofficial manager's profile. Remember that the system will
remove this list every time you run the Create Row Security for Mgr process.
Note. The Create Row Security for Mgr process uses the managers' EmplID as their user ID and uses the
following naming convention for row security permission lists: HCDP_DEPT_MGR_[manager's EmplID]
The Create Row Security for Mgr process uses tree-based security to create row security permission lists for
managers. Before you run this process, you must have set up a department security tree.
The hierarchy rules of the department security tree apply to these permission lists. If a manager's department
has departments reporting up to it on the security tree, the manager will have access to the people in those
departments as well as his or her own.
The Create Row Security for Mgr process creates and modifies row security permission lists and assigns row
security permission lists to, or deletes them from, user profiles. Both of these actions require that you:
Run the Refresh SJT_CLASS_ALL process to refresh SJT_CLASS_ALL with the row security
permissions list data.
Run the Refresh SJT_OPR_CLS process to refresh SJT_OPR_CLS with the new user profile and row
security permission list pairings from the User Profile - General page.
The system will not enforce the new data permission set up by the process until you run these refresh
processes.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refreshing SJT_CLASS_ALL
Process, page 102.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the Refresh SJT_OPR_CLS
Process, page 103.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 119
Setting Up and Administering HRMS Security Chapter 5
Create Manager Users and RUNCTL_PER510 Set Up HRMS, Security, Use to create and update
Sec. (create row security for User Maintenance, Create manager row security
manager) Manager Users and Sec., permission lists.
Create Manager Users and
Sec.
As Of Date Select the date as of which the row security list permission list should become
effective.
User ID Select a default User ID. The system will base the new user IDs on this default.
Create User as locked Select to lock all the new user IDs.
The Create Row Security for Mgr process consists of two PeopleSoft Application Engine processes and one
SQR report:
120 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
1. HR_PER510.
Determines the changes required in order to maintain data-permission for department managers.
2. HR_PER510_CI
Lists the changes determined by HR_PER510 and applied by HR_PER510_CI and their status.
Note. You must select each process individually and wait for it to complete successfully before selecting and
running the next process.
This section provides an overview of security for user IDs and discusses how to:
Create users.
Lock users.
Use the Lock Users page to lock user IDs (employee IDs) until you are ready to use them.
See Also
Chapter 22, "Setting Up and Working with Group Definitions," page 541
Group ID Select the ID of the group whose members require user IDs.
Populate Group Click to populate the page with the group members.
EmplID and Name Displays the Empl IDs and names of the individuals in the selected group.
User ID Displays the user IDs of the individuals once you've clicked the Create User IDs
button. The system uses the Empl ID as the User ID.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 121
Setting Up and Administering HRMS Security Chapter 5
Account Locked Out? The system selects this option if the user ID account is locked out.
Create Users CREATE_USERS Set Up HRMS, Security, Use to create user IDs for a
User Maintenance, Create group of individuals.
Users, Create Users
Lock Users page LOCK_USERS Set Up HRMS, Security, Use to lock or unlock
User Maintenance, Lock groups of user IDs.
Users, Lock Users
Creating Users
Access the Create Users page (Set Up HRMS, Security, User Maintenance, Create Users, Create Users).
Note. The user ID created by this process will be the same as the employee ID for which it was created.
Group ID Enter or select the group ID that you want to use to create user IDs for a group of
individuals.
122 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
User ID Select a default User ID. The system will base the new user IDs on this default.
Once created, you can modify individual profiles on the User ID pages.
If the user ID upon which you are basing the new users has data permission, you
will need to run the Refresh SJT_OPR_CLS process. Otherwise the system will
not recognize the data permission on the new user profiles.
See Chapter 5, "Setting Up and Administering HRMS Security," Running the
Refresh SJT_OPR_CLS Process, page 103.
Create User as locked Select to lock all the new user IDs.
Locking Users
Access the Lock Users page (Set Up HRMS, Security, User Maintenance, Lock Users, Lock Users).
Note. You can only lock users created through the Create Users page. The employee ID and user ID are the
same value.
Lock Group Click to run the process and lock the user IDs (employee IDs) of the entire group.
Unlock Group Click to run the process and unlock the user IDs (employee IDs) of the entire
group.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 123
Setting Up and Administering HRMS Security Chapter 5
1. Use the Country Specific - Installed HR Countries page (INSTALLATION_SEC) to select the local
country functionality that is installed as part of your PeopleSoft HRMS system.
If you do not specify a country here, its local functionality can't be accessed.
2. Grant the primary permission lists access to country-specific functionality using the Setup Global Security
page.
3. Assign a user access to a primary permission list containing access to the countries that are required by
the user on the User Profile - General page.
See Also
Setup Global Security SCRTY_TBL_GBL Set Up HRMS, Security, Select which country
Component and Page functionality a primary
Security, Setup Global permission list can access
Security, Setup Global on global components.
Security
Setup Global Security - SCRTY_GBL_SEC Click the Excluded Restrict access to local
Excluded Panelgroups Components link on the functionality on selected
Setup Global Security page. components.
124 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
Primary Permission List Users assigned to this permission list can access the country-specific sections on
global components of the countries that you indicate on this page.
Primary permission lists are defined in the Permission List component. Users are
assigned a primary permission list on the User Profile - General page.
Country Select the country or countries whose local functionality users assigned to the
primary permission list can access in global components.
Excluded Components When you click Excluded Components, the system displays the Restricting
Access to Local Country Functionality page. Using this page, you can restrict
access to country-specific functionality in select components.
For example, you can grant a permission list access to Italian sections on all
global components except for Personal Data.
See Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List
Preferences, page 312.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 125
Setting Up and Administering HRMS Security Chapter 5
Component Name Select the name of the component for which global functionality for this country
is being restricted. For example, to restrict access to Italian-specific functionality
in the Personal Data component, select the Personal Data component.
If you use this view, you need to create a class of users who can access all departments so that they can
perform transfers. Also, update the Job record definition in PeopleSoft Application Designer so that the
prompt table for the DEPT_ID field is DEPT_SEC_VW. You may also want to change the security view on
the DEPARTMENT_TBL component to this view if you want users to only be able to access departments
they have access to. This is defined using the Department security sets.
See Also
126 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 5 Setting Up and Administering HRMS Security
For example, to allow workers to change their own personal data, you enable the PeopleCode function for
PERSONAL_DATA, the underlying record definition for the Personal Data component. Then workers can
change their personal data, but not their job information.
4. Insert a row and enter the following code after the first line (a comment) of existing code:
if %Component = Component.PERSONAL_DATA then
AllowEmplidChg(true);
end-if;
Workers can now update their own data using the Personal Data page.
To allow workers to update their own data in other places in PeopleSoft HRMS, enter this PeopleCode
function in the underlying record definition for each page where you want to allow updates.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 127
Chapter 6
This section provides an overview of implementation defaults and discusses how to:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 129
Setting Up and Installing PeopleSoft HRMS Chapter 6
Warning! You must complete the information on the Org Defaults by Permission Lst component
(OPR_DEF_TBL_HR) for each primary permission list. Most of the defaults in PeopleSoft HRMS come
from the Org Defaults by Permission Lst component and not the Installation Table pages. Other PeopleSoft
HRMS applications have defaults that are based on the Installation Table settings. However, in PeopleSoft
Enterprise Human Resources, all defaults are based on the settings that you make on the Org Defaults by
Permission Lst component. There are some exceptions to this rule in PeopleSoft Human Resources, and they
are noted in the default field level discussion.
See Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List
Preferences, page 312.
When you access the Installation Table pages for the first time, you'll see that PeopleSoft has already entered
information for a sample company that you can use as a guide. After you enter your installation information,
log off to save your changes.
Global Payroll Country INSTALL_GP_SEC Click the Installed GP Select the PeopleSoft
Extensions Countries link on the Enterprise Global Payroll
Products page. country extensions you are
implementing.
HRMS Options INSTALLATION_TBL1B Set Up HRMS, Install, Specify how to drive your
Installation Table, HRMS system: by person, by
Options position, or both.
Enter the PeopleSoft
HRMS defaults that are
related to your
organizational policies.
Product Specific INSTALLATION_TBL1A Set Up HRMS, Install, Enter product- and industry-
Installation Table, Product specific installation
Specific information.
130 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Installed HR Countries INSTALLATION_SEC Click the Installed HR Specify which local country
Countries link on the functionality to activate for
Installation Table - Country users in PeopleSoft
Specific page. Enterprise Human
Resources.
Last ID Assigned INSTALLATION_TBL2 Set Up HRMS, Install, Specify the number that the
Installation Table, Last ID system uses to start
Assigned assigning numbers.
Third Party/System INSTALLATION_TBL4 Set Up HRMS, Install, Set the criteria for gathering
Installation Table, Third statistics and activate the
Party/System SQR security for PeopleSoft
HRMS. Define parameters
for using third-party
applications such as Visio.
Alternate Character ALT_CHAR_TBL Set Up HRMS, Install, Specify the language code
Installation Table, Alternate and alternate character type.
Character
Installation Table Report - PRCSRUNCNTL Set Up HRMS, Install, Run the Installation Table
Run Control Installation Table Report, report (PER702). This
Run Control report lists default values
for field defaults, such as
company code,
minimum/maximum
standard hours, and Social
Security number.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 131
Setting Up and Installing PeopleSoft HRMS Chapter 6
Products page
Select the applications you are installing. To access that application's functionality, you must select it on this
page.
If you are implementing PeopleSoft Global Payroll, select the Installed GP Countries link to select the Global
Payroll country extensions you are implementing.
If you are implementing an integration product, select the Installed Integration Products link to select the
integration product.
To set up your database for U.S. federal government functionality, select Federal on the Installation Table -
Products page and update the Org Defaults by Permission Lst component to point to the U.S. federal
government industry and sector.
To set up your database for military functionality, select Militaryon the Installation Table - Products page.
Make your primary permission list preference changes on the Settings page of the Org Defaults by Permission
Lst component. To set up a federal database, select an Industry of Government and an Industry Sector of US
Federal.
132 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Company Select the default company code. The system uses this default in several tables in
PeopleSoft Human Resources.
For a single-company organization, enter the code for that company; for
multicompany environments, determine which company is most appropriate.
Standard Hours
To use this functionality to control payroll input in PeopleSoft Global Payroll, review your payroll and make
sure that the elements reference the appropriate PeopleSoft Human Resources items. The system does not use
them automatically.
Min Standard Hours Enter the minimum and maximum standard hours that workers are expected to
(minimum standard work in the standard work period. The system enters this information as default
hours) and Max values but you can override the values on either the Job Code component
Standard Hours (JOB_CODE_TBL) or Position Data component (POSITION_DATA).
(maximum standard
hours)
Default Standard Hours Enter the number of hours in a standard work period at the company. This is a
required field. When you define preferences for a primary permission list, the
standard hours appear by default from the Installation Table. The value that you
enter also becomes the default standard hours value for a job in the Job Code
Table component and the default standard hours value in the Salary Plan Table
component (SALARY_PLAN_TABLE).
PeopleSoft Human Resources uses standard hours to compute a full-time
equivalency (FTE) value to prorate holiday hours and pay for part-time and
hourly workers.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 133
Setting Up and Installing PeopleSoft HRMS Chapter 6
Work Period Select a standard work period (the time period in which workers must complete
the standard hours). Values are stored on the Frequency table.
The system uses the annualization factor of the standard work period in
combination with the standard hours to calculate FTE.
To drive part or all of the system by position, change the setting in this group box.
If you use PeopleSoft Enterprise Pension Administration, don't use position management for your retiree
organization. If you use position management for your workers, select Partial to exclude retiree departments.
Note. Using position management substantially alters the way that the system processes your data, and
requires you to maintain data differently.
Full The system expects that you track position data for all people in your
organization and that you drive your human resource system by position, not by
person.
Partial The system uses whatever position data is available, but doesn't require that you
track your entire organization using position management. Select to use the
business process on a trial basis or for selected departments.
None You drive your system by person. You can still assign position numbers to
people, but the system doesn't use position data for job records, such as work
phone or mail drop ID. This is helpful for tracking only certain positions, such as
those above a particular management level.
Online Update The system uses this number to capture the maximum number of incumbents in a
Incumbent Limit position that will be updated online. The system default is 50, but you can adjust
this amount based on your organization's server capabilities.
If the number of incumbents for the position does not exceed the limit set here,
the incumbent data is updated online.
When saving data in the Position Data component, and the number of incumbents
for the position exceeds the limit set here, the system will display a message that
the update of incumbent data will be done through a batch process. The process
is scheduled and another message with the process instance number of the job
displays. The application engine program calls the Position Data CI so that the
UpdateIncumbents function is invoked to perform the incumbent updates.
Default Comp Select the value to use for reporting salaries. This field is required. The system
Frequency (default also uses this value as the default compensation frequency in the Job Code Table.
compensation frequency)
134 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Use Rate Code Groups Select if your organization bundles rate codes to apply percentages when
calculating compensation.
Use Salary Points Select if your organization uses rate codes that have the rate code type points.
Multi-Step Grade Select if your organization uses a multistep/grade salary plan. This causes the
system to use the Salary Step Components page (SALARY_PLAN_T3GBL) to
determine compensation rates.
Currency
Multi-Currency Select if you use different types of currency to pay people. This option affects
only PeopleSoft Enterprise Payroll for North America. PeopleSoft Global Payroll
uses a separate multicurrency in the payroll system.
Note. Select the Multi-Currency check box on the PeopleTools Options page
(PSOPTIONS).
Base Currency Select a currency code from the values in the Currency Code page
(CURRENCY_CD_TABLE). The code you select is the default currency that the
system uses to calculate compa-ratios (percent through range calculations) and all
total amounts on pages and reports for PeopleSoft Human Resources and
PeopleSoft Payroll for North America, regardless of the currency that is used for
individual line items.
For example, if the U.S. dollar is your base currency, but your global salespeople
submit expense reports in French francs, the system calculates the expense total
in U.S. dollars by internally converting all line item amounts to U.S. dollars and
displaying the total in U.S. dollars.
Note. All currency defaults in PeopleSoft Human Resources are based on the
base currency that you indicate on the Installation Table page, not the Org
Defaults by Permission Lst component. The Org Defaults by Permission Lst
component doesn't affect the currency defaults on the local country pages.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Enterprise Components,"Working With
Currencies and Market Rates"
Rate Type Identify the default rate type on which your currency conversion is based. Do this
only if you haven't specified a default rate type for a primary permission list on
the Org Defaults by Permission Lst component. The system checks the Org
Defaults by Permission Lst component for a default rate type first; if none is
specified, it looks at this value.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 135
Setting Up and Installing PeopleSoft HRMS Chapter 6
See Also
Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List Preferences,
page 312
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions,"
Creating Positions
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting
136 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Benefits Functions
When the 415(c) limit is met, the deduction classes are limited in the following order: Employee Before-tax
contribution, Employee After-tax contribution, Ptax Benefit (Employer Before tax Match), & then the
Nontaxable Benefit (After Tax Employer Match). The user can change the deduction class order when the
limit is met by selecting PTax Benefit then EE After Tax Employer Before Tax Contribution is limited
first then the Employee After Tax Contribution. The deduction class order will then be Employee Before-tax
contribution, Ptax Benefit (Employer Before tax Match), Employee After-tax contribution & then the
Nontaxable Benefit (After Tax Employer Match).
Default Pay Basis For the Default Pay Basis, select the value to use for quoting and reporting
salaries. This field is required if you selected Federal on the Products page.
NFC Indicator Select this check box to expose National Finance Center (NFC) fields on
impacted components and run the associated Peoplecode logic.
Concurrent Select to enable the system to run a calculation and confirmation at the same
Calc/Confirm time. It is possible for a person to be in two concurrent runs; this could cause a
(concurrent calculation deadlock situation where the process ends abnormally.
and confirmation)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 137
Setting Up and Installing PeopleSoft HRMS Chapter 6
Automatic Employee Select to enable the system to create employee federal, state, and provincial tax
Tax Data records automatically whenever the following criteria are met:
You hire an employee.
You add a concurrent job that requires a new work tax location for an
employee.
Use State Residence for Automatically selected when you select Automatic Employee Tax Data. Leave
Local this field selected to assume that an employee is a resident of any local tax
jurisdiction that happens to be located in the employee's state of residence. If this
assumption is not true, clear this field to prevent resident local taxes from being
erroneously deducted from an employee's paycheck.
T&L/NA Payroll Paysheet Opt (Time and Labor and Payroll for North America paysheet
options)
Change Final Check, Select to enable payroll users to make paysheet changes to data that is retrieved
Change Online Check, from PeopleSoft Enterprise Time and Labor. PeopleSoft recommends not
and Change Reversal selecting these check boxes because changes that are made directly to the
Adjustments paysheets aren't transmitted to PeopleSoft Time and Labor.
Load in Preliminary The Pay Calculation process uses the value of the Load in Preliminary Calc field
Calc (load in preliminary to determine whether to load new available time (additional time that was worked
calculation) before the job change but not previously loaded on paysheets):
If you select this check box, the system loads all valid available time to the
new paysheets, including new available time.
If you deselect this check box, the process does not load any new available
time to paysheets, except as noted below.
Note. If an employee had a Job data change that caused paysheets to be rebuilt,
the Pay Calculation process attempts to reload all valid time and rejects time that
is no longer valid as a result of the Job data change. This is true regardless of the
setting of the Load in Preliminary Calc field. In this case, the process first rejects
all previously loaded time, then it reloads the available time. If Load in
Preliminary Calc is not selected, some new time might be loaded, but only for the
employee being processed due to the Job data change.
AP Inv. Prefix (accounts (Optional) Enter a prefix to be used for accounts payable invoices that are
payable invoice prefix) generated through HRMS.
138 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Commitment Accounting
Encumbrance Trigger Select to enable pre-encumbrance and encumbrance triggers to be processed from
various online events. Each event causes the system write a record to the
Encumbrance Trigger table (ENCUMB_TRIGGER), which is then used as input
for the Batch Encumbrance Calculation process (ENC_CALC).
Comm Control Budget Select to enable real-time budget checking using the Commitment Control
Processor (commitment Budget Processor in PeopleSoft Financials. Real-time budget checking verifies
control budget processor) available funding for job data changes or position data changes that generate
encumbrances and pre-encumbrances. The Commitment Control Budget
Processor is a PeopleSoft Financials Application Engine program that checks
your budget for available funds
This check box is available if you have configured the necessary integration with
PeopleSoft Financials 9.0 or higher, but you must separately confirm that the
necessary ledgers have been set up. If the ledgers have not been set up, the
Commitment Control Budget Processor response to all budget checks is that the
charges are invalid.
Enforce Real Time This setting is applicable only to departments with real time budget checking
Budget Check configured in department table setup.
Select to prevent users from saving certain critical job data and position data
changes when real-time budget checking shows that there are not sufficient
budgeted funds for the change.
Critical changes in the Job Data component include hiring, rehiring, and adding a
concurrent job. Critical changes in the Position Data component include creating
a position, increasing the head count for a position, changing a position from
inactive to active, and changing the Pre-Encumbrance Indicator for a position
from None or Requisition to Immediate. Any other changes that affect
encumbrance and pre-encumbrance calculations are considered non-critical.
If you select this check box, users must address the budget errors before the
system will allow the critical job data or position data changes to be saved. If you
do not select this check box, users can choose to ignore the budget errors for
critical changes.
Note. Users can always ignore budget check errors related to non-critical job data
and position data changes.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 139
Setting Up and Installing PeopleSoft HRMS Chapter 6
Human Resources
Multi-Company Select if your organization comprises more than one company. Select if you use
Organization PeopleSoft Pension Administration, because you set up companies specifically to
house your pension payees.
Automatic Job Select to automatically terminate any job that has an end date. The system does
Termination this by creating a termination row for the job.
Automatic Job Select to activate substantive job suspension for workers working in temporary
Suspension assignments where the substantive job requires suspension for the duration of the
assignments.
'Temporary SSN' Mask Enter a three-digit number to be a default Social Security number for all
(temporary Social applicants or people whose Social Security numbers are unavailable. Assign a
Security number mask) value that is greater than 800 so that the temporary number doesn't conflict with
valid Social Security numbers.
Empl ID Field Length Enter the number of characters to be used for employee IDs.
General Ledger
GL Version Displays the version of PeopleSoft Enterprise General Ledger that is interfacing
with PeopleSoft HRMS. Click the Update Version button if you change versions.
The system will automatically update the GL Version.
Note. Full ChartField functionality is available only when you use PeopleSoft
General Ledger 8.4 or higher. Real-time budget checking is available only when
you use PeopleSoft Financials 9.0 or higher with Commitment Control.
Update Version Click to test the integration with PeopleSoft Enterprise Financials and display the
latest version of Financials.
Cache Validations Select to cache the results of your validations. This improves performance by
enabling you to cached validations.
Cache Retention Days Enter the number of days to store validation results. The system will delete
anything in the cache older than this.
See Also
140 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Country
Language Code The system displays the default base language for the database.
Installed HR Countries Select this link to go to the Installed HR Countries page, where you can select
which local country functionality is installed in the system.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 141
Setting Up and Installing PeopleSoft HRMS Chapter 6
Last ROE Nbr (last Enter the last ROE, direct deposit file, flexible spending account carry-forward
record of employment claim, and CPS transmission ID numbers that were used.
number), Last Dir Dep The system increases each number by one when it assigns a new number. The
File Creation Nbr (last system also updates the Installation Table every time it assigns a number. These
direct deposit file creation values are used in PeopleSoft Payroll for North America when running a
number), Last FSA Canadian payroll.
CarryForward Claim #
(last flexible spending
account carry-forward
claim number), and Last
CPS Transmission ID
Nbr (last CPS
transmission ID number)
Census Metro Area Enter the Census Metro Area (CMA) code that is prescribed by Statistics Canada
(census metropolitan area) for this location. The system uses the default CMA code that you enter only if no
default CMA code is specified on the Org Defaults by Permission Lst
component. CMA refers to the main labor market area of an urban core with a
population of at least 100,000. This field is required for Canadian companies.
See Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List
Preferences, page 312.
Industrial Sector Used for Canadian employment equity purposes. The system uses the default
value that you enter only if no default industrial sector is specified on the Org
Defaults by Permission Lst component. This value is used as the default for the
Canadian Industrial Sector field in the Department component; and it identifies
the industrial sector with which people in a given department are associated. This
field is required.
See Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List
Preferences, page 312.
See Chapter 11, "Setting Up Organization Foundation Tables," Maintaining Departments, page 299.
Education & Select this check box for Australian public service organizations.
Government
142 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Additional Appointment Select if you will be implementing Additional Appointment tracking (Kenmu).
Enabled Selecting this check box activates functionality to create a dummy additional
appointment job code when you create a new business unit.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer
Workforce, "(JPN) Tracking Additional Appointments (Kenmu)."
Two-Question Format Select this check box if you want to collect U.S. employee ethnicity data using
(Ethnicity) the two-question format defined in the U.S. Office of Management and Budget's
(OMB) 1997 Standards for Maintaining, Collecting and Presenting Federal Data
on Race and Ethnicity.
When this check box is selected, U.S. employees who access the self-service
Ethnic Groups page see a version of the page that uses the two-question format.
When this check box is deselected, U.S. employees see the same version of the
self-service Ethnic Groups page that non-U.S. employees see. This general-
purpose version of the page does not include any questions. Instead, employees
specify one or more ethnicities in an Ethnic Groups grid.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 143
Setting Up and Installing PeopleSoft HRMS Chapter 6
The system displays a flag for each country that has special local functionality in PeopleSoft Human
Resources:
Select a check box to activate local functionality for that country. Users who have security access can see
and work with that country's local functionality.
Deselect a check box to hide that local functionality from your users.
If the check box for a country is selected on this page, but you don't grant country access to the users' primary
permission list on the Setup Global Security page (SCRTY_TBL_GBL), users will not see local country
functionality.
See Chapter 5, "Setting Up and Administering HRMS Security," Setting Up Security for Local Functionality,
page 124.
144 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
In PeopleSoft HRMS, there are several fields where you can either enter numbers manually or let the system
assign them.
Last HS Non-Employee ID Assgn PeopleSoft Human Resources Monitor Health and Safety
Administer Training
Last Position Nbr Used PeopleSoft Human Resources Manage Positions Plan Successions
Last Grievance Nbr Used PeopleSoft Human Resources Manage Labor Administration
Last Car Nbr Used PeopleSoft Human Resources Administer Company Cars
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 145
Setting Up and Installing PeopleSoft HRMS Chapter 6
Last Template Hire Seq # Used PeopleSoft Human Resources Administer Workforce
Last H/S Claim Nbr Assigned PeopleSoft Human Resources Monitor Health and Safety
Last Incident Nbr Used PeopleSoft Human Resources Monitor Health and Safety
Last Journal Nbr Assigned PeopleSoft Payroll for North Administer GL Interface
America
Last Help Context Nbr Used PeopleSoft HRMS Customizing Windows Online Help
Last Retro Pay Request Seq Nbr PeopleSoft Payroll for North Manage Retroactive Pay
America
Last Retro Ded Request Seq Nbr PeopleSoft Benefits Administration Manage Retroactive
Benefits/Deductions
PeopleSoft Human Resources: Base
Benefits
Last FSA Claim Nbr Assigned PeopleSoft FSA Claims Administer FSA
Administration
146 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Last OSHA Case Nbr Assigned PeopleSoft Human Resources Monitor Health and Safety
Meet Regulatory Requirements
To let the system assign numbers for the fields on this page, enter the last number that you used in the field.
The system increases that number by one when it assigns a new number. The system updates the Installation
Table every time it assigns a number.
Note. To avoid maintaining two different sets of numbers, either always assign numbers manually or always
let the system do it.
ID Considerations
When you convert ID data to PeopleSoft Human Resources from another system, enter the highest number
that was used in your previous system so that you don't duplicate IDs. If the last ID you assigned in your
previous system was 1000, enter 1000 in the Last Employee ID Assigned field. When you add a person in
PeopleSoft Human Resources, the system assigns an ID of 1001 and updates the Last Employee ID Assigned
field accordingly.
To always enter IDs manually, enter 9999999999 (ten 9's) in the Last Employee ID Assigned and Last
Applicant ID Assigned fields.
If you use Social Security or insurance numbers as IDs, change the formatting for the employee ID field using
PeopleSoft Application Designer.
Zero-filled Numbers
To make data entry faster and more accurate on several pages when you enter a number that the system has
assigned, the system enters zeros before the number. For example, when you enter 4, you see 00000004, a
total of 8 characters per number. This occurs in the following fields:
Job Opening
Requirements Search
Grievance
Incident
Claim
Position
Note. If you have already assigned numbers that aren't zero-filled, change their numbering so that the system
can accurately track them when you convert the data to PeopleSoft Human Resources.
For more information about data conversion, ask your human resources project leader or see the PeopleSoft
Application Designer documentation.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 147
Setting Up and Installing PeopleSoft HRMS Chapter 6
See Also
Start Time For Stats Enter the date and time of the start and stop.
Gathering (start time for
statistics gathering) and
Stop Time For Stats
Gathering (stop time for
statistics gathering)
Gather Statistics for Select to gather statistics locally.
Table
Gather Statistics Select to gather statistics globally.
Globally
Write Interval Enter the number of seconds for gathering the statistics.
Organization Chart Enter the type of third-party program you use to create organizational charts with
your human resources data.
148 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
System Defaults
Max Number of Rows in Enter the maximum number of rows in a scroll-controlled data box for third-party
Scrolls (maximum systems.
number of rows in scrolls)
Commit After Empl Enter the maximum number of people that a third-party system processes before
Processed (commit after committing.
employee processed)
See Also
Note. Because you are setting the alternate character code on the Installation Table, the setting affects your
entire HRMS application configuration. Make sure that you account for all language codes for your
installation.
If you don't specify an alternate character type for a language code that a user is working with, and the user
tries to enter characters in an Alternate Character field, a warning message appears.
If you specify an alternate character type for a language code, and a user enters any other character type in an
Alternate Character field, a warning message appears.
Note. You can ignore the warning message and enter the data in another character set, but problems can occur
when data is sorted in multiple alternate character sets.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 149
Setting Up and Installing PeopleSoft HRMS Chapter 6
This section discusses how to set up HRMS options on the PeopleTools Options page.
You use the PeopleTools Options page to set a variety of values that are related to:
Multi-company organizations.
Access the PeopleTools Options page on the PeopleTools, Utilities, Administration menu.
Select the following check boxes, as applicable, to activate these kinds of functionality:
Multi-Company Select if your organization comprises more than one company or if you use
Organization PeopleSoft Pension Administration to set up companies specifically to house
your pension payees.
Multi-Currency Select to enter data in more than one currency. For example, if you have offices
in the United States and Italy, you may want to calculate pay rates in both U.S.
dollars and Italian lira. If you select Multi-Currency, the system displays a
Currency Code field on pages where amount fields appear.
Note. Multi-Currency doesn't affect PeopleSoft Global Payroll, which has its
own multiple currency functionality.
Multiple Jobs Allowed PeopleSoft HRMS requires that you leave this option selected.
Multiple job functionality must be active so that PeopleSoft Human Resources
can manage data for people with whom you have different types of
organizational relationships (employee, contingent worker, and person of
interest).
See Also
150 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
This section provides an overview of country codes and enterprise integration points and discusses how to:
You need codes for all the countries where your organization does business and where the people in your
system live. The Country Description page (COUNTRY_DEFN) includes an extensive list of predefined
countries and codes. The page is updated with each version of PeopleSoft Human Resources according to the
countries that are recognized by the International Standards Organization (ISO).
If you need a new country code, notify your PeopleSoft account manager so that we can add it to the Country
Table for the next version of PeopleSoft Human Resources.
Address Format ADDR_FORMAT_TABLE Set Up HRMS, Install, Specify the address format
Country Table, Address for the country that is
Format selected from the Country
Table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 151
Setting Up and Installing PeopleSoft HRMS Chapter 6
Valid Address EO_ADDR_VALIDAT Set Up HRMS, Install, Specify the county, state,
Country Table, Valid and city for the country that
Address is selected from the Country
Table.
Country Table Report - Run PRCSRUNCNTL Set Up HRMS, Install, Run the Country Table
Control Country Table Report, Run report (PER708) that prints
Control a list all country character
codes.
2-Char Country Code Enter the code that the U.S. government assigned to the country, if applicable.
(two-character country
code)
EU Member State Select if this is an EU member state. This field is for your reference only and
(European Union member doesn't impact system processing or reporting.
state)
152 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Address Edit Page Select an address page from the list of available options. The system will display
the list of fields on that page in the Address Fields group box.
Enable Address Select to enable the system to validate address entries for state or province and
Validation city as shown on the Valid Address page.
Address Fields
Field Name The Field Name column displays the address fields available in the PeopleSoft
HRMS.
Edit Label Override Enter a different label to override the displayed Field Name, if required for this
country.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 153
Setting Up and Installing PeopleSoft HRMS Chapter 6
Include in Display? Select to have the system include this field when an address appears in read-only
mode. Deselect this check box for specific fields if your organization wants to
display addresses in a format that is different from how addresses appear during
data entry.
Include in Print? Select to have the system print this field whenever an address in this country will
be printed.
Line Number Enter the line on the page on which this field should appear.
Use Description? Select to have the system display a full description for this field.
Pre Separator and Post Enter separator characters for the address elements if applicable (for example and
Separator em dash).
154 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Valid Addresses
The Valid Address page stores state/province codes with corresponding cities, as entered on the State/
Province page. When you select Enable Address Validation on the Address Format page, the system checks
address entries against the values stored on the Valid Address page to verify that the city and state or province
match.
Note. (JPN) Japanese postal data is stored in both the Postal Code Table and the Valid Address table
(EO_ADDR_VALIDAT). To keep the Valid Address table in sync with the Postal Code Table, you must
enter new postal data in the Postal Code Table page. The system will not update the Postal Code Table with
values you enter on the Valid Address page.
See Also
Chapter 17, "Setting Up Local Country Functionality," (ITA) Setting Up Italian City Codes, page 447
Chapter 17, "Setting Up Local Country Functionality," Maintaining the Postal Code Table, page 454
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 155
Setting Up and Installing PeopleSoft HRMS Chapter 6
(AUS) Australia
Australian Public Enter the Australian Public Service four digit country code here.
Service
(BEL) Belgium
NIS Country Number Enter the NIS Country Number for reporting hires and terminations to the Social
(National Institute for Insurance.
Statistics country number)
(FRA) France
INSEE Country INSEE is an official statistics and economics organization in France. This
Number (National organization issues a number that is used by the tax authorities, Social Security,
Institute for Statistical and the Chamber of Commerce, and others to identify an enterprise and its entities.
Economic Studies country
number)
156 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
(NLD) Netherlands
Nationality Enter the four-digit nationality code for the country. Nationality codes are
defined by the Netherlands coding standard (NEN) and are used in wage
declarations for the Netherlands. The system uses the Country code specified for
an employee on the Citizenship/Passport page to determine which nationality
code applies to the employee.
Target Group - Select this check box to identify this country as a target group for diversity
Diversity Mgmt (target reporting purposes in the Netherland. If you're administering a Dutch workforce,
group - diversity may want to track information on the national origin of an employee. Employee
management national origin is based on either their birthplace or their parent's birthplace.
Note. From December 31, 2003 the SAMEN law is no longer a legislative
requirement. However, we continue to provide the ability to track employees'
national origin to enable you to monitor workforce diversity.
(USA) USA
Country Code for 1042 (USA) Enter the country code used when reporting wage and tax data to federal
and state government agencies in the EFW2 format.
(E&G) Enter the country code for nonresident alien processing
State/Province page
PeopleSoft delivers the State/Province table with all states, provinces, and equivalent geographical entities
(such as Dutch communities and French departments) for all supported countries. The codes are based on
standard postal codes. PeopleSoft updates this table with each version.
You need these state or province codes for all countries where your organization does business. You use this
information in many address fields in the system.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 157
Setting Up and Installing PeopleSoft HRMS Chapter 6
Numeric Code Enter the numeric code, if applicable. The U.S. federal government assigns a
numeric code to each state for reporting purposes. You don't need to enter
numeric codes for new Canadian provinces.
This section provides an overview of enterprise integration points and discusses how to define regulatory
regions.
158 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Country Select a country from the list. When you create a regulatory region, you must
specify the country to which the region belongs. This enables country-specific
edits even when a state-level or provincial-level region is used in a system
transaction. If the country you want to add isn't in the list of values, add that
country to the system using the Country Table.
Security Access Select a security access level from the list. Because many companies have users
working with only one, limited set of regulatory regions, this feature enables you
to hide the other regulatory regions from the user. The values are stored on the
Translate table. The Regulatory Region prompt edit views use these values to
limit the user's Regulatory Region choices to the regions to which the user has
access. Values are as follows:
Available To All: Users can select this region.
With Global Security Only: Only users who have access to that region's
country functionality assigned to their primary permission list can select that
region.
Note. If you choose not to maintain the country-level data security, then select
Available to All or Not Available to Anyone to provide universal access to
regulatory regions. To simplify maintenance, availability is established only once
for each regulatory region and is used for all transactions.
Use this group box to specify the SetIDs that make up this regulatory region. Since Regulatory Region is used
to drive set processing in some applications, such as Health and Safety, Regulatory Region is a set control
value. The default record group SetIDs establish an initial set processing relationship for this new regulatory
region.
SetID When you add a regulatory region, the SetID field is available for entry, and the
Clone From Existing Regulatory Region field is unavailable for entry. The
system places a default setID in the SetID field that bears the same name as the
Regulatory Region Code that you just defined. If you haven't defined a SetID that
matches this code, select another applicable SetID for your regulatory region
from the list of valid values. The SetIDs in the list were set up using the
TableSetID table. You can select only from those SetIDs.
Note. Before you can specify SetIDs, you must define SetIDs, record groups, set
control values, and TableSet record group controls, using the components on the
PeopleTools, Utilities, System Administration menu.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 159
Setting Up and Installing PeopleSoft HRMS Chapter 6
Clone from Existing You can clone the SetIDs attached to this new regulatory region from an existing
Regulatory Region regulatory region. Use this option if the new regulatory region that you're
defining requires the same default record group SetIDs as those that you've
already created for another region.
Enter the regulatory region that you want to clone.
See Also
This section provides an overview of regulatory transactions and discusses how to add regulatory regions to a
transaction.
STANDARD All countries that are supported in Most applications apply regulatory
the system. and legislative edits at the country
level.
HANDS (Health and Safety) All countries that are included in Most applications apply regulatory
the system, plus the Canadian and legislative edits at the country
provinces. level, but Canada has specific
provincial laws governing their
Health and Safety reporting.
Use the two pages in the Regional Transactions component (REG_TRX_REGION) to assign new regulatory
regions to these transaction types (if you have added countries or regulatory regions to the system) and to
establish new regulatory transactions.
160 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Regulatory Region Select the regulatory regions that belong to this transaction.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 161
Setting Up and Installing PeopleSoft HRMS Chapter 6
Person Object Installation INSTALL_PERSON Set Up HRMS, Install, Select installation settings
Person Object Installation, for the Add a Person
Person Object Installation component
(PERSONAL_DATA).
162 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 6 Setting Up and Installing PeopleSoft HRMS
Installation Settings
Show Checklists Select to show the Checklists Code field on the Organizational Relationships
page (PERSON_DATA4), enabling users to select a checklist for the person they
are adding and create a record in the Person Checklist component
(PERSON_CHECKLIST).
Perform Automatic Select to perform an automatic search and match when you add a person to the
Search/Match PERSONAL_DATA component. The system will search the database to
determine that you are not entering a duplicate record.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 163
Setting Up and Installing PeopleSoft HRMS Chapter 6
Default Checklists
Select the default checklists that the system will display in the Checklist Code field on the Organizational
Relationship page when you add to add one of the following relationships for the new person:
Employee.
In the Employee Checklist field, select the default checklist for commercial employees.
In the French Public Sector Emp field, select the default checklist for French public sector employees.
Contingent Worker.
In the Contingent Worker Checklist field, select the default checklist for contingent workers.
Person of Interest
For each POI type listed in the Person of Interest Type Checklist grid for which you want a default
checklist, select the checklist.
The system will create a record in the Person Checklist component by identifying this checklist code on the
Organizational Relationship page when you first create the person.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Setting Up the
Administer Workforce Business Process," Creating Checklists.
164 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7
Set up Search/Match.
Understanding Search/Match
To use the full functionality of your system, you must maintain the integrity of your database. With users
from many departments entering data into your system, you want to minimize the entry of duplicate or
multiple records. Search/Match enables you to define criteria to check for duplicate or multiple ID records.
The searchable ID types (called Search Types) are:
Person (EmplID)
Note. PeopleSoft delivers these ID types as translate values inside the SM_TYPE field. They are delivered as
Active, but you can inactivate them depending on the applications that you license. Do not, however, add or
delete ID type values.
For each of these ID types, departments or business areas can, based on user security roles, define their own
search criteria to perform a search. The criteria can include defining search rules and placing them in the
desired order within a search parameter. Each department or business area can also set what data to display in
the results to identify a possible matching ID. Departments and business areas can set up multiple search
result codes and give security access to all users or restrict it to specific users who have a certain security role
assigned.
You can also set rules and parameters to permit only ad hoc searches to enable users with the appropriate
security to perform ad hoc searches without the constraints of predefined criteria.
Data returned in a search result can contain sensitive information. You can control whether to entirely or
partially mask a field or display the entire field. The masking configuration can be controlled with user
security access. With search results and display controls defined, users can perform Search/Match to
determine if a record already exists before adding one.
You can also enforce the use of Search/Match by setting Search/Match to trigger when a user enters data and
saves a new ID by transferring the user directly to the list of IDs that match the criteria. When you enforce
Search/Match at save time, the user does not need to navigate to the Search/Match component and reenter the
data to determine whether the ID exists.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 165
Setting Up and Working with Search/Match Chapter 7
You define search rules to identify which fields to search for and how to use them to perform the search. You
can use one or multiple search rules. If you use multiple search rules, Search/Match applies the rules in the
order that you define. Starting with the first rule, if the system finds at least one match according to that rule,
it will stop searching. However, if it finds no match for that rule, it will continue to the next rule, and so on.
Also, if you use multiple search rules, you should order the rules from the most restrictive to the least
restrictive. For example, rule 1 could return matching IDs when first name, last name, phone number and
national ID exactly match. Rule 4 could return matching IDs when only the first and last name match. In this
example, rule 4 could return more potential matching IDs than rule 1. The search rule used by Search/Match
could therefore be used as an indicator to users of how significant the returned results are.
A search parameter is a set of one or more search rules that you order sequentially with the lowest (or first)
search order level as the most restrictive, and the highest (or last) search order level as the least restrictive. A
search parameter must be created even if it contains only one search rule.
When a user runs the search, the system searches according to these rules and search orders until it either
encounters a potential duplicate or executes all search sequences and finds no potential duplicate.
Use search result codes to specify the data that you want Search/Match to return in the grids on the Search
Results page for the potential matching IDs that it finds. You can define field-level security for fields that you
consider sensitive. For example, you might allow some users to see the full birth date, but restrict other users
to see only the year (or nothing at all), depending on the Primary Permission List in their user profile.
Some search rules, search parameters, and search results are delivered with your system. You can use these as
they are, modify them, or add as many as you need.
Warning! Adding new search fields require significant programming effort and is not recommended.
See Also
Chapter 7, "Setting Up and Working with Search/Match," Automatic Search, page 166
Automatic Search
Automatic search reinforces the use of Search/Match when you create a new ID in a transaction page. To
trigger an automatic search from the transaction page, associate the component that contains that page with an
active search parameter. When the user enters all of the necessary data to create a new ID on that page and
saves the transaction record, Search/Match begins automatically. The system uses the predefined search
parameter and the data entered by the user as search criteria. If Search/Match does not find matching IDs, the
system saves the transaction successfully. If Search/Match finds at least one matching ID, the system displays
the search results inside a grid on the Search Results page.
If the component name is associated with a search parameter code and a search result code, Search/Match
displays the search results inside a grid on the Search Results page. This enables users to review the potential
duplicate IDs without having to manually navigate to the Search/Match page. After reviewing the results on
the Search Results page, the user clicks Return and is instructed to either click OK to continue saving the new
ID or to click Cancel to avoid saving the transaction and investigate further.
Note. This setup is valid only when creating person IDs from HRS_PREP_FOR_HIRE component.
166 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Warning! To display the Search Results page at save time, you must have a security role with access to the
component interface HCR_SM_SEARCH.
See Chapter 7, "Setting Up and Working with Search/Match," Viewing Search Results, page 186.
Note. This setup is valid only when creating person IDs from the Personal Data (PERSONAL_DATA)
component for commercial HRMS and the Employee Hire (EE_HIRE) component for Federal HRMS.
You enable Automatic Search/Match processing in HRMS by selecting the Perform Automatic Search/Match
check box on the Person Object Installation page (INSTALL_PERSON).
When you select the check box, the system checks to see if a Search Parameter and a Search Result code have
been associated with the PERSONAL_DATA component (or the EE_HIRE component for Federal). If it
finds codes, it displays these rule names. If not, the system generates a warning informing you that Automatic
Search/Match processing will not occur until you associate Search Parameter and a Search Result code with
the PERSONAL_DATA or EE_HIRE components.
See Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Person of Interest Types, page 229.
Setting Up Search/Match
To set up Search/Match use the Search Match Rules (HCR_SM_RULE), Search/Match Parameters
(HCR_SM_PARM), Search/Match Result Fields (HCR_SM_RSLT_FLDS), Search/Match Results
(HCR_SM_RESULT), and Search/Match (HCR_SM_SEARCH) components.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 167
Setting Up and Working with Search/Match Chapter 7
Search Parameters HCR_SM_PARM Set Up HRMS, System Combine and order search
Administration, Utilities, rules. The combination
Search/Match, (called the search
Search/Match Parameters, parameter) is what the users
Search Parameters select prior to performing a
search to determine the
search fields that they are
permitted to search on.
Search Permissions HCR_SM_PERM Set Up HRMS, System Identify who can use the
Administration, Utilities, search parameter to perform
Search/Match, the search. Also identify
Search/Match Parameters, which component names, if
Search Permissions any, should use the search
parameter as part of saving
a new ID in the database.
Search/Match Result Fields HCR_SM_RSLT_FLDS Set Up HRMS, System View or add fields that are
Administration, Utilities, available to define the
Search/Match, search results.
Search/Match Result Fields,
Search/Match Result Fields
Search Results HCR_SM_RESULT Set Up HRMS, System Specify which result fields
Administration, Utilities, to include in the search
Search/Match, results and control how to
Search/Match Results, display their values.
Search Results
Note. Be careful not to
confuse this page with the
page also called Search
Results with a similar object
name
(HCR_SM_RESULTS),
which is the page on which
Search/Match displays
returns from a search.
168 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Search Results Detail Page HCR_SM_RDTL_PG Click the Page Navigation Define the page to use to
button that appears on the view more information
Search Results page when about a specific ID returned
you select the Use Detail by Search/Match.
Page option.
Search Results Exceptions HCR_SM_RESULT_EXCP Click the Exceptions link on Define field-level security
the Search Results page. exceptions to the data
display control that is set on
the Search Results
Permissions page
Search Result Permissions HCR_SM_RSLT_PERM Set Up HRMS, System Identify who should have
Administration, Utilities, access to this search result
Search/Match, code. Also identify which
Search/Match Results, component, if any,
Search Result Permissions Search/Match should use
this result code when a new
ID is added and a potential
duplicate ID is found.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 169
Setting Up and Working with Search/Match Chapter 7
Ad Hoc Search Select to permit ad hoc searches from this search rule.
An ad hoc search enables users to bypass the institution's predefined search
standards to perform a configured search without predefined operands and
without limiting the characters to evaluate. For example, an ad hoc search might
be first name equals John; whereas, a non-ad hoc search might be set to search
only on the first three characters of the first name (in this case, Joh).
Search Fields
Warning! Adding new search fields require significant programming effort and is not recommended.
Sequence Enter the order in which you want the search fields to appear when used inside a
search parameter.
Search Field and Field Select each search field that you want to assign to this search rule code. When
Description you exit the field, the system displays the associated description. Search fields
are the fields on which users are permitted to search.
Search fields are delivered with your system. Adding or modifying a search field
value requires a significant programming effort. Do not attempt to delete a search
field.
Note. When you include name, national ID, phone, email, or address fields in the
rule without the types (Name Type, National ID Type, phone type, email type or
address type), the system searches on all national IDs, phones, emails or
addresses in the system for that individual.
Required Select this check box to require a value in the search field to find a potential
match on this search rule. Selecting this check box is useful for making the rule
more restrictive.
If the check box is not selected, the system accepts blank or nonexistent for this
field inside this search rule. For example, if all the fields inside a search rule are
marked as required, the user must provide data for each of those search fields to
find a match on this rule. However, if the Required check box is not selected, for
example, for Date of Birth, the user can still search on that search rule without
specifying a date of birth.
170 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Usage Identify how you want the search to evaluate the field value:
Begins With: The value must begin with this data. When you select this value, the
Start Position field appears with a default value of 1, and the Number of
Characters fields are available for you to define. You cannot modify the start
position default value.
Contains: The value must contain this data but can be preceded or followed by
other data. When you select this value, the Start Position field appears with a
default value of 1, and the Number of Characters fields are available for to you
define.
Equals: The value must be exactly equal to this data.
Not Used: Do not use this field value in this search.
Start Position and Enter the character position where you want the compare to start, and enter the
Number of Characters number of characters from that start position to include in the compare.
For example, if the usage selected for National ID is Contains, and you enter a
start position of 3 and the number or characters of 5, the system compares against
the 3rd, 4th, 5th, 6th, and 7th characters in the field value. It will return matching
IDs for which the National ID contains these 5 characters.
If the usage selected was Begins With, the start position is has a default value of 1
and you need to specify how many characters from the first character that
Search/Match should use to perform the search.
Length Indicates the number of characters in the search field. When you exit a particular
field in the Search Field column, the system displays the total number of
characters in the associated field.
See Chapter 7, "Setting Up and Working with Search/Match," Understanding Search/Match, page 165.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 171
Setting Up and Working with Search/Match Chapter 7
Ad Hoc Search Select to permit only ad hoc searches from this search parameter.
An ad hoc search enables users to bypass the institution's predefined search
standards to perform a configured search without predefined operands and
without limiting the characters to evaluate. For example, an ad hoc search might
be first name equals John; whereas, a non-ad hoc search might be set to search
only on the first three characters of the first name (in this case, John).
Search/Match Rules
Search Order Enter the order in which to apply the search rule codes of this search parameter.
Enter the most restrictive search rule in the lowest order number and the least
restrictive search rule in the highest order number.
You can reorder the search rules at any time. When you reorder the rules and
save the page, the system displays the rules in the most recent numerical order
that you entered.
Search/Match processes the lowest order search rule first; if it finds one or more
possible matches, it stops the search and returns the results. If it finds no results,
it continues to the next search rule, and so on.
In the search results, the system displays the search order number that
corresponds to the search rule where potential matching IDs are found.
You can use only one search rule for an ad hoc search; therefore Search Order
fields do not appear when theAd Hoc Search check box is selected.
172 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Search Rule Code and Enter the search rule code to use. When you exit the field, the system displays the
Rule Code Description search rule description. You must enter at least one search rule to create a valid
search parameter.
View Definition Click this link to access the Search/Match Rules page on which you can view or
edit the rule definition.
Full Access Select to enable all users to use the search parameter code.
This area appears only when the Full Access check box is not selected.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 173
Setting Up and Working with Search/Match Chapter 7
Role Name and Role Restrict the use of this search parameter code to users that have specific roles
Description inside their security profile.
Component Name and If you want to enforce the use of Search/Match when adding a new ID, select the
Component Description component name where adding a new ID occurs. The system will then initiate
Search/Match when a user enters the data to create a new ID and saves the
transaction. You can restrict the search to specific components whether you give
permissions to all roles or only to specific roles.
Note. A component name can be associated with only one search parameter.
However, the same search parameter can be used inside several component
names. Select all components where the search parameter should be used.
Note. This field is available only when the Search Type is Person or
Organization.
Many Search/Match result fields are delivered predefined and are available for you to use when defining
search result codes. The text System Data - not available for update appears for these fields on the
Search/Match Result Fields page. You cannot edit the data for the predefined search fields. You can,
however, select additional fields to make available for your search result codes.
174 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
When you select Add a New Valueand enter a name for the results field, the Search/Match Result Fields page
appears with enterable fields for you to select the record and field to make available within the search results.
To control how the values for a field appear in the results, use the Search/Match Results setup page.
Note. When search result fields are created based on records that are either effective-dated or type-related
(such as address type, email type, phone type, and so on), Search/Match returns a row for each of the dates
(historical, current and future dates) and types. For example, the field Gender is included in the
PERS_DATA_EFFDT record. If you use Gender as a search result field, then a person with multiple rows on
PERS_DATA_EFFDT will display multiple rows with the same gender in the search results grid. This is to
make sure the evaluation of potential duplicate IDs is done across all dates and types applicable to each ID. If
your organization prefers to see a limited number of rows, you can create the search result fields based on a
view that could include logic to limit the effective date to display only current information or logic to return
only a specific type (for example select address information where Address Type is Home).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 175
Setting Up and Working with Search/Match Chapter 7
Result Set
Use Detail Page Select this check box to display a Detail link beside each ID returned from a
search.
When you select Use Detail Page, the Page Navigation button appears.
Page Navigation This button appears only when the Use Detail Page check box is selected.
Click to access the Search Results Detail page, on which you can define the page
to which you want users to be directed to see more details about a specific ID.
Note. To be transferred to the page that you define here, the user must have
security access to the page.
176 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Sequence Enter the order by which the system displays results in the in the Search/Match
results grid. You can reorder the result fields at any time. When you reorder the
fields and save the page, the system displays the result fields in the most recent
numerical sequence that you entered.
Result Field andField Select the data to return with the search results. Fields used to perform the search
Description (search fields) can be different from the fields needed to review the results (result
fields).
The result fields are defined in the Search/Match Result Fields page.
Display Option Displays the default display control for that field. You can override this. Select
Display Entire Field or Mask Entire Field to display or hide the entire field value
respectively . The other options are:
Display First: Displays the first specified number of characters of the field value.
When you select this, the Number of Characters field appears. You must enter
the number of characters to display from the beginning of the field value.
Display Last: Displays the last specified number of characters of the field value.
When you select this, the Number of Characters field appears. You must enter
the number of characters to display from the end of the field value.
Display Partial Date: Displays the specified parts of a date field value. When
you select this, the Day, Month, Year check boxes appear. You must select which
parts of the date to display. For example if you select Year, only the year will
appear.
Number of Characters Enter the number of first or last characters of a field value to display.
Day, Month, Year Select the parts of the date to display for a date value.
Length Displays the number of characters possible for the field value.
Exceptions Click this link to access the Exceptions page, on which you can define field-level
exceptions to these results.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 177
Setting Up and Working with Search/Match Chapter 7
Menu Name, Menu Bar Select each item that corresponds to the page that you want to use to provide
Name, Item Name, and more details about a specific ID.
Page Name
Action Mode Select the action mode to define in which mode you want your users to access the
detail page. Options are:
Add
Correction
Data Entry
Upd/Dsplay (update/display)
Update
178 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
You can define exceptions to the search results that you set up on the Search Results page. For example, you
might have partially masked the birth date field in your search results, but you want the entire field to appear
for those who have a need to know. Using primary permission lists, you can set those exceptions here.
Primary Permission List Select the primary permission lists of the users who will be exceptions to the
and Permission List result field selected. When you exit the field, the system displays the permission
Description list description.
Display Option Select the display option to use as the exception to the display option selected on
the Search Rules page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 179
Setting Up and Working with Search/Match Chapter 7
Full Access Select this check box to enable all users to use the search result code
Role Nameand Role Enter roles to restrict the use of this search result code to users that have this role
Description inside their security profile. These fields appears when the Full Access check box
is not selected.
Component Name This field is available only when the Search Type is Person.
If you use automatic search and want to display a warning message to alert users
when potential duplicate IDs exist and you want to display the results of the
automatic search, select the same component name or names that you selected on
the Search Permissions page for the search parameter. You can restrict the search
to specific components whether you give permissions to all roles or to only
specific roles.
Note. A component name can be associated with only one search result code.
However, the same search result code can be used inside several component
names. Select all components where the search result code should be used. If
Search/Match finds potential matching IDs that correspond to the data entered,
the system returns a Search Results page showing the matching IDs that were
found.
See Also
Chapter 7, "Setting Up and Working with Search/Match," Viewing Search Results, page 186
180 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Maintaining the integrity of IDs and their associated data is important toward maximizing system features and
functionality. Search/Match helps you to prevent the entry of duplicate or multiple records by determining
whether a person (EMPLID), an organization (EXT_ORG_ID, if you license PeopleSoft Enterprise Campus
Solutions) or an applicant (HRS_PERSON_ID, if you license PeopleSoft Talent Acquisition Management)
already exists in your database before creating (or recreating) the record.
You use Search/Match to define rules and search parameters that determine if duplicate or multiple records
exist with the uniquely identifying data relevant to your business processes. You can configure which results
fields to display with the returned matching IDs. You can also choose to fully display, mask, or partially mask
result field values based on business processes and the level of security that your users need.
You can reinforce the evaluation of possible duplicates by setting up Search/Match to run automatically at
save time when a user creates a new ID.
See Also
Chapter 7, "Setting Up and Working with Search/Match," Automatic Search, page 166
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 181
Setting Up and Working with Search/Match Chapter 7
Workforce
Administration,
Personal Information,
Search for People,
Search Criteria
Default Search Result HCR_SM_USERDFLT Click the User Default link Assign a search result code
on the Search Criteria page. for the user ID to use as a
default value for a specific
search type.
Search Results HCR_SM_RESULTS Enter criteria on the Search View Search/Match results
Criteria page and click of a manual search and
Search or click one of the investigate potential
search by order number duplicate IDs.
Selective Search buttons to
launch a manual search. Note. Do not confuse this
page with the Search
Results setup page that has
a similar object name
(HCR_SM_RESULT) and
on which you define search
result fields.
182 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 183
Setting Up and Working with Search/Match Chapter 7
Search Type The system displays the search type (Person) selected to access the page. If you
have licensed PeopleSoft Talent Acquisition Management, you could have
selected Applicant, and if you have licensed PeopleSoft Campus Solutions, you
could have selected Organization.
Search Parameter Displays the parameter code selected to access the page. The search parameter
prompt on the search dialog page enables you to select only the search
parameters to which your security roles permit you access.
Depending on your responsibilities, you might need to access the Search/Match
page several times a day. If you use the same search parameter frequently, click
the Save Search Criteria link on the search dialog page to save it prior to
accessing the Search/Match page. Then, in the future, you can select it from the
Use Saved Searchprompt.
184 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Ad Hoc Search The system selects this to indicate that the Search Parameter code is set to
perform a ad hoc search.
An ad hoc search enables you to bypass the institution's predefined search
standards to perform a configured search without predefined operands and
without limiting the characters to evaluate. For example, an ad hoc search might
be first name equals John, whereas, a non-ad hoc search might be set to search
only on the first three characters of the first name (in this case, Joh).
For an ad hoc search, the Search Criteria page displays the Search fields set up
inside the search parameter code that you selected; and an Operand field appears
for each search field. The Operand field enables you to perform a search that
begins with, contains, or equals the search value that you enter.
Also, for ad hoc searches, the Search by Order Number area of the page does not
apply and therefore does not appear.
See Chapter 7, "Setting Up and Working with Search/Match," Defining Search
Parameters, page 171.
Search Result Code Select the search result code to use for displaying the results of this search. The
search result code contains all of the information regarding how to display the
IDs retrieved by Search/Match and what data to return to help you quickly
determine whether an ID already exists for the constituent that you are looking
for
User Default Click to access the Default Search Result page where you can select a search
result code to use as a default value for this search type.
The system permits one default search result code per search type for each user
ID.
Search Click this button to launch a search on all of the values that you entered and to
retrieve results for the most restrictive search order number defined in the Search
Parameter that you selected. When the search is complete, the system transfers
you to the Search/Match Results page.
Note. When you click Search, the system searches only for the data specified. It
filters the search orders that are defined for the Search Parameter that you
selected. For example, if Search/Match finds at least one potential matching ID at
search order number 10, it will stop the search and display the results obtained at
search order number 10. If no potential matching IDs are found, the search
continues to the next search order number, and so on. If you want to search using
a specific Search Order number, use the Selective Search button for that order
number.
Clear All Click this button to clear all entries in the Value fields.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 185
Setting Up and Working with Search/Match Chapter 7
Search Criteria
Search Fields The system displays each of the search fields associated with the search
parameter that you selected.
Operand These fields appear only when the search parameter permits ad hoc searches.
When the parameter permits ad hoc searches, the system selects the Ad Hoc
Search check box and hides the Search by Order Number area of the page.
Select the operand to perform the search. The valid values are Begins With,
Contains, and Equals. These values are delivered as translate values and should
not be changed.
Value For each search field that you specify, enter the value to search for. If predefined
values are available (such as for gender), you can select from them from the
prompt. If no predefined values exist, you can type the data directly into the
value field.
This area of the page appears only if the Ad Hoc Search box is not selected.
When you enter criteria in the Value fields, the Selective Search button for the search order defined with the
fields becomes available.
When the search is complete, the system transfers you to the Search/Match Results page.
186 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
When you enter criteria on the Search Criteria page and click Search or any of the search by order number
Selective Search buttons, the system launches the search and transfers you to the Search Results page with the
results displayed as shown in the sample page above.
For an automatic search, the Search Results page is displayed as shown in the sample page below. That is, if
Search/Match is set to launch automatically with both the search parameter permission and search result
permission configured with a component name that enables creation of IDs. When you try to add an ID on a
component that is set up that way and Search/Match detects potential duplicates at save time, the Search
Results page displays a warning message indicating that at least one potential ID in the database matched the
data entered to create the ID and what where the data used to perform the automatic search.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 187
Setting Up and Working with Search/Match Chapter 7
See Chapter 7, "Setting Up and Working with Search/Match," Understanding Search/Match, page 165.
On either version of the Search Results page, you can view the list of results returned by the search, view the
details of any record returned in the search, and click Carry ID to have the system carry the ID forward as you
subsequently access pages for further investigation.
Number of ID's Found Displays the number of IDs that met the search criteria.
This number may be smaller than the number of rows returned in the Search
Results grid because the grid might include the same ID multiple times. If the
name field is included in the search result code selected, the search returns rows
for each name type and effective date that match the search criteria entered. If the
national ID field is included in the search result code, the search returns rows for
each national ID entered for the record matching the search criteria.
188 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 7 Setting Up and Working with Search/Match
Search Order Number Indicates the search order number at which results were found and indicates how
precise the search wasthe lower the number, the more restrictive the search and
the greater the chance of having found duplicate IDs. This number can be used as
an indicator of how close the returned IDs match the criteria entered.
Search Results
Columns appear on the Results and Results 2 tabbed pages based on the search result code selected.
Depending on the user's role security, some values in the columns might be masked, partially masked, or fully
displayed.
Carry ID Click this button for the system to capture and carry the ID to the ID field of the
search box on the pages that you subsequently access so that you do not need to
remember the ID.
Detail The Detaillink appears if the selected search result code was configured to
provide the user with a link to a page for more information about an ID.
Person Organizational Click to access the Person Organizational Summary page, on which you can
Summary review the status of this person of interest record.
Relations With Click to access the Campus Solutions Relations With Institution Detail page, on
Institution which you can determine the type of relations that the individual has with your
institution and further clarify whether this is the individual for whom you are
searching.
Note. This link is used by customers who are also using PeopleSoft Campus
Solutions and only shows if you have selected the Student Administration check
box and/or the Contributor Relations check box on the Installation Table -
Products page (INSTALLATION_TBL1).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 189
Chapter 8
PeopleSoft uses several methods to ensure full multilingual capabilities. PeopleTools contains built-in ways
of translating field labels, page displays, and menu items. When you log in to the system, everything appears
in your language of preference, assuming that it has been translated.
If you modify PeopleSoft by adding new fields, pages, or menu items, you can use the built-in PeopleTools
capabilities to translate those items into your supported languages.
To maintain full language capability when you modify your application, you enter translations of any new
items. If you use only one language and enter new items in that language, that's fine. However, if you use
more than one language and you do not translate the new items, they appear in your original language, even
when you change to another language. Then you may see more than one language on your page.
DAN Danish
DEU German
DUT Dutch
ESP Spanish
FRA French
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 191
Setting Up and Working with Languages Chapter 8
ITA Italian
JPN Japanese
KOR Korean
POL Polish
SVE Swedish
Note. The translation of objects that we deliver is performed once, before we distribute the system, and
includes all the pages and menu items that are in the application. However, you must translate new field
labels and any datanames, comments, long descriptions, and short descriptionsfor each new record that
you create or in the data that you add.
See Also
Note. PeopleSoft has built-in language preference capabilities. Regardless of your system's base language,
you can view a PeopleSoft application in any supported language.
192 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 8 Setting Up and Working with Languages
Once setup is established, click the Language Name button to view the sign-on page in the specified
language. The language you select determines the language in which the entire application is displayed in the
PeopleSoft Internet Architecture.
Note. The Language Code used in My System Profile page (USER_SELF_SERVICE) is applied only when
you run reports and produce emails.
The language code you indicate is the language that the system uses for future pages that are displayed during
the current session. This is the language of the session until you either log off or change your language
preference. The tool set uses the language code to apply country-specific formats for numbers, dates, and
currencies. If you change the language code during a session, your user profile language preference is not
affected. The next time you log in, you'll see the language that is associated with your user ID.
Making a change means that everything you seepages, menus, and field contentsappears in your new
language preference.
Note. Your PeopleSoft language selection is independent of your Windows language options. To change your
Windows language parameters, select Start, Settings, Control Page.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 193
Setting Up and Working with Languages Chapter 8
The alternate character system architecture accommodates languages (such as Chinese and Japanese) that
require the entry of proper nouns by using two character sets to support phonetic sorting rather than binary
sorting on proper nouns. For example, users who enter data in Japanese require functionality that enables
them to enter proper nouns (such as names or descriptions) both in Kanji and by using a phonetic character
set. To accomplish phonetic sorting in PeopleSoft HRMS, configure your system so that the user can enter
Japanese proper nouns twice: once in Kanji and once (phonetically) using Katakana, Hiragana, or roman
alphabets also known as Romaji.
Important! (JPN) In choosing which phonetic character set to adopt, it is important for customers to
determine a consistent method for entering phonetic character set information. From a technical perspective,
the system simply applies a binary sort method to phonetic characters. Thus, different characters with the
same pronunciation aren't sorted together by their pronunciation in PeopleSoft HRMS. For example, a
Hiragana Ma character is sorted before a Hiragana Mi character and after a Hiragana Ho character. If a
Katakana Ma character is included in the sort, it is sorted after a Katakana Mi character and appears only after
all the Hiragana characters are sorted.
(CHN) As Chinese government adopts an official method of romanizing Chinese characters, also known as
Hanyu Pinyin, it is strongly advised to use Alphanumeric (roman alphabets) as the alternate character set.
See Also
The following table lists the alternate character fields and the global pages with which they are associated in
PeopleSoft HRMS.
BANK_BRANCH_E BRANCH_NAME_AC
C
BANK_EC BANK_NAME_AC
194 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 8 Setting Up and Working with Languages
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 195
Setting Up and Working with Languages Chapter 8
PYE_BANKACCT ACCOUNT_NAME_AC
SRC_BANK ACCOUNT_NAME_AC
The following PeopleSoft HRMS search records that have NAME_AC (alternate character name) as an
alternate search key or subrecords that are included in search records, enable for Japanese input and display:
NAMES
NAMES_SS_TMP
NE_INCIDNT_SRCH
NE_PERSONAL_DTA
OPR_ROWS_EE
OPR_ROWS_EE2
PERSON_NAME
PERS_SRCH_ALL
PHYSICIAN_SRCH
PHYSICIAN_SRCH2
SHS_EMPL_TAO
SHS_EXEMPT_TAO
SSF_PERSON_VW
SUCCESS_TR_SRCH
TRN_DMNDEE_SRCH
TRN_INSTR_SRCH
196 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 8 Setting Up and Working with Languages
UPG_NAMES_TAO
WCS_NAME_SCH_VW
WF_PERSON_NAME
WORKER_PROMPT
The following reports in PeopleSoft Enterprise Human Resources sort on the Name field or on the Alternate
Character Name field when the system base language and the report language are configured as shown:
SQR/Crystal Reports
These SQR/Crystal reports are sorted phonetically for Japanese, based on the report and the base language
configuration:
Report ID Description
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 197
Setting Up and Working with Languages Chapter 8
Report ID Description
Note. This list doesn't include country-specific regulatory reports that are sorted by Name.
1. Link the alternate character sets with language codes on the Installation Table - Alternate Character page
(ALT_CHAR_TBL).
Note. On this page, you define the alternate character set for the language that each user selects on the
sign-on page.
2. Enable the alternate character functionality for specific user IDs on the Org Defaults by Permission Lst
page (OPR_DEF_TBL_HR).
When you enable alternate character functionality for a user, the system displays the alternate character
button to the right of all the fields on the Global menus that have an associated Alternate Character field.
When you click the Alternate Character button, the system opens a page where you enter or display the
field value in the alternate character set.
198 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 8 Setting Up and Working with Languages
Note. (CHN),(HKG) and (JPN) On the Name page, when the Format for Country is CHN,HKG or JPN, the
Name and the Alternate Character Name fields appear on the page: You can enter information in both fields
directly on the Name page. On the Address page, click a button to access the alternate character secondary
page. Whether the Alternate Character button appears on the Address page depends on the user ID's
permission list and whether the particular page has Alternate Character functionality.
(CHN) When the Format for Country is CHN, the First Name and Last Name fields have values with
alphanumeric characters, and you leave Alternate Character Name blank, the system populates Alternate
Character Name using Last Name, space delimiter, and First Name. Please note that this functionality works
only if Alternate Character Name has no existing value.
If you click the Alternate Character Address button in the Address History secondary page
(ADDR_HISTORY_SEC), the system opens the Alternate Character Address page, such as the example that
follows, where you can enter any proper noun information, such as street and city, in the designated alternate
character set.
Note. If you sign in to the application using a language for which you specified an alternate character type,
the system displays that character type in the title bar of the Alternate Character Type page. In the example
above, Alphanumeric is the alternate character type defined for English.
Once you enter alternate character information into an alternate character field and click OK to close the
page, the system changes the appearance of the Alternate Character button on the page to indicate that
alternate character information is available for the primary proper noun field on the main page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 199
Setting Up and Working with Languages Chapter 8
For example, to look up Japanese employee Noriko Kawamoto's Personal Data record, place the cursor in the
Alternate Character Name field, enter the Japanese phonetic characters for Kawa, and click OK. The list box
on the search record page displays all the names (sorted phonetically) that begin with Kawa such as
Kawasaki,Kawashima or Kawamoto in both Kanji and Kana.
Note. The phonetic value is the same as the base name value.ain
200 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 9
Understanding Currency
If your organization operates in a global environment, your business tasks are probably global, too. You need
to track personnel salaries and reimbursement amounts in multiple currencies, perhaps even multiple currency
rate types, yet keep an eye on the bottom line by using one currency as a point of reference to track your
expenses and costs worldwide.
Understanding the mechanics of defining currency codes, types, exchange rates, and base currency, which
are universal to HRMS.
Understanding how some of the PeopleSoft HRMS applications use this information. For example,
PeopleSoft Enterprise Global Payroll has extensive, application-specific currency functionality. For
details of application-specific currency issues, see the application-specific documentation.
Note. Currency setup that is universal to PeopleSoft applications is discussed in another PeopleBook.
See Also
PeopleSoft Enterprise Human Resources PeopleBook: Enterprise Components, "Defining Currencies and
Market Rates"
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 201
Setting Up and Working with Currencies Chapter 9
PeopleSoft rounds all currency-sensitive amount fields to the currency precision of the controlled currency
during all online or background processes. For example, in a database containing amount fields with a length
of 15.3, Japanese yen are rounded to 123.000 and U.S. dollars are rounded to 123.230. The system doesn't
place a nonzero amount after the decimal for a Japanese amount or after the second digit to the right of the
decimal for a U.S. amount.
PeopleSoft displays the amount fields on the online pages with the proper precision. For example, it displays
Japanese yen as 123 and U.S. dollars as 123.23. When entering an amount, you can't enter more than the
defined precision; if you do, the system treats the entry as an online error.
PeopleCode programs and background processes round all currency-sensitive amount fields to the currency
precision of the controlled currency.
Activate the PeopleTools multicurrency option on the PeopleTools Options page (PSOPTIONS) by selecting
the Multi-Currency check box. PeopleTools will then use the precision you specify in the Currency Code
page (CURRENCY_CD_TABLE ) for the currencies relating to monetary fields for which you have specified
currency control fields. Some PeopleSoft applications are shipped with the Multi-Currency check box
selected. You can change that default.
Note. Once you deselect the Multi-Currency check box, selecting it again does not automatically round the
existing transaction amounts. If you deselect the Multi-Currency check box, PeopleSoft supports only the
default amount field size of 13.2. It does not support the larger amount field size of 15.3.
See Also
202 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 9 Setting Up and Working with Currencies
For reporting with Crystal Reports and PS/nVision (Excel), the amount appears as a 2-decimal number. You
have to modify the reports if you want to show 3 decimals on these reports.
Our third-party reporting tools don't fully support numeric fields that are greater than 15 digits. PS/nVision
(Excel) uses an 8-byte float for numeric fields. This causes truncation after the fifteenth digit. Crystal Reports
displays up to 16 digits correctly; for numbers that are greater than 16, Crystal Reports starts to insert
nonsensical numbers into the decimal positions; however, this is a problem only with very large numbers. For
any of these reporting tools, you should have accurate results up to the following amounts:
For example, if you enter 2s into a 15.3 numeric database amount field, the following third-party reporting
tools will display the value as:
Although this step is optional, we highly recommend it. This way, you can recover your database if you
experience any database integrity problems during the remaining steps.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 203
Setting Up and Working with Currencies Chapter 9
Run DDDAudit and SYSAudit from PeopleSoft Process Scheduler to ensure that the database is clean.
Select PeopleTools, Process Scheduler, System Process Requests and enter a Run Control ID. Click Run.
Specify the Server name of your environment, and select DDDAUDIT (and then SYSAUDIT) from the
list of processes. Click OK to run the processes.
Locate the DDDAudit and SYSAudit reports in your environment, and review them to ensure that the
database is clean.
Once the database is clean, run the script FSINTLFD.DMS to populate the international field size table
INTL_FLDSIZ_TBL. Use DataMover to run this script. The system populates the international field size
table with all the amount fields that have the controlled currency that is specified in Application Designer.
The system calculates the new length by adding 2 digits to the left of the decimal and 1 digit to the right
of the decimal. Before the system inserts new fields into the international field size table, it deletes all
existing fields from the table.
Select the International Field Size page. The Field Size - International column displays 15.3 for most of
its fields. When compared with the Current Field Size, the values in the Field Size - International column
should be 2 digits greater to the left of the decimal and 1 digit greater to the right of the decimal. In other
words, a Current Field Size value of 13.2 should correspond to a 15.3 value in the Field Size -
International column.
6. Run the PeopleTools process TLSINST1.SQR to change the field size on PSDBFIELD.
Note. This SQR is also an application engine. You can access it on the PeopleTools, Utilities,
International, Process Field Size page.
Using SQRW, run PeopleTools SQR TLSINST1.SQR to change the field size on the PeopleTools table
PSDBFIELD. This changes the PeopleTools definition values, but not the database field size.
It also creates a report (TLSINST1.LIS) that lists all the pages that use Average or Maximum size page
fields. As a standard of PeopleSoft Enterprise, all monetary amount fields use a Custom field size to avoid
the overlapping of fields when the amount fields are expanded. Review the list of pages and make any
adjustments that are necessary to preserve readability.
The SQR log is created in C:\TEMP, unless otherwise specified. View the log to ensure that the field size
value has been changed to 15.3. Verify the result by randomly checking the field size, opening the
various records containing amount fields shown in step 5. As you build the project, executing scripts to
SQL alter tables, creating views, and indexing, closely monitor the execution of the scripts and review the
error log.
204 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 9 Setting Up and Working with Currencies
f. Click Insert under Record Name. The system displays a list of all the tables being populated.
g. Click Select All, and click Insert again; click Close to close the page.
i. In the Build Options group box, select Create Indexes and Alter Tables.
j. Under Build Execute Options, be sure that the Build script file is selected.
k. Review the script file with your database administrator (DBA), and execute the file using your
recommended SQL query tool.
b. Select File, Save Project As. Save the Project Name as CURR_VW.
c. Select Insert, Objects into Project. Select Object Type: Record and Type: View/Query View.
i. Review the script file with your DBA, and execute it using your recommended SQL query tool.
Run DDDAudit and SYSAudit again to make sure that the database is clean.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 205
Setting Up and Working with Currencies Chapter 9
PeopleSoft has enhanced most SQR reports to accommodate 15.3 amount fields. However, some of them
are too crowded, and their amount field sizes remain 13.2. If the last digits of the decimals are important
to you, update the SQR to 12.3 to display 3 decimals on the report. Following is a list of reports that
require manual changes by application to accommodate the third digit of the decimal:
Receivables AR30001 (9.2), AR30002 (9.2), AR30003 (9.2), and AR30004 (12.2)
See Also
Many of the pages that display earnings or amounts in one currency enable you to view the amounts in
another currency. This is an integral feature of the PeopleSoft Economic and Monetary Union (EMU) support
and it enables you to view conversions across all currencies that are supported by the system.
206 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 9 Setting Up and Working with Currencies
Currency Rate Report - Run PRCSRUNCNTL Set Up HRMS, Foundation Use this page to run the
Control Tables, Currency and Currency Rate Table report
Market Rates, Currency (PER714) prints
Rate Report, Run Control information about exchange
rates.
Currency Code Table - Run PRCSRUNCNTL Set Up HRMS, Foundation Use this page to run the
Control Tables, Currency and Currency Code Table report
Market Rates, Currency (PER713) prints
Code Table, Run Control information about each
currency defined in your
Currency Code table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 207
Chapter 10
Frequency IDs.
Frequency IDs
Frequency IDs are used in PeopleSoft Enterprise Human Resources, Global Payroll, and Payroll for North
America. Frequency IDs are defined on the Frequency Table component (FREQUENCY_TBL). Each
frequency ID has a frequency type and an associated annualization factor that represents the number of times
that the period occurs in the course of a year.
In PeopleSoft HRMS, you use frequency IDs to define the periods of time in which compensation is quoted,
standard hours are completed, and people are paid, to list a few examples.
PeopleSoft delivers a set of standard frequencies that are PeopleSoft-maintained. You can define additional,
customer-maintained frequencies for nonstandard periods. For example, you could define a monthly-type
frequency with a nonstandard annualization factor of 13 to represent 13 monthly periods in a year
PeopleSoft-Maintained Frequencies
PeopleSoft delivers and maintains the following frequency IDs in the Frequency Table component:
A Annual Annual 1
B Biweekly Biweekly 26
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 209
Setting Up and Working with Frequencies Chapter 10
C Contract Contract 1
M Monthly Monthly 12
210 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
Q Quarterly Quarterly 4
S Semimonthly Semimonthly 24
W Weekly Weekly 52
When you set up PeopleSoft Human Resources, you can define default compensation frequencies at several
levels. You can usually change that default value when the system enters it into other pages.
This table lists important pages on which compensation frequencies are either specified or used:
Default Frequencies page (DFLT_FREQUENCY) Specify default frequencies for each country and specify
the order in which the system uses them to display base
pay compensation in the Pay Rates group box on the
Compensation page of the Job Data component.
Compensation page (JOB_DATA3) of the Job Data Displays base pay compensation information in the
component (JOB_DATA) frequencies that are specified for the country on the
Default Frequencies page
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 211
Setting Up and Working with Frequencies Chapter 10
HRMS Options page (INSTALLATION_TBL1B) of Set a default compensation frequency and a default
Installation Table component (INSTALLATION_TBL) work period for your organization. The system enters
these default values in the Job Code table.
Job Code Profile page (JOBCODE_TBL1_GBL) of Job Default compensation frequency and default work
Code component (JOB_CODE_TBL) period values are taken from the Installation table.
Comp Rate Code Table component Specify rate code frequencies on the Comp Rate Code
(COMP_RATECD_TBL) table. The system enters these default values when you
select the rate code in a pay components group box
(found on a number of pages in PeopleSoft HRMS).
You can also specify here whether the FTE (full-time
equivalency) calculation should be applied to the
compensation associated with the rate code.
Define Salary Plan component Specify default frequency for components of pay
(SALARY_PLAN_TABLE) assigned to salary steps.
Pay Group Table component (PAYGROUP_TABLE) Specify daily and monthly frequencies for the pay group
. The system uses the frequency information to calculate
pay rates.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Compensation, "Setting Up Administer
Compensation," Setting Up Rate Codes
Global Payroll uses frequency IDs when defining elements, generation control parameters, calendar periods,
rate code elements, and system elements. In addition to using frequency defined on the Frequency Table
page, Global Payroll also uses frequency defined on the Generation Control Frequency page
(GP_GCTL_FREQUENCY).
Payroll for North America uses frequency IDs to define pay period frequency and to calculate pay rates and
proration of pay.
212 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
See Also
Chapter 10, "Setting Up and Working with Frequencies," Understanding Frequency in Global Payroll, page
218
Chapter 10, "Setting Up and Working with Frequencies," Understanding Frequency in Payroll for North
America, page 222
Each frequency ID has an associated annualization factor that represents the number of times that the period
occurs in the course of a year.
See Chapter 10, "Setting Up and Working with Frequencies," Frequency IDs, page 209.
When converting hourly compensation rates, the frequency conversion calculations use the job standard hours
and the standard work period. Job standard hours define how many hours the worker should work in the job.
The standard work period defines the work period in which the standard hours should be completed. You
define the standard work period by selecting a frequency ID (and its annualization factor) as defined on the
Frequency Table component.
You define the standard hours and the standard work period on the following pages:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 213
Setting Up and Working with Frequencies Chapter 10
Org Defaults by Permission Lst Settings (OPR_DEF_TBL_HR2) Values for a primary permission list
(OPR_DEF_TBL_HR)
Define Salary Plan Salary Plan Table Values for a salary plan
(SALARY_PLAN_TABLE)
The minimum and maximum standard hours values and the standard work period defined on the Business
Unit HR Defaults page (BUS_UNIT_OPT_HR) are used for validation edits in the Job Data and Position
Data components.
The system inserts the standard hours and the standard work period as default information only if both are
defined. The following table describes the source of defaults in Job data under the specified conditions:
You assign the worker a salary plan. Salary Plan Table page
You assign the worker to a position. Description page of the Position Data component
You assign the worker a job code. Job Code Profile page of the Job Code component
You didn't indicate standard hours on the Salary Plan HRMS Options page of the Installation component
table, Job Code table, or Position Data table.
Full-Time Equivalency
Full-time equivalency (FTE) is the percentage of full time that a worker should normally work in a job. In
calculating the FTE, the system uses your definition of the standard hours and the standard work period.
If you select Apply FTE for a compensation component, PeopleSoft Human Resources uses the standard
hours and the standard work period to compute FTE to prorate holiday hours and pay for part-time and hourly
workers.
Note. (FRA) For workers in French regulatory regions, the system uses the PAID_FTE field to prorate
holiday hours and pay for part-time and hourly workers.
214 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
PeopleSoft Human Resources calculates FTE using the product of the standard hours of the job multiplied by
the annualization factor of the job's standard work period which is then divided by the product of the default
standard hours multiplied by the annualization factor of the default full time standard hours work period, as
shown in this equation:
FTE Equation
In this equation, the default full-time standard hours and default full-time standard work period are from:
The Salary Plan component (if a salary plan is defined for the worker, and if both standard hours and
standard work period are defined for this salary plan).
The Org Defaults by Permission Lst component (if no salary plan is defined for the worker, and if both
standard hours and standard work period are defined in the Org Defaults by Permission Lst component).
2. Divides the annual rate using de-annualization conversion calculations to calculate the rate at the desired
frequency.
3. Multiplies the converted compensation rate by the FTE factor if Apply FTE is selected for the pay
component.
Note. (FRA) For workers in French regulatory regions, the system uses the PAID_FTE field to multiply the
converted compensation rate.
The system uses the following formulas to convert compensation rates to an annual frequency:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 215
Setting Up and Working with Frequencies Chapter 10
The system uses the following formulas to convert compensation rates from an annual frequency to another
frequency:
Comprate (hourly) 10
The following table shows how the system calculates Teresa Johnson's monthly FTE (full-time equivalency)
compensation rate. The total represents Teresa's monthly salary based on a thirty-five hour workweek over a
fifty-two week year.
Rate Equation
Annual 10 35 52 = 18,200
216 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
The following table shows how the system calculates Bill McKenny's biweekly compensation rate:
Rate Equation
Because the PeopleSoft Global Payroll and Payroll for North America systems calculate daily and monthly
pay rates using frequencies established for the pay group, it is possible that the compensation rates displayed
on the Job Data - Compensation page will vary from the pay rates calculated with pay group daily and
monthly frequencies. This would occur if the pay group daily or monthly frequency differs from the daily or
monthly frequency specified for the country on the Default Frequency page. It is recommended that you
establish pay group frequencies to match the default frequencies for the country whenever possible.
The pay rates calculated with pay group frequencies are available on the JOB record in the fields
JOB.ANNUAL_RT, JOB.MONTHLY_RT, JOB.DAILY_RT, JOB.HOURLY_RT. These fields are
referenced by the Job Summary page and can be referenced in PS Query.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 217
Setting Up and Working with Frequencies Chapter 10
See Also
Chapter 10, "Setting Up and Working with Frequencies," Setting Country-Specific Frequency Defaults, page
227
Elements (such as earnings, deduction, and absence) can be standalone. Supporting elements (such as rate
codes or rounding rules) can be used with other elements to define a calculation rule. Each element is defined
only once, but it can be used repeatedly.
For any earnings, deduction, or absence element, you must specify the frequency of the stated amount on the
Earning/Deduction definition. For each item that you associate with a frequency, you must consider how the
frequency fits into the overall processing picture. Selecting the correct frequency for earnings, deductions,
and absence elements is essential for correct processing. For example:
Earnings element In what frequency is the stated amount paid? Is it per week, per month, or per
year?
Deduction element In what frequency is the stated amount withheld? Is the stated amount the amount
to withhold each pay period, each month, or for the entire year?
Absence element Is an employee entitled to three days of holiday time per month or per year?
In PeopleSoft Global Payroll, you use frequency to define earnings, deduction, or absence elements.
To illustrate, we refer to defining an earnings element. However, the process is the same for earnings,
deduction, and absence elements.
218 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
You define the calculation rule, frequency, and generation control for an earnings element on the Earnings -
Calculation page (GP_ERN_DED_CALC).
See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook, "Defining Earning and Deduction Elements,"
Defining Calculation Rules for an Earning Element.
Select a calculation rule and once you select a calculation rule, you must further define details for each
component of the rule. For example, if you select Amount, specify the amount of the earnings element.
The following table lists the calculation rules and the components of the calculation rule for which frequency
conversion is performed:
Define the frequency that the stated amount represents. If you select Use Calendar Frequency, the system uses
the frequency that's defined for the calendar period on the Define Calendars - Period page
(GP_CALENDAR_PERIOD). If you select Use Specified Frequency, you can define your frequency directly
on the Earnings - Calculation page by selecting from a list of frequencies.
See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook, "Using Calendars," Creating Periods.
The Frequency field enables you to tell the system the frequency with which you are stating a value. For
example, let's say that you select Use Specified Frequency, that you have a weekly payroll, and you create an
earnings element with an amount of 100 and a frequency of Monthly. If you don't have any generation
control conditions defined, the system annualizes and de-annualizes the amount into a processing frequency
amount. Let's assume that you define your organization's monthly frequency as 12 and the weekly frequency
as 52. The system takes the 100 (monthly amount) and annualizes it to 1200. Next, it takes this annualized
amount and de-annualizes it into the payroll processing frequency (weekly, in this example). The amount paid
each pay period is:
1200 / 52 = 23.08
The benefit of defining a frequency is that if your organization has multiple pay frequencies (such as weekly,
semimonthly, and monthly), you don't have to create separate earnings for each frequency. The system
automatically converts the amount into the corresponding pay period amount. Let's say that your organization
decides to give an annual bonus of 1000 to all payees and this bonus is distributed throughout the year. Your
hourly payees get paid weekly and your salaried payees get paid monthly. If you define an earnings bonus as
BON = 1000, with a frequency of Annual, you can apply this earnings definition to payees who are paid
weekly and payees who are paid monthly by using annualization and de-annualization. The frequency
assigned on the Earnings Calculation page calculates the bonus amount correctly, regardless of the pay
frequency.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 219
Setting Up and Working with Frequencies Chapter 10
Note. In PeopleSoft Global Payroll, there is no distinction between organizational relationships (employee,
contingent worker, or person of interest). Because payroll is processed for all types of people with jobs, the
PeopleSoft Global Payroll documentation refers to both of them as payees.
PeopleSoft Global Payroll provides an additional generation control concept called "Generation Control
Frequency" to help control the pay periods in which a specific earning or deduction is to be resolved (such as
only the first pay period of a month, and so on). Generation control frequencies enable you to define
meaningful names and associate the correct frequency ID with a pay period.
An example of a frequency that isn't on the HR Frequency Table is First of the Month. Let's say that you have
a weekly pay frequency, but you want an earnings element to be paid only on the first pay period of the
month. In PeopleSoft Human Resources, the frequency would be monthly. This might not work for your
payroll purposes. So, in PeopleSoft Global Payroll, the earnings element would be defined (tagged) as First
of the Month and paid only on the first pay period of the month.
The Generation Control Frequency component is part of generation control frequency processing.
Generation control enables you to tell the system, through various control methods, when to process an
element. For example, if an earnings element is to be paid only on the first pay period of the month (for
weekly payrolls), you can control the payroll so that this earning is only paid in Week 1, and not paid in the
subsequent week's payrolls during the month:
First you define generation control ID parameters on the Generation Control - Conditions page
(GP_GCTL_CONDITION).
See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook, "Defining Calculation Elements," Naming
Generation Control Elements.
Next, when you define an earnings element, you prompt against this table by selecting a generation
control name on the Earnings - Calculation page.
Then you don't have to redefine the parameters for each earnings element.
If you leave the Generation Control field blank on the Earnings - Calculation page, the system assumes to be
paid every time based on normal eligibility rules for the payee.
Note. If the frequency that you select is other than Use Calendar Period Frequency, the system de-annualizes
the earnings amount based on the pay period frequency. If a generation control frequency exists, the system
de-annualizes the earnings amount based on that frequency. The generation control frequency overrides the
pay period frequency during frequency conversion. For example, let's say that you have an earnings element
with an amount of 1200, an annual frequency, and a monthly pay period. If your organization's monthly
frequency is defined as 12, and you don't have a generation control frequency for this earnings, the amount
is de-annualized to 100 per month (1200 / 12 = 100). If you have a generation control frequency for this
earnings element, the amount is different. Let's say that you have defined a generation control frequency of
quarterly. The earnings are de-annualized to 300 (1200 / 4 = 300).
220 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
PeopleSoft Global Payroll delivers four predefined generation control frequencies: 1st Month, Annual,
January, and Quarter. All generation control frequencies can be used in corresponding generation control
elements.
When processing a payroll or absence run in PeopleSoft Global Payroll, you must tell the system the time
period to calculate. This is often referred to as the pay period. You define period selection criteria by defining
a period ID on the Define Calendars - Period page.
See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook, "Using Calendars," Creating Periods.
The period ID defines the start date, end date, and frequency of a particular pay period. This definition is kept
separate from the pay calendar to make it easy to reuse and to provide optimum flexibility during processing.
Here are some examples of the time and frequency data that can be defined by a period ID:
On the Define Calendars - Period page, the frequency is defined for de-annualization when an earnings,
deduction, or absence element is defined without generation control frequency. However, if generation
control frequency is included (in the earnings, deduction, or absence element definition), and the element
generation control and the calendar ID generation control match, the system uses this generation control
frequency for the de-annualization factor.
Examples of Frequencies
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 221
Setting Up and Working with Frequencies Chapter 10
Pay Period Semimonthly (24) Semimonthly (24) Semimonthly (24) Semimonthly (24) *
Frequency
You don't need to specify the associated frequency if it coincides with the pay period frequency.
See Chapter 10, "Setting Up and Working with Frequencies," Job Data Pay Rate Frequencies, page 217.
A system element that is frequency-controlled resolves in the calendar frequency portion of payroll
processing, according to the frequency that is specified for the element when it is set up. The system then de-
annualizes by the calendar frequency.
222 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
See Also
Chapter 10, "Setting Up and Working with Frequencies," Job Data Pay Rate Frequencies, page 217
This example illustrates how Payroll for North America calculates the pay period rate by annualizing monthly
compensation using the following frequencies:
Using a compensation rate of 1,000 USD, the calculations of the annual compensation rate and pay period
compensation rate are:
12,000.00 = 1,000.00 12
Payroll for North America uses the annualization factor of the standard work period frequency in combination
with the standard hours to calculate pay rates or proration of hourly compensation.
This example illustrates how Payroll for North America calculates the weekly pay period rate of hourly
compensation.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 223
Setting Up and Working with Frequencies Chapter 10
The calculations of the annual compensation rate and pay period compensation rate are:
Annual Rate = Comprate (Standard Hours Standard Work Period Annualization Factor)
20,800.00 = 10 x 40 52
400 = 20,800.00 / 52
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Pay Groups,"
Understanding Proration Rules.
See Also
Chapter 19, "Setting Up Pay Calendars," Creating Pay Calendars and FLSA Calendars, page 487
224 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
Frequency Table FREQUENCY_TBL Set Up HRMS, Foundation Define a frequency ID, its
Tables, Compensation frequency type, and its
Rules, Frequency Table, annualization factor.
Frequency Table
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 225
Setting Up and Working with Frequencies Chapter 10
Biweekly
Contract
Daily
Hourly The Use Standard Hours for Annualization check box becomes
available.
Monthly
Quarterly
Semimonthly
Weekly
Use Standard Hours for Select to have the system use job standard hours for annualization instead of the
Annualization frequency annualization factor. The frequency annualization factor is set to 0,
and that field becomes unavailable.
Note. You can use only hourly frequencies that use standard hours for
annualization for compensation and pay frequency in PeopleSoft Human
Resources, PeopleSoft Payroll for North America, and PeopleSoft Global
Payroll.
You can define a frequency called W53 with a W (weekly) frequency type
and an annualization factor of 53.
226 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 10 Setting Up and Working with Frequencies
Select four frequencies to set as defaults for the specified country. The system uses these default frequencies
to calculate pay rates in the Pay Rates group box on the Job Data - Compensation page. The order you list the
frequencies on this page is the order in which the pay rates appear in the Pay Rates group box.
For example, you specify the 1st Frequency as annual, 2nd Frequency as monthly, 3rd Frequency as daily,
and 4th Frequency as hourly for Canada. For an employee in Canada, the Pay Rates group box displays the
following pay rates in this order: annual, monthly, daily, and hourly. The system converts compensation rates
to the default frequencies using the standard formulas described earlier in this chapter.
See Also
Chapter 10, "Setting Up and Working with Frequencies," Job Data Pay Rate Frequencies, page 217
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 227
Chapter 11
Define establishments.
Establish locations.
Maintain departments.
This section provides an overview of POI types and discusses how to set up new POI types and activate
delivered POI types.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 229
Setting Up Organization Foundation Tables Chapter 11
See Also
The generic components are on the Workforce Administration menu but these components are also available
on different application menus throughout the system. When you set up or modify a POI type, you can limit
the components on which the POI type can be selected by menu. For example, you could create a new
recruiting POI type that is only available on the components on the Recruiting menu or you could make the
Pension Payee POI type, which is delivered as an option only on the Pension Administration menu, available
on the Administer Workforce menu components, too.
Person of Interest Types POI_TYPE_TBL Set Up HRMS, Foundation Review the delivered POI
Tables, Organization, types and modify the
Person of Interest Types, characteristics that govern
Person of Interest Types how the system processes
the information of POIs
with this type.
230 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Effective Status Inactivate any system delivered POI types that you will not be using so that they
do not appear as options on HRMS transaction components.
Job Record Required? Select if this POI type requires a POI job record.
When you select this check box for a new POI type, the system enters default
information into the POI Transaction group box that you cannot overwrite.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 231
Setting Up Organization Foundation Tables Chapter 11
POI Transaction
Record for POI Select the record used for processing and holding information about people with
Transaction this POI type.
If you select the PER_POI_TRANS record (the generic POI transaction record
used by the Person Organization Summary component), the system enters default
information into the rest of the fields in the POI Transaction group box and the
Record for POI Summary View field that you cannot overwrite.
If you choose to use a record other than PER_POI_TRANS for POI types that do
not require jobs, you will need to create a view to use in the Record for POI
Summary View field in order for the data in the transaction record to show up in
the Person Organizational Summary component.
Component Name Select the component using the POI transaction record. When you select this POI
type on the Personal Data Organizational Relationships page and click the Add
the Relationship button, the system will move you to the component you select
here.
Market, Menu Name, Select the menu's market, name, bar name, and item name for the selected
Menu Bar Name, and component.
Menu Item Name
Transfer Panel Name Enter the object name of the page you want the system to open to when you click
the Add the Relationship button.
Record for POI Select the record from which the system draws the summary information for this
Summary View POI type. When you view the organizational relationships of a person with this
POI type on the Person Organizational Summary component, the system pulls the
summary information from this record.
If you choose to use a record other than PER_POI_TRANS, you must create a
view to use here in order for the data in the transaction record to show up in the
Person Organizational Summary component. Create the view in PeopleSoft
Application Designer using the PER_POI_TRANS view but with different view
text.
Person of Interest Select a default checklist for this POI type. When you opt to assign a POI type to
Checklist a person and create a POI checklist from the Personal Data - Organizational
Relationships page (PERSONAL_DATA4), the system creates a record for the
person on the Person Checklist page (PERSON_CHECKLIST) and adds this
checklist.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer
Workforce, "Setting Up the Administer Workforce Business Process," Creating
Checklists.
232 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Allow in Generic Add Select to make this POI type available when adding a record for a POI in the Add
Component a Person component, Job Data component, and Person Organizational Summary
component on the Administer Workforce menu. The system selects this check
box for all new types.
Allow in Generic Upd Select to make this POI type available when updating a record for a POI in the
Component (allow in Job Data component and Person Organizational Summary component on the
generic update Administer Workforce menu.
component)
You can modify the following fields for system delivered POI types:
Effective Status.
This section provides an overview of holiday schedule defaults on the Job Record and discusses how to
define holiday schedules.
Defaulting of the holiday schedule to the worker's job record depends upon the payroll system:
If the payroll system is Global Payroll, the system does not enter a default holiday schedule on the Job
Data - Payroll page. On the Payroll page, you may select a holiday schedule for the payee or leave the
field blank. If you leave it blank, Global Payroll processes use the holiday schedule assigned to the
payee's pay group.
If the payroll system is Payroll for North America, the default holiday schedule entered on the Job Data -
Payroll page is determined by whether you're adding a worker or updating job data, and by whether you
have defined a default holiday schedule for the location.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 233
Setting Up Organization Foundation Tables Chapter 11
When You Add a Worker with Payroll for North America Payroll System
If the payroll system is Payroll for North America, the default holiday schedule initially entered on the Job
Data Payroll page is the holiday schedule that is associated with either the Location table or the Pay Group
table:
Location table.
If you have assigned a default holiday schedule on the Location Profile page, that schedule is the default
when you add a worker with that location.
If you leave the Holiday Schedule field blank on the Location table, the system enters the default holiday
schedule that is assigned to the pay group.
You can change the holiday schedule on the worker's Job Data Payroll page.
When You Change the Job Data of a Worker with Payroll for North America Payroll System
Changes in the following job data fields might cause a change in holiday schedule if the Holiday Schedule
field is blank on the worker's Job Data Payroll page:
Company
Position Number
Pay Group
Note. If the holiday schedule is already populated on the worker's job record, changes in these fields do not
cause updating of the holiday schedule.
If the worker's holiday schedule is not populated, changes in Company and DeptID cause the system to
first enter the default holiday schedule from the Location table. If there is no default holiday schedule
assigned on the Location table, the system enters the holiday schedule assigned on the Pay Group table.
Changes in the Position Number and Pay Group fields cause the system to enter the default holiday
schedule directly from the Pay Group table if the worker's holiday schedule is not already populated.
234 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Holiday Enter all of the holiday dates that your organization observes within this
schedule.
Nbr of Hours (number of (Optional) You can specify the number of paid hours for each holiday.
hours)
Payroll for North America uses this field to reduce from pay.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 235
Setting Up Organization Foundation Tables Chapter 11
Start Time and End (Optional) You can specify the starting and ending time of each holiday.
Time
Note. Payroll for North America and Global Payroll do not refer to these fields.
Business Unit Reference BUS_UNIT_TBL_HR2 Set Up HRMS, Foundation Identify business units in
Tables, Organization, other PeopleSoft
Business Unit, Business applications that are related
Unit Reference to a business unit.
Business Unit Options BUS_UNIT_OPT_HR Set Up HRMS, Foundation Set system defaults such as
Defaults Tables, Organization, Company, Country, and
Business Unit Options Currency for a specific
Defaults, Business Unit SetID.
Options Defaults
236 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Warning! To optimize system performance, your business units must be 5 characters. If your SetIDs or
business units have fewer than five characters, you will experience serious performance degradation.
Status Select Active or Inactive . If you select Inactive, the business unit won't appear
in any business unit lists in PeopleSoft HRMS.
Note. Business units aren't effective-dated, so use this field to implement or retire
business units.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 237
Setting Up Organization Foundation Tables Chapter 11
Default Record Group When you define a new business unit on the Business Unit component, you
Set IDs specify that the system establish default record group setIDs for the new business
unit, using the options in this group box. The SetID or Clone from Existing
Business Unit value that you enter determines your preliminary tableset sharing
setup for the new business unit by determining the setIDs that are assigned to
each record group for the new business unit. The setID assigned to a record
group determines which tableset is used when retrieving valid values from the
various control tables for that business unit.
TableSet sharing
If you want to define a tableset sharing setup for the new business unit you are creating, using a primary
default setID that you can modify as necessary on the TableSet Control - Record Group page
(SET_CNTRL_TABLE1), enter the default setID that you want to use.
When you add a new business unit to the system, the system populates the SetID field with a setID name that
is the same as your new business unit. For example, if your business unit is called USA, then the SetID value
defaults to USA. You can override the default setID as necessary.
When you save the business unit without changing the default setID, the system creates a new setID with the
same name as the business unit, in this case USA, and this default setID of USA that you specified on the
Business Unit page is assigned to each record group for the new business unit, as shown in this diagram:
238 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Note. You can associate only one default setID with a business unit.
With the Clone from Existing Business Unit option, you can clone the TableSet sharing setup of an existing
business unit.
Note. When you first enter the Business Unit page, the Clone from Existing Business Unit option is clear. To
activate the option, clear any set ID values from the Set ID field and move out of the field.
If you want the tableset sharing for the new business unit that you are creating to mirror that of another
business unit you've defined, or if you want the two units to be similar except for a few record groups, enter
the business unit that you want to mirror as the cloned business unit. When the record groups are linked to the
new business unit, the system assigns each record group the same setID that is used for the record group by
the business unit that you selected as the Clone Unit.
For example, you specify an existing business unit to clone that has the setID SHARE associated with record
groups 01, 02, and 05, setID USA associated with record groups 03 and 04, and setID MFG associated with
record group 06. The new business unit you create will share these identical setID values for the same record
groups, as shown in this diagram:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 239
Setting Up Organization Foundation Tables Chapter 11
Whichever method you select, after you save the new business unit for the first time, the system makes the
default SetID or Clone from Existing Business Unit fields unavailable for entry. You can't change the default
record group setID information from this page for this business unit again. This rule prevents you from
accidentally overwriting the TableSet record group controls for your defined business units in PeopleSoft
HRMS.
Note. When you add a new business unit and save the page, the system creates all the appropriate table values
provided by PeopleTools that connect the business unit ID, the record group ID, and the setID.
240 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
TableSet sharing is set up as soon as you create your business units. However, the sharing, especially if you
have chosen to create a TableSet sharing setup using one default setID, may need some fine-tuning. You can
do this by changing the setIDs that are assigned to individual record groups on the TableSet Control
Record Group page. The system uses the default SetID value on this page when you add record groups.
See Also
Enterprise PeopleTools PeopleBook: Data Management, "PeopleTools Utilities", TableSet Control - Record
Group
Business Unit Cross In this group box, enter the business unit cross reference, if applicable, for any
Reference PeopleSoft application that is listed on the page. You identify other business
units in other PeopleSoft applications that relate to your business unit.
Note. You can review which PeopleSoft Enterprise General Ledger units are associated with the PeopleSoft
HRMS business units on the GL/HR Business Unit Mapping page (BU_GL_HR_LNK).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 241
Setting Up Organization Foundation Tables Chapter 11
By setting up default values for a setID, you can specify the default values that populate these fields in your
human resources system. Because the setID keys the Business Unit Options Defaults component (you can
share these defaults among multiple business units.
Warning! The values that you enter or select on this page affect the default values throughout your
PeopleSoft HRMS system.
Company, Country, and Select the Company,Country, and To Currency that the system will use as a
To Currency default value.
Standard Hours
Default Standard Hours The system takes default standard hours from the Define Salary Plan component
(SALARY_PLAN_TABLE), the Job Code Table component
(JOB_CODE_TBL), or the Installation Table component
(INSTALLATION_TBL).
242 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Work Period The standard work period is the time period in which employees must complete
the standard hours. The system uses the annualization factor of the standard work
period in combination with the default standard hours to calculate FTE (full-time
equivalency). The system takes default standard work period from the salary
plan, the job code, or the Installation Table. The value that you enter here is used
for validation in the Job Data pages (JOB_DATA) and the Position Data
component (POSITION_DATA).
Minimum Standard Enter the default minimum and maximum standard hours for this SetID. The
Hours and Maximum value that you enter here is used for validation on the Job Data pages and the
Standard Hours Position Data component.
(BEL) Belgium
Industrial Committee Select the appropriate industrial committee for the company. This can be
overwritten at the department level if necessary.
NACE Code Enter the NACE code for the company. Note: You can choose the level of detail
for the NACE Code. It can range from 5 digits for group level, 6 for class level
and 7 for subclass level.
(CAN) Canada
Note. These values affect Canadian regulatory reporting in PeopleSoft Enterprise Human Resources.
Define companies.
(Payroll for North America) Enter liability and expense account codes.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 243
Setting Up Organization Foundation Tables Chapter 11
Understanding Companies
Use the Company component to enter information about a single company or multiple companies in your
organization, from the corporate address to general ledger accounts, tax information, and payroll processing
information.
If you're using only PeopleSoft Human Resources, you enter information only on the Company Location page
(COMPANY_TABLE1) for each company that you want to add. You can also associate a default pay group
with the company on the Default Settings page (COMPANY_TABLE2_GBL). The value you select appears
as the default on the Job Data pages for people in this company. However, it is easier to treat each company
that you add as a separate tax entity, as though you were using PeopleSoft Payroll for North America.
If you're using PeopleSoft Global Payroll, you must enter additional, payroll-specific company information
on the Pay Entity component (GP_PYENT), if your pay entity is the same as the company. You do this in
PeopleSoft Global Payroll.
PeopleSoft Enterprise Pension Administration tracks pension payees through retiree jobs that are separate
from and concurrent with employees' active job data records. These retiree jobs must be associated with
specific retiree companies. Therefore, be sure to set up companies to house your payees. Because pension
plans are distinct tax reporting entities with their own U.S. Employer Identification Numbers (EINs), you
typically set up one retiree company for each pension plan that you sponsor. Once you set up your retiree
companies, you can match companies to pension plans in the Plan Administration component (PLANADM).
For U.S. companies, if you're using PeopleSoft Payroll for North America or PeopleSoft Pension
Administration, a company is typically defined as a business unit that has a unique federal Employer
Identification Number (EIN) for payroll tax reporting purposes. Because pension plans have EINs, you create
companies for each pension plan. You reference a pension plan company from the payee job data record of
anyone collecting benefits from that plan.
If your company uses PeopleSoft Payroll for North America, each company that you add must be equivalent
to each EIN that you use. To add a company EIN, your payroll staff needs to complete all three pages at least
once.
244 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
See Also
Company Legal Type LEGAL_TYPE_TBL Set Up HRMS, Foundation Many countries require that
Tables, Organization, you report on your
Company Legal Type, organization's legal
Company Legal Type structure, whether it's a
corporation, a public limited
company, a cooperative, or
another type of
organization.
You can associate the
correct legal type with each
company on the Company
Table and use the
information when you
generate reports.
Set Up HRMS,
Foundation Tables,
Organization, Agency
USF, Agency Location
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 245
Setting Up Organization Foundation Tables Chapter 11
(Payroll for North America) COMP_TBL7USA_SEC Select the General Ledger Use the General Ledger
General Ledger Liability Accounts link on the Liability Accts page to enter
Accts Default Settings page. General Ledger account
codes for net pay and direct
deposits.
Tips Processing COMP_TBL6USA_SEC Click the Tips Processing Set up tip allocation.
link on the Default Settings
page.
Tax Details COMP_TBL8USA_SEC Select the Tax Details link Use the Tax Details page to
on the Default Settings specify your federal
page. employer identification
number, link companies
together, and define default
tax status.
(BEL) Claeys Defaults COMP_TBL2ABEL_SBP Click the Claeys Defaults Enter the default
link in the Belgium section information and salary
on the Default Settings factors that are used to
page. perform Claeys formula
calculations.
External Providers BEL COMP_TBL2BBEL_SBP Click the External Providers Associate a provider with a
link in the Belgium section setID.
on the Default Settings
page.
Phones COMPANY_TABLE3_GBL
Set Up HRMS, Enter telephone information
Foundation Tables, for a company.
Organization,
Company, Phones
Set Up HRMS,
Foundation Tables,
Agency USF,
Company, Phones
Set Up HRMS,
Foundation Tables,
Organization, Agency
USF, Rules Definition
246 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Company Table Report - PRCSRUNCNTL Set Up HRMS, Foundation Run the Company Table
Run Control Tables, Organization, report (PER707). This
Company Table Report, report prints all companies
Run Control in the Company Table and
default information,
including name and address,
company code, and
effective date.
The report PAY702 prints
the General Ledger
information you enter in the
Company Table.
Defining Companies
Access the Company Location page (Set Up HRMS, Foundation Tables, Organization, Company, Company
Location or Set Up HRMS, Foundation Tables, Organization, Agency USF, Agency Location).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 247
Setting Up Organization Foundation Tables Chapter 11
For a single-company environment, you set up this table only once; for multiple-company environments, you
set up a company code for each company.
(BEL) Belgium
(JPN) Japan
Title Enter the title of your company's representative as of the effective date. This is
the person whose title (and name) appears by default on the Appointment
Notification report page.
If you accept the defaultwhich you can override on the report pagethe title
and name appear on the Notification of (Hiring, Department Change, Grade
Advance or Termination) pages.
Name Enter the representative's name. You can override this default on the
Appointment Notification report page.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "(JPN) Tracking Additional
Appointments (Kenmu)," Recording and Viewing Employee Additional Appointments Data
248 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 249
Setting Up Organization Foundation Tables Chapter 11
250 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 251
Setting Up Organization Foundation Tables Chapter 11
252 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 253
Setting Up Organization Foundation Tables Chapter 11
Default Settings
These fields are for companies using PeopleSoft Payroll for North America.
Pay Group If you enter a value in this field, the pay group appears as the default for all
employees in this company. You save data-entry time at the employee level if
most employees have the same pay group.
Note. The size of this field varies depending on whether you use PeopleSoft
Global Payroll or PeopleSoft Payroll for North America. First, set up your
PeopleSoft Global Payroll or PeopleSoft Payroll for North America pay groups
to make them available here. Where you do that depends on which payroll
application you use.
254 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Lines on Paysheet Enter the number of lines for the paysheet. Paysheets serve as a repository for the
data that is required to calculate the employee pay for each pay period.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Defining
Earnings Codes and Earnings Programs."
(BEL) Belgium
Company Trade Name Enter the name of your Belgian company; for example, Continental Commerce -
Belgium.
Registration for Trade Enter the company's official registration number from the Belgian Trade
Register.
Legal Entity A legal entity is the legal form that applies to a company: Inc (corporation),
Coop (cooperative), and so forth. The translate values reference different forms
that you can select to indicate whether the company is public or privately held or
whether it is of limited liability.
Salary Limit Select to set a maximum salary limit. While selecting this check box doesn't
enforce any salary limits in the system, you can use it as a reference to prevent
salary raises that exceed company limits or that would occur during periods
where increases aren't allowed.
If your organization enforces periods where no salary increases are allowed or
limits salary increases, you can modify the PeopleCode behind this page. Then,
when you select this check box, the system it to ensure that no raises are allowed
during these periods.
Official Language Select the company official language. This value is used as the default person's
official language, with the exception of companies located in the Brussels-
Capital Region, for which the person's preferred language is used as the default.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 255
Setting Up Organization Foundation Tables Chapter 11
Claeys Defaults Click to enter Claeys default and salary factor information on the Claeys page.
See Chapter 11, "Setting Up Organization Foundation Tables," (BEL) Entering
Default Information and Salary Factors, page 267.
External Providers Click to enter Belgian provider information for tracking third-party providers on
the Providers page.
See Chapter 11, "Setting Up Organization Foundation Tables," (BEL)
Associating a Provider with a SetID, page 268.
Natl Office for Social Enter the number under which the company is registered at the National Office
Sec (national office for for Social Security.
social security)
Overseas Soc Ins Inst Enter the company's overseas social insurance institution, federal pension
(overseas social insurance institute for use in meeting your Belgian organization's reporting requirements to
institution, federal the Belgian government. While the system doesn't require this information, it is
pension institute) important for regulatory reporting.
RIZIV Nbr (RIZIV Enter the RIZIV code. It records the company's Federal Institute for Illness and
number) Disability Insurance category.
Geo Loc NOSS Enter the geographical location for the NOSS.
(geographic location for
State Social Insurance
category)
Statistics Institute Enter the statistics institute for use in meeting your Belgian organization's
reporting requirements to the Belgian government. While the system doesn't
require this information, it is important for regulatory reporting.
Industrial Committee Select the appropriate industrial committee for the company. You can override
this value at the department level.
Note. The NACE code can range from 5 digits for group level, 6 for class level,
and 7 for subclass level.
(CAN) Canada
Firm Number and Rate Enter if you are tracking Workers' Compensation Board data for Canadian
Number workers.
256 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
(CHE) Switzerland
AHV Number (Alters- Enter the number of the responsible AHV compensation office. This numeric
und Hinterbliebenen code can be up to 6 characters.
Versicherung number)
Accident Insurance Enter the number assigned to the company by its accident insurance company.
Number Use this number in health and safety reporting.
Trade Registry Number Enter the number assigned to the company by the Trade Registry office. The
format is 999.9.999.999-9.
(DEU) Germany
OECD Permission Select if applicable. Germany requires OECD permission for workers from non-
Required (Organization OECD countries to work in certain types of industry, such as defense or high
for Economic Cooperation technology.
and Development
permission required)
Medical Checkup Select if a medical checkup is required for your workers under German labor law.
Required
(ESP) Spain
Fiscal Identification Enter your company's fiscal identification code as assigned by the Spanish
Code government.
(FRA) France
SIREN Code (Systeme Enter a SIREN code for this organization. This code is assigned to a company
Informatique pour le when it registers as a business with the French government. The code isn't
Repertoire des required for your human resources system, but is required on many company
Entreprises code) documents.
APE Code(Activite Select an APE code. This code serves as a classification of the type of industry
Principale Exercee code) that the company is involved in (banking, software, insurance, and so forth). The
code is required by French law and must appear on all company regulatory
reports.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 257
Setting Up Organization Foundation Tables Chapter 11
Base Scheme Select the base scheme for the company. Base schemes are defined on the
Mandatory Base Scheme page (Set Up HRMS, Product Related, Workforce
Administration, Workforce Data FRA, Base Scheme) and are required for DADS
reporting.
See PeopleSoft Enterprise Global Payroll for France 9.1 PeopleBook, "Setting
Up DADS Reporting."
Option This field was previously used in DADS reporting for the previous DADS norm
(DADS-TDS). However, the field is no longer used with the current DADS
reporting that uses the DADS-U norm.
Company Fund This scroll area displays the pension/contingency contracts defined for the
Membership company on the Pensions/Contingency Contracts page. Click the Membership
Number link to view the contract definition.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory
Requirements, "(FRA) Meeting Regulatory Requirements for France," Setting Up
Pension/Contingency Fund Contracts.
Note. The system doesn't check the format of the numbers that you enter in the fields on this page.
Business Description Enter the company business description. This information is used on the two
local UK RIDDOR reports, which are located on the Monitor Health/Safety
menu. The system prints the business description of the relevant company from
the Job record of each employee.
(ITA) Italy
Company Code Type Enter the company code type and code that is assigned to your company by the
and Company Code Italian regulatory authorities.
Main Code Select if this is the main company code that is used for reporting purposes.
(NLD) Netherlands
Federal Employer Tax Enter the tax ID number that is provided by the Dutch government. It is required
ID for the wage declaration that is submitted to the Tax Authority.
See PeopleSoft Enterprise Global Payroll for the Netherlands 9.1 PeopleBook,
"Withholding and Reporting Taxes," Generating Wage Declarations.
258 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Vendor ID Select the providers that are associated with the company. For Dutch illness
reporting, the system uses the vendor that has the HRMS Class field on the
Vendor Information page set to I (Industrial Insurance Board Provider). Set up
vendors using the Provider/Vendor Table component (Set Up HRMS, Product
Related, Benefits NLD).
Dutch illness reporting is delivered with the Human Resources Monitor Absence
business process and PeopleSoft Enterprise Global Payroll for the Netherlands.
See PeopleSoft Enterprise Global Payroll for the Netherlands 9.1 PeopleBook,
"Updating Absences," Understanding Dutch Illness Reporting.
Registration Nbr Enter the registration number for the insurance provider, which you obtain from
(registration number) the provider. The registration number is a required field for the vendor that is
used in Dutch illness reporting.
(USA) USA
Employer ID Number Specify the unique Federal Employer ID Number (EIN) associated with the
company. This control becomes the default for the Employer ID State
Withholding control on the Company State Tax Table.
Note. If you choose to set up multiple companies with the same EIN,
modifications must be made to the quarterly wage reports to 'roll-up' these totals
(for example, TAX810XX, TAX860XX, TAX002XX, etc.).
However, for Annual W-2 reporting, employee balances can be combined using
the W-2 Reporting Company feature.
FLSA Required Select this option if any non-exempt employees in the company need to have the
FLSA rate calculated for their overtime pay. If there are Pay Groups with non-
exempt employees who do not need to have the FLSA rate calculated then the
FLSA Required flag on the Pay Group should be deselect.
Deselecting the FLSA Required on the Company component prevents you from
using the FLSA calculation for all pay groups because the FLSA Required flag
on the Pay Group component (PAYGROUP_TABLE) is hidden.
If you select this option, also select the applicable FLSA rule to indicate how and
when the FLSA calculated premium will apply to overtime pay.
Higher of FLSA premium will apply only when it is greater than the contractual rate.
FLSA/Contractual
Always use FLSA Use the FLSA premium amount regardless of the contractual rate.
Premium
Federal Reserve Bank The system uses this field when processing U.S. savings bonds issuing data.
ID Enter the Federal Reserve Bank (FRB) identifier assigned to this company by the
FRB.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 259
Setting Up Organization Foundation Tables Chapter 11
Federal Reserve Bank The system uses this field when processing U.S. savings bonds issuing data.
District Enter the Federal Reserve Bank District Designator indicating which FRB is
doing the issuing of the bonds.
EEO Company Code If the U.S. government has assigned this company a code for EE0-1 and VETS
(equal employment 100 reporting, enter the number.
opportunity company
code)
(AUS) Australia
Liability for Payroll Tax Specify whether tax is applicable to the default compensation rate components.
When you select this check box, the state payroll tax rates you set up on the State
Payroll Tax page (PKG_PYTX_RT_TBL) are used in the package compensation
calculation for your salary-packaged employees.
TEC Comp Rate Code Specify the default compensation rate code for TPV (Total Package Value) and
andTPV Comp Rate TEC (Total Employment Cost) that you will use in salary packaging enrollment.
Code You set up your compensation rate codes on the Comp Rate Code Table page
(COMP_RATECD_TBL).
Institute Code This group box appears only if you've selected the Education & Government
check box on the Installation Table component. Enter the Institute Code identifier
for DETYA reporting. This is used by the system to track information about the
institute for reporting purposes and defaults on any page where this is required
information.
Agency Code This group box appears only if you've selected the Education & Government
check box on the Country Specific page of the Installation component. Enter the
agency code for the company.
Classification Unit Enter the classification unit for your company. This information comes from the
Class Unit Table page (CLS_UNT_TBL_NZL). The system uses this data for
Accident Rehabilitation Compensation Insurance (ARCI) employer premium
calculations.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(NZL)
Meeting Regulatory Requirements for New Zealand," Setting Up the ARCI Table.
(ARG) Argentina
260 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
(MEX) Mexico
Company Settings Define the company's activity. Typical values are Financial, Pharmaceutical,
Manufacturing, Services, Tourism, and Sales.
% Creditable Subsidy Enter the percentage of accreditable subsidy. This value is used to calculate
federal taxes.
Name Enter the name of the person who acts as the legal representative for the
company.
RFC and CURP Enter these values for the legal representative.
(BRA) Brazil
Nature of Declarer Enter the legal nature of the establishment. This information is used for reporting
purposes.
Option to Simples Select an option to simples value to have the company's contributions replaced
by the actual invoice contribution amounts after invoices are generated.
(MYS) Malaysia
Reference Number Enter the company tax reference number (the Company C File Number). This
number is used in Annual Statement of Tax Deductions - Malaysian CP159
report (GPMYTX05).
Registration Number This is the company registration number, assigned by the government of
Malaysia assigns to an organization to uniquely identify the company. This is
used in CP39 Monthly Statement of Tax Deductions - Electronic form
(GPMYTX04).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 261
Setting Up Organization Foundation Tables Chapter 11
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Labor Administration, "Requesting Works
Councils Approval"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(GBR) Meeting
Regulatory Requirements for the United Kingdom"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Salary Packaging, "Setting Up Salary
Packaging," Setting Up Salary Packaging Company Payroll Tax Options
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Compensation, "Setting Up Administer
Compensation," Setting Up Rate Codes
262 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
The Net Pay and Direct Deposits fields on this page are applicable to both U.S. and Canada. The liability
combination codes are related to U.S. tax accounting information only. Canadian companies use the Wage
Loss Plan Table to enter GL tax accounting information.
Distribute Expense Select this box to distribute the cost of benefits between an employee's home
department and other departments where the employee earns earnings (such as an
employee who has multiple jobs). The system distributes the cost of benefits
according to the percentage of total earnings that the employee earned in each
department. If you do not select this check box, all expenses are distributed to the
employee's home department.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Payroll Tax Tables,"
(CAN) Setting Up Wage Loss Plans.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Garnishments,"
Establishing a General Ledger Account for Company Fees.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 263
Setting Up Organization Foundation Tables Chapter 11
Tips Processing Select to indicate the use of this feature. Tip allocation is required when the
amount of tips reported by tipped worker for a pay period is less than a specified
percentage of an establishment's gross receipts for that period.
Tip Establishment Field This field designates where the tips are acquired. Tips allocation is done for each
establishment. An establishment is an individual restaurant, hotel, or other unique
location. If a company has 15 restaurants, tips are allocated separately for each
restaurant. You cannot override this value in the Tip Establishment page.
264 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Minimum Tips Percent Enter the minimum percentage of tips to be distributed to workers. The
percentage specified by the federal regulations is 8 percent. Employers can apply
for a lower percentage if it can be shown in writing that the tip rate at an
establishment is less than 8 percent. You can override this value in the Tip
Establishment table.
Note. The minimum tips percent value is based on federal and state regulations.
Tips Allocation Method Select the tip allocation method used for this company. Only establishments that
employ fewer than 25 employees (tipped and nontipped) during a pay period can
use the Hours Worked method. You can override this value in the Tip
Establishment table.
Tips Allocation Select the earnings code to record the amount calculated by the tip allocation
Earnings Code process. You cannot override this value in the Tip Establishment table.
These values populate the Pay Group table, where you can override them.
Delay Withholding of Select to have the system delay withholding until the worker reports 20 USD of
Taxes tips in a month federal and state taxes for each earning that is indicated for tax
withholding in the Tax table.
Adjust to Minimum Select this check box unless your company has a special agreement with the
Wage (adjustment to Internal Revenue Service. This ensures that tipped workers receive necessary
minimum wage) wage adjustments to bring them up to the minimum wage.
Min Wage Adjustment Select the earnings code to be used when tips plus wages do not meet statutory
Earns Code (minimum minimum wage requirements.
wage adjustment earnings
code)
Tip Credit Earnings Select an earnings code for recording tip credits. Tip credits are memo earnings
Code to identify what portion of reported tips goes toward payment of the federal
minimum wage (state minimum wage is used if it is higher than the federal
minimum wage).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 265
Setting Up Organization Foundation Tables Chapter 11
Use the Balance Processing options when two or more related corporations concurrently employ one or more
workers and pay them through one of the corporations as a common paymaster. By selecting these controls,
the system treats simultaneous employee balances in multiple companies as one total balance when
calculating payroll.
The total Social Security and Medicare taxes that must be paid are determined as if the people had one
employerthe common paymasterpaying all their wages. The system will also recognize balances in all
companies linked by a common paymaster when determining if a certain limit has been metso you don't
have to calculate employee balances manually.
Common Paymaster ID Enter a Common Paymaster ID to tell the system to treat all employee tax,
deduction, garnishment, and earnings balances as one for companies sharing
that Common Paymaster ID.
Other Common ID Enter an Other Common ID to tell the system to treat all employee deduction
garnishment, and earnings balances as one for companies sharing that Other
Common ID.
You'd typically use an Other Common ID when you need to keep your
companies separate for tax purposes, but need to maintain accurate current
employee balances across companies for calculating Section 415 limits, year-to-
date deduction maximums, and maximum yearly earnings ceilings. Leave accrual
balances are not included in Common Paymaster ID or Common Other ID
processing.
266 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Tax Report Type This field is used by the year-end tax reporting programs.
PeopleSoft Payroll for North America requires employees and supported types of
persons of interest to be associated with companies that have the correct tax
report type:
Employees must be associated with companies with one of these tax report
types:
W-2 or Territories
Other Payee and Pension Payee persons of interest must be associated with
companies with tax report type 1099R.
Note. To produce Forms W2PR for Puerto Rico in Payroll for North America,
you must have paid Puerto Rico employees in one or more separate companies
for the entire tax year being reported. Each Puerto Rico employee's home address
must be set up with the country code USA and the state code PR for proper tax
reporting.
Note. To include retirees in your year-end reports, you must set them up in a
separate 1099-R company.
FICA Status-Employee This information appears as a default on the Job Information page
(JOD_DATA_JOBCODE).
SDI Status-Employee For states where the SDI status is not specified as Not Applicable, the
Employees' SDI Status will appear as a default.
FUT Exempt Select this option if the company is exempt from FUT.
SUT Exempt Select this option if the company is exempt from SUT.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 267
Setting Up Organization Foundation Tables Chapter 11
Claeys Salary Limit Enter the salary limit for applying the Claeys formula.
Hour/Year Factor Enter the hour/year factor to calculate the hourly amount that an worker earns
and gross that amount up to the yearly total.
Month/Year Factor Enter the month/year factor to calculate the monthly amount that an worker earns
and gross that amount up to the yearly total.
Week/Year Enter the week and year to calculate the weekly amount that an worker earns and
gross that amount up to the yearly total.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "(BEL) Entering Additional
Data for Belgian Workers"
268 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
SetID and Vendor ID Select from the list of options. The system lists all valid providers, not just
Belgian providers.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 269
Setting Up Organization Foundation Tables Chapter 11
Processing Controls
(FRA) France
Phone Type and Enter the phone type, such as Business, Home, and so forth, and the phone
Telephone number. The phone fields are effective-dated and scrollable so that you can enter
multiple phone types and maintain history data.
FTE Decimal Precision Enter the number of decimal points the system will use when calculating FTE.
Note. If you set this field to zero or leave it blank, the FTE calculations on the
Job Data pages will default to 1 regardless of the number of hours entered or
part/full-time status.
(FRA) France
PAID FTE Decimal Enter the number of decimal points the system will use when calculating FTE for
Precision payment purposes.
270 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
This section provides an overview of agency information and discusses how to enter payroll information.
If you use only PeopleSoft Human Resources, you enter information only on the first page, the Agency
Location page, for each agency that you want to add. You can also associate a default pay group with the
agency on the Default Settings page. The value that you select appears as the default on the Job Data pages
for workers in this agency. However, it is easiest to treat each agency that you add as a separate tax entity, as
though you were using PeopleSoft Payroll for North America.
If you're using PeopleSoft Payroll for North America, an agency is typically defined as a business unit that
has a unique federal Employer Identification Number (EIN) for payroll tax reporting purposes.
If your agency uses PeopleSoft Payroll for North America, each sub-agency that you add must be equivalent
to each EIN that you use. Your payroll staff needs to complete all nine pages at least once to add an agency
EIN.
You can print a report of your Agency table using the Agency Table report.
Note. The Agency Location, Default Settings, Phones, and Rules Definition pages in the Agency Table
component are identical to those in the Company Table component and share the same object names.
Payroll Interface GVT_COMPANY_TBL7 Set Up HRMS, Foundation Enter the agency's payroll
Information Tables, Organization, interface information.
Agency USF, Payroll
Interface Information
Payroll Office Address GVT_COMPANY_TBL8 Set Up HRMS, Foundation Enter the agency's payroll
Tables, Organization, office address information.
Agency USF, Payroll Office
Address
ECS Address (electronic GVT_COMPANY_TBL9 Set Up HRMS, Foundation Enter the agency's ECS
certification system Tables, Organization, address information.
address) Agency USF, ECS Address
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 271
Setting Up Organization Foundation Tables Chapter 11
Agency Table Report - Run PRCSRUNCNTL Set Up HRMS, Foundation Run the Agency Table
Control page Tables, Organization, report (FGPER803). This
Agency Table Report USF, prints all agencies in the
Run Control Agency component and
default information,
including name and address,
agency code, and effective
date.
See Also
Appendix D, "PeopleSoft Application Fundamentals for HRMS Reports," Basic HRMS Reports, page 1106
272 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
See Also
Defining Establishments
To define establishments, use the Establishment component (ESTABLISHMENT_DATA) and Controlled
Establishment Sumry component (CONTROLLED_ESTABS). Use the ESTABLISHMENT_DATA
component interface to load data into the tables for the Establishment component.
Understanding Establishments
You use the Establishment component to define distinct physical places of business (establishments) within
your company, to enter address information, and to enter regulatory reporting information. In PeopleSoft
Human Resources, you define establishments that are consistent with the regulatory requirements of your
business operations.
Has an address.
An establishment isn't necessarily a single building or location; it could be an entire industrial or office
complex, but it is usually a physical place for which information is reported as a consolidated unit.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 273
Setting Up Organization Foundation Tables Chapter 11
Occupational Illness and Injury Record keeping (OSHA 200) and Equal Employment
Opportunity/Affirmative Action reporting in the United States.
Note. (USA) To support AAP reporting, locations and establishments can have a many to many relationship.
Set up the relationship between establishments to locations on the Location Profile page
(LOCATION_TBL2_GBL). Only establishments that are effective as of the location's effective date are
available on the Location Profile page. View the locations associated with an establishment on the
Establishment Address page.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(USA) Meeting
Regulatory Requirements for the United States"
Workforce Monitoring,
Meet Regulatory
Rqmts, Define
Regulatory Reqmts
Data, Establishments,
Phone Numbers
274 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 275
Setting Up Organization Foundation Tables Chapter 11
276 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 277
Setting Up Organization Foundation Tables Chapter 11
Headquarters Unit Select if the establishment that you're defining is your headquarters. Designate at
least one establishment in your company as the headquarters.
(ESP) Spain
Insurance Company Select the code of the insurance company that represents the establishment (work
Code center) in work-related injuries. These codes are maintained on the Insurance
Company page (INSUR_COMP_CD_ESP).
SSN Employer Enter the social security number as assigned by the Spanish government.
SSN ER Type (social Select the SSN type Apprentice, Regular , or Training based on the type of
security number employer contract you have with your employees.
type)
278 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Main Select if the entry in the SSN Employer field is the main number for this
establishment (work center). One work center can have more than one employer
social security number.
IA Code (industry Enter the IA code, which is maintained on the Industry Activity page
activity code) (INDSTRY_ACT_CD_ESP).
Days Type Select the Days type from the available options.
(FRA) France
NIC Code(Numero Enter the NIC code for the establishment. NIC numbers identify the entities that
Interne de Classement are inside the same enterprise.
code). (Internal Number
of Filing)
Note. The SIRET number (Systeme Informatique pour le Repertoire des Etablissements, or Electronic List of
Entities) is an identifying number that is given to a French business by the INSEE (Institut National de la
Statistique et des Etudes Economiques, or National Institute of Statistics and Economics Information). INSEE
is an official statistics and economics organization in France. The SIRET number is a combination of the
SIREN and NIC numbers and is used by the tax and social security authorities to identify a business
enterprise and its entities.
CRAM Fund ID(Caisse Select a CRAM fund ID. CRAM is the regional social body that deals with the
Regionale d'Assurance prevention of and compensation for industrial injuries. The CRAM office
Maladie fund ID) oversees the local CPAM (Caisse Primaire d'Assurance Maladie) offices that
manage occupational health care coverage.
Transport Rate Date Enter the date of the last update to the Transport Rate. This date is reported in the
DUCS report provided in PeopleSoft Enterprise Global Payroll for France.
Additional Transport Enter the additional transport rate if applicable.The transport rate is a statutory
Rate deduction and is defined by local regulations. PeopleSoft Enterprise Global
Payroll for France uses the additional transport rate that you enter here.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 279
Setting Up Organization Foundation Tables Chapter 11
Additional Transport Enter the date of the last update to the Additional Transport Rate. This date is
Rate Date reported in the DUCS report provided in PeopleSoft Enterprise Global Payroll
for France.
URSSAF Code (Union de Enter an URSSAF code and number. The URSSAF is responsible for ensuring
Recouvrement de la payment of Social Security contributions by all French employers.
Securite Social et des
Allocations Familiales
code) and URSSAF Nbr
(URSSAF number)
Mandatory Base Scheme Select the Social Security code for DADS.
Tax on Salary Liability Indicate if the tax on salary liability is complete, partial or if there is no liability
to this tax.
Establishment Activity Enter an establishment activity and select a medical organization code. Medical
and Medical organization codes are defined on the Medical Organizations page (Set Up
Organization Code HRMS, Product Related, Workforce Monitoring, Regulatory Requirements FRA,
Medical Organizations). These fields are used for Single Hiring Statement
reporting.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory
Requirements, "(FRA) Meeting Regulatory Requirements for France," Running
Workforce Reporting Statutory Reports.
This scroll area displays details of the pension/contingency funds defined for the establishment on the
Pension/Contingency Contracts page. Click the Membership Number link to view the pension/contingency
contract definition.
Establishment Risk
Risk Code Enter the risk code.The various rates are associated by the risk code that is used
at the department level to specify the work accident rate for the department.
AT SECTION (Section System-displayed information that you need to identify the risk code by
Accident du Travail establishment.
section) (Work Accident
Section)
Standard Rate Enter the standard rate information. The various rates are associated by the risk
code that is used at the department level to specify the work accident rate for the
department.
(MEX) Mexico
Enter the Registros Patronal information required for social security and tax purposes.
280 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Guide Number Enter the number provided by the IMSS authority. The guide number is used as a
reference when you submit reports to the IMSS.
IMSS Zone, IMSS Select the IMSS zone, subzone, and sector for your establishment's location.
Subzone, and IMSS The IMSS zone, IMSS subzone and IMSS sector indicate the office where you
Sector can make your payments.
Risk Factor Enter the risk factor that's used for IMSS tax calculation.
Wage Zone Select the economic zone for your company's location. Wage zones dictate
minimum wages. Valid values are A Zone, B Zone, and C Zone.
(USA) USA
Section B
North Amer Ind Class Enter the NAICS code, controlling establishment ID, SIC code, and Vets 100
Sys [North American unit number, if any apply to this establishment.
Industrial Classification
System (NCIS)],
Controlling
Establishment ID, SIC
(Standard Industrial
Classification), and Vets
100 Unit Number
Section C
Section E
Location same as last Select Yes or No to indicate whether your location is the same as last year, or
year select No Report if you made no report last year.
Major business activity: Select Yes or No to indicate whether your business activity is the same as last
same as last year year; or, select No Report if you made no report last year.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 281
Setting Up Organization Foundation Tables Chapter 11
Estab major business Enter a description of the establishment's major business activity. The description
activity (establishment's is limited to the four lines that appear on the page.
major business activity)
Section G
Location
As of Date Select a date to view which locations are associated with this establishment at a
certain point in time.
SetI D, Location Code, View the location codes associated with this establishment on the Location
andDescription Profile page.
Go To Locations Click to access the Location component. The system will open the component
with the same action you are in on the Establishments component.
When you save or cancel your changes on the Locations component, the system
returns you to the Establishment component.
See Also
Chapter 11, "Setting Up Organization Foundation Tables," Establishing Locations, page 283
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(USA) Meeting
Regulatory Requirements for the United States"
282 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Phone Type and Phone Enter phone information for this establishment.
(FRA) France
Establishing Locations
To establish locations, use the Location (LOCATION_TABLE) and the Location Table Report
(RUN_PER705) components. Use the LOCATION_TABLE component interface to load data into the tables
for the Location component.
Understanding Locations
Use the Locations component to establish physical locations in your organization, such as corporate
headquarters, branch offices, remote sales offices, and so forth. If you use PeopleSoft Global Payroll, you
may want to report certain information by location, so consider this when planning your implementation of
this information.
If you use PeopleSoft Pension Administration, you can create one or more locations specifically for pension
payees. You can use a single retiree location for all retirees if you don't need to report on your payees based
on more specific location information.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 283
Setting Up Organization Foundation Tables Chapter 11
Various pages in PeopleSoft Human Resources reference the information that you define in the Locations
component. In recruitment, for example, applicants can specify work preference by location. In career
planning, you can assign training courses to locations.
Note. (USA) To support AAP reporting, when you select a regulatory region with a country value of USA on
the Location Profile page, the system enables you to establish a many to many relationship between locations
and establishments. Set up the relationship on the Location Profile page in the USA section of the page. Only
establishments that are effective as of the location's effective date are available on the Location Profile page.
View the locations associated with an establishment on the Establishment Address page.
Business Units by Location LOC_BU_SEC Click the Business Units View a list of the business
that use this Set ID link on units that use this setID.
the Location Address page.
Phone Number BUS_PHONE_SEC Click the Phone link on the Enter phone numbers for
Location Address page. the location addresses.
Location Details BRA LOCATION_TBL_BRA Set Up HRMS, Foundation Define details for
Tables, Organization, geographic locations in
Location BRA, Location Brazil.
Details BRA
284 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Location Table Report - PRCSRUNCNTL Set Up HRMS, Foundation Run the Location Table
Run Control Tables, Organization, report (PER705). This
Location Table Report, Run report lists each physical
Control location by Location Code.
Because you can define
locations by effective date,
the report program prints all
locations (past, present, and
future).
Building Enter the building location, if applicable. For example, your corporate
headquarters might be located in building 4 in an office park.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 285
Setting Up Organization Foundation Tables Chapter 11
286 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
You enter U.S. tax information for Canadian and German locations on this page.
Note. PeopleSoft Payroll for North America references the Tax Location Table for location information, and
PeopleSoft Pension Administration references the PeopleSoft Payroll for North America tax information. For
more information about the relationship between the Locations component and the Tax Location Table in
PeopleSoft Payroll for North America, see the PeopleSoft Payroll for North America documentation.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 287
Setting Up Organization Foundation Tables Chapter 11
Set ID and Plan Select a salary administration plan from the values that you created on the Salary
Plan component.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base
Compensation and Budgeting, "Setting Up Base Compensation and Budgeting,"
Setting Up Salary Plans, Grades, and Steps.
Tying a salary administration plan for a location helps you distinguish currency
and cost-of-living differences for workers with the same job code. If you don't
need to distinguish salary administration plans by location, leave this field blank.
Note. Select only the plans that are associated with the setID that you selected on
the Define Salary Plan component. If you select a salary administration plan on
this page, the system uses that plan as the default value on the Job Data pages for
the people in this location. Otherwise, it uses the salary administration plan that
you enter on the Job Code Table.
Regulatory Region Enter the regulatory region that is associated with this location.
Note. (USA) If you select a regulatory region with a country value of USA, the
system will hide the Estab ID field. To associate establishments with this
location, use the Establishments fields in the USA section of this page.
Note. If you use PeopleSoft Payroll for North America, the holiday schedule you
select here is the default holiday schedule assigned to workers on the Job Data
Payroll page (JOB_DATA2). If you leave this field blank, the default holiday
schedule comes from the Pay Group component.
If you use PeopleSoft Global Payroll, the holiday schedule on this page is for
informational purposes only; assigned pay groups control the default holiday
schedule for processing.
Note. (USA) If you select a Reg Region value with a country value of USA, the
system hides this field. Set up establishments for U.S. locations in the USA
section of this page.
Taxing Locality and Select a taxing locality and check cashing location. This field is for information
Check Cashing Location only.
288 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
(CAN) Canada
Canadian Census Select the Canadian Census Metropolitan Area (CMA) code that is prescribed by
Metropol Area Statistics Canada for this location. CMA refers to the main labor market area of
(Canadian Census an urban core with a population of at least 100,000. This field is required.
Metropolitan Area)
CEC Management Area Select from the list of options.
(Canada Employment
Center Management Area)
Geographical Location Enter the geographic location code as defined by Statistics Canada.
Code
Note. (CAN) If the Official Languages Act applies to your organization, use the information in the
Geographic Location Code, Office Type, TBS Office Code, and National Capital Region fields as part of the
Official Languages reports (PER102CN and PER108CN) that you submit to the Canadian government. If this
is a military installation, the geographic location code entered on the first page of the Location MIL
component, is copied to the Geographical Location code in the Canada section.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(CAN)
Meeting Regulatory Requirements for Canada."
(CHE) Switzerland
Municipality Code The default value is the municipality code that corresponds to the postal code of
the location address. You can select a different code from the list of valid
municipality codes for the canton that this location is in.
(DEU) Germany
Tariff Enter the tariff, or the type of business conducted at this location, such as
banking, retail industry, printing, or wood processing.
Industrial Inspection ID Select the ID for this location from the list of values, if appropriate. Industrial
inspection codes are included on Incident and Illness Reports that record the
worker accidents and illnesses incurred on the job in the Monitor Health and
Safety business process.
Note. When you enter a person's location on the Job Data pages, the Tariff and Tariff Area values appear by
default from the Locations component, based on the values that you entered on this component for the
location.
When you enter a person's location and labor type on the Job Data pages, the system populates the
Spokesman Committee ID and Works Council ID fields. These values are based on the person's location in
the Work Location page (JOB_DATA1) and the value of the Labor Type (Management or Non-Management)
in the Job Labor page (JOB_LABOR).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 289
Setting Up Organization Foundation Tables Chapter 11
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Labor Administration, "Requesting
Works Councils Approval."
(MEX) Mexico
Fonacot ID Number Enter the FONACOT ID for your location. FONACOT is a consumer fund for
employees.
FONACOT Office Identify the nearest FONACOT office for your location.
Tax Local Select this check box if the location of the state is Chihuahua.
Special Local Tax If the location of the state is Chihuahuathis field will default to Ciudad Juarez.
(ESP) Spain
Last Matricula Number The Spanish government requires employers to assign each people a unique
Assigned matricula number, which is used for government reporting. To avoid duplication
of numbers, this field updates and stores the last matricula number assigned.
Northern Ireland Select if this is a Northern Ireland reportable location. Indicates that people in
Reportable this location are to be included in the community background report (Fair
Employment Monitoring Return) that is provided for Northern Ireland.
USA
290 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Note. You can view the locations associated with an establishment on the
Establishment Address page.
(ARG) Argentina
Family Allowance Rate Select the family allowance rate from these values: General, Zone 1, Zone 2,
Zone 3 and Zone 4.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 291
Setting Up Organization Foundation Tables Chapter 11
Location MIL - Location LOCATION_TABLE_MIL Set Up HRMS, Foundation Enter military locations and
Address Tables, Organization, associate them to
Location MIL, Location geographic locations.
Address
City Code/Name The system assigns a city code. Enter the city name.
292 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
CBSA(core based This value is supplied by the OPM data file. It is blank if the duty station is not in
statistical area) a CBSA. This field is labeled MSA for effective dates before February 2, 2005.
CSA(combined statistical This value is supplied by the OPM data file. It is blank if the duty station is not in
area) a CSA. This field is labeled CMSA for effective dates before February 2, 2005.
See Chapter 11, "Setting Up Organization Foundation Tables," Entering Company Locations, page 285.
This section provides an overview of federal locations and discusses how to:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 293
Setting Up Organization Foundation Tables Chapter 11
Various pages in PeopleSoft Human Resources reference the information that you define in the Locations
USF component. In recruitment, for example, applicants can specify work preference by location. In career
planning, you can assign training courses to specific locations.
Locality Pay Area Table GVT_LOCAREA_TABLE Set Up HRMS, Product Define the regions where
Related, Compensation, federal workers receive
Locality Pay Area Table additional pay above their
USF, Locality Pay Area base pay.
Table
294 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Federal employees in certain regions receive additional pay above their base pay. PeopleSoft delivers this
data, but you might need to change it based on Office of Personnel Management updates.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 295
Setting Up Organization Foundation Tables Chapter 11
Effective Date The first time you set up this table, select an effective date that is early enough to
accommodate your organization's oldest historical information.
Note. Add data rows and use the scroll bar, the Effective Date field, and the
Status field to maintain history data for information that changes over time. For
example, to retire a Locality Pay Area, insert an effective-dated row with a status
of Inactive.
Locality Percentage Enter the percentage of base pay employees in this region receive above their
base pay, which is set by their pay plan, grade, and step. The amount appears on
the person's Compensation page (JOB_DATA3) in Administer Workforce.
City Code/Name The system assigns a city code. Enter the city name.
296 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Note. PeopleSoft Payroll for North America references the Tax Location Table for location information.
See Also
Building Enter the building where the location is, if applicable. For example, your national
office might be located in the main building of your complex.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 297
Setting Up Organization Foundation Tables Chapter 11
Country Select a country from the list of values and move out of the field. The system
displays the appropriate address fields for the country that you selected, using the
standard address format that you have set up in the Country Table.
298 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Works Council ID Select the ID of the Works Council representing workers at this company and
location.
(DEU) Germany
Maintaining Departments
To maintain departments, use the Departments component (DEPARTMENT_TBL) and the Department Table
Report component (RUN_PER701). Use the DEPARTMENT_TBL component interface to load data into the
tables for this component.
Understanding Departments
After you define company and location data for your enterprise, use the Departments component to define
business entities in your organization. If you're using PeopleSoft Payroll for North America or PeopleSoft
Global Payroll, you must set up department codes according to your cost centers where you charge wages. If
you use PeopleSoft Pension Administration, you need departments to house your pension payees. You can
use a single department for all your pension payees, or you can organize your payees using a department
scheme that meets your reporting needs. Otherwise, you can set up departments using any groupings you like.
PeopleSoft Human Resources offers two ways to access the Departments component to define and view
departments:
This section discusses how to use the Departments component from within the Set Up HRMS menu.
PeopleSoft enables you to create a security hierarchy using PeopleSoft Tree Manager and use it to grant or
deny users to person data, based on the department a person belongs to. If you decide to use a Department
Security tree to control data access, you must attach each department you create, whether from the Set Up
HRMS menu or Tree Manager, to an effective Department Security Tree.
PeopleSoft HRMS also enables you to use other fields for data permission security.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 299
Setting Up Organization Foundation Tables Chapter 11
See Also
Comm. Acctg. and EG DEPARTMENT_TBL_CA Set Up HRMS, Foundation Enable and control
(department table - Tables, Organization, department information that
commitment accounting and Departments, Comm. is specific to Education and
education and government) Acctg. and EG Government customers and
customers who use the
Commitment Accounting
feature.
Department Table Report - PRCSRUNCNTL Set Up HRMS, Foundation Use this page to run the
Run Control Tables, Organization, Department Table report
Department Table Report, (PER701) that lists all
Run Control departments by Department
ID.
300 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 301
Setting Up Organization Foundation Tables Chapter 11
Effective Date If you add a new department to the Departments component from the Set Up
HRMS menu, set its effective date to predate (or be equal to) the effective date of
your security tree.
302 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Description For Payroll for North America: If you use the department specified on the
employee's Job record to indicate where to deliver checks, the system
automatically prints the department description and code on the check.
Location Set ID and To associate a department with a physical location, select the location. Maintain
Location these values in the Locations component.
Company Indicate the company to which this department belongs. The system uses the
Company field value as the default company location on the job records for all
people associated with this department. If you add a person to this department,
the system assumes that they are also with the designated company. If you don't
enter a company here, you can enter it on the Job Data pages. If you do enter a
company here, you can't change it on the Job Data pages.
Note. If yours is a multicompany environment and you want more than one
company to share the department, leave the Company field blank.
Manager Type
If you are not specifying managers for departments, select None. If you are specifying managers, indicated if
the manager is a person (EmplID) or a position (Position). If you use partial position management, where you
use positions for only a portion of your organization, select whichever option is appropriate for this
department.
Manager ID If you selected EmplID, the system makes this field available for you to select
the ID of the manager. The manager ID that you select becomes the default
supervisor ID on the Job records of all people who are assigned to this
department. If you have more layers in your organization, override the default.
Manager Position If you selected Position, and you have created positions for this department,
select a Manager Position number. This field is optional, but you might find it
useful for reporting activities such as departmental hierarchical data.
The system displays the name and EmplID of the current position incumbent in
the EmplID field.
Note. The system allows you to select any position. To have the system prompt
you with positions that are only in this department, update the DEPT_TBL in
PeopleSoft Application Designer so that the prompt table for this field is
DEPT_POSITIONS.
Budget Year End Date If you handle your budgeting in PeopleSoft Human Resources, enter the last
month and day of the budget year as the date for all positions in this department.
Budget Level Select Department, Job Code, Line Item, Position Number, or None to define
budgeting for this department.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 303
Setting Up Organization Foundation Tables Chapter 11
Tax Location Specify the tax jurisdiction for the department. The code that you enter populates
the Tax Distribution pages (TAX_DISTRIBUTION or TAX_DIST_CAN) of
employees of this department. You can override this information for individual
employees.
(BEL) Belgium
Industrial Committee Select the industrial committee for the company. This can be overwritten at the
department level if necessary.
Note. The NACE code can range from 5 digits for group level, 6 for class level,
and 7 for subclass level.
(CAN) Canada
Industrial Sector The North American Industrial Classification System (NAICS) is a common
framework for the production of comparable industry statistics for Canada,
Mexico and the United States. Its hierarchical structure is composed of sectors
(two-digit codes), subsectors (three-digit codes), industry groups (four-digit
codes), and industries (five-digit codes). At each level of the hierarchy, additional
digits are appended to those from the previous level. For example, the NAICS-
2007 sector code for health care is 62, so all of the subsector, industry group, and
industry codes for healthcare begin with 62.
Use the Canadian Industrial Sector field to select the two-digit sector code for the
department. Sectors with a large number of industries have multiple sector codes.
Although there is no difference between the codes at the sector level, the best
practice is to select the code with the correct digits for the department's industry.
For example, although you can use 31, 32, or 33 for the Manufacturing sector, if
you are a clothing manufacturer with an industry group of 3151, you should
select 31 as the sector code.
Codes are effective-dated so that you can easily update this field when new codes
are published. For example, the NAICS-2007 codes became effective on January
1, 2007 and are available for entry only in rows with effective dates on or after
that date.
NAICS Code Enter the four-digit NAICS code for the department's industry group. The
NAICS code is used for Canadian employment equity reporting purposes and
appears in the Employment Equity Report (PER101CN).
When new NAICS codes are published, create a new effective-dated row to
capture any changes to a department's industry group code.
304 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
(E&G) Stats-Can- Enter a 3-character code to be reported in the Canada Academic Teaching
Department Code Survey. This field is intended for Canadian higher education degree-granting
(Statistics Canada institutions only.
department code)
(E&G) Stats-Can Select a code to associate a faculty with a department. Faculty codes are set up in
Faculty Code (Statistics the StatsCan Faculty Code table and are used to associate medical and dental
Canada faculty code) categories with faculties. The system uses the faculty code that is associated with
this department to determine the medical and dental categories that are reported
in the Canada Academic Teaching Survey. This field is intended for Canadian
higher education degree-granting institutions only.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Track Faculty Events, "(CAN) Working with
the Statistics Canada Academic Teaching Surveys Process."
(DEU) Germany
Note. For more information about how tax location codes affect payroll
processing for North America, see your PeopleSoft Payroll for North America
documentation.
Note. The Accident Insurance, Hazard, and Social Insurance Accident # fields are used to monitor Health and
Safety business process functionality in PeopleSoft Human Resources.
(FRA) France
Establishment ID Select an establishment ID for this department. French Social Security defines a
risk code for your establishment, based on the number of work accidents that
have occurred in the past three years in a particular establishment. Your
establishment must contribute to a Work Accident fund, based on the number of
work accidents that occur in your establishment; the more accidents you have,
the more you pay into the fund.
This field is required for Global Payroll for France. The system will default this
value into a worker's Job record when you use PeopleSoft Human Resources:
Manage Positions.
Risk Code Select a risk code from the list of risk codes. You define your organization's
percentage of contributions to the French Social Security fund at the department
level, based on the risk code that you enter.
AT SECTION Select the AT section for the risk code selected in the Risk Code field. Risk Code
/ AT sections are defined for establishments. When there are several AT sections
defined for the establishment, use this field to specify the AT section to use.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 305
Setting Up Organization Foundation Tables Chapter 11
(USA) USA
EEO4 Function (Equal Select the functional category, such as health or fire protection, that applies to
Employment Opportunity this department. The option that you select affects your EEO reporting to the U.S.
04 function) federal government.
Classification Unit Enter the classification unit for your company. This information comes from the
Classification Unit Table. The system uses this data for Accident Rehabilitation
Compensation Insurance (ARCI) employer premium calculations.
(AUS) Australia
These fields appear only if you selected the Education & Government check box on Country Specific page of
the Installation component.
Organizational Unit Enter the appropriate Higher Education organizational unit code.
Agency Code Enter the four-digit Australian Public Service code for this department.
306 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
FTE Edit Indicator (full- Select whether you want the system to display a warning or an error message
time equivalency edit when you exceed the FTE maximums for this department. If you don't want the
indicator) system to perform an FTE edit for this department, select No Edit.
Tenure Processing
Can Grant Tenure Select to be able to grant tenure to qualified people in this department.
Commitment Accounting
Use Comm. Acctg / Select if you use Commitment Accounting processing for this department. When
Budgeting (use you select this check box, the other page elements in this group box become
commitment accounting / available for entry.
budgeting)
Budget with Department An accumulated budget for a group of departments rolls up to the department that
you enter.
The department that you enter must be in the same SetID as the department that
you are defining, and it must be higher on the security tree. For example, if
departments 00010 and 00012 are lower on the security tree than department
00005 and they have the same SetID, then departments 00010 and 00012 can
budget with department 00005. The budgets for 00010 and 00012 roll up into a
single budget with 00005.
See Chapter 5, "Setting Up and Administering HRMS Security," Setting Up and
Assigning Tree-Based Data Permission, page 81.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 307
Setting Up Organization Foundation Tables Chapter 11
Use Encumbrance Select if you use Commitment Accounting encumbrance processing for this
Processing department.
Use Actuals Distribution Select if you use Commitment Accounting's Actuals Distribution process for this
department.
Process Option Choose how to process job data and position data changes that can affect
encumbrance calculations.
Certain processing options result in different actions depending on whether the
job data or position data change is considered critical. Critical changes in the Job
Data component include hiring, rehiring, and adding a concurrent job. Critical
changes in the Position Data component include creating a position, increasing
the head count for a position, changing a position from inactive to active, and
changing the Pre-Encumbrance Indicator for a position from None or Requisition
to Immediate,
The following table describes your processing option choices:
Batch Process Only Do not allow real-time budget Do not allow real-time budget
checking. All encumbrance checking. All encumbrance
calculations are performed by the calculations are performed by the
batch process. The individual budget batch process. The individual budget
check status is set to Pending. check status is set to Pending.
308 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Automatic Budget This check box is available only if the selected Process Option is All or Critical.
Check Select this check box if you want the system to immediately perform a real-time
budget check when a user attempts to save a change to job data or position data.
Deselect this check box if you want the system to present a pop-up window when
a user attempts to save a change to job data or position data. The pop-up window
gives the user the choice of performing the budget check immediately or saving
the transaction without performing the budget check. If the user bypasses the
budget check, the system generates a transaction that can be processed from the
Budget Check by Job page or the Budget Check by Position page.
Use TL Distribution Select to take into account the task information that is entered into PeopleSoft
Time and Labor during Commitment Accounting's Actuals Distribution process.
This check box applies only to PeopleSoft Time and Labor customers.
If you select this check box, the Actuals Distribution process creates an entry for
each Time and Labor task entry. It then distributes the earnings in the appropriate
ratio (the same ratio that is used for Labor Distribution).
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Track Faculty Events, "Setting Up Track Faculty
Tenure," Setting Up Tenure Tracking
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Commitment Accounting, "Defining Fiscal
Year Budgets"
The procedures for running SQRs vary with your application environment. If you aren't sure of your standard
procedures, ask your system administrator.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 309
Setting Up Organization Foundation Tables Chapter 11
Set up departments.
Setting Up Departments
Access the Department Table page (Set Up HRMS, Foundation Tables, Organization, Departments USF,
Department Table).
310 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
Effective Date Important! \If you add a new department to this Departments USF component
from the Set Up HRMS menu, set its effective date to predate (or be equal to) the
effective date of your security tree.
Note. The system uses the Company and Sub-Agency fields as the default
agency/sub-agency location on the Job records for all people who are associated
with this department. If you hire employees into this department, the system
assumes that they are also employees of the designated agency/sub-agency. If
you don't enter an agency here, you can enter it on the Job Data pages. If you do
enter an agency here, you can't change it on the Job Data pages.
Manager ID The manager ID that you select becomes the default supervisor ID on the
employee records of all employees who are assigned to this department. If you
have more layers in your organization, override the default.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 311
Setting Up Organization Foundation Tables Chapter 11
Manager Position If you use position management, and you create positions for this department,
you can select a manager position number. This field is optional, but you might
find it useful for reporting activities such as departmental hierarchical data. When
you select a manager position number, the system displays whether an employee
is assigned to the manager position.
Note. You can select any position in this field. To have the system to prompt
you with positions that are only in this department, update the DEPT_TBL in
PeopleSoft Application Designer so that the prompt table for this field is
DEPT_POSITIONS.
If you use partial position management, where you use positions for only a
portion of your organization, you can use either the Manager ID number or the
Manager Position number. When you select either field, the system disables the
remaining field.
Budget Year End Date If you handle your budgeting in PeopleSoft Human Resources, enter the last
month and day of the budget year as the date for all positions in this department.
Budget Level Select Department, Job Code, Line Item, Position Number, or None to define
budgeting for this department.
(USA) USA
EEO4 Function Select the functional category, such as health or fire protection, that applies to
this department. The option you select affects your EEO reporting.
See Also
This section provides an overview of primary permission list preferences and discusses how to:
312 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
See Also
Chapter 5, "Setting Up and Administering HRMS Security," Setting Up Security for Local Functionality,
page 124
Org Defaults by Permission OPR_DEF_TBL_HR Set Up HRMS, Foundation Set predefined TableSet
Lst - Defaults Tables, Organization, Org sharing and system-wide
Defaults by Permission Lst, defaults for each of your
Defaults primary permission lists.
Org Defaults by Permission OPR_DEF_TBL_HR2 Set Up HRMS, Foundation Set Payroll System and
Lst - Settings Tables, Organization, Org system-wide defaults for
Defaults by Permission Lst, each of your permission
Settings lists.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 313
Setting Up Organization Foundation Tables Chapter 11
You can tailor your PeopleSoft HRMS system for each of your users, controlling the default values that users
see on pages in the system.
Note. The TableSet Record - Group Control page regulates what users see on the prompt tables in PeopleSoft
HRMS. These defaults override the defaults that you set for these options on the Installation Table for this
permission list.
Alternate Character Select to enable alternate character searching for this permission list.
Enabled
Warning! The SetID field value that you select affects the business unit and SetID defaults for this
permission list throughout your PeopleSoft HRMS system.
314 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
See Also
Chapter 8, "Setting Up and Working with Languages," Working with Alternate Character Sets, page 193
Chapter 6, "Setting Up and Installing PeopleSoft HRMS," Administering Country Codes, page 151
Chapter 4, "Working with Regulatory Regions," Associating a Regulatory Region with a Transaction, page
31
You can tailor your PeopleSoft HRMS system for each permission list, thus controlling the default values that
users see on the system pages.
Industry Select Government if this is a U.S. federal government database. The default
value is Core .
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 315
Setting Up Organization Foundation Tables Chapter 11
Industry Sector Select US Federal if this is a U.S. federal government database. The default
value is Core .
Carry ID Select to carry the EmplID (employee ID) search key information across menus.
When you select this check box, the system uses the EmplID search key that you
are currently using on subsequent menus.
Note. You must select an Industry of Government and an Industry Sector of US Federal to fully use U.S.
federal government functionality in your database. In addition, you need to select Federal on the Installation
Table - Products page (ISTALLATION_TBL1).
Payroll System Select the default payroll system. When you select a payroll system on a table or
page in PeopleSoft HRMS, the system displays North American, Global, or
neither one based on the choice you enter here for this permission list. The user
can override this default, as necessary.
Default Standard Hours The default is 40 hours. The value that you enter here affects how the human
resources system calculates FTE (full-time equivalency) for workers and affects
compensation processing.
Standard Work Period Select a standard work period. The standard work period is the time period in
which workers must complete the standard hours. The system uses the
annualization factor of the standard work period in combination with the default
standard hours to calculate FTE (full-time equivalency).
Minimum Standard Enter the default minimum and maximum standard hours for this SetID. The
Hours and Maximum value that you enter affects how the human resources system calculates FTE for
Standard Hours workers and affects compensation processing.
(CAN) Canada
Canadian Census Select from the metropolitan areas defined on the Translate table.
Metropol Area
(Canadian census
metropolitan area)
Canadian Industrial Select from the list of values on the Translate table.
Sector
Note. (CAN) These values affect Canadian regulatory reporting in PeopleSoft Human Resources.
316 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 11 Setting Up Organization Foundation Tables
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(CAN)
Meeting Regulatory Requirements for Canada."
See Also
Chapter 6, "Setting Up and Installing PeopleSoft HRMS," Setting Up Implementation Defaults, page 129
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 317
Chapter 12
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 319
Setting Up Personal Information Foundation Tables Chapter 12
Country The system displays the country code you entered to access the page. Define
citizenship status codes for this country.
Status Enter the citizenship status code that you want to define. Enter as many
citizenship codes as needed.
320 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 12 Setting Up Personal Information Foundation Tables
All countries track some form of national ID for payroll, identification, or benefits purposes. For example,
German workers are assigned a Social Insurance number, UK workers have a National Insurance number, and
U.S. workers have a Social Security number. Each type of national ID has unique formatting requirements.
When you select a country code on any global page where you are entering a national ID, the system refers to
the information defined on this page to enter a default national ID type (if selected) or to ensure that you
select a valid one. The system also validates the national ID you enter against the format you specify here. If
you don't enter the correct number of digits or letters for a country's national ID, the system displays a
warning message.
For example, when you enter national ID information for a new American person on the Biographical Details
page the system uses the information set up on the National ID Type Table page to determine the valid
national ID types for USA and enters PR as the default. It will validate the data you enter to make sure it
matches the specific value types you set up for the National ID Type Format and format the data entered, if
necessary. In this example, the system will reformat an entry of 999999999 to 999999999.
Note. Application pages containing the National ID field perform an additional system check to determine the
proper display by referring to the User Defined File (UDF) format. Specify these formats in PeopleSoft
Application Designer.
Note. The PeopleSoft application delivers the National ID Type table with the proper types for the supported
countries.
Note. (GBR) Use the NID Prefix GBR page to define valid national insurance prefixes. The Inland Revenue
requires that employers' year-end reporting contain valid national insurance prefixes only.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 321
Setting Up Personal Information Foundation Tables Chapter 12
See Chapter 17, "Setting Up Local Country Functionality," (GBR) Setting Up National Insurance Prefixes for
the U.K., page 457.
Note. (CAN and USA) The delivered proper national ID type for Canada and the United States is PR (which
corresponds to the Canadian Social Insurance Number and the American Social Security Number,
respectively). You cannot delete this value because it is required for payroll processing.
Note. (DEU and JPN) Users in Germany and Japan aren't required to enter national ID data for workers, so
PeopleSoft created a default value of NO .
NID Type (national ID Enter the types of national IDs you will use to identify people (for example,
type) employees, dependents, and applicants).
If you do not require a national ID type for a country, create a value of NO and
leave the National ID Format field blank. National ID Type is often a required
field on other PeopleSoft HRMS pages and this gives you a value to enter for
individuals from this particular country.
Default Select to have the system use this NID Type as the default national ID type for
individuals from this country. You do not have to designate a default national ID
type for a country but without a designated default users will need to specify a
type every time they enter a national ID in the system.
National ID Format Indicate the default format for the national ID. Use the following values:
X or Z when the user can enter an alphanumeric or blank value.
A and any lower case letter when the user must enter a letter.
If you leave this field blank, users can enter any value (or no value at all) for
this national ID type.
Note. In addition to the general formatting you set up here, PeopleCode record
logic performs special data validation on BEL, BRA, CAN, CHE, FRA, GBR,
MEX, NLD, USA, DEU, ESP, MYS, and ITA national IDs.
NID as Stored (national Shows how the NID is stored in the system. Match this value to the field display
ID as stored) formats in the Application Designer.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Adding a Person in
PeopleSoft Human Resources," Entering Name and Biographical Data
322 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 12 Setting Up Personal Information Foundation Tables
This section provides an overview of additional name information and discusses how to:
If you're managing a European workforce, you can track additional standard naming conventions for
Germany and the Netherlands, such as the royal name prefix von for German workers. You can also track
formal titles such as professor, doctor, or count. These tables provide you with a flexible method for tracking
a wide variety of naming conventions in your human resources system.
Name Format Tbl NAME_FORMAT_TBL Set Up HRMS, Foundation Define name format types
Tables, Personal, Name to use on name pages
Format Types, Name throughout HRMS.
Format Tbl
Name Type NAME_TYPE_TBL Set Up HRMS, Foundation Define name types and the
Tables, Personal, Name order in which they are
Type, Name Type available.
Name Prefix NAME_PREFIX_TABLE Set Up HRMS, Foundation Enter name prefixes that
Tables, Personal, Name you'll use when you record
Prefix, Name Prefix name information.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 323
Setting Up Personal Information Foundation Tables Chapter 12
Name Suffix NAME_SUFFIX_TABLE Set Up HRMS, Foundation Enter name suffixes to use
Tables, Personal, Name to record name information.
Suffix, Name Suffix
Royal Name Prefix NM_ROYAL_PREFIX Set Up HRMS, Foundation Enter royal prefixes and
Tables, Personal, Royal descriptions. Royal Name
Name Prefix, Royal Name Prefix codes are used
Prefix primarily for Germany and
the Netherlands. When you
enter names for workers in
the Personal Data pages,
you can reference these
standard name prefixes.
Royal Name Suffix NM_ROYAL_SUFFIX Set Up HRMS, Foundation Define royal suffixes. The
Tables, Personal, Royal Royal Name Suffix
Name Suffix, Royal Name application is used only by
Suffix Germany and prompts with
DUEVO standards. When
you enter names in the
Personal Data pages, you
can reference these standard
Royal Name Suffixes.
Name Title TITLE_TBL Set Up HRMS, Foundation Enter titles for use with
Tables, Personal, Name names.
Title, Name Title
Track standard titlesfrom
professor to mijnheer
for names in your human
resources system.
324 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 12 Setting Up Personal Information Foundation Tables
Order by Enter the order in which the system should make this name type available.
Name Type CD (name Enter a code for the name type, the full name type name, and a short version of
type code), Name Type, the name type.
and Short Name
Note. You cannot edit the Primary and Preferred name types because they are system data.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 325
Setting Up Personal Information Foundation Tables Chapter 12
Name Prefix Enter the name prefix you want to add. When you enter names for people in the
Personal Data pages, you can reference these standard name prefixes.
The system displays the prefixes you enter here as part of the person's name.
Note. Name prefixes aren't effective-dated, nor do they have a status associated
with them.
Name Suffix Enter the name suffix you want to add. When you enter names for people in the
Personal Data pages, you can reference these standard name suffixes.
Short Description and Descriptions you enter for the prefix appear on the page as part of the person's
Description name.
Note. Name suffixes aren't effective-dated, nor do they have a status associated with them.
326 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 12 Setting Up Personal Information Foundation Tables
Certified By Displays the value you selected when you accessed the page: DUEVO for
German prefixes or NEN for Dutch prefixes.
Status Royal Name Prefixes aren't effective-dated, so to retire a prefix code, change the
status to Inactive.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 327
Setting Up Personal Information Foundation Tables Chapter 12
Certified By The system displays the value you selected to access the page: DEUVO for
German prefixes or NEN for Dutch prefixes.
Status as of Effective Royal Name Suffixes aren't effective-dated, so to retire a suffix code, change the
Date status to Inactive.
328 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 12 Setting Up Personal Information Foundation Tables
Address Type ADDR_TYPE_TBL Set Up HRMS, Foundation Enter address types and the
Tables, Personal, Address order in which they are
Type, Address Type available.
Order by Enter the order in which the system should make this address available.
Addr Type CD (address Enter a code for the address type, the full address type name, and a short version
type code), Address of the address type.
Type, and Short Type
Note. You cannot edit the Home, Mailing, Business, and Check address types because they are system data.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 329
Chapter 13
Setting Up Jobs
This chapter discusses how to:
Classify jobs.
This section provides an overview of job subfunction codes and function codes and discusses how to set them
up.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Profiles, "Managing Profiles"
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 331
Setting Up Jobs Chapter 13
Job Subfunction JOB_SUBFUNC_DEFN Set Up HRMS, Foundation Set up and define job
Tables, Job Attributes, Job subfunction codes.
Subfunction, Job
Subfunction
Job Function JOB_FUNCTION_TBL Set Up HRMS, Foundation Set up and define job
Tables, Job Attributes, Job function codes. Define the
Function, Job Function relationship of subfunctions
to job functions.
332 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
(ITA) Italy
INAIL Code ( Istituto The INAIL code classifies jobs according to the level of risk that is associated
Nazionale per with the job and the related insurance that is required by the employer.
l'Assicurazione contro gli
Infurtuni sul Lavoro code)
This section provides an overview of job families and discusses how to group jobs into families.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 333
Setting Up Jobs Chapter 13
Job Family Table JOB_FAMILY_TABLE Set Up HRMS, Foundation Create job families.
Tables, Job Attributes, Job
Family Table, Job Family
Table
Important! The job family effective date must be effective as of the relevant job code effective dates.
Classifying Jobs
To classify jobs, use the Job Code Table component (JOB_CODE_TBL). Use the CI_JOB_CODE_TBL
component interface to load data into the tables for this component.
This section provides an overview of job codes and discusses how to:
Associate salary plan information and base pay rate codes with a job code.
When you save a job code, the system creates a rate code defaulting rule for the salary step, with the Rate
Code Source Indicator equal to the job code. The system uses rate code defaulting rules (instead of the Job
Code and Salary Step setup tables) for the compensation defaulting.
334 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
In HRMS, job codes are different from positions: Within a single job code, you can have a number of
positions. For example, you can have a job code representing Administrative Assistant, and within that job
code, you can have different Administrative Assistant positionsone in your Marketing department, one in
Research, and one in your Compensation group. You use positions to track details on a particular job in a
particular department or location. Positions usually have a one-to-one relationship with workers. Job codes
have a one-to-many relationship with workers.
You still use job codes to create general groupings or job classifications in your organization if you drive
PeopleSoft Enterprise Human Resources by position in your organization, . You then use the Job Code
groupings as the basis for default job data for positions.
Note. If you use PeopleSoft Enterprise Pension Administration, set up jobs, and not positions, for your
pension payees. You can use Manage Profiles to set up profiles for your job codes.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Profiles, "Managing Profiles."
The Job Code field on the Job Details page of Job Requisition Data is a required field. If your organization
has adopted a human resources management system based on capability grade, you may not want to associate
a job code with your job requisitions. However, to satisfy the requirements of that page, you need to have a
dummy job code that you can enter in the Job Code field. The dummy job code has no processing associated
with it. The Job Code Profile page, on which you create the dummy code, has only six required fields, but of
these fields, five take default values, so you need to enter only a Job Title. We recommend using a job title
that clearly indicates that this is a dummy job code.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions"
Job Code Profile JOBCODE_TBL1_GBL Set Up HRMS, Foundation Add new job codes to the
Tables, Job Attributes, Job system and define job
Code Table, Job Code family, compensation, and
Profile regulatory information for
each job code.
Business Units by Job Code JOBCODE_BU Click Business Units that View all business units
use this Set ID link on the associated with the SetID
Job Code Profile page. for this Job Code.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 335
Setting Up Jobs Chapter 13
Evaluation Criteria JOBCODE_TBL2_GBL Set Up HRMS, Foundation Assign points to certain job
Tables, Job Attributes, Job evaluation criteria. You can
Code Table, Evaluation use this information to rank
Criteria job codes in your company
and to assess salary grades,
steps, and exempt and
nonexempt categories for
personnel.
Market Pay Match JOBCD_MP_SAL_SURV Set Up HRMS, Foundation Associate a market pay
Tables, Job Attributes, Job matrix to a specific job
Code Table, Market Pay code.
Match
336 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 337
Setting Up Jobs Chapter 13
338 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Job Code A unique code that you associate with a specific job in your organization.
Key Job Code Select this check box if it is a key job for your organization's succession
planning.
(USF) Occupation Select from the list. This fields are available on the federalized database for users
Series, Official Posn authorized to view federal information.
Title Code (official
position title code), and
Organization Posn Title
Cd (organization position
title code)
Job Function Code Select the code that best categorizes the job by function, such as administrative,
legal, or management.
Job Subfunction Select the code that best categorizes the job's subfunction.
Job Family Select a job family to categorize a job code into a more general grouping. For
example, you might group a trust analyst and an operations analyst into a job
family called Analyst.
Standard Hours Enter the default number of hours in a standard work period for this job. The
Standard Hours value that you enter on this page becomes the default for all
workers who are associated with this job code. You can modify the standard
hours for an worker on the worker's Job Data pages (JOB_DATA).
The value that you assign for Standard Hours must fall between the minimum
standard hours and the maximum standard hours defined in the Primary
Permission List Preferences table. If no minimum standard hours and maximum
standard hours are defined on the Primary Permission List Preferences table, the
system uses the values on the Installation table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 339
Setting Up Jobs Chapter 13
Standard Work Period Select the time period in which workers must complete the standard hours.
Maintain these values in the Frequency Table page (FREQUENCY_TBL).
The system uses the annualization factor of the standard work period in
combination with the standard hours to calculate FTE (full-time equivalency).
See PeopleSoft Enterprise Human Resources PeopleBook: Enterprise
Components
Workers' Comp Code Enter a code to specify the workers' compensation plan to which this job code
(Workers' Compensation belongs.
code)
Manager Level Select the level of management associated with the employee.
Comp Freq Select the frequency in which the compensation is quoted. The default value is
(compensation frequency) the frequency that you specified on the Installation table
Medical Checkup Select if this job code requires a onetime medical checkup when the worker is
Required hired into the job.
Note. If you're tracking a German workforce, also indicate whether the job
requires ongoing medical surveillance in the Job Code Profile section for local
German functionality, especially if the worker comes into contact with hazardous
conditions or materials on the job.
Union Code If you're defining a job code that is associated with a union, select a union code.
Define union codes as a part of the Manage Labor Relations business process in
PeopleSoft Human Resources.
(SGP) Singapore
Festive Advance Pay If you set up one or more festive advance pay programs that each cover all the
Program festive holiday types (using the Festive Advance Pay Program page), associate a
default festive advance pay program with a specific job code here.
The program details for each festive holiday can be the same or different from
each other. One pay program can have many festive holiday types and can be
associated with many combinations of earnings elements, deduction elements,
and probation periods.
This job code, in conjunction with the ethnic group and religion, are responsible
for the defaults on the FA Employee Details (SGP/MYS) page.
340 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
(CAN) Canada
BPS Activity (Business If you are participating in the Statistics Canada Business Payrolls Survey, select
Payrolls Survey activity) the job code's business activity.
Report Flag Select the appropriate option if the job code is to be reported in one of the
Statistics Canada Academic Teaching Surveys.
This field is for Canadian higher education degree-granting institutions only.
Duties Indicate whether the duties of the job code consist of Teaching only, Teaching &
other resp (teaching and other responsibilities), or Research. This field is
required if you selected the Report Flag check box.
This field is for Canadian higher education degree-granting institutions only.
Province Enter the province that you report to when you perform WCB (Workers'
Compensation Board) reporting for this job code. WCB reporting in Canada is
always done at the provincial level; there is no national WCB level.
Rate Group Select a rate group for this job code. Each industry is assigned a rate group for
assessment purposes, based on the type of industry and the accident/injury level
in that industry in that province.
Classification Select a WCB classification for this job code. The classification indicates the
industry that applies to this job code.
Note. The rate groups and classifications can be obtained from your provincial
WCB. The rates and rate codes may vary from province to province.
(DEU) Germany
Medical Surveillance Select if ongoing medical surveillance is required for this job code. For instance,
Required some jobs require workers to be in contact with hazardous materials, and health
and safety regulations require that workers receive periodic medical checkups as
long as they are in that job.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 341
Setting Up Jobs Chapter 13
UK SOC Code (United Enter the appropriate UK Standard Occupational Classification code. This code
Kingdom Standard is required for Northern Ireland Fair Employment reporting.
Occupational
Classification code)
(ITA) Italy
INAIL Code Select the job code's INAIL code from the list of options. This code classifies
jobs according to the level of risk that is associated with the job and the related
insurance that is required by the employer.
(MYS) Malaysia
Number of Hours in a Enter the standard workday hours that are used for payroll and leave calculations.
Work Day
Festive Advance Pay If you set up one or more festive advance pay programs that each cover all the
Program festive holiday types (using the Festive Advance Pay Program page), associate a
default festive advance pay program with a specific job code here.
The program details for each festive holiday can be the same or different from
each other. One pay program can have many festive holiday types and can be
associated with many combinations of earnings elements, deduction elements,
and probation periods.
This job code, in conjunction with the ethnic group and religion, are responsible
for the defaults on the FA Employee Details (SGP/MYS) page.
(USA) USA
EEO Job Categories Select a job category. The EEO-1 code is also the Federal Occupation Category
(FOC).
To retrieve valid job codes for EEO-1 reporting, select a EEO-1 job category that
is not equal to No EEO-1 Reporting.
Standard Occupational If your company has operations in Alaska, you can enter a Standard Occupational
Classif (Standard Classification (SOC) code for use in unemployment insurance reporting. You
Occupational enter U.S. SOC codes in the U.S. Standard Occupational Classification Table.
Classification)
EEO Job Group To further classify the job categories, enter the EEO job group to which this job
belongs.
342 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
FLSA Status (Fair Labor Enter a code to indicate whether this job is exempt or nonexempt according to the
Standards Act status) FLSA. This value becomes the default for the FLSA status on all worker job
records that are associated with this job code. Example values are
Administrative, Executive, Nonexempt, and Professional.
Available for Telework Select if this location allows workers to work remotely.
(AUS) Australia
Note. You set up package templates on the Package Template page. You set up
package rules on the Package Rule page.
These fields are available when you select the Australian Public Service box on the Country Specific page of
the Installation component.
Job Function Select the default job function for the organization.
Type of Work Select the default type of work performed for the organization.
Performed
Annual Contact Hours Enter the number of contact hours. This depends on the type of work performed.
See "Determining Contact Hours" to calculate this value.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 343
Setting Up Jobs Chapter 13
(BRA) Brazil
Brazilian Occupation Enter the appropriate Brazilian Code of Occupation (CBO - Cdigo Brasileiro de
Cd (Brazilian occupation Ocupaes) from the official table.
code) Codes effective before December 31, 2002 should be in the format 99999. Codes
effective from January 1, 2003 onward should be in the format 999999.
(USF) US Federal
These fields are available when you work in a federalized (U.S. Federal) database:
344 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Override NFC Indicator Select this check box to override the value in the NFC Update Indicator field.
NFC Update Indicator Status of the transaction in relation to NFC, as maintained by the user or system.
Options in this field include:
In Process This Jobcode has been run through the export program and will
be sent to NFC.
Not Ready User intends to exclude this Jobcode from export to NFC.
Ready User intends to include this Jobcode in the next NFC export.
SINQ This Jobcode has not successfully passed NFC's PINE Edits and
needs correction.
NFC Function Code Identifies the task to be performed by NFC on a master record. Options in this
field include Add,Change,Delete,Inactivate, and Reactivate.
Bargaining Unit If the job code is associated with a union, select a bargaining unit.
Pay Basis Enter the pay basis for which you quote salaries for this job code; for example,
Per Annum, Per Hour.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 345
Setting Up Jobs Chapter 13
Classification Factors The system displays the classification authority and the classification factors that
are associated with the classification standard.
Factor Level Enter a classification factor level for each classification factor that is associated
with this classification standard.
Points, Grade Points, The system displays the points that are associated with the classification
and Total Points standard.
Weight (%) The system displays the weight percentage of the points that are associated with
the classification standard.
OPM Certification Nbr Enter the OPM certification number that is associated with this job code.
(office of personnel
management certification
number)
Position Classification Enter the position classification standards that are used.
Stds (position
classification standards)
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Festive Advance, "Setting Up Festive
Advances"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Salary Packaging, "Setting Up Salary
Packaging"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Track Faculty Events, "(AUS) Reporting DETYA
for the Australian Higher Education Sector," Understanding DETYA Calculations and Reference Dates
346 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Knowhow Enter points that represent the worker's knowledge required to perform the job.
Accountability Enter points that represent the worker's ability to do the assigned job.
Problem-Solving Enter points that represent the worker's ability to work out solutions despite
obstacles.
Total Points You determine the points by comparing each of these factors to every other job in
your company. The greater the know-how, accountability, and problem solving
for this job, the higher the points. For example, you would probably assign more
accountability points to a controller than to a secretary because the controller has
more responsibility.
The system calculates Total Points and the Percent, or relative importance, of
each factor. For example, if Knowhow receives 33.2 percent of the total points,
Accountability receives 33.7 percent, and Problem-Solving receives 33.1 percent,
then all three factors are almost equally important.
However, if Knowhow receives 54.4 percent of the total points, Accountability
receives 9.2 percent, and Problem-Solving receives 36.4 percent, then Knowhow
is of greater importance than Accountability or Problem-Solving, and
Accountability is of little significance.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 347
Setting Up Jobs Chapter 13
Used by Position Select if this job code is used by a position. If you specified full or partial
Management position management on the Installation Table, this check box is selected by
default.
A selected check box tells the system that you're budgeting for the job code at the
position level. It does not restrict your ability to attach positions to a job code or
attach workers to a job code. If this check box is deselected, you can still set up a
position with the job code. If the check box is selected, you can still enter the job
code on the worker's job data record.
When you deselect this check box, the Pre-Encumbrance Indicator and Encumber
Salary Option fields appear.
Pre-Encumbrance Indicate if you want the system to encumber this job code immediately
Indicator (Immediate), not at all (None), or upon requisition (Requistn).
Encumber Salary If you are using Commitment Accounting to encumber salaries, the system uses
Option the option that you select to determine the salary amount when it encumbers the
salaries of vacant positions.
Encumber Salary If you select User Specas the Encumber Salary Option, enter the salary amount to
Amount encumber.
(FRA) France
Employee Category Select the employee category for the job code. This code is required for these
statutory reports:
Personal Register
INSEE Code (National Link this job code to an INSEE code for use in the French Disability report.
Institute for Statistical and
Economic Studies code)
Job Category Code Select a job category code, required for the Single Hiring Statement report.
(DEU) Germany
348 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Job Type Select whether this job is public, private, or public private combination.
Contract Worker Select the salary grade table type and salary grade table that apply to contract
Compensation workers in this job.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage French
Public Sector, "Setting Up French Public Sector Tables," Setting Up Salary
Grades.
Job Outside Coll Lbor Select this check box if the job code is not covered by a collective labor
Agrment (job outside the agreement.
collective labor
agreement)
Regulatory Region Select the job code's regulatory region.
Note. Labor agreements are grouped by regulatory region. If you are assigning a
labor agreement to this job code, ensure that the regulatory region matches that of
the labor agreement.
Labor Agreement Select the labor agreement that covers this job code.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Labor
Administration, "Setting Up Labor Administration Data," Defining Labor
Agreements.
Labor Agreement Select the labor agreement category for this job code.
Category See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Labor
Administration, "Setting Up Labor Administration Data," Defining Labor
Agreement Categories.
Auto Hire Validation Select to have the system automatically validate the newly hired person's
qualifications with the job requirements.
Match Competencies Select to have the system match the competencies associated with this job code
with the qualifications of the person assuming the job.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 349
Setting Up Jobs Chapter 13
Training Program
Training Program You can associate a training program with this job code, which you'll find helpful
in career planning. When you set up training and development programs for
workers in this job code, you can use the default training program as the basis for
an individual career-training plan.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Setting Up Positions"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(FRA) Meeting
Regulatory Requirements for France"
Matrix Name Select the market pay matrix that you want to associate with this job code. The
effective date of the matrix must be less than or equal to the effective date of the
job code.
Edit Matrix Click this button to access the Data Content page where you can view and edit
values associated with this matrix. Any other job code linked to this same matrix
will be impacted as well.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Using Configurable Matrices"
Chapter 18, "Setting Up and Working with Market Pay," page 461
350 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Associating Salary Plan Information and Base Pay Rate Codes with a Job
Code
Access the Default Compensation page (Set Up HRMS, Foundation Tables, Job Attributes, Job Code Table,
Default Compensation).
By associating rate codes with job codes, you define default compensation packages that will be associated
with a worker's job record on the Job Information page.
Job Ratio
The job ratio calculates comparative salary information for workers who perform similar work activities in
countries where plan/grade/step data is used to support industrial tariffs. If you use plan/grade/step data for
job-related activities, you do not need to use the Job Ratio fields.
The worker's compensation rate (as specified on the Compensation page of the Job Data component) is
converted to the currency and frequency defined in the Job Ratio group box. The result is divided by the job
code midpoint salary.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 351
Setting Up Jobs Chapter 13
Minimum Salary, Enter the minimum, midpoint, and maximum salary amounts according to the
Midpoint Salary, frequency (which appears by default from the Job Code Profile page but can be
Maximum Salary, overridden here) that is available to this job code. Indicate the currency of the
Currency, and salary amounts if it is not the same as the default.
Frequency
If your company has established compensation programs, select the codes that represent the default salary
plan/grade/step for this job. You define these codes in the Salary Plan Table, the Salary Grade Table, and the
Salary Step Table.
Sal Plan/Grade/Step Select a salary plan, grade and step. Note that all three fields are optional. If you
do set defaults, the system populates the rest of the Salary Administration Plan
fields on the page and the Salary Step Components grid with hourly, monthly,
and annual midpoint pay rates that are associated with the grade.
When you assign a worker to a job code on the Job Information page
(JOB_DATA_JOBCODE), the system enters these values as a default on the
Salary Plan page (JOB_DATA_SALPLAN).
Note. If you have associated a salary plan with the location code assigned to the
worker on the Work Location page (JOB_DATA1), the system will use the
location salary plan as a default on the Salary Plan page instead of the job code
salary plan.
Military
Service Select the military service to which this job belongs. This becomes the military
service default value in Manage Positions when you associate this job code to a
position.
Rank Select the military rank to which this job is classified. This becomes the military
rank default value in Manage Positions when you associate the job code to a
position.
Select one or more rate codes that will make up default base compensation for this job code. The default
values for compensation rate, currency, and frequency come from the Rate Code Definition page, but you can
set different values if required.
Note. If a rate matrix is associated with the rate code, the compensation rate field will be unavailable. In this
case, the rate will be set dynamically based on employee data when this rate code is added to the employee's
compensation record.
352 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Details Click to review the description, comp rate type (compensation rate type), and rate
code class that are associated with the rate code.
Frequency The system displays the compensation frequency of the rate code as the default
frequency. Rate code frequency is defined on the Comp Rate Code Table page.
See Chapter 10, "Setting Up and Working with Frequencies," page 209.
Points The system displays the points that are associated with this rate code, if
applicable.
Percent If the rate code type for this rate code is Percent, the system displays the percent
that is to be applied to the job compensation rate or to a rate code group.
Apply FTE (apply full- Select to indicate that the compensation rate for this rate code is multiplied by the
time equivalency) FTE in calculating the job compensation rate.
Note. Column order for grids may vary by implementation. All columns may not be visible. Use the page's
horizontal scroll bar as necessary to view all the columns.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Setting Up Base Compensation and Budgeting"
The system doesn't use non-base pay rate codes as default values on any HRMS pages. The codes are used for
payroll processing.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 353
Setting Up Jobs Chapter 13
This section provides an overview of job tasks and discusses how to define job task codes.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Profiles, "Managing Profiles"
Job Tasks JOB_TASK_TABLE Set Up HRMS, Foundation Define job task outcomes.
Tables, Job Attributes, Job For example, if a job
Tasks, Job Tasks requires an worker to pick
up heavy boxes and move
them, then define moving
heavy boxes as the essential
job task. Because a worker
with a disability could use a
forklift to move them, do
not define the job task as
lifting heavy boxes.
Job Code Task Table JOBCODE_TASK_TABLE Set Up HRMS, Foundation Associated job tasks with
Tables, Job Attributes, Job each job code.
Code Task Table, Job Code
Task Table
354 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Total Percent Time The system calculates and displays this when you move out of the % Time Spent
Spent field. The total cannot exceed 100%.
Note. Once created, this information is particularly useful for discussing job
requirements with applicants. Although the ADA prohibits you from asking
applicants if they have disabilities, you can show them a job's task list and ask
them if they might have difficulties in completing the tasks. This way, you offer
the applicants the opportunity to describe their disabilities and any
accommodations that they need to perform the job tasks.
Jobtask Set ID Select a job task set ID from the available options. Valid values are stored on the
TableSet ID page.
Job Task Select a job task from the available options. Valid values are stored on the Job
Tasks page.
Imprtce (importance) Select the importance of the job task to the particular job code. Valid values are
in the Translate Table.
Freq (frequency) Enter how often the job task occurs for each job code. Valid values are in the
Frequency Table.
Cons (consequence) Select the result that occurs if the job task isn't performed. Valid values are in the
Translate Table.
% Time Spnt Enter the percentage of time that is spent on the job task.
(percentage time spent)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 355
Setting Up Jobs Chapter 13
This section provides an overview of pay groups and discusses how to:
While pay groups may seem specific to payroll processing, you also need this information for Human
Resources, to set up job records and benefit programs. Many of the default field values on the Administer
Workforce pages are based on the pay group values that you specify on the Pay Group Table component
(PAYGROUP_TABLE). Set up at least one pay group for each company that you established in the Company
component (COMPANY_TABLE) or the Agency USF component (AGENCY_TABLE) for U.S. federal
users.
See Chapter 11, "Setting Up Organization Foundation Tables," Entering Company Information, page 243.
See Chapter 11, "Setting Up Organization Foundation Tables," (USF) Entering Agency Information, page
271.
Where you set up your pay group depends on which payroll application you use:
If you use PeopleSoft Payroll for North America, use the Pay Group table pages discussed in this section
as well as additional pages of the Pay Group table that are documented in the PeopleSoft Enterprise
Payroll for North America PeopleBook.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Pay Groups."
If you use PeopleSoft Payroll Interface, use the Pay Group Table pages discussed in this section as well as
additional pages of the Pay Group table that are documented in the PeopleSoft Enterprise Payroll
Interface PeopleBook.
See PeopleSoft Enterprise Payroll Interface 9.1 PeopleBook, "Setting Up Payroll Schedules."
356 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
If you use PeopleSoft Global Payroll, use the Pay Group component in that application.
See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook, "Defining the Organizational Structure,"
Defining Pay Groups.
If you are not using a PeopleSoft payroll application, use the Pay Group table pages discussed in this
section.
If you use PeopleSoft Pension Administration, also set up pay groups for your pension payee companies.
Pension Administration doesn't use pay groups for paying pension benefits.
Note. If you use more than one payroll application (for example, Payroll for North America and Global
Payroll), set up the pay groups required for both applications. Otherwise, set up only the pay groups required
for the application you are using. The company and pay group keys must be unique to the payroll application;
do not use the same combination of keys for multiple payroll applications.
The Pay Group Table component consists of nine pages. For Human Resources, enter information only on the
first three pages of the component, because that information is used across all HRMS applications. The last
six pages in the component are used with Payroll for North America, and to a lesser extent, with Payroll
Interface.
Definition PAYGROUP_TABLE1
Set Up HRMS, Product Set up and describe pay
Related, Payroll for groups.
North America, Payroll
Processing Controls,
Pay Group Table,
Definition
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 357
Setting Up Jobs Chapter 13
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Pay Groups"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Salaries for the Netherlands, "Setting
Up Administer Salaries for the Netherlands," Creating and Maintaining Pay Groups
358 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Definition page
Pay Group The Pay Group value that you specified in the entry dialog box is displayed.
Note. On employee job records, the Pay Group default is from the company
level.
Set ID Select a set ID for the shift table used by the employees in this pay group. For
pay groups that don't use a shift table, use a generic set ID.
Retiree Pay Group Select for a separate retiree pay group. PeopleSoft recommends keeping retirees
in their own pay group. There is no processing associated with this check box.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 359
Setting Up Jobs Chapter 13
Note. You must enter a value for Payroll Interface. If the PI Configuration ID is
not set up correctly, payroll processing in Payroll Interface will not function
properly. Refer to the PeopleSoft Enterprise Payroll Interface PeopleBook for
more information.
Deduction Priority Enter a deduction priority number for your pay group. The deduction priority is
used for multiple job employees when the single check option is not selected for
a company.
Employee Type Default Select the most common employee type within the pay group. The system uses
this value as the default for the pay group's employee job records. The default
you enter on this page is edited against the Benefit Program table. You need
either to set up that table first or leave this field blank for now. Values are as
follows:
Salaried: Select for employees whose earnings are based on an amount per
pay period, rather than accumulated hours. You can still enter exceptions on
the pay sheets.
Hourly: Select for employees who don't work the same number of hours each
pay period. Typically, an hourly employee requires positive time reporting. In
this case, you enter the hours worked on the pay sheets.
Exep Hrly (hourly exceptions): Select for employees who work a set number
of hours each pay period. Enter only exceptions to their schedule on the pay
sheets.
(CAN) Wage Loss Plan Specify a wage loss plan default value for the pay group. This default value
Default assigns employees the appropriate wage loss plan on the Canadian Income Tax
Data page whenever the system automatically creates employee tax data records.
Frequency
Daily Select the frequency used by Payroll for North America to calculate the daily pay
rate. Only frequencies on the Frequency table with a frequency type of daily are
available for selection.
360 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Monthly Select the frequency used by Payroll for North America to calculate a monthly
pay rate. Only frequencies on the Frequency table with a frequency type of
monthly are available for selection.
Rate Type Select the appropriate value from the list provided.
Conv Date (conversion Values are Check Date, Pay End Date, and Today's Date.
date)
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Defining Deductions," Setting Up
Deductions
Chapter 10, "Setting Up and Working with Frequencies," Understanding Frequency in Payroll for North
America, page 222
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 361
Setting Up Jobs Chapter 13
You establish options on this page before you assign employee types on employee records. For example, you
might want to group only salaried employees in your monthly pay group and group hourly and exception
hourly employees in a biweekly pay group.
Continue With Errors Select to enable the Pay Confirmation process to proceed even if the Pay
Calculation process encounters nonfatal calculation errors. The system moves the
paysheets in error to a designated off-cycle calendar to be corrected in a separate
off-cycle run.
Note. All pay groups attached to a single pay run ID must have the same setting
in the Continue With Errors option on this page. If this condition is not met, the
system cannot transfer any errored paysheets for the pay run ID.
Error Pay End Date This value is used by the Pay Calendar build process to set up the pay calendar.
Option Select the date of the off-cycle calendar to which erred paysheets are moved.
If you select Next Day, the Pay Calendar Creation process creates one cycle pay
calendar for each on-cycle pay calendar that is created. The pay end date for the
off-cycle calendar is one day after the pay end date for the on-cycle pay calendar.
For example, if the pay end date for the on-cycle calendar is May 31st, the pay
end date for the off-cycle calendar is June 1st.
Warning! If you enter your own end date, you must ensure that a pay calendar
has been built for that date before attempting to calculate transferred pay lines.
362 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Processing Control
Industry Sector Select None, Core, Public Sct (public sector), or US Federal.
Employee Type Select the optionsHourly, Exception Hourly, or Salariedthat are valid for
this pay group. If you use PeopleSoft Payroll for North America, you also need to
designate payroll processing parameters. Otherwise, for employees being paid
with PeopleSoft Payroll for North America, leave Print Paysheets selected as the
default.
Note. If a specific employee type is not defined on a pay group, a user can't set
up that type of employee. For example, if a pay group does not have an employee
type of salaried, when an employee is hired, the user can't enter S as the
employee type on job.
Print Paysheets If you are using PeopleSoft Payroll for North America, select this check box if
the employees in this employee type should always be included when printing
paysheets. Employee types for which this check box is deselected still appear on
the paysheet pages.
Note. You must check this box if either of the confirmation required check boxes
is selected.
Confirmation Required If you are using PeopleSoft Payroll for North America, select this box to deselect
for Job Earnings on the OK to Pay field on the paysheets by default. OK to Pay tells the system
Paysheet whether to pay an employee or place the record on hold until you review it. Pay
Calculation, in turn, processes only those employees who have OK to Pay
selected. If you select this option, Print Paysheets must also be selected.
Typically, hourly employees require some sort of positive time input to get paid.
For this reason, you might say that confirmation is required. Once you enter their
time on the paysheets, you manually select OK to Pay to permit them to be paid.
For exception hourly and salaried employees, you usually enter exception time
only as required. Therefore, you might indicate that confirmation is not required.
These employees automatically get paid their regular salary or hours each pay
cycle, because the paysheets are created with the OK to Pay check box selected.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 363
Setting Up Jobs Chapter 13
Confirmation Required If you are using PeopleSoft Payroll for North America, select this box to control
for Partial Pay Period the OK to Pay check box on the paysheet. Whenever there is a mid-period
on Paysheet change on the Job recordan employee is hired, is terminated, or changed jobs
or pay ratesthe system creates partial pay period records due to proration.
Typically, if you prorate pay, you should deselect this check box to tell the
system that confirmation is not required and to select OK to Pay on the paysheet.
If, on the other hand, you want to manually verify the proration for employees,
select this option. You can adjust the pay on the paysheets and click the OK to
Pay check box. If you select this option, Print Paysheets must also be selected.
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Working with Paysheets"
364 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Earnings Program ID Select a default value for the employee records in this pay group. Earnings
Program IDs are set up using the Earnings Program Table component
(EARNS_PROGRAM_TBL) in either Payroll for North American or Payroll
Interface. You must set up that component first or leave this field blank for now.
Pay Plan (USF) Select the pay plan to assign to this pay group.
Holiday Schedule Select the holiday schedule for the pay group. If you left the Holiday Schedule
field blank on the Location Profile page, the system uses the holiday schedule
you specify on this page as the default for the worker's job record. You must set
up the Holiday Schedule table before making a selection or leave this field blank
for now.
Note. In Payroll Interface, if you want the third-party payroll system to process
holiday pay, on the Holiday Schedule component set up a holiday schedule called
NONE.
Default Benefit Program Select the default benefit/deduction program for the pay group. The system uses
this default benefit/deduction program as the default for the employee's job
record. The default you enter on this page is edited against the Benefit/Deduction
Program Table in the Benefits menu. You must set up that table first, or leave
this field blank for now.
Retro Pay Program ID Select a retro pay program to associate with the pay group. The retro pay
program identifies the earnings codes used in retro pay calculations.
In each retro pay program, you list earnings codes that are eligible for retro pay,
and for each of these earnings codes, you specify the earnings code to be used for
paying the retro pay earnings.
You define retro pay programs in the Retro Pay Program component.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting
Up the Payroll Process," Defining Retro Pay Programs.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 365
Setting Up Jobs Chapter 13
Retro Pay Trigger Select a retro pay trigger program to associate with the pay group. The retro pay
Program ID trigger program controls which record and field changes (on the job record and
the additional pay data record) create retro pay requests. The retro pay
calculation process then processes these requests to determine how much, if any,
retro pay is to be paid because of the changes.
You define retro pay trigger programs in the Retro Pay Trigger Program
component.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting
Up the Payroll Process," Defining Retro Pay Trigger Programs.
Note. Releases before PeopleSoft Payroll for North America 9.1 generated retro
requests using PeopleCode rather than retro pay trigger programs. When you
upgrade from one of these earlier releases, use correction mode to enter retro pay
trigger programs for the current and history rows on this page. You cannot save
changes to this component if there are any rows that have a retro pay program but
no retro pay trigger program.
Final Check Program ID To specify a default final check program for the pay group, select the final check
program ID that identifies the earnings, deductions, and accruals to be used in
final check processing for the pay group.
FLSA Required (USA) Select this check box if FLSA regulations are to be applied to this pay
group. When you select this check box, the FLSA Period Definition button
appears. If you do not select this check box, the button does not appear and you
cannot define FLSA pay periods.
FLSA is for U.S. Payroll only; this check box appears on the page if you have
enabled FLSA processing on the FICA/Tax Details page (access through the
Company Table Default Settings page) and on every pay group when
applicable.
Note. If FLSA is not selected for a company, it cannot be selected for a pay
group within that company. After it has been selected at the company level, it
does not have to be selected at the pay group level. However, if FLSA is required
for a pay group, it must be selected at both the company and pay group levels.
Note. (USF) If FLSA is required for a whole agency or for most pay groups in an
agency, you should deselect the FLSA Required check box and define FLSA
requirements on the Agency Table. Remember that if the FLSA Required check
box isn't selected on the Agency Table, the FLSA Rule for a pay group is set by
default to Higher of FLSA Contractual.
Note. When setting up pay groups, do not use the same pay group ID in two
separate companies if the companies use different overtime earnings codes for
FLSA.
FLSA Period Definition (USA) Click to access the FLSA Period Definition page.
366 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Earnings
Use this group box to define earnings codes for each earnings type.
Regular Hours Select the appropriate earnings code for the regular hours earnings type.
Overtime Hours Select the appropriate earnings code for the overtime hours earnings type.
(overtime hours earnings
type)
Regular Earnings Select the appropriate earnings code for the regular earnings type.
Holiday When the system creates paysheets and detects that a holiday falls within the pay
period, it uses the earnings code associated with this field. If Holiday Type on the
Holiday Schedule Table is Canadian, the system uses this earnings code to set up
the statutory holiday earnings on the paysheet.
Note. (USF) The system does not enter the holiday earnings code on the paysheet
if the employee is in a nonpay status for the entire pay period.
Refund Enter the earnings code used to refund money to employees who cancel U.S.
Savings Bond elections or whose purchases are suspended due to the annual
purchase limit.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Defining
Earnings Codes and Earnings Programs," Entering Special Options and Tax
Methods for Earnings Codes.
(USF) US Federal
Nonpay Hours Enter the earnings code to be entered on the paysheets when the system detects
that an employee is on leave without pay or short or long-term disability for an
entire pay period.
Note. Nonpay hours are included on paysheets only if the employee is in nonpay
status for the entire pay period.
Interest Earnings Code Enter the earnings code used to pay interest on retroactive payments that are over
30 calendar days late.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook,
"Processing Retro Pay," (USF) Managing Interest Calculations on Retro Pay.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 367
Setting Up Jobs Chapter 13
See Also
Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Holiday Schedules, page 233
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up the Payroll Process," Setting
Up Retro Pay Processing
The FLSA Period Definition page changes, depending on which options you select. The following table
shows which fields are visible on the page, depending on the FLSA Period Definition you select:
FLSA Period FLSA Salaried Use Basic FLSA FLSA Period FLSA
Definition HRS Use: Formula Calendar ID in Days Threshold
Unspecified or Hours
Fixed
Fixed FLSA X X X X
Period with
Fixed Salaried
Hrs selected
and Use Basic
Formula clear
368 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
FLSA Period FLSA Salaried Use Basic FLSA FLSA Period FLSA
Definition HRS Use: Formula Calendar ID in Days Threshold
Unspecified or Hours
Fixed
Fixed FLSA X X
Period with
Fixed Salaried
Hrs selected
and Use Basic
Formula
selected
Fixed FLSA X X X
Period with
Unspecified
Salaried Hrs
selected
Law X X X
Enforcement
Fire Protection X X X
If you select Fixed FLSA Period, the period can only be for 7 or 14 days. There
are no FLSA Threshold Hours for employees in the Fixed FLSA Period, because
threshold hours only apply to law enforcement and fire protection employees.
Fixed Salaried Hours Select this option to use the standard hours you entered on the employee's Job
record. If you select this option, the Use Basic Formula check box appears.
Use Basic Formula If you select this check box, the FLSA Calendar ID and FLSA Period in Days
check boxes disappear. Basic formulas are used only for monthly and semi-
monthly pay periods. The FLSA period is assumed to be the same as the Pay
Calendar period; hence, no FLSA Calendar ID is required. If you select this
check box, you must enter information into the Work Day Hours field on the Job
Information page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 369
Setting Up Jobs Chapter 13
Unspecified Salaried Select this option to use the actual number of hours worked per week by salaried
Hours employees to determine their FLSA rate.
FLSA Calendar ID Select a FLSA calendar ID. The FLSA calendar ID is linked to the FLSA Start
Date and FLSA Period in Days fields on the FLSA Calendar Table page, which
are used to define the FLSA begin and end dates. Hence, the pay group uses the
FLSA Calendar ID to define the FLSA periods. This field is not applicable if you
select Basic Rate Formula. If you select Fixed FLSA Period, the prompt list
contains only FLSA Calendar IDs with 7 or 14 FLSA Periods in Days. For Fire
Protection or Law Enforcement, the prompt list contains FLSA Calendar IDs
from 7 to 28 days.
FLSA Period in Days The length of the FLSA pay period, or the days from the FLSA Begin Date to the
FLSA End Date. The system displays it automatically. It is based on the FLSA
Period in Days you define on the FLSA Calendar Table. This field is display-
only.
FLSA Threshold Hours The number of hours worked before the FLSA rate applies to Fire Protection and
Law Enforcement employees. Both of these types of jobs have different threshold
hours defined by FLSA regulations. Both threshold hour schedules are delivered
by PeopleSoft and are defined in the FLSA Period Table. You can create user-
defined FLSA period definitions with different threshold hour schedules if
necessary.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "(USA)
FLSA and Alternative Overtime Calculations."
This section lists the page used to run job code and pay group reports.
370 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 13 Setting Up Jobs
Job Code Table Report - PRCSRUNCNTL Set Up HRMS, Foundation Job Code Table report
Run Control Tables, Job Attributes, Job (PER709C) lists all job
Code Table Report, Run codes.
Control
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 371
Chapter 14
View the Project Costing and General Ledger Business Unit tables.
This section provides an overview of federal HRMS control tables and discusses how to:
Set up sub-agencies.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 373
(USF) Setting Up Human Resources Management Tables Chapter 14
When creating personnel action requests, you search fields using information from the Legal Authority table,
the Nature of Action table, the PAR Remarks table, and the NOA/Legal Authority 1 table.
When you enter employee-specific information, you use values from the Handicap table and the LEO Pay
Area table.
In PeopleSoft HRMS, you use values from the U.S. County table, the Personnel Office ID table, and the Sub-
Agency table.
Handicap Table GVT_HANDICAP_TBL Set Up HRMS, Product Assign codes to the types of
Related, Workforce disabilities a person might
Administration, Workforce have. You can set up the
Data USF, Handicap Table, table with the disabilities
Handicap Table that your agency is likely to
use and add more as
needed.
Legal Authority GVT_LEGAL_AUTH_TBL Set Up HRMS, Product The Legal Authority table
Related, Workforce provides the values that are
Administration, Workforce used on the Data Control
Data USF, Legal Authority, pages for Personnel Action
Legal Authority Request (PAR) processing.
U.S. County Table GVT_COUNTY_TABLE Set Up HRMS, Product View a complete list of
Related, Workforce counties in the United
Administration, Workforce States. This table populates
Data USF, U.S. County the County description on
Table, U.S. County Table the Location Table.
PeopleSoft delivers the list
of U.S. counties, but you
can add or change an entry
if needed.
Nature of Action Table GVT_NOAC_TBL Set Up HRMS, Product Review, add, and update
Related, Workforce codes. This table defines the
Administration, Workforce Nature of Action codes that
Data USF, Nature of Action are used in PeopleSoft
Table, Nature of Action Human Resources.
Table
374 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 14 (USF) Setting Up Human Resources Management Tables
Law Enforcement Officers GVT_LEOAREA_TABLE Set Up HRMS, Product Set up special pay areas in
Pay Area Table Related, Compensation, the Law Enforcement
LEO Pay Area Table USF, Officers Pay Area Table .
Law Enforcement Officers Law enforcement officers in
Pay Area Table these regions receive
additional pay above the
base pay for their pay plan,
grade, and step. PeopleSoft
delivers the current LEO
pay areas, and you can
update them based on
Office of Personnel
Management updates that
you might receive
throughout the year.
NOA/Legal Authority 1 GVT_AUTH_VAL_1 Set Up HRMS, Product Connect the NOA codes
Related, Workforce that are defined in the
Administration, Workforce Nature of Action table with
Data USF, NOA/Legal the legal authorities that are
Authority 1, NOA/Legal defined in the Legal
Authority 1 Authority table. You must
have set up nature of action
codes and legal authority
codes.
PAR Approving Officials GVT_POI_TABLE2 Set Up HRMS, Product Enter the names that appear
Table Related, Workforce in the routing process
Administration, Workforce section of the PAR.
Data USF, Personnel Office
ID, PAR Approving
Officials Table
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 375
(USF) Setting Up Human Resources Management Tables Chapter 14
Disabled Select if the disability code describes what your agency considers a disability.
Usually you select this check box. However, if (for example) you set up a
disability code to indicate that a person has no disability, leave this check box
deselected.
A legal authority is the authority that empowers an agency to grant a personnel action request. PeopleSoft
delivers your system with a list of legal authorities. If the Office of Personnel Management issues an update
of legal authorities, you can keep your system up to date by changing the information in the Legal Authority
table.
376 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 14 (USF) Setting Up Human Resources Management Tables
Effective Date When you add a legal authority code to this table, select an effective date early
enough to accommodate your organization's oldest historical record to which it
applies. Add data rows to maintain history data for information that changes over
time.
Description - Part 1 and Enter descriptions that appear on the Data Control page (GVT_JOB0) when you
Description - Part 2 process personnel actions for a person.
Nature of Action Code Every Personnel Action Request (PAR) requires a Nature of Action (NOA) code,
so every personnel action is described in this table and assigned an NOA code.
PeopleSoft delivers the NOA codes, but you can add or update entries as needed.
When entering NOA codes for your agency's internal use, PeopleSoft suggests
that you use codes in the 900 series.
Effective Date When you add a Nature of Action code to this table, select an effective date that
is early enough to accommodate your organization's oldest historical record to
which it applies. Add data rows to maintain history data for information that
changes over time for the NOA code.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 377
(USF) Setting Up Human Resources Management Tables Chapter 14
Time NOA is Effective This field designates when the personnel action should take effect. Select
(time nature of action is Opening of Business Day (the default) or Close of Business Day.
effective)
If you select (none), the system uses the default, Opening of Business Day.
In PeopleSoft, all actions are normally assumed to take place at the beginning of
business on the effective date. This isn't always the case with the federal
government. With Termination/Non-Pay actions (NOAs that are in the 300
series and 400 series), the action is effective at Close Of Business Day on the
effective date. Any personnel action defined with Close of Business Day
increments the Job effective date by one. The Federal (GVT_JOB) effective date
is not affected.
Required for CPDF Select if the NOA code is reportable to the Office of Personnel Management
(required for central (OPM) from CPDF reports.
personnel data file)
Push Action to Job Select if the nature of action is to be applied to the core PeopleSoft job record
(JOB) from the federal government side after saving the personnel action.
IRR Reportable Select if an NOA code is to be reported to OPM on the IRR. This indicates that
(individual retirement an IRR-related NOA code is part of an IRR control record when a separation
record reportable) personnel action is saved.
IRR Type Select the type of IRR to be generated. Values are Retirement,
Transfer/Resignation, and Supplemental.
378 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 14 (USF) Setting Up Human Resources Management Tables
LEO Percentage (law Enter the percentage of base pay that LEOs in this region receive in addition to
enforcement officer the base pay set by their pay plan, grade, and step. The amount is reflected on the
percentage) Compensation Data page (JOB_DATA3) in Administer Workforce.
When you enter an NOA (nature of action) code on the PAR Data Control page in Administer Workforce and
prompt on the Authority (1) field, you see only the valid values from this table. However, for Authority (2),
you can select any of the legal authorities that are defined in the Legal Authority table.
Setting Up Sub-Agencies
Access the Sub-Agency page (Set Up HRMS, Product Related, Workforce Administration, Workforce Data
USF, Sub-Agency, Sub-Agency).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 379
(USF) Setting Up Human Resources Management Tables Chapter 14
Sub-Agency page
Sub-Agency If your agency has multiple organizations that might report to the Office of
Personnel Management as separate entities, you define them as distinct sub-
agencies for online processing purposes.
Report CPDF (report Select if this sub-agency reports CPDF on a regular basis.
central personnel data
files)
Long Enter a long description of the sub-agency.
380 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 14 (USF) Setting Up Human Resources Management Tables
Personnel Officer's Enter the name of the person who is responsible for personnel actions for this
Name office.
OPM Oversight Office Select the OPM Oversight Office to which you report personnel actions from the
(office of personnel available values. The values are stored on the Translate table. To change or add
management oversight values, inform your project management office of the updates you require.
office)
Automated Submitting The automated submitting point is an informational field and isn't used during
Point PeopleSoft HRMS processing. However, it is required on the OPM form that is
used to communicate the establishment of or changes to a Personnel Office
Identifier for currently operating personnel offices.
Electronic Commerce This address is for your agency's information only. For example, this might be an
Address email address or a government network ID.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 381
(USF) Setting Up Human Resources Management Tables Chapter 14
Empl ID (employee ID) Enter an employee ID for each official who approves personnel actions. When
you move out of the field, the system populates the Empl Record, Name, and
Title fields. You can edit these fields.
Primary PAR Select if applicable. This check box is for your information only.
Approving Official
(primary personnel action
request approving official)
382 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 14 (USF) Setting Up Human Resources Management Tables
The Office of Personnel Management (OPM) designates remark codes that begin with A through X.
PeopleSoft delivers the current standard OPM PAR remarks, but you need to maintain them, based on OPM
updates that you might receive throughout the year. To enter additional remarks for your agency's internal
use, use codes that begin with Y or Z. When you upgrade PeopleSoft HRMS, retain your agency-specific
remarks.
Print Priority Select the printing priority for the remark. Available values are 1st Tier and 2nd
Tier. First tier remarks print first on the SF50/52 reports before any second-tier
remarks. Therefore, any remark that is defined as 1st Tier is printed in the order it
is listed by the HR personnelist. These are followed by the 2nd tier remarks.
Insertion Required Select if this remark needs employee-specific information. When you select this
remark at the person level, this check box is unavailable for entry.
PeopleSoft uses an asterisk (*) to denote person-specific information that is
changed by your human resources personnel clerk when the remark is attached to
a PAR at the person level.
IRR Reportable Select if this remark is attached to a PAR that is to be printed on an IRR and you
(individual retirement want to print the remark on the IRR.
record reportable)
ROST Reportable Select to have this remark printed on the ROST.
(Register of Separations
and Transfers reportable)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 383
(USF) Setting Up Human Resources Management Tables Chapter 14
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "(USF) Generating IRR and ROST
Reports"
384 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 14 (USF) Setting Up Human Resources Management Tables
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 385
(USF) Setting Up Human Resources Management Tables Chapter 14
The PC Business Unit table is part of the Project Costing process in PeopleSoft Enterprise Financials, which
interacts with the Time and Labor process. If you don't use project costing, you don't need to import the
values for this table.
The GL Business Unit table is part of the General Ledger process in PeopleSoft Financials that interacts with
the Payroll process. If you don't use General Ledger, you don't need to import the values for this table.
386 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15
Banking setup.
Banking Setup
To set up banks in HRMS:
Note. There is some additional banking setup required for the UK.
See Chapter 15, "Setting Up Banks and Bank Branches," (GBR) Bank and Building Society Setup in the
UK, page 387.
3. Specify source banks for payroll processing on the Source Bank Accounts page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 387
Setting Up Banks and Bank Branches Chapter 15
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Entering Additional
Data in Human Resources Records," Entering Bank Account Information.
You must set up every bank or building society that your organization deals with during the course of
business. This information is stored in the BANK_EC_TBL and BANK_BRANCH_TBL tables. A third
table, PYE_BANKACCT, stores the details of your payee's bank and building society accounts.
For UK banks, set up bank branches on the Bank Table page. For building societies, use the Bank Table page
to identify the bank branch that handles clearing for the society. Use the Branch Table page and its associated
Building Society Address page, to enter the building society details. This table shows how to complete these
pages:
Type of Account Bank Table Page Branch Table Page and Building
Society Address Page
Bank Branch Enter the name, address, and phone Leave blank.
number of the bank branch.
Building Society Enter the name, address, and phone Enter the building society name and
number of the bank branch that address and the number of the
handles clearing for the building account that the building society
society. has with the clearing bank that is
identified on the Bank Table page.
Warning! You must set up a building society on the Branch Table page, linking the society to its clearing
bank on the Bank Table page. If you don't set up building societies as described, the BACS interfaces and
processes that are provided by Global Payroll for the UK do not generate valid data.
This example shows how a building society is defined on the Branch Table page:
388 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
In the example, the building society is linked to LloydsTSB bank (bank ID 30000) that handles clearing for
the building society. The building society's clearing account is shown in the Account Number field.
You download bank information from a website or service that provides bank information to an Excel
spreadsheet and then import the information from the Excel spreadsheet to the CI_BANK_EC component
interface, using the Excel to Component Interface utility. The CI_BANK_EC component interface loads the
bank information into the BANK_EC table and BANK_BRANCH_TBL in PeopleSoft HRMS.
Note. It is your responsibility to determine which rows to update and which rows to add to the PeopleSoft
HRMS database when using the Excel to Component Interface utility.
See Also
Use the CI_BANK_EC component interface to load the banking data into the tables for this component
interface.
Identify banks.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 389
Setting Up Banks and Bank Branches Chapter 15
Bank Table BANK_EC Set Up HRMS, Common Set up basic information for
Definitions, Banking, all financial institutions.
Banks, Bank Table
You must complete the
Bank Table page before you
identify a bank with a
source bank account.
Identifying Banks
Access the Bank Table page (Set Up HRMS, Common Definitions, Banking, Banks, Bank Table).
390 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
Bank ID System-displayed. There are different formats for each country. Some are
numeric, and others are alphanumeric.
Bank Type Select the type of bank. Values are Commercial,Community,General,Post Bank,
and Savings.
Alternate Bank ID Enter the bank's national ID, if applicable. If the bank participates in an
international banking consortium or system, it is given an alternate bank ID that
is used in international transactions.
Bank Identifier Code Enter the Bank Identifier Code (BIC) provided by SWIFT. When saved, the
system checks that this entry is 8 or 11 characters long. The system does not
validate the accuracy of the BIC, only its length.
Edit Address Click the Edit Address link to change address information for a bank.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 391
Setting Up Banks and Bank Branches Chapter 15
AC Bank Name This field appears if you enabled AC functionality on the Primary Permission
(alternate character bank List Preferences page. Japanese users enter the bank name in single-byte,
name) Katakana format.
Note. If you're setting up a building society, enter the sort code of the bank
branch that handles clearing for the building society. Clearing is normally
handled by a bank's head office.
Bank Name Enter a description of the branch. Include the location of the branch, not just the
bank name.
Branch ID Enter the branch ID for the bank. Branch ID formats vary by country.
392 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
Bank Identifier Code Enter the Bank Identifier Code (BIC) provided by SWIFT. When saved, the
system checks that this entry is 8 or 11 characters long. The system does not
validate the accuracy of the BIC, only its length.
AC Branch Name This field appears if you enabled AC functionality on the Primary Permission
(alternate character branch List Preferences page. Japanese users enter the branch name in single-byte,
name) Katakana format.
Address Information Click the Address Information link to access the Bank Branch Address page.
Other Information (BRA) Click the Other Information link to access the Bank Branch Brazil page.
To set up UK building societies, enter the following information on the Branch Table page:
Bld Soc ID (building Enter a unique identifier for the building society.
society ID)
Status You can enter employee account details only for building societies with an active
status.
Bld Soc Name (building Enter the full name of the building society.
society name)
Account Number Enter the number of the building society's account at the clearing bank.
Address Information Click the Address Information link to access the Building Society Address page,
where you enter the building society's head office address.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 393
Setting Up Banks and Bank Branches Chapter 15
Verifier Digit Enter the bank-assigned verifier digit. File transfers may require the verifier digit.
Contact Name Enter the contact name for the bank branch.
This section provides an overview of IBAN setup and discusses how to set up IBAN information.
To set up IBAN functionality you must select the IBAN enabled field on the IBAN Country Setup page. You
can also establish the rules used to create the Basic Bank Account Number (BBAN) on this page. After the
IBAN feature is enabled, the IBAN field and Edit IBAN link appears on the Source Bank Account page and
the Maintain Bank Account pages for the country.
See Also
Chapter 15, "Setting Up Banks and Bank Branches," Specifying Source Banks, page 396
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Entering Additional Data
in Human Resources Records," Entering Bank Account Information
394 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
IBAN Country Setup SETUP_IBAN_TBL Set Up HRMS, Common Enable the IBAN feature for
Definitions, Banking, IBAN a specific country. Create
Country Setup, IBAN BBAN validation rules.
Country Setup
IBAN Enabled Select this check box to enable the IBAN functionality for this country. If you
enable IBAN, the IBAN field and the Edit IBAN link appears when you set up a
source bank account page or a payee bank account with this country code.
IBAN Required Select this check box to require an IBAN value for accounts in this country. If
you select this check box, you must complete the IBAN fields when you set up a
source bank account or a payee bank account with this country code.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 395
Setting Up Banks and Bank Branches Chapter 15
See Chapter 15, "Setting Up Banks and Bank Branches," Specifying Source Banks, page 396.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Entering Additional
Data in Human Resources Records," Entering Bank Account Information.
Sequence Enter the order in which the value will appear in the Basic Bank Account
Number (BBAN).
Bank Account Field Select the field used to compose the BBAN.
Start Position Enter the position where the Bank Account Field will begin.
Length Enter the number of characters allotted for this Bank Account Field.
Zero Pad Select this option to fill any difference between Length and the actual Bank
Account Field value with zeroes.
This section provides an overview of source banks and discusses how to:
(CAN and USA) Specify data for banks in Canada or the U.S.
For certain countries, such as the U.S., Canada, and Japan, you must set up additional information for source
banks, accessed through the Other Required Information link on the Source Bank Accounts page. For
countries in Europe, you must define International Bank Account Number (IBAN) information, accessed
through the Edit IBAN link on the Source Bank Accounts page.
Payroll Setup
PeopleSoft Enterprise Global Payroll users must link source banks to a pay entity.
See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook, "Defining Banking Instructions."
396 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
PeopleSoft Enterprise Payroll for North America users must link source banks to a pay group.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Pay Groups," Specifying
Banks and Tips Processing.
Source Bank Accounts SRC_BANK Set Up HRMS, Common Assign a source bank ID
Definitions, Banking, and define information
Source Bank Accounts, about the banks that pay out
Source Bank Accounts money.
International Bank Account BANKACCT_IBAN_SEC Click the Edit IBAN link on (BEL, CHE, DEU, ESP,
Nbr the Source Bank Accounts FRA, GBR, ITA, and NLD)
page. Enter or edit the
International Bank Account
Number. Generation of the
IBAN is the responsibility
of the bank or bank branch
servicing the account.
This page is only available
if the country selected on
the Source Bank Accounts
page is set up for IBAN on
the IBAN Country Setup
page.
Canada Bank Additional SRC_BANK_PY_SP Click the Other Required (CAN and USA) Specify
Data Information link on the data for banks in Canada or
Source Bank Accounts the U.S.
US Bank Additional Data
page.
page This page is only available
if you select CAN or USA
as the Country Code on the
Source Bank Accounts
page.
Japan Bank Additional Data GPJP_SRC_BANK_SEC Click the Other Required (JPN) Specify the account
Information link for a type and company code for
Japanese bank on the Japanese banks.
Source Bank Accounts
page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 397
Setting Up Banks and Bank Branches Chapter 15
Country Code Select the country code where the bank is located.
Account Number Enter the bank account number. Each country has its own account number
format.
Check Digit Enter the value used to validate the bank ID, bank branch ID (if applicable), and
account number. This field only appears for countries where check digits are
used.
Note. This field is not for IBAN accounts. You enter the IBAN check digit on the
International Bank Account Nbr page that you access when you click the Edit
IBAN link on this page.
IBAN Displays the IBAN. This only appears if the country code is BEL, FRA, DEU,
CHE, ITA, ESP, NLD, or GBR.
398 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
Edit IBAN Click this link to access the International Bank Account Nbr (number) page
where you can edit the IBAN.
Note. Generation of the IBAN is the exclusive responsibility of the bank or bank
branch that services the account.
Depending on the country that you select, you may not have this page. It is used
to record information for companies that operate in Europe.
See Chapter 15, "Setting Up Banks and Bank Branches," Editing IBAN
Information, page 399.
Other Required Click this link to access the Additional Data page. Depending on the country that
Information you select, this page might not be available. It is used to record information for
companies that operate only in the U.S., Canada, or Japan.
See Chapter 15, "Setting Up Banks and Bank Branches," (CAN and USA)
Specifying Data for Banks in Canada or the U.S., page 400.
See Chapter 15, "Setting Up Banks and Bank Branches," (JPN) Specifying the
Account Type and Company Code, page 402.
AC Account Name This field appears if you enabled AC functionality on the Primary Permission
(alternate character List Preferences page. Japanese users enter the bank account name in single-byte,
account name) Katakana format.
EFT Domestic (electronic Specify which EFT format the source bank account accepts. Enter the EFT name
funds transfer domestic) for domestic transactions. If the payee or recipient account is domestic, the
default EFT name is taken from the EFT Domestic field of the source bank
account that you selected. With domestic accounts, the country code is the same
as the country code that you selected during installation.
Bank Transfer ID Enter the bank transfer ID that is used to identify banks to clearing systems.
EFT Int'l (electronic Enter the EFT name for international transactions. If the payee or recipient
funds transfer account is foreign, the default EFT name is taken from the EFT Int'l field of the
international) source bank account you selected. With foreign accounts, the country code is
different from the country code that you selected during installation.
Note. The Payment ID Assignment page, found in this component, is specific to PeopleSoft Global Payroll
and is documented in the PeopleSoft Global Payroll documentation.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 399
Setting Up Banks and Bank Branches Chapter 15
Note. Generation of the IBAN is the exclusive responsibility of the bank or bank branch that services the
account.
Note. While saving, the system validates the data. The page will not be saved if any invalid values appear.
Country Enter or edit the country code used to generate the IBAN.
Calculate Bank Account Click this button to generate the IBAN. The system populates the Country and
Number Basic Bank Account Number fields using data from the Source Bank Accounts
page. You must complete the Check Digit field and correct the defaulted values if
necessary.
Basic Bank Account Enter or edit the account number used to generate the IBAN.
Number
(CAN and USA) Specifying Data for Banks in Canada or the U.S.
Access the Canada Bank Additional Data page or the US Bank Additional Data page (click the Other
Required Information link for a CAN or USA bank on the Source Bank Accounts page).
400 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
Wait Days Enter the number of prenote wait days. What you enter here at the source bank
level determines whether the prenotification process is required or not. If you
enter 0 in this field, there won't be a prenote generated at the payee level. If you
enter any number other than 0 in this field, a prenote is required.
When a company makes transfers to a new account (for example, an employee
changes the account for automatic deposits), the banks recommend an initial run
with a dummy record to establish that this is a valid (existing) account. The
specified waiting period (after the dummy run but before the funds can be
transferred to this account) is called the prenote wait days.
Note. enable the prenote process to validate the transit numbers, which you
specify at the employee level.
The Payroll for North America group box only appears if you have PeopleSoft Payroll for North America
installed. You only have to define this group box if you have PeopleSoft Payroll for North America.
Check Stock Form ID If your company generates checks, select the form ID for this source bank
account.
Advice Form ID If your company generates direct deposits, select the form ID for this source bank
account.
When assigning numbers for checks or direct deposits, the Pay Confirmation and
Paycheck Reprint processes reference this field to determine which check and
advice numbers to use. Form IDs are defined in the Form Table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 401
Setting Up Banks and Bank Branches Chapter 15
Deposit Medium Specify how transactions are transferred to the bank for processing. Options are
Tape,EFT, (electronic funds transfer), Diskette, and Report.
For PeopleSoft Payroll for North America: This field is for your information
only; it does not affect the payroll process in any way.
Account Type The source bank account type. Values are Checking and Regular.
Company Code Enter the ID that is assigned to the company by the banking institution.
402 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 15 Setting Up Banks and Bank Branches
This section lists the page used to report on banks and bank branches.
Bank/Branch Report PRCSRUNCNTL Set Up HRMS, Common Run the Bank/Branch report
Definitions, Banking, that lists information from
Bank/Branch Report, the bank and bank branch
Bank/Branch Report table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 403
Chapter 16
Note. For customers integrating with PeopleSoft Enterprise 8.4 Financials or higher, most of the components
described in this chapter are display only.
In addition to this basic categorization of a transaction amount using the account ChartField, you can
simultaneously record the same transaction by product, project, fund, or any number of categories by using
other ChartFields with appropriate values. This creates additional subsets of that same transactional data.
PeopleSoft delivers a set of ChartFields and associated functionality that fully covers most accounting and
reporting requirements. ChartFields are designed to be configured by you to meet your specific requirements.
Delivered ChartFields
This table describes the delivered ChartFields:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 405
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Label Long Name Label Short Name ChartField Name Component Name Description
(Field Length)
406 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Label Long Name Label Short Name ChartField Name Component Name Description
(Field Length)
Alternate Account Alt Account ALTACCT (10) ALTACCT Classifies the nature
of a transaction for
regulatory authorities.
Use it for statutory
accounting.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 407
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Label Long Name Label Short Name ChartField Name Component Name Description
(Field Length)
408 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Label Long Name Label Short Name ChartField Name Component Name Description
(Field Length)
Prerequisites
This table describes the service operations that you must configure in the HRMS database to implement the
ChartField and ChartField combination functionality:
RELEASE_RESPONSE HRMS receives the update of the General Ledger version from
Financials.
One integration point for each GL ChartField HRMS receives the ChartField values published from the Financials
database.
See Chapter 16, "Setting Up and Working with ChartFields and
ChartField Combinations," Entering and Maintaining ChartField
Values, page 418.
HR_ACCT_CD_LOAD HRMS receives the combination codes imported from the Financials
database or flat file and populates the GL Account Code table
(GL_ACCT_CD_TBL).
COMBO_CF_EDIT_REPLY HRMS receives and processes the response from the Financials
database to a request for validation of a combination code.
Note. Most of these service operations require that you use PeopleSoft Enterprise General Ledger in a version
that is capable of using Integration Broker.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 409
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
See Also
Interactive Services Repository in the Implementation Guide section of the My Customer Support website
Chapter 38, "Working with Integration Points in Enterprise HRMS," page 941
This table compares the ChartField functionality for the different combinations of General Ledger indicator
and version on the Installation table:
410 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Note. The Department ChartField is always set up as read only. Changes made to the Department table are
automatically reflected in the Department ChartField.
See Also
Chapter 6, "Setting Up and Installing PeopleSoft HRMS," Setting Up Implementation Defaults, page 129
Product Specific INSTALLATION_TBL1A Set Up HRMS, Install, Enter product- and industry-
Installation Table, Product specific installation
Specific information.
See Also
Chapter 6, "Setting Up and Installing PeopleSoft HRMS," Setting Up Implementation Defaults, page 129
1. Select the General Ledger and Project Costing indicators on the Installation Table - Products page
(INSTALLATION_TBL1).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 411
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
2. Click the Update Version button in the General Ledger group box on the Installation Table - Product
Specific page (INSTALLATION_TBL1A).
This button triggers a request to the Financials database and updates the GL version automatically.
Note. The default GL version is N/A, which you can update using the Update Version button if you use
Enterprise Financials 8.4 or higher for original ChartFields, or Enterprise Financials 9.0 for project
ChartFields.
If you select the Project Costing check box on the Installation Table - Products page but are not using
PeopleSoft Enterprise General Ledger, Project Costing ChartFields will be available to you for editing, but no
validation with Financials is performed.
If Payroll for North America supports your General Ledger system, follow the system configuration
instructions in the related documentation.
This section provides an overview of standard ChartField configuration and discusses how to:
Note. The ChartField configuration template is review only if you use PeopleSoft Financials. Modifications
to this ChartField configuration template should be done in the Financials system. If you use Financials 8.40
or above for original ChartFields, or Financials 9.0 for project costing ChartFields, configuration changes are
sent to HCM by the FSCM_CF_CONFIG service operation.
Original ChartFields
PeopleSoft delivers the standard ChartField configuration template with fourteen active and two inactive
original ChartFields in the following sequence:
412 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Account
Department
Project/Grant
Product
Fund Code
Program Code
Class Field
Affiliate
Operating Unit
Alternate Account
Budget Reference
Chartfield 1
Chartfield 2
Chartfield 3
Note. Original ChartField integration is available to those organizations that are on PeopleSoft Enterprise
Financials 8.4 or higher.
PeopleSoft delivers the standard ChartField configuration template with six project costing ChartFields,
which have the following display order:
Business Unit PC
Project/Grant
Activity ID
Resource Type
Resource Category
Resource Sub-Category
Important! Project costing ChartFields are unique in that their display order is always the same in
relationship to the position of the Project/Grant ChartField. When changing the field display order, all project
costing ChartFields move together in a block; you can change the display order of a project costing
ChartField but the other five ChartFields will remain in the same order in relation to that project costing
ChartField.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 413
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Note. Project Costing ChartField integration is available to those organizations that are on PeopleSoft
Enterprise Financials 9.0. If your organization does not integrate with PeopleSoft Financials but you use
PeopleSoft Project Costing, then the attributes of the project costing ChartFields can be modified in the
standard ChartField configuration template.
If you do not use PeopleSoft Enterprise General Ledger, you can use the Standard ChartField Configuration
page to make the following modifications to the standard ChartField configuration:
Inactivated ChartFields are not displayed on pages, reports, or in prompt lists. They are not included in
indexes. While not displayed, they are not removed from records or pages. This significantly reduces
configuration time and effort.
ChartField Labels STANDARD_CFLBL_LNG Click Label Details on the View changes of ChartField
Action Status page. labels for both base
language and related
language.
414 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
The FSCM_CF_CONFIG service operation consists of Financials's latest ChartField template along with all
corresponding ChartField labels. Upon receiving the service operation, the HCM database compares the
configuration template and labels and generates the actions required to perform ChartField changes in HCM.
These pending ChartField change actions reside on the Action Log file. You can review these changes on the
Action Status page and determine the time to apply them to your system. Use controls on the Standard
ChartField Configuration page to review the configuration status and apply the changes.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 415
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
The Standard ChartField Configuration page initially displays the ChartFields as delivered by PeopleSoft.
Status An active ChartField displays on pages, reports and prompt lists. An inactive
ChartField is not displayed on pages, reports and prompt lists, but it is not
removed from records and pages.
Fund Affiliate, Operating Unit Affiliate, and the Project Costing ChartFields are
delivered inactive but can be activated if the delivered active ChartFields are not
sufficient for your requirements.
Warning! Do not change the status of a ChartField after you have run the full
configuration and are using the system in production. Status determines whether
ChartFields are displayed on pages, reports and prompt lists throughout the
system.
416 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Order Change the order of display by changing the sequence of order numbers in this
field. Inactive ChartFields have the order value of 99. Active ChartFields require
an order number. When you activate an inactive ChartField, the system assigns it
the next available number, which you can change to place the newly activated
ChartField in any desired sequence.
When you save the page, the system completes the final reordering to remove
gaps or duplicates in the numbering sequence.
Important! Project costing ChartFields are always the same in relationship to the
position of the Project/Grant ChartField. When changing the field display order,
all project costing ChartFields move together in a block.
Field Long Name and Enter a new long name and short name to relabel the description of a ChartField.
Field Short Name These names are displayed on pages, reports and prompt lists rather than the
database field name of the ChartField.
Display Length Enter a new value to change display length on pages. The display length cannot
be greater than the actual field length of the ChartField.
IntraUnit Related A unique intraunit related ChartField of the same or smaller ChartField length
ChartField must be specified for each intraunit affiliate ChartField that is active. (Business
Unit is required for the InterUnit Affiliate ChartField.)
Activate To activate an inactive ChartField, click the check box next to the field you want
to activate and then click the Activate button.
Inactivate To inactivate an active ChartField, click the check box next to the field you want
to inactivate and then click the Inactivate button.
Impact Click to run the ChartField Configuration PSJob process (PYCONFIG) in report
mode to analyze the ChartFields changes and determine the impact of applying
the new template.
Configuration Status Click to access the Action Status page where you can view the standard
ChartField activity log and pending changes, including changes that have been
subscribed to from Financials but not yet applied.
Before applying the subscribed changes, view their impact by clicking the Impact
button.
If you have saved changes but want to cancel them before applying them, use the
Configuration Status - Action Status page to cancel the undesired configuration
actions. This resets the ChartField to its previous configuration.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 417
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Apply Click to run the ChartField Configuration PSJob process (PYCONFIG) in update
mode to apply the ChartField configurations changes.
Warning! If you make any changes to the Standard Configuration pages, you
must run the ChartField Configuration process in update mode to apply those
changes before they take effect.
After you apply your changes, the system displays only the active ChartFields.
ChartFields display in the order and with the labels defined in this standard
configuration.
This table lists the service operations used to import original ChartFields from Financials by Integration
Broker:
Account ACCOUNT_CHARTFIELD_FULLSYNC
ACCOUNT_CHARTFIELD_SYNC
Project/Grant PROJECT_FULLSYNC
PROJECT_SYNC
Product PRODUCT_CHARTFIELD_FULLSYNC
PRODUCT_CHARTFIELD_SYNC
418 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
ChartField 1 CHARTFIELD1_FULLSYNC
CHARTFIELD1_SYNC
ChartField 2 CHARTFIELD2_FULLSYNC
CHARTFIELD2_SYNC
ChartField 3 CHARTFIELD3_FULLSYNC
CHARTFIELD3_SYNC
You can view the imported ChartField values from the ChartField Values page.
This table lists the additional service operations used to import Project Costing ChartFields from Financials
9.0 by Integration Broker:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 419
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Note. In PeopleSoft Financials, combination editing does not support the publishing of detail project
ChartFields to HCM since the source record is the COMBO_DATA_TBL, which does not include the detail
project ChartFields. The only project ChartField that is published is PROJECT_ID.
See Also
Chapter 38, "Working with Integration Points in Enterprise HRMS," page 941
The active ChartFields on the Standard ChartField Configuration page determines the pages that are available
for entering ChartField values.
Note. PeopleSoft recommends that you not use special characters and embedded blanks in ChartField values.
Use the generally accepted alphanumeric characters and the underscore. Special characters and embedded
blanks can be problematic and in particular can cause problems in some background processes.
420 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Other than the Project ChartField, all changes to the definition of a ChartField value are effective-dated.
Therefore, you can establish when you want to activate a department, introduce a product line, or close an
account. Use effective dating with activation and inactivation functionality to maintain a full history of all
changes or additions, to provide a complete audit trail, and to make possible historical comparisons with past,
present, or future conditions. When you no longer use a certain ChartField value, add a row to create an
effective-dated inactive entry, instead of inactivating the original row. If you simply make the existing row
inactive, you will have no history of its time as an active ChartField value.
After you initially populate the ChartField tables, you can maintain them from the ChartField Values page.
Affiliate ChartField.
Affiliate ChartField values are the values of the related ChartField. In other words, there is no separate
affiliate ChartField page where you enter affiliate values as with the stand alone ChartFields, such as account
or department.
Business unit is required as the interunit-related ChartField for affiliate. It provides the values available in the
list box for the Affiliate field on the Journal Entry page.
Resource Type
Resource Category
Resource Sub-Category
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 421
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Resource types can be as general or as specific as needed. For example, you can use a labor resource type to
track total project labor costs, or use overtime labor and standard labor resource types to track overtime and
standard labor separately.
You can combine categories and sub-categories in resource groups for greater flexibility and granularity for
tracking and analyzing costs for reporting and analysis. For example, you can divide a labor resource type
into different categories of labor, such as architect labor, carpenter labor, and plumber labor, and you can
create sub-categories for regular hours and overtime hours. By using these categories and sub-categories, you
can track items such as total labor costs for a project, total overtime hours, architect overtime hours, and
carpenter standard hours.
Resource types, categories, and sub-categories provide flexibility for defining transactions. You can define
relationships between these fields to control data-entry options for specific fields. The relationships can be
one-to-one or one-to-many. If you relate resource types to specific categories, and assign a resource type to a
transaction, you can assign a resource category only if it is related to the resource type. For example, a
transaction with a labor resource type can only be entered in a resource category that is related to labor. The
same is true for relationships between resource categories and resource subcategories.
ChartField Values DEFINE_CF_VALUES Set Up HRMS, Common Displays the links to the
Definitions, ChartField components of the active
Configuration, ChartField ChartFields. Click the link
Values, ChartFIeld Values of the component you want
to access.
GL Account Table GL_ACCOUNT Click the Account link on Set up new account
the ChartField Values page. ChartField values. Account
values are used in
combination with other
ChartFields values to create
valid ChartField
Combinations.
422 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Project/Grant PROJECT_CF Click the Project/Grant link Add project values, set up
on the ChartField Values project start and end dates,
page. and project status.
Fund Code FUND_DEFINITION Click the Fund Code link on Define fund values for all
the ChartField Values page. types of funds. Funds are
primary structural units for
education and government
accounting. Funds are
maintained as a balanced set
of accounts and are used to
present financials
statements.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 423
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Program Code PROGRAM_DEFINITION Click the Program Code Set up codes to enable
link on the ChartField financial tracking of
Values page. programs.
Class Field CLASS_PNL Click the Class Field link on Set up codes to enable
the ChartField Values page. financial tracking of class
amounts, such as salaries or
bonuses.
Operating Unit OPERATING_UNIT Click the Operating Unit Set up codes to identify a
link on the ChartField unit of operation for
Values page. financial tracking.
Alternate Account ALTACCOUNT Click the Alternate Account Set up new alternate
link on the ChartField account ChartField values.
Values page.
Note. This page is not
available for entry if you are
integrating with PeopleSoft
Financials.
Budget Reference BUDREF_PNL Click the Budget Reference Set up unique budgets
link on the ChartField where budgets share budget
Values page. keys and overlapping
periods.
424 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 425
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Business Unit PC BUSINESS_UNIT_PC Click the Business Unit PC Set up business units for
link on the ChartField project costing to plan
Values page. projects and gather business
data without the constraints
of the enterprise's standard
accounting procedures for
financial posting and
reporting. The project
costing business unit
determines the values
available for the Project ID,
Activity ID,Resource Type,
Resource Category, and
Resource Sub-Category
fields.
Resource Type RESOURCE_TYPE Click the Resource Type Define resource types that
link on the ChartField you can assign to individual
Values page. transactions to identify the
transaction's purpose.
Resource types are
necessary for Project
Costing resource groups,
reports, and processes to
function properly; if not
implemented, these source
types must still be
configured.
426 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 427
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Project/Grant page
Integration Use to select an integration template for the project and project level.
Start Date and End Date These fields are for information only. There is no processing behind them.
Project Status Enter the effective date and select a project status to indicate the various stages of
the life cycle for the project.
428 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
The PeopleSoft alternate account feature enables you to enter a statutory chart of accounts as well as analytic
or primary accounts at the detail transaction level. The alternate account produces journal line or transaction
level balances for statutory reporting requirements. The primary account ChartField contains the corporate
accounts, and alternate account ChartField contains the statutory accounts. This is useful for organizations
that have two different reporting requirementsone for internal management or a corporate parent, and
another for a local jurisdiction or national government.
Local regulatory authorities often require statutory accounts. In PeopleSoft applications, this is termed the
alternate account ChartField (ALTACCT).
You link alternate account ChartField values with account ChartField values. When you enter values for the
account ChartField, the system enters the associated alternate account value. When you enter values for the
alternate account ChartField, the system enters the associated account value. You can override the default
values by selecting another value from the prompt list. The system displays only account values that you have
mapped to the account or alternate account ChartField.
Note. You can map alternate account ChartFields only to account ChartFields with the same attributes unless
they have a different SetID.
Long Description Optionally, you can enter the purpose or use of the alternate account, and an
explanation of the type of transactions that are to be posted to it.
Monetary Account Type Select from the types previously defined on the Account Types page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 429
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Statistical Account Used for statistical amounts, not monetary amounts. If you select the check box,
you must specify a unit of measure.
Control Flag Select to indicate that you can update this alternate account only by using the
Journal Generator. A control account represents a summarization of detail from
an application.
This section provides overviews of combination codes, valid combination loading, and speed types and
discusses how to:
A valid combination code is a combination of ChartFields that are valid in general ledger. Store valid
combination codes in the Valid Combination table (VALID_COMBO_TBL) to be used by the ChartField
combination validation process.
Note. If you are not using valid combination codes and want to be able to enter any combination of
ChartFields on the transaction pages, do not populate the Combination Code table. The system populates the
ChartField Transaction table (ACCT_CD_TABLE) with the ChartField combinations you use so that you can
track them and reuse them.
See Also
Chapter 16, "Setting Up and Working with ChartFields and ChartField Combinations," Editing ChartField
Combinations in HRMS Transactions, page 440
430 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
If you integrate with PeopleSoft Financials 8.0 or later, you can import the valid ChartField Combinations
from the Financials database and keep them up to date using Integration Broker.
1. Publish combination data information from Financials (FSCM) to HCM using the
HR_ACCT_CD_LOAD Integration Broker service operation.
When HRMS receives this service operation, the handler arranges the data in the correct layout and
populates the GL_ACCT_CD_TBL.
2. Run the Load Combination Code SQR process (BUD003) to populate the Valid Combination table.
This diagram illustrates importing valid combination codes from the Financials database as described above:
If you integrate with a financials system that does not have Integration Broker capability, you can use the
Inbound Flat File process to load and maintain the Valid Combination table (VALID_COMBO_TBL).
To populate valid combination codes using the Inbound Flat File process:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 431
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
1. Create a flat file that contains valid combination data in the layout format specified by
GL_ACCT_CD_TBL.
2. Initiate the Inbound Flat File process to publish this combination data using the HR_ACCT_CD_LOAD
service operation.
When the service operation is received, the handler arranges the data in the correct layout and populates
the GL_ACCT_CD_TBL
3. Run the Load Combination Code SQR process (BUD003) to populate the Valid Combination table.
This diagram illustrates importing valid combination codes using a flat file as discussed above:
432 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Manual Loading
If you do not integrate with PeopleSoft Enterprise Financials, you can enter valid ChartField combinations
directly into the Combination Code Table page. This page is not available for manual data entry if the GL
indicator is selected on the Installation table.
See Also
PeopleSoft Enterprise Human Resources PeopleBook: Integration Interfaces, "Using the Flat File Utility"
If you integrate with PeopleSoft Financials 8.0 or later, you can use the HR_CHARTFLD_COMBO_SYNC
service operation to keep the Speed Type table up to date. Any change made to the Speed Type table in the
Financials database triggers the Integration Broker update to HCM.
Load Combination Code RUNCTL_FILEPATH Set Up HRMS, Common Run the Load Combination
Table Definitions, ChartField Code process (BUD003) to
Configuration, Load load the Combination Code
Combination Code Table, table with ChartField
Load Combination Code combinations already
Table imported into the
GL_ACCT_CD_TBL using
the HR_ACCT_CD_LOAD
service operation.
Combination Code Table VALID_COMBO_TBL Set Up HRMS, Common Review all combination
Definitions, ChartField codes imported into HRMS
Configurations, and loaded by the Load
Combination Code Table, Combination Code process
Combination Code Table (BUD003)
Manually define and review
valid combinations of
ChartField values if not
importing them.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 433
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Combination Code Report PRCSRUNCNTL Set Up HRMS, Common Run the Combination Code
Definitions, ChartField report (PAY760) to report
Configurations, on the contents of the Valid
Combination Code Report Combination table
(VALID_COMBO_TBL).
As of Date Enter the as of date for the ChartField combinations you are importing from
PeopleSoft General Ledger.
434 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Inactivate Accounts Not When this option is selected, the system inactivates combinations for which it
Downloaded? doesn't find matches in the current fiscal year.
When this option is blank, old combinations remain active for the current fiscal
year.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 435
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Note. You cannot change the ChartField values for combination codes imported from Financials, but you can
change the description and make it active or inactive.
436 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
GL Combination Code Enter this code on the HRMS pages to use this combination of ChartFields in a
(general ledger transaction.
combination code)
The system generates the combination code sequentially based on the Installation
table's Last Combination Code Assigned field under these conditions:
The ChartField combination is received from Financials by Integration
Broker.
The GL Combination Code value is not supplied on the inbound flat file.
You manually add the ChartField combination and do not pre-assign the GL
Combination Code value.
Valid Value This field is available for entry when entering the ChartField combination for the
first time for the setID. Select it if the ChartField combination is valid. If the
combination already exists with the same setID, this field is populated based on
the value of the preexisting combination and is unavailable for change.
Funding Source Click this link to view the Funding Source Information page, which displays the
Information default funding end date. The Manage Commitment Accounting business process
uses the default funding end date in department budgets and in encumbrance
definitions.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage
Commitment Accounting, "Defining Fiscal Year Budgets," Funding End Dates
and Multiyear Encumbrances.
ChartField Detail
If you're setting up combination codes manually, enter the ChartField value for each ChartField that applies to
this ChartField combination.
Note. Only the ChartFields that are active on the Standard ChartField Configuration page are visible on this
page.
This section provides an overview of the ChartField Transaction search page, the ChartField Transaction
Table, and discusses how to review and maintain ChartField transactions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 437
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
You can use the Transaction Report (PAY710) to report on the contents of the ChartField Transaction table.
Note. If you are not using valid combination codes and want to be able to enter any combination of
ChartFields on the transaction pages, do not populate the Valid Combination table. The system populates the
ChartField Transaction table (ACCT_CD_TABLE) with the ChartField combinations you use so you can
track them and reuse them.
ChartField Transaction PRCSRUNCNTL Set Up HRMS, Common Run the Transaction Report
Report Definitions, ChartField (PAY710) to report on the
Configurations, ChartField contents of the ChartField
Transaction Report Transaction table.
438 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
The ChartField information on this page is unavailable for entry, but you can maintain information about the
combination. Only the ChartFields that are active on the Standard ChartField Configuration page are visible
on this page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 439
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Combination Code If this is not a valid combination code imported into or created in the Valid
Combination table, the system assigns this unique combination of ChartFields a
combination code. You can use the combination code on the transaction pages to
reuse this particular combination of ChartFields.
Direct Charge Select this check box to indicate whether you'll use this combination code during
the Actuals Distribution process. This field is for information only; it has no
affect on processing.
Prorate Liability If you want to prorate liabilities, select this check box.
Indicator The system looks for the Prorate Liability Indicator flag when it runs the Actuals
GL Interface process. If you select this indicator, employee paid taxes and
deductions are prorated back across the earnings expenses.
Encumbrance Account These fields are available for use in your own GL interface programs. The
and Pre-Encumbrance Manage Commitment Accounting business process in PeopleSoft Enterprise
Account Human Resources does not use these fields.
Funding Source Click this link to view the Funding Source Information page, which displays the
Information default funding end date for this combination code.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage
Commitment Accounting, "Defining Fiscal Year Budgets," Funding End Dates
and Multiyear Encumbrances.
440 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
If you integrate with PeopleSoft Financials 8.4.01 or higher, the system uses the
COMBO_CF_EDIT_REQUEST and COMBO_CF_EDIT_REPLY service operations to validate the
combination with the Financials database.
If you do not integrate with PeopleSoft Financials 8.4.01 or higher and you populated the Valid
Combination table (VALID_COMBO_TBL) with valid combinations, the system searches the Valid
Combination table to find the ChartField combination that matches the individual ChartField values
specified.
If you do not integrate with PeopleSoft Financials 8.4 or higher and you did not populate the Valid
Combination table, the system assumes the combination of ChartFields that you selected is valid and
searches the Transaction table to find the match.
If it finds a match, it uses the corresponding combination code. If it does not find a match, it generates a
combination code using the next available number.
Note. The effective date of the newly created combination code is the current date. If the effective date of
the transaction is earlier than this date, you need to modify the effective date of the newly created
combination code so that it will be a valid code for the transaction from which you created it.
ChartField Details HMCF_HRZNTL_CFLD Click the ChartField Details Enter or review ChartFields
or Edit ChartFields link or or combination codes in
button on an HRMS PeopleSoft HRMS
transaction page. transactions.
Search Combination Codes HMCF_VLD_CMBO_SRCH Select the Combination Search for ChartFields
Codes search option and using valid combination
click the Search button on codes.
the ChartField Details page.
Search Speed Types HMCF_SPD_TYP_SRCH Select the Speed Types Search for ChartFields
search option and click the using PeopleSoft Financials
Search button on the Speed Types.
ChartField Details page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 441
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Note. This page might have a more specific name, depending upon the transaction page from which you
access it.
If the combination code is already entered on the transaction page, this detail page displays the associated
ChartField values. If you are in correction mode or in a new effective dated row on the transaction page, then
you can make changes to individual ChartField values and let the system determine if the new combination is
valid. Otherwise the page is display only and you can only review the ChartField values.
If there is no combination code entered on the transaction page, all ChartField values are blank on the detail
page and you can enter the specific ChartFields required.
Note. Only the ChartFields that are active on the Standard ChartField Configuration page are visible on this
page.
Search Options
Select from the available options to search for an existing ChartField combination. The options available
include the following, depending upon the combination code tables that you have set up:
Combination Codes
This option is available if you populated the Valid Combination table (VALID_COMBO_TBL).
Speed Types
This option is available if you imported SpeedType values from PeopleSoft General Ledger.
442 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 16 Setting Up and Working with ChartFields and ChartField Combinations
Note. Only the ChartFields that are active on the Standard ChartField Configuration page are visible as fields
on this page.
The system finds all ChartField combination codes that match those ChartField values.
The system returns you to the ChartField Details page with all individual ChartField values populated.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 443
Setting Up and Working with ChartFields and ChartField Combinations Chapter 16
Note. Only the ChartFields that are active on the Standard ChartField Configuration page are visible as fields
on this page.
The system finds all speed types that match those ChartField values.
The system returns you to the ChartField Details page with all individual ChartField values populated.
3. Since this is selected from speed types, you might have to enter additional ChartField values to form a
valid ChartField combination.
444 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17
This section provides an overview of Swiss postal code maintenance and discusses how to update Swiss valid
addresses.
1. Download the latest update of postal codes from the website of the Swiss Post and note the path to the file
in which you save it.
2. Download the latest update of alternate names from the website of the Swiss Post and note the path to the
file in which you save it.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 445
Setting Up Local Country Functionality Chapter 17
3. Use the Load Postal Codes CHE page to enter the file paths and load the valid addresses and alternate
names files to the Valid Addresses table.
The system uses the information on the Valid Addresses table to validate municipalities against the postal
code.
Load Postal Codes CHE POSTAL_LOAD_CHE Set Up HRMS, Install, Load Swiss postal code
Product and Country information into the Valid
Specific, Load Postal Codes Addresses table.
CHE, Load Postal Codes
CHE
Postal Codes File Enter the complete path to the Postal Code file that you downloaded from the
Swiss Post.
446 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
Alternate Names file Enter the complete path to the Alternate Names file that you downloaded from
the Swiss Post.
Load Data Click to load the postal code data into the Valid Addresses table.
State, Postal Code, and Initially, these fields display the current data from the Valid Addresses table.
City After you run the load process, the updated information appears.
City Specify the city that is associated with this industrial inspection code according
to the German Berufsgenossenschaft.
This section lists the page used to load Italian city data.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 447
Setting Up Local Country Functionality Chapter 17
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Setting Up Country-
Specific Tables"
Load Cities ITA RUNCTL_CITYUPDATE Set Up HRMS, Install, After downloading the city
Product and Country code data file from the
Specific, Load Cities ITA, Ministero delle Finanze, run
Load Cities ITA the ITA City Update
process to update Italian
city data.
This section provides an overview of education level age and discusses how to:
This section discusses how the system uses the Education Level Age Basis in the eventual determination of a
worker's education age-related pay. This section uses many acronyms, so here's a quick reference:
448 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
Acronym Meaning
Company A has set the Education Level Age Basis (ELABa) for four years of college at 22. The company
also set the Standard Calculation Birthday (SCB)the anniversary for incrementing years of serviceto
April 1.
Hiroshi was born on February 6, 1972 and graduated after four years of college on March 23, 1994 at age 22.
He then spent two years travelling around the world. Company A hired him on June 1, 1996. He is not hired
on April 1 because he didn't get back from his travels until May 1996. At the time he is hired, he is 24 years
old.
For the purpose of calculating Hiroshi's education age-related pay, each year the system needs to calculate
Hiroshi's Education Level Age. It will use his Education Level - Adjusted Birth Date to do this.
In calculating a worker's ELABi, the system uses the ELABa, the Company Seniority Date (CSD), and the
company's SCB.
The relationship between the worker's CSD and the company's SCB may result in an adjustment to the
worker's ELABa, called the Adjusted Education Level Age Basis or AELABa. If the month/day of a worker's
hire date (as determined by the CSD field) is after the company's SCB (that is, CSD is greater than SCB), the
worker's ELABa is decreased by 1.
In Hiroshi's case, because his June 1 month/day hire date (also his CSD) falls after the company's April 1
SCB, his ELABa is decreased by 1. If he had been hired on or before April 1, there would be no adjustment to
his ELABa.
Since CSD month/day (Jun 1) > SCB month/day (Apr 1), adjustment = -1
ELABa 1 = AELABa
22 1 = 21
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 449
Setting Up Local Country Functionality Chapter 17
The system now uses the AELABa (21) to determine Hiroshi's ELABi year.
or
1996 21 = 1975
So for education age-related pay calculations, Hiroshi's ELABi is April 1, 1975, the combination of the
company's SCB month/day and Hiroshi's ELABi year (remember, he was born February 6, 1972).
One year later, 1997, the system needs to know Hiroshi's ELA. This is the calculation:
or
This is the same ELA as a graduate who started with the company immediately after college. This set of
calculations has, then, effectively adjusted Hiroshi's ELA, upon which education age-related pay is based, to
take into account the two years that he spent traveling and the fact that he started work after the company's
SCB.
Note. If your company considers that the lapse of two months from April to June is not significant, you can
adjust Hiroshi's ELABi from April 1, 1975 to April 1, 1974. Then, for the same 1997 calculation, Hiroshi's
ELA is 23 (April 1, 1997 to April 1, 1974), the same as a new graduate who has worked for one year.
See Also
450 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
Load Postal Codes JPN RUNCTL_POSTAL_JPN Set Up HRMS, Install, Import Postal Code CSV
Product and Country files provided by Japan
Specific, Load Postal Codes Post.
JPN, Load Postal Codes
JPN
The system uses these age bases in the calculation of a worker's Education Level-Adjusted Birth Date, which
is, in turn, used in the calculation of the worker's Education Level Age and education level age-related pay.
Education Level Age This is the value you associate with the Highest Education Level that you
Basis selected in the first field. The system uses this in calculating a worker's
Education Level-Adjusted Birth Date, which is used in the calculation of a
worker's education level age.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 451
Setting Up Local Country Functionality Chapter 17
Note. The Highest Education Level values are translate values from the Highest Education Level table. You
access the table to put workers' highest education levels on their Personal History page in Personal
Information. If you change any of these translate values (inactivate them, for example), you will need to
change any worker records that were using the value to use another value. If you add a translate value and
you want to associate an education level age basis with it, you must also add it to this page and allocate an
Education Level Age Basis to keep it synchronized with the Highest Education Level table. If you don't add
it, and you use the new Highest Education Level valuein Personal Data, Personal Profile, for example
the system will not be able to calculate the worker's Education Level - Adjusted Birth Date (it will remain
blank). Consequently, the system will not be able to calculate the worker's Education Level Age.
This is the single date, or anniversary, on which your workers' education level ages increment by one.
Educ Lvl Month Enter the month, where January = 1, February = 2 and so on. This sets the month
(education level month) of your organization's Standard Calculation Birthday, the date on which all
workers' company years of seniority increment by one year. It is used in the
calculation of each worker's Education Level Age.
Educ Level Day This is the day of the month of the Standard Calculation Birthday. For example,
(education level day) Month 4, Day 1 sets the Standard Calculation Birthday as April 1.
452 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
Defined Range Check Select to ensure the system checks that any record added to a Job Data -
Compensation page with a compensation rate code of class Defined Rate of Pay
(DFRPAY) is within the range that you have defined for that grade on the Salary
Grade Table.
The check applies to both a manually added record and an automatically added
record.
Selecting this check box also ensures that only one compensation rate code of the
class DFRPAY can be entered on a worker's Compensation page.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the
Workforce," Entering Compensation Information
Note. Before using this page, you must download and extract the CSV file from Japan Post's website and post
it to a FTP server located at your site. The CSV file must be encoded in Shift-JIS character set. You must
define URL data in the PeopleTools Utilities menu before using this Load Postal Code process.
See Chapter 6, "Setting Up and Installing PeopleSoft HRMS," Specifying the Address Format for a Country,
page 153.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 453
Setting Up Local Country Functionality Chapter 17
URL Identifier Select the FTP Uniform Resource Locator (URL) where the CSV file that
contains the postal codes is located.
All Prefectures Select this option to load postal data for all prefectures.
Note. Because there are more than 120,000 postal codes rows, consider batch
performance when importing all rows.
Selected Prefecture Select this option to load postal codes for a specific prefecture.
Load Results
If the length of Address1 or Address AC1 is more than 55 characters, the fields are left blank. Also, if the
length of Address1 or Address AC1 is too long and divided into multiple rows, only the first row is imported
and the rest of the rows are printed on the log reports as unimported rows.
If you want to remove "Not listed as below" as the Address 1 and AC Address 1, register these text strings in
the Strings Table; the Program ID is HGJPPSTL. Set the text that you want to remove to String Text fields.
All rows might not appear when there are multiple rows for a single postal code with the same State, City,
Address1, but different Address1_AC because of different pronunciation.
If expected data is not loaded, add it or edit it on the Postal Codes JPN page.
After completion of this process, the system generates a process log report that lists the number of rows
imported, the number of rows not imported, and a detailed reason for the latter. Possible reasons for not
importing rows include:
The import file is for a different prefecture from the one specified in the Selected Prefecture field.
454 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
Municipal Code Enter the code for the Japanese municipality that this postal code belongs to.
Prefecture Select the prefecture for this postal code from the list.
This section discusses how to import postal codes into the Postal Code JPN .
Load Postal Codes NLD RUNCTL_POSTAL_NLD Set Up HRMS, Install, Import postal codes into the
Product and Country NLD Postal Code JPN in
Specific, Load Postal Codes your human resources
NLD, Load Postal Codes system.
NLD
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 455
Setting Up Local Country Functionality Chapter 17
The Dutch postal authority provides a postal code table to which you can subscribe. The Load Postal Code
Table process loads all of the postal codes provided in a source file by the Dutch Post (TPG Post) into your
human resources system.
Initial Postal Code Load Enter the initial postal code load file, including the path information, if you're
file adding Dutch postal code data to your system for the first time.
Update Postal Code File Enter the updated postal code file, including the path information, if you're doing
a periodic update of the Dutch Postal Code Table.
Run Click to run this request. PeopleSoft Process Scheduler runs the NLD Load
Postal Code Table process at user-defined intervals.
If you do business in Spain, enter the information that is required by the Spanish government concerning your
organization's primary industry activity and the insurance company that you use for workplace accidents or
illnesses.
The Spanish government also requires every Spanish worker to belong to a Social Security Work Center.
Employers use the work center number information to report worker information to the Spanish Social
Security National Institute (Instituto Nacional de la Seguridad Social).
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the
Workforce," Adding Organizational Instances for Employees, Contingent Workers, and POIs
456 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
Insurance Company Table INSUR_COMP_CD_ESP Set Up HRMS, Product Enter information about
Related, Workforce your organization's
Administration, Workforce insurance company.
Data ESP, Insurance
Company Table, Insurance
Company Table
Industry Activity Table INDSTRY_ACT_CD_ESP Set Up HRMS, Product Define the codes that are
Related, Workforce needed by your
Administration, Workforce organization.
Data ESP, Industry Activity
Table, Industry Activity
Table
This section provides an overview of national insurance prefixes and discusses how to:
Use the delivered setup table to define valid national insurance prefixes. When you enter a person's national
insurance code on the Biographical Details page, the system validates the prefix against this national
insurance prefix table.
The format of national insurance numbers is defined on the National ID Type Table page, which is described
in this PeopleBook.
See Also
Chapter 12, "Setting Up Personal Information Foundation Tables," Defining National ID Types, page 320
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Adding a Person in
PeopleSoft Human Resources," Entering Name and Biographical Data
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 457
Setting Up Local Country Functionality Chapter 17
NID Prefix GBR NID_PREFIX_GBR Set Up HRMS, Install, View the existing NID
Product and Country prefixes.
Specific, NID Prefix GBR,
NID Prefix GBR
NID Prefix Details NID_PR_GBR_SEC Click a NI prefix link or Set up a new NID prefix or
click the Add button on the change the status of an
NID Prefix GBR page. existing prefix.
458 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 17 Setting Up Local Country Functionality
By default, this page lists the NID prefixes that are active as of the current date. Click the NID prefix link to
view and update the effective date and status of the selected NID prefix.
Effective and Status To display NID prefixes that are active as of a different date or to display NID
prefixes with a different status, update the Effective field and/or the Status field
and click the Refresh button
Refresh Click to refresh the page. Use this button when you change the Effective or
Status fields.
Add Click to add a new NI prefix. The NID Prefix Details page appears.
Use this page to add a new NID prefix or change the status of an existing NID prefix. To change existing
prefixes, add a new row.
Select the date that the prefix becomes Active or Inactive and select the status in the Status field.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 459
Chapter 18
You can further distinguish geography by country, state, province, and city.
Create a market pay matrix and associate it with one or multiple job codes.
Upload data from existing salary survey tables into the market pay tables, which preserves the existing
functionality.
Import salary survey data from PeopleSoft Enterprise Workforce Rewards if your organization licenses
that application.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 461
Setting Up and Working with Market Pay Chapter 18
3. (Optional) Map existing salary survey data fields to a configurable matrix definition.
4. Associate a market pay matrix with one job code on the Job Code - Market Pay Match page or to several
job codes on the Associate Mkt Pay to Job Codes page.
(Workforce Rewards users only): Subscribe to message published from Workforce Rewards.
Set up Integration Broker messaging to subscribe to the message published by Workforce Rewards.
These diagrams illustrate the market pay process flow as discussed above:
462 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 463
Setting Up and Working with Market Pay Chapter 18
Prerequisites
These tasks are prerequisites to setting up and using market pay matrices:
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the
Workforce."
4. Set up the integration with Workforce Rewards if you plan to import salary data from that application
using the COMP_MKT_RATE_SYNC Integration Broker message and service operation.
464 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
MARKET_PAY
WFR_SURVEY_DATA
The system uses this matrix if you import salary data from the Workforce Rewards application.
You can set up additional configurable matrices to include market pay survey data.
Note. If you have maintained survey matches in PeopleSoft, you can continue to do so by selecting the
delivered Market Pay matrix or by creating a new matrix with fields such as Survey Provider and Survey Job
Code. These fields enable you to create ad hoc survey participation reports at any time. You create the reports
based on the requirements of your survey providers.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Using Configurable Matrices"
Define Geographical Areas GEOGRAPHY_TBL Set Up HRMS, Product Define geographical areas
Related, Compensation, by city, state, province, and
Market Pay, Define country. Use these areas to
Geographical Areas, Define organize market pay data.
Geographical Areas
Matrix Definition WCS_LK_TBL_DEFN Set Up HRMS, Common Set up a market pay matrix
Definitions, Configurable definition.
Matrices, Define Matrices,
Matrix Definition
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 465
Setting Up and Working with Market Pay Chapter 18
Search Keys WCS_LK_TBL_KEYS Set Up HRMS, Common Specify the search keys to
Definitions, Configurable be used to match worker
Matrices, Define Matrices, data used in market pay
Search Keys surveys.
Load Configurable Matrix WCS_LK_TBL_KEY_SEC Click the Select Values Automatically load search
Keys From Prompt Table link on keys for specific sources
the Search Keys page. using a prompt table.
Data Content WCS_LK_TBL_DATA Set Up HRMS, Common View or enter values for the
Definitions, Configurable output data.
Matrices, Define Matrices,
Data Content
466 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
You can enter a geography as broad as an individual country, or you may target a specific country, state,
province, or city. You can have one or more rows of country, state, province, or city data. However, you
cannot list the same combination of country, state, province, or city within the same geographical area.
Warning! Use care when listing the same combination of country, state, province, or city in different
geographies, as this may result in conflicting information when combined with worker data.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 467
Setting Up and Working with Market Pay Chapter 18
Effective Date Enter a date that is equal to or less than the date you want to link it to one or
more job codes.
Status Select Active. The default value for all configurable matrices is Inactive. You
must change the status to Active in order to use the matrix.
468 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
Inputs page
Optional Prompting
If you specify GEOGAREA as the source ID, you can enter prompt values in this group box. Enter
GEOGRAPHY_TBL as the table and GEOGRAPHY_ID as the field. There is no automatic validation of key
values for geographical areas.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 469
Setting Up and Working with Market Pay Chapter 18
Source ID Select the source for the market pay data. The maximum number of inputs for
each matrix is 15. Common types of inputs include:
Geographical Area
Survey Provider
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Predefined Source IDs and Result IDs for Configurable Matrices"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Using Configurable Matrices," Defining Sources Based on Geographical Areas
Outputs page
470 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
Result ID Select an output for the market pay matrix. Typical outputs include currency,
base, variable, and total compensation. You can have a maximum of 30 outputs
for each matrix.
These system-delivered values have default names, however, you can edit them
to the label that best suits your business.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base
Compensation and Budgeting, "Predefined Source IDs and Result IDs for
Configurable Matrices."
Use this page to enter the key values against which worker data is matched. Suitable search keys for a market
pay matrix are Geographical Area or Survey Provider.
Note. You can create a matrix without specifying any search keys and output data values. For example, you
might want to define a template for a matrix and then load values from other sources such as a flat file.
However, if you change the status of the matrix to Active and you have not defined any search criteria or
values, you receive a warning.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 471
Setting Up and Working with Market Pay Chapter 18
Use this page to view input and output fields. You may leave the data values blank for the loading of market
pay data from a file or Workforce Rewards. You may also enter the data manually.
View page
After you have entered all data content for outputs, you must save the matrix. You can view the matrix on this
page only after you have saved it.
When you click the Display Saved Matrix button, the results generated are from the last saved version of the
matrix.
472 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
Important! This page displays only the last saved version of the matrix.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Using Configurable Matrices."
Define Salary Survey SP_SURV_MAP_TBL Set Up HRMS, Product Map market pay matrix
Mapping Related, Compensation, fields to existing salary
Market Pay, Define Salary survey fields.
Survey Mapping, Define
Salary Survey Mapping
Associate Mkt Pay to Job SP_SAL_SURV_TBL Set Up HRMS, Product Associate market pay
Codes Related, Compensation, matrices to specific job
Market Pay, Associate Mkt codes.
Pay to Job Codes, Associate
Mkt Pay to Job Codes
Market Pay Match JOBCD_MP_SAL_SURV Set Up HRMS, Foundation Associate a market pay
Tables, Job Attributes, Job matrix to a specific job code
Code Table, Market Pay using the Job Code table.
Match
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 473
Setting Up and Working with Market Pay Chapter 18
Load Market Pay Data from SP_SURVLOAD_TBL Set Up HRMS, Product Load market pay data from
File Related, Compensation, files to overwrite existing
Market Pay, Load Market data or add new data.
Pay Data from File, Load
Market Pay Data from File
Report Market Pay by Job SP_MPAY_RPT_TBL Set Up HRMS, Product This effective-dated report
Code Related, Compensation, displays all the market pay
Market Pay, Report Market definitions ever associated
Pay Data by Job Code, with a particular job code.
Report Market Pay Data by
Job Code
474 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
Note. The MARKET_PAY and WFR_SURVEY_DATA matrices are delivered with the system. You can
also define configurable matrices to include market pay survey data.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Using Configurable Matrices," Defining and Maintaining Configurable Matrices.
Matrix Field The system displays the values from the Matrix Definition page.
Target Field Select a value. These values come from the Job Code table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 475
Setting Up and Working with Market Pay Chapter 18
Click the Add button to create a new association between market pay data and job codes. Click Search to find
existing values.
Edit Matrix Click this button to access the Data Content page in the Matrix Definition
component, where you can add, modify, or delete the Matrix Data field
information.
Job Code Select the job codes to which you want to associate the market pay matrix. You
may link multiple job codes to one market pay matrix. However, a single job
code can only be associated to one market pay matrix at a given time.
Note. You must be in Correct History mode to see new effective-dated matrix data for a job code. You can
have only one market pay matrix associated with a single job code at a given time.
476 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 18 Setting Up and Working with Market Pay
Matrix Name Select the market pay matrix that you want to associate with this job code.
Edit Matrix Click this button to access the Data Content page on the linked matrix, where you
can view and edit values associated with this matrix.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Base Compensation and Budgeting,
"Using Configurable Matrices," Entering Data Content Fields.
Required fields for the input file are SETID, EFFECTIVE DATE (date in the format yyyy-mm-dd),
EFFECTIVE STATUS, DESCRIPTION, JOBCODE, MATRIX ID, The fields must be in the order shown.
Also the fields in the matrix must follow the matrix ID and also be in the same order as they are in the matrix.
We recommend that you open the file and verify the date format, as some utilities such as Excel might
reformat your date differently than is displayed. You can format the date the correct way by defining it
manually in Excel.
File Name Enter the name of the file from which you want to import the market pay data.
File Location Enter the location of the import file. You can also specify a machine name for a
location in the format "\\machinename\directory".
Load Properties Select Append to add the market pay information to the existing file.
Select Overwrite to replace the data that is already in the system with the data
that is in the file.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 477
Setting Up and Working with Market Pay Chapter 18
Note. The COMP_MKT_RATE_SYNC service transaction loads the market rates into a delivered
configurable matrix definition. If you want to load the data to a matrix with different fields, you would have
to create a new message and service operation.
Manually enter the market pay data into the Matrix Data group box.
This page displays the current market pay data as well as previous and future market pay data when available.
478 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19
Note. The information in this chapter applies to Oracle's PeopleSoft Enterprise Payroll for North America and
Oracle's PeopleSoft Enterprise Payroll Interface. The information in this chapter does not apply to Oracle's
PeopleSoft Enterprise Global Payroll.
See Also
This section provides an overview of balance IDs and discusses how to:
Specify the quarter by company and year for each Balance Year ID.
Note. You must set up one balance ID with the Bal for Calendar Year (balance for calendar year) option
selected for each company for which you process payroll.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 479
Setting Up Pay Calendars Chapter 19
SetID - Comments BALANCE_ID_PU Click the Set ID button on View the setID established
the Balance ID Table 1 or for each company.
Balance ID Table 2 page.
480 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
All other fields become unavailable for entry. The system automatically creates the balance ID details for
twelve periods in the year, four quarters in the year, and the end date default of Month.
If you are creating a non-calendar year balance ID, you must specify values in the Periods in a Year/Quarters
in a Year, End Date Default, Use Date, and Balance ID Details fields. You must also select the balances to be
maintained.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 481
Setting Up Pay Calendars Chapter 19
Entering Values
Set ID Click this button to access the SetID page, where you can see which balance
setIDs are used for which companies. The setID for the Balance ID Table
component is specified on the Company Table Company Location page.
Balance ID Entered on the Balance ID Table search page. Identifies a balance period, for
example CY for Calendar Year, FY for Fiscal Year, or BY for Benefit Year.
Once you establish a balance ID it should not be changed.
Periods in a Year If you are not setting up a balance ID for a calendar year, specify the number of
periods in a year.
Quarters in a Year If you are not setting up a balance ID for a calendar year, specify the number of
quarters in a year.
Bal for Calendar Year Select if you are setting up a balance ID for a calendar year. This causes the
(balance for calendar remaining check boxes and edit boxes on the page (except for Description and
year) Short Desc) to become unavailable for entry. All balance types are automatically
selected for the calendar year, and the Check Date option is automatically
selected. However, the Yr field and Create button appear and become available
for entry.
Create Click this button to instruct the system to automatically populate the company,
year, period, begin date, end date, period name, and abbreviated fields for the
specified company and year.
If you are not setting up a balance ID for a calendar year, use this group box to specify the end date to apply
for the calendar year.
None Select if you do not want a specific end date for the calendar year.
Month, BiMonth, Select the corresponding option if you want a monthly, bimonthly, quarterly, or
Quarterly, and Days daily end date.
Maintain Earns Bal, If you are not setting up a balance ID for a calendar year, select the
Maintain Tax Bal, corresponding check box to maintain earnings balances, tax balances, deduction
Maintain Dedn Bal, balances, paycheck balances, or garnishment balances for the year you are
Maintain Check Bal, and creating.
Maintain Garn. Bal
Note. Each of these balances is maintained for the year being defined. For
example, if you are defining a fiscal year and Maintain Earns Bal was selected,
earnings balances for the fiscal year are maintained.
482 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Use Date
If you are not setting up a balance ID for a calendar year, use this group box to select the balance types you
want to maintain. You must set up the first period, begin date, and end date for each company and year. After
you enter this, the begin and end dates are set by default automatically for each row for that company/year.
Check Date Select to maintain balances by the check date being processed. For example, if
you are defining a fiscal year of July 1, 2006 - June 30, 2007 and your check date
was June 23, 2007, the balance would be included in this fiscal year. If, however,
the check date were July 1, 2007, the balance would be in the next fiscal year.
Period End Date Select to maintain balances by the period end date being processed. For example,
if you are defining a fiscal year of July 1, 2006 - June 30, 2007 and your pay
period end date was June 23, 2007, the balance would be included in this fiscal
year. If, however, the pay period end date were July 1, 2007, the balance would
be in the next fiscal year.
Balance ID Details
If you are not setting up a balance ID for a calendar year, use this group box to specify the year, period, begin
date, end date, period name, and abbreviated fields for the specified company and year.
Note. For the first entry, enter values in the Year, Period, Begin Date, End Date, Period Name and
Abbreviation fields; after you have entered this information, the values in the Year, Period, Begin Date and
End Date fields are set by default automatically for any additional rows, based on the values entered in the
previous row.
Year, Period, Begin Enter the year, period, begin date, end date, and period name for the balance
Date, End Date, and type.
Period Name
Abbreviation Enter the abbreviation for the period name.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 483
Setting Up Pay Calendars Chapter 19
Comments page
The Set ID page displays the set ID established for each company. This helps you to know which set ID to
enter for a specific company.
Specifying the Quarter by Company and Year for Each Balance Year ID
Access the Balance ID Table 2 page (Set Up HRMS, Product Related, Payroll for North America, Payroll
Processing Controls, Balance ID Table, Balance ID Table 2).
484 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
If you selected the Bal for Calendar Year check box and clicked the Create button on the Balance ID Table 1
page, the field information for the Balance ID Table 2 page automatically appears.
If you did not specify a calendar year balance ID type on the Balance ID Table 1 page, you must enter a value
for the Year, Quarter, Period Name, Abbreviation, From Period, and To Period fields. For each row that you
add after the first, the Year, Quarter, and From Period fields are set by default, based on the value in the
Quarters in a Year field.
See Also
Chapter 19, "Setting Up Pay Calendars," Defining Balance IDs, page 480
This section provides an overview and discusses how to create pay run IDs.
Generally, all calendar entries that share a pay run ID have the same pay end date, but not necessarily the
same pay frequency. For example, if you have a semi-monthly and a monthly pay calendar, both calendars
can be processed together for the month-end run, because they have identical pay period end dates.
Note. A pay run ID must be unique throughout payroll history. You must create pay run IDs in the Pay Run
table before you enter them on the pay calendar. The pay run ID may be up to 10 characters. PeopleSoft
suggests that you use as many of the 10 available characters as is necessary to ensure that your pay run ID is
easily identifiable.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 485
Setting Up Pay Calendars Chapter 19
486 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Short Description Enter a short description of the pay run. This description appears on various
delivered payroll reports (for example, PAY002, the Payroll Register). It also
appears on the Run Control when you enter the pay run ID for Paysheet Creation,
Payroll Calculation, and Payroll Confirmation.
Company, Pay Group, The Pay Calendar Data group box displays all the pay calendar entries grouped
and Pay Period End under the pay run ID. After you enter the pay run IDs on the Pay Calendar table,
Date return to this page to check the pay calendar data assigned to each pay run ID.
This section provides overviews of pay calendars and FLSA calendars and discusses how to:
(USF) Review interface status and periods for federal leave accrual processing.
To process payrolls, the pay calendar entry being processed must be assigned a pay run ID. Generally, all pay
calendar entries that share a pay run ID have the same pay end date, but not necessarily the same pay
frequency. Typically, but not always, you would set up a different pay run ID for each Pay Period End Date
on the Pay Calendar Table component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 487
Setting Up Pay Calendars Chapter 19
Note. All pay groups attached to a single pay run ID must have the same setting in the Continue With Errors
option on the Pay Group Table Process Control page. If this condition is not met, the system cannot transfer
any paysheets with errors for the pay run ID.
If you have a semi-monthly and a monthly pay calendar and set up both to continue processing with errors,
you can process both calendar entries together for the month-end run, because they have the same pay period
end date. Your processing schedule and Continue with Errors setting determine which groups can or can't be
grouped together.
In the following illustration, CCB has assigned the same pay run ID (EMB) to both the February 28 Monthly
calendar entry and the February 28 Semimonthly entry to enable the system to process them at the same time.
For pay groups that do not share the same pay period end date, such as the Semimonthly mid-month pay
period (February 15 or March 15), have their own pay run IDs (MMB and MMC). Both pay groups are set up
for continue with errors processing:
Pay groups that share the same pay period end date can be assigned to the same pay run IDs while those
with different pay period end dates should be assigned their own pay run ID
You must create a calendar entry for every pay period for each pay group you set up. You must also assign a
pay run ID to each calendar entry before you run the payroll.
488 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
To build pay calendars automatically, use the Create Pay Calendars page followed by the Pay Calendar Table
page:
1. Use the Create Pay Calendars page to automatically build pay calendars.
The Create Pay Calendars page enables you to run the Calendar Build process (PSPCLBLD), which
automatically generates the pay calendar entries for all or part of a year. To run the process:
Follow the same procedure for all pay groups. Each time you run the Calendar Build process, the system
deletes the run control data. Therefore, whenever you rerun the process, you must enter the data again.
2. Use the Pay Calendar Table page to manually complete the pay calendar entries.
The Calendar Build process does not assign values to Pay Run ID, Accrual Percent, Reverse Accruals,
Aggregate ID, Off-Cycle Calendar?, Off-Cycle Ded Override, General Ded Subset ID, Benefit Ded
Subset ID, Benefit Deductions Taken, or General Deductions Taken fields on the Pay Calendar Table
page. After you run the process, you must enter values for these fields manually. Although some of these
fields are optional, you must assign a pay run ID to each calendar entry before you run the payroll.
To build a pay calendar manually or to manually complete pay calendar entries for pay calendars that were
built automatically, use the Pay Calendar Table page (PAY_CALENDAR_TABLE).
In general, you build stand alone, off-cycle pay calendars manually only to accommodate off-cycle
processing, such as adjustments, online checks, or check reversals.
If several pay groups have the same FLSA periods and FLSA period start dates, you can use the same FLSA
calendar for all of them.
The same process that creates pay calendars also creates FLSA Calendars.
Enter the FLSA Calendar ID and specify period length and period start date.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 489
Setting Up Pay Calendars Chapter 19
2. Run the Calendar Build process from the Create Pay Calendars page.
If you did not set up the FLSA calendar before you ran the Calendar Build process, you can use the Create
Initial FLSA Cal Period COBOL SQL process (PSPIFLSA) to build FLSA calendars. You can also use
this process if pay group FLSA status is updated or changed.
3. To view the FLSA periods, return to the FLSA Calendar Table page.
Note. The system creates the FLSA calendar for the entire calendar year. The pay calendar dates do not affect
the FLSA calendar.
FLSA Calendar Table FLSA_CALENDAR Set Up HRMS, Product Set up FLSA calendars.
Related, Payroll for North
America, Payroll Processing
Controls, FLSA Calendar
Table, FLSA Calendar
Table
Create FLSA Calendars RUNCTL_FLSACALPD Set Up HRMS, Product Run the Create Initial FLSA
Related, Payroll for North Cal Period COBOL SQL
America, Payroll Processing process (PSPIFLSA), which
Controls, Initial FLSA creates FLSA calendars for
Calendar, Create FLSA existing pay groups and pay
Calendars calendars.
490 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Payroll Status GVT_PAY_STATUS_SEC Click the Federal button on Indicate whether interfaces
the Pay Calendar Table have been run and specify
page. periods for Federal Leave
Accrual processing.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 491
Setting Up Pay Calendars Chapter 19
Pay Calendar Report PRCSRUNCNTL Set Up HRMS, Product Generate a report that lists
Related, Payroll for North information from the Pay
America, Comp/Earnings Calendar Table component,
Table Reports, Pay which contains the cycles
Calendar, Pay Calendar that you create for payroll
Report processing by pay group.
Each entry in the table
corresponds to a pay period
for a pay group.
Open/Close Pay Calendar RUNCTL_PAY130 Payroll for North America, (USA) Reopen a closed pay
U.S. Annual Processing, calendar for the purpose of
Year-End/New Year entering year-end
Preparation, Open/Close adjustments required after
Pay Calendar, Open/Close processing the first payroll
Pay Calendar of the year.
492 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Open/Close Pay Calendar RUNCTL_130CN Payroll for North America, (CAN) Reopen a closed pay
Year-End Processing CAN, calendar for the purpose of
Year-End/NewYear entering year-end
Preparation, Open/Close adjustments required after
Pay Calendar, Open/Close processing the first payroll
Pay Calendar of the year.
FLSA Calendar ID The FLSA Calendar ID that you added or selected in the entry page displays
here. Use the FLSA Calendar ID to link an FLSA calendar to a pay group. For
example, an FLSA Calendar ID of 14, MON-SUN, would be linked to pay
groups whose pay period is 14 days and whose FLSA pay period begins on
Monday and ends on Sunday. This ID is then used on the FLSA Period
Definition page to associate the FLSA calendar to the pay group.
FLSA Period in Days Use this field to define the length of the FLSA period for this Calendar ID. The
information you enter here is used with the FLSA Period Start Date to determine
the FLSA Begin Dates and FLSA End Dates, which display on this page after
you've created FLSA calendars.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 493
Setting Up Pay Calendars Chapter 19
FLSA Period Start Date Use this field to define the starting date from which succeeding FLSA periods are
set. You should set this field to the earliest start date of any of the pay groups that
use this FLSA Calendar ID.
Note. After you create the FLSA calendar using the Calendar Build process, the FLSA Calendar Table page
becomes display-only. Each row in the FLSA Dates group box displays the FLSA Begin and End Dates for
one FLSA work period. After you create the FLSA calendar and it becomes display-only, you cannot make
any changes or corrections.
See Also
Chapter 19, "Setting Up Pay Calendars," Understanding FLSA Calendars, page 489
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "(USA) Setting Up Additional U.S. Payroll
Functionality," Setting Up for FLSA Calculation
Note. Use the Create Pay Calendars page to set up and run the Calendar Build process. Once the calendars are
built, use the Pay Calendar Table page to assign pay run IDs and other information.
494 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Note. You must set up the calendar year balance ID before creating calendars.
Pay Period End Date Enter the first pay period end date for the pay calendar. For example, for a semi-
monthly payroll for 2009, enter 01/15/2009. To build a pay calendar for a partial
calendar year, enter the end date of the pay period where you want the calendar
to start. In other words, to start the calendar for the pay period ending on March
15, enter 03/15/2009.
Check Dt Days From Enter a value representing the number of days (plus or minus) from the pay
Pay End Dt period end date to the check issue date. For example, if the pay period end date is
January 31 and the check date is February 3, set the number of days to 3. If the
pay period end date is January 31 and the check date is January 30, enter -1.
Should the check date fall on a holiday or weekend day, the system automatically
searches backwards on the calendar to find the first workday before the holiday
or weekend day to issue checks.
Pay Periods Per Year The number of pay periods per year appears. This number depends on the Pay
Frequency assigned to the pay group.
Pay Year (USF) This field appears only for U.S. federal customers.
The IRR process requires a pay year. When processing IRRs, the IRR Fiscal Data
accumulator identifies all monies that come from the pay year. Enter the pay year
to which the pay calendar applies.
Calendar Yr Run This value is used by federal leave processing on particular leave types for which
(calendar year run) accrual begins with the calendar year. Of the calendar entries to be created
automatically, enter the pay calendar number that identifies which pay period is
designated to begin the leave plan calendar year. For example, for a monthly
payroll there are twelve pay calendars in a year. January would be the starting
point, so enter 1 in this field.
Pay Yr Run (pay year This value is used by federal annual leave accrual processing on leave types for
run) which accrual begins with the pay year. Of the calendar entries to be created
automatically, enter the pay calendar number that identifies which pay period is
designated to begin the pay year for leave accrual processing.
Fiscal Yr Run (fiscal This value is used by federal annual leave accrual processing on leave types for
year run) which accrual begins with the fiscal year. Of the calendar entries to be created
automatically, enter the pay calendar number that identifies which pay period is
designated to begin the fiscal year for leave accrual processing.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 495
Setting Up Pay Calendars Chapter 19
Leave Yr Run (leave This value is used by federal annual leave accrual processing only. Of the
year run) calendar entries to be created automatically, enter the pay calendar number that
identifies which pay period is designated to begin the annual leave year.
Note. The leave year begins on the first day of the first full pay period for which
the begin and end dates are both within the new year. The leave year ends on the
last day of the last pay period ending just before the pay period of the new leave
year.
See Also
Chapter 19, "Setting Up Pay Calendars," (USF) Reviewing Interface Status and Periods for Federal Leave
Accrual Processing, page 502
Chapter 19, "Setting Up Pay Calendars," Understanding Pay Calendars, page 487
496 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Off-Cycle Calendar? Select to identify the pay calendar as off-cycle processing. Two types of
processing are associated with a pay calendar: on-cycle and off-cycle. On-cycle
processing is the normal, scheduled payroll processing for a pay group and pay
period. Off-cycle processing is any other payroll activity that deviates from the
norm. Typically, off-cycle activity consists of recording manual checks issued
during this period, on-demand checks calculated and issued during this period,
and reversals processed during this period. This option enables you to run a
group of off-cycle checks that are associated with a specific check date which
may differ from your on-cycle check date.
Off-Cycle Ded Override For an off-cycle run, select this check box to specify that the Pay Calculation
(off-cycle deduction process should use the deduction override process to determine deductions.
override)
If Off-Cycle Calendar is selected and Off-Cycle Ded Override is deselected,
then the deduction override evaluation process is bypassed during pay
calculation. That means that employee-level benefit or general deduction
override will not take effect. This might be useful for an off-cycle bonus run.
Federal (USF) Click this button to access the Payroll Status page. This button appears
only for U.S. federal customers.
Pay Period End Date The pay period end date appears here. The system uses this date to determine if
an employee's pay should be prorated. It also checks this date to see whether a
holiday falls within the pay period and determines if the employee is active
within that pay period. Therefore, the system knows whether to pay the employee
for that day.
The pay calculation program uses these dates to determine which deductions and
additional pays to use.
Pay Period Begin Date Enter the pay period begin date. The system uses this date to determine if an
employee's pay should be prorated. It also checks this date to see whether a
holiday falls within the pay period and determine if the employee is active within
that pay period. Therefore, the system knows whether to pay the employee for
that day.
The pay calculation program uses these dates to determine which deductions and
additional pays to use.
Pay Run ID Select a pay run ID. Each payroll batch process must have a pay run ID to
determine what pay groups to process. All pay calendar entries with the same pay
run ID are processed at the same time. Before you start payroll processing for a
pay period, you must assign a pay run ID on this page, and that ID must first be
defined on the Pay Run Table page. The Payroll Process cannot run without a
pay run ID.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 497
Setting Up Pay Calendars Chapter 19
If you enter the same aggregate ID on multiple pay calendars, then for a given
employee, each succeeding check (whether off-cycle or on-cycle) calculated
under each of these pay calendars is aggregated with all of the already-calculated
qualifying checks of the previous pay calendars which were set up using the
same aggregate ID.
If a pay calendar has a unique aggregate ID, then for a given employee,
succeeding off-cycle and on-cycle checks are aggregated with any already-
confirmed qualifying off-cycle checks for that pay calendar.
To aggregate taxation across checks, you must also set up the earnings code with
Specified on Paysheet specified as the tax method and you must manually specify
Aggregate as the tax method on off-cycle paysheets.
See PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "(USA)
U.S. Tax Methods and Calculations," Aggregate Taxation of Multiple Checks.
Paycheck Issue Date Select a paycheck issue date. This date appears on the employee's paycheck or
advice slip. It determines the Calendar Year, Quarter, and Period for all payroll
balances. In addition, the system uses the paycheck issue date to find the
appropriate effective-dated entry in the tax tables to use for this pay calculation.
Note. The system updates employee balances (such as taxes, deductions, and
earnings) based upon the check date on the pay calendar you are processing with,
not the check date on the paysheet or check. These dates are often the same, but
not always.
Weeks in this Period Enter a value to indicate the number of weeks within the payroll cycle.
Depending on the state in which your employees are based, you may need to use
this field for tax reporting. The number of weeks is based on the number of
Wednesdays in the pay period.
498 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Pay Periods Per Year Enter a value to indicate the number of pay periods per year. When the system
calculates deductions, it checks the deduction table, annualizes the amount of
each deduction, and then divides the result by the number of pay periods per
year.
Example: If you set up a deduction for $100 per month, the system multiplies
$100 by 12 to arrive at $1200, and then, for employees paid monthly, divides by
12 to arrive at a deduction of $100 per pay period. For semi-monthly employees,
the system divides the deduction by 24.
For weekly and biweekly pay periods, it is not quite so simple. Depending on the
day of the week on which the payday falls, there may be 53 (instead of 52)
weekly pay periods during a given year; likewise, there may be 27 (instead of 26)
biweekly pay periods. To accommodate this situation, in the Pay Periods Per
Year field, specify whether the pay calendar you're defining has 26, 27, 52, or 53
Pay Periods Per Year.
The system always annualizes amounts by multiplying by 52, 26, 24, or 12,
depending on whether the deduction is weekly, biweekly, semimonthly, or
monthly; it de-annualizes by dividing by the number you enter for the number of
pay periods per year.
Note. For monthly and semi-monthly pay calendars, the Pay Periods Per Year
field is unavailable for entry; the only valid values are 12 and 24.
Balance ID Details This group box displays the year, quarter, and period applicable to the pay period
for each balance ID for which you're maintaining balances.
Accrual Percent Enter an accrual percent to calculate accrual totals for the general ledger
interface. This percentage is typically used to process pay periods that overlap
accounting periods or don't correspond to calendar months. For example, if
payroll is processed weekly, but general ledger is processed monthly, you may
need to make adjustments. If you specify a percent here, that percent of pay for
the last pay period of the month is added to accrual amounts for the general
ledger Interface. Then, in the first pay period of the following month, you can
reverse those accruals by selecting the Reverse Accruals check box and leaving
the Accrual Percent field deselected. The system responds by subtracting the
accruals from the appropriate amounts in the General Ledger Interface.
Reverse Accruals Select to reverse accruals added to the General Ledger Interface. The system
responds by subtracting the accruals from the appropriate amounts in the General
Ledger Interface. However, if you select this check box, you must leave the
Accrual Percent field deselected. If the Accrual Percent field is not deselected,
you must deselect the Reverse Accruals check box.
Note. The Accrual Percent field and Reverse Accruals check box are not
applicable to PeopleSoft Payroll for North America for E&G.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 499
Setting Up Pay Calendars Chapter 19
FLSA On-Cycle Pay Select a pay end date for FLSA off-cycle processing. This field applies only to
End Date off-cycle calendars. For on-cycle calendars, this field is unavailable for entry. If
the earnings being paid in the off-cycle are subject to FLSA (Affect on FLSA
check box on the Earnings Table General page is not set to None), enter the on-
cycle pay end date to which the earnings should be applied. The system uses this
date to determine the correct FLSA period.
Benefit Deductions Select a value to indicate how to take benefit deductions for this pay run. The
Taken default value is Deduction.
None: Select this value if you do not want to take benefit deductions.
Deduction: Select this value if you want to use the regular benefit deductions
defined on the Deduction Table pages for these employees. This is the default
value.
Subset: Select this value if you want to use a specified benefit deduction
subset. If you select this value, you must specify the subset ID in the Benefit
Ded Subset ID (benefit deduction subset ID) field.
Benefit Ded Subset ID Specify the subset ID if you selected Subset in Benefit Deductions Taken.
(benefit deduction subset
ID)
General Deductions Select a value to indicate how to take general deductions for this pay run. The
Taken default value is Deduction.
None: Select this value if you do not want to take general deductions.
Deduction: Select this value if you want to use the regular deductions defined
on the Deduction Table pages for these employees. This is the default value.
Subset: Select this value if you want to use a specified general deduction
subset. If you select this value, you must specify the subset ID in the General
Ded Subset ID (general deduction subset ID) field.
General Ded Subset ID Specify the subset ID if you selected Subset in General Deductions Taken.
(general deduction subset
ID)
Pay Period of the Month Use this option to assign a pay period to the earnings and deductions designated
for this calendar entry. When you create paysheets, the system checks if the pay
period for additional pay matches the pay period being processed, then adds the
additional pay to the paysheet. During Pay Calculation, if the pay period for a
deduction matches the pay period being processed, the system takes the
deduction from gross pay. Select the corresponding option to specify the pay
period of the month you want: First, Second, Third, Fourth, and Fifth.
500 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
The check boxes across the bottom of the Pay Calendar Table page are unavailable for entry. The system
maintains this section, which consists of process indicators, or milestones, that indicate how far along you are
in the payroll process for this calendar entry. For example, if you have already created paysheets, completed
your final Pay Calculation, and run Pay Confirmation, the system selects several check boxes on the Pay
Calendar Table page, representing the steps you have already completed.
The background programs and SQRs maintain these indicators. During payroll processing, the system queries
these indicators to verify that you are running the payroll batch processes in the correct order.
Off-Cycle Closed After an on-cycle payroll is confirmed for the next pay period, the system selects
the Off-Cycle Closed check box, and you can no longer run off-cycle payrolls
against this calendar.
Note. You can use the Open/Close Pay Calendar process (PAY130 or
PAY130CN) to open the calendar (deselect the off-cycle closed check box) to
process year end adjustments. After the adjustments are processed, run the
PAY130 or PAY130CN to close the calendar. This process only opens or closes
the last on-cycle calendar of the year.
Payroll Distribution Selected when the non-commitment accounting GL distribution has been run.
Run
GL Interface Run Selected when the (non-commitment accounting) accounting lines have been
created.
CA Payroll Distribution Selected when the commitment accounting GL distribution has been run.
Run (commitment
accounting payroll
distribution run)
CA GL Interface Run Selected when the commitment accounting GL Interface has been run.
(commitment GL
interface run)
Note. You should run the GL interface only after you have completed your on- and off-cycle payrolls for a
pay calendar entry. After the GL interface has been run, the system won't allow you to enter any more payroll
transactions for that calendar entry. If GL Interface Run or CA GL Interface Run is selected, you cannot rerun
the process until resetting the check box. The GL interface check boxes have no effect on processing
adjustments for the pay period. You can still run adjustments until the Off-Cycle Closed check box is
selected.
You should run your GL Interface only after you have completed your on- and off-cycle payrolls for a pay
calendar entry. After the GL Interface has been run, the system won't allow you to enter any more payroll
transactions for that calendar entry. If GL interface Run is selected, you cannot rerun the process until
resetting the check box and it has no effect on processing adjustments for the pay period. You can still run
adjustments until the Off-Cycle Closed check box is selected.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 501
Setting Up Pay Calendars Chapter 19
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Defining Deductions," Creating
Deduction Subsets
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Working with Checks and Direct
Deposit"
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Reviewing, Adjusting, and Deleting
Employee Balances"
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Defining Deductions"
(USF) Reviewing Interface Status and Periods for Federal Leave Accrual
Processing
Access the Payroll Status page (click the Federal button on the Pay Calendar Table page).
Payroll Status
Leave Accrual Run This check box is updated by the Leave Accrual process that you run after
payroll is confirmed.
502 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 19 Setting Up Pay Calendars
Interface Status
The check boxes in this group box indicate whether the RITS Interface, TSP Interface, or the Treasury
Interface has been run for the pay calendar. The system updates these fields.
Pay Year
Pay Year The IRR process requires a Pay Year. When processing IRRs, the IRR Fiscal
Data Accumulator identifies all monies that come from the Pay Year. Enter the
pay year to which this pay calendar applies.
Year Indicators
The system completes the first four check boxes based on the run control parameters you enter when you run
the Calendar Build process. If you need to change these values, you can manually update the calendar after it
is built.
Calendar Year Begins This check box is used by federal annual leave accrual processing only. If the pay
calendar is for a pay period designated to begin the Leave Plan Calendar Year for
a particular Leave Type, select this check box.
Leave Year Begins This check box is used by Federal Annual Leave Accrual processing only. If the
pay calendar is for a pay period designated to begin the Annual Leave year,
select this check box.
Note. The leave year begins on the first day of the first full pay period for which
the begin and end dates are both within the new year. The leave year ends on the
last day of the last pay period ending just before the pay period of the new leave
year.
Pay Year Begins This check box is used by Federal Annual Leave Accrual processing on Leave
Types for which accrual begins with the Pay Year. If the pay calendar is for a pay
period designated to begin the Pay Year for Leave Accrual processing, select this
check box.
Fiscal Year Begins This check box is used by Federal Annual Leave Accrual processing on Leave
Types for which accrual begins with the Fiscal Year. If the pay calendar is for a
pay period designated to begin the Fiscal Year for Leave Accrual processing,
select this check box.
Leave Year Ends This check box is for your information only. It enables you to identify the pay
calendar that is intended to represent the leave year end.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 503
Setting Up Pay Calendars Chapter 19
Off-Cycle Calendar? If you selected this check box on the Pay Calendar Table page, this check box is
selectedif you did not, the check box is deselected.
If you select this option, you must process the pay calculation for the transferred
paysheets using the run parameters on the left side of the run control page. If you
do not select this option, the system assumes that you are linking the transferred
paysheets to an existing off-cycle paysheet that is linked to an on-cycle calendar.
Continue With Errors Select this check box if you want the payroll process to continue when the system
encounters error messages that are defined for the Continue With Errors
functionality.
Error Pay End Date Select an error pay end date that represents the end date of the off-cycle payroll
in which you want to correct and pay the employees who are bypassed during the
regular pay run. Be sure that you have an off-cycle pay calendar set up for the
pay end date that you select.
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up the Payroll Process," Setting
Up Continue with Errors Processing
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Calculating Pay," Reviewing Payroll
Messages and Correcting Errors
504 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20
Note. The tax tables discussed in this chapter are required for both the Payroll for North America and Payroll
Interface applications. The PeopleBook for each of these applications discusses additional tax data setup that
is specific to the application.
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Setting Up Payroll Tax Tables"
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "(CAN) Canadian Tax Method
Calculations"
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "(USA) U.S. Tax Methods and
Calculations"
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 505
Setting Up Company Tax Tables for North America Chapter 20
General CO_STATE_TAX_TBL
Set Up HRMS, Product Set up an entry in the
Related, Payroll for Company State Tax Table
North America, for each state where your
Federal/State Taxes, organization collects or
Company State Tax pays taxes.
Table, General
VDI/FLI CO_STATE_TAX_TBL2
Set Up HRMS, Product Identify the voluntary
Related, Payroll for disability plans associated
North America, with the company.
Federal/State Taxes,
Company State Tax
Table, VDI/FLI
506 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
GL Accounts CO_STATE_TAX_TBL3
Set Up HRMS, Product Enter your general ledger
Related, Payroll for account numbers for state
North America, taxes.
Federal/State Taxes,
Company State Tax
Table, GL Accounts
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 507
Setting Up Company Tax Tables for North America Chapter 20
The State field in State Tax Data 1 and Local Tax Data is edited against this table. You must create entries in
this table before entering any state and local tax information for your employees.
State Withholding
Non-Resident This check box is selected or deselected by default according to the Federal/State
Declaration Reqd Tax Table 1 record for the state. Indicates whether the state requires a Non-
Resident Declaration for non-resident employees.
508 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
State Unemployment
Exempt From SUT Select this check box if the company is not required to pay SUT for this state.
Use this option if you've specified, on the Company table, that the company as a
whole is not exempt from SUT. If you select it here, Exempt from SUT becomes
the default at the employee level; employees hired in this state have this check
box selected on the State Tax Data page.
See Chapter 20, "Setting Up Company Tax Tables for North America," Setting
Up SUT Exemptions To Generate Data for the TAX002, TAX810 and TAX860
Reports, page 510.
Override (MA only.) The Massachusetts standard Health Ins Rate is set by default from the
State Tax table. For Massachusetts, the Health Insurance Rate differs for newer
employers. If you're a Massachusetts employer to whom a lower rate applies,
select this check box and enter the correct Massachusetts Health Ins Rate.
Experience Rate Percent The experience rate you enter in the State Unemployment group box should
reflect the rate you receive from your state unemployment agency. Enter the year
and quarter when the rate becomes effective in the Effective Yr/Qtr field. This
enables you to have different rates within a single calendar year.
MA Health Insurance (MA only.) If you select Override, enter the correct health insurance rate.
Rate
Branch Code This field is informational for Arizona. TAX860AZ.SQR appends the branch
code to the end of the state EIN.
UBI Number (unified If the company you're adding is in Washington State, enter the UBI number
business ID number) assigned. Used for quarterly reporting for companies in the State of Washington
only.
EAF Rate (employment If the company you're adding is in Washington State, enter the EAF rate used to
administration fund rate) calculate an additional tax for the Employment Administration Fund, which
finances work search assistance and training for the unemployed. Used for
quarterly reporting for companies in the State of Washington only.
State Disability
Exempt From ER Select this check box if employees in this state are exempt from employer-paid
Disability state disability tax. This field is for informational purposes only and is not used
by the system.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 509
Setting Up Company Tax Tables for North America Chapter 20
Experience Rate Percent The experience rate you enter in the State Disability group box should reflect the
rate you receive from your state disability agency. Enter the year and quarter
when the rate becomes effective in Effective Tax Yr/Qtr. This enables you to
have different rates within a single calendar year.
Note. You must set up a record for Quarter 1, because the system assumes a
Quarter 1 record exists. A record for a subsequent quarter is required only if the
rate changes mid-year. If you set up a Quarter 2 record, and you don't have a
Quarter 1 record, you receive the error "SUT rate not found on Company/State
Tax table" during Pay Calculation. This error occurs regardless of the pay end
date you are processing.
Employer ID (E&G) Enter the appropriate employer ID for state disability grouping in
California, Michigan, and Minnesota. The T002CAHP, T002MIHP, and
T002MNHP reports are grouped by employer ID if you enter the employer ID
here and select the Separate Tax Report check box on the run control page. The
report lists state withholding, state unemployment, and state disability.
Setting Up SUT Exemptions To Generate Data for the TAX002, TAX810 and TAX860 Reports
The TAX002, TAX810, and TAX860 reports are generated based on SUT wages. When you select the
Exempt From SUT field on this page, the system does not generate taxable wages, and the TAX002, TAX810,
and TAX860 reports will contain no data.
Perform the following to generate taxable earnings, enabling the TAX002, TAX810, and TAX860 reports to
produce the required wage detail reporting data, while still remaining exempt from State Unemployment
Taxes:
1. Ensure that the Company Exempt from SUT field on the Company Table-FICA/Tax Details page is
deselected.
2. Leave the Exempt From SUT field on the Company State Tax Table - General page deselected.
These steps should ensure that the Exempt From SUT field on the State Tax Data page remains clear for
each employee. Verify that the Exempt From SUT field is clear on all three pages.
3. Enter a dummy number in the State Unemployment Employer ID field on the Company State Tax Table
General page.
After you do these steps, the system can track taxable wages without calculating SUT tax dollars. The
TAX002, TAX810, or TAX860 report can report the SUT subject wages.
510 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
This page includes nearly identical sections for setting up information for your VDI (voluntary disability
insurance) plan and your voluntary state family leave insurance plan.
Voluntary Disability Select this check box to indicate that the plan you're defining is a voluntary
Plan disability plan allowed by the state.
Plan Number Enter the plan number of the voluntary disability plan. For New Jersey, this
number appears on Form W-2.
VDI Administrator Select the code that identifies the administrator of the plan. You maintain
Code administrator codes on the VDI/FLI Administrator Table page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 511
Setting Up Company Tax Tables for North America Chapter 20
To set up VDI with a rate of zero so that you can track the VDI wages, enter 99.99999 as the Employee Rate
Percent and Employer Rate Percent on this page.
Voluntary Family Leave Select this check box to indicate that the plan you're defining is a voluntary
Plan family leave plan allowed by the state.
FLI Plan Number Enter the plan number of the voluntary family leave insurance plan.
FLI Administrator Code Select the code that identifies the administrator of the plan. You maintain
administrator codes on the VDI/FLI Administrator Table page.
To set up FLI with a rate of zero so that you can track the FLI wages, enter 99.99999 as the Employee Rate
Percent and Employer Rate Percent on this page.
512 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
Enter the general ledger account numbers, if applicable, for the following company liabilities:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 513
Setting Up Company Tax Tables for North America Chapter 20
This section discusses how to set up company local tax table entries.
Note. You must complete the Company Local Tax table before local tax data for employees is entered
because the locality field on the Local Tax Data page is edited against this table.
Pages Used to Define an Entry for the Company Local Tax Table
514 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
Employer ID This field is used for local withholding tax for this locality. It is set by default to
the Employer ID for state withholding taxes on the Company State Tax table.
These accounts are General Ledger accounts for use with local withholding tax; they are only used by the
PayGL01 process. Only GL information not subject to Commitment Accounting would use these accounts.
Employee and Employer If you have general ledger account numbers to which you post liability for local
withholding tax for this locality, enter the employee and employer account
numbers here.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 515
Setting Up Company Tax Tables for North America Chapter 20
516 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
Note. It is your responsibility to update all rates on the Company Tax Table.
Prescribed Interest If your company processes low interest loans, enter the current prescribed interest
Percent percent. This rate is updated quarterly by the Canadian federal government.
Important! The system ignores override values of zero. If the override value is 0.00, the system calculates
taxes using the rates on the provincial tax tables.
Province Enter all applicable provinces in which the company operates and needs to
process PPT tax or override a Health Insurance Rate.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 517
Setting Up Company Tax Tables for North America Chapter 20
Provincial Premium Tax Enter the provincial premium tax percent applicable to group life and health
Percent insurance benefit plan premiums, if your company is responsible for withholding
and submitting the tax.
Health Insurance Rate Enter the health insurance rate override to specify the premium rate that applies
Override to your company, if that rate is different from the rate defined on the Canadian
Tax Table Provincial Rates page. This field applies to companies operating in
provinces, such as Ontario and Manitoba, where variable rates apply based upon
total gross payroll figures.
This section provides an overview of tax locations and discusses how to:
Establish the locations for which you process payroll and taxes.
Associate provinces, states, and localities with the tax location code.
Note. If you've selected Automatic Employee Tax Data on the Installation table, the system automatically sets
up tax data for each work and resident state and locality of each of your employees. Tax distribution records
are created for the work state/locality if the tax location represents a single state/locality.
518 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
Tax Location Report PRCSRUNCNTL Set Up HRMS, Product Generate PAY718 that lists
Related, Payroll for North information from the Tax
America, Tax Table Location table.
Reports, Tax Location, Tax
Location Report
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 519
Setting Up Company Tax Tables for North America Chapter 20
Establishing the Locations for Which You Process Payroll and Taxes
Access the Tax Location Table - Address page (Set Up HRMS, Product Related, Payroll for North America,
Federal/State Taxes, Tax Location Table, Address or Set Up HRMS, Product Related, Payroll for North
America, Canadian Taxes, Tax Location Table, Address).
Tax Location Code Establish a tax location code for each location for which you process payroll and
tax data. You can associate any number of states and localities with eachcode.
Note. If you select Automatic Employee Tax Data on the Installation table and assign a Tax Location ID to
each employee in the Job data, each employee's tax data is set by default on the Employee Tax Data page and
the Employee Tax Distribution page.
Associating Provinces, States, and Localities with the Tax Location Code
Access the Tax Location Table State/Province/Locality page (Set Up HRMS, Product Related, Payroll for
North America, Federal/State Taxes, Tax Location Table, State/Province/Locality or Set Up HRMS, Product
Related, Payroll for North America, Canadian Taxes, Tax Location Table, State/Province/Locality).
520 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 20 Setting Up Company Tax Tables for North America
State / Province Use to identify each state that is associated with the tax location code. You can
associate any number of states with a single tax location. For each state, identify
each taxing locality, if any.
The states you associate with this tax location code must be defined on the
Company State Tax table and the Company Local Tax table. This value is set by
default to the Employee Tax Data pages and the Employee Tax Distribution page
for employees you assign to this tax location.
Locality The localities you associate with this tax location code must be defined on the
Company State Tax table and the Company Local Tax table. This value is set by
default to the Employee Tax Data pages and the Employee Tax Distribution page
for employees you assign to this tax location.
Other Work Locality Use this field only where multiple local taxes apply in one location, such as:
Paducah, KY and McCracken County, KY.
Enter the other work locality from the previous row in Locality.
Note. You should never attempt to enter multiple Indiana localities. Regardless
of the number of Indiana locations in which an employee may work, either
simultaneously or over the course of the year, the employee is liable for Indiana
county tax for only one Indiana county per calendar year. This is the Indiana
county of residence as of January 1, if that county imposes a tax, or the Indiana
county of principal work activity as of January 1, if the residence county does not
impose a tax.
Note. Locality and Other Work Locality are not required in Canada, because a Canadian employee can be
taxed in only one province at a time, and there are no locality taxes in Canada.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 521
Setting Up Company Tax Tables for North America Chapter 20
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the Workforce"
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Maintaining Payroll Data,"
Understanding Split Local Tax Distribution for KY, AL, and OR
522 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21
Setting Up Vendors
This chapter provides an overview of vendor tables and discusses how to enter vendor information.
Vendors
A vendor is any agency or organization that the company sends money to on behalf of a worker or that the
company uses to withhold money from a person's paycheck. Vendors can be:
Benefit providers
Garnishment payees
Tax collectors
The system stores information about the vendor in the Vendor table. It holds the information necessary to
make payments to a vendor and the policy information for a benefit provider.
Note. If you are using PeopleSoft Enterprise Payables to pay your vendors, we recommend that you enter and
update vendors in the Vendor table through PeopleSoft Payables and export the Vendor table to PeopleSoft
Human Resource Management System (HRMS).
Warning! If you update vendors through the HRMS tables, the contact information is exported to the
Payable system. However, any changes to existing vendor bank information that are made through HRMS
will not be exported to the Payables system.
Integration Points
Before using the integration to maintain the Vendor table, configure the Integration Broker nodes and activate
the appropriate queues, handlers, and routings for these service operations:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 523
Setting Up Vendors Chapter 21
VENDOR_FULLSYNC Payables publishes all contents of the Vendor table to the HRMS
Vendor table.
VENDOR_SYNC Payables publishes updates in the Vendor table to the HRMS Vendor
table.
To research the technical details of any integration point used by PeopleSoft applications, refer to the
Interactive Services Repository on My Oracle Support.
See Also
Chapter 38, "Working with Integration Points in Enterprise HRMS," page 941
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Integrating with PeopleSoft Payables,"
Maintaining Vendor Information
This section provides an overview of vendor setup pages and discusses how to:
524 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
AP Vendor Control
Vendor Information
Addresses
Locations
Contacts
Policy Information
AP Vendor Control
This is used only if you want PeopleSoft Payables to pay the vendor. It provides a mechanism for identifying
the different types of vendors.
Vendor Information
This page creates the vendor code and identifies the name and type of vendor you are entering.
Addresses
This is a strictly address information and should not be confused with location. You can enter multiple
addresses for the different sites a vendor might have.
Locations
A vendor location is not a physical address. It is a default set of rules, or attributes, which define how you
conduct business with a particular vendor. A vendor's location comprises information such as payment terms,
remittance information, bank account information, and so on. Although a location is not an address, it will
reference addresses.
Your vendor may need only one location. If the vendor uses the same set of rules across its business, you can
simply enter one location for your vendor, and you're ready to go. If, however, your vendor uses different sets
of rules for different portions of its business (different branches, sites, or offices, for example) you can set up
the vendor with multiple locations, each with its own unique set of business rules.
Contacts
This page is used to enter information about the people whom you contact on a regular basis. You can enter
an unlimited number of vendor contacts and identify their roles so that you can easily determine whom you
should contact if you have questions, or discern why a contact might want to talk to you, before you return
their call.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 525
Setting Up Vendors Chapter 21
Policy Information
Policy information is necessary for benefit providers. You will link this vendor and policy information using
the Benefit Plan table in Base Benefits.
AP Vendor Control VNDR_CNTRL Set Up HRMS, Product Identify the prefix assigned
Related, Payroll for North to the vendor in PeopleSoft
America, AP-Vendors, Payables.
Vendor Control, AP Vendor
Control
Addresses VNDR_ADDRESS
Set Up HRMS, Product Enter a vendor's address
Related, Payroll for information.
North America, AP-
Vendors, Vendor
Information, Addresses
526 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Alternate Names VNDR_ADDR_ALTN Click the Alternate Names Enter any alternate name for
link on the Vendor use on payments.
Information - Addresses
page.
Phone Information VNDR_ADDR_PHN Click the Phone Information Enter a vendor's phone
link on the Vendor information for addresses.
Information - Addresses You can enter more than
page. one phone number per
address.
Email Address VNDR_ADDR_EMAILID Click the Email Address Enter a vendor's email
link on the Vendor addresses.
Information - Addresses
page.
Locations VNDR_LOC
Set Up HRMS, Product Enter address and
Related, Payroll for remittance information.
North America, AP-
Vendors, Vendor
Information, Locations
Bank Accounts VNDR_BANK_ACCOUNT Click the Bank Accounts Enter banking information
link on the Vendor for the vendor.
Information - Locations
page.
Bank Address VNDR_BANK_ACCT2 Click the Bank Accounts Enter the bank's address
link on the Vendor information. The bank's
Information - Locations Country defaults from the
page and then the Bank Bank Accounts page. The
Address link on the Bank form of the address fields
Accounts page. varies, depending on the
country.
Phone Details VNDR_BANK_ACCT3 Click the Bank Accounts Enter phone information for
link on the Vendor the bank.
Information - Locations
page and then the Phone
Details link on the Bank
Accounts page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 527
Setting Up Vendors Chapter 21
Contacts VNDR_CNTCT
Set Up HRMS, Product Enter a vendor's contact
Related, Payroll for person. Enter more than one
North America, AP- phone number if necessary.
Vendors, Vendor
Information, Contacts
Garnishment Payee Table GVT_GARN_PAYEE Set Up HRMS, Product Enter garnishment payee
Related, Payroll for North contact information for U.S.
America, Garnishments, federal government.
Payee Table USF,
Garnishment Payee Table
528 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Use Auto-Numbering PeopleSoft Payables has the option of using an autonumbering feature to assign
IDs to new vendors.
HRMS Vendor ID If you selected the auto-numbering check box, enter a prefix that is used identify
Prefix HRMS vendors.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 529
Setting Up Vendors Chapter 21
HRMS Class (HRMS This field identifies the HRMS classification used to create views so you see the
classification) appropriate vendors on the appropriate tables.
It is also used to identify tax and non-tax deductions when the system extracts
deductions to create AP vouchers.
Available values are:
Credit Card Supplier (C)
Status For HRMS vendors, select Approved. The other values are used by Enterprise
Payables.
530 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Persistence For HRMS vendors, select Regular. The other values are used by Enterprise
Payables.
Address Type Enter the one or more addresses for the vendor.
If you are using PeopleSoft Payables at least one address should be the
remittance address. This is the address that is used when creating payment
vouchers.
Premium Payment and Remittance are the only valid address types for
deduction recipients. If any other address type is displayed for this vendor,
contact your Accounts Payable department.
Premium Payment generally applies to benefit deductions and Remittance applies
to all other types of deductions including taxes.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 531
Setting Up Vendors Chapter 21
Alternate Name 1 and When the system generates payments for the location using this address,
Alternate Name 2 Enterprise Payables needs to use a name different from the one entered on the
Vendor Information page, enter the name here.
532 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Location Enter an identifier for the location information you are entering. If more than one
location is set up for the vendor, you can use the previous page and next page
links on the Vendor Location bar to display information for the location in which
you're interested.
Default Select this check box if you want this location to automatically print on the
vouchers for this vendor. Only one location can be selected as the default.
Remit Vendor This is the information about the vendor to whom payments will be sent. You
need to select the codes that identify the name of the vendor receiving the
payments, vendor location, and address where the payment is sent.
Bank Accounts Click this link to display the Bank Accounts page. Work with the Payroll
department to set up this information.
Payment Options Click this link to display the Payment Options page. Work with the Payroll
department to set up this information.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 533
Setting Up Vendors Chapter 21
Default The Default check box is selected if this is the default bank account for the
location. The default bank account is copied to each payment schedule for this
vendor.
Bank ID Qual The country-specific numeric value by which the bank/counterparty is identified.
This value controls how the bank/counterparty pages edit and display bank
information.
Acct Type (account type) The account type for the bank, Bond, Checking Account, and Life Insurance, for
example.
DFI Qualifier If you make automatic clearing house (ACH), wire, or EFT payments to this
vendor location, this field should display the appropriate DFI Qualifier: The
value determines the format for the DFI ID field.
Transit Number: The DFI ID is exactly 9 digits, plus check digit calculation.
The DFI Qualifier determines the format of the bank's DFI ID.
DFI ID The bank's DFI ID. The format is determined by the value displayed in the DFI
Qualifier field.
Bank Address Select Bank Address for the Bank Address page.
Phone Details Select Phone Details for the Phone Details page.
534 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Payment Control
Hold Payments If this check box is selected, PeopleSoft Payables automatically places payments
for this vendor on hold.
Separate Payment If this check box is selected, PeopleSoft Payables creates a separate payment for
each voucher, even if the system processes multiple vouchers for the vendor in
the same pay cycle.
Bank
Bank ID The code for the bank from which you want to make payments for this vendor.
Bank Account The account from which payments will be made to this vendor.
Payment Handling
Specify at this Level: The payment handling instruction for the vendor
appears in the Code field.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 535
Setting Up Vendors Chapter 21
Code If you select Specify at this Level in the Flag field, this field displays the
payment handling instructions your accounts payable department follows when
issuing payments for this vendor:
High Dollar Payment.
Internal Distribution.
Regular Payments.
Route to Purchasing.
Payment Method
Specify at this Level: The payment method for the vendor appears in the Code
field.
Code If you select Specify at this Level in the Flag field, this field displays the
payment method for this vendor:
Automated Clearing House.
Direct Debit.
Giro - EFT.
Giro - Manual.
Letter of Credit.
Manual Check.
System Check.
Wire Report.
536 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Address Select one of the addresses that you entered on the Addresses page.
Phone Information Click this link to display the Provider/Vendor Table - Contacts: Phone
Information page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 537
Setting Up Vendors Chapter 21
General Policy URL ID Select the vendor's website address that provides general policy information.
Authorized Providers Select the vendor's website address that contains a list of authorized participating
URL ID providers
Sequence Select a contact from the list of contacts that were entered on the
Provider/Vendor Table - Contacts page. After you select the contact, the Contact
Name automatically appears.
538 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 21 Setting Up Vendors
Distribution Click this button to access the Deduction Distribution Information page.
Information
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 539
Setting Up Vendors Chapter 21
Payment Method For EFT distributions, select EFT as the payment method and specify the
remittance state and FIPS code in addition to the account information.
See Also
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Administering Garnishments," Entering
Garnishment Deduction Distribution Information
PeopleSoft Enterprise Payroll for North America 9.1 PeopleBook, "Administering Garnishments," (USA)
Specifying EFT Information for Child Support Garnishments
540 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22
Create a group.
You might want to apply a business process to a group of individuals that crosses job, department, or even
company lines. For example, you might want to offer a special bonus plan to your organization's research and
development teams. The group includes everyone in departments 10200 though 10500. Using the Group
Build feature, you can create a group consisting of departments 10200 through 10500 and administer the
group's incentive plan using the Variable Compensation module. Later, someone else can administer salary
increases to the same group using the Base Compensation and Budgets module. You define the group only
once.
You can define groups in Group Build and use those groups in HRMS applications such as:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 541
Setting Up and Working with Group Definitions Chapter 22
ePerformance
Creating a Group
Creating a group in PeopleSoft HRMS involves three steps:
3. Refine dates and other application-specific parameters in individual PeopleSoft applications (if
necessary).
Note. These steps are designed for experienced users who are familiar with the record and field structures in
PeopleSoft HRMS.
Select the records, fields, and values that define the group.
To use an existing review group later in the Manage Variable Compensation business process, link the
existing group ID to a node in the Variable Compensation Group Tree in the Manage Variable Compensation
business process.
Group build comes with a group ID of No Group that is required for Variable Compensation processing. The
group ID NOGROUP is used for Variable Compensation plans without groups. It is a reserved group ID, and
you cannot create a Group ID of NOGROUP in the Group Build application.
542 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
This section provides overviews of group definitions, query definition, and automatic generation of
department groups and discusses how to:
1. (Required unless using a query.) On the Group Build Records and Fields component (GB_REC_FIELD),
select the fields for each record available to make them available to create group criteria on the Group
Criteria page (GB_GRP_CRIT1_TBL) and Group Definition page (GB_GRP_DEF2_TBL).
See Chapter 22, "Setting Up and Working with Group Definitions," Selecting Fields For Use in Group
Criteria and Definitions, page 548.
Group criteria are like building blocks of records and fields that you can use repeatedly to create different
groups. For example, if your organization operates several business processes based on workers'
department and union memberships, you may want to create a group criteria ID called DEPT AND
UNION CODE. Once you've created the group criteria ID, you can use it to define a variety of groups.
Job Department
See Chapter 22, "Setting Up and Working with Group Definitions," Defining a Group Criteria, page 549.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 543
Setting Up and Working with Group Definitions Chapter 22
3. Attach a group criteria ID or query to the group definition on the Group Profile page
(GB_BRP_DEFN1_TBL).
On the Group Profile page, you can use a group criteria ID and queries as part of a group's definition.
If you use a group criteria ID, you can define additional records, fields, and field values on the Group
Definition page. You can use only one group criteria per group.
See Chapter 22, "Setting Up and Working with Group Definitions," Creating a Group Profile, page
550.
If you use PeopleSoft Query, you can choose an existing query or create a new one. Using queries
provides access to a broader set of system records than the thirty-two records that are available
through the Group Criteria page or Group Definition page. However, a query must follow certain rules
to be used in a group definition. You can attach only one query to a group definition.
See Chapter 22, "Setting Up and Working with Group Definitions," Understanding Query Definition
for Group Build, page 545.
4. Define or refine the group by selecting records, fields, and field values on the Group Definition page.
If you included a group criteria ID in the group definition, you must use the Group Definition page to
attach the appropriate field values to the fields and records in the Group Criteria. You can also add any
other records, fields, and values that you want to include in the group's definition.
If you've included a query in the group definition, you can't make any further selections on the Group
Definition page.
You can also define a group entirely on the Group Definition page, without attaching a group criteria or
query.
See Chapter 22, "Setting Up and Working with Group Definitions," Specifying Records, Fields, and Field
Values for a Group, page 552.
Note. Only the fields that you select on the Group Build Records and Fields component are available on
the Group Definition page.
Note. Once you have saved a Group ID, you must give yourself access to that group on the Security By
Group page (GB_GRP_SEC_TBL) or Security By Operator page (GB_GRP_SEC_TBL) or else you will
be unable to access the group in the Group Build - Group Definition component
(GB_GRP_DEFN_TABL).
See Chapter 22, "Setting Up and Working with Group Definitions," Setting Up Group Security, page 559.
This graphic shows how to define and create groups, as discussed above, as well as the create groups from
departments and query methods for creating groups:
544 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
When you define a query to use in group definitions, the following rules apply:
The first record you insert into the query must be the Group Build view (GB_QRY_LINK_VW).
The system uses this view to merge SQL statements that are created in the Group Build pages with the
SQL statements that are created by PeopleSoft Query.
You must select the following four fields from the GB_QRY_LINK_VW record:
EFFDT
EEFFSEQ
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 545
Setting Up and Working with Group Definitions Chapter 22
You must have at least one criterion for a record that you add in PeopleSoft Query.
You should not add additional criterion from the GB_QRY_LINK_VW record in PeopleSoft Query.
You can't define fields that are returned by the SQL statement.
You can use only Field Name, Expression, Constant, In List, Current Date, and Effective Seq (effective
sequence).
See Also
For example:
Any user who has access to the departments has access to the new groups. For example, a user who has
access to department 10200 in SetID USA has access to the new Group USA 10200.
546 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Group Build Records and GB_REC_FIELD Set Up HRMS, Common Select fields for use on the
Fields Definitions, Group Build, Group Criteria page and
Group Build Records and Group Definition page.
Fields, Group Build
Records and Fields, Group
Build Records and Fields
Group Criteria GB_GRP_CRIT1_TBL Set Up HRMS, Common Create a group criteria ID,
Definitions, Group Build, which is a building block
Group Criteria, Group that you combine with other
Criteria elements to build a more
complex group.
Group Definition GB_GRP_CRIT1_SEC Click the Comments link on Enter free-form comments
Comments Sec the Group Criteria page. about a Group Criteria
definition.
Group Definition GB_GRP_DEF2_TBL Set Up HRMS, Common Specify the records, fields,
Definitions, Group Build, and field values to define a
Group Build - Group group or refine a group
Definition, Group criteria.
Definition
Group Build Definition GB_GRP_DEF1_SEC Click the Comments link on View the records, fields,
View the Group Profile page or field values, and operators
the Group Profile or Group that you've specified for the
Definition page. group definition.
Group Result GB_GROUP_RES_SEC Click the Group Visualize View and sort the members
icon on the Group of the groups that you've
Definition page. built on the Group Build
pages.
Group Build From Co./Dept RUNCTL_GBP003 Set Up HRMS, Common Create groups from
(group build from company Definitions, Group Build, departments by running the
and department) Group Build From Group Build Construction
Co./Dept., Group Build SQR process (GBP003) to
From Co./Dept. translate your existing
company and department
structure into group format.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 547
Setting Up and Working with Group Definitions Chapter 22
For the record you selected on the search page, choose the fields you want to make available for creating
group criteria on the Group Criteria page and on the Group Definition page. The system makes only those
fields that you select here available on the Group Criteria page.
Field Name and Field Select the field name that you want to have available for use as group criteria.
Label After you select a field name, its description appears in Field Label; you can
change this description.
Edit Table Select the field's edit tablethe table from which the field is prompted.
548 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Prerequisite Fields
Required for Prompt Select the field that prompts for the group criteria fields, if required.
and Field Label For example, if the defaulting rules field is Department, select SETID because
before you can select a department, you need to select the department's setID.
The appropriate Field Label and Equivalent Record Field appear when you select
the Required for Prompt field.
Equivalent Record Field Select the Required for Prompt field's equivalent. For example, the department's
equivalent of SETID is SETID_DEPT
Sometimes the equivalent field is the same as the Required for Prompt field or
there is no equivalent field. If there is no equivalent field, leave this field blank.
Boolean This field appears only if you add a second row of data to the page. Use it to tell
the system how to process the records and fields that you enter on this page.
Values are AND (the default) and OR.
( Create sets or subsets of linked records and field names. Using parentheses helps
avoid ambiguity when you create several AND/OR conditions. You can create up
to five nesting levels. The system displays a list of values. The default is none.
Record Select the record name to include in the group criteria definition. The system
displays a list of the records you made available on the Group Build Records and
Fields component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 549
Setting Up and Working with Group Definitions Chapter 22
Field Name Enter the field name to include in the group criteria definition. The system
displays a list of the fields you made available on the Group Build Records and
Fields component for the record that you selected in the Record field.
Field Label The system fills in this field when you press TAB to move out of Field Name.
You can change the entry.
Edit Table The system uses edit tables to validate the data that you enter in certain fields. If
the field name you entered is linked to an edit table, the system fills in this field
when you press TAB to move out of Field Name.
) Complete a nesting statement that links multiple records and fields together. The
system displays a list of values.
Group Criteria ID To include an existing group criteria in this group definition, enter the ID here.
Otherwise, leave the field blank. You can include only one Group Criteria ID in a
group.
550 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
If you changed the Group Criteria ID, click the Refresh button to repopulate the
Group Definition page with new values.
Complex Group - Batch Select if you want to select batch processing for complex groups that take a long
Process time to build online. Batch processing can take place at off-peak times when you
don't need your system for other purposes.
PeopleSoft Process Scheduler handles batch processes, so be sure that your
process scheduler is up when you select this check box. Process Scheduler
notifies you when processing is complete. If you need a status on scheduled
group execution, see the Group Definition - Group Results page.
Note. Clicking the Launch Count button on the Group definition page sends the
group to the process scheduler to be generated. If you have a complex group that
you have already generated, clicking Launch Count retrieves the number of rows
in the group.
Avail to Manager Self- Select this check box if you plan to use Group ID as an access type for any
Service manager self-service transaction.
Comments Click this link to enter free-form comments on the Group Build Definition View
page and to view the where clauses defined on the Group Definition page.
Query Name To include an existing query in this group definition, enter the query ID here.
Otherwise, leave the field blank.
Warning! When you access the list of options in this field, all existing queries
that include the record GB_QRY_LINK_VW appear. However, the Group Build
process works only with queries that have the fields EMPLID, EMPL_RCD,
EFFDT, and EFFSEQ. If you select a query that does not contain those fields, the
system will not display the Launch Count and Group Visualize buttons on the
Group Definition page.
Manager ID Designate the group's manager, if applicable. For example, if the group you're
defining consists of all employees in department 10200, enter the department
manager's ID here. You can also use this field to designate the leader of a project
team.
Variable Compensation uses the group manager ID to determine who can access
the Award Allocation page when a plan is managed with groups.
If you selected the Avail to Manager Self-Service check box, Manager ID is
required.
Approver Empl ID If you're planning to use this group in the Variable Compensation Administration
(approver employee ID) by Groups business process, enter the employee ID of the person who approves
awards for this group. The system displays a list of values.
If you selected the Avail to Manager Self-Service check box and are using
workflow with self-service transactions, Approver EmplID is required.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 551
Setting Up and Working with Group Definitions Chapter 22
See Also
Group Definition
You can use this page in combination with a group criteria entered on the Group Profile page or you can build
a group entirely on this page. You can use this page in any of the following ways:
The system populates the Group Definition page with the record and field names from the Group Criteria
page. You can't change the record and field names on this page. To finish defining the group, complete
the parameters by entering the appropriate field values for each field name in the Criteria Definition group
box on the Group Criteria page. You can add more records, field names, and field values to the definition.
Define the group entirely on this page. Enter all the records, field names, and field values that you'll use to
build the group.
552 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
(launch count) After you save the page, click the Launch Count icon to compute how many
members are in the group. If you selected the Complex Group - Batch Process
check box on the Group Definition - Group Profile page, clicking Count sends
the group to PeopleSoft Process Scheduler to be generated.
If this is a complex group that you have already generated, clicking Count
retrieves the number of rows in the group.
Count Result When you click the Launch Count button, the system displays the number of
members in the group. If you used effective-dated records in the group definition,
the group might include more than one row of data per employee. Each data row
counts as one item in the Count Result.
(group visualize) Click the Group Visualize button to build the group and to access the Group
Result page, where you get a list of all group members.
Comments Click this link to access the Group Build Definition View page where you can
enter comments or view the where clause that you defined on the Group
Definition page.
Where Clause
Record Enter the name of the record that you want to use to define the group. The system
displays a list of valid record names. If this field is populated by a Group Criteria
definition, you can't change the entry.
Field Name Enter the name of a field to use to define the group. The system displays a list of
values for the record that you entered in the Record field. If you entered a group
criteria ID on the Group Profile page, the system populates this field and you
can't change the entry.
Label The system populates this field when you move out of the field.
Operator Define the field values to include in or exclude from the group. See the following
Valid Operators table.
Note. (JPN) If you define groups for use in Japanese processes such as Seniority
Pay or Salary Increase, we recommend that you do not set the Operator for Job
Effective Date to Current. If you select Current, you may not get the results you
want when you run processes that are backdated. Provided Effective Date is not
set to Current here, you can run processes to extract other than current data by
using the As of Date on the process page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 553
Setting Up and Working with Group Definitions Chapter 22
Edit Table The system uses edit tables to validate the data that you entered in certain fields.
If the Field Name that you entered is linked to an edit table, the system populates
this field.
Note. If the Field Name that you entered is keyed to other fields, the system
displays the other fields that you must enter to finish defining the field. For
example, if you want to build a group based on a particular Salary Step, you must
also specify the SetID, Salary Plan and Salary Grade.
Valid Operators
Operator Description
= Equal to.
Between
Current
In List
554 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Operator Description
Like
Max Maximum.
Min Minimum.
Not Equal
Not Like
Job
Compensation
The system stores both current and historical data for these records, so you can build groups with them in two
ways:
For example, selecting only an employee's current job and leaving out the previous jobs. The system adds
the condition Current to the record's effective date.
For example, including all the jobs that the employee has held in your organization. The group can
include multiple rows of data for one employee. If you don't place any conditions on the effective date
when you define the group, the system pulls all the historical data as of the current system date.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 555
Setting Up and Working with Group Definitions Chapter 22
If you create a group definition that includes two effective-dated records, you can link the two records by
effective date. The following table shows how to link two effective-dated fields.
Operator Description
Where Clause View the where clause as defined on the Group Definition page.
556 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Because the number of group members could be very large, the system loads members into this page in
chunks. You can determine the number of rows in a chunk in the Maximum Number of Rows for Scrolling
field on the Installation Table. You manage the display of chunks using filters and navigator buttons.
Filters enable you to enter search criteria for identifying a chunk of members. You can enter information into
one or more of the filter fields to narrow your search.
Important! Group Build automatically joins the JOB, COMPENSATION, PERSON, and PER_ORG_ASGN
tables. To compare the group results from this page with the results of a query that you launched from your
SQL editor, add the joins to those three records in your SQL editor to ensure that the results are comparable.
When you click the count button, Group Build Definition gives the system date as parameter. For example,
the Group Build Definition adds the condition JOB.EFFDT <= Given Date is added in the generated SQL,
even if you did not define any dates criteria in the Group Build Definition.
Use the following filters and navigator buttons to move from one chunk of members to another:
Search on Name Enter one or more letters in this filter field to instruct the system to populate the
page with employees whose last names begin with the letters that you entered.
You can use the wild card % to help select a record. For example, to search for
all employees named John enter %John.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 557
Setting Up and Working with Group Definitions Chapter 22
ID (employee ID) Entering one or more numbers in this filter field instructs the system to populate
the page with employees whose employee IDs begin with the numbers that you
entered.
Sort group by Select whether you want the members to appear in order by EmplID (employee
ID) or Name.
Note. (JPN) The Sort group by feature is disabled when Japanese Kanji character
sets are used in a Non-Unicode database with Japanese as the base language and
login language.
Click the Refresh Search Fields? button to clear all previously entered search
criteria from the filter fields.
Search Click the Search button to display the results of a new search. To the left of the
Sort group by group box, the system displays which rows are visible compared to
the total number of rows. For example, 1 to 4 of 4 means that rows 1 through 4
are displayed out of a total of 4 rows.
Note. After you click Search, the button disappears from the page until you click
the Refresh Search Fields? icon.
See Also
Chapter 22, "Setting Up and Working with Group Definitions," page 541
Run the Group Build Construction SQR process (GBP003) to translate your departmental structure into group
format.
When the process is complete, you can use the Group Build pages to view the groups and verify that they
were generated correctly.
See Also
Chapter 22, "Setting Up and Working with Group Definitions," Understanding Automatic Generation of
Groups by Department, page 546
558 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
This section provides an overview of group security and discusses how to:
Note. User profiles must have an associated person in order to be given security access to groups (the system
will not list user IDs that don't have a person associated with them). This ensures that the security is assigned
to a person and the activities involving the group can be tracked by the person. Assign people to user profiles
on the User Profiles component in PeopleTools security.
Group Security Default GB_GROUP_DFT_TBL Set Up HRMS, Common Set up default component
Definitions, Group Build, access.
Group Security Default,
Specify which components
Group Security Default
in your system can use or
refer to groups that are
created in the Group Build
component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 559
Setting Up and Working with Group Definitions Chapter 22
560 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Component Name The system populates these fields with a list of the standard PeopleSoft Human
Resources components that refer to groups.
Components can refer to groups in one of two ways:
The page contains a field that prompts the user to supply a group ID.
When you define group security for a particular group or user, you can import
this default list into the Security By Group and Security By Operator pages. Then
you can selectively delete components to make them unavailable to that group or
user.
To keep a particular component from appearing on the Security By Group or
Security By Operator page, delete its name from the list.
Effective Date The date on which the security configuration takes effect. The default is to
today's date. Change the date to grant security access as of a different date.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 561
Setting Up and Working with Group Definitions Chapter 22
User ID Select the ID of a user whose group access you want to set up or change.
If you know a person's ID but not the matching user ID, click the Get Employee
(get employee ID) ID icon to search for the person's user ID. The system displays the Search
Operator ID box. Enter the ID and click OK to add the person's user ID to the
user list, if it isn't already on the list.
If you don't know the person's ID, click the Look up EmplID icon to search for it.
The system displays a Look up EmplID page that you can use to search for the
ID you want.
Status Select Active to grant the user access to the group or Inactive to remove the user's
access.
Component Name Select the components that you want to include in the user's security access for
this group. Valid values are the default components listed on the Group Security
by Default page.
Default Click this button to assign this user access to the current group from any default
component listed on the Group Security Default page. The system displays the
default components. You can delete any components for which you do not want
to grant security access to this user for this group.
See Chapter 22, "Setting Up and Working with Group Definitions," Setting Up
Default Component Access, page 560.
562 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Effective Date The date that the security configuration takes effect. The default is today's date.
To grant security access as of a different date, change the date.
Group ID Enter the ID of the group to which you want to control this user's access.
Status Select Active to grant the user access to the group or Inactive to remove the user's
access.
Component Name Select the components that you want to include in the user's security access for
this group. Valid values are the default components listed on the Group Security
by Default page.
Default Click this button to assign this user access to the specified group from any default
component listed on the Group Security Default page. The system displays the
default components. You can delete any components for which you do not want
to grant security access to this user for this group.
See Chapter 22, "Setting Up and Working with Group Definitions," Setting Up
Default Component Access, page 560.
A point in time.
Some processes select only group members as of an effective date specific to the process. In this case, if
the group is created with all job historical rows, the system selects only the data as of the effective date.
A period of time.
Some processes select group members who have job data between a from and a through date.
See Also
Appendix A, "Group Build Implementation for Developers," Building Applications or Batch Programs that
Include Group Build Functions, page 995
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 563
Setting Up and Working with Group Definitions Chapter 22
See Also
Chapter 22, "Setting Up and Working with Group Definitions," Viewing Group Results and Reports, page
563
Common Elements
Group ID Enter the ID of the group whose members you want to view.
As Of Date The report lists the members who belong to the group as of the current date, or as
of the date you specify in the Refinement Date field.
Refinement Date If the group definition includes effective-dated records, enter the date for which
you want the records run. For instance, you might want to run a group with an
effective date of 1/1/1990, but run the effective-dated rows in the group as of
2/15/1998. In that case, you would select a Group As of Date of 1/1/1990 and a
Refinement Date of 2/15/1998.
If you leave this field blank, the system will run the group as of the current date.
Complex Group Results RSLT_SMRY_PNL Set Up HRMS, Common View the status of the
Summary Definitions, Group Build, complex groups that you
Complex Group Results created in the Group
Summary, Complex Group Definition component.
Results Summary
You must already have run
the background process to
create the group.
Group Overlapping RUNCTL_GBP001 Set Up HRMS, Common Run the Group Member
Definitions, Group Build, Overlapping report
Group Overlapping, Group (GBP001). This report lists
Overlapping individuals who belong to
multiple groups.
564 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 22 Setting Up and Working with Group Definitions
Group Membership RUNCTL_GBP002 Set Up HRMS, Common Run the Group Membership
Definitions, Group Build, report (GBP002). This
Group Membership, Group report lists the members of
Membership selected groups.
You can designate any group as a complex group by selecting the Complex Group - Batch Process check box
on the Group Definition - Group Profile page. The system creates complex groups by background process and
notifies you when processing is complete.
Group Results Purge RUNCTL_GBP004 Set Up HRMS, Common Delete (purge) the results of
Definitions, Group Build, a previous version of a
Group Results Purge, Group group from the Group
Results Purge Results Table.
Unusable Group Results RUNCTL_GBP005 Set Up HRMS, Common Delete the results from all
Purge Definitions, Group Build, of your groups from the
Unusable Group Results Group Result Table.
Purge, Unusable Group
You must have saved the
Results Purge
group you want to purge
before using this page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 565
Setting Up and Working with Group Definitions Chapter 22
The Group Results Purge process deletes usable groups groups with results in the Group Results Table
that are still in sync with the current group definition and can potentially be retrieved by the system.
Group ID Enter the ID of a group whose results you want to purge. The system deletes the
results from the Group Build results table GB_GRP_RES_TBL.
The Unusable Group Results Purge process deals with unusable groupsgroups that were generated when
the group definition was different from what it is now, and the results that are stored on the Group Results
Table no longer match the group definition. Group results become unusable when any of the following items
change:
The Group Results Table, where the group results are stored.
566 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 567
Administering the HRMS System Chapter 23
File Name Enter the name of the file you want the process to create and populate with the
portal analysis. The process will distribute the file to the reporting repository.
Portal Name Enter the name of the portal you want to analyze.
Content Provider Name Select HRMS in the Content Provider Namefield to analyze HRMS portal
navigation.
Process Result Select the processing result from the following options:
Portal/Menu Path
The result creates a straight list of the portal and menu paths. This result does
not use the other values on the page so the system hides them when you
select this option.
This result gives you more options and can create a more hierarchical view of
the navigation.
Display Levels Enter the number of portal levels to print. Leave empty to print all the levels.
568 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
Show Object Names Select to display the object names of the CREFs or folders.
If you leave this check box deselected, the process will just display the labels.
Show Select to display the CREFs menu, component, and market information.
Menu.Component.Mark
et
Suppress Hidden Select to keep the process from including hidden objects.
Objects If you leave this check box deselected, the system identifies hidden objects with
the following text preceding the object name: *hidden*.
Select to analyze the portal navigation for the security access assigned to a UserId,Role, or Permission List.
Select the userID, role, or permission list to use.
This section provides an overview of setting up ID delete control and discusses how to prevent the deletion of
IDs from critical records.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Updating Person and Job
Information," Changing and Deleting IDs
The PeopleSoft system delivers predefined ID delete control priority tables and fields for individual and
organization IDs. Corresponding messages are preset to appear when you try to delete an ID with data in any
of the associated control records and fields.
Note. You should not modify the predefined ID delete controls. You can, however, define additional priority
data by adding other records and fields to control the deletion of IDs.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 569
Administering the HRMS System Chapter 23
ID Delete Control ID_DEL_PRVNT_TABLE Set Up HRMS, System Enter records from which
Administration, Database an ID should not be
Processes, ID Delete removed during an ID
Control, ID Delete Control deletion or change. This
ensures that the information
is stored for historical
purposes.
The ID on each of the following control records and the associated messages are delivered predefined as
priority data for HRMS:
GP_PYE_PRC_STAT
PAY_LINE
You should not delete any of the rows of predefined control records. Keep these as your base ID delete
control records for individual IDs and define additional priority data as necessary.
570 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
To define an additional control record, or to add an additional field from the same record, click the Plus
button at the level where you want to add it. The system enters a new row and renumbers the sequence of
control records. Select the record name, field name, and message data. The new row is not added until you
click Save.
Record (Table) Name Displays the name of the record that contains the priority data field.
Field Name Displays the name of the field that, when data exists in it, prevents the deletion of
the ID.
Message Set Number Enter the set number of the message to display when data exists in the priority
data field.
Message Number Enter the number of the message to display when data exists in the priority data
field.
Note. The short description for many message numbers is the same. Review the
detailed description associated which each message number in the PeopleTools
Message Catalog to determine which message number displays the desired
message regarding the specific field.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Updating Person and Job
Information," Refreshing Tables to Facilitate Reporting
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 571
Administering the HRMS System Chapter 23
PERSONAL_DATA PERSON_DT_SETUP Set Up HMRS, System Select the data that you
Settings Administration, Database want to include in the
Processes, refresh snapshot of the
PERSONAL_DATA Personal Data component
Settings, (PERSONAL_DATA). The
PERSONAL_DATA fewer options you select,
Settings the faster the system can
refresh the table. You must
make these selections when
you install HRMS.
PeopleSoft only uses
EmplID and Name data.
Select the options you need
to meet your ad hoc
reporting and query needs.
Refresh Personal Data PRCSRUNCNTL Set Up HMRS, System Refresh the Personal Data
Administration, Database component. The Refresh
Processes, Refresh Personal Personal Data component
Data, Refresh Personal Data (PERS_REFRESH) loads
the data types that you
selected on the
PERSONAL_DATA
Settings page.
572 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
Update Personal Data- PRCSRUNCNTL Set Up HMRS, System Run this process shortly
Future Administration, Database after midnight to update the
Processes, Update Personal Personal Data component.
Data-Future, Update The process will update
Personal Data-Future data with future dated
information that has become
current.
The Update Personal Data-
Future process runs the
HR_PERSDATA
application engine program.
Refresh Name Display NAME_DISPLAY_RC Set Up HRMS, System Refresh all records with the
Values Administration, Database NAME_DISPLAY and
Processes, Refresh Name NAME_FORMAL fields to
Display Values, Refresh reflect changes made to the
Name Display Values PeopleCode definition of
those fields. You can
choose to update records
with all name format types
or just with one name
format type.
HR Core Data Integrity HRAUDIT Set Up HRMS, System Initiate the Core Human
Audit Administration, Database Resources Data Integrity
Processes, Core HR Data Audit.
Integrity Audit, HR Core
Data Integrity Audit
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 573
Administering the HRMS System Chapter 23
Include Installed Select to include the information in the country-specific group boxes for those
Countries countries that you've installed on the Installation Table - Country Specific page.
Include Primary Phone Select to include the information in the PERSONAL_PHONE record.
Data
Include Smoker Data Select to include the information in the PERS_SMOKER record.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Adding a Person in
PeopleSoft Human Resources," Adding a Person
574 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
Select which records whose name fields format you want to update.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 575
Administering the HRMS System Chapter 23
SQR reports.
COBOL programs.
PS Query views.
Reports the record names referenced by the SQL statements within the applications.
Reports the way in which those records were accessed (for example, Select, Update, or Delete.)
Because of the flexibility of the programming environments and the rich set of meta-SQL available in
PeopleTools, the table list created by the Tables Accessed and Updated report may sometimes be incomplete.
The list will be incomplete when:
Since the Tables Accessed and Updated report can't know the full set of tables that might be substituted, it
reports the condition when it encounters this kind of SQR.
The SQR incorporates the construction of SQL clauses within string variables that can then be used in
SQL statements and resolved by the SQR at runtime.
The Tables Accessed and Updated report can't detect this style of coding, however there aren't many table
references found within these kinds of clauses.
576 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
The SQR references libraries through syntax that includes (#INCLUDE) SQC files.
If an included module is a very generic library with a large number of general-purpose routines in it, the
analysis may overstate the number of tables referenced.
The COBOL programs reference libraries through syntax that calls (CALL ... USING) routines in other
modules.
If the module called is a very generic library with a large number of general-purpose routines in it, the
analysis may overstate the number of tables referenced.
The Application Engine program contains the meta-SQL phrase %Execute() with platform-specific
procedural logic (such as Microsoft SQL Server "Transact-SQL" or Oracle "SQL-Plus").
The Tables Accessed and Updated report reports such usage as unanalyzed.
The Tables Accessed and Updated reports any use of PeopleCode as unanalyzed, whether or not it
contains SQL statements.
The Application Engine program contains forms of meta-SQL that contains dynamic object references.
Since the Tables Accessed and Updated report can't know the full set of tables that might be substituted, it
reports the condition when it encounters this kind of meta-SQL.
Tables Accessed and TAU_RUN_CONTROL Set Up HRMS, System Use the Table Access
Updated Administration, Utilities, Utility page to run the
Tables Accessed and Tables Accessed and
Updated, Tables Accessed Updated report.
and Updated
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 577
Administering the HRMS System Chapter 23
Application Type Select the type of application to analyze in the report. The options are:
AppEngine Programs
SQR Reports
COBOL programs
Queries
Application Name Enter part or all of the name of the application or applications you want to
analyze. Enter a ? to report on all applications in the product.
You can run the report using just the information you enter here or you can use
this value as search criteria to create a list of applications using the Available
Applications and Selected Applications group boxes.
For example, when you select SQR Reports,Human Resources, and enter R in the
Application Name field and run the utility, the report will analyze the
REG001FR, REG002FR, and REG003FR reports. To refine the search, click the
Refresh Available Applications button and select which of the three reports to
analyze and add them to the Selected Applications list.
578 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
Refresh Available Click Refresh Available Applications to populate the Available Applications
Applications and group box with applications that match the search criteria you entered in the
Available Applications Application Name field. Select the applications you want to analyze.
Note. A small number of applications are not associated with normal run control
pages (for example, one-time conversion routines or system setup utilities used
during installation) and the system will not display them in the Available
Applications list. You can enter these applications in the Selected Applications
list using the insert button and entering the application's name.
<<Add<< Click to add the applications you selected in the Available Applications list to the
Selected Applications list.
Once you've added items to the Selected Applications list, you can enter new
search criteria in the Application Name field and refresh the Available
Applications list.
Clear Selected The report will analyze all the applications included in the Selected Applications
Applications and list. You can add or remove applications using the insert and delete icons.
Selected Applications Click the Clear Selected Applications button to deselect the list of applications
you've selected for analysis.
Include PeopleTools Select to include PeopleTools tables in your analysis. PeopleTools tables define
Tables all PeopleSoft objects and manage system behavior, and include this such as
related language control, currency conversions, and Process Scheduler activity.
Location of Source Code If you are analyzing COBOL programs, enter the path to the COBOL source
code's location on the server.
Note. The system only makes this field available when you select to analyze a
COBOL program.
Location of Tools If you are analyzing SQR programs and are excluding PeopleTools tables, enter
programs the path to the PeopleTools SQR components' location on the server.
Note. The system only makes this field available when you select to analyze
SQR reports.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 579
Administering the HRMS System Chapter 23
Pages Used to Test Component Interfaces Using the Invoke Core CIs Utility
Invoke Core CIs RUNCTL_CCI Set Up HRMS, System Use this page to launch a
Administration, Utilities, component interface with
Invoke Core CIs, Invoke sample data to test if it
Core CIs executes in the manner in
which you want it to.
Name Select the name of the component interface you want to test.
580 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 23 Administering the HRMS System
Find: Select to find a list of data rows that match the search criteria you enter
in the Component Interface Access Keys grid.
Get: Select to find a single row of data that match the search criteria you
enter in the Component Interface Access Keys grid.
Write Log File Select to create a log file of the component interface test.
Invoke CI When you've entered all of the necessary information, click to invoke the CI and
test it using the information entered on this page.
Sort Order, The component interface's key properties are the search keys of the underlying
KeyProperty, and Value component's search record. Select with key fields to use in the search in the
KeyProperty field and enter the value of the field to use in the search in the Value
field.
If you are searching by more than one key field, indicate the order in which the
system should sort the results.
If you are testing the CI using the Create action mode, use all the key properties.
Actions to be Performed
Sequence Number Indicate the order in which the system should execute this action using the
component interface.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 581
Administering the HRMS System Chapter 23
Get: Select to retrieve data rows that match the values you enter in this group
box.
Insert: Select to insert a new data row with the values you enter in this group
box.
For example, if the current row is dated November 12, 2005 and you want to
enter a row effective January 1, 2004 while still maintaining the November
row as the current row, select this option.
Invoke Method:
Select to execute the method for the CI. A method, for instance, can execute
PeopleCode. For example, in Salary Planning, the calculation of the salary
increase of each employee can be executed on-line or using a batch program.
The batch program will execute the method
CI_SALARY_PLAN_GRP.Methods.SalPlanGrp.
Carry Forward Select this option to update any rows in the component that are more current than
the row you are inserting using the CI.
Parent Collection Name Select the collection (which corresponds to a record) in which you want to update
data.
Sort Order,KeyProperty (Collection Keys) Select the key field or fields for the scroll and enter the value
, and Value of the row upon which you want to execute the action.
Sort Order,Property, (Property/Values Pairs) Select the fields in the collection and the field values that
and Value you want to use in the action.
582 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24
Registering Interfaces
This chapter provides an overview of the HCM interface registry and discusses how to:
Test services.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 583
Registering Interfaces Chapter 24
The service consumer finds an interface in the registry and the registry provides the information necessary to
bind and execute the service
The service consumer is an application, service, or some other type of software module that requires a
service. It is the entity that initiates the location of the service in the registry, binding to the service over a
transport, and executing the service function. The service consumer executes the service by sending it a
request formatted according to the contract.
The service provider is the service, the network-addressable entity that accepts and executes the requests from
consumers. It can be a mainframe system, a component, or some other type of software system that executes
the service request. The service provider publishes its contract in the registry for access by service consumers.
1. Set up the interface contract and register the interface using the Registration Wizard (Setup HRMS,
System Administration, HCM Registry, Registry Wizard).
An interface contract specifies the way a consumer of a service will interact with the provider of the service,
including the format of the request and response from the service. The HCM registry is populated with the
existing interface contracts within HCM. To add new interfaces to the registry, you must first define the
contract between the services.
584 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Services
Services interfaces are procedural invocations and can be local and remote.
Events can be notifications (outbound) or consumption (inbound) and are based on messaging and
integration points.
sqlViews (views)
Types
Types represent the complex data types used in service invocations. The following types are supported for
service invocations in API:
Primitives (native PeopleCode data types), such as string, date, number, boolean, hexbinary, and
arrays.
Note. While you can use all primitive types in service invocations natively, all complex types must be
explicitly defined and registered in the registry.
Exceptions
Exceptions are fatal errors that can occur during service execution and require special handling by the
PeopleCode program. Service providers must identify exceptions that they believe can occur so that the
consumer code can manage the exception.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 585
Registering Interfaces Chapter 24
View RegistryDoc.
Service Registry HMCR_IFC_REGISTRY Set Up HRMS, System Review the HCM registry
Administration, HCM and modify existing entries.
Registry, Service Registry,
Service Registry
<Registry Folder Label> HMCR_IFC_FLDR_ACT Click an interface folder on Generate and audit the
the Service Registry page. WSDL for a selected
interface folder.
Audit - <Registry Folder HMCR_IFC_AUD_RSLT Click the Run Audit button Review the results of a
Label> on the <Registry Folder registry folder audit.
Label> page.
Interface Registry - Details HMCR_WSDL_VIEWER Click a link under the Review registry and
HMCR_IVW_VIEWER Services, sqlViews, Types, interface details about a
or Exceptions interface selected interface.
HMCR_TYPE_VIEWER
folders on the <Registry
Folder Label> page.
<Registry Entry Name> HMCR_WSDL_RAW_SEC Click an interface for a View WSDL code for a
service on the <Registry service registry entry, or
Folder Label> page, and view XSD code for a type
then click the Show WSDL or exception registry entry.
button, or click an interface
for a type or exception, and
then click on the Show XSD
button.
586 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
The registry lists all the content owners and their interfaces in a tree format. Each tree leaf represents a
registered interface. Registered interfaces are grouped by interface folders. Click a registered interface to
review interface information on the Details page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 587
Registering Interfaces Chapter 24
Refresh Cache Click this button to manually refresh the cache where services, types, exceptions,
and SQL views are stored whenever you make a change to the registry. You must
refresh the cache when a definition is modified, added, or deleted. You must also
refresh the cache when an external cache has to be imported.
Generate Registry Doc Click this button to generate RegistryDoc for the selected HCM service registry.
The system generates RegistryDoc in HTML and provides the View
RegistryDOC link for you to access the data. The RegistryDoc enables you to
view or introspect the registry without having to open the registry, thus offering a
quicker view into the registry.
View RegistryDoc Click this link to view RegistryDoc that you have generated. The system opens a
new browser window, which displays the registry API content in HTML format.
You do not know the exact name for or the navigation to the service, sqlView, type, or exception.
You want to search for the descriptions for a specific word or pattern of a word.
Search Descriptions Select this check box to search descriptions of registry entries for an exact word
that you specify in the Search Filter field.
Select this check box and the Search Descriptions check box to search
descriptions of registry entries for the word pattern that you specify in the Search
Filter field.
Wildcard Search Select this check box to search registry entries for the word pattern that you
specify in the Search Filter field.
Select this check box and the Search Descriptions check box to search
descriptions of registry entries for the word pattern that you specify in the Search
Filter field.
588 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Search Filter To search registry entries for an exact match of a service, sqlView, type, or
exception, enter a value in this field without selecting any check boxes. The
system lists the registry entry.
To search registry entries for a word pattern, enter the word pattern in this field
and select the Wildcard Search check box. The system lists registry entries that
match the pattern that you entered.
To search descriptions of registry entries for an exact word, enter the word in this
field and select the Search Descriptions check box. The system lists registry
entries with descriptions that contain the exact word.
To search descriptions of registry entries for a word pattern, enter the word
pattern in this field and select both the Search descriptions and Wildcard Search
check boxes. The system lists registry entries with descriptions that match the
pattern that you entered.
Search Click this button to retrieve the registry entries that match your search criteria.
<Registry Folder Label> page showing the HR Core interface folder data
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 589
Registering Interfaces Chapter 24
Use the View WSDL group box to review the WSDL that the system generated for the selected registry
folder. Click the Run Audit button to run an audit on the registry folder. The system displays the Audit -
<Registry Folder Label> page for you to review the results of the registry folder audit.
590 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Note. The Interface Registry - Details page is slightly different for each type of interface (services, sqlViews,
types, and exceptions).
Registry Details
IUD The IUD is the interface's unique identifier for a service within the registry. The
system generates this identifier.
Version Each registry entry has a version type. You can have multiple versions of an
entry when you require multiple version of an interface.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 591
Registering Interfaces Chapter 24
Status An interface can have one of the following statuses within the registry:
Requested
The interface has been requested by a party but has not been implemented.
In Work
Active
Deprecated
The interface has been replaced by a more current version, but is still
supported.
Retired
Scope This field indicates who can reference this version of the interface:
If the interface is Public, it can be used by any application.
If the interface is Private, it can only be used within the provider module.
Generate Consumer Click to generate the consumer stub code for this registry entry. Use this code to
Code implement the service.
See Chapter 24, "Registering Interfaces," Implementing Registered Interfaces,
page 605.
Generate Provider Code Click to generate the provider stub code for this registry entry. Use this code to
implement the service.
See Chapter 24, "Registering Interfaces," Implementing Registered Interfaces,
page 605.
Show WSDL Click this button to generate Web Services Definition Language (WSDL) code
for the service registry entry. WSDL code provides you with all the details about
the service that is needed for consuming a service. The system displays the
<Registry Entry Name> page where you can view the WSDL code.
Note. Definitions for sqlViews, types, and exceptions do not have WSDL
viewing capability.
592 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Show XSD Click this button to generate XSD code for a type or exception registry entry.
XSD code contains the definition of a particular type, which is information that is
necessary for consuming complex types. The system displays the <Registry
Entry Name> page where you can view the XSD code.
Note. Definitions for services and sqlViews do not have XSD viewing capability.
Run Audit Click this button to run an audit of the selected registry folder. Audits ensure that
the registry is clean. They also enable you to monitor discrepancies between
implementation and contracts. The system displays the Audit - <Registry Folder
Label> page, where you can review the results of the audit.
Interface Details
Interfaces are defined using an XSD schema. The schema for each interface type is stored in the registry. The
system generates the schema during registration.
Note. The schema defines the details of sqlView interfaces, not the database view that implements the view
interface. The database view must match the properties defined in the schema.
Service interface types have operations called DoServices. A DoService has one or more input, output, and
outfault element and each element is defined by either one or more simple or complex type.
Exception Details
Implementation Details
In the Implementation Details group box, review the fully qualified application class path that implements
class for this type or exception. The class path includes a branch indicating the version of this type. The
version attribute of the registry entry must match the version in the class path of the type class.
Note. For sqlView interfaces, the Implementation Details box displays the database view implementing the
interface view.
Note. All exceptions must extend the class baseException, which extends the PeopleTools built-in exception
class.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 593
Registering Interfaces Chapter 24
Viewing RegistryDoc
To view RegistryDoc, click the Generate Registry Doc button on the Service Registry page. The system
generates the RegistryDoc and displays the View RegistryDoc link.
Click the View RegistryDoc link. The system opens a new browser window, which displays the registry API
content in HTML format.
594 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
The page contains three frames. The upper left frame lists the root packages within the RegistryDoc. Click a
link for a root package in the upper left frame to view for a list of all of the services, sqlViews, types, and
exceptions that are associated with the selected root package. The system displays the details of the selected
root package within the lower left frame. The right frame displays the services, sqlViews, types, and
exceptions for all root packages.
Click a link in the lower left frame or the right frame to view service, sqlView, type, or exception details.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 595
Registering Interfaces Chapter 24
From a service details page, click on the View WSDL link to view WSDL code for the selected service.
596 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
If a service or type refers to another complex type or exception, click on the type link on the details page to
view type or exception details.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 597
Registering Interfaces Chapter 24
598 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Interface Specification HMCR_WZ_STEP2 Set Up HRMS, System Enter details about the new
Administration, HCM interface.
Registry, Registration
Wizard, Interface
Specification
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 599
Registering Interfaces Chapter 24
Note. The pages in this component and the information you enter can vary
depending on the type of interface you select here.
Name Enter a meaningful name for the interface using the following guidelines:
One word (no spaces).
Mixed case.
Note. Users see the name you enter here on the registry tree so make sure that the
name is clear and meaningful.
The interface has been requested by a party but has not been implemented.
In Work
Active
Deprecated
The interface has been replaced by a more current version, but is still
supported.
Retired
600 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Select parent folder Click this link to access the registry folder structure and select the folder within
which the new interface will reside. Group interfaces by feature.
Note. The system displays a different version of this page depending on what type of interface you're
registering. See the Registering Services section for information on how to use this page to register service
interfaces.
Initialize from If you are basing the Interface View definition on an interface that has already
Implementation been implemented, click Initialize from Implementation and select the view. The
system populates the elements with the fields from the fields in the view's record.
Note. The system only displays this link when you register Interface Views.
Seq Nbr(sequence Indicate the order in which the element should occur.
number)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 601
Registering Interfaces Chapter 24
Element Name Enter the element name. An element is a property of the interface. Element
names must be one word, mixed case, and self-describing.
Note. If you are implementing an Interface View, you must add an element to
correspond with each field in the view's record.
Note. Service interface elements are descriptive items that identify the parameter
in a given position. While the position of the elements must correspond to a
parameter, it does not have to be a PeopleSoft field name.
Type Category Select the element category. Categories indicate whether the element's data type
is simple or complex. A simple datatype is a system-delivered data format.
Complex datatypes reference other interface types already in the registry.
Note. The system selects Simple for Interface Views and this field is unavailable
for entry.
Simple Type If the element is simple, select the element's system-delivered data format type:
xsd:string
xsd:date
xsd:number
xsd:boolean
Complex Type If the type is complex, select the registered element to which it refers.
Note. If the interface is an exception, you must select ExceptionType from the
Service Framework folder.
Minimum Occurrences Indicate the minimum number of times this element can occur. Select 0 if the
occurrence is optional and 1 if the element must occur at least once.
Maximum Occurrences Indicate the maximum number of times the element can occur.
Registering Services
When you register a service, enter the follow information in the four group boxes:
602 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
DoService Request
When a service interface will be used to request information, use the fields in this grid to define the
service's request parameters.
DoService Response
When a service interface will be used to respond to requests for information, use the fields in this grid to
define the service's request parameters.
Exceptions
List all of the exceptions defined for the service interface. You can only select exceptions that have
already be added to the registry.
Warnings
List all of the warnings and messages that could be logged during the execution of the service and that are
meaningful to the consumer.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 603
Registering Interfaces Chapter 24
Implementation page
Note. The system displays a different version of this page depending on what type of interface you're
registering. See the Registering Interface Views section for information on how to use this page to register
interface views.
Deployment and The system displays this field only when you register a Service interface.
Deployment Node Indicate if the service is Local (resides in the same database as the consumer) or
Remote (resides outside the consumer's database).
If the service is remote, select the deployment node.
Package Root Select the provider's root package. The root suffix depends on the interface type
you are registering:
For Type interfaces: <ownerID>_TYPES.
Class Path Select the class path to the appropriate version of your type class.
604 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Implementation Once you have implemented the class, return to the registry to select the
AppClass interface's application class. Do not select a value when you initially register the
interface; wait until you have implemented the interface.
See Chapter 24, "Registering Interfaces," Implementing Registered Interfaces,
page 605.
Note. If you are implementing a Service interface, populate this field only if the
service is local.
Generate Class Code Click to generate the PeopleCode for the implementation AppClass. You can
copy and paste the code into your application class object when you implement
the interface.
See Chapter 24, "Registering Interfaces," Implementing Registered Interfaces,
page 605.
Note. The system does not display this button when you register Service
interfaces.
Register Click to register the interface definition. When the system successfully registers
the definition it will display the interface's IUD.
Interface View After you have implemented a sqlView for this interface, return to this page and
select the view that corresponds to this Interface View.
See Chapter 24, "Registering Interfaces," Implementing Registered Interfaces,
page 605.
Related Language The system displays the related language view defined in for the implementation
Interface View in Application Designer, if one exists.
Implement types.
Implement services.
Implement exceptions.
Implement SQLViews.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 605
Registering Interfaces Chapter 24
Implementing Types
To implement a registered type interface:
1. In Application Designer, create an application package for each functional module using the naming
convention <NAMESPACE_PREFIX>_TYPES.
Use the first level sub-package to group implementation classes by function and the second level to group
classes by versions.
When you create the application class, you must ensure that it:
Has a IUD property that contains the correct IUD of the corresponding registry entry.
Instantiates any array properties defined in the class as array properties with 0 elements.
3. Copy the stub code the system created when you clicked the Generate Class Code button on the Registry
Wizard - Implementation page for this interface and paste it into the application class implementing the
interface type.
The generated type stub code includes the following mandatory methods:
method toxmlNode(&parentNode As XmlNode);
method TruncateType();
The system uses the XML mandatory methods to marshal and unmarshal the type to or from an xml
representation, which is required in order to use this type in a remote service invocation. The
truncateType mandatory method resents the value of all type elements.
4. Access the registry entry for the type interface in the Registry Wizard and add the application class to the
type's implementation details.
Implementing Services
Consumer programs cannot directly instantiate service implementation classes. Due to late binding and
remote procedure call support, the framework delays the resolution of the implementation class name until
run-time so the only information available to service consumers during design is the interface name.
606 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
At run-time, the service manager resolves the interface name into the implementation class name using the
registry lookup functionality. Depending on the implementation details defined in the registry, the service
manager will return to the consumer either an instance of a local implementation class or a proxy class for the
remote implementation.
Because of these considerations, the providing application needs to supply the following two application
classes to fully implement a service:
An implementation class that the service manager can bind to during run-time.
1. In Application Designer, create an application package for each functional module using the naming
convention <NAMESPACE_PREFIX>_SERVICES.
Use the first level sub-package to group implementation classes by function and the second level to group
classes by versions. Use the third (application class) level to define an interface and an implementation for
the service.
2. Create two application classes to implement the service, an interface and an implementation class.
3. Select the registry entry for this service and click the Generate provider Code button. The system displays
a page with three group boxes containing code:
Interface peoplecode
Copy and paste the interface PeopleCode into the interface application class.
Implementation peoplecode
Copy and paste the implementation PeopleCode into the implementation application class. The
implementation code generated is only a skeleton the actual logic for the application class. The
development team must therefore modify the implementation class to meet the providing application's
needs.
Proxy peoplecode
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 607
Registering Interfaces Chapter 24
4. Confirm that the interface and implementation classes contain the necessary information.
The two applications serve different functions. The interface class is an abstract definition and details
what methods and properties the implementation class will have to have to comply with registered
specifications, but it does not contain the implementation details. The implementation class actually
implements the interface, providing the executable code for the abstract method definitions.
Contain a constructor method that creates an instance of the parent baseService class.
Define an abstract DoService method with the signature matching the signature of the registered
service.
When a development team decides to provide a service, they create an interface and implementation
class that implements it.
Imports the interface that it implements, as well as the types and exceptions it is working with.
Throws exceptions in accordance with the registered interface contract in order to handle errors.
The interface application class provides details of all warnings that were generated when the service
was executed.
Uses the API2CI framework to abstract from the component interface specifics, if the implementation
is component interface-based.
Component interface-based services need to import the CI library (which is provided with the registry)
using this code:
import HMCR_API2CI
If you are using a DoService method, you need to declare two local objects: ciHandler and ciIdent.
ciHandler is the class managing all access to a component interface since you cannot directly
manipulate a component interface. ciIdent defines the unique attributes of each ciHandler instance.
6. Access the registry entry for the service interface and add the implementation application class to the
type's implementation details.
608 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Note. You can use services to organize multiple other services to execute an business task. This is called
aggregating services. The aggregating service is the service responsible for managing the business
transaction, housekeeping, and performing the save professing so these processes are run only once,
improving overall performance. When a service is running another service in aggregation mode, the calling
service (the aggregating service) sets the RunAggregated flag on the called service, causing the called service
to skip the housekeeping and save processing.
Implementing Exceptions
PeopleSoft delivers a baseException class providing the default exception handling, which is on the
PeopleTools exception class. The baseException class constructor takes the following parameters:
Creates a PeopleTools exception for the provided message set and message number.
1. In Application Designer, create an application package for each functional module using the naming
convention <NAMESPACE_PREFIX>_EXCEPTIONS.
Use the first level sub-package to group implementation classes by function and the second level to group
classes by versions.
2. Copy the stub code the system created when you clicked the Generate Class Code button on the Registry
Wizard - Implementation page for this interface and paste it into the application class implementing the
exception.
Note. The exception's registry entry defines the exception name, the fault message structure, and the
exception semantics (description).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 609
Registering Interfaces Chapter 24
Takes an instance of a LogType as a single parameter and imports the LogType class definition.
Assigns the correct IUD of the corresponding registry entry to its IUD property.
Implementing SQLViews
To implement a registered sqlView interface:
Note. Implement registered sqlView interfaces as PeopleSoft record definitions with a type of view.
1. Create fields on the record definition to correspond to each field in the registered sqlView interface.
3. Open the sqlView registry entry and add the implementation record name to the registry entry.
When you are creating a new interface view, you must use the Registry Wizard component. When you are
updating an existing view, you must use access the registry and click the Update button. The system then
displays the Registry Wizard component.
See Chapter 24, "Registering Interfaces," Registering New Interfaces, page 598.
Consume SQLViews.
610 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Note. You can click the Generate Consumer Code button on the Registry Details page for the registered
service to generate all the code the consuming application needs. Cut and paste the code into the consuming
application's PeopleCode Event (for example, SavePostChange PeopleCode). Confirm that the generated code
meets the criteria set out in these steps and make any necessary modifications.
Note. You can only place the code for manipulative services such as Set,Add, or Delete in the
SavePostChange PeopleCode of a single field in a component. You cannot spread out manipulative service
calls over several PeopleCode events. You must also not place manipulative service calls in FieldChange
PeopleCode.
1. Import, declare, and create framework classes, service classes, and type classes.
2. Bind to the service implementation using the Service Manager's LocateService method.
At runtime, the Service Manager determines the appropriate implemented interface application class and
returns an instance of it to the consuming application for invocation as follows:
a. The import statement in the consumer code indicates which registered interface is required.
b. The registered interface contains information about which implemented interface class is required.
c. The Service Manager's LocateService method returns an instance of the implementation class.
Note. The LocateService method requires the service name and the service version in order to bind to
the appropriate service.
The consumer code only needs to know which registered interface it is using. The provider application
specifies which implemented class should be returned to the consumer. This enables the provider to make
changes to the implemented interface without impacting the consumer.
3. If you are invoking a type interface, the consumer application needs to set the properties of the type class
in the input parameters prior to passing it to the DoService call.
The type interface registry entry describes the properties of the type class. The consumer can map
properties individually from the consuming application to the type class properties.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 611
Registering Interfaces Chapter 24
4. Invoke the DoService method of the service implementation class, passing the parameters as defined in
the service signature.
The service signature defines the zero or more input and output parameters that need to be passed to the
service. Parameters can be simple types (such as string, number, date, or boolean) or complex types
defined and registered as types in the interface registry:
When the service requires complex types as parameters, the consumer needs to import the type class,
declare it as a local variable and instantiate it using the Create instruction.
When the service requires simple types, the simple types only need to be declared by the consumer.
The consumer code must invoke all services within a try-catch block. All code executed in between the
try and the catch statement is in a protected area so that any exceptions thrown during service execution
will immediately return control to the catch statement in the consumer code. The consuming application
can then react to the exception.
The consumer code can catch specific exceptions or the baseException, which is the parent class to all
registered exceptions.
Note. The consuming code should always catch for baseException to catch exceptions not specific to the
service.
During service execution, the registry framework collects all warnings and messages issued by the
provider and exposes them to the consumer as a service execution log. The consumer can query the
execution log and take action based on the warnings and messages, if necessary.
Each service has a property called ExecutionLog. The property has an array of LogType called Log. The
LogType has the following attributes:
DEFAULT_TEXT
MESSAGE_SET_NBR
MESSAGE_NBR
MESSAGE_SEVERITY
The service's Log class has a generic method ShowLog() to display the content of the execution log.
Note. All consumer PeopleCode runs within the scope of a consumer component session. Any services that
the system invokes during the component runtime will also run within this transaction scope. If the service
execution encounters fatal errors, the system will roll back the entire component transaction unless the errors
are specifically caught as exceptions. For example, if the a component in the consumer application uses two
services invoked by the SavePostChange PeopleCode and one executes successfully while the other throws a
fatal error, the system will not save any data to the component from either service.
612 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
However, if the service is to update prior selected data, you need to set up a stale data check to ensure that the
underlying data has not been modified during user interaction on the consumer side. To do this, create a Get
service in the Component.PostBuild PeopleCode and a Set service in the Component.SavePostChange
PeopleCode.
If the registry detects a discrepancy in the data, it will cause an error, which can be caught using
baseException.
The system then passes the component interface pool to the Service Manager's LocateService method. If a
requestor is only issuing one service call in a Peoplecode Event, the system passes NULL as a component
interface pool.
Use a collection-sized Get service to populate the collection type class, manipulate it, and pass it back to the
Set service.
In the consumer code, set up a call to the helper method PopulateToRowset to bring all data from the type
class instance to the user interface of the consumer component. Set up a call to the helper method
PopulateFromRowset to bring all values from the rowset used in the user interface of the type class.
Note. Not all type classes provide helper methods and not all helper methods will work in all consumer
components. In these cases, you will need to write your own logic to bind the type class values to the
consumer user interface.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 613
Registering Interfaces Chapter 24
Consuming SQLViews
Consuming applications can use registered sqlViews directly without binding. Use registered sqlViews for the
following:
Search views.
Prompting.
Related display.
Administer Service Registry HMCR_CONTENT_ADMIN Set Up HRMS, System Add or delete folders from
Administration, HCM the registry.
Registry, Administer
Service Registry,
Administer Service Registry
614 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Create Folders
To create a new folder, select Create Folder in the Operation field and enter the folder's registry details.
Folder Label Enter the folder label that will appear in the registry.
Owner ID Select the folder content's owner ID from the list of options.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 615
Registering Interfaces Chapter 24
Final Level Indicate if the folder is a final folder. A final folder can not have any child
folders other than the folders for the four interface types. If you make this folder
a final folder, the system will create the four interface folders.
If you leave this check box deselected, the folder is a feature folder and you can
add child folders to it.
Create Tree After you have entered the folder details, click the Create Tree button. When you
click the button the system generates a new registry tree. Navigate through the
tree and select the node under which the new folder should go.
You can only place a new folder under folders that have the same owner ID and
that are not final level folders.
Delete Folders
To delete a folder, select Delete Folder in the Operation field. Expand the registry tree, locate the folder you
want to delete, and click on it. You cannot delete a folder that contains registered interfaces within one if it's
child folders.
Testing Services
To test newly created services, use the Service Tester component (HMCR_SRV_TESTER).
Service Tester HMCR_SRV_TESTER Set Up HRMS, System Test newly created services
Administration, HCM in this generic component.
Registry, Service Tester,
Service Tester
Testing Services
Access the Service Tester page (Set Up HRMS, System Administration, HCM Registry, Service Tester,
Service Tester).
616 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Use this page to test newly created services through a generic component. For example, if you create a new
service using the Registration Wizard component and the corresponding implementation code, you can use
this page to test the service and ensure that service you are committing works as designed. The system returns
the results of the service test in a new window as XML.
Add, Correction, or Select the mode that the service will run in. You can use these options to test the
Update/Display service running in the various modes.
Use Tree Input and Use Select to populate inputs using an XML format (SOAP 1.2) or using the tree
XML Input structure. When you click the Use XML Input button, the system converts the
tree inputs to the corresponding SOAP document. This is useful for testing
remote services, for populating the inputs of a larger service, and for copying an
existing service to a new service test (similar to "save as" functionality).
Use Input Parameters as Select this check box for services which have no input parameters but do update
Output the input parameters that are passed in. This is valid only for local services
because remote services cannot update inputs by reference. It is not
recommended for local services but can be used where local services where this
situation exists.
Run Service Click this button to invoke the service request after you have populated the
inputs. Upon completion of the service call, the system displays the outputs of
the service in a new window as XML.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 617
Registering Interfaces Chapter 24
618 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Use this page to view details of transformation maps, which instruct the system to convert incoming messages
(From) into (To) a specific format. Primarily this is done because, between release, the record definitions may
have undergone a change.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 619
Registering Interfaces Chapter 24
When you need to exchange information between two different release of a PeopleSoft Enterprise product
you must perform transformations. With each release record definitions sometimes undergo changes.
Transformations enable you to scale these problems by transforming messages from one release to another.
Use this page to create transformation maps for messages from one release to another and from one version to
another.
Message Name Select the message that needs to be transformed from one version to another.
Message Version Select the version of the message that needs to be transformed for one version to
another.
Application Release Select which PeopleSoft Enterprise application release that the message belongs
to. For example, specify whether the message is from the HRMS 8.3 system or
the HRMS 8,8 system. The Default value is that the system use the current
release of the product.
Transaction Type Select the type of transaction of the message, either Inbound Asynchronous,
Inbound Synchronous, Outbound Asynchronous, or Outbound Asynchronous.
IUD The system displays a unique identifier for the transformation. The system
generates this identifier.
620 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
Synchronize Integration Broker services with the Integration Services Repository (ISR) automatically.
PeopleTools Integration Broker serves as the transport mechanism for services. By mapping your HCM
services to Integration Broker, you ensure that your Service Registry conforms to industry standards.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 621
Registering Interfaces Chapter 24
Initiate the mapping of HCM services to Integration Broker through the HCM Interface Registry. The system
permits mapping at only third level folders, which are the lowest sub-categorization of HCM services for
products.
To map the HCM Interface Registry metadata for a particular folder to an Integration Broker service:
1. Click the folder name link on the Service Registry page for a third level folder.
2. Click the Add to service repository button to add to the service repository.
Provided that you have set up Integration Broker, the system displays details of the service.
Note. The Delete from service repository button is available only when you have mapped the registry
folder to the Integration Broker service repository, at which time the Add to service repository button
becomes unavailable. This ensures that you can only perform the correct action.
The system automatically generates an Integration Broker service name for the folder. This service name is
the IUD for the folder, which is unique string within the HCM Interface Registry and thus guarantees that
each service has a unique name. Optionally, you can rename the Integration Broker service to give it a more
meaningful name through the Service Administration component (PeopleTools, Integration Broker, Service
Utilities, Service Administration). If you rename the service, the system still guarantees a unique name
because the Service Alias field contains a copy of the IUD service name. This ensures that the delete process
has a means of correlating the service with the HCM Interface Registry.
Note. Do not change the Service Alias field under any circumstances because it is critical to service delete
processing.
Each HCM service that is in a registry folder on the Service Registry page is mapped to an Integration Broker
service operation and can be found in the service that you have generated for the folder on the Services page
(PeopleTools, Integration Broker, Integration Setup, Services). The system uses the name of the HCM service
as the name for the service operation, unless that service operation already exists. If the service operation
does already exist, an algorithm works within the length constraints of the Service Operation Name field (30
characters). The algorithm replaces the endmost characters with digits until it generates a unique name. The
system retrieves the version for the service operation from the HCM Interface Registry.
The system maps each input and output interface to an integration Broker non-rowset based message,
complete with generated schema. The system also assigns the version from the HCM Interface Registry. The
base name for the messages is the HCM service name plus the suffix _IM or _OM to designate input or
output interfaces, respectively (for example, ADDPOITYPE_IM) .
The system maps outfault interfaces to Integration Broker non-rowset based part messages. This is due to the
limitation of Integration Broker having only one fault message per service operation. Therefore, the system
creates all outfaults that are associated with a mapped HCM service within an Integration Broker container
message. The system indicates outfault messages by using the suffix _FM (for example,
ADDPOITYPE_FM).
622 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 24 Registering Interfaces
The system assigns each service operation that you generate the standard HCSPSERVICE permission list.
Access the permission list details for the web service on the Web Service Access page (PeopleTools,
Integration Broker, Service Operations, General, click the Service Operation Security link).
The system assigns a handler to each service operation that you generate. The assigned handler references a
generic handler class that is processing the incoming request, and generates the required response. The
generic handler is HMCR_FRAMEWORK:IB_Framework:Handlers:IB_SyncRequestHandler. Access
handlers for service operations on the Handlers page of the Service Operations component (PeopleTools,
Integration Broker, Integration Setup, Service Operations).
Within the HCM Registry there is no indication of consumers for a given service, so the system does not
generate routings during the mapping process. It is up to the development teams to create the necessary
routings.
The delete process removes the following objects from the Integration Broker metadata:
WSDL
Services
Service operations
Message schemas
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 623
Registering Interfaces Chapter 24
1. Access the Service Operations component (PeopleTools, Integration Broker, Integration Setup, Service
Operations).
2. Select the Generate Any-to-Local check box in the Routing Actions Upon Save area of the General page.
The system updates the Any-to-Local value of the Routing Status area to Exists.
The system also generates the routing and displays it on the Routings page of the component.
You can publish as a web service any service that has at least one service operation defined as any-to-local.
1. Access the Provide Web Service component (PeopleTools, Integration Broker, Web Services, Provide
Web Service) to launch the Provide Web Service Wizard.
2. Search for the service that you wish to publish as a web service.
3. Select that service in the returned search results, and then click the Next button.
4. Select the service operation for the service that you want to publish as a web service, and then click the
Next button.
5. Click the View WSDL link for a service to view the WSDL that the system generated for the service.
6. Return to the View WSDL page and click the Next button.
Select the Publish to UDDI check box or the WSDL Repository check box to publish the services to the
corresponding location.
8. View the WSDL generation log to confirm the results of the wizard.
624 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 25
Prerequisites
Before you can create organization charts, you must:
Visio is not delivered with PeopleSoft Human Resources; you must purchase and install Visio on the
client computers separately. For more information about installing Visio, see your Visio documentation.
Select Visio as your Organization Chart interface on the Third-Party/System page in the Installation Table
component (INSTALLATION_TBL).
Make sure that organization and person data exists in PeopleSoft Human Resources before you start
working with the Organization Charting Interface pages.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 625
Setting Up and Building Organization Charts Chapter 25
Run the Organization Chart SQR from the Organization Chart page.
Review the organization chart information gathered by the Organization Chart SQR.
626 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 25 Setting Up and Building Organization Charts
Tree
Builds your tree based on one of your Human Resources system trees. Using
this option, you can include multiple departments in your chart.
Note. You can build your organization chart from active department and position trees only. You must also
have security access to the trees and departments that you want to include in your organization chart.
If you select Department in the Report Type field, then the Set ID and Department fields appear.
Department Enter the department that you want to include in your organization chart from the
list of department IDs in the setID. You build your organization chart one
department at a time. (You create the department codes when you define
departments in the Department Table.)
Run Click Run if you're building your chart using the Department report type.
PeopleSoft Process Scheduler runs the Organization Chart SQR.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 627
Setting Up and Building Organization Charts Chapter 25
If you selected a report type of Tree, the SetID, Tree Name, Tree Node, and #Levels (number of levels) fields
appear:
Tree Node Select the level of the tree on which you want the organization chart to start. For
example, if you're using a department tree, select the department.
Tree Level The system enters the tree level of the tree node that you selected.
Nbr Levels (number of Specify the number of levels to include in the tree.
levels)
For example, if you begin the chart at tree level5 and you specify the number of
levels as3, the organization chart includes levels 5 though 7 of your tree.
See Also
Chapter 5, "Setting Up and Administering HRMS Security," Creating and Modifying Security Trees, page 85
1. Access the Process Monitor Process List page (PMN_PRCSLIST) (PeopleTools, Process Scheduler,
Process Monitor).
2. Locate the organization chart process and click the associated Details link.
628 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 25 Setting Up and Building Organization Charts
Unique ID
Name
Reports To
Position
Department
Telephone
Note. These instructions are for Visio 2000. The Organization Chart Wizard may operate slightly differently
for other Visio versions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 629
Setting Up and Building Organization Charts Chapter 25
2. In the window that appears, select the option Information that's already stored in a file or database and
click Next.
3. On the next window select the option A text, Org Plus (*.txt), or Microsoft Excel file and click Next.
4. On the next window enter the location on the client that contains your organization information (where
you saved the ORGCHART.TXT file), for example C:\TEMP\ORGCHART.TXT and click Next.
5. Select Name for the Name field, Reports_To for the Reports to field, and <none> for the First Name
(optional) field and click Next.
6. Select the data that you want displayed in the chart shapes (for example Name for the First Line and
Position for the Second line) and click Next.
7. Add other fields contained in the ORGCHART.TXT file to the Org Chart by selecting them from the Data
file columns and adding them to the Custom Property fields column. Click Next.
8. Select I want the wizard to automatically break my organization chart across pages and click Finish.
Following is an example of the Visio page that you see when your organization chart is complete:
Note. For more information about editing and printing your organization chart in Visio, see your Visio
documentation.
630 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26
Note. PeopleSoft no longer supports HRMS-specific Mass Change templates. We have left the templates in
the database for your convenience, but recommend that you use the Mass Update feature.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 631
Setting Up and Processing Mass Updates Chapter 26
Mass Update Manager: This is the front-end module that provides the user interfaces for the Mass Update
feature. It consists of:
The Define Mass Update component (MU_SETUP ). for setting up mass update definitions.
The Create Mass Updates component (RUNCTL_MU_CREATE) and related Application Engine
(AE) process for generating mass update transactions.
The Report Mass Updates component (RUNCTL_MU_PRINT) and related Structured Query Report
(SQR). report for reviewing and printing lists of mass update transactions.
The Manage Mass Updates component (MU_MANAGE) for reviewing or previewing mass update
transactions, managing statuses, and processing mass update transactions individually online.
The Execute Mass Update component (RUNCTL_MU_EXECUTE) and related AE process for
running mass updates in batch.
The Delete Mass Updates component (RUNCTL_MU_DELETE) and related AE process for deleting
pending mass update transactions.
Transaction Processor: This is a back-end module that consists of the Configure Processor component for
setting up and managing system data that is available for mass updates and an application class that
provides access to transaction processing functionality. The role of the Transaction Processor application
class is to provide access to services within the Services Oriented Architecture (SOA) to read (select and
write, or update, information. Each transaction is an XML message that contains the list of elements that
are involved in the update for a specific employee and employee record combination. The Transaction
Processor application class interprets this XML message, provides access to the correct service, and
returns acknowledgements and any exceptions to the online or batch process that calls it.
Execution Manager: This is a back-end module that is a mechanism in the batch mass update process to
manage and monitor parallel processing through spawning. Spawning is a method of simultaneously
running multiple instances of a child process by a parent process. The Execution Manager enables you to
run multiple instances of the batch mass update process and run these instances in parallel to improve
performance.
1. Set up a mass update definition through the Define Mass Update component.
2. Run the mass-update selection phase and create transactions for mass update through the Create Mass
Updates page (which is part of the Mass Update Manager module.)
You can review and update transactions online through the Manage Mass Updates component.
You can also generate a report to review transactions from the Report Mass Updates page.
632 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
You can process transactions one at a time from the Manage Mass Updates component, which is part of
the Mass Update manager module.
Or you can process transactions in batch through the Execute mass Updates page, which is part of the
Execution Manager module.
5. (Optional) If necessary, cancel transactions through the Manage Mass Updates component, which is part
of the Mass Update Manager.
6. (Optional) If necessary, delete transactions one at a time through the Manage Mass Updates component,
or delete transactions in batch through the Delete Mass Updates page.
The following diagram illustrates this process flow of mass update processing:
Use the correction option only if you are certain that you want to override data.
Familiarize yourself with the online transaction to understand the rules governing the component before
trying to automate it using the Mass Update process. When you update a component using Mass Update,
it is governed by the same rules (such as defaulting and required fields) as when you access the
component online.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 633
Setting Up and Processing Mass Updates Chapter 26
Create several simple Mass Update IDs that you can use in combination instead of trying to create a
complicated one that changes everything.
In addition to being more flexible, this approach facilitates identifying the source of errors.
Important! The Mass Update feature uses services to update data. Services run all of the business logic that
is associated with a component, which ensures that the components function correctly and that the data is
consistent. However, updating the data in this manner, while more complete, is slower than some other
methods (such as a SQL update). When you run a mass update, take steps to improve performance, such as
limiting the size of the transaction set, performing the update at night when server traffic is low, or both.
This section provides an overview of Transaction Processor configuration and discusses how to:
Mass update processing relies on the configuration of the Transaction Processor. To perform this
configuration, you must use the Configure Processor component. This component is intended for technical
users with a high level of experience. PeopleSoft provides many predefined sections within the Configure
Processor component for performing mass updates.
The Transaction Processor setup defines the sections that are available for a mass update, the service that
manages the update, and the list of elements that are available for mass update within the section. You can
then use the Define Mass Update component to create mass update definitions. During mass update
processing, the Mass Update Manager triggers the Transaction Processor to process mass update transactions
using the section, elements, and values that you define on the applicable mass update definition. For each
section that the Transaction Processor encounters, it refers to the Transaction Processor setup for the right
service, and then triggers the service with the values that are defined in the transaction.
Note. If you add Job Profile Manager (JPM) catalog types to the system, then to perform mass updates to the
newly added JPM data, you must replicate those catalog types in the Configure Processor component.
634 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Configure Processor MU_TP_SETUP Workforce Administration, Define the sections that are
Collective Processes, Mass available for a mass update,
Update, Configure the service that manages the
Processor, Configure update, and the list of
Processor elements that are available
for mass update within the
section. You also define
prompt and prerequisite
information that the system
uses when you create mass
update definitions through
the Define Mass Updates
component.
Configure Processor - MU_TP_SETUP_PRE Click the Details icon on the Define the prerequisites
Prerequisites Configure Processor page. elements that you must
define as part of a mass
update definition for the
given section. These
prerequisites establish the
relationships between
elements that are available
for mass update
transactions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 635
Setting Up and Processing Mass Updates Chapter 26
Sections
Section Enter the name of the section. A section is a functional group of elements and is
defined within a service.
Description Enter the description of the section. When you are defining a mass update on the
define Mass Update component, the system uses the description as a prompt
value for the Section field.
Level Select whether the Component Interface is based on an Employee Record number
or a Person. By default, the system selects the Person value.
When the Mass Update Manager module generates mass updates for a person, it
uses the selected level to ensure that it generates these update transactions for the
same person once only.
The Transaction Processor module uses the selected level to provide access to the
service that contains the correct key values.
Allow Copy Forward Select to make the Copy Forward option available for the section or service in the
Define Mass Update component.
636 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Service Enter the service that the system uses to manage the update for the corresponding
section. The service that you specify provides all the controls and defaults for
mass updates that involve the section; no processing logic is within the setup
itself.
PeopleSoft Enterprise Human Resources delivers the following services for use
with mass update processing: Job Data (which includes specifics for
compensations and labor agreements), Person Data, Job Profile Manager, and
Military Approval Tracking. Each service is defined using data types and uses
the same base class. Each data type defines the elements that are available for the
service. To manage services, use the Service Registry component.
Note. You can also build your own services and incorporate them into the Mass
Update feature. To have the mass update process access data beyond the
delivered services, you must define a service to manage the specific
requirements, register the service, and then update the Transaction Processor
setup.
Elements
Element Enter the object name of the element or data type that you want to make available
for a mass update that uses this section. You can enter as a value any simple data
type that is defined in the service. The elements that you list provide the
information that is available for a mass update.
Description Enter the description of the element. When you are defining a mass update on the
define Mass Update component, the system uses the description as a prompt
value for the Element field.
Prerequisites Defined The system automatically selects this check box whenever you have defined
prerequisites for the element.
Details Click this button to access the Prerequisites page, where you can define
prerequisites for the corresponding element.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 637
Setting Up and Processing Mass Updates Chapter 26
Prompt Select how you want to define the prompt for the element. The prompt that you
select determines how you can define the value of the section and element
combination on the Define Mass Updates page. Possible values are:
Action: When processing a mass update for this section and element
combination, the system performs the specific action within the application
that the element defines. For example, an element might perform the action of
pressing a button or setting a default value (in that case, there is no prompt).
Checkbox: When you are defining a mass update for this section / element
combination, the system displays a Boolean Value check box.
Date: When you are defining a mass update for this section / element
combination, the system displays a date field.
Record: When defining a mass update for this section / element combination,
the system displays a Character Value field that prompts against the record
that you specify in the Edit Record or Field field.
Edit Record or Field If you select to prompt for the element with a record, select the record. If you
select to prompt for the element with a translate value, select the field name.
638 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Section Prerequisite, Select the section and element that is a prerequisite to this section and element
Element Prerequisite, when defining a mass update. The system prompts you to select from the sections
and Description that you have defined in this component and the elements that you have defined
for the selected section prerequisite. The system displays the name of the element
prerequisite that you select.
Prompt Field Select the field that you want to use to prompt for the prerequisite element. This
field is used internally in order to identify which field of the prompt record will
be populated with the value of the prerequisite field. For instance, the element
Work Location / Department has the element Work Location / Business Unit as
prerequisite. Then, the field SETID will be populated with the value of Business
Unit when used in the prompt record DEPT_TBL.
Sequence Enter the sequence in which you need to enter the prerequisites when defining a
mass update.
This section provides an overview of mass update definitions and discusses how to:
You should review mass update definitions carefully to avoid population overlap. The Mass Update process
manages additional changes in sequence, processing each employee and record number combination only
once. Each change overrides the previous one for the same employee and record number. Therefore, only one
combination of change data within a mass update definition applies to an employee and employee record
number combination during one mass update.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 639
Setting Up and Processing Mass Updates Chapter 26
For example, assume that you want to change the Department value from D1 to D2 and also change the
Location value to L3 for all departments with D2 value. If you define on the Additional Changes page within
a single mass update definition to update the department element value to D2 and the D2 departments to a
location value of L3, the Mass Update process will first move employees in department D1 to department D2
and then move the employees who are already in department D2 before the update to location L3. The
Employees process will not change the location of the employees with the department change. If you want the
location change to apply to the whole population, you must define two mass update definitions, one for the
department change and one for the location change. You must then apply the second mass update only after
the first one finishes.
640 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Define MU page
Mass Update ID When adding a new mass update definition, enter a unique ID for the definition.
Description and Short Enter a description and short description of the mass update definition.
Desc (short description)
Status The system displays the status of the mass update definition. Possible values are:
New: The mass update definition has been created and is available for the
selection phase.
Initiated: The mass update definition has been included in a run of the
selection phase. You can run the selection phases multiple times before
running the update phase.
In Progress: The mass update definition has been included in a run of the
update process phase. You can run the update phase multiple times before
running the completion phase.
Closed: The mass update definition has been included in a completion phase
and closed. You cannot run any further mass update processing.
Note. When you initiate the update phase of the mass update processing, the
mass update definition becomes display only.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 641
Setting Up and Processing Mass Updates Chapter 26
Copy From Select another mass update definition to use as the basis for the definition that
you are defining. If you confirm the copy of the mass update definition, the
system populates the Define Mass Update component with data from the other
definition.
When you copy a mass update definition, the system verifies whether the group
builds and employees that are in the original definition are available for you to
use. If not, the system issues a warning and removes the unavailable group builds
and employees from the new definition.
Note. The system overwrites all existing data that you have already included in
the new definition that you are creating.
Use this group box to specify the general processing options for the mass update definition. Indicate whether
you want the process to correct the current information or add a new effective-dated row. Also indicate how
you want the process to handle eligible future-dated rows.
Add a New Effective Select to insert a new effective-dated row using the Reference Date value as the
Date new effective date. If a record already exists with this effective date and the
record contains a sequence number field, the system inserts a row with the date
and a new sequence number, otherwise it overwrites data. If the record is not
organized by effective sequence, overwrites data. This option inserts new
information and does not override previous data.
Correct Current Select to change incorrect data and override information in the person's records.
Information The system corrects the record that is or was effective as of the Reference Date
value that you enter.
Reference Date Enter the data that you want the mass update processes to use when inserting a
new effective-dated row or correcting an existing row.
Include Eligible Future Use this option when you want to update data of employees that are eligible for
Rows the change (as defined in population selection criteria) after the reference date.
This option (similar to retroactivity) can be used in conjunction with the carry
forward option available at element level.
642 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Use this group box to define the population selection criteria for the mass update. For each row of criteria that
you define, you can select to include or exclude the associated employee population. You can combine
multiple rows of criteria to refine the population selection.
Select By Select how you want the system to select the employee population to include or
exclude for the mass update.
When you make a selection here, the system displays related fields for you to
specify which value you want the process to update. For example, if you selected
Group ID, the system displays the Group ID field. The update process will select
all people with the group ID that you specify.
Note. To set up mass update definitions by group, you must grant group security
to the Define Mass Update component. To set up a mass update definition by
department (this is also applicable for other criteria, such as business unit,
company, etc... the row-level security defined in the database is applied for any
selection), the user must have access to the selected department.
Boolean Value If applicable, select this check box to indicate the Boolean value for the selected
population.
From Date and To Date If applicable, enter the date range for the selected population.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 643
Setting Up and Processing Mass Updates Chapter 26
Business Unit If applicable, select the business unit to which the employees in the selected
population belong.
Character Value If applicable, enter the character value for the selected population.
Regulatory Region If applicable, select the regulatory region for the selected population.
Labor Agreement If applicable, select the labor agreement for the selected population.
Military Service If applicable, select the military service for the selected population.
Process Select whether to include or exclude the selected population from the mass
update.
Individuals
Use this group box to include or exclude specific employees from the mass update.
Empl ID (employee ID) Select the employee that you want to include or exclude from the mass update.
Empl Record (employee Select the record number of the employee that you want to include or exclude
record number) from the mass update.
Process Select whether to include or exclude the selected employee from the mass
update.
Data Changes
Use this group box to define which fields to update and with what values. You must enter at least one row on
this page or the Additional Changes page.
You should include an action and reason code value when making changes to job data. If you do not specify
an action and action reason for inserting a new effective-dated row in a person's Job or Personal Data record,
the Mass Update process inserts the following values in the new record:
644 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Seq Nbr (sequence Enter a numeric value to indicate the order in which you want to process the
number) mass updates. By default, the system sets the first row to one and incrementally
increases the value by one for each additional row that you insert.
Some elements cannot be updated without your specifying several other related
elements in the same mass update ID. For example, to specify a Location on the
JOB record, you must first specify the appropriate business unit. The Business
Unit element should be processed first and should have an earlier sequence
number than Location.
Elements that are managed with a key, such as phone information, also require
that you use a sequence number to ensure that the key is updated first. For
example, before the mass update can update a phone number, it needs to update
the phone type. When setting up the mass update, ensure that phone type is an
earlier sequence number than the phone number.
The system warns you if you need to add a related or key field.
Section Select the section that contains the element for which you want to perform a mass
update. Define the section and element combinations that are available for mass
updates as part of the Transaction Processor setup on the Configure Processor
page.
Element Select the element within the selected section for which you want to perform a
mass update data change. An element refers to a field on a page. Define the
section and element combinations that are available for mass updates as part of
the Transaction Processor setup on the Configure Processor page.
Some elements require prerequisites as defined on the Configure Processor page.
You must select prerequisites elements first. If you select an element that
requires a prerequisite element and you have not entered a data change for the
prerequisites, the system alerts you to the missing prerequisite.
Character Value Specify the new value to which you want to change the selected element. The
system displays different value fields according to the type of field for the
selected element.
Copy Forward Select to have the Mass Update process update all existing future effective-dated
rows in addition to the effective-dated row that it is adding or correcting. A
future effective-dated row is a row that has an effective date that is later than the
reference date that you specify on the Define MU page. This option is applicable
only to data that is effective-dated.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 645
Setting Up and Processing Mass Updates Chapter 26
Additional changes are combined with common Changes and several combinations can be defined. While
several additional changes can be entered, none of them is mandatory.
Change Number Enter in the Change Number field the order in which you want to process mass
update changes for additional populations within the mass update definition.
Click the Add a new row button to insert information for data changes to
additional populations. The system automatically sets the first row to 1 and
increments the value by 1 for each additional row.
Note. The remaining fields on this page are the same as the fields on the Common Changes page.
646 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Note. The process shares this run control page with other mass update processing components.
Mass Updates
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 647
Setting Up and Processing Mass Updates Chapter 26
Seq (sequence) Enter the sequence in which you want the process to generate mass update
transactions for the mass update definitions that you specify. By default, the
system sets the first row to 1 and increments the sequence by 1 for each
additional row that you add.
Important! If you are creating transactions for two or more mass update
definitions at the same time, be sure to avoid population overlap between the
mass update definitions.
Mass Update ID and Select the mass update definition for which you want to generate mass update
Description transactions. The system displays the description of the selected mass update
definition.
Mass Update Status The system displays the processing status of the selected mass update definition.
Possible values are New,Initiated, In Progress, and Closed.
See Setting Up Mass Update Definitions, Defining Generic Information For
Mass Updates
648 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
The Mass Update SQR report (HRMASS) includes the mass update ID, description, and status. It also
includes the total transactions per status and transaction details. This report is part of the Mass Update
Manager module. You can run this report anytime before, during, or after the processing of the mass update
transactions. When it is run before you process the mass update transactions, you can use this report as a
preview.
Language Select the language in which you want to print the report.
Transaction Status Select the status of the mass updatate transactions that you want to include in the
report. Possible statuses are Cancel,Failure,Ready, Success, and Warning.
Print Messages Select to include the details of messages and exceptions in the report.
Mass Updates
Use this group box to enter one or more mass update definitions to include in the report.
Seq (sequence) Indicate the order in which you want the mass update definitions to appear on the
report. By default, this sets the value to 1 for the first row and increments the
value by 1 for each additional row.
Mass Update ID and Select the mass update definitions that you want to include in the report. The
Description system displays the description of the selected definitions.
Mass Update Status The system displays the status of the selected mass update definitions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 649
Setting Up and Processing Mass Updates Chapter 26
Transaction Details MU_MANAGE_DETAIL_S Click the Details button for Review details of the mass
a row on the Manage Mass update transactions. This
Updates page. page includes high-level
details of the transaction as
well as information about
population selection criteria,
changes, eligibility,
messages, and exceptions.
650 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Running Instances
Use this group box to view details of the current running instances for mass update processing.
Process Instance Displays the process instance number for the corresponding instance.
Mass Update ID The mass update definition that the instance is processing.
Pending Transactions The number of mass update transactions that are assigned to the process instance
but not yet processed.
Processed Transactions The number of mass update transactions that have been processed by the process
instances. This includes processed transactions with errors.
Search Criteria
Use this group box to specify search criteria for retrieving mass update transactions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 651
Setting Up and Processing Mass Updates Chapter 26
Mass Update ID Select a mass update definition to narrow your search to only mass update
transactions within that definition.
Section Select a section to narrow your search to only mass update transactions that
involve that section.
Element Select an element to narrow your search to only mass update transactions that
involve that element.
Empl ID (employee ID) Select an employee to narrow your search to only mass update transactions that
involve that employee.
Transaction Status Select a transaction status to narrow your search to only the mass update
transactions with that status.
Search Click to retrieve a list of the mass update transactions that meet your search
criteria. The system displays your search results in the Mass Update Transactions
grid.
Use this group box to view statistics that are related to the mass update transactions in your search results.
The system displays a list of the mass update definitions in your search results, the status of each definition,
and the transaction count for each definition.
Mass Update The system displays the ID for each of the mass update definitions that meet your
search criteria with a separate row for each employee who has a transaction
based on the definition. Click the ID to access the Define Mass Update
component, where you can review the details of the mass update definition.
Person ID The system displays the ID of the person that is involved in each of the mass
update transactions that meet your search criteria. Click the Person ID link on a
row to access the Personal Data component, where you can review the personal
data record for the individual.
Note. This link provides access to personal information, but the mass update
transaction itself might not relate to personal data.
Empl Record (employee The system displays the employee record number of the person that is involved
record number) in each of the mass update transactions that meet your search criteria. Click the
employee record number link on a row to access the Job Data component, where
you can review the person's job data record.
Note. This link provides access to job data, but the mass update transaction itself
might not relate to job data.
652 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Name The system displays the name of the person that is involved in each of the mass
update transactions that meet your search criteria. Click the name link on a row
to access the personal data for the individual.
Transaction Status The system displays the status of each mass update transaction. Possible values
are:
Cancel: A user has canceled the mass update transaction.
You can change this status to Cancel to cancel the transaction. Note however
that this action is irreversible after it has been processed.
Ready: The transaction has been created during the selection phase and is
ready to be processed.
You can change this status to Cancel to cancel the transaction. Note however
that this action is irreversible after it has been processed.
Success: The Mass Update process has successfully processed the transaction
and performed the update.
Warning: The transaction has been created during the selection phase and is
ready to be processed. However, a conflict occurred during transaction
creation. For the shown employee record number, the employee is eligible for
more than one additional population. The system has assigned the employee
to the latest population.
You can change this status to Cancel to cancel the transaction. Note,
however, that this action is irreversible after it has been processed.
When you change transaction statuses and save the page, the system updates the
status of the mass update definition accordingly. If all transactions for a mass
update definition have a status of Cancel or Success and no transactions have a
status of Ready, Warning or Failure, then the system changes the status of the
mass update definition to Closed. The Mass Update process processes only
transactions with a status of Ready or Failure. It does not process transactions
with any other status.
Details Click to access the Transaction Details page, where you can view details of the
mass update transaction and its execution log.
Execute Click this button for a row to process the corresponding mass update transaction
online individually. You can process only transactions with a status of Ready or
Failure. The system triggers the Transaction Processor to process the transaction.
The Transaction Processor then updates the statuses of the transaction and the
mass update definition. Note that processing individual transactions online is
especially useful for troubleshooting.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 653
Setting Up and Processing Mass Updates Chapter 26
Review the population selection criteria that the system used when generating the mass update transaction.
This includes criteria for common changes and additional changes.
Eligibility
Review the date range for which the transaction is eligible for the mass update.
654 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Review the messages and exceptions that the Transaction Processor generated for the mass update transaction
during processing. The system displays in sequence the date and time of the last update in which the
Transaction Processor generated the message or exception, the severity, and the description.
The Mass Update process (HR_MASS_UPD) uses the services that are related to the data that is slated for
update (that is, for job data, it uses the JOB_DATA component) and retrieves the data for each person in the
group. It then assigns the new values for the people and saves the change, triggering any business rules that
apply to this component. It also creates an execution result record to trace the statuses of all modifications for
all people.
To run the Mass Update process, use the Execute Mass Updates run control page to specify one or more Mass
Update definitions for which you want to process mass updates in batch and the sequence in which you want
the Mass Update process to handle transactions for these definitions. You also can define parallel processing
parameters. Parallel processing enables you to run instances of the Mass Update process in parallel to
improve performance.
When you run the Mass Update process (which is triggered by the Mass Update Manager), it calls the
Transaction Processor for the set of transactions to process (transactions in pending status). The Mass Update
process monitors the queue of mass update transactions that are pending processing and a list of running
instances until no more transactions are in the queue or until the process reaches the maximum parallel
processing values that you define on the run control page.
When you run the process with parallel processing, the Mass Update Manager activates the Execution
Manager by means of the Mass Update Execution AE process (HR_MASS_EXE) and uses the parallel
processing parameters that you specify on the run control page. The Mass Update Execution process first
creates an instance (which is called spawning). The process then assigns a chunk of transactions to that
instance based on the value that you specify in the Transactions per Instance field and submits that instance to
PeopleTools Process Scheduler for processing. As long as the instance number is less than or equal to the
value that you specify in the Maximum of Instances field, the process spawns another instance. The process
repeats these steps until it reaches the maximum allowable number of instances. The Mass Update Execution
process is a child process of the Mass Update process.
Note. PeopleTools provides load balancing options on the Server Definition page, navigation PeopleTools,
Process Scheduler, Servers, Service Definition.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 655
Setting Up and Processing Mass Updates Chapter 26
Execute Mass Updates RUNCTL_MU Workforce Administration, Run the Mass Update
Collective Processes, Mass process.
Update, Execute Mass
Updates, Execute Mass
Updates
Mass Updates
Use this group box to select the mass update definitions for which you want to process the mass update
transactions.
Seq(sequence) Indicates the order in which the process performs the mass update. By default,
the system sets the first row to 1 and automatically increments by 1 for each
additional row.
Mass Update ID and Select the mass update definitions that you want to include in the processing.
Description You can select only from the mass update definitions that are initiated or in
progress. The system displays the description of the selected mass update
definition.
656 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 26 Setting Up and Processing Mass Updates
Mass Update Status The system displays the status of the mass update definition.
Parallel Processing
Use this group box to specify parameters for parallel processing of mass update execution instances. Note that
to improve performance, you can run Mass Update processes in parallel on different hardware with no
additional configuration required.
Run Instances in Select to enable the process to run instances in parallel. The process uses the
Parallel Execution Manager to generate and monitor subprocesses (called process
instances) that run in parallel on the PeopleTools Process Scheduler.
Deselect this check box to run the process on a single instance on PeopleTools
Process Scheduler. The process in this case commits mass updates to the
database after each transaction without intervals.
Maximum of Instances Enter the maximum number of instances that the process can generate and run in
parallel. This option is available only when you have selected to run instances in
parallel.
Transactions per Enter the maximum number of transactions that the process can process per
Instance instance before creating a new instance. This option is available only when you
have selected to run instances in parallel.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 657
Setting Up and Processing Mass Updates Chapter 26
The Mass Update Manager triggers the Mass Update Delete Application Engine (AE) process
(HR_MASS_DEL) to perform the transaction deletion. The Mass Update Delete process deletes the pending
mass update transactions that you have generated through the Create Mass Updates component for the
selected mass update definitions. The process also performs the necessary cleanup of the system tables.
Mass Updates
Use this group box to specify the mass update definitions for which you want to delete mass update
transactions.
Seq(sequence) Specify the order in which you want the process to delete mass update
transactions. By default, the system sets the first row to 1 and automatically
increments by 1 each additional row.
Mass Update ID and Select the mass update definition that contains the mass update transactions that
Description you want to delete. The system displays the name of the mass update definition.
You can select only from mass update definitions that are initiated or in progress.
Mass Update Status The system displays the status of the mass update definition.
658 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27
Administer approvals.
Understanding Approvals
Many daily tasks are part of a larger process that involves several steps and people working together, such as
the approval of a promotion. To facilitate this type of multiuser process, PeopleSoft Enterprise provides
approvals functionality, which enables you to automatically trigger workflow notifications to inform the next
approver in the process of pending transactions.
Many PeopleSoft applications are delivered with predefined approval processes. However, this chapter
provides the PeopleSoft Enterprise HRMS product line specifics of the Approval Framework functionality.
While this document lists the HRMS navigation and additional topics specific to setting up HRMS Approval
Framework, more detailed overviews and field descriptions are documented in the companion documentation
PeopleSoft Enterprise Human Resources PeopleBook: Approval Framework.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 659
Setting Up and Working with Approvals Chapter 27
See Also
Approval Framework
Approvals Terminology
The following terms are important to the understanding of the approvals functionality and are used
throughout the chapter:
Approval Process A generic term referencing the business process of how a particular transaction is
routed for approval within an organization.
Approval Framework Engine that provides capabilities for the creation, execution, and management of
approval processes.
Approval Process The definition of an approval process within the Approval Framework. The
Definition definition may contain stages, paths, steps, varying hierarchies, and criteria,
among other configurable parameters.
Approval Process The ID associated with a particular approval process definition in the Approval
Definition ID (Process Framework. Each transaction registered with the Approval Framework must have
ID) at least one process ID defined.
Request A transaction that uses the Approval Framework for approval processing. For
example, a promotion, transfer time off request, job requisition, and so on.
Approval Step or Step A step has one or more approvers, whose actions are tracked. A step can be
configured to require a set number of approvers to act, and has criteria which
govern whether or not the step is to be active for the request under consideration.
Steps are sequential.
Approval Path or Path A path is a sequence of steps. For example, step two routes to its approvers only
after step one is approved. A given approval could actually go through multiple
approval paths based on some decisions. Paths can be mutually exclusive or
parallel. They all converge at the final approval.
Approval Stage or Stage A stage is a collection of approval paths. Approval stages come in a single
sequence (stage 1, stage 2, and so on). An approval stage runs when it's
immediately preceding stage finishes. When an approval stage runs, all the
approval paths within it run simultaneously. The approval stage is considered
complete when all approval paths within it have finished.
Approver The person who has been determined to have the authority to approve (deny,
pushback, and so on) a request.
660 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Requester and The requester is the person for whom you want the Approval Framework to treat
Originator as the initiator of a request. In most cases the requester and originator are the
same person. However, when using the Delegation feature the requester and
originator of a request can vary. For example, if a manger delegates a transaction
to a direct report and that direct report submits the transaction, the direct report is
the originator and the manager is the requester.
Subject The person for whom a transaction is being processed. For example, Karen
submits to her boss, Russell, a promotion request for one of her employees,
Robbin. Karen is the requester (originator), Robbin is the subject, and Russell is
the approver.
Supervisor or Manager The person who has management responsibilities for the requester or for an
approver, as defined in your direct report settings during implementation.
Status or Approval Statuses typically represent the overall state a transaction is in, such as pending,
Status on hold, approved, denied, terminated, and so on.
Approval Criteria Rules used to decide whether or not approval is required. Approval criteria fields
and dimensions are data elements and attributes that are used to define the
approval criteria.
Approval Hierarchy The organizational hierarchy that models the actual approvals required by a
transaction type (for example, approval hierarchy by supervisor or department).
User List Collection of users (PeopleSoft Operator IDs) expressed as the result of an SQL
statement, PeopleSoft role, or PeopleSoft Application Class.
Alternate Approver or A user can have another user in the system as his or her alternate approver for a
Alternate User ID specified period of time. This is set on the Workflow page of the User Profile
component within PeopleTools security.
Approval Framework
The Approval Framework is the engine that provides the framework and capabilities for creating, running,
and managing approval processes. The engine uses a series of database objects combined with application
component configuration settings to determine how to process approvals using workflow.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 661
Setting Up and Working with Approvals Chapter 27
Approval workflows are triggered when requesters submit a transaction, such as a promotion. The application
hands the transaction over to the Approval Framework, which finds the appropriate approval process
definition and launches the approval workflow. A set of approvers then carry out tasks related to the
transaction.
The Approval Framework enables three levels of users to develop, configure, and use transaction approvals
that meet their organizational requirements. For example, the process of submitting a promotion and getting it
approved requires defining who will approve the promotion, the order in which they will approve it, and how
it will be routed to approvers.
In contrast to the standard PeopleSoft workflow, which requires advanced technical skills in PeopleSoft
PeopleTools to create and maintain, approval workflow provides an alternative workflow that is much easier
to create, configure, and maintain. For example, all of the steps in approval workflow are defined using
PeopleSoft pages rather than underlying PeopleSoft PeopleCode, so functional users can design and maintain
workflow using these online PeopleSoft pages instead of requiring technical developers to create workflow
rules.
See Also
Application developers register information with the Approval Framework by using the Register
Transactions page, where they register an application with the engine and describe its components, event
handler, and records.
As part of defining the registry, application developers create a record and table in which to store cross-
reference information and set up notification templates for events. This definition determines the pending
approval workflow process and tells an application which transaction is being approved or denied.
Application developers also link the transaction component.
Note.
PeopleSoft Enterprise Human Resources delivers many transactions that are registered with the Approval
Framework. Do not modify these transaction registry definitions because the system requires their setup
to be as delivered. For a complete list of delivered transaction registry definitions, access the Register
Transactions component by navigating to Set Up HRMS, Common Definitions, Approvals, Approvals
Setup Center, Register Transactions.
Functional business analysts define the approval process definition for an application transaction.
The approval process definition includes setting up approval stages, paths, steps, recipients, and
notifications for each approval process ID. Analysts identify the approval transaction registry entry on
which to base approval process definitions and then define the details of the process.
Functional business analysts also define or review user list definitions, email template definitions, and
transaction configuration settings.
After completing the setup, functional business analysts are responsible for maintaining and
troubleshooting approval process transactions.
662 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
This action launches the approval process. The Approval Framework reads the approval process definition
and queues the transaction for approvers.
The system queues an approval task to an approver or reviewer using email notification, Worklist entry,
or both.
The URL encoded in the Worklist entry points to the corresponding approval component.
They can approve or deny requests, monitor transaction statuses, and audit approvals. When an error or
violation of criteria or rules occurs during the approval process, the system notifies the approvals
administrator, who interacts to resolve the issue.
This diagram details the business process flow of implementing and using approvals functionality. It shows
tasks that application developers, business analysts, and end users perform in conjunction with approval
workflow.
See Also
Approval Framework, "Understanding the Approval Framework," Understanding the Approval Framework
Process Flow
Approval Framework, "Understanding the Approval Framework," Understanding Header- and Line-Level
Approvals
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 663
Setting Up and Working with Approvals Chapter 27
Sources of Information
The Approval Framework is a common component that is shared across multiple PeopleSoft Enterprise
applications both within HRMS and other product families. For the HRMS product family, you'll find
documentation pertaining to the Approval Framework in various locations:
This present chapter lists the Approval Framework functionality that applies to the setup steps, navigation
paths, and details that are specific to the HRMS product family.
The PeopleSoft Enterprise Human Resources PeopleBook: Approval Framework describes the common
Approval Framework functionality that applies to all product families.
Before implementing, you should read all relevant sources of information to gain a complete understanding of
how the pieces fit together.
To review delivered HRMS transactions for use with the Approval Framework:
1. Register the approval transaction in the Approval Framework through the Register Transactions page.
See Chapter 27, "Setting Up and Working with Approvals," Registering Approval Transactions, page 666.
2. Link Human Resources self-service transactions to the Approval Framework through the Workflow
Transactions page.
See Chapter 27, "Setting Up and Working with Approvals," Linking Workflow Transactions, page 669.
3. Set up the configuration options for the approval transaction on the Configure Transactions page.
See Chapter 27, "Setting Up and Working with Approvals," Configuring Approval Transactions, page 674
.
664 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
4. Set up the approval process definition through the Setup Process Definitions component.
See Chapter 27, "Setting Up and Working with Approvals," Setting Up Approval Process Definitions,
page 676.
a. Define the stages, paths, and steps of the approval process definitions on the Setup Process Definitions
page.
b. Define criteria for workflow approval processes at the definition, path, and step level on the Criteria
Definition page, which is accessed through links on the Setup Process Definitions page.
c. Set up path details for workflow approval processes on the Approval Path Definition page.
d. Define step details for approval workflow processes on the Approval Step Definition page.
See Chapter 27, "Setting Up and Working with Approvals," Defining Dynamic Approvals, page 683.
5. Create email templates for the approval transaction on the Generic Template Definition page.
See Chapter 27, "Setting Up and Working with Approvals," Defining Notification Templates for
Approvals, page 686.
6. Maintain user list definitions for the approval transaction on the User List Definition page.
See Chapter 27, "Setting Up and Working with Approvals," Defining Users for Approvals, page 687.
See Chapter 27, "Setting Up and Working with Approvals," Setting Up the Notification and Escalation
Manager, page 690.
8. Set up the appropriate permission lists, roles, and web libraries through PeopleTools security components.
See Chapter 27, "Setting Up and Working with Approvals," Setting Up Security for Approvals, page 692.
If you need to implement other transactions for use with the Approval Framework besides the delivered
transactions, you must complete additional implementation steps. These steps include those involving object
construction within PeopleTools Application Designer and those involving setup within application pages.
For technical details on how to implement additional approval transactions, see the PeopleSoft Enterprise
Human Resources PeopleBook: Approval Framework
Note. In addition to the PeopleSoft Enterprise HRMS custom navigation pages, the PeopleSoft application
provides menu navigation and standard navigation pages.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 665
Setting Up and Working with Approvals Chapter 27
This section discusses how to use the custom navigation pages to navigate in the components for approvals
functionality.
See Also
Approvals Setup Center Set Up HRMS, Common Definitions, Approval administrators and
Approvals, Approvals Setup Center implementers can use the links on this
page to access the components
necessary to register and set up
transactions for the Approval
Framework for PeopleSoft Enterprise
HRMS.
Approvals and Delegation Workforce Administration, Self Approval administrators can use the
Service Transactions, Approvals and links on this page to access the
Delegation components necessary to monitor and
troubleshoot approval transactions
and to maintain delegation and for
PeopleSoft Enterprise HRMS.
This section provides an overview of the approval transaction registry, lists prerequisites, and lists the page
used to register approval transactions.
666 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
PeopleSoft Enterprise HRMS delivers several approval transaction process identifiers that are common across
applications for use with the Approval Framework. The system uses these process IDs specifically for
registering delegation-related transactions with the Approval Framework so that the approval framework,
which handles the requests, can communicate back and forth with the delegations framework.
When registering approval transactions with the Approval Framework on the Register Transactions page, you
must specify a header record for the approval transaction. When you are configuring these process IDs in the
Configure Transactions component, you can use this header record and any of the listed fields to define
additional criteria for the processing of the approval transaction. You define this additional criteria on the
Criteria Definition page, which is accessible through the Configure Transactions component. Fields not listed
on the Register Transactions component are not available for the criteria definition.
This table lists the approval transaction process IDs that PeopleSoft Enterprise HRMS applications deliver:
Process ID Description
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 667
Setting Up and Working with Approvals Chapter 27
Process ID Description
Note. Refer to the corresponding documentation in your application-specific PeopleBooks for information
about delivered approval transaction process IDs that are specific to an application.
Note. Any PeopleSoft delivered approvals will already have the Approval Transaction Registry populated.
No additional configuration is typically needed.
Prerequisites
Before registering approval transactions, you must create all of the required objects in PeopleTools
Application Designer.
Create a Transaction Handler Application class that extends an approved event handler class delivered by
approval workflow.
Create notification templates for the events, which include approval and denial for header and line levels.
668 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
See Also
Chapter 27, "Setting Up and Working with Approvals," Implementation of HRMS Transactions for Approval
Framework, page 664
See Also
This section lists the page used to link workflow transactions and discusses how to link workflow
transactions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 669
Setting Up and Working with Approvals Chapter 27
670 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
The Workflow Transactions grid and the Approval Workflow Engine (AWE) and Delegation Transactions
grid are mutually exclusive. You cannot register the same transaction in both grids. If attempted, the system
displays an error, and you must delete one of your entries before saving the page.
Workflow Transactions
Use the Workflow Transactions grid to register self-service transactions that use existing workflow
configuration from a previous release. For example, if the self-service transaction is currently configured to
update core records upon final approval via a component interface, you can list the transaction the Workflow
Transactions grid so that you can still leverage these configuration values.
Transaction Name Enter the name of the self-service transaction in either one grid or the other, not
both.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 671
Setting Up and Working with Approvals Chapter 27
Delegation Initiation Select to enable delegation of transaction initiation for the corresponding self-
service transaction that uses existing approvals configuration from a previous
release. The transaction then becomes available for configuration as an initiate-
type delegation transaction. Configure delegation transactions on the Configure
Delegation Transaction page.
See Chapter 28, "Setting Up and Working with Delegation," Configuring
Delegation Transactions, page 722.
Use the Approval Workflow Engine (AWE) and Delegation Transactions grid to register self-service
transactions that use the Approval and Delegation framework. The data that you enter into this grid links the
transaction name and accompanying tables for HRMS self-service transactions to the approval process IDs
that you create for these transactions on the Register Transactions page as part of the Approval Framework
setup.
Note. You can only list a particular transaction once. You cannot assign the same Approval Framework
transaction to multiple HR_TRANSACTIONS because this violates Delegation processing requirements.
Workflow Transactions page (Approval Workflow Engine (AWE) and Delegation Transactions grid: Details1
tab)
672 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Workflow Transactions page (Approval Workflow Engine (AWE) and Delegation Transactions grid: Details2
tab)
Transaction Name Enter the name of the self-service transaction in either one grid or the other, not
both.
Approval Process ID When implementing the Approval Framework, you define a unique transaction
registry ID, called a process ID, for each of your HRMS self-service transactions
on the Register Transactions page. Select the approval process ID that you have
defined for this self-service transaction. By creating this link between the self-
service transactions and the Approval Framework, the self-service transactions
can dynamically retrieve this approval process ID by transaction name and thus
invoke the Approval Framework. The Approval Framework requires this
parameter during processing.
Delegation Initiation Select to enable delegation of transaction initiation for the corresponding self-
service transaction that uses the Approval Framework. The transaction then
becomes available for configuration as an initiate-type delegation transaction.
Configure delegation transactions on the Configure Delegation Transaction page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 673
Setting Up and Working with Approvals Chapter 27
Delegate Approvals Select to enable delegation of transaction approval for the corresponding self-
service transaction. The transaction then becomes available for configuration as
an approval-type delegation transaction. This functionality is available only for
transactions that you register with the Approval Framework in the lower grid.
If you select both the Delegation Initiation and the Delegate Approvals check
boxes, you can configure the transaction for delegation of initiations and
approvals. Configure delegation transactions on the Configure Delegation
Transaction page.
See Also
674 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Configure Transactions EOAW_TXN_NOTIFY Set Up HRMS, Common Configure how the system
Definitions, Approvals, uses the particular
Approvals Setup Center, implementation of approval
Configure Transactions, triggers by configuring all
Configure Transactions the events and notifications
associated with your
approval process IDs.
For HRMS transactions, the
workflow engine requires
that you enter specific
values in the User Utilities
section to enable it to
interact with the Approval
Framework and
Delegations. In the User
Utilities Package field, you
must select the value
HCSC_USER_UTILITIES.
In the User Utilities Path
field, you must select the
value UserUtilities.
PeopleSoft Enterprise
HRMS delivers these
values.
See Also
Approval Framework, "Defining the Approval Transaction Registry," Configuring Approval Transactions
Chapter 27, "Setting Up and Working with Approvals," Defining Notification Templates for Approvals, page
686
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 675
Setting Up and Working with Approvals Chapter 27
Business analysts use this component to define an approval process definition. The process is made up of
stages and their paths and steps. The approval steps that you place on the approval path represent the approval
levels that are required for a transaction.
Use staged tracks, such as first receiving department approval and afterward receiving HR approval.
Two different approvers for each step, where both approvers at a step must approve the request for it to
advance to the next step.
This section list the pages used to set up approval process definitions and reviews an example of setting up
the HRMS approval process definition.
Setup Process Definitions EOAW_PRCS_MAIN Set Up HRMS, Common Define workflow approval
Definitions, Approvals, process stages.
Approvals Setup Center,
Setup Process Definitions,
Setup Process Definitions
676 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Approval Path Definition EOAW_PATH_SEC Click the Details link or Set up path details for
icon within the Paths group workflow approval
box on the Setup Process processes.
Definitions page.
Approval Step Definition EOAW_STEP_SEC Click the Details icon Define step details for
within the Steps group box workflow approval
on the Setup Process processes.
Definitions page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 677
Setting Up and Working with Approvals Chapter 27
Copy Approval Process EOAW_PRCS_COPY Click the Clone Approval Create a new approval
Process link on the Setup process definition by
Process Definitions page. copying the existing one.
The system requires that
you assign a new definition
ID and effective date.
Preview Approval EOAW_PRV_MON_SRC Click the Preview Approval Verify the routing of the
Process link on the Setup approval process definition
Process Definitions page. by previewing.
In this example, let's suppose that your company wants to create an approval process definition to handle the
approval of an employee's request for a day off.
678 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
1. First you must define the stages, paths, and steps of your approval process (Set Up HRMS, Common
Definitions, Approvals, Approvals Setup Center, Setup Process Definitions, Setup Process Definitions).
Notice in the example that the approval process contains one stage, one path, and two steps. The stage in
this example contains one approval path in the organization that requires two levels of supervisor
approval before the employee is granted the day off. First, the employee's supervisor must grant approval,
and then that supervisor's manager must approve the request.
You can define multiple stages, paths, and steps for an approval process definition. For example, perhaps
you require administrator approval of the employee's day-off request. In this case, you would create an
additional path within the existing stage that contains one step requiring administrator approval.
The Approval Framework processes multiple stages and steps sequentially. The engine cannot advance to
the next step until you complete the preceding step in the given path. Likewise, the engine cannot advance
to the next stage until you complete all paths within a given stage. For paths, however, you can define
them as static (processed sequential) or dynamic (processed in parallel).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 679
Setting Up and Working with Approvals Chapter 27
2. Now you will add logic that the Approval Framework evaluates at runtime for a Boolean result. You can
define criteria at the definition, path, or step level. For this example, you want to add logic to the
definition level that instructs the Approval Framework to stop processing if it encounters an absence
request that is missing the employee ID value. To set up this criteria, click the Definition Criteria link at
the top of the Setup Process Definitions page.
This activates fields on the page that enable you to manually define your criteria.
c. Use the Field Criteria group box to specify the necessary logic. In the Record field, select the header
record for this transaction. You define header records for transactions on the Register Transactions
page. In this instance, the process ID of the transaction is AbsenceManagement, which has a defined
header record of GP_ABS_SS_DAT. Now choose between any of the fields that are defined within that
header record for the process ID.
In this example, EMPLID is selected. To complete the logic, select in the Criteria Operator field, the
Is Not Blank value.
680 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
The logic in this criteria definition states that when processing a request for time off, the Approval
Framework uses this definition ID to process any transaction related to the AbsenceManagement
approval process ID that contains employee ID as part of the transaction. If the transaction does not
contain an employee ID value, the Approval Framework continues to search for another definition ID
that matches the required criteria needed to process the transaction for the related approval process ID.
3. Next you want to require the Approval Framework to advance the approval to the next approver in the
path if the current approver doesn't respond within three days. Click the Details link in the Paths group
box to access the Approval Path Definition page.
You can use the Timeout Options group box to define what should happen to a particular transaction or
request after a certain period of time. For instance, you can notify the participant, advance the approval, or
reassign the approval after a certain number of hours or days have passed. You can have the request
reassigned to a particular person in the database or to a predefined user list.
To meet the needs of this example, set the Escalate Option field to Advance Approval, the Days field to 3,
and click OK.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 681
Setting Up and Working with Approvals Chapter 27
4. Now that you have defined the approval process definition, you can look at a graphic representation. Click
the Approval Process Viewer link at the top of the Setup Process Definitions page.
The Setup Process Definitions page enables you to view graphically your approval process definition and,
if necessary, quickly modify the definition. Click the plus signs, minus signs, or correction buttons. For
example, perhaps you have decided that it is best that there is a third approval step for an absence request.
Click the plus sign after step 2.
682 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
The system returns you to the Setup Process Definitions page and inserts a new row after step 2 for you to
enter the new step. Click Save when you have completed your definition.
This section provides an overview of how to configure dynamic approval authorizations and lists the pages
used to define dynamic approvals.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 683
Setting Up and Working with Approvals Chapter 27
1. Define user lists for dynamic authorizations through the User List Definition page.
The Approval Framework delivers user lists that address the most common approval scenario of routing
an approval to a supervisor. If the requester is an end user, his immediate supervisor cannot authorize
more than 5,000.00 USD, and the job requisition is for 6,000.00 USD, then the requisition moves to the
next level supervisor. The user ID for the direct supervisor is listed on the user profile.
Note. To enable the Supervisor by User ID approval routing, you must have a supervisor assigned to your
user ID for the job.
2. Create an approval authorization by authorizing roles and approvers for dynamic paths through the
Approval Authorization page.
The Approval Authorization page is available through PeopleTools but must be added to the portal
navigation to render it available in the application. To add this page to portal navigation, navigate to
PeopleTools, Portal, Structure and Content. On the displaying page, click Set Up HRMS, then Common
Definitions, then Approvals, and then the Edit link for the Authorize option. Deselect the Hide from portal
navigation check box, and click Save. Then navigate to PeopleTools, Portal, Portal Security Sync and run
the portal security sync process so that the portal cache recognizes the changes.
If you don't specify a definition ID, the authorization is generic. To create an approval authorization for
specific definition IDs, you must add a line for each definition ID.
Note. If you activate self-approval on the Approval Authorization page, it replaces the self-approval on
static path steps.
3. Define a dynamic approval path through the Approval Path Definition page.
Note. When creating criteria within the path that will trigger the workflow engine to activate, be certain
that you set up the final approver as Greater Than so that no gaps occur.
a. Select Dynamic for a dynamic approval path in the Step Source field.
b. Select the Notify Admin on No Approvers check box to indicate that the approvals administrator is to
be notified if the system does not find an approver for the path. This option is only available when the
Step Source is Dynamic.
c. Select the Skip Prior Steps for Requester check box to indicate that if one of the approvers in this path
is also the requester, then the system is to skip all steps in the path prior to that approver's step.
d. Select the Check Authorization check box to enable the approval authorization.
e. Select the Skip Unauthorized Users check box to enable the approval process to skip users within the
user list if the system determines that they can't satisfy all of the criteria for approval.
For more information and an example of dynamic approvals see PeopleSoft Enterprise Human Resources
PeopleBook: Approval Framework, "Defining Dynamic Approvals."
684 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Setup Process Definitions EOAW_PRCS_MAIN Set Up HRMS, Common Define workflow approval
Definitions, Approvals, process stages.
Approvals Setup Center,
See Chapter 27, "Setting Up
Setup Process Definitions,
and Working with
Setup Process Definitions
Approvals," Setting Up
Approval Process
Definitions, page 676.
Approval Path Definition EOAW_PATH_SEC Click the Details link within Set up workflow approval
the Paths group box on the path details.
Setup Process Definitions
See Chapter 27, "Setting Up
page.
and Working with
Approvals," Defining
Dynamic Approvals, page
683.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 685
Setting Up and Working with Approvals Chapter 27
Approval Step Definition EOAW_STEP_SEC Click the Details icon Define step details for
within the Steps group box approval workflow.
on the Setup Process
See Chapter 27, "Setting Up
Definitions page.
and Working with
Approvals," Administering
Approvals, page 694.
User List Definition EOAW_USER_LIST Set Up HRMS, Common Create and maintain user-
Definitions, Approvals, list definitions used for
Approvals Setup Center, routing transactions for
Maintain User Lists, User approval. Also, define user
List Definition sources for use with steps in
the approval process.
See Chapter 27, "Setting Up
and Working with
Approvals," Defining Users
for Approvals, page 687.
User Profile - General USER_GENERAL PeopleTools, Security, User Set up user IDs and assign
Profiles, User Profiles, roles.
General
See Enterprise PeopleTools
PeopleBook: Security
Administration
This section provides an overview of generic template definitions and list the pages used to define notification
template definitions.
If you are using bind variables (%1, %2, %3 and so on) in your email notification template, you must also
create an SQL object through PeopleTools Application Designer. The Approval Framework uses this SQL
object to populate the bind variables that you define in your notification template. You assign an SQL object
to an email notification through the SQL Object identifier fields on the Configure Transactions page.
686 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
The Approval Framework reserves the %1 bind variable as a placeholder for an auto-generated link within the
email notification to an application component. If you do not want to display the auto-generated link in your
email notification, exclude the %1 bind from the template variables that you list on the Generic Template
Definition page.
See Also
Approval Framework, "Defining Notification Templates and Users for Approval Framework"
Chapter 28, "Setting Up and Working with Delegation," Reviewing Delivered Notification Templates for
Delegation, page 749
This section provides an overview of user lists within Approvals and lists the pages used to define users for
approvals.
PeopleSoft Enterprise HRMS delivers the following common user lists for use with the Approval Framework:
By Department Manager Uses the Manager ID field from the Department Profile
page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 687
Setting Up and Working with Approvals Chapter 27
By Partial Pos Mgmt - Dept Mgr Uses the Reports To field from the Job Information page
and then the Manager ID field for that position and
department from the Department Profile page.
By Partial Pos Mgmt - Suprvsor Uses the Reports To field from the Job Information page
and then the Supervisor ID field for that position from the
same page.
By Position Management Uses the Reports To field from the Job Information page.
Note. Refer to the corresponding documentation in your application-specific PeopleBooks for information
about delivered user lists that are specific to an application.
PeopleSoft Enterprise HRMS delivers a series of user lists, or approval hierarchies, based on application class
that is designed specifically for receiving and passing employee job information. These user lists correspond
to the roles within an organization and enable you to select which job the Approval Framework uses to route
approvals for employees with multiple jobs.
If an employee with multiple jobs encounters a job-related transaction during self-service approvals
processing, the system prompts the employee to select the job for which she or he wants to process the
transaction. For multiple job capability, the delivered user lists use an Application Class as the source for the
user list, with the value of the Root Package ID field set to HCSC_USERLIST_UTILS and one of the
following delivered Application Class Path values:
HCSC_USERLISTS:GetApproversBySupervisorId By Supervisor ID
The delivered user lists correspond with different access types that PeopleSoft Enterprise Human Resources
delivers with direct reports functionality. The system uses each of these delivered user lists in correspondence
with how you define your direct report structure (by supervisor, by department, and so on).
If you define a custom user list and want multiple job capability, then you must use these same application
root package ID and application class path values. PeopleSoft Enterprise HRMS supports multiple job
capability only in the predefined user lists that we deliver.
688 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Note. PeopleSoft Enterprise HRMS does not support multiple job capability for these custom user lists.
See Also
User Profiles - Roles USER_ROLES PeopleTools, Security, User Attach workflow roles to
Profiles, User Profiles, users. A role is a class of
Roles users who perform the same
type of work, such as clerks,
buyers, or managers. A role
describes how people fit
into workflow.
Role user IDs determine
how to route Worklist items
to users and how to track
the roles that users play in
the workflow.
User Profiles - Workflow USER_WORKFLOW PeopleTool, Security, User Define workflow for user
Profiles, User Profiles, profiles. Use this page to
Workflow define alternate users who
are part of the workflow
process. You can define
alternate users to handle
approvals during the
absence of the primary
approver and supervisor.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 689
Setting Up and Working with Approvals Chapter 27
User List Definition EOAW_USER_LIST Set Up HRMS, Common Create and maintain user-
Definitions, Approvals, list definitions used for
Approvals Setup Center, routing transactions for
Maintain User Lists, User approval. Also, define user
List Definition sources for use with steps in
the approval process.
This section provides an overview of notification and escalation, list the pages used to set up the Notification
and Escalation manager, and discusses how to view event statuses.
For example, escalations are used when an approver has not responded within a specified time period to a
transaction that is pending approval. You can specify the time period (timeout) and you can specify alternate
approvers to whom to notify and escalate the approval for further action. Timeout options are defined on the
Approval Path Definition page.
690 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Define Event Types EOAW_NEM_EVENTS Set Up HRMS, Common Associate events to a server.
Definitions, Approvals,
See Approval Framework,
Notification and Escalation,
"Using the Notification and
Define Event Types, Define
Escalation Manager,"
Event Types
Associating Events to a
Server.
Event Status EOAW_NEM_STATUS Set Up HRMS, Common View the status of an event.
Definitions, Approvals,
Notification and Escalation,
Event Status, Event Status
Schedule JobSet Definition SCHDLDEFN PeopleTools, Process Set up a NEM to define the
Scheduler, Schedule JobSet job to run, and how often
Definitions, Schedule you want it to run.
JobSet Definition
See Approval Framework,
"Using the Notification and
Escalation Manager,"
Setting Up a NEM.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 691
Setting Up and Working with Approvals Chapter 27
This Event Click to delete all notification event logs for the event ID that you selected.
All Events Click to delete all notification event logs for all events.
Notification Manager
DateTime Stamp Used in the Status record to track the results of each instance run.
Matches Displays the number of rows that are returned from a row set.
This table describes the delivered permission lists for the approval framework:
692 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
PeopleSoft Enterprise HRMS delivers the AWE Administrator role. This role already has the
HCCPSCAW1010 permission list assigned to it. However, this role is not attached to any users as delivered.
If you do not have an application-specific administrator role, then you can use this role by attaching it to any
application-specific administrator users that you have. If you do have an application-specific administrator
roles within your organization, then PeopleSoft recommends that you simply attach the HCCPSCAW1010
permission list to that role.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 693
Setting Up and Working with Approvals Chapter 27
To enable users to view additional information about Approval Framework participants through the approvals
status monitor, you must assign users the correct permissions. Because of the manner in which the system
displays the approvals status monitor, you must also grant access to the WEBLIB_PTAF web library for the
appropriate product permission lists. Also, for users to be able to use the EMC functionality that is part of the
Approval Framework, you must grant permission lists full access to the WEBLIB_EOAW web library.
PeopleSoft Enterprise HRMS delivers these two web libraries as part of the delivered Approval Framework
permission lists.
2. Select the permission list for which you want to grant access to web libraries.
3. On the Web Libraries page, insert a new row for the web libraries WEBLIB_PTAF and
WEBLIB_EOAW.
5. Click the Full Access (All) button to grant access to all functions, or complete the Access Permissions
field to grant access to specific script functions.
6. Click OK.
Note. The Approval Framework assumes each person in the system has one valid operator ID. If you are
using the approval process and allow your employees to have more than one operator ID, make sure they
have the same roles and permission lists.
See Also
Administering Approvals
The approval monitor gives administrators a view into all approvals to which they have access, as well as the
ability to take necessary actions on pending approvals.
This section provides overviews of approvals administration and discusses how to administer approvals.
See Also
Chapter 34, "Setting Up and Working with Self-Service Transactions," (USF) Reviewing Federal Self-
Service Transactions, page 841
694 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Approve Allows the approvals administrator to act on behalf of the assigned approver. The
approval is initiated for a specific user, wherever that user may be pending within
a specific transaction. Once the administrator takes action, the approval resumes
the approval process.
Denial Allows the approvals administrator to act on behalf of the assigned approver. The
denial is initiated for a specific user, wherever that user may be pending within a
specific transaction.
When a request is approved, the engine notifies the application, which then takes source end actions:
End actions.
An approval of one transaction often leads to the creation of another transaction, or triggers another
business process. The Approval Framework supports this trigger by providing a call-back mechanism for
event notification. For example, when a promotion is approved, it can be sourcedan action follows final
approval, which is the end action.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 695
Setting Up and Working with Approvals Chapter 27
Use line-level approvals to make it possible for an action to be taken on different line items upon their
approval, without waiting for the approval of other line items in the transaction. You can source line items
as soon as they are approved.
This action is possible only if line-level approval routings are at the end of the process and require no
further review. In this case, the application can act on the individual lines as they get approved. The
Approval Framework notifies the application of significant approval-related events.
Header actions allow the transaction lines to be grouped together and processed as one unit.
Approval Reassignment
You can reassign pending tasks to another approver, or an administrator can reassign all tasks that belong to a
specific approver to another approver. Use reassignment in the following situations:
The approver chooses to redirect the task to another approver, thus delegating a specific task (step) to
another approver.
The approvals administrator decides to reassign all pending tasks within a step that belong to an approver
to another approver.
This reassignment usually occurs when an approver is unexpectedly absent and the approvals
administrator reassigns all pending tasks to another.
When you redirect a workflow task to another approver, you can modify the approval process map.
Note. The Approval Framework is set up for administrative reassignment and escalations only.
Monitor Approvals EOAW_ADM_MON_ACT Click the link for the Approvals administrators
approval step in the can perform an action on a
Modified column on the specific approval process.
Monitor Approvals page.
See Also
696 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Administering Approvals
Access the Monitor Approvals page for a view of the approval process (Workforce Administration, Self-
Service Transactions, Approvals and Delegation, Administer Approvals, Monitor Approvals).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 697
Setting Up and Working with Approvals Chapter 27
For a complete description of this page, see PeopleSoft Enterprise Human Resources PeopleBook: Approval
Framework, "Using the Approval Monitor."
See Approval Framework, "Using the Approval Monitor," Using the Approval Monitor Search Page.
Administrative Actions
Approver's Oper ID Select the operator ID of the approval to whom the approval transaction is
(approver's operator ID) assigned.
Reassign To Select the operator ID of the person to whom you want to reassign approval
transactions for the specified approver in the Approver's Oper ID field.
698 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Allow Auto Approval Select to allow auto approval of approval transactions that are assigned to the
specified approver.
Allow Self-Approval Select to allow the specified approver to approve transactions on their own
behalf.
Comment Enter a comment to describe the mass reassignment. The comment becomes part
of the transaction itself.
Reassign Selected Click to reassign the approval transactions from approver in the Approver's Oper
ID field to the person specified in the Reassign To field. The system reassigns
only the approval transactions that you have selected in the search results.
Search Results
The system displays a unique section for each approval process that has approval transactions meeting your
search criteria. Each section contains key fields that are unique to the specific approval process. You can filter
your search results within a section by specifying key values and clicking the Filter button.
Select All Click to select all approval transactions that are listed in your search results.
Deselect All Click to clear the selection of all transactions in your search results.
Filter Specify key values and then click the Filter button to narrow your search results
within an approval process section.
Modified The system displays the date when the approval transaction was last modified. If
the approval transaction has never been modified, the system displays Never.
Status The system displays the status of the approval transaction: Pending,Denied,
Terminated, or Approved.
<Key Values> The system displays key values for each of the approval transactions that meet
your search criteria. Key values vary depending on the approval process.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 699
Setting Up and Working with Approvals Chapter 27
The Approvals Audit Report (AWEAUDIT) report includes the following data regarding approval transaction
requests as applicable:
Transaction number, which the Approval Framework automatically assigns to each approval transaction
request.
Approval process ID, which is defined during setup of the approval process.
Approval definition ID, which is defined during the setup of the approval process.
Enter data into one or more of the fields to filter your report results. If you leave a field blank, the report
process includes results for all possible values pertaining to that criterion. For example, if you specify the
range of dates for which requests were submitted as January 1, 2009 to December 31, 20096, and a specific
originating requester, then the system generates a report that includes all transactions requested by that person
for 2009, regardless of approval process ID and approval definition ID.
You can view the report online in PDF format, print the report, save it, or rerun the report using different
filtering criteria. You can also download the report to your local machine as a TXT, XLS, or CSV file. The
top of the report displays the date and time stamp of when it was generated and a summary of the filter data
selected. The report sorts the data by request submit date.
700 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Submitted After and Enter a date range for which you want to include approval transaction requests in
Submitted Before the audit report.
Approval Process ID Select an approval processes ID to filter your report results to a specific type of
approval transaction.
Approval Definition ID Select a specific approval process definition for which you want to filter your
report results.
Requested By Select a requester to filter your report results to approval transaction requests
submitted by a specific person.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 701
Setting Up and Working with Approvals Chapter 27
Transaction Status Select a status to filter your report results to approval transaction requests that
currently have the selected status.
Note. You can configure this report through the PeopleTools XML Publisher functionality.
702 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
Important! This section lists only the self-services pages for approval transactions that are common across
multiple applications within the HRMS product line. For details about self-service pages that are specific to
business processes within an application, refer to application-specific PeopleBooks.
Select Job HCM_JOB_SELECT The system displays this Users with multiple jobs
page when a user submits or can select the job for which
approves an request and the they want to submit or
user has multiple jobs. approve an approval
requests.
See Also
Chapter 28, "Setting Up and Working with Delegation," Working with Self-Service Delegation, page 733
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 703
Setting Up and Working with Approvals Chapter 27
Users can view the status and details of approval transaction requests that are pending their approval,
approved, denied, or terminated. The system displays the results in the grid. For each transaction in the grid,
users can click the View Details link or the Approve/Deny link to access pages where they can review details
of the transactions and take further action in the approval process.
Note. For archiving transactions that are stored in the Approval Framework, PeopleSoft recommends using
the PeopleTools Archive manager component.
704 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 27 Setting Up and Working with Approvals
If a user submits or approves a transaction and the user has multiple jobs, the user can select the job for which
to submit or approve the transaction so that the system can route the request to the appropriate people.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 705
Chapter 28
Administer delegations.
Understanding Delegation
Delegation is when a person authorizes another to serve as a his or her representative for a particular task of
responsibility. With the Delegation feature, users can authorize other users to perform managerial tasks on
their behalf by delegating authority to initiate or approve managerial transactions.
Delegation of authority to perform managerial transactions is usually prompted by one of these scenarios:
A manager takes leave and wants to delegate authority of managerial transactions to another person while
away from the office.
A senior executive does not have the time to process transactions and wants to delegate this authority to
another person, such as an assistant.
Delegation Terminology
The following terms are important to the understanding of Delegation feature and are used throughout the
chapter:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 707
Setting Up and Working with Delegation Chapter 28
Delegate Initiation The Delegation Framework allows you to separate the task of initiating a
transaction from approving the same transaction on someone's behalf. Delegator
may delegate authority for a proxy to only initiate or submit a transaction on the
delegator's behalf.
Delegate Approvals The Delegation framework allows you to separate the task of initiating a
transaction from approving the same transaction on someone's behalf. Delegator
may delegate authority for a proxy to only approve or deny a transaction on the
delegator's behalf.
Delegated Authority The rights and privileges that are delegated from the delegator to the proxy.
Delegation Request A request from the delegator to the proxy to take on delegated authority.
Delegation Period The time range in which the delegated authority is in effect.
Delegation The system administrator who is responsible for configuring, managing, and
Administrator maintaining delegated authorities.
Delegation Framework
The core of the Delegation feature is the Delegation framework. The Delegation framework manages a
proxy's authority over a delegated transaction. When a proxy has delegated authority, the Delegation
framework temporarily assigns the proxy a unique role that is specific to the delegated transaction. The role
enables the proxy to access the components and pages associated with the delegated transaction. When the
proxy no longer has delegated authority, the Delegation framework removes that role and thus prevents the
proxy from performing the transaction.
Downward delegation of authority to a direct report or another person lower down in the reporting
hierarchy.
Upward delegation of authority to a manager or another person higher up in the reporting hierarchy.
Lateral delegation of authority to a peer either within the same division or in a different division within
the reporting hierarchy
The Delegation framework integrates with the Approval Framework. This integration provides several
benefits. First, the integration between the Delegation framework and Approval Framework makes the
Approval Framework aware of delegated authorities in the system. Second, the Delegation framework uses
the Approval Framework to manage the acceptance and rejection of delegation requests.
708 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
The Delegation framework is a component of the PeopleSoft Enterprise HRMS self-service solution. Users
can create delegation requests for selected transactions through HCM self-services pages.
For example, an employee who is not a manager does not have access to manager self-service transactions
and, therefore, cannot delegate manager-specific transactions.
Delegate all transactions to a single proxy, or delegate different transactions to different proxies.
Delegation Administration
Delegation administrators can use the administrative components for delegation to perform several useful
tasks. They can:
Create delegation requests on behalf of delegators through the Add Delegation Request component
(HCDL_ADMIN_ADD_DLG).
Review delegation requests and, if necessary, revoke them on behalf of delegators through the Administer
Delegation component (HCDL_ADMIN_DLG).
Process all delegation transactions in batch daily through the Maintain Delegated Authorities component
(HCDL_BATCH).
Notifications
The system uses email and worklist notifications to notify managers and proxies of new delegation requests
and transactions pending approval. The system creates a worklist item only on the proxy's worklist, not on the
delegator's worklist (provided that you have set up worklist items as a preference for receiving notifications).
The system sends email notifications for approval to the proxy and, if approval framework is configured
correctly, the system also sends the delegator a courtesy email notification. Delegation administrators can use
the Generic Templates component to configure different email templates for the proxy and delegator.
See Chapter 28, "Setting Up and Working with Delegation," Reviewing Delivered Notification Templates for
Delegation, page 749.
The Delegation framework manages delegation requests through request statuses and delegation statuses. A
request status defines the status of the delegation request. A delegation status defines whether a proxy's
delegation authority is active or inactive. The combination of these two statuses determines how the
Delegation framework handles delegations.
This table lists request statuses for delegation and describes how the Delegation framework handles a
delegation depending on the delegation status associated with each request status:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 709
Setting Up and Working with Delegation Chapter 28
710 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
You should also analyze the following security needs and create a plan that covers these needs:
Analyze delivered permission lists and roles for delegation components to decide if the implementation
will use the delivered objects or create new objects.
Decide how to define a standard user profile for the delegation administrator that contains the relevant
roles.
Decide how to define a standard user profile for the delegator that contains the relevant roles.
Decide how to define a standard user profile for the proxy that contains the relevant roles.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 711
Setting Up and Working with Delegation Chapter 28
Decide if the delegator and proxy should have the same or different profiles.
1. Register delegation transactions for workflow on the Register Workflow Transactions page.
2. Set up delegation permission lists and roles through PeopleTools Security components.
3. Define installation settings for delegation on the Delegation Installation Settings page.
Note. In addition to the PeopleSoft Enterprise HRMS custom navigation pages, the PeopleSoft system
provides menu navigation and standard navigation pages.
See Also
Delegation Setup Center Set up HRMS, Common Definitions, Administrators can use the
Delegation, Delegation Setup Center component links on this page to
access the pages necessary to set up
the Delegation framework for
PeopleSoft Enterprise HRMS.
Approvals and Delegation Workforce Administration, Self Administrators can use the
Service Transactions, Approvals and component links on this page to
Delegation access the pages necessary to
maintain delegation and to monitor
approval transactions for PeopleSoft
Enterprise HRMS.
712 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
See Also
Chapter 27, "Setting Up and Working with Approvals," Linking Workflow Transactions, page 669
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 713
Setting Up and Working with Delegation Chapter 28
714 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 715
Setting Up and Working with Delegation Chapter 28
Note. When implementing the Delegation framework, you must register all self-service transactions. Only the
registered workflow transactions that you enable for delegation initiation or approval are available for
subsequent delegation transaction setup.
See Chapter 27, "Setting Up and Working with Approvals," Linking Workflow Transactions, page 669.
This table describes the delivered permission lists for the Delegation framework:
716 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
HCCPDL1000 Enables users to access the delegation setup HCM Delegation Admin
components that are part of the Delegation Setup (administrator)
Center page and the delegation administrative
components that are part of the Approvals and
Delegation page.
In addition to permission lists, you need to define the delegation administrator role and assign the
HCCPDL1000 permission list to it. Once assigned to a user, this role enables that designated delegation
administrator access to the delegation setup and administrative components. The PeopleSoft Enterprise
HRMS system delivers the HCM Delegation Admin role as system data for this purpose. This role already
has the HCCPDL1000 permission list assigned to it.
PeopleSoft Enterprise HRMS applications that use delegation functionality deliver many transactions that are
preconfigured for the Delegation framework. These transactions are preconfigured with a unique permission
list and role for each component where the proxy can perform the delivered delegated transaction. When a
proxy status becomes active, the system inserts the unique role for that delegation transaction into the proxy's
user profile. The role contains the permission list that enables the proxy access to the component for
performing the delegated transaction. When the proxy status becomes inactive, the system removes that role
from the proxy's user profile. To configure delegation transactions, use the Configure Delegation Transaction
page to associate to the transaction the unique role and the component where the transaction is performed.
The unique permission list is associated with the role in PeopleTools security.
See Chapter 28, "Setting Up and Working with Delegation," Configuring Delegation Transactions, page 722.
When configuring transactions for delegation you must use a unique role and permission list for each
component that you associate with a delegated transaction. You must attach the permission list to portal
security for the component and associate the unique role with the unique permission list. You might also need
to run the Portal Security Sync process (PeopleTools, Portal, Portal Security Sync) to ensure that the
permission list is associated with the portal navigation.
Warning! Do not use an existing role to configure a delegation transaction because the delegation
framework grants and revokes the role from the proxy's security profile according to the proxy's delegated
authority over a transaction. This will cause a proxy who already has access to the specified component to
lose access to that component entirely when the delegation framework revokes the delegated authority.
See Also
Chapter 28, "Setting Up and Working with Delegation," Configuring Delegation Transactions, page 722
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 717
Setting Up and Working with Delegation Chapter 28
Set Up HRMS,
Common Definitions,
Delegation, Installation
Settings, Delegation
Installation Settings
718 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Administrator Role Select the role that you want to designate as the delegation administrator. The
delegation framework routes errors to this role. The PeopleSoft system delivers
the HCM Delegation Admin role as system data for this purpose. You can select
that role or any other role.
Duration to check for Enter the number of days that you want the Maintain Delegated Authority
active proxies and Days Application Engine process to add to the system date when checking whether a
proxy is active in the job data record or equivalent record for persons of interest.
Delegation administrators can run this process from the Maintain Delegated
Authority page.
Checking for proxy availability is particularly important when using open-ended
delegations. An open-ended delegation is when the delegator leaves the To Date
field blank on the Enter Dates page when creating a delegation request through
self-service.
By default, the system uses 7 days. If you leave the field blank or enter 0, then
upon saving the component the system automatically sets the value to 7. In this
example, when delegation administrators run the batch job, the process adds
seven days to the system data and checks for proxy availability on that date.
Enable Hierarchies
Use this group box to define options for how self-service users can select a proxy when delegating a
transaction. Your selections here determine the available proxies that the system displays on the Select Proxy
By Hierarchy page when users create delegation requests. These settings apply to all transactions that are
using the Delegation framework. For example, you cannot specify that the system display available proxies
for time-off requests by supervisor ID and available proxies for promotions by Reports To Position.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 719
Setting Up and Working with Delegation Chapter 28
All Persons Select this check box to enable open selection of the proxy when users are
creating a delegation request. The system displays the Search by Name link on
the Select Proxy By Hierarchy page. When users click this link, the system
displays the Select Proxy By Name page, where users can search for and select as
proxy any active person in the system. By default, the system selects this check
box.
720 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Specific Hierarchies Click this check box to require delegators to select a proxy based on a specific
hierarchy. You can only select one hierarchy. The hierarchy that you select
applies to all delegation requests across the system regardless of the transaction
type. When self-service users search for a proxy by hierarchy, they can search up
the hierarchy as well as down the hierarchy.
Your choices are:
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.
This option is available only if you have enabled the Manage Positions
business process on the Installation Table - HRMS Options page.
This option is available only if you have enabled the Manage Positions
business process on the Installation Table - HRMS Options page.
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 values first,
and then for Department Manager ID values.
By Group ID: Determines data access using the group ID set up in the Group
Build feature.
If you select this option, you must select a valid group ID in the field that the
system displays to the right. You define group IDs using the Group Build -
Group Definition component.
These hierarchies relate to direct reports functionality and are the same as those
found in the Access Type field on the Target Information page of the Direct
Reports Setup component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 721
Setting Up and Working with Delegation Chapter 28
If you select the Specific Hierarchies check box and the All Persons check box,
then this hierarchical selection of proxy becomes a preference rather than a
requirement because the delegator has the option to either select from the list or
search for any active proxy in the system.
722 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 723
Setting Up and Working with Delegation Chapter 28
Note. For more information about application-specific delegation transactions, refer to the application-
specific PeopleBook.
724 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Transaction Name Displays the name of the transaction. If you are adding a new value, the system
prompts you to select a value from the list of transactions that have been
configured for workflow and selected for delegation initiation or approval on the
Workflow Transactions page. Transactions that do not meet these criteria are not
available for delegation configuration.
Transaction Type Displays whether the configuration of the transaction is for delegation initiation
or approval. The Delegation framework allows you to separate the task of
initiating a transaction from approving the same transaction on someone's behalf.
If you are adding a new value, the system prompts you to select either:
Initiate: Delegator may delegate authority for a proxy to only initiate or
submit a transaction on the delegator's behalf.
Although both options are available for the selected transaction, the value that
you select is valid only if you have selected the corresponding Delegate Initiation
or Delegate Approvals check box on the Workflow Transactions page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 725
Setting Up and Working with Delegation Chapter 28
Description Enter the description of the delegation transaction configuration. The system uses
this description throughout the delegation pages when displaying related
transactions. As a default, the system uses the concatenation of the transaction
type and transaction name. We strongly recommend that you always assign a
meaningful description.
Effective Date and Status Enter the effective date of the transaction and whether it is active or inactive
within the Delegation framework. By entering new effective-dated rows, you can
enable or disable the transaction, as necessary. When entering a new row, the
system uses the system date for the effective date by default.
Security
Use this group box to establish security access for proxies that are delegated authority to the given
transaction. While a delegation transaction is active, the Delegation framework temporarily assigns the
specified role to the proxy and grants the proxy access to the specified component.
Role Select the role that contains the permission list for the relevant component where
one processes the given transaction. Each transaction that you enable for
delegation must have a unique role and associated permission list that are solely
for delegation purposes.
When a proxy's delegated authority becomes active, the system temporarily
assigns this role to the proxy's user profile so that the proxy can access the
transaction component while having delegation authority. When the proxy's
delegation authority ends, the system deletes this role from the proxy's user
profile. Thus, the proxy no longer has access to the transaction component.
If an approval transaction requires that the approver be in a particular role, then
the proxy who is delegated authority over that transaction must have the same
role to approve the transaction. For example, if promotion approval requires that
the approver be a manager, then the proxy who is delegated authority to approve
promotions must also be a manager to successfully approve a promotion request.
This field prompts from roles set up in the Roles component.
Warning! You must use a unique role for each component that you associate
with a delegated transaction.
Component Name Select the object name of the component where users can process requests for the
given transaction. When a user creates a delegation request, the system checks
the delegator's user profile to determine if the delegator has the authority to
access this component. The system permits the creation of a delegation request
for the transaction only if the delegator has security access.
Optional Parameters
Use this group box when you need to create a link on the Delegation pages that will take the user to a product
specific page to complete the delegation process.
726 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Use the Display Link Label fields for retrieving the link labels from the message catalog.
Message Set Number Enter the number that will identify the label that should be used for the link that
and Message Number will appear on the Delegation Detail page. This label is maintained at the product
specific
Use Delegation Event Handler Class fields to identify the product specific application classes.
Root Package ID Select the application package that owns the component to which the person will
be directed when he or she clicks the link in the Delegation pages.
Path Enter the class that will take the user to the product specific component to
finished the delegation process.
Add Delegation Request HCDL_ADMIN_ADD_DLG Workforce Administration, Add delegation requests that
Self Service Transactions, administrators create on
Approvals and Delegation, behalf of delegators.
Add Delegation Request,
Add Delegation Request
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 727
Setting Up and Working with Delegation Chapter 28
Note. To prevent situations of cascading or circular delegation chains, after the Delegation framework passes
delegated authority over a transaction to a proxy, the proxy cannot delegate authority over that transaction to
another user. The Delegation framework only passes authority over transactions from initial delegator to
initial proxy.
Note. When a user adds a delegation request, the system checks for an Alternate User ID field value on the
User Profile - Workflow page. The delegation request overrides the alternate user ID for transactions in the
delegation request. If an alternate user ID exists and the dates of the delegation and alternate ID overlap, the
system issues a warning message.
From Date and To Date Enter the date range for which you want the delegation to be active. The From
Date value must be greater than today's date. The To Date value must be greater
than the From Date value. If you want to make the delegation open-ended, leave
the To Date field blank.
Trans Type (transaction Select the transaction that is being delegated. The system prompts you to select
type) and Transaction from only the transactions for which the delegator has access. The transactions
Name must be active for the specified date range of the delegation, as defined on the
Configure Delegation Transaction page.
The system displays whether the selected transaction is for delegation initiation
or approval.
Proxy and Name Select the proxy to whom the delegator wants to delegate the transaction.
Notify Delegator Select this check box to have the system send a courtesy email notification to the
delegator when the proxy approves or initiates this transaction on the delegator's
behalf.
Maintain Delegated Click this link to access the Maintain Delegated Authority page, where you can
Authorities run a batch job to process delegation transactions.
Administer Delegation Click this link to access the Administer Delegation page, where you can search
for and manage individual delegation requests in the system.
728 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Product specific link Select the product specific link for a transaction to have the system open the
product specific component to complete the delegation request.
The product specific component will have a check box to indicate that it is OK to
submit the delegation request or not. If it is OK, then the delegation request will
be submitted. If it is not OK, then the delegation request will not be submitted.
This link is available when the Optional Parameters section of the Configure
Delegation Transaction page for the transaction is configured to have further
product specific delegation requirements. The label of the link comes from
message catalog as specified on Configure Delegation Transaction page. When
no information is entered in the Optional Parameters section of the Configure
Delegation Transaction page, the link is not available.
Administering Delegations
This section discusses how to administer delegations.
Administering Delegations
Access the Administer Delegation page (Workforce Administration, Self-Service Transactions, Approvals
and Delegation, Administer Delegation, Administer Delegation).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 729
Setting Up and Working with Delegation Chapter 28
Note. If the delegator and proxy initiate duplicate transactions, then either the proxy, delegator, or delegation
administrator can cancel the duplicate transaction or approvers can deny the duplicate transaction while
approving the original transaction.
Maintain Delegated Click this link to access the Maintain Delegated Authority page, where you can
Authorities run a batch job to process delegation transactions.
Add Delegation Request Click this link to access the Add Delegation Request page, where you can create
delegation requests on behalf on delegators.
730 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Selection Criteria
Use this group box to specify criteria for the delegation requests that you want to retrieve. To retrieve all
delegation requests, click the Search button without specifying criteria. To narrow your search results, enter
one or more criteria.
Delegator Enter the delegator for whom you want to retrieve delegation requests. The
system prompts you to select from delegators with existing requests.
Proxy Enter the proxy for whom you want to retrieve delegation requests. The system
prompts you to select from proxies with existing requests.
Transaction Name Enter the transaction for which you want to retrieve delegation requests. The
system prompts you to select from transactions that are part of existing requests.
From Date and To Date Specify the specific from or to date for which you want to review delegation
requests.
Request Status Select the status of the requests that you want to retrieve. Request statuses are
Accepted, Ended, Rejected, Revoked, and Submitted.
See Chapter 28, "Setting Up and Working with Delegation," Understanding
Delegation, page 707.
Delegation Status Select the delegation status of the requests that you want to retrieve, either Active
or Inactive.
See Chapter 28, "Setting Up and Working with Delegation," Understanding
Delegation, page 707.
Search Click this button to retrieve delegation requests based on your selection criteria.
Search Results
The system displays delegation requests and details based on your search criteria.
Request Status The system displays the status of the request on the Request Details tab:
Accepted,Ended, Rejected, Revoked, and Submitted. Click this link to review
further details of a delegation request. The system displays the Administer
Delegation - Request Details page.
Select All Click this button to select the check boxes for all delegation requests in the
search results.
Deselect All Click this button to deselect all check boxes for the selected delegation requests
in the search results.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 731
Setting Up and Working with Delegation Chapter 28
Revoke Click this button to revoke a delegation request on behalf of the delegator. The
system revokes delegations for all requests that are selected in the search results.
The system sends a notification to the proxy who is affected by the change and
automatically reassigns all pending transactions back to the delegator.
Click the Process Request button to run the Maintain Delegated Authority (HCDL_BATCH) Application
Engine process. This batch program processes all delegation transactions as of the system date that appears on
the run control page. The process activates all delegation transactions that were future-dated to become active
on today's date, revokes all delegation requests that have expired as of today's date, and searches for inactive
proxies. For all affected delegation transactions, the process updates the request status and delegation status
as appropriate. The process also updates proxy navigation security, as needed.
Important! Run this process daily to maintain delegations and update invalid rows.
732 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 733
Setting Up and Working with Delegation Chapter 28
Manage Delegation - Learn HCDL_DLG_INSTR Click the Learn More about View help for delegation.
More about Delegation Delegation link on the Users can view an
Manage Delegation page. instructive description of
delegation functionality.
Create Delegation Request - HCDL_JOB_SELECTION Click the Create Delegation Select the job for a
Select Job Title Request link or the Review delegation request. Users
My Proxies link on the with multiple jobs can
Manage Delegation page select the job for which they
when you hold multiple want to create the
jobs. delegation request or review
their proxies.
Create Delegation Request - HCDL_ADD_DLG_DATES Click the Create Delegation Enter delegation dates by
Enter Dates Request link on the Manage specifying the From Date
Delegation page. and To Date, which defines
the delegation authority
period for a transaction. By
not specifying a To Date,
users specify an open-ended
delegation.
Create Delegation Request - HCDL_ADD_DLG_TXNS Click the Next button on the Select transactions for
Select Transactions Enter Dates page. delegation. Users can select
one or more transactions to
delegate.
734 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Create Delegation Request - HCDL_ADD_DLG_SRCH Click the Next button on the Select a proxy by reporting
Select Proxy by Hierarchy Select Transactions page. hierarchy. Users can select a
proxy for the transactions
being delegated based on
their reporting hierarchy.
Create Delegation Request - HCDL_ADD_DLG_DTL Click the Next button on the Submit a delegation request.
Delegation Detail Select Proxy by Hierarchy Users can review the details
page or the Select Proxy by of a delegation request and
Name page. then submit the delegation
request.
Confirmation, HCDL_DLG_CONFIRM
Click the Submit button View the confirmation of
on the Delegation the delegation request
Accept Delegation Request,
Detail page when submission, the acceptance
Reject Delegation Request adding a delegation of a delegation request, or
request. the rejection of a delegation
request.
Click the Accept button
or the Reject button on
the My Delegated
Authorities page.
My Proxies HCDL_MGR_DLGT
Click the Review My Manage proxies for
Proxies link on the delegation. Users can
Manage Delegation manage their proxies by
page. search for and updating the
status of their delegation
Click the OK button on requests.
the Confirmation page
after successfully
completing a delegation
request.
Delegation Request Details HCDL_REQUEST_DTL Click the Details button for Viewing delegation Request
the delegation transaction Details. Users can review
on the My Proxies page. the details of a submitted
delegation request.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 735
Setting Up and Working with Delegation Chapter 28
Multiple Transactions HCDL_MULTI_TXNS Click the Multiple Users can view details of
Transactions link on the My the multiple transactions for
Delegated Authorities page. which they have delegated
authority.
736 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
Users can view all delegation activity associated with themselves. They can create a delegation request,
revoke delegation requests for which they have delegated transaction initiation or approval to a proxy, and
accept or reject the delegation requests for which they are selected to serve as proxy. The system displays
only the content and associated links that are applicable to the user at the time that user accesses the page.
Specifically, the system displays:
The Learn More about Delegation link and associated content for learning more about delegation, which
is accessible to all users at all times provided that the system is using the Delegation framework.
The Create Delegation Request link and associated content for creating delegation requests only if the
user has navigation security access to transactions that are enabled for delegation through the delegation
setup pages.
The Review My Proxies link and associated content for reviewing proxies only if the user has active or
inactive delegation requests.
The Review My Delegated Authorities link and associated content for reviewing delegated authorities
only if the user has been delegated authority to serve as a proxy.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 737
Setting Up and Working with Delegation Chapter 28
You can configure this page by accessing it through PeopleTools Application Designer.
738 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
If users creating the delegation request or reviewing their proxies have multiple jobs, the system prompts the
user to select the job for which they want to create the delegation request or review proxies. This page
displays only when the employee has multiple jobs.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 739
Setting Up and Working with Delegation Chapter 28
740 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
The system displays only the transactions that are configured for delegation initiation or approval on the
Configure Delegation Transactions page and for which the delegator has component access.
Users can delegate one or multiple transactions to another person in a single delegation request. When a
proxy receives a delegation request for multiple transactions, he or she must accept or reject the entire
request. The delegator, however, can revoke single transactions from a multiple transaction request. When a
delegator revokes one or more transactions from a multiple transaction request, the system pulls the revoked
transactions out of the multiple transaction request and creates individual revoked entries in the Approval
Framework. The remaining transactions stay in the multiple transaction request. If only one transaction
remains after revoking, the system disbands the group and displays an individual rather than multiple
delegation request. This functionality preserves the accuracy of the multiple transaction status.
Users can select a proxy for transactions they are delegating. If the delegation administrator selects a specific
hierarchy for the transaction on the Delegation Installation Settings page, the system displays valid proxies
based on that selection, and users can select from this list. Valid proxies include persons who report directly
or indirectly to the delegator, as well as all persons in the upward hierarchystarting with the delegator's
manager. If the delegation administrator selects the All Persons check box on the installation page, then the
system displays the Search by Name link so that users can search for and select from any person in the
system.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 741
Setting Up and Working with Delegation Chapter 28
Users can search for a proxy by name and select from the list of valid values in the search results. This page is
available only if the delegation administrator selects the All Persons check box on the Delegation Installation
Settings page.
742 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
The system displays the delegation period, the selected proxy, and the selected transactions. When a
transaction is set up with product specific delegation requirements on the Configure Delegation Transaction
page, a link will appear after the transaction. When no information is entered in the Optional Parameters
section of the Configure Delegation Transaction page, the link is not available. Select the product specific
link for a transaction to have the system open the product specific component to continue the delegation
request.
When users click the Submit button, the system automatically sends an email notification to the proxy to
either accept or reject the delegation request if Approval Framework is set up.
To prevent situations of cascading or circular delegation chains, after the Delegation framework passes
delegated authority over a transaction to a proxy, the proxy cannot delegate authority over that transaction to
another user. The Delegation framework only passes authority over transactions from initial delegator to
initial proxy.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 743
Setting Up and Working with Delegation Chapter 28
Note. When a user adds a delegation request, the system checks for an Alternate User ID field value on the
User Profile - Workflow page. The delegation request overrides the alternate user ID for transactions in the
delegation request. If an alternate user ID exists and the dates of the delegation and alternate ID overlap, the
system issues a warning message.
Note. If the delegator and proxy initiate duplicate transactions, then either the proxy, delegator, or delegation
administrator can cancel the duplicate transaction or approvers can deny the duplicate transaction while
approving the original transaction.
744 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
My Proxies page
Users can change their mind by revoking delegation requests for which they have delegated transaction
initiation or approval to a proxy. To revoke the delegation request, users must select the check box for the
delegation request and then click the Revoke button. The system changes the request status to Revoked and
automatically sends an email notification to the proxy about the status of the delegation request.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 745
Setting Up and Working with Delegation Chapter 28
Users can click the Return button to return to the My Proxies page.
746 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
A proxy can hold more than one delegated authority from different delegators. The proxy must select the
check box for delegation request and then click either the Accept button or the Reject button. The system
automatically sends an email notification to the delegator about the status of the delegation request.
Note. When you are delegating to a proxy who has multiple job records (as defined in the Job Data
component), the system uses the proxy's job record number 0 by default.
Multiple Transactions
Delegators can delegate one or multiple transactions to another person in a single delegation request on the
Create Delegation Request - Select Transactions page. If the delegation request contains multiple
transactions, the proxy can click the Multiple Transactions link to access the Multiple Transactions page and
view details about each transaction in the delegation request. For a delegation request with multiple
transactions, the proxy must accept or reject the entire request.
The delegator can revoke single transactions from a multiple transaction request on the My Proxies page.
When a delegator revokes one or more transactions from a multiple transaction request, the system pulls the
revoked transactions out of the multiple transaction request and creates individual revoked entries in the
Approval Framework. The remaining transactions stay in the multiple transaction request. If only one
transaction remains after revoking, the system disbands the group and displays the delegation request as an
individual transaction rather than a multiple transaction. This functionality preserves the accuracy of the
multiple transaction status.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 747
Setting Up and Working with Delegation Chapter 28
Users can click the OK button to return to the My Delegated Authorities page.
Note. In some cases, there may be manager self-service pages that you do not typically have permission to
access. In these cases, after accepting a delegation request, log off the system and back in to access the
manager self-service pages.
Users can click the OK button to return to the My Delegated Authorities page.
748 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 28 Setting Up and Working with Delegation
The system provides access to this page only if the delegator selected the user to server as proxy for multiple
transactions within the same delegation request.
DelegationAccept States that the proxy has Proxy accepts delegation To: Delegator
accepted the delegation request.
CC: Proxy
request submitted by the
delegator.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 749
Setting Up and Working with Delegation Chapter 28
DelegationNotifyAdmin States that the system has Delegation administrator To: Delegator
identified that a proxy is runs the Maintain
CC: Delegation
inactive for at least one day Delegated Authorities batch
Administrator
for a delegation request that process.
has been accepted.
DelegationReject States that a proxy has Proxy rejects delegation To: Delegator
rejected a delegation request.
CC: Proxy
request submitted by a
delegator.
See Also
Chapter 27, "Setting Up and Working with Approvals," Defining Notification Templates for Approvals, page
686
750 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29
This section provides an overview of the HCM metadata repository and discusses how to:
Export metadata.
Import metadata.
The HCM metadata object model consists of the following two elements:
PeopleTools-level metadata
Provides information about fields, field labels, and database records and views.
HCM-level metadata
Establishes relationships between objects at the object level, defines objects's services, and alternative
labels.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 751
Working with Metadata and Query Builder Chapter 29
HCM metadata object definitions are registered in the metadata repository as classes and these classes are
grouped in the following two catalogs according to general behavior, processing, and attribute needs:
Base catalog.
Object classes:
Object catalog.
Object classes:
Can be the child object of a parent base class, inheriting all of the attributes of the base class.
Note. Object class catalogs do not need to have a parent class object.
Note. Any metadata class definitions that are not obviously a parent class object, should be defined in
the object catalog.
For example, the base class object, Person Base, is the parent to the derived object class, Person.
Basic Information Define the class's basic characteristics by entering information into the following
fields:
Class Name
Display Label
Object Owner ID
Active Flag
752 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Staging: a specialized staging object used to load data into the HCM
system.
The system selects the System Data check box if the class object is delivered as
HCM system data.
Persistence Mapping Enter the name of the PeopleTools record to which this class maps. The
PeopleTools record is the sole source for the class object. Each class definition
maps to one PeopleTools record
Click to populate the Class Attributes grid with all the fields associated with the
PeopleTools record you selected in the persistence mapping Record Name field.
The button does not overwrite valid fields.
Note. PeopleSoft recommends that you keep the attributes in sync with the
PeopleTools record fields by using this button after you make a modification to
the PeopleTools record.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 753
Working with Metadata and Query Builder Chapter 29
Relationships Define the relationships this class definition has with other class definitions. For
example the Person class that maps to the PeopleTools Person record could be
have relationships with the:
Name class.
Address class.
Job class.
Click the View Relationship Details button to review details or enter a details for
a new class attribute on the Class Relationship Details page.
Class Extensions Class extensions enable you to define any additional attributes that you can
access through APIs (you cannot use these properties with Query Builder). For
example, you could create a Java type class extension called MyJava and with a
value of the Java file name that programmers can access as required.
Define the class extensions by entering values into the following fields:
Type
Name
Value
Base Class Definition HCMD_BASE_PG Set Up HRMS, Product Define base classes by
Related, Compensation, setting up and reviewing
HCM Metadata Repository, definitions for base classes.
Base Class Definition, Base
Class Definition
Object Class Definition HCMD_OBJS_PG Set Up HRMS, Product Define object classes by
Related, Compensation, setting up and reviewing
HCM Metadata Repository, definitions for derived
Object Class Definition, classes.
Object Class Definition
754 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Export Metadata HCMD_FILENAME Click the Export All Class Enter the path and filename
Definitions Definitions button on the of the export file to be
Export Metadata created.
Definitions page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 755
Working with Metadata and Query Builder Chapter 29
756 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 757
Working with Metadata and Query Builder Chapter 29
Class Attributes
Parent Class If this class object is built upon a parent class object, select it here. The class
object will inherit all of the parent's attributes.
Leave this field blank if the object class has no parent.
Search Component Select the search component to search for instances for this derived class object.
The system uses the Query Builder search component as a default if you do not
enter a value here.
Component Interface Select the PeopleTools component interface used to save data for the class. You
Name can use the component interface in Query Builder to perform bulk updates. For
example, you can create a query for all the people at Location A and then update
the location information on the Job Data component for that group of people to
Location B.
Edit Component
When you enter a component in this group box for a class, the system enables you to link to the component or
page from a hyperlink in the query results when you query the class in Query Builder. This enables you to
make updates to the component while you are reviewing the query results
Enter the component's Menu Name,Menu Bar Name,Item Name, and Page Name.
758 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Attribute Name Enter the attribute name. It can be different from the corresponding field.
Field Name Each attribute must have a corresponding field in the PeopleTools record.
Configuration Controls
Allow Modifications? Select if the users can modify the attribute in dynamic user interfaces.
Allow Deletion? Select if the users can delete the attribute in dynamic user interfaces.
Use Options
Use in User Interface Select to display the attribute in a dynamic user interface.
Key Settings
Business key? Select if the business logic indicates that this attribute (field) is a key. You do not
need to define the attribute as a key field at the record level.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 759
Working with Metadata and Query Builder Chapter 29
Class attribute extensions enable you to define any additional attributes that you can access through APIs
(you cannot use these properties with Query Builder). For example, you could create a Java type class
attribute extension called MyJava and with a value of the Java file name that programmers can access as
required.
Define the class extensions by entering values into the following fields:
Type
Extension Name
Extension Value
Use in User Interface Select to display the relationship in a dynamic user interface.
760 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Source Cardinality Select the cardinality setting of the source class object from the following
options:
zero to 1 (0.. 1)
Target Cardinality Select the cardinality setting of the target class object from the following options:
zero to 1 (0.. 1)
Relationship is Select to make the reverse relationship (with the source and target object classes
Bidirectional? reversed) automatically available.
Bypass Indirection Select to bypass automatic setID indirection for those relationships that include
setID indirection fields.
Query Build automatically adds the required SetID logic as required. If you
select this option, you must define the logic in the relationship attribute mapping.
For example, SETID_Location maps directly to the SetID field on the Locations
table (LOCATION_TABLE) to improve performance.
Enter the names of the attributes that you are mapping. You can map any number of attributes and the
attributes do not have to have the same name to be mapped.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 761
Working with Metadata and Query Builder Chapter 29
Click to export all the metadata definitions in the catalog to an XML file. The
system will display the Export Metadata Definitions page where you enter the
export path and file name to be created.
Criteria Filter
To limit the classes, enter filter criteria in the Class ID,Class Type,Object Owner ID, or Active Flag fields.
Note. You can select more than one class ID in this field by separating the values with commas.
Click to apply the criteria you entered. The system populates the Search Results
grid with the class objects that meet the criteria.
Search Results
The system populates this grid with the class objects that meet your search criteria and automatically selects
all of them. Deselect the check boxes next to those class objects that you do not want to export.
762 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
The system displays the Export Metadata Definitions page when you click the Export All Class Definitions
button or Export Selected Definitions button. Enter the full path to the application server and the file name. If
you do not specify a file name, the process will create the file in the default directory.
Enter the file path and name to load the data from the XML file. The system will display a list of classes that
exist in the exported file and an icon indicates if the class already exists. Select which classes should be
imported and if the system should overwrite existing class definitions.
This section provides an overview of Query Builder and discusses how to:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 763
Working with Metadata and Query Builder Chapter 29
Create queries of unlimited length and complexity without the need to know the underlying database
model.
Query builder automatically generates the most efficient SQL based on the metadata class definitions,
generates all SQL joins automatically based on the relationships defined in metadata, and includes SetID
and effective-dated logic.
Select any number of available output fields to display results from both the underlying class and the class
relationships.
Group the output with counts, sums, and averages and include minimums and maximums for the grouped
output.
Preview the Structured Query Language (SQL) query generated by Query Builder.
Whereas PeopleSoft Query uses records and fields in queries, Query Builder queries objects and attributes.
This approach has two benefits:
You are more likely to recognize an object name than record and field names, and hence find it easier to
query objects that are in the system.
Underlying record and field definitions of system objects can change without affecting existing query
definitions, resulting in more robust queries.
Result Attributes EQRY_OUTPUT_PG Set Up HRMS, Product Select the object attributes
Related, Compensation, that you want to use as
HCM Query Builder, Query result attributes in the query
Builder, Result Attributes results. Select as many
attributes as needed.
Save Attributes EQRY_OUT_S_PG Click the Save Attributes Save the result attributes of
button on the Result the query. Enter a name and
Attributes page. description for the query.
The query is available to all
users who have access to
Query Builder. If you don't
want the query generally
available, select Private
Query.
764 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Load Attributes EQRY_OUT_L_PG Click the Load Attributes Load or append predefined
button on the Result result attributes selection for
Attributes page. use in the current query.
The attributes that are
available depend on the
target object that is selected
when Query Builder is
invoked.
Criteria Attribute Tree EQRY_ATT_TREE_PG Click the Select Attribute Using the object selection
lookup button next to the tree, navigate to the
Attribute Name field on the attribute that you want to
Criteria page. use as query criteria and
select it.
Select Value EQRY_VBUILD_PG Click the Value lookup Select the attribute value to
button on the Criteria page. use as query criteria
Save Criteria EQRY_PROP_PG Click the Save Criteria Save the current criteria
button on the Criteria page. selection by name for use in
later queries. The system
saves the query criteria
selection for the target
object that is selected when
Query Builder is invoked.
Load Criteria EQRY_LOAD_PG Click the Load Criteria Load an existing criteria
button on the Criteria page. selection.
Save/Load Query EQRY_COMBO_SAVE_PG Set Up HRMS, Product Save the current query or
Related, Compensation, load a predefined query.
HCM Query Builder, Query
Builder, Save/Load Query
Pre-defined Queries EQRY_VIEWER_PG Set Up HRMS, Product Run a query that you've
Related, Compensation, predefined on the Query
HCM Query Builder, Pre- Builder component. The
defined Queries page looks like the Query
Builder - Results page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 765
Working with Metadata and Query Builder Chapter 29
Use the Result Attributes page to select the object attributes that you want to search against. You can select
any combination of the defined attributes for the object.
At any point while defining result attributes, you can run the query and view the results. You can then return
to the Result Attributes page to modify the query result attributes, go to the Criteria page to refine the query
selection, or save the definitions.
Class ID to Query Displays the class ID you selected for querying on the search page.
Select Attributes
The system displays folders for the target class ID object and any other objects that have a relationship (as
entered on the Object Class Definition page) with the selected class ID. In this example, you can see that both
the Person Core Objects and Person Data Model objects have a relationship with the Email Addresses object.
Click the folder to view the attributes of each object. Click an attribute to add it to the attribute grid.
766 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Select Attributes You can rearrange the order of the selected attributes to determine the order in
which they appear on the Results page. You can also determine the sort order of
the data that is in each results column.
More... When Query Builder first opens, the Select Attributes tree displays the system
objects that are closely related to the target object through direct association.
These relationships are defined in HCM metadata and represent the objects that
you most often use in queries. If you can't find the objects that you want, click
the More link to access other objects .
Expand All Click to reveal the contents of all attribute tree folders.
Attribute Grid Select this check box to display the results columns as defined in the Attribute
Grid.
Aggregations Select this check box to display the results based on the groupings that are
selected in the Aggregations grid.
Enable Outer Joins Select this check box to enable the query to use outer joins to gather additional
data in the query.
View Results Click to run the query. The system opens the Results page, showing the results of
the query.
Clear Attributes (Optional) Click to remove the attributes that appear in the Selected Attributes
list.
Set As Default (Optional) Click to set the attributes that you select as the default attributes that
appear each time that you use the target object.
Attribute Grid
Selected Attributes The system populates the Selected Attributes list with the target object's list box
items as they're defined in the Tools Record definition. You can add or delete
attributes as necessary for your query.
and Use the arrows to rearrange the attributes to determine the column display order
in query results. For example, the attribute at the top of the Selected Attributes
list appears as the left-most column in the query results.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 767
Working with Metadata and Query Builder Chapter 29
Sort (Optional) Indicate a sort order for the attribute in the column results: Blank,Asc
(ascending), and Desc (descending). You can sort one or multiple columns.
Specifying multiple sorts causes column results to sort from left to right. Column
results that are sorted have a link that appears in the column header in the query
results.
Aggregations
Use the check boxes in this grid to indicate how you want the results to appear on the Results page. For
example, you can tell the system to group the results by order number, and within each group, sum the order
amounts as well as show the minimum and maximum amounts.
Group Select this check box to group the results by the attribute.
Count, Sum, Avg Select these options to have the system count the different groups. For attributes
(average), Min that are related to transaction amounts, the system can also sum, average, and
(minimum), and Max indicate the minimum or maximum amounts.
(maximum)
Use the Load Attributes page to add saved results columns to the query. The page displays all of the attribute
sets that are saved by all users as well as the attribute sets that you save and mark as private.
User ID The user who creates and saves the result attributes.
768 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
Criteria page
After you load or define the query result attributes, you can optionally add criteria to filter the query results
on the Criteria page. You can only select attributes from the objects that are selected on the Results Attribute
page. Specify as many criteria rows as needed, or save a criteria selection for later use to use as a predefined
query selection in the current query.
By using indentation in expressions, you can create queries that are as complex as you need. Query Builder
intelligently parenthesizes the expressions to ensure that the query is evaluated correctly.
Attribute Name Select the attributes from the objects connected to the class ID you're querying.
Click the Select an Attribute button to view a list of all defined attributes for the
object on the Select Criteria page. Select an attribute to return to the Criteria
page.
Value Enter a value for the selected attribute to use as query criteria.
Selecting a Value
Access the Select Value page to select the values that you want to use to filter the query. The fields on the
page differ depending on the operator that you select on the Criteria page.
If you use the between or not between operators, you select a From and To value.
If you used the like, not like, equal to, not equal, greater than, less than or equal to, less than, or greater than
or equal to, you select a value for the system to compare the result to.
If you use the in or not in operator, you can select one or more check boxes for the values within which you
want the system to return the results.
At any point while defining the criteria, you can click the View Results button to run the query, and then
return to the Criteria or Results Columns page to modify or (optionally) save the definitions.
View Results Click to view the results of the query on the Results page.
Clear Criteria Click to remove all current attribute names and value selections and start over.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 769
Working with Metadata and Query Builder Chapter 29
Save Criteria (Optional) Click to save current attribute name and value selections.
After selecting the criteria, you can save the query definition for future use. On
the Save Criteria page, enter a name and description for the query and indicate
whether or not you want it to be a private query.
Load Criteria (Optional) Click to load predefined attribute name and value selection.
This page works just like the Load Columns page, and displays all of the query
criteria sets that are saved by all users as well as the sets that you save and mark
as private.
Results page
Use the Results page to view the results of the query. You can click any of the links that are in the results
columns to go to the application page where the attribute is defined.
Select to view the query SQL, download the query results into Excel, add new criteria, or rerun the query.
Note. When you select to download the current query results to a Microsoft Excel spreadsheet, only the
results currently displayed on the page are downloaded to the spreadsheet. To download all query results,
click the View All link, and then click the Download to Excel link.
Aggregations Grid
Shows the results sorted and totaled based on the check boxes that you select on the Results Columns page.
This grid is only visible if you select the Aggregations check box on the Results Columns page.
770 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 29 Working with Metadata and Query Builder
While defining a query, you can save the result attributes and criteria as separate definitions. This allows you
the flexibility to mix and match various result attributes and criteria. You can also save a query definition,
which is a combination of an output (result attributes) selection and a criteria selection.
Query Name Enter a name under which to save the query. When you save a Query Builder
query, both the result attributes and the criteria selection are saved.
Private Query Select to make the query private and available only to the user who created it.
Select a query by searching on output and criteria combination, description, original class ID, or a
combination of these. Then click the query result that you want to run. Click the View Definition link to
access the Query Builder component, where you can change the results columns, attributes, or criteria of the
query and rerun the query.
Note. Predefined queries are also available by loading existing query definitions from within Query Builder.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 771
Chapter 30
HCM Transformation Framework enables seamless integration among PeopleSoft applications as well as with
third-party applications such as Oracle, SAP, and Siebel. Transformation schemas are associated with
transformation maps, enabling you to quickly locate and modify a schema to respond to external changes.
The transformation map registry is made up of transformation maps. The transformation map defines the
message properties of the message for both the target and source application. For each transformation map,
create a transformation schema, an XML document that defines the message structure mapping between two
applications.
When a message needs to be transformed in order to be successfully received by an application, you need to
assign a transformation program with the message on the Integration Broker Relationships component
(IB_RELATIONSHIP).
Based on the type of transaction, choose the appropriate transformation program to associate with your
message.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 773
Working with HCM Transformation Framework Chapter 30
When an application publishes a message that requires transforming, PeopleSoft Integration Broker invokes
the transformation program associated with the message. The transformation program determines which
transformation map corresponds to the target message and applies the transformation schema to the message
data using XSLT, an XML translation language. The transformation schema can modify the metadata or the
message data itself to comply with the target application requirements. PeopleSoft Integration Broker
repackages the transformed message data into an XML document that is structurally compliant with the target
application. The Integration Broker can then deliver the message to the receiving application.
This diagram illustrates the flow of information from one application to another using HCM Transformation
Framework:
See Also
Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker, "Applying Filtering, Transformation and
Translation"
774 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 30 Working with HCM Transformation Framework
<?xml version="1.0"?>
<PeopleSoftMessageName>
<FieldTypes>
<RecordName1 class="R">
<fieldname1 type="CHAR"/>
<fieldname2 type="NUMBER"/>
...
</RecordName1>
<RecordName2 class="R">
<fieldname1 type="CHAR"/>
<fieldname2 type="NUMBER"/>
...
</RecordName2>
...
</FieldTypes>
<MsgData>
<Transaction>
<RecordName1 class="R">
<fieldname1>Fieldvalue</<fieldname1>
<fieldname2>Fieldvalue</<fieldname2>
...
<RecordName1>
<RecordName2 class="R">
<fieldname1 type="CHAR"/>
<fieldname2 type="NUMBER"/>
...
</RecordName2>
<PSCAMA class="R">
<AUDIT_ACTN>ActionCode</AUDIT_ACTN>
</PSCAMA>
...
</Transaction>
...
</MsgData>
</PeopleSoftMessageName>
This format is then packaged into an XML document for transmission to the target application. If you have
attached one of the supported framework transformation programs to the message, the transformation
program identifies the appropriate transformation map and applies the transformation schema to the message,
modifying its structure. The message is then repackaged into an XML document in its altered form and
delivered.
Note. The transformation message must be supported by the transformation framework. Only supported
programs can work with the transformation maps. You can also add configured Application Engine or XSLT
transformation programs as part of the relationship definition independent of the transformation framework.
The transformation program can modify the following elements of the standard message structure:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 775
Working with HCM Transformation Framework Chapter 30
Transaction Contains the data for the records and their fields and organizes them into a
hierarchy. The record tags at each level contain the fields for that record.
The transformation program can select one or more record subsets and their
fields or just a subset of fields required by the target service operation and can
change their names.
PSCAM (PeopleSoft The last record within a transaction that provides information about the entire
Common Application transaction. The PSCAMA record contains fields that are common to all
Message Attributes) messages. The <PSCAMA> tag repeats for each row in each level of the
transaction section of the message. The sender can set PSCAMA fields to
provide basic information about the message, for example, to indicate the
message language or the type of transaction a row represents.
The transformation program copies this structure to the target message structure.
776 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 30 Working with HCM Transformation Framework
The system stores the map as an HTML template in the portal registry (HC_REGISTRY) in the HCM
Transformation Maps component.
Message Name and Select the message name and version for both the source (From) and target (To)
Message Version application.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 777
Working with HCM Transformation Framework Chapter 30
Transformation Define the mapping information (schema) to map the source service operation
Definition structure to the target service operation structure.
Inbound Synchronous.
Outbound Asynchronous.
Outbound Synchronous.
[TargetMessageRecord] class Enter the element class. The value is R for PeopleSoft
record based message structure.
Note. Edit this tag so that it
is the name of the target source_record (Optional) Enter the name of the source record. You
message record. should enter a value if the names of the source and
target records are different.
778 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 30 Working with HCM Transformation Framework
[TargetMessageRecordFiel type Select the data type of the field of the transformed
d] message for the target application. Valid values are:
NUMBER
source_field Enter the name of the source record field name whose
values should be copied in the transformed message
or
structure for the target application or enter the default
value value that should be copied in the transformed message
structure for the target application.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 779
Working with HCM Transformation Framework Chapter 30
Drill down to the transformation map by message name, message version, application version, and transaction
type. Click the template URL to access the Transformation Map page for the transformation map.
780 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31
Prerequisites
Use PeopleSoft Process Scheduler in PeopleSoft Human Resources to generate the sample form letters that
are delivered with PeopleSoft HRMS. The PeopleSoft Process Scheduler runs a job that:
1. Executes a Structured Query Report (SQR), with SQRibe Technology's Structured Query Report Writer
to extract data from the database.
2. Merges the data into a document template, with Word as the word processor.
If you currently use a report writer other than SQRibe Technology's Structured Query Report Writer or a
word processor other than Word, review the information in this chapter to understand the steps that are
involved in generating form letters. Then, consult your report writer or word processor documentation to
modify the procedures to fit the sample letters.
Once you are familiar with the sample form letters, you can modify the letters or create new ones for other
tasks.
Note. To generate letters, you should be familiar with the Word mail merge functions.
See Also
Chapter 31, "Setting Up and Generating Form Letters," Adapting Form Letters, page 790
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 781
Setting Up and Generating Form Letters Chapter 31
Please follow the appropriate method to create your form letters successfully.
Many human resource management activities involve sending out routine letters and memos on a regular
basis. For example:
(PeopleSoft Human Resources) Letters announcing course session enrollments, cancellations, and
rescheduling.
The wording of such letters doesn't change much from mailing to mailing; what does change is information
such as addresses and dates. In PeopleSoft HRMS, you can create form letters in your word processor by
accessing the data that you need from your human resources database.
You can generate several types of letters and print them all at the same time, or you can generate letters now
and print them later, if you prefer to review them first. Three sample form letters are provided at the end of
this chapter.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Training, "Enrolling and Wait-Listing
Students"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Labor Administration, "Setting Up Labor
Administration Data," Setting Up Labor Administration Disciplinary, Grievance, and Resolution
Classifications
PeopleSoft Enterprise Talent Acquisition Manager 9.1 PeopleBook, "Defining Installation Options for
Recruiting"
782 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Note. These instructions show you how to use templates to create form letters for PeopleSoft Human
Resources. To create form letters for other PeopleSoft HRMS applications, you follow a different method.
Please follow the appropriate instructions to create your form letters.
See Also
Chapter 31, "Setting Up and Generating Form Letters," Generating Form Letters for Other PeopleSoft HRMS
Applications, page 799
The form letter processes search the database for records that have been tagged with specific letter codes. For
example, when you enroll an employee in a training course using the Administer Training business process,
you can add a letter code to the employee record that identifies the type of letter required. When you later run
the training letter report, the system searches for records with the letter codes for training letters.
The form letter processes use Word to generate the letters based on data extracted from the PeopleSoft
database.
1. Create letter codes by using the Standard Letter Table page (STANDARD_LTR_TABLE).
Letter codes represent form letters and are used to link a record to the required letter.
2. Tag people's records with the appropriate letter code in the PeopleSoft Human Resources database.
Enter a letter code into the records of applicants, employees, contingent workers, or people of interest to
flag the record when it's time to generate a form letter.
For example, when you enroll or add students to waiting lists for training courses, the system inserts letter
codes into employee, contingent worker, and person of interest records.
3. Generate form letters by running a report that runs the following processes:
The final step is completed by the Distribution Agent that moves the letter files to the Report Repository.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 783
Setting Up and Generating Form Letters Chapter 31
This step is for the training letters only. The system also emails training letters to students if their email
addresses are in their person records.
Note. You must configure SMTP and activate Workflow to automatically send training letters by email.
The system creates the form letters in a temporary directory on the web server, putting all letters of the
same type in one file.
The distributed architecture of the PeopleSoft Human Resources system enables you to access the
application server far from local machines therefore the system doesn't print letters to a default printer.
Instead, you select where you want to print the letters by using standard Microsoft Word print options.
See Also
Chapter 31, "Setting Up and Generating Form Letters," Setting Up Standard Letter Codes, page 797
Generating form letters for PeopleSoft Human Resources with PeopleSoft Process Scheduler
784 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Identifies records in the database with the appropriate letter codes (and no print date).
Creates a data extract file (with an .ltr extension) that contains the data for each letter.
For example, the file containing data for offer letters is ltrof1.ltr, where of1 represents offer letter, and .ltr
represents letter.
The SQR process sends its output to the log/output directory defined for SQR reports. Define the log/output
directory in the Process Scheduler configuration file.
The WORDINIT WinWord process is an initialization process. Its purpose is to ensure that the PSMERGE
application engine process can retrieve the location of:
The WORDINIT process runs winword.exe and a dummy macro called PSINIT which opens and closes the
psmerge.doc file without creating any output. By including the WORDINIT WinWord process in the job
definition, the Process Scheduler ensures that it has loaded the location of the winword.exe file into
PSPRCSPARMS.
The PSMERGE application engine process uses this information to call Microsoft Word.
The PSMERGE Application Engine process completes the merge of the data extract files and the Word
templates. It:
Retrieves the locations of the data extract files, winword.exe and the PS_HOME Winword directory.
This file contains the locations of the files and a list of files to be merged.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 785
Setting Up and Generating Form Letters Chapter 31
Microsoft Word:
Opens the form letter templates that correspond to the data extract files.
Merges the appropriate extract file data into the field codes for each template.
For example, the offer letters template is ltrof1.doc and it includes field codes for names, addresses,
and offer amounts.
Inserts the data from the appropriate .ltr file into the template field codes.
For example, it inserts the data from the ltrof1.ltr extract file into the ltrof1.doc template.
You create letter codes in the Standard Letter Table component. Use letter codes to indicate what kind of
letter is required for a particular record. The standard letter codes that are delivered by PeopleSoft for use
with the sample letters are listed below.
The extension .ltr represents form letters and the extension .doc is the normal templates extension. Every
letter code for which you generate form letters must have a corresponding data extract file and a template
with the same name of the data extract file:
Object Example
The letter codes and their associated data extract files and Word templates include:
786 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Training letters
Purpose of Letter Letter Code Data Extract File Word Letter Template
Note. The Standard Letter Table also contains two codes, WTC and WTS, that are used in Administer
Training for students on waiting lists. However, these codes don't have macros or sample letters
associated with them.
Purpose of Letter Letter Code Data Extract File Word Letter Template
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 787
Setting Up and Generating Form Letters Chapter 31
1. Install the Microsoft Word on the same machine that runs the Process Scheduler.
The WINWORD parameter defines the location of the Microsoft Word executable file, winword.exe on
the server. Make sure that there are no spaces in the path and the path does not end with a slash (/).
3. Use the Process Scheduler Manager to define a server specifically for running the form letter processes.
Select PeopleTools, Process Scheduler Manager, Use, Server Definitions to define the server. On the
Distribution page, leave the Transfer Log Files to Report Repository check box deselected.
If you run the Process Scheduler as a service, modify the service to interact with the desktop:
2. Open the Process Scheduler service and access the log on tab.
3. For the Log on as field, select Local System account and select the Allow service to interact with desktop
check box.
This enables Microsoft Word to run in the foreground of the server. You cannot run Microsoft Word
macros as a background service.
See Enterprise PeopleTools PeopleBook: PeopleSoft Process Scheduler, "Appendix: Using the PSADMIN
Utility"
To run the macro that completes the merge, you must set the macro virus protection to Low. To do this:
1. Run Microsoft Word and select Tools from the menu bar.
To generate form letters, the document templates and the macros must be located in the directory
%PSHOME%\winword.
Check that the files psmerge.doc and psmerge.dot, and all the document templates in this directory are read-
only.
788 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Before running any of the form letters processes, test your environment by running the WORDSAMP
process. If this process runs successfully, this demonstrates that the environment is correctly configured to
run Microsoft Word processes.
Note. To verify that the WORDSAMP process has successfully completed verify that it has created a
document called wordsamp.doc.
1. Select PeopleTools, Process Scheduler, System Process Requests. Select a Run Control ID and click Run.
3. Select your server in the Server Name field and select the Win Word Sample Process check box.
4. Click OK.
5. Click the Process Monitor link to check that the process runs successfully (Run Status is Success).
6. Check that a document wordsamp.doc is created. This document is posted to the Report Repository as a
normal report.
If the process doesn't run successfully or the process doesn't create wordsamp.doc, then your environment
is not set up correctly to run WinWord processes.
See Enterprise PeopleTools PeopleBook: PeopleSoft Process Scheduler, "Submitting and Scheduling a
Process Request"
When you run the form letter report to generate letters, make sure that the Type and Format fields are set up
correctly for the SQR data extract process. The SQR process must be set up with Type set to File and Format
set to LP.
For example, if you are creating a training letter, check the output type and format as follows:
1. Select Enterprise Learning, Student Enrollment, Create Training Letters, Training Letters page
(RUNCTL_TRN001).
3. On the Process Scheduler Request page, click Training Letters to access the Job Detail page.
4. In the Process List group box, which lists the three processes run to generate letters, locate the SQR
process TRN001 and select File in the Type field and LP in the Format field.
For information about running the form letter reports, refer to the appropriate PeopleSoft Human Resources
PeopleBook.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Labor Administration, "Tracking
Disciplinary Actions and Grievances."
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Training, "Enrolling and Wait-
Listing Students," Generating Student Form Letters.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 789
Setting Up and Generating Form Letters Chapter 31
See PeopleSoft Enterprise Talent Acquisition Manager 9.1 PeopleBook, "Managing Applicants," Generating
Batch Recruitment Letters.
Depending on your configuration, you may need to make these changes to the standard Microsoft Word
macros that are supplied by PeopleSoft:
Default path to the empty.doc file that contains all the macros.
The macros create letters in the directory C:\TEMP on your application server. We recommend that you
edit the macros to change the location of the letters so that when you print them from Microsoft Word,
you print them to your local printers.
1. On the Servers - Distribution page, create a new dedicated Process Scheduler leaving the Transfer System
Files to Report Repository check box deselected to run form letters.
WINWORD defines the location of the Microsoft Word executable file that the process scheduler runs to
produce the form letters. For example, if Microsoft Word is run on the application server, you might have
this line in the process scheduler configuration file:
WINWORD=C:\APPS\OFFICE97\OFFICE
See Also
790 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
The form letter templates that are delivered with PeopleSoft Human Resources contain sample text for
different types of tasks that you can change to suit your needs. For example, you'll probably want to change
the sender names in the letters to the names of the employees in your organization who are responsible for
administering the tasks. If you need to modify only the text, without changing any fields that are used or
pages and tables that are referenced in PeopleSoft Human Resources, use the following procedure.
If you see " " in the document, select Tools, Options; then select the Field codes check box.
3. Make changes to the text as you would in any other document and save the file.
Warning! Don't overwrite the field codes (enclosed in curly brackets). They are the placeholders for the
values that are extracted from PeopleSoft Human Resources.
In addition to updating the text of a sample letter, you can include other types of data from PeopleSoft Human
Resources.
Note. To make this change, you should be familiar with Microsoft Word fields and the report writer used to
extract data values from your PeopleSoft Human Resources database.
1. Add field codes to the form letter templates for any new data types that you want to include.
2. Modify the SQR that extracts data from PeopleSoft Human Resources so that it retrieves values from all
of the fields that you want to use and writes them to the appropriate data extract files.
For example, to include title in the Training Enrollment Confirmation letter ltrcon.doc, add a title field
code to the form letter template. Also add a variable for title in TRN001.sqr so that the SQR retrieves the
title value and writes it to the data extract file.
Here's what the data extract file looks like before the change:
systemdate, Name, . . .,
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 791
Setting Up and Generating Form Letters Chapter 31
You can create form letters for different purposes. For example, you might want to create a form letter
notifying students they are on the waiting list for a course session.
2. Create a Word letter template, including the appropriate text, field codes, and data statement reference.
The file name of the template must match the data extract (.ltr) file name. For example, if the data extract
file is app004.ltr, the Word template file must be called app004.doc.
You might find it easier to adapt an existing form letter template than to create a new one. Look through
the form letter templates to see if there's one that needs only minor modifications to serve as a new form
letter template.
For example, create a form letter for interview schedules (INT) by adapting the offer letter template. In
the directory \PS\WINWORD, open ltrof1.doc. Modify the text as needed and add any new field codes
that you want to use in the letter. Save the new template under a different name, ltrint.doc.
792 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
3. Edit the SQR that selects and extracts data from other PeopleSoft Human Resources tables and stores it in
a separate data extract file.
Insert the MERGEFIELD field code where you want the merge process to insert data from the data
extract file into the letter. Press ALT + F9 to insert the MERGEFIELD field code.
For example, to create a new form letter for interview schedules, you create new procedures in app007.sqr
to extract values from all the fields and create a separate data extract file to store interview schedule letter
information.
The SQR process must include the name and extension (.ltr) of the data extract file that is created. An
example is:
begin-procedure Write-Heading
move '{IMPORTPREFIX}' to $FileName !start a new report file
do Get-prcsoutputdir
if (rtrim($prcsoutputdir,' ') <> '')
move $prcsoutputdir to $Filename
concat 'APP004.LTR' with $Filename
end-if
NEW-REPORT $Filename
Let $InputField1 = 'LANG,Audience,Job_Requisition,JobTitle,DeptID,DeptName,Min_Rt_
Annual,Max_Rt_Annual,Name1,Value1,Name2,Value2,Name3,Value3,Name4,Value4,Name5,Val
ue5,Name6,Value6,Name7,Value7,Name8,Value8,'
Let $InputField2 = 'Name9,Value9,Name10,Value10,Name11,Value11,Name12,Value12,Name1
3,Value13,Name14,Value14,Name15,Value15,Name16,Value16,Name17,Value17,Name18,Value1
8,Name19,Value19,Name20,Value20,AsOfToday'
Let $InputFieldTot = $InputField1 || $InputField2
move
$InputFieldTot
to $ioarea
print $ioarea (1,1)
next-listing
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 793
Setting Up and Generating Form Letters Chapter 31
end-procedure
If you create an Application Engine process, the file created by the process must have an .ltr extension.
4. Copy the new letter template to the Process Scheduler %PS_HOME%\winword directory.
5. Create a PSJOB to ensure that the SQR, WORDINIT, and PSMERGE processes are run in the correct
order.
Note. PeopleSoft recommends that you do not modify any of the delivered Winword macros or templates.
Note. To link your new letter to PeopleSoft Process Scheduler, ask your human resources project leader or
see the references below.
We deliver PeopleSoft Human Resources with Letter Code fields in several pages in Administer Training,
Administer Workforce, and Manage Labor Relations.
You can add the Letter Code field to any other pages (and their underlying tables) in PeopleSoft Human
Resources. For example, if you routinely send letters to employees, notifying them of career planning
sessions, you can add the Letter Code field to one of the pages from the Plan Careers menu.
Note. To make this change, you should be familiar with PeopleSoft Application Designer; Microsoft Word
field codes, macros, and data statements; and the SQRs that are used to extract data values from your
PeopleSoft Human Resources database.
When you add the Letter Code field to another page and its underlying table or tables in the system, also
create:
A form letter template with the appropriate text, field codes, and data statements.
An SQR that extracts data from the correct tables in PeopleSoft Human Resources and creates new data
extract files.
A job containing the SQR, WinWord process WORDINIT, and the Application Engine PSMERGE.
794 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
See Also
Enterprise PeopleTools PeopleBook: Using PeopleSoft Applications, "Working With Processes and Reports"
The process is run with the output Type set to File and Format set to LP. If you have run the SQR with
any other output type or format, make sure that you delete these data extract files.
The data extract file has been produced in the format xxx.ltr in the Process Scheduler log/output directory.
If the WORDINIT process fails and the environment is correctly configured, the most likely cause is macro
security. Switching off the macro security works for some Microsoft NT networks. You may also need to
consult your Systems Administrator.
In some networks, Microsoft Word automatically switches the security level back to "high" when running the
process. For example, if Winword macro security is defined at the NT User Profile level then you need to set
macro security to "low" for the NT ID that starts the Peoplesoft Process Scheduler service.
Note. Windows locks and caches the macro virus protection settings for Winword and this may cause
difficulties when turning off the macro virus protection.
Try hard-coding the path to PS_HOME in the Process Definition for WORDINIT:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 795
Setting Up and Generating Form Letters Chapter 31
4. In the Parameters field replace %%PS_HOME%% with the hard-coded path to the directory.
If the PSMERGE Application Engine process does not complete and you have added extra fields to the SQR
data extract process, check that the fields have also been included in the document template and that the fields
occur in the same order.
You must define a separate Process Scheduler server at Process Scheduler Definition level with the
Transfer Log Files to Report Repository check box deselected.
Confirm that the WINWORD parameter is correctly specified in the prcs.cfg file.
Check that all failed attempts at running the form letters have been deleted using the Process Monitor. Delete
any Process Requests that have failed.
Use the Windows Task Manager to check that there are no Winword processes still running. Delete these
before rerunning the form letter report.
Once Microsoft Word is interacting with the desktop it may try to reinstall itself. To avoid this, disable the
Windows Installer.
Check that the template files are in the correct directory with the correct access:
The Winword templates and the macros must be located in the %PS_HOME%\winword directory.
The files psmerge.doc and psmerge.dot and the document templates in the %PSHOME%\winword
directory must be read-only.
To display errors and debug the Winword Processes, modify your Process Scheduler configuration file,
psprcs.cfg, by adding the following line to the Process Scheduler section of the file (after the line for the
Allow Dynamic Changes parameter):
Allow To Interact With Desktop=1
Save the changes, clear the cache and re-start the application server.
See Enterprise PeopleTools PeopleBook: PeopleSoft Process Scheduler, "Using the PSADMIN Utility"
796 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
If the PSMERGE Application Engine process is failing or the status remains as Processing, take the trace file,
AE_PSMERGE_<PI>.trc (where <PI> is the process instance number), and extract the arguments from the
file, combine them and run them from a command line. This tests the process outside the Process Scheduler.
See Enterprise PeopleTools PeopleBook: PeopleSoft Application Engine, "Tracing Application Engine
Programs"
Note. You set up letter codes only for PeopleSoft HRMS form letters used with PeopleSoft Human
Resources. You do not set up letter codes for PeopleSoft HRMS form letters used with other PeopleSoft
HRMS applications.
Standard Letter Table page STANDARD_LTR_TABLE Set Up HRMS, Common Define your letter codes.
Definitions, Standard Letter
Table, Standard Letter
Table
Standard Letter Report - PRCSRUNCNTL Set Up HRMS, Common Run the Standard Letter
Run Control Definitions, Letters and Table report (PER711) that
Documents, Standard Letter lists the codes in your
Report, Run Control Standard Letter table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 797
Setting Up and Generating Form Letters Chapter 31
PeopleSoft delivers letter codes for the sample letters that are supplied as standard. You can add your own
codes to generate other form letters.
Note. PeopleSoft delivers a letter code for each template, but not all letter codes have a template. Before you
use a letter code, confirm that there is a corresponding template.
Set Letter Code Select a code from the available options. This code is used to group similar letter
codes, making it easy for you to find the code that you want. Options are:
COBRA Letter: Select for COBRA letters
Customer Letters: Select if you have created letters for your organization that
don't fit into any other category.
The system uses the Set Letter Code field to determine which letter codes to list
for the Set Letter Code fields.
798 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Note. These instructions show you how to use templates to create form letters for other PeopleSoft HRMS
applications. To create form letters for PeopleSoft Human Resources, you follow a different method. Please
follow the appropriate instructions to create your form letters.
See Also
Chapter 31, "Setting Up and Generating Form Letters," Generating Form Letters for PeopleSoft Human
Resources, page 782
The SQRs search your PeopleSoft HRMS database, retrieve data, and create data extract files containing
one line of data for each letter.
2. Use Microsoft Word to run the macros that merge the data extract files into form letter templates, one for
each type of letter.
To generate form letters by using PeopleSoft Process Scheduler, PeopleSoft delivers two files (stdltr.dot
and stdltr.95 located in the \PS\WINWORD directory on your application CD) containing the Word
macros. You must use the file that is appropriate for your system.
The macros in stdltr.dot are for use with Word 97 (in Microsoft Office 97) and are written in Visual
Basic.
The macros in stdltr.p5 are for use with Word 7.0 (used in Microsoft Windows 95) and are written in
Word Basic.
If you need to use stdltr.95, copy it to your system and rename it stdltr.dot.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 799
Setting Up and Generating Form Letters Chapter 31
The system creates the form letters in a temporary directory on the application server, putting all letters of
the same type in one file.
The distributed architecture of your PeopleSoft HRMS system means that your application server can be
located far from your machine, so the system doesn't print letters to a default printer. Instead, you select
where you want to print the letters by using standard Microsoft Word print options.
This diagram and the steps below illustrate how PeopleSoft Process Scheduler generates form letters for other
PeopleSoft HRMS applications:
Generating form letters for other PeopleSoft HRMS applications with PeopleSoft Process Scheduler
PeopleSoft Process Scheduler follows these steps to generate form letters for other PeopleSoft HRMS
applications:
800 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
1. SQR PAWRL01:
c. Creates data extract files pastdext.dat in the TEMP directory that is defined in the macro.
a. Opens the form letter templates that correspond to the data extract files.
b. Merges the appropriate extract file data into the template rollover.doc.
c. Inserts the data from pastdext.dat into the template field codes.
Depending on your configuration, you may need to make these changes to the standard Microsoft Word
macros that are supplied by PeopleSoft:
Default path to the empty.doc file that contains all the macros.
The macros create letters in the directory C:\TEMP on your application server. We recommend that you
edit the macros to change the location of the letters so that when you print them from Microsoft Word,
you print them to your local printers.
This enables the application server to add the letters to the directory. For example, if you're the training
administrator, you may share the C:\TEMP directory on your machine as TRNTEMP.
For the multilingual letters, set up subdirectories for each language in which you run the letters. For
example, if you run letters with the Language field set to English, you create the directory
C:\TEMP\ENG. See your system administrator if you don't know how to set up shared directories.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 801
Setting Up and Generating Form Letters Chapter 31
2. Update the macros with the location of your empty.doc file and the location of your shared directory.
Where:
WINWORD defines the location of the Microsoft Word executable file that the process scheduler runs to
produce the form letters. For example, if Microsoft Word is run on the application server, you might have
this line in the process scheduler configuration file:
WINWORD=C:\APPS\OFFICE97\OFFICE
See Also
You specify several environment variables in each Microsoft Word macro so that it can find the Word
templates and data extract files during the form letter process. For example, your network or workstation
configuration may have some of the files in different locations than those specified in the macros, so you need
to modify the PATH to reflect the correct locations.
Before you edit the existing macros (or create new ones), we recommend that you print copies of the
Microsoft Word documents and macros and the report writer SQRs and study them carefully.
802 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Note. To make this change, you should be familiar with Microsoft Word templates and macros and with your
report writer.
All of the macros are attached to a file in the \PS\WINWORD directory. (Your path may differ, depending on
your installation, but you can always find the file in a WINWORD subdirectory.) They are attached to an
empty Microsoft Word file called empty.doc.
To modify a macro:
4. Highlight the macro that you want to modify and click Edit.
The form letter templates that are delivered with PeopleSoft HRMS contain sample text for different types of
tasks, which you can change to suit your needs. For example, you'll probably want to change the sender
names in the letters to the names of the employees in your organization who are responsible for administering
the tasks. If you need to modify only the text, without changing any fields that are used or pages and tables
that are referenced in PeopleSoft Human Resources, use the following procedure.
If you see " "in the document, select Tools, Options; then select the Field codes check box.
3. Make changes to the text as you would in any other document, and save the file.
Warning! Don't overwrite the field codes (enclosed in curly brackets). They are the placeholders for the
values that are extracted from PeopleSoft Human Resources.
In addition to updating the text of a sample letter, you can include other types of data from PeopleSoft
HRMS.
Note. To make this change, you should be familiar with Microsoft Word fields and the report writer used to
extract data values from your PeopleSoft Human Resources database.
1. Add field codes to the form letter templates for any new data types that you want to include.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 803
Setting Up and Generating Form Letters Chapter 31
2. Modify the SQR that extracts data from PeopleSoft Human Resources so that it retrieves values from all
of the fields that you want to use and writes them to the appropriate data extract files.
For example, to include currencies in the notification letter rollover.doc, add a Currency field code to the
form letter template. Also add a variable for currency in pastdext.sqr so that the SQR retrieves the
currency value and writes it to the data extract file.
Here's what the data extract file looks like before the change:
LANG,NAME,PLAN,ADDR1,ADDR2,ADDR3,NATIONAL_ID,CURDATE
You can create form letters for different purposes. For example, you might want to send out form letters about
their benefit plans to be signed by employees.
1. Create a Word letter template, including the appropriate text, field codes, and data statement reference.
You might find it easier to adapt an existing form letter template than to create a new one. Look through
the form letter templates to see if there's one that needs only minor modifications to serve as a new form
letter template.
2. Create the SQR that selects and extracts data from other PeopleSoft Human Resources tables and stores it
in a separate data extract file.
3. Create a new macro that is able to read the extracted data and merge it with the Word letter template.
You might find it easier to copy an existing macro and adapt it.
Note. To link your new letter to PeopleSoft Process Scheduler, ask your human resources project leader or
see the references below.
See Also
804 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 31 Setting Up and Generating Form Letters
Training Letter Sample A confirmation of enrollment letter that is used in training (PeopleSoft Human
Resources Administer Training business process).
Pension Form Sample A Direct Rollover Election Form that the employee must complete for pension
(PeopleSoft Enterprise Pension Administration).
Dear Barry:
I am pleased to confirm your enrollment in training course K018 titled PeopleTools 1 beginning 09/11/2009
and ending 09/15/2009. Course hours are 9:00 AM to 6:00 PM daily, unless otherwise advised. The course
will commence at: Corporation Headquarters Bldg 2000 Floor 2 Room Training Room 2
New York, NY
Directions:
From the Airport, take the shuttle bus to George Washington Parkway.
Sincerely,
NAME
Date: CURDATE
ADDR1
ADDR2
ADDR3
I. Distribution Information:
Name of Plan:_________________________________________________________
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 805
Setting Up and Generating Form Letters Chapter 31
Address of Plan:_______________________________________________________
_______________________________________________________
OR
___ The plan is a qualified plan under Internal Revenue Code Section 401(a).
I hereby certify that the information I have entered on this form is true, correct, and complete.
______________________________________________________ Date_______________
Signature of Participant
806 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32
This chapter provides an overview of the work-in-progress (WIP) management system setup and discusses
how to:
Delivered setup.
Configuration steps.
Delivered Setup
Human Resources delivers definitions for the USFED WIP management transaction for personnel action
requests (PAR) and definitions for these self service transactions:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 807
(USF) Setting Up the Work-in-Progress Management System Chapter 32
Promotion (FE_PROMOTION)
Reassignment (FE_REASSIGN)
Retirement (FE_RETIRE)
Separation (FE_SEPARATE)
WIP set up tables are delivered as system data. You can modify the delivered setup to suit your agency's WIP
processing needs. Setting up WIP control parameters is usually a one-time-only process that you do when you
first configure your PeopleSoft Human Resources system. The setup information in this chapter is for your
agency's system administrator who will perform the setup and is not for managers or system users.
Note. All discussions assume that you understand the processes that are being described.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "(USF) Administering
Personnel Action Requests"
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "(USF) Processing
Personnel Action Requests"
PeopleSoft Enterprise eProfile Manager Desktop 9.1 PeopleBook, "(USF) Managing Direct Reports"
Configuration Steps
These are the WIP system configuration steps:
2. Set up WIP status codes and associate them with status types and batch processes for reporting.
1. Review the delivered sample USFED WIP system parameters as an example of WIP setup.
See Chapter 32, "(USF) Setting Up the Work-in-Progress Management System," Understanding
Delivered Sample WIP System Parameters, page 809.
808 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
2. Analyze your agency's review process and determine the levels of review that you need for PARs and
recruiting processes.
3. Design your system based on your agency's requirements for routing requests and other data through
approval processes.
Use the charts of sample parameters presented in this chapter as a starting point. You can use the charts as
is, change them, or use them as templates to set up your own charts in similar formats.
On the Transaction Setup page, define the WIP status codes that you want to use.
Defining WIP status codes classifies the WIP process into steps. You use those steps to define routing and
tracking in PeopleSoft Workflow.
The WIP status code tells PeopleSoft Workflow when and where to send data to the next step of the
request/approval cycle or other type of cycle. When reviewers change the WIP status of a request, the
PeopleSoft Workflow process that you link to a status ensures that the action goes through all of your
agency's review levels and keeps it going until it is completed as an actual event.
The status type tracks the requests and tells related processes when to add data rows.
On the Batch Programs page, specify the WIP status and type for related processes.
During processing, the identified process creates a new database row for the specified status type and
enters the associated WIP status.
In the Approval Flow component, associate components with WIP activities and further specify the WIP
status processing, workflow routing, and other component-level processing controls for each WIP activity.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 809
(USF) Setting Up the Work-in-Progress Management System Chapter 32
This table lists and describes the WIP status codes and the users who assign them in the sample system.
WIP/PAR Status Code WIP/PAR Status Description Who Can Assign This Status
810 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
WIP/PAR Status Code WIP/PAR Status Description Who Can Assign This Status
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "(USF) Administering
Personnel Action Requests," Adding and Updating Data
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 811
(USF) Setting Up the Work-in-Progress Management System Chapter 32
812 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
EMPL REQST Employee Insert REQ EE_EMPL_REQ 1ST, 2ND, INI, REQ
Request COR, DIS,
PRO, INI,
REQ, RET,
SIG
SUP REQST Supervisor Insert REQ EE_SUP_REQ PRO, INI, INI, REQ
Request REQ
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 813
(USF) Setting Up the Work-in-Progress Management System Chapter 32
You can use all or some of the statuses that are delivered with the system, and you can use some of them
more than once in a process. For example, your agency might require two levels of authorization and two
levels of approval for processing a PAR. Or, as shown in the sample system, you might want two levels of
authorization and one level of approval.
Assign the appropriate WIP status type to each status. As a PAR travels along the path of approvals, it retains
the status type Work-in-progress until it is approved, at which time the status type would be Completed.
This table lists the available WIP status types with definitions indicating when you would use each:
Work-in-progress The request hasn't reached the final level of approval. The personnel
action information resides only in the Federal PAR component and
is not applied (pushed) to core records and components.
814 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
See Also
Chapter 32, "(USF) Setting Up the Work-in-Progress Management System," Sample WIP Status Codes, page
810
Chapter 32, "(USF) Setting Up the Work-in-Progress Management System," Sample WIP Status Types and
Related Status Codes, page 811
Chapter 32, "(USF) Setting Up the Work-in-Progress Management System," Defining WIP Status Codes and
Associating Status Types, page 809
Transaction Setup GVT_WIP_RECORD1 Set Up HRMS, Product Define WIP statuses and
Related, Workforce associate status types for the
Administration, Workforce USFED or Federal eApps
Data USF, Approval transactions.
Transactions, Transaction
Setup
Select USFED as the
Transaction value in the
search page.
Select any other value
starting with FE_ for
Federal eApps for Self
Service transactions.
Batch Programs GVT_WIP_RECORD2 Set Up HRMS, Product Specify WIP status and type
Related, Workforce Data for related batch processes.
USF, Approval
Transactions, Batch Note. This page appears
Programs only for the USFED
transaction.
Select USFED as the
Transaction value in the
search page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 815
(USF) Setting Up the Work-in-Progress Management System Chapter 32
Because the WIP setup is delivered with your system, we describe the page controls that appear on this page
as they apply to our sample database. You can change the values in the USFED transaction to correspond to
the setup that you require for your agency.
WIP Status Label Enter a WIP status label. This label is for referencing the WIP status on various
human resources pages. For example, for referencing the WIP status on the
Administer Workforce request pages, the label in our sample system is Par
Status (personnel action request status).
Avail to Manager Self- Select this option only when setting up approvals for self-service transactions.
Service(available to
manager self-service)
Effective Dated Record Select if the record is to be effective-dated. This must be selected for the USFED
transaction.
816 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
WIP Status (work-in- Add or modify the three-character status codes as necessary. Each WIP status
progress status) represents a step in the approval process.
Description and Short The system displays the description or short description on HRMS pages when
Description you select the three-character PAR Status that corresponds to the WIP status.
Allow Row Insert Select this option if you want users to be allowed to insert a new row from a
personnel transaction with the selected status.
For example, the Data Control page in Administer Workforce enables users to
enter new effective-dated rows and add new data, creating a history of the
changes. These types of pages are part of the WIP processing pages and depend
on the WIP control configuration to designate the WIP status in which a user can
enter a new row.
Status Type Select the status type to be linked to the WIP status. Valid status types are:
Work-in-progress.
Completed.
Canceled.
Corrected.
In this group box, enter details related to printing forms from a page with the selected status.
SF-52 Print Area Select the area where the name is to appear on the actual form; for example, Part
A - Box 6: Authorized By.
Allow SF-50 Print Select if you want the SF-50 button to be enabled. This allows the SF50 form to
be printed for a personnel transaction with this status.
Continue reviewing and modifying data in the delivered data rows on the page. Add additional data rows if
required.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 817
(USF) Setting Up the Work-in-Progress Management System Chapter 32
Program Enter the name of the SQR, COBOL, or Application Engine process that inserts a
new row. The row that the system inserts is the highest effective-dated row with
the status type that is specified in the Status Type field on this page.
Add rows as necessary to add programs.
Status Type Specify the status type for which a new row is to be inserted by the program.
Options are as follows:
Completed: The system searches for both Completed and Corrected.
WIP Status Select the WIP status to be inserted on the new row.
Example
For example, based on the exhibit above, the FGHR002B process inserts the highest effective-dated row with
the status type Completed and displays PRO (Processed by Human Resources) in the WIP Status field.
818 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "(USF) Processing
Automatic Actions for Probation, Tenure, and WGIs"
Define WIP statuses for approval steps for federal self-service transactions.
Component Defaults page GVT_WIP_PGRP_SEC Click the Component Select component defaults
Defaults button on the WIP for action, reason, NOA,
Activity 1 page for the and legal authority.
USFED transaction.
WIP Activity 2 GVT_WIP_ACTVTY2 Set Up HRMS, Product Specify valid WIP status
Related, Workforce values, workflow routing,
Administration, Workforce and PAR tracking for each
Data USF, Approval Flow, combination of WIP activity
WIP Activity 2 and component.
Select USFED as the
Transaction value in the
search page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 819
(USF) Setting Up the Work-in-Progress Management System Chapter 32
Define Steps GVT_WIP_ACTVTY4 Set Up HRMS, Product Associate WIP statuses with
Related, Workforce steps in the approval
Administration, Workforce process for federal self-
Data USF, Approval Flow, service transactions.
Define Steps
Note. You cannot associate
Select a transaction WIP statuses with approval
beginning with FE as the steps for federal self-service
Transaction value in the transactions until your
search page. approval process has been
defined. Use the Approval
Workflow Engine (AWE) to
define the approval process.
820 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
WIP Activity Enter the activity for which you are defining controls.
WIP Status Select the default WIP status that appears on the respective component's Data
Control page when you insert a new effective-dated transaction row, or when you
are in Add mode.
Allow Row Insert? For effective-dated records only. Select to permit users to insert rows using this
WIP activity.
Allow Row Delete? For effective-dated records only. Select to permit users to delete rows using this
WIP activity.
Insert Status Specify the status types from which row insert is permitted.
Select the WIP status codes to include in search records. The search records for the components that are
linked to this activity retrieve only employees with rows that contain a WIP status that matches what is in this
table.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 821
(USF) Setting Up the Work-in-Progress Management System Chapter 32
Select the components that the WIP activity uses to perform the actions. An activity (for example, a request)
can have more than one component associated with it. For example, the components for Employee Request
(EE_EMPL_REQ) and Supervisor Request (EE_SUP_REQ) are request-like activities and can be included
under the Request activity.
Self Service Select if the component is a self-service component. When this option is selected,
the component automatically inserts a row when it is initialized. This is like
adding a new row.
All Job Actions Valid? Select if all job actions are valid for this component.
Component Defaults Click this button to access the Component Defaults page, where you enter the
valid job action, reason, NOA code, and legal authorities.
Select the values that the system enters by default in the component for this WIP activity.
822 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
This scroll area contains a row for each component listed for the WIP activity on the WIP Activity 1 page.
The statuses that you specify in this group box are the only statuses available for selection in the WIP Status
field on the PAR (personnel action request) pages in the component.
Bus Proc (business The Bus Proc, Activity, and Event Name fields are signals for PeopleSoft
process), Activity, and Workflow. These entries govern the routing of the action through the various
Event Name PeopleSoft Human Resources business processes.
To modify the routings, you create a new business process activity and event in
PeopleSoft Application Designer. On this page, you insert the name of the new
process and define its routing. The system retrieves the name of the process from
this table and triggers that event when the user saves the activity with the WIP
status that you have designated.
Prompt for Route to Select to specify the routing prompt list views that are to be used on the prompt
Next? page.
When you select this option, the Using and Routing Text fields appear, where
you enter the parameters for the routing process.
Using A prompt page appears when the user saves the component if you have set up the
activity with Prompt for Route to Next? selected for the component. On the
prompt page, the user selects from the list of employees who are in the result set
of the view that you select in the Using field on the WIP Activity 2 page. The
user selects an employee from the results set to whom to route the request for the
next level of approval.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 823
(USF) Setting Up the Work-in-Progress Management System Chapter 32
Routing Text. Specify the verbiage your users will see when prompted with the option of
routing this personnel action.
Default Sequence Select the default sequence of a WIP status in PAR tracking.
WIP Status Select the WIP status for the sequence you are defining.
Action Reason
The Action Reason group box appears only if the All Job Actions Valid? option is deselected on the WIP
Activity 1 page for the combination of activity and component. The Action and Reason Code values you
select here control what values are available from the Action/Action Reason prompts when administering the
PAR using the component and activity.
824 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 32 (USF) Setting Up the Work-in-Progress Management System
Action Enter the action for the selected activity and component.
Reason Code Select a valid reason code for the selected activity and component. Only reason
codes appropriate to the selected action are available.
All fields on the page are unavailable for data entry if the WIP status is not one of the values selected here for
the activity the user is in.
WIP Status Select the WIP statuses that enable data input in the component.
Status Field Only? Select if only the status field is available for entry. Use this option when a
reviewer is allowed to change the WIP status but is not allowed to change the
underlying data in the action.
When you search for transactions that begin with FE, the system accesses the Define Steps page rather than
the WIP Activity pages for approval setup. The PeopleSoft Enterprise eProfile PeopleBook documents this
page in detail.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 825
(USF) Setting Up the Work-in-Progress Management System Chapter 32
See Also
PeopleSoft Enterprise eProfile 9.1 PeopleBook, "(USF) Setting Up Approvals," Associating WIP Statuses
With Approval Steps and Actions.
PeopleSoft Enterprise eProfile Manager Desktop 9.1 PeopleBook, "(USF) Managing Direct Reports"
826 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 33
Set up HRMS security giving HelpDesk agents access to the data of the people they will be serving.
Set up the direct report structure for the managers in your organization.
See Also
Personal
Job
Position summary
Payroll summary
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 827
Setting Up PeopleSoft HelpDesk for HR 360 View Chapter 33
Benefits summary
Direct reports
There are three levels of HR HelpDesk Agents in the CRM database Level 1, Level 2 and Level 3. Level 1
and Level 2 Agents cannot access certain HRMS pages through the Action Links. Besides, the Level 1 Agent
can only view the HRMS pages but cannot make changes. The following table shows the pages that each
agent can access in HRMS database.
828 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 33 Setting Up PeopleSoft HelpDesk for HR 360 View
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 829
Setting Up PeopleSoft HelpDesk for HR 360 View Chapter 33
PeopleSoft HelpDesk for HR can only retrieve the appropriate reporting structure for a person if you have set
up the access type on the Direct Reports Setup page.
Target Information SS_LINK_TBL Set Up HRMS, Common Set up the access type for
Definitions, Direct Reports the
for Managers, Direct HD_360_COMPONENT.
Reports Setup, Target
Information
1. Access the Direct Reports Setup component (Set Up HRMS, Common Definitions, Direct Reports for
Managers, Direct Reports Setup) and select the component HD_360_COMPONENT.
2. On the Target Information page choose the Access TypeBy Supervisor Id.
830 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34
Review transactions.
Note. PeopleSoft delivers two different workflow technologies for self-service transactions. Delivered self-
service transactions with workflow are preconfigured for either the Approval Framework or the technology
described in this chapter.
See Also
This section provides an overview of rules for self-service transactions and discusses how to:
Note. If the self-service transaction uses the Approval Framework for approval processing, you must also set
up the transaction for use with that engine and its framework.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 831
Setting Up and Working with Self-Service Transactions Chapter 34
See Chapter 27, "Setting Up and Working with Approvals," page 659.
Updates the database or sends a notice to the administrator to complete the transaction manually.
Notifies a specific person when problems occur during the processing of the transaction or when a
transaction successfully completes.
This table lists the configurable transactions and indicates the approval and delegation features that are
delivered active for each:
Address Change
Marital Status
Name Change
Promotion Yes (Approval Framework) Yes (Approval Framework) Yes (Approval Framework)
Training Enrollment
Transfer Yes (Approval Framework) Yes (Approval Framework) Yes (Approval Framework)
832 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
You can change the delegation setting for any transaction on the Workflow Transactions page. For workflow
that does not use the Approval Framework, you can enable transactions for delegation initiation, but not for
delegation approval.
See Chapter 28, "Setting Up and Working with Delegation," page 707.
Transactions that use the Approval Framework functionality and the delegation functionality require
additional configuration. PeopleSoft delivers these transactions preconfigured for using these functionalities.
This diagram maps out the process a self-service transaction takes when the transaction is set up to follow the
configuration rules:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 833
Setting Up and Working with Self-Service Transactions Chapter 34
834 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Note. If the transaction uses the Approval Framework and an appropriate user is not found, the system
automatically routes the transaction to the Approval Framework administrator for review and approval. If an
appropriate user is not found for a transaction that does not use Approval Framework for workflow, the
system sends an error notification to the administrator who can view the error using the Self-Service Inquiry
page. If you enter an alternate user on the General Profile Information page, make sure the User ID entered
has permission to access the necessary pages.
Some transactions update the worker's job data. These self-service rules cannot override information
controlled by Position Management.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 835
Setting Up and Working with Self-Service Transactions Chapter 34
Admin Notification Setup WF_HR_TRANS_NOT Click the Notification Setup Defines if an administrator
link on the Workflow should receive email
Configurations page. notification when automatic
update was successful or
there were warning
messages issued during the
update.
SS Component Interface SS_TRANS_CIDTL_SEC Click the Component Defines the name of the
Setup Interface Setup link on the component interface used
Workflow Configurations by the transaction and
page. location of error and
warning messages.
836 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Note. (USF) This page is not used for U.S. federal self-service transactions, which never update the HR tables
directly. Instead, federal transactions go through intermediate Personnel Action Request (PAR) tables, where
an HR administrator completes a final approval outside of the standard approval process.
Description Lists the self-service transaction delivered with the system that is designed to
work with the Process Configuration process.
Approval Process? This check box is only available to those transactions designed to use an approval
process. If selected, the system requires Manager level approval. If not selected,
manager level approval is not required.
Note. Transactions that use the Approval Framework require additional approval
configuration.
See Chapter 27, "Setting Up and Working with Approvals," page 659.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 837
Setting Up and Working with Self-Service Transactions Chapter 34
Allow DB Update (allow If selected, this check box allows the transaction to update the database. If not
database updates) selected, an administrator will be notified of the change and need to complete the
process request. Administrators can complete the request on the Workflow
Inquiry page or in the Self-Service transaction pages.
Administrator Role Identifies the role of the person who is responsible for reviewing the results of
the transaction if errors occur.
If Notify on Success or Notify on Warnings is selected on the Admin
Notification Setup page, this role receives notifications when processing is
successful or warnings are encountered.
Notification Setup Click this link to access the Admin Notification Setup page.
Component Interface Click this link to access the SS Component Interface Setup page.
Setup
See Also
Notify on Success Applicable only if Allow DB Update is selected on the Workflow Configuration
page. Select to have the role selected on the Workflow Configuration page
receive an email when automatic updates are successful.
Notify on Warnings Select to have the role selected on the Workflow Configuration page receive an
email when warning messages are generated during a successful HR database
update.
838 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Business Process Name, This is predefined system data that can be changed if you want to use a different
Activity Name, and business process.
Event Name
Note. You do not need to modify this page unless you use component interfaces or exception tables that you
have created or modified. This is predefined system data that can be changed if you want to use a different
component interface.
Reviewing Transactions
This section discusses how to review transaction activity.
Note. Use the Approval Monitor to review transactions that use the Approval Framework.
See Also
Chapter 27, "Setting Up and Working with Approvals," Administering Approvals, page 694
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 839
Setting Up and Working with Self-Service Transactions Chapter 34
Required Search Fields To see the activity for a specific worker enter the ID in the Empl ID field. Make
sure to tab out of the field.
To see the transaction activity, select the transaction name in the Transaction
Name field.
Optional Search Field To see the activity for transaction that occurred on a specific date, enter the date
in the Date field.
To select activity with a specific status, select the check box next to the name of
the status. You can select one or more statuses.
Search Click this button to find transactions that match the search criteria. Results
display below the Search button.
Clear All Click this button to clear all search criteria or search results on the page and start
a new inquiry.
Search Results
Information about the transaction appears below the search area. Click the various tabs to display information
relevant to the transaction:
840 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Click the Errors or Warnings links to display error and warning messages.
Click the Go To link to display the component page relevant to the transaction.
Note. The Approval Workflow Engine (AWE) provides its own approval monitor that you can use to review
and, if necessary, perform certain administrative actions for approval transactions. The pages described in this
section provide additional administrative capabilities, including the option to review transactions that predate
the use of AWE processing for federal self-service transactions.
See Also
Chapter 27, "Setting Up and Working with Approvals," Administering Approvals, page 694
<Transaction Name> <Various> Click the View Detail link Review detailed transaction
for a transaction on the information, and take
Workflow Inquiry (USF) administrative action for
page. certain transactions.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 841
Setting Up and Working with Self-Service Transactions Chapter 34
Search Criteria
Transaction Name, To see the activity for a specific transaction type, request date, or employee, enter
Request Date, and the appropriate search criteria in these fields.
Employee ID
Workflow Status
To get search results, you must select at least on of these check boxes; only transactions with selected statuses
are included your search results.
Error With Processing An approved AWE transaction encountered an error with the component
interface that pushes the transaction data to the U.S. federal PAR tables.
See PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer
Workforce, "(USF) Administering Personnel Action Requests."
Error With Approval An AWE transaction encountered a routing error. To review and address the
Routing error, you must use the AWE approval monitor (the Monitor Approvals page).
842 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Manually Entered into The transaction was approved and an administrator manually entered the
PAR transaction into the PAR tables.
This occurs for the full-time/part-time change, location change, and reporting
change transactions. These transactions cannot be automatically pushed to the
PAR system because they are position-controlled: changes are made to the
position and then propagated out to the persons in the positions
Automatically sent to The transaction was approved and the system automatically pushed the data into
PAR the PAR tables using a component interface.
Search
Search Click this button to access a list of self-service approval transactions that meet
the specified criteria.
Search Results
Search results are grouped into transaction-specific grids. The grids display basic transaction information
such as the employee name and ID and the date of the transaction. The grids also display the following
approval processing columns:
Status Displays the status of the transaction. The statuses are the same as the status
check boxes in the Search Criteria group box.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 843
Setting Up and Working with Self-Service Transactions Chapter 34
PAR Result Indicates whether the transaction has been sent to the PAR tables.
Not Applicable: The transaction is still in the approval process and, until it is
approved, it cannot be sent to the PAR tables.
This value is used only for transactions that are normally sent to the PAR
tables automatically.
This value is used for the three position-based transactions that require a user
to manually enter data into the PAR tables: location change, reporting
change, and full time/part time change.
In Process: The transaction has been sent to the PAR tables and is awaiting
HR action.
Complete: The transaction has been sent to the PAR tables, and HR personnel
have finalized the transaction.
Denied: The transaction was sent to the PAR tables, and HR personnel have
denied PAR approval.
Go to HR Processing Click this link to access the HR Processing USF component where the HR
Personnelist reviews and finalizes the approved transaction.
View Detail Click this link to access a detail page that displays more information about the
transaction, including:
The specific data change that the user requested (for example, the previous
and new marital status).
Information about the approval process, including the status of each approval
step.
Note. The page name and certain field vary depending on the transaction type.
844 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
At the top of the page, you can see the previous and new values for the requested data change. The specific
fields that appear depend on the type of transaction.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 845
Setting Up and Working with Self-Service Transactions Chapter 34
PAR Values
This group box displays data that will be written to the PAR tables for this transaction. This data is not
provided by the self-service user; instead, you use the Defaults/Admin setup page to provide transaction-
specific default values for each field.
See PeopleSoft Enterprise eProfile 9.1 PeopleBook, "(USF) Setting Up Approvals," Defining PAR Tracking
Data.
When transaction approvals are processed using AWE, the transaction details page includes a graphical
representation of the approval flow.
The approval chain diagram includes a box for each approver. The box title shows the approver's status, while
the box contents include the approver's name, the approver's role in the approval process (for example, First
Authorizer), and the date, if any, when the approver took action on the approval request
When the transaction predates the use of AWE to manage approvals for federal self-service transactions, the
approval steps appear in a grid rather than as a graphical representation of the approval flow.
This grid lists each approver by role and by name and displays the action (if any) taken by the approver, the
date the action was taken, and any comments entered by the approver at the time the action was taken.
PAR Result
PAR Result (Personnel Displays a message that corresponds to the PAR Result field on the Workflow
Action Request Result) Inquiry (USF) summary page.
Administrator Actions
Current Transaction Displays a message that corresponds to the Status field on the Workflow Inquiry
Status (USF) summary page.
Select this option as the This check box and the Save button appear only if the current transaction status is
request cannot be Error with CI. Select the check box to acknowledge that you know you must
completed via Self- manually enter the request into PAR, then click the Save button.
Service. You will be
required to manually
enter the request into
PAR
846 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Go to HR Processing Click this link to access the HR Processing USF component where the HR
Personnelist reviews and finalizes the approved transaction (and where you
manually enter the transaction data if necessary).
This link is not available if the current transaction status is Error With Approval
Routing because such errors must be addressed in the AWE approval monitor
(the Monitor Approval page).
Note. If you are setting up direct reports data for ePerformance or eProfile, use the pages documented in the
"Working With Common Components" chapter.
See Chapter 35, "Working with Common Components," Configuring Direct Reports Functionality, page 858.
Target Information SS_LINK_TBL Set Up HRMS, Common Set up worker data access
Definitions, Direct Reports for the Manager self-service
for Managers, Direct option.
Reports Setup, Target
Information
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 847
Setting Up and Working with Self-Service Transactions Chapter 34
Configure Direct Reports HR_DR_UI_CFG_1 Set Up HRMS, Common Select the ePerformance or
UI Definitions, Direct Reports eProfile transaction that you
for Managers, Configure want to configure for direct
Direct Reports UI reports or user interface
behavior.
See Chapter 35, "Working
with Common
Components," Configuring
Direct Reports
Functionality, page 858.
Configure Direct Reports HR_DR_UI_CFG_2 Click the Configure button Configure direct reports or
UI for the selected transaction user interface behavior for
on the Configure Direct ePerformance or eProfile
Reports UI component self-service transactions.
page.
See Chapter 35, "Working
with Common
Components," Configuring
Direct Reports
Functionality, page 858.
You determine a user's access to some or all of the manager self-service components when you define their
component access on the Permission List page. In the Direct Reports Setup component, you specify whose
data a user can see for a particular manager self-service transaction.
The system determines what kind of reporting relationship exists between managers and their staff. Reporting
relationships are determined on two pages: the Work Location page (JOB_DATA1) and the Department
Profile page (DEPARTMENT_TBL_GBL). On the Work Location page, you indicate who a worker's
manager is. On the Department Profile page, you indicate who manages a department and the staff who report
to that department.
Note. This section does not apply to the manager role in PeopleSoft Enterprise Talent Acquisition Manager.
848 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
See Also
Chapter 11, "Setting Up Organization Foundation Tables," Setting Up Primary Permission List Preferences,
page 312
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Increasing the
Workforce," Entering Employee Job Location and Position Information
Chapter 11, "Setting Up Organization Foundation Tables," Defining Basic Information About a Department,
page 300
Note. If you are setting up direct reports data for ePerformance or eProfile, use the pages documented in the
"Working With Common Components" chapter.
See Chapter 35, "Working with Common Components," Configuring Direct Reports Functionality, page 858.
Note. To determine technical names of the system objects, use PeopleSoft Application Designer.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 849
Setting Up and Working with Self-Service Transactions Chapter 34
Component Name Enter the component name as defined on the menu in PeopleSoft Application
Designer.
The component name is the name of the Select Employee page that the system
displays when the user selects a Manager self-service transaction. It isn't the
name of the transaction component.
Menu Name Select ROLE_MANAGER. All Manager self-service transactions are delivered on
this menu. To grant manager access to components on other menus, select the
name of the menu that the component is on.
Menu Bar Name Select the name of the menu bar that the transaction component is under.
Item Name Enter the component's item name. The item name is the system name of the
transaction component, not the component name of the Select Employee page.
The transaction component contains pages that the manager uses to view or
manipulate staff data.
Page Name Enter the object name of the transaction component's page. The object name for
each Manager self-service transaction is listed in the introduction table of the
page discussion.
If a transaction component has more than one page, enter the name of the
transaction page that the system displays first (usually the first page in the
component) when a user selects a person name.
Access Mode Select which action the user performs in the transaction. Options are Add,
Update/Display, Update/Display All, and Correction.
Record (Table) Name Enter the object name of the record that makes up the page of the transaction
component.
850 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Access Type This field defines the reporting relationship used by the Select Employee page for
this transaction component. Available options are:
By Department Manager ID: Defines the reporting relationship based on
information in the Manager ID field on the Department Profile page. For
users who are department managers, the system displays a list of the workers
who are in the user's department.
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 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.
Update Own Info Not applicable to self service. Select to allow managers to update their own
(update own information) information in this transaction component.
See Also
Chapter 5, "Setting Up and Administering HRMS Security," Creating and Modifying Security Trees, page 85
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 851
Setting Up and Working with Self-Service Transactions Chapter 34
Title Message Set and Enter the title message set and number of the transaction instructions title that the
Title Message Number system displays on this component's Select Employees page.
Message Text Displays the text of the transaction instruction title that is associated with the
Title Message Number. The system displays this text on this component's Select
Employees page.
Instructions Message Set Enter the number of the instructions message set and number for the instruction
and Instructions message that the system displays on this component's Select Employees page.
Message Number
Explain Displays the text of the instruction message that is associated with the
Instructions Message Number. The system displays this text on this component's
Select Employees page.
Tells the user how to select the employees whose data they want to view or
manipulate.
852 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
See Also
Worklist System Defaults WF_SYS_DEFAULTS PeopleTools, Workflow, Set default parameters for
Defaults & Messages, Set workflow messages.
Workflow Defaults,
Worklist System Defaults
Workflow Transaction EO_TRAN_CATS Set Up HRMS, Common Defines the category for
Categories Definitions, Self Service, self-service transactions.
Transaction Categories, Generally, all self-service
Workflow Transaction transactions are assigned to
Categories HR_TRANSACTIONS.
This data is supplied by
PeopleSoft and it is
recommended that you not
change this information.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 853
Setting Up and Working with Self-Service Transactions Chapter 34
System Workflow Rules EO_SYS_WF_RULES Set Up HRMS, Common For every SetID where you
Definitions, Self Service, plan to use workflow, set
System Workflow Rules, the rules for workflow
System Workflow Rules notification.
Workflow User Preferences HR_SS_WF_EE_PREF Self Service, Workflow Set up a user's notification
User Preferences, Workflow method for workflow
User Preferences messages.
854 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 34 Setting Up and Working with Self-Service Transactions
Make sure the Worklist Active,Email Active, and HR Installed check boxes are selected.
For different rules to exist for different business units, specify these rules at the SetID level.
Note. You must specify this information when you implement PeopleSoft HRMS.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 855
Setting Up and Working with Self-Service Transactions Chapter 34
Workflow Rule Define how the system notifies users when they're required to perform a function.
Values include:
Email: Notify the user via email.
None: No notification.
User: Enable the user to define a preference. The user specifies preferences
on the Workflow User Preferences page.
Notify User - Entry Select if users are to receive confirmation when initiating transactions.
Notify All Select if users are to be notified each time someone processes one of their
transactions.
Notify - Final disposition Select if users are to be notified when the final disposition has been made for the
request.
See Also
856 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35
Configure attachments.
Note. PeopleSoft Human Resources also delivers as common components the approval workflow, delegation,
and XML publishing functionality. These features are discussed in their respective chapters.
See Also
Object Owner ID Identifies the application in which a common component is used. This is
delivered functionality.
Sub ID (sub application Used to further partition component entries by function. . For example, the Sub
ID) ID of M (Manager) allows component entries different from those of a Sub ID of
E (Employee).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 857
Working with Common Components Chapter 35
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, an application such as eRecruit,
ePerformance or Benefits Administration).
Data Structures
Each common component manages its own data source. These common components have keys. 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 manipulate these configuration options inside the plug-in's configuration pagethe same place
it registers its keys.
HCM plug-ins, except for 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.
This section provides an overview of direct reports and discusses how to:
858 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Select the actions and fields that appear on the direct reports UI.
See Also
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 for implementing 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 de-coupled from data service. It receives
information from the data service and presents it in a streamlined, consistent, reusable UI that enables
users to visually navigate an organizational structure and select one or more workers for processing.
There are two methods of setting up direct reports functionality. If you are setting up direct reports for the
following applications, use the Direct Reports Setup (SS_LINK_TBL) component:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 859
Working with Common Components Chapter 35
Note. Otherwise, use the Configure Direct Reports UI component described in this section.
See Also
Chapter 34, "Setting Up and Working with Self-Service Transactions," Setting Up Access to Direct Reports
Data, page 847
Manager Desktop HR_DR_UI_CFG_2 Click the Configure button Select the actions and fields
Transactions - Configure for an application on the that appear on the direct
Manager Desktop reports UI for a transaction.
Transactions page.
Invoke Direct Reports API - HR_DRPT_API_EXEC Set Up HRMS, Common Test the direct reports API.
Set / Execute Definitions, Direct Reports
for Managers, Invoke Direct
Reports API, Set / Execute
Invoke Direct Reports API - HR_DRPT_API_RSLTS Set Up HRMS, Common View the exceptions and
Execution Results Definitions, Direct Reports data returned by a method.
for Managers, Invoke Direct
Reports API, Set/Execute
Select the Execution Results
tab on the Invoke Direct
Reports API - Set/Execute
page.
Invoke Direct Reports API - HR_DRPT_API_TRACE Set Up HRMS, Common View the trace log of a
Trace Results Definitions, Direct Reports method execution.
for Managers, Invoke Direct
Reports API, Set/Execute
Select the Trace Results tab
on the Invoke Direct
Reports API - Set/Execute
page.
Invoke Direct Reports UI HR_DRPT_API_UITEST Set Up HRMS, Common Test the direct reports user
API Definitions, Direct Reports interface.
for Managers, Invoke Direct
Reports UI API, Invoke
Direct Reports UI API.
860 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
<application context> HR_DR_ADDL_INFO Select a value from the Enter a date to use to
Component Name field and generate a list of direct
click Execute API on the reports to invoke the
Invoke Direct Reports UI specified application
API page. context.
<application context> - HR_DR_SELECT_EMPS Click Continue on the View a list of direct reports
Select <context> <application context> and select employees to add
(HR_DR_ADDL_INFO) to the API Results list on
page. the Invoke Direct Reports
UI API page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 861
Working with Common Components Chapter 35
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 Manager Desktop Transactions - Configure page (Click the Configure button for an application on
the Manager Desktop Transactions page).
862 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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 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.
Update Own Info Select to indicate that the user can update their own records. When you select this
check box, the manager's information is returned in the direct reports 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.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 863
Working with Common Components Chapter 35
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.
Allow Empty Position Select to return unfilled position reports. This check box is available when you
select one of the position-related options as an access type.
Select Multiple Select to enable the user to select more than one worker from the search results.
Employees 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 as delivered might not work.
Displayed Fields
Select one or more fields to appear within the direct reports list when rendered by the application.
See Also
Chapter 34, "Setting Up and Working with Self-Service Transactions," page 831
864 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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 a worker/job.
DrillUp()
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).
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.
Execute Method Click to execute the method using the class properties you set.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 865
Working with Common Components Chapter 35
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.
Navigation Method Select the method to use when determining reporting relationships. The options
are: 1 - Department Security Tree,2 - Supervisor ID,3 - Department Manager ID,
4 - Reports To Position,5 - Position / Supervisor ID,6 - Position / Dept Manager,
and 7 - Group ID.
Target Empl Record Enter the employee record number of the target employee.
Show Name Indicate if the system should include employee names in the Direct Reports
Rowset grid. The default value is True.
Show Empty Positions Identify whether unfilled positions should be returned in the Direct Reports
Rowset grid when the navigation method is position-based. The default value is
False.
Show Indirect Indicator Identify whether the Direct Reports Rowset grid should indicate whether an
employee has direct reports. The default value is False.
Include Target Should the target employee be filtered out of the returned Direct Reports Rowset
Employee and Supervisor Rowsets grids. When True, the target employee is not filtered out.
When False (which is the default), circular reporting relationships are not shown.
LimitDrillUp Indicate if the user be allowed to DrillUp to a level higher than the target
employee/job that was first specified. For example, when used in a manager self-
service transaction, should I be able to drill down 2 levels, and then up 3 levels to
expose and select my peers? On the other hand, when used in a notification
process, drilling up beyond the initial target employee/job is essential. When
True (which is the default), DrillUp is limited.
Combine Partials Indicate, when using one of the partial position management navigation methods,
whether the secondary method be applied even if the primary method returns
valid data. The default value is True.
Rebuild Group Specify, when the Navigation Method is Group ID, if the system should force the
group to be rebuilt, even if group results for this effective date already exist.
866 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Buffer Indicate if the service should buffer the next level up and down to increase
performance. The default value is False.
Trace Indicate if the service should generate a trace of processing when executing class
method. The default value is False.
Debug Mode Specify, when Debug Mode = True, if any exceptions encountered during
execution should be displayed prior to the results set being displayed.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 867
Working with Common Components Chapter 35
Data appears on this page only if you select True for the Trace class property.
868 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
The testing of this API shows the results set that the you will see based on the current configuration. To
populate the API Results grid, select a component name and click Execute API. The system will present you
with two additional <application context> pages where you will enter an as of date and then select employees
as of that date.
The example here shows the API Results values that were made by selecting Cynthia Adams from within the
application context Location Change component pages.
Access the <application content> page (HR_DR_ADDL_INFO) (select a Component Name and click
Execute API on the Invoke Direct Reports UI API page).
Access the <application content> - select page (HR_DR_SELECT_EMPS) [enter an as of date and click
Continue on the <application content> page (HR_DR_ADDL_INFO)].
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 869
Working with Common Components Chapter 35
Use this page to select the direct reports. The direct reports plug-in executes within the context of the
component and returns the results to the API Results grid on the Invoke Direct Reports UI API page.
This section provides an overview of simple person search and discusses how to:
870 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Configure Simple Person HR_PSS_CONFIG Set Up HRMS, Common Configure components for
Search Definitions, Person Search simple person search.
Match, Configure Simple
Person Search, Configure
Simple Person Search
Invoke Person Search API HR_PSS_TEST_API Set Up HRMS, Common Test simple person search
Definitions, Person Search within the context of an
Match, Invoke Person application.
Search API, Invoke Person
Search API
Person Search - Simple HR_PSS_SEARCH Select an Object Owner ID Search for and select a
value and click the Execute person.
API button on the Invoke
This page is invoked from
Person Search API page.
several calling applications.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 871
Working with Common Components Chapter 35
You select the options that govern how an application searches for and returns person information on the
Simple Person Search page within an application.
Max Rows (maximum Enter the maximum results rows to return to the calling application. Any rows
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, the user is prompted with a
message that the search returns more than the maximum number of people and
asks them to narrow the search.
Select Multiple Select to enable the user to select more than one person from the search results. If
Employees you select this field, a check box appears next to the names in the results list,
otherwise a radio button appears.
Alternate Character Select to enable the user to search for names by entering the search string in
Names 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 deselected
by default.
872 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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 only. This check box is selected by
default.
PerOrg(person Select one of these values to control how the person's relationship to the
organizational organization is used on the Person Search page:
relationship)
Hidden
Display Only
Enterable
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.
Persons of Interest Select to return other persons of interest, for example, retirees or job applicants,
in the search results.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 873
Working with Common Components Chapter 35
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.
Searching for and Selecting a Person from the Simple Person Search Results
Access the Person Search - Simple page (select an Object Owner ID value and click the Execute API button
on the Invoke Person Search API page).
874 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
This section provides an overview of the mouse over popup page and discusses how to:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 875
Working with Common Components Chapter 35
The PeopleSoft HCM application provides you with the flexibility to configure this mouse over popup page
in a way that is useful to you or other groups within your organization. You may want to set up a popup page
that includes employee information such as a picture, job title, department, supervisor's name, and work
location. Or, when performing certain business processes, you may find it beneficial to have a popup page
that includes contact information, such as an email for an employee or applicant. You can even associate this
email contact information with an icon that, by clicking, will initiate an email notification.
Create different mouse over popup page designs to associate with a specific product, feature, or user role; or
share the same design across multiple products. For example, you may want to view information regarding an
employee's benefit selections on one page while on another page you may find it more beneficial to view the
employee's holiday schedule.
Use the MouseOver Page Design component to identify mouse over IDs, which define the fields and number
of columns that should appear on a given mouse over popup page. The system delivers these three layout
designs that enable you to display pages differently:
Each column can include up to seven fields. However, when you include an employee's picture on the mouse
over popup page, the image will display in column 1 and no other fields will appear in that column.
876 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Note. PeopleSoft recommends that if you want to use a variation of one of these delivered mouse over IDs
that you insert a row in the MouseOver Page Design for the ID and use the Owner ID and Sub ID fields. Do
not modify the delivered value other than by inserting a row and using the owner field, since other
applications may be using the delivered value. Changes to the delivered ID can affect other application
currently using the mouse over ID.
Prior to creating your mouse over popup page designs, you must identify the fields that can be included on the
page in the MouseOver Field Definition component. The PeopleSoft application delivers these predefined
fields:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 877
Working with Common Components Chapter 35
PHONE (Phone)
Warning! Adding other fields is considered a customization and requires modifications to the Application
Package/Class (HR_MO_COMMON: SET_UP_COMMON) PeopleCode that is used to retrieve the data
associated with any new fields.
The majority of the setup for the mouse over popup page is done through delivered PIA setup pages in the
HRMS system. However, the Mouse Over Popup properties must also be set within the page field properties
within Application Designer by enabling the page popup and selecting the page layout, which is identified in
the MouseOver Page Design component, Suggested Popup Page field. When mouse over popup is set up, the
system places the mouse over indicator of a dotted underline under the field, which will initiate the popup.
Note. The Mouse Over Popup feature can be applied to many different pages within HCM as long as the
employee or applicant ID is located at level 0 in the record structure.
Important! When you have set up a page field property for use with the mouse over popup, and this page is
used in a component, the mouse over indicator will be present on the page. If this page exists in multiple
components and each of those components has not been properly setup then the user will receive a message
indicating so.
878 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
For more information about page levels and enabling mouse over popup pages, see Enterprise PeopleTools
PeopleBook: PeopleSoft Application Designer.
MouseOver Field Definition HR_MO_FLDNM_TBL Set Up HRMS, Common Define mouse over popup
Definitions, Mouse Over fields and supporting fields
Popup, MouseOver Field that will be available in the
Definition, MouseOver MouseOver Page Design
Field Definition component and can be used
with the mouse over popup
page.
Mouse Over Column 1 HR_MO_CL1_TBL Set Up HRMS, Common Create mouse over page
Definitions, Mouse Over designs by defining the
Popup, MouseOver Page fields for the first column of
Design, Mouse Over the mouse over popup page.
Column 1
Mouse Over Column 2 HR_MO_CL2_TBL Set Up HRMS, Common Create mouse over page
Definitions, Mouse Over designs by defining the
Popup, MouseOver Page fields for the second column
Design, Mouse Over of the mouse over popup
Column 2 page.
MouseOver Component HR_MO_COMP_SETUP_1 Set Up HRMS, Common Enable the mouse over
Setup Definitions, Mouse Over popup page for a
Popup, MouseOver component. Define the
Component Setup, components which will
MouseOver Component utilize the Mouse Over
Setup Popup feature. This setup
will define the popup type,
the mouse over ID to be
used with the component,
and the owner and sub
owner ID, if needed.
Person Detail HR_MO_COMP_SETUP_2 Click Person Detail on the Indicate the ID field to
MouseOver Component retrieve the mouse over
Setup page. page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 879
Working with Common Components Chapter 35
Define the fields that are configured for use with the mouse over popup page. There are 31 fields that we are
delivering with this feature. Adding any other fields would be considered a customization and will require
peoplecode modifications to the Application Package/Class (HR_MO_COMMON: SET_UP_COMMON)
that is used to retrieve the data associated with any new fields.
Note. Only the fields delivered as system data will be retrieved by the mouseover popup application class.
Any new fields added to the component require modifications to HR_MO_COMMON application package in
order to retrieve the data.
Field Name Define a field name that should be available for entry on the MouseOver Page
Design pages when creating the design of the mouse over popup page for the
user. The PeopleSoft application delivers several predefined fields for the mouse
over popup page.
See Chapter 35, "Working with Common Components," Mouse Over Popup
Page Layout and Design, page 876.
Label Define the default label name that will appear on the mouse over popup page.
The value you enter here will supply the default value for the Label field on the
Mouse Over Column 1 and 2 page but can be overwritten on that page.
880 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Show Display Field Select this check box to have the Display field appear on the Mouse Over Page
Design pages for this field. You use the Display field to specify whether the field
value on the mouse over popup page should display the code, the description, or
both the code and description for the user. For example, you can determine
whether to have the Department field display the department code of 11000, the
department description of Accounting, or both the code and description 11000
Accounting.
Show Type Field Select this check box to have the Field Type field appear on the Mouse Over
Page Design pages for this field. You use the Field Type field when the field can
have different types of the same data. For example, you may have a phone type
of Home,Business, or Other for a person.
Show Icon Field Select this check box to have the Icon ID field appear on the Mouse Over Page
Design pages for this field. You use the Icon ID field when the field can have an
image associated with a field. For example, you may want to have an email field
with an icon image that when selected will take the user to another window and
bring up their email software.
Note. The PeopleSoft application is set up to support email field icons. You will
need to make modifications to PeopleCode to use other types of software.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 881
Working with Common Components Chapter 35
Note. Set up the Mouse Over Column 2 page the same way you set up the Mouse Over Column 1 page with
the exception of the Owner ID / Sub ID Data fields. The Include Employee Picture check box and the Popup
Page field are available on the Mouse Over Column 1 page only. The Owner ID and Sub ID fields are display
only on the Mouse Over Column 2 page.
When creating a mouse over popup page, you can define fields to display in column 1 only, column 2 only, or
both columns 1 and 2.
Mouse Over ID Enter a mouse over ID that defines this unique mouse over popup page layout.
You will associate this code with each component that should use this mouse
over popup layout.
This level enables the system to display different items on the mouse over popup page for owners and sub
owners. You can have several different owner IDs and page structures associated with the same mouse over
ID.
Owner ID Enter an owner ID when there are different views of the same popup page for
different owners. For example, use this field when a group or applications want
to use the same mouse over ID but would like to change the data details of an
existing ID.
If you do not specify an owner id, the system uses the most recently effective
mouse over ID for the display of the page. When you associate the mouse over
ID with a component on the MouseOver Component Setup page, you can also
enter the owner ID to specify the unique mouse over popup page design for this
owner.
882 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Include Employee Select this check box to have the popup page display the employee picture, if
Picture available. When this check box is selected, the Column 1 fields are unavailable
for entry and the system displays a message that no other data will display in
column 1 other than the picture.
Note. This field is only available on the Mouse Over Column 1 page and will
display employee pictures only and should not be used for applicant mouse over
popup pages.
Sub ID Enter a sub owner ID in order for the system to display different views of the
same pop up page for the different sub owners.
If you do not specify an owner or sub owner id, the system uses the most recently
effective mouse over ID for the display of the page. When you associate the
mouse over ID with a component on the MouseOver Component Setup page, you
can also enter the owner ID and sub owner ID to specify the unique mouse over
popup page design for this owner or sub owner.
Suggested Popup Page Displays the name of the page layout upon saving the page and determines which
popup/layout to apply to the page in application designer when using the selected
mouse over ID. The page layouts identify a page with one column of data
(HR_MO_DSP_1_POP), a page with two columns of data
(HR_MO_DSP_1_2_POP ), or a page that displays an employee's picture and
one column of data (HR_-MO_DSP_P_2_POP ).
The fields in this grid box depend upon the Fieldname values you select and the supporting fields that you
selected for this field name on the MouseOver Field Definition page. The fields and field detail data you enter
on these pages determine how the system will display the mouse over popup page for the user.
Note. The system enables you to select up to seven field items per column.
Ord Seq (order sequence) Enter a sequence number up to 98 for any field name except for address fields,
which the system automatically assigns with the sequence number of 99. The
layout of the mouse over page puts address fields at the bottom of the column
because the system displays the address as two rows.
Fieldname and Field Select the fields that should appear on the mouse over popup page. Values are
Name defined on the MouseOver Field Definition page. When you enter a value in the
Fieldname field, the Field Name value displays. The grid displays additional
fields based upon the supporting fields that were selected on the MouseOver
Field Definition page.
Field Type Select a specific type of field value that should display when there may be more
than one option available. For example, select whether to show the business
phone number or the home phone number for the Phone field.
This field is available when the Show Type Field check box is selected on the
MouseOver Field Definition page for the field name.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 883
Working with Common Components Chapter 35
Display Identity how the system should display the field value to the user. You can
choose to show the field value code (CODE), the description of the field (DESC),
or display both the code and description in the field BOTH. For example, you can
have the system display the job code 290000, the description of the job Clerk, or
have the system display both 290000 Clerk.
This field is available when the Show Display Field check box is selected on the
MouseOver Field Definition page for the field name.
Label Enter the label name that should appear for the user. The field value is provided
by default from the MouseOver Field Definition page but can be overwritten on
this page.
Icon ID Specify the icon that should display for the user that will enable him or her to
click and initiate contact with the person. For example, the user can click an
email icon to have the system launch the email software The PeopleSoft
application supports this functionality for contacting a person through email.
This field is available when the Show Icon Field check box is selected on the
MouseOver Field Definition page for the field name.
Icon Text Specify text that should appear when the user places the mouse over the icon.
The default value comes from the icon ID description but can be overwritten
here. This field is available for entry after selecting a value in the Icon ID field.
884 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Component Name Identify the component that will utilize the Mouse Over Popup functionality.
Market Indicate the markets for the component. The mouseover popup key structure is
by component, however, when different markets exist with the same component
name you can differentiate them by market. For example, you differentiate
between the Canada and United States balance arrears components by entering
the market code of CAN in one row of the component name and USA in another
row of the component name.
MouseOver Popup Type Select the mouse over type that should be used within this component. Values are
Employee and Applicant.
Include Job Select this check box to enable the user to specify the employment record
number if the data retrieved through the popup should be based on a particular
employee record number. When you deselect this check box, the system uses the
employee's current effective job data.
Mouse Over ID Enter the mouse over ID that should be used in relation to this component. The
mouse over ID determines the look of the mouse over popup page, which is
defined in the MouseOver Page Design component.
Owner ID and Sub ID Enter an owner or sub owner ID when there are different views of the same
popup page for different owners. If you do not specify an owner or sub owner id,
the system uses the most recently effective mouse over ID for the display of the
page.
Person Detail Click this link to access the Person Detail page and enter the record name and
field name that will initiate the mouse over popup page.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 885
Working with Common Components Chapter 35
Note. The field properties for a page must be setup to use a mouse over popup page in the Application
Designer. When this is done the system displays the dotted lines under the ID, indicating that the Mouse Over
Popup functionality has been enable for the field. The system will display an error message if the component
that contains the page has not been properly setup in the MouseOver Component Setup component.
If the Include Job check box is not selected on the MouseOver Component Setup page, the system will only
these fields for entry.
Employee Record Name Enter the record in the selected component that the system will use to retrieve the
or Applicant Record employee or applicant information.
Name
Employee Fieldname or Specify the field from the record identified in the Employee/Applicant Record
Applicant Fieldname Name field that will invoke the mouse over popup page and retrieve the
employee or applicant information.
Important! The field that will be used to retrieve the applicant or employee information must be at level 0 in
the component and the Mouse Over Popup properties must also be set within the page field properties within
the Application Designer.
886 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
These fields appear when the Include Job check box is selected for the component on the MouseOver
Component Setup page when the mouse over popup type is Employee.
Job Record Name Enter the name of the record of the selected component that the system will use
to retrieve job related information specific to an employment record number.
Job Fieldname Enter the name of the field in the job record which the system will use to retrieve
job related information specific to an employment record number.
This section provides an overview of the HR Notepad and discusses how to:
You can integrate the plug-in application that maintains the HR 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 tertiary page for viewing note history. In
most cases, you can access the notepad pages when an application page displays the Maintain/View Notes
icon.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 887
Working with Common Components Chapter 35
The Maintain/View Notes icon enables users to access the notepad pages to enter
and view notes.
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.
HR Notepad Configuration HR_NP_CONFIG2 Click the Configure link for Set up the keys for storing
- Configure Keys an application on the HR notes.
Notepad Configuration -
Select Application page.
HR Notepad Configuration HR_NP_CONFIG3 Click the Configure Links Configure the links that
- Configure Links link on the bottom of the appear on application note
HR Notepad Configuration pages.
- Configure Keys page.
Note Pad Tester HR_NP_TEST_API Set Up HRMS, Common Test the notepad
Definitions, Text Catalog configuration.
and Notepad, Invoke HR
Notepad API, Note Pad
Tester
<application page> Notepad HR_NP_NOTE_SRCH Click the Maintain/View Access the notepad page to
Notes icon on an search for and enter notes.
application page.
Selected Note HR_NP_NOTE Click the Add a New Note Enter or update a note.
button or select the View or
Edit this Note link for an
existing note on the
<application page> Notepad
page.
Confirm Delete HR_NP_MESSAGE Click the Delete button on Confirm the deletion of a
the <application page> note.
Notepad page.
888 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Person Search - Simple HR_PSS_SEARCH Click the Transfer button on Transfer ownership of the
the <application page> selected note to another
Notepad page. person.
Object Owner ID and Select an object owner. The system will display the description of the object
Description owner.
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.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 889
Working with Common Components Chapter 35
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.
This page is for note pad key configuration and consists of six context key rows. Each row in the grid
supports one key configuration requirement.
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 search field in the UI.
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 Prompt
Table field.
Key Field Label Select the configurable label that will display on the page for this field.
Related Display Field Enter the field name for the prompt table that appears in the UI as a related field
for the value. This field is optional. If not specified, then there is no related-
display field for the context key. For example, you do not usually specify a
display field for a date or number context key.
890 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Hide Key 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
deselected 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 deselect 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 deselected by default.
Display on 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 deselected.
Clear Checked Rows Click this button after you have selected any context key rows for which you
want to clear from this configuration. The page will still display the row but the
prompt table and field information will be cleared.
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.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 891
Working with Common Components Chapter 35
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.
Menu 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.
Access the Item/Page tab on the HR Notepad Configuration - Configure Links page.
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.
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.
892 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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 valid sub ids for the application. The application keys that
appear correspond to the application keys (up to six) that you configure on the HR Notepad Configuration -
Configure Keys page.
Edit()
InvokeNotepad()
View()
Execute API Click to execute the API method with the keys you entered.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 893
Working with Common Components Chapter 35
Example of the Notepad page you access through the Job Data pages
Note. The fields that appear on the notepad page are determined by the notepad configuration.
Selection Criteria
Depending upon the configuration of a page, you may need to select a person to add or view notes.
Optionally, enter a Notes From and Through date.
Search Click to view a list of notes that meet the search criteria.
Add New Note Click to access the Selected Note page, where you can create a new note.
Existing Notes
This section displays if there are any notes that meet the search criteria. Click the link in the Subject column
to open the Selected Note page and view or edit an existing note.
894 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Delete Select one or more listed notes and click this button to remove them from the
system.
Transfer Select one or more listed notes and click this button to access the Person Search -
Simple page to transfer them to another person.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 895
Working with Common Components Chapter 35
Effective Date The note date for new notes is the effective date that appears on the page. You
cannot change the date.
Note. Changing the effective date of the record that is associated with the note
does not change the note effective date. As a result, the note becomes
inaccessible. For example, if you create a note for a job data row with a January
1, 2009 effective date, the note effective date is also January 1, 2009. If you use
correction mode to change the effective date of the job data row to January 20,
2009, the note effective date remains unchanged. When you view the notes for
the January 20 row of data, you will see only January 20 notes. Without a
January 1 row of data, the original note is inaccessible, and users will not see any
indication that the original note ever existed.
Subject Enter the note subject. This entry appears as the link in the Subject column of the
notepad page.
This section provides an overview of the text catalog, lists common elements, and discusses how to:
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.
896 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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 rowthe 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.
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 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 January 1, 1900.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 897
Working with Common Components Chapter 35
Configure Text Catalog: HR_SSTEXT_CFG Set Up HRMS, Common Configure the text catalog
General Definitions, Text Catalog for an application.
and Notepad, Configure
Text Catalog, Configure
Text Catalog, General
Configure Text Catalog: HR_SSTEXT_CFG Select the Key 1,Key 2,Key Designate keys that are used
Key 1 3,Key 4,Key 5, or Key 6 tab to store and retrieve text
on the Configure Text catalog entries.
Configure Text Catalog:
Catalog page.
Key 2
Configure Text Catalog:
Key 3
Configure Text Catalog:
Key 4
Configure Text Catalog:
Key 5
Configure Text Catalog:
Key 6
Maintain Text Catalog - HR_SSTEXT_HTML Click the View/Edit as View text catalog entries as
HTML View HTML link on the Maintain HTML.
Text Catalog page.
Text Catalog - View All HR_SSTEXT_ALLKEYS Click the View all effective View versions and context-
Keys dates and context keys for key entries for a particular
this Text ID link on the text ID and effective date
Maintain Text Catalog page combination by clicking the
or the Test Text Catalog view keys link for the
page. desired effective date.
Translate Text Catalog - HR_SSTEXT_LANG Set Up HRMS, Common Select and describe the
Descriptions Definitions, Text Catalog languages into which a text
and Notepad, Translate Text catalog entry is translated.
Catalog, Descriptions
898 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Translate Text Catalog - HR_SSTEXT_LANG2 Set Up HRMS, Common Enter translations for text
Catalog Text Definitions, Text Catalog catalog entries
and Notepad, Translate Text
Catalog, Catalog Text
Test Text Catalog HR_SSTEXT_TEST Set Up HRMS, Product Test the text retrieval for a
Related, ePerformance, text ID, using any
Text Catalog, Test Text combination of key values.
Catalog, Test Text Catalog
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 899
Working with Common Components Chapter 35
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.
Object Owner Identifier Select an object owner. The system will display the description of the object
and Description owner.
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.
900 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Note. The Key 2, Key 3, Key 4, Key 5, and Key 6 tabs are identical in appearance and usage to the Key 1
page (Set Up HRMS, Common Definitions, Text Catalog and Notepad, Configure Text Catalog, Configure
Text Catalog and access the appropriate key tab).
Key 1 (2, 3, 4, 5, or 6) Select the object name of the prompt table that defines the values by which the
Prompt Table 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 (2, 3, 4, 5, or 6) Select the field in the prompt table that contains the value that appears in the
Field Name prompt list for this key.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 901
Working with Common Components Chapter 35
Note. If you enter a value for the prompt table, you must also enter a value for the field name in the same
row.
The context keys that appear on this page are determined by the text catalog configuration for the application,
which will display up to six keys. 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 the author type of employees (E) and only when the
document status is in progress (IP).
902 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 903
Working with Common Components Chapter 35
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.
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.
904 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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.
Catalog Text
Access the Translate Text Catalog - Catalog Text page Set Up HRMS, Common Definitions, Text Catalog
and Notepad, Translate Text Catalog, Catalog Text).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 905
Working with Common Components Chapter 35
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.
906 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
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.
2. (Optional) Enter values for any key fields. The content keys that appear correspond to the application
keys (up to six) that you configure on the HR Notepad Configuration - Configure Keys page.
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.
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.
4. (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.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 907
Working with Common Components Chapter 35
The text entry that best matches the search criteria and context keys for the selected text ID appears.
Configuring Attachments
To configure attachments, use the Define Authorization (HR_ATT_AUTH), Define Authorization Entries
(HR_ATT_AUTH_ENT), Define Attachments (HR_ATT_CNFG), Configure Keys
(HR_ATT_KEYS_DFN), and Maintain Definitions (HR_ATT_DEFN) components.
Maintain definitions.
Understanding Attachments
The attachment feature enables you to attach files, notes, and URLs to a PeopleSoft Enterprise application.
An administrator can add URLs, common notes, and files to a component or page and enable others to view,
download and edit the attachments. Attachments include notes, PDF files, spreadsheet files, document files,
URLs, and so on. You can also define the types of attachments that users can add to a specific row of
application data, such as medical or adoption certificates, fitness for duty forms, and so on.
Although the types of attachments you can add to a page are essentially unlimited, attachments are
categorized as one of the following:
Attachments are any previously created electronic file that the administrator wants users to be able to
download.
Notes are free-form text that the user can enter through the attachment page in the PeopleSoft application.
Note. Only attachments and URLS are defined on the Define Attachments page. Notes are created by the user
through the attachment pages of the PeopleSoft application.
908 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Note. The Define Attachments page enables an administrator to create document definitions, as well as
attachments and URLs. Document definitions are types of files that users can upload to the system. For
example various medical certificates or evidence of class completion.
Since many uploaded attachments should not be visible to all users, the system enables an administrator to
restrict access to the attachments. The administrator uses roles to define who can add, modify or delete their
own attachments for a specific row of application data.
Here are the steps for defining attachments to use in PeopleSoft Enterprise applications:
For each attachment you plan to establish, specify the attachment object type, Attachment, Note, or URL,
and the user roles that can access the attachment. Specify the access level of each user role by assigning
an Authorization ID to the role.
Add common attachments, URLs, or document definitions and the roles that can see the attachments.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 909
Working with Common Components Chapter 35
4. Configure keys
Integrate attachments into any application within any context. After defining the attachments, you can
integrate them into any PeopleSoft Enterprise application and the context varies depending on the product
that uses the framework. The Configure Keys page enables you to define which application data field
maps to each of the required context keys.
Context keys are populated with values corresponding to a field in the associated application. To
define the contextual variations, define contextual key prompt tables or views and key prompt fields
based on the application using the attachment framework. These keys can come from any number of
tables and are implemented as generic character fields that are defined as record keys in the data
structure at the application level to denote alternate configuration IDs that can be used under different
circumstances.
For attachment configuration IDs that are document definitions, you must create a store record to
launch the document definition and store the attachments added by a user to a specific row of
application data.
Define store keys for document definitions in order to differentiate the row of data to which the
attachment belongs. Each application can decide the number of keys to use, from 1 to N, creating its
own record plus a sub record in Application Designer to store common fields related to the
attachments. Once the store record has been created, it must be associated to the Object Owner ID and
Sub ID to automatically retrieve the key field definitions and select the store key labels.
After creating the store record, associate it to the Object Owner ID and Attachment Sub ID and then
select the field labels. When you enter the name of the store record definition, the key fields are
automatically retrieved in the correct order by the key position defined in the record.
5. Maintain definitions
The system retrieves a list of valid Configuration IDs based on the defined context keys. In addition, the
system uses the Definition ID and the effective date to choose the attachment from the database.
To implement the attachment framework use the application class methods in the HR_ATTACHMENTS
application package PeopleSoft delivers. There are two classes in the delivered application package. The
Attachment_Data application class enables you to create an object containing entries for all of the link
labels, configuration IDs and group boxes that contain the links to the defined attachments. The
Attachment_UI application class enables you to manage the user interface for the attachments.
See Also
910 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Configure Keys HR_ATT_KEYS_HDR Set Up HRMS, Common Define the prompt tables
Definitions, Attachments, and key fields used by an
Configure Keys, Configure application.
Keys
Attachments Context Keys HR_ATT_KEYS_C Click the Context Keys link Enter content key prompt
on the Configure Keys page values.
Attachments Store Keys HR_ATT_KEYS_S Click the Store Keys link on Enter store key values.
the Configure Keys page
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 911
Working with Common Components Chapter 35
Authorization Options
Edit Attachments Select the check box to enable the user to create, update, or delete attachments.
The system automatically selects the View Attachmentscheck box when you
select the Edit Attachments check box and save the page.
Edit Notes Select the check box to enable the user to create, update, or delete notes. The
system automatically selects the View Notescheck box when you select the Edit
Notes check box and save the page.
Edit URLs Select the check box to enable the user to create, update, or delete URLs. The
system automatically selects the View URLscheck box when you select the Edit
URLs check box and save the page.
Delete Options
Select an option to determine the action of the system when the user deletes a existing attachment, note, or
URL. Selecting Mark as Deleted, the system still lists the object as an attachment, but the object's status is
Deleted and it cannot be selected. This option enables you to track deleted attachments. Selecting Delete from
database completely removes the object from the database.
912 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Note. The options in this group box are not available unless one or more of the editing fields, Edit
Attachments,Edit Notes, or Edit URLs,are selected.
Attachments, Notes, and Select to allow the Role Names listed in the Define Authorization area to create
URLs attachments, notes, or URLs based on the specified Authorization ID. You must
select at least one of the options in the Entry Control region.
Define Authorization
Use the fields in the Define Authorization region to specify the operations a role can perform by associating a
role with an attachment Authorization ID. Select the Role Name and then select a valid Authorization ID in
each row. Only one Authorization ID can be assigned to each role, but multiple roles can share the same
Authorization ID.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 913
Working with Common Components Chapter 35
Description Enter a description for the Configuration ID. This description appears in the
group boxes as a label for the link to the attachment.
Attachment Type Select the type of attachment users can attach or access. Values are: URL,
Attachment, and Document Definition. Based on your selection, the remainder of
the fields on the page change.
Select either Attachment or URL if you want to define common attachments or
URLs such as policies, handbooks, FAQs, and so on. Select Document Definition
if you want to create an entry that enables users to create their own attachments
for a specific row of application data.
Attachment Enter the file name of the attachment and then click the Add Attachment button.
After uploading the file, this field displays the file name of the attachment. You
can then use the View Attachment and Delete Attachment buttons to manage the
content of the attachment. This field is visible only if the Attachment Type is
Attachment.
URL Enter the desired URL to attach as a link. This field is visible only if the
Attachment Type is URL.
Add Attachment Click to add the file listed in the Attachment field. This button is visible only if
the Attachment Type is Attachment and a file has not yet been uploaded.
View Attachment and Use these buttons to manage the content of the file listed in the Attachment field.
Delete Attachment These buttons are visible only if the Attachment Type is Attachment and a file
has been uploaded.
914 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Authorized Roles
Enter the roles that you want to have access to the attachment or URL. If no role is selected, all of the
available roles can see the link. This region is only visible if the Attachment Type is Attachment or URL.
Role Name Select the role that you want to access the specified attachment.
Document Definitions
Enter the list of defined authorization entries that the user can upload as an attachment. The Document
Definitions region is visible only if the Attachment Type is Document Definition
Entry ID Select the authorization entry that you want users to upload to the system. The
system lists the Authorization Entry IDs defined on the Define Authorization
Entries page.
Last Upd User (Last Displays the user name that last updated the Define Attachments page.
Updated User)
Updated on Displays the date the Define Attachments page was last updated.
Sub ID(Sub application Enter a sub-application ID. Use the Sub ID field to create a definition for
ID) multiple lines of features within a single product line.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 915
Working with Common Components Chapter 35
Sequence Specify the order of the context keys on the Maintain Definitions page.
Key Prompt Table Select the object name of the prompt table that defines the values by which
attachments are partitioned for a an application.
Key Prompt Field Select the prompt table field that contains the value in the prompt list for a
specified key.
Related Fields
Click the Related Fields tab to select the fields related to the key prompt table and key prompt field by row.
916 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
Hide Key Select to indicate whether the key is displayed on the Document Definition page.
Display on Grid Select to indicate whether the key field is displayed on the Document Definition
Header page
Maintaining Definitions
Access the Maintain Definitions page (Set Up HRMS, Common Definitions, Attachments, Maintain
Definitions, Maintain Definitions).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 917
Working with Common Components Chapter 35
Key Field Displays the list of context keys specified on the Attachments Context Keys
page.
Key Value, Key Date, Select a valid value for the specified key field. The available field depends upon
and Key Number the Key Field type. For example, Cycle ID is a CHAR type field, so the Key
Value field is available and the Key Date and Key Number fields do not allow
you to enter data. The Budget Period Start Date is a DATE type field, which
means the Key Datefield is available and the Key Value and Key Number fields
do not allow you to enter data. None of these fields are available when the All
Values check box is selected.
All Values Select to specify that any value for the specified key field is valid. Selecting this
field makes the Key Value field unavailable.
Attachments
Configuration ID Select a valid configuration ID. Only active attachment configuration IDs are
displayed.
Sequence Enter a number to specify the order in which the hyperlinks to attachments are
retrieved from the database.
Group Box Select the group box where the hyperlink label is displayed. Values are: Related
Links,Other Links, and None.
Note. The context keys are not displayed the first time you open the Maintain Definitions page. You must
enter the Sequence Number and then the context keys automatically display.
The GetAttachmentLink method uses the effective date and the context keys array to retrieve the
configuration IDs from the database. Then these entries are loaded into a standalone rowset for further
filtering by role name.
918 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
The method returns an array object that contains entries for all link labels, configuration IDs, and group boxes
to which the current user has access.
There are two options to discover or retrieve the current user's roles, depending on the values passed of
&Roles, %Component, or %UserID:
1. The system uses the %UserId and %Component variables to discover all of the valid role names for each
content reference and user ID in order to perform the filtering.
2. Using the &Roles array of strings, only the role names in the array are considered for filtering.
Note. You must choose one of these options in order to perform further filtering by role name. The system
automatically uses the &Roles array of strings if you pass all three parameters at the same time.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 919
Working with Common Components Chapter 35
The system uses the &EfftDt and &cKeys to retrieve the Configuration IDs using the current context keys
values. The system uses the &EfftDt and &oKeys to retrieve the Configuration IDs using the context keys
values from the last time the component was saved. Using the %UserId and %Component system variables
the system discovers all of the valid role names for each content reference and user ID in order to perform the
filtering. Using the &Roles array of strings only the role names that are in the array are considered for the
filtering. Then these entries are loaded into arrays for comparison. If the current Configuration IDs are the
same as the prior Configuration IDs, then the method returns the value True. If the return is True, the product
that intends to implement this functionality has the option to delete the invalid attachments or leave them in
the database.
The statements contained in this method provide the initialization of the class and instantiates new objects of
the Attachment_UI class.
The Configuration ID and the Effective Date are used to retrieve the attachment type from the Attachment
Configuration Table (HR_ATT_CNFG_TBL.)
The method returns the attachment type as one of the following string values:
920 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 35 Working with Common Components
The system uses the Configuration ID value (&hCnfgID) and the Effective Date (&hEffDt) to retrieve the
attachment type from PS_HR_ATT_CNFG_TBL using the GetAttachmentType method. If the attachment
type is Attachment or URL then the specified attachment file or URL is opened in a new window. Otherwise,
the user is transferred to the Attachment User Interface (Component: HR_ATT_DD). To enable the user to
open the component ensure that the corresponding store key record and store key field labels are defined.
&hRole Specify the Role Name (use the value that the
GetAttachmentLinks method returns in the array).
The method returns a numeric value that indicates the number of successfully added attachment records.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 921
Working with Common Components Chapter 35
The method returns an array that contains entries for all of the hyperlink labels, Configuration IDs and group
boxes that the current user can access.
The steps to view delivered text catalog entries for attachments are:
1. Navigate to the Maintain Text Catalog page. (Set Up HRMS, Common Definitions, Text Catalog and
Notepad, Maintain Text Catalog)
2. Enter HHR in the Object owner identifier field and ATT in the Sub ID field.
922 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 36
The Mass Organizational Change processes enable you to make changes based on department and position
changes. Using the Mass Organization Changes features, you can:
Create new departments or positions, changing the organizational structure and transfer employees into
the new departments or positions.
Merge employees from multiple departments or positions into new or existing departments and positions.
You perform mass organization changes by defining the changes, setting up any necessary information, and
then executing the change. Based upon the definitions you enter, the Mass Organization Change process
updates the affected records. This process creates Federal personnel action changes into the system as you
defined them. This occurs in the same manner as if you had entered them directly online.
Mass changes affect a large number of rows of data in the system, which makes this a powerful tool.
Therefore, you must give careful consideration to selecting the person in your organization who is allowed to
perform mass organizational changes.
Note. If you are performing several mass change operations, assign each one a unique mass organization
change ID to help you retain and identify all of them. You can group them when you set up your run process.
We also recommend breaking down large changes into smaller changes to help reduce error and the burden
on the system.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 923
(USF) Working With Mass Organization Changes Chapter 36
See Also
924 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 36 (USF) Working With Mass Organization Changes
1. (optional) Create a new department or position or make changes to an existing department or position.
1. If you are creating a new department, add the new 1. If you are creating a new position, add the new
department to the Departments USF component position to the Add/Update Position Info
(DEPARTMENT_TBL). component (POSITION_DATA).
Note. If you are using tree-based data permission See PeopleSoft Enterprise Human Resources
security, don't forget to add the new department to 9.1 PeopleBook: Manage Positions, "Setting
the department security tree and refresh Up Positions," Creating Positions.
SJT_CLASS_ALL.
2. If you are modifying the position hierarchy, make
See Chapter 11, "Setting Up Organization the changes in PeopleSoft Tree Manager or the
organizational structure in the Add/Update Position
Foundation Tables," (USF) Setting Up Federal
Info component.
Departments, page 309.
2. If you use tree-based security and are modifying the Note. You can access the Add/Update Position Info
department security hierarchy, make the changes in component from the HR: Position tree by adding a new
PeopleSoft Tree Manager. node, (to add a new position) or double clicking on an
existing node (to update an existing position).
See Chapter 5, "Setting Up and Administering HRMS
Security," Setting Up and Assigning Tree-Based Data See PeopleSoft Enterprise Human Resources 9.1
Permission, page 81. PeopleBook: Manage Positions, "Maximizing Position
Data," Maintaining Your Organizational Structure.
If you made changes to the department hierarchy, re- If you've made changes to the reporting hierarchy,
create it by running the Refresh Department Table rebuild the position tree or position structure by running
(FGHR006) process from the Build Department the SQR Build Position Structure (POS006A) process
Organization page (RUNCTL_FGHR006). from the Build Position Structure page.
3. Define the mass organization change on the Define Changes page (GVT_MOC_DATA).
Enter the effective date of the change, the action and reason, the nature of action (NOA) and legal
authority code or codes and descriptions, and the old and new department or position.
Use the Apply Changes page (RUNCTL_GVT_MASSORG) to generate mass organization changes based
on the Mass Organization Change data setup. This determines which employees in the departments or
positions you identified are affected and inserts new rows of Federal personnel action data.
5. Generate the Mass Org Exception report (FGHR034 SQR) to identify who was in an affected department
or position.
Print the necessary position descriptions using the SQR Process FGOF8. Run a few random reports from
this process to test and verify the changes that were performed.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 925
(USF) Working With Mass Organization Changes Chapter 36
Build Position Structure RUNCTL_ASOFDATE Workforce Administration, Run the Build Position
Collective Processes, Mass Structure SQR (POS006A)
Organization Changes USF, to link the positions in the
Build Position Structure, system and create the
Build Position Structure reporting hierarchy
represented in the Indented
Position Report.
See PeopleSoft Enterprise
Human Resources 9.1
PeopleBook: Manage
Positions, "Maximizing
Position Data," Running the
Organizational Structure
Reports.
See Appendix D,
"PeopleSoft Application
Fundamentals for HRMS
Reports," POS006A - Build
Position Structure
Manage Positions, page 1186.
926 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 36 (USF) Working With Mass Organization Changes
Mass Org Exception Report RUNCTL_FGHR034 Workforce Administration, Run this report to identify
(mass organization Collective Processes, Mass those employees that were
exception report) Organization Changes USF, in a position or department
Mass Org Exception identified in the processed
Report, Mass Org Mass Organization Change
Exception Report ID but who the system did
not process. Modify the
records of these employees
manually.
Change
Indicate if the change is a department or position change. When you select Department, the system makes the
fields in the Position Change group box unavailable. When you select Position, the system makes the fields in
the Department Change group box unavailable.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 927
(USF) Working With Mass Organization Changes Chapter 36
Defaults
The system inserts the values you enter here into the new job data rows it creates for the employees affected
by this mass organization change.
Date of Change Enter the date the change takes effect. The system uses this date as the effective
date on the new Job Data row.
Action and Reason Code Select the action and reason for the change.
Note. Remember that some actions will set payroll or HR status and/or update
employee dates. Review the processing or defaulting that action triggers in the
system on the Actions component (ACTION_TBL).
NOA Code (nature of Select the NOA code, WIP status, and legal authority (the WIP Status and Legal
action code), WIP Status Authority (1) fields are required).
(work-in-progress status), See Chapter 14, "(USF) Setting Up Human Resources Management Tables,"
and Legal Authority (1) Setting Up Nature of Action Codes, page 377.
Department Change
You can add more than one row to accommodate changes to a number of departments. If you are merging two
departments into one, for example, enter two rows and select one old department in one row and the other old
department in the other and select the new department they are merging into in the New Department field in
each row.
Old Department Enter the name of the department that is being changed.
Position Change
You can add more than one row to accommodate changes to a number of positions.
928 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 36 (USF) Working With Mass Organization Changes
Reports To Enter the position that the new position reports to.
Mass Organization Select the ID of the mass organization change that you want to process. You set
Change ID up mass organization change IDs on the Define Changes page.
This process:
Determines the affected employees in the departments or positions identified
in the mass organization change ID.
Inserts a new row of Federal personnel action data for each affected
employee with the default information selected for the mass change ID.
Generates a PDF file that records the action for each employee. You can
access the file using through the Process Monitor link.
Review the file to see if there are discrepancies for any rows of data for any
of the employees that were updated by the process. You can correct the
discrepancies by entering them directly into the Federal HR Processing USF
component.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 929
Chapter 37
Note. If you have also licensed PeopleSoft Enterprise Campus Solutions, please refer to the PeopleSoft
Enterprise Campus Solutions Application Fundamentals PeopleBook, "Working with PeopleSoft Directory
Interface for PeopleSoft Campus Solutions"
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 931
Working with PeopleSoft Directory Interface for PeopleSoft HRMS Chapter 37
Use the DSMAPINPUT FullSync Load process to load only people and their job data. Use the Directory
Load process when you are loading location and department entries in addition to person and job data.
Note. The Directory Load process sometimes experiences performance issues when loading a large volume of
person data. To avoid these issues, use the DSMAPINPUT FullSync Load process.
Note. Both the DSMAPINPUT FullSync Load and the Directory Load processes overwrite any existing data
in the directory.
Pages Used to Load the Directory Using the DSMAPINPUT FullSync Load
Process
Full Data Publish EO_FULLDATAPUB Enterprise Components, Use to load person and job
Integration Definitions, data into the directory.
Initiate Processes, Full Data
Publish, Full Data Publish
2. Select the DS_CLEANTEMP process from the list and click OK.
Note. Do not run the Directory Load (EO_DS_AUDIT) process at this time.
932 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 37 Working with PeopleSoft Directory Interface for PeopleSoft HRMS
The utility processes the first active map it finds in the Directory Map table. If several maps contain
DSMAPINPUT as the message name, ensure that you activate the service operation for only the message that
you want before running this process.
4. Specify a Request ID and description, save your changes and click Run.
5. Choose the Full Table Data Publish (EOP_PUBLISHT) process and click OK.
2. If the Started column has a number greater than zero, it means the message is still being processed. When
the subscriptions are completed, the only column that will have a number greater than zero is the Done
column.
See Also
Note. Do not run the Clean Temp Tables or the Directory Load (EO_DS_AUDIT) process at this time.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 933
Working with PeopleSoft Directory Interface for PeopleSoft HRMS Chapter 37
Use the DSMAPINPUT FullSync Audit process to audit only people and their job data. Use the Directory
Load process when you are auditing data that includes location and department entries in addition to person
and job data.
Note. The Directory Audit process sometimes experiences performance issues when loading a auditing
volume of person data. To avoid these issues, use the DSMAPINPUT FullSync Audit process.
Pages Used to Audit the Directory Using the DSMAPINPUT FullSync Audit
Process
Full Data Publish EO_FULLDATAPUB Enterprise Components, Use a set of rules to publish
Integration Definitions, the
Initiate Processes, Full Data DSMAPINPUT_FULLSYN
Publish C_A service operation.
934 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 37 Working with PeopleSoft Directory Interface for PeopleSoft HRMS
2. Select the EODS_CLEANLD process from the list and click OK.
The utility processes the first active map it finds in the Directory Map table. If several maps contain
DSMAPINPUT as the message name, ensure that you activate the service operation for only the message that
you want before running this process.
4. Specify a Request ID and description, save your changes and click Run.
5. Choose the Full Table Data Publish (EOP_PUBLISHT) process and click OK.
Note. You can choose to use your own service operation instead of DSMAPINPUT_FULLSYNC_A but you
must add FULLSYNC_A to the name of the service operation from the directory map. For example, if
PERSMSG is a configured service operation specified on the map for person entries, name the service
operation PERSMSG_FULLSYNC_A.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 935
Working with PeopleSoft Directory Interface for PeopleSoft HRMS Chapter 37
2. If the Started column has a number greater than zero, it means the message is still being processed. When
the subscriptions are completed, the only column that will have a number greater than zero is the Done
column.
See Also
Note. Do not run the Clean Temp Tables or the Directory Load (EO_DS_AUDIT) process at this time.
936 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 37 Working with PeopleSoft Directory Interface for PeopleSoft HRMS
We developed the sample mappings assuming that you are using the tree structure illustrated below, which is
HR_PERSONs reporting to HR_DEPARTMENT, the departments are associated to the HR_LOCATION,
which report to the corporate level, or HR_COMPANY:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 937
Working with PeopleSoft Directory Interface for PeopleSoft HRMS Chapter 37
PeopleSoft Directory Interface delivers the following sample messages for mapping PeopleSoft data to the
directory.
The UID field is limited to fifty characters. The system truncates the person's name if it exceeds fifty
characters.
938 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 37 Working with PeopleSoft Directory Interface for PeopleSoft HRMS
DSMAPINPUT Message
The DSMAPINPUT service operation, which corresponds to Directory Input, is a sample service operation
that combines a person's job and personal data into one service operation. The DSWORKFORCE_SYNC
mservice operation publishes person's job information. The DSPERSON_BASIC_SYNC service operation
publishes a person's personal information.
BuildMappingMessage Syntax
The BuildMappingMessage function populates a service operation with data that is stored in another service
operation and with data from the local database. After populating the service operation from the two data
sources, it calls the mapping function. When all the data required for directory mapping isn't in the original
published service operation, BuildMappingMessage uses this function instead of directly calling the mapping
function:
BuildMappingMessage (input message, output message, on-line flag, [, map name])
Copies data in the same record from the input service operation into the output service operation.
Examines data in the service operation for key values for empty records.
If it finds key values for empty records, populates empty records in the output service operation by
retrieving its current rows in the database.
If a map name is provided, calls the mapping function for the specified name. Otherwise, calls the
mapping function for each map referencing the output service operation.
The BuildMappingMessage is found in the application package and class that is associated with handler of the
_EFF service operation. For example, you can find the BuildMappingMessage for the
DSLOCATION_SYNC_EFF service operation in theDSMappingSub application class, which is part of
DSLOCATION_SYNC_EFF application package. The BuildMappingMessage code is in the
FUNCLIB_EO_DS derived record, DSMAPMESSAGE field, FieldFormula event.
Parameters
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 939
Working with PeopleSoft Directory Interface for PeopleSoft HRMS Chapter 37
An example:
Local Message &MsgIn;
940 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 38
Other PeopleSoft Enterprise HRMS applications inside of the database (local integrations).
Third-party applications.
Use the Interactive Services Repository (ISR) on My Oracle Support to identify the integrations that you need
for your implementation. Documentation provided with the ISR application on My Oracle Support provides
instructions for using search pages to query the repository using a variety of criteria:
By product.
By business process.
By integration technology.
The advanced search page enables you to combine the individual search criteria into a single search.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 941
Working with Integration Points in Enterprise HRMS Chapter 38
See Also
The "Interactive Services Repository" PDF instructions on My Oracle Support, Implementation Guide,
Implementation Documentation and Software, Interactive Services Repository.
Verify or select the Active status for the service operation on the General page.
Activate the appropriate handlers and associated application classes on the Handlers page.
In the PeopleTools, Integration Broker, Integration Setup, Queues component, set the status of the
corresponding service operation queue to Run.
See Also
Setup Requirements
When using local integrations, you must configure only the local node, but the application server must be
running both the publish and subscribe servers. The local gateway and node must be properly configured. For
local to local integrations, you must activate the asynchronous routing within the local node (local to local).
This table lists the local to local service operations in alphabetical order:
942 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 38 Working with Integration Points in Enterprise HRMS
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 943
Working with Integration Points in Enterprise HRMS Chapter 38
EP_JPM_CAT_I_RLAT PROJECT_FULLSYNC
EP_RATING_MDL PSXP_ARCHATTR
PeopleBook Reference
PeopleSoft Enterprise Global Payroll See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook,
PeopleBook "Integrating with PeopleSoft Enterprise General Ledger."
PeopleSoft Enterprise Global Payroll See PeopleSoft Enterprise Global Payroll 9.1 PeopleBook,
PeopleBook "Integrating with Variable Compensation Functionality."
PeopleSoft Enterprise Human Resources See PeopleSoft Enterprise Human Resources 9.1 PeopleBook:
PeopleBook: Manage Professional Compliance Manage Professional Compliance, "Setting Up Manage Professional
Compliance."
PeopleSoft Enterprise Human Resources See PeopleSoft Enterprise Human Resources 9.1 PeopleBook:
PeopleBook: Manage Variable Compensation Manage Variable Compensation, "Managing Awards Approval and
Payout."
PeopleSoft Enterprise Payroll for North See PeopleSoft Enterprise Payroll for North America 9.1
America PeopleBook PeopleBook, "Integrating with PeopleSoft Enterprise Time and
Labor."
944 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 38 Working with Integration Points in Enterprise HRMS
PeopleBook Reference
PeopleSoft Enterprise Payroll for North See PeopleSoft Enterprise Payroll for North America 9.1
America PeopleBook PeopleBook, "Integrating with PeopleSoft HRMS and Enterprise
Expenses."
PeopleSoft Enterprise Payroll for North See PeopleSoft Enterprise Payroll for North America 9.1
America PeopleBook PeopleBook, "Integrating with Enterprise General Ledger."
PeopleSoft Enterprise Payroll for North See PeopleSoft Enterprise Payroll for North America 9.1
America PeopleBook PeopleBook, "Integrating with PeopleSoft Payables."
PeopleSoft Enterprise Stock Administration See PeopleSoft Enterprise Stock Administration 9.1 PeopleBook,
PeopleBook "Administering Variable Compensation Grants," Variable
Compensation Integration.
PeopleSoft Enterprise Talent Acquisition See PeopleSoft Enterprise Talent Acquisition Manager 9.1
Manager PeopleBook PeopleBook, "Managing Employee Referral Programs."
PeopleSoft Enterprise Time and Labor See PeopleSoft Enterprise Time and Labor 9.1 PeopleBook, "Using
PeopleBook Time Collection Devices," Receiving Time from a TCD.
PeopleSoft Enterprise Time and Labor See PeopleSoft Enterprise Time and Labor 9.1 PeopleBook,
PeopleBook "Integrating with PeopleSoft Financials and Enterprise Performance
Management."
PeopleSoft Enterprise Time and Labor See PeopleSoft Enterprise Time and Labor 9.1 PeopleBook, "TCD
PeopleBook Interface."
PeopleSoft Enterprise Time and Labor See PeopleSoft Enterprise Time and Labor 9.1 PeopleBook, "TCD
PeopleBook Interface."
Note. To research the technical details of any integration point used by PeopleSoft applications, refer to the
Interactive Services Repository in the Implementation Guide section of My Oracle Support.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 945
Chapter 39
PeopleSoft HRMS integrates with OWS through the PeopleSoft Integration Broker (IB), which is a
messaging system that enables you to synchronize data from one application or system with another.
PeopleSoft Integration Broker facilitates synchronous and asynchronous messaging among internal systems
and trading partners, while managing message structure, message format, and transport disparities.
The following diagram illustrates the HRMS integration with OWS process flow:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 947
Integrating with Oracle Workforce Scheduling Chapter 39
When PeopleSoft HRMS products and OWS are integrated, the following information is exchanged
asynchronously between the applications:
PeopleSoft Human Resources sends employee's personal, job, contract and profile information to OWS.
PeopleSoft Time and Labor sends employee schedule preferences, updates to schedule preferences and
approved or submitted reported time to OWS.
OWS sends employee optimized punch schedules back to Time and Labor.
The system sends batches of Human Resources messages to OWS when multiple events occur. Such as when
an employee has a change to Job Data and Person Data. The system saves event information in a hold file
rather than sending the information from each event in separate messages. This enables you to use the Publish
OWS Messages process (Workforce Administration, Collective Processes, Publish OWS Messages) to
schedule OWS messages.
See Also
948 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
Workforce
Administration, Job
Information, Current
Job
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 949
Integrating with Oracle Workforce Scheduling Chapter 39
Oracle Workforce Select to indicate that OWS has been installed and that the system sends the
Scheduling following information through Integration Broker:
PeopleSoft Human Resources sends employee's personal, job, contract and
profile information to OWS.
OWS sends employee optimized punch schedules back to Time and Labor.
950 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
Oracle Workforce Select to indicate enrollment in OWS for this employee and employee record
Scheduling combination.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 951
Integrating with Oracle Workforce Scheduling Chapter 39
Configurations page
Allow Override to OWS Select to enable a manager to change or override a punch schedule inserted from
Schedule OWS for the employee and employee record combination on the Manage
Schedules page.
The following table describes the Event Manager trigger points for sending information to OWS:
952 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
JobUpdated Adding or updating an employee's job In Add or Update mode, this event is
data. triggered if any of the Job Data fields
are updated.
JobProfileDataUpdated Adding or updating an employee's job In Add or Update mode, this event is
profile data. triggered if any of the Job Profile
Data fields are updated.
The following table describes the OWS fields and the corresponding Human Resources field data that is sent
to OWS:
EndDate To be calculated
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 953
Integrating with Oracle Workforce Scheduling Chapter 39
Contract Date
954 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
Batch Processing
The system sends batches of Human Resources messages to OWS when multiple events occur. Such as when
an employee has a change to Job Data and Person Data. The system saves event information in a hold file
rather than sending the information from each event in separate messages. This enables you to use the Publish
OWS Messages process (Workforce Administration, Collective Processes, Publish OWS Messages) to
schedule OWS messages.
Important! You must use the Publish OWS process to send PeopleSoft Human Resources information to
OWS. This only applies to messages created by PeopleSoft Human Resources for OWS and does not effect
the way PeopleSoft Absence Management or PeopleSoft Time and Labor sends or receives information from
OWS.
Initially, you must send all of the active and approved absences to OWS using the Absence Full Sync
(GP_ABS_FSYNC) Application Engine process. Absence Management sends absence event data to OWS
when all of the following conditions are met:
The absence start date or end date falls on or after the date specified in the Process As Of Date field on the
Publish Absence Data to OWS page.
EMPLID
EMPL_RCD
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 955
Integrating with Oracle Workforce Scheduling Chapter 39
BGN_DT
PIN_CODE
END_DT
ORIG_BEGIN_DT
PRC_EVT_ACTN_OPTN
BEGIN_DAY_HRS
BEGIN_DAY_HALF_IND
END_DAY_HRS
END_DAY_HALF_IND
ALL_DAYS_IND
START_TIME
DURATION_ABS
START_TIME2
END_TIME
END_TIME2
Once the Absence Management and OWS systems have been synchronized using the GP_ABS_FSYNC
process, Absence Management continues to publish absence events for active employees that are enrolled in
the installed OWS system. The following changes or additions to absence events for enrolled employees are
published:
The absence event takes place from the process date onward.
956 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
BGN DT
END DT
PRC_EVT_ACTN_OPTN
WF_STATUS
BEGIN_DAY_HRS
BEGIN_DAY_HALF_IND
END_DAY_HRS
END_DAY_HALF_IND
ALL_DAYS_IND
START_TIME
END_TIME
START_TIME2
END_TIME2
ORIG BEGIN DT
Use Cases
The following table lists the various actions a user might take in Absence Management and lists the message
used to convey the changed information to OWS, the audit action value of the changed data, the information
received by OWS, and the actions OWS takes in response to the received data.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 957
Integrating with Oracle Workforce Scheduling Chapter 39
The user changes a GP_ABS_EVENT_S C OWS receives the Update the OWS
non-key field in the YNC approved absence schedule with the
absence event. event record where new data.
the changed field has
For example,
the attribute
START_TIME
"IsChanged."
For example, if the
user changes the
START_TIME, then
START_TIME is
"ISChanged."
The user changes a GP_ABS_EVENT_S N (old key) OWS receives two Use the old record
key field in the YNC records: key field to access the
K (new key)
absence event. old employee
The schedule and remove
For example, AUDIT_ACTN = the old absence time,
EMPLID, N for the old then use the new
EMPL_RCD, record record to update the
PIN_TAKE_NUM,
OWS schedule with
BGN_DT and AUDIT_ACTN = the new data.
END_DT. K for the new
record. For example, if the
user changes the
The changed field has BGN_DT then OWS
the attribute changes or removes
"IsChanged." the absence from the
schedule using the
old BGN_DT and
update the schedule
with the new
BGN_DT.
958 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
The user changes key GP_ABS_EVENT_S N (old key) OWS receives two Use the old record
fields and non-key YNC records: key field to access the
K (new key)
fields in the absence old employee
event. The schedule and use the
AUDIT_ACTN = new record to update
For example, the user N for the old the OWS schedule
changes the record with the new data.
BGN_DT and the
START_TIME. AUDIT_ACTN = For example, if the
K for the new user changes the
record. BGN_DT then OWS
removes the absence
The changed fields using the old
have the attribute BGN_DT from the
"IsChanged." schedule and updates
the schedule with the
new BGN_DT.
The user deletes an GP_ABS_EVENT_S D OWS receives the Remove the related
absence event. YNC deleted absence event delete absence data
record from the OWS
schedule.
Publish Absence Data to GP_ABS_FULLSYNC_RC Global Payroll & Absence Publish absence event data
OWS Mgmt, Absence and Payroll to OWS.
Processing Publish Absence
Data to OWS
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 959
Integrating with Oracle Workforce Scheduling Chapter 39
Publish Absences for All Select to publish all absence events. When this field is selected, the system
Employees excludes the absence events for any employee and record number combinations
listed in the Employees to Process area from the data published to OWS.
Deselect the check box to publish only the absence events for the employee and
record number combinations listed in the Employees to Process area.
Process As Of Date Enter the date for which you want to publish absence data. Active and approved
absences with a start date or end date that falls on or after the Process As Of Date
are published to OWS.
Include/Exclude This column indicates whether the absence events for specified employees are
included or excluded from the information published to OWS. When the Publish
Absences for All Employees check box is selected, the Include/Exclude field for
all of the entries in the Employees to Process region are set to Exclude. This
means that these employees will not have any absence event data sent to OWS.
When the Publish Absences for All Employees check box is deselected, the
Include/Exclude field is set to Include. This means that only the employee ID's
listed in the Employees to Process region will have absence event information
published to OWS.
Initially, you must send all of the active and approved absences to OWS using the Absence Full Sync
(GP_ABS_FSYNC) Application Engine process.
This process can be used after the initial synchronization between Absence Management and OWS as a way
to update data with OWS. For example, if absence data for some employees becomes corrupted, update the
information for just the affected employees by entering the EmplID and Empl Rcd Nbr for each affected
employee and then deselecting the Publish Absences for All Employees field. This changes the
Include/Exclude field to Include. When you run the GP_ABS_FSYNC process, the absence events for the
listed employees are updated in OWS.
960 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
Time and Labor sends and receives information from OWS for employees that meet the following criteria:
The system has OWS, Human Resources, and Time and Labor installed.
The employee has a schedule with either a punch or a flex shift type, regardless of the rotating schedule
status on the Defining Schedules page.
Publish Reported Time TL_RPTD_OWS Time and Labor, Process Send reported punch and
Time, Publish Reported approved time to OWS.
Time
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 961
Integrating with Oracle Workforce Scheduling Chapter 39
Start Date and End Date Enter the start and end date for the schedule information you want to publish to
OWS. You must enter both a start and end date.
Select All Employees Select to publish the reported time for all active employees that are enrolled in
OWS. Deselect this check box to enter specific time reporter groups in the
Employees to Process area.
Use the Employees To Process area to select one or more employees to process or exclude from the reported
time that is published to OWS.
EmplID Enter the Employee ID of an active employee enrolled in OWS. When you enter
an Employee ID the Time Reporter Group field is not displayed for that row.
Time Reporter Group Enter the Time and Labor employee group ID for which you want to send
schedule data to OWS. When you enter a time reporter group, the EmplID,
Employee Record, and Include or Exclude Selection fields are not displayed for
that row.
Include or Exclude Specify whether to include or exclude a specified employee's schedule data when
Selection publishing schedule data to OWS. Values are Include and Exclude.
Time and Labor publishes any reported punch time with a status of SB or AP. If there is no reported punch
time with the correct status, the TL_RPTD_PUB process makes the following entry in the message log: "No
employees selected to send to OWS."
962 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 39 Integrating with Oracle Workforce Scheduling
Use the Schedule Preferences page (Self Service, Time Reporting, User Preferences, Schedule Preferences) to
publish employee preference schedules to OWS. When the user saves his or her schedule preferences, the
system uses the SCH_PREFERENCE_SYNC message to publish the information to OWS.
Note. Time and Labor only publishes to OWS for each day that the user enters a Shift ID or a Start Time and
End Time. Some employees may not establish preference for every day. Time and Labor does not publish
time for days where the Shift ID is set to Off.
The system enables you to select a Shift ID or enter the start and end times for each work day. On the
Schedule Preferences page, when you select a Shift ID, the Start Time and End Time fields are not available
for input. When you choose to enter a start and end time, the system verifies that you have entered values in
both the Start Time and the End Time fields.
Time and Labor publishes the first in and the last out punch times associate with a Shift ID. For example, an
employee has the following punch times:
The system publishes the 8:00 AM punch in and the 5:00 PM punch out to OWS.
See PeopleSoft Enterprise Time and Labor 9.1 PeopleBook, "Using Self-Service Components," Setting Up
User Preferences.
When first integrating Time and Labor and OWS, you must send all of the applicable schedule preferences to
OWS using the Publish Schedule Preference process (SCH_PREF_PUB.) Access the Publish Schedule
Preference page (Set Up HRMS, Product Related, Time and Labor, Schedules, Publish Schedule Preference).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 963
Chapter 40
PeopleSoft Time and Labor facilitates the management of time reporting and time approval, as well as the
creation and use of schedules. The scheduling module enables customers to create and maintain schedules and
to communicate work expectations, track adherence, and reconcile the actual work completed.
This chapter provides an overview of the integration with Clairvia and discusses how to:
The following diagram illustrates the flow of information between PeopleSoft HCM applications and
Clairvia:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 965
Integrating with Clairvia Chapter 40
Information flow between PeopleSoft HRMS, Time and Labor, and Clairvia
When PeopleSoft HRMS products and Clairvia are integrated, the following information is exchanged
asynchronously between the applications:
PeopleSoft Human Resources sends employee personal, job, and person profile information to Clairvia.
PeopleSoft Time and Labor sends employee reported punch time, leave balances, and payable time to
Clairvia.
Clairvia sends employee work schedule and scheduled leave information back to Time and Labor.
Note. The reported leave time and leave balance information is obtained from Time and Labor though
integration with HR Base Benefits. Absence Management is not required for this integration.
The system publishes PeopleSoft Human Resources messages in real-time to Clairvia when any of the
following transactions occur:
966 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Important! The PeopleSoft system supports scheduling integration with Clairvia and Oracle Workforce
Scheduling. However, the system supports the integration with only one external scheduling application at a
time. You cannot integrate your PeopleSoft system with Clairvia and Oracle Workforce Scheduling
simultaneously.
This section only discusses the configuration necessary to enable Integration Broker to send messages
between the PeopleSoft applications and Clairvia.
Full Data Publish EO_FULLDATAPUB Enterprise Components, Create the run control for
Integration Definitions, the Full Data Publish utility.
Initiate Processes, Full Data
Publish
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 967
Integrating with Clairvia Chapter 40
All PeopleSoft applications use common, centralized tables and pages to define how to publish full table
messages. The Publish utility uses full table publish rules to process the data. For integration with Clairvia,
you must set the Publish Rule Definition Status to Active for the following messages:
PERSON_BASIC_CV_FULLSYNC_EFF
JPM_JP_CV_FULLSYNC_EFF
WORKFORCE_CV_FULLSYNC
See Also
968 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
You must run the Full Data Publish process two times when you initially integrate with Clairvia:
2. After you enter employee data and indicate which employees are integrated with Clairvia, run this process
again for the PERSON_BASIC_CV_FULLSYNC_EFF, WORKFORCE_CV_FULLSYNC, and
JPM_JP_CV_FULLSYNC_EFF messages.
See Chapter 40, "Integrating with Clairvia," Administering PeopleSoft Human Resources Integration with
Clairvia, page 974.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 969
Integrating with Clairvia Chapter 40
JPM Catalog Details INSTALL_CATTYP_SEC Click the JPM Content Defines which content types
Catalog Details link on the to publish to Clairvia
Installed Integration
Products page.
Employment Information EMPLOYMENT_DTA1 Click the Employment Data Enroll the selected
link at the bottom of any employee in Clairvia.
page in the Job Data or
Current Job Data
component:
Workforce Administration,
Job Information, Job Data
Workforce Administration,
Job Information, Current
Job
970 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Application Type Select the type of application that is being integrated. Scheduling is the default
value.
Product Select the product you want to use for integration. Clairvia is the default value.
Installed Select to indicate the installation of an application type and product combination.
The default value is deselected.
Access the JPM Catalog Details page (Click the JPM Content Catalog Details link on the Installed Integration
Products page).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 971
Integrating with Clairvia Chapter 40
Content Type Select the Profile Management content type to publish to Clairvia.
Access the Employment Information page (Click the Employment Data link at the bottom of any page in the
Job Data or Current Job Data component).
972 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Employment Information page, showing the Product Integration Information group box
Since basic HRMS data flows only from PeopleSoft to Clairvia, you must add new employees to PeopleSoft
before adding them to Clairvia.
Access the Configurations page (Set Up HRMS, Install, Product and Country Specific, Time and Labor
Installation, Configurations).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 973
Integrating with Clairvia Chapter 40
Allow Override to Select to enable a manager to change or override a Clairvia schedule for the
Schedule employee and employee record combination on the Manage Schedules page.
Deselect this field to prevent manager overrides of Clairvia schedules on the
Manage Schedules page.
974 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
1. Run the Full Data Publish process for the following messages:
DEPT_FULLSYNC
JOBCODE_FULLSYNC
JPM_CAT_FULLSYNC
POSITION_FULLSYNC
2. Enroll the existing employees in your PeopleSoft system into Clairvia via the Job Data page or using the
ADD_CLAIRVIA_EMPLOYEES DataMover script provided by Oracle.
The ADD_CLAIRVIA_EMPLOYEES PeopleTools DataMover script enables you to add the initial
employee and employee record instances that you want to integrate with Clairvia at one time. You modify
the DataMover script to include the employee information for the desired employees, and then initiate the
DataMover process to insert the employee information into the PS_PER_ORG_ASG_INT integration
table.
For example, assume your hospital has 3,000 nurses that you wish to enroll in Clairvia. Rather than
manually updating the Job Data for each of those employees, use the ADD_CLAIRVIA_EMPLOYEES
DataMover script to complete a mass enrollment of the employees.
3. Run the Full Data Publish process again, to send any enrolled employee data from your PeopleSoft
system to Clairvia.
PERSON_BASIC_CV_FULLSYNC_EFF
WORKFORCE_CV_FULLSYNC
JPM_JP_CV_FULLSYNC_EFF
PERSON_BASIC_CV_SYNC_EFF
WORKFORCE_CV_SYNC
JPM_JP_CV_SYNC_EFF
The system publishes the messages to the Clairvia node after removing any future-dated and history rows
using the Enterprise Components method Process Effdt Msg, for Person and HR Manage Profiles data.
Clairvia only accepts current effective-dated information for these messages. Future-dated rows are published
using the Enterprise Components Effective Dated Publish utility.
Clairvia accepts all historic, current and future dated messages for job related information
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 975
Integrating with Clairvia Chapter 40
Clairvia does not integrate with organizational-related setup tables such as Business Unit, and Location, as
well as other setup tables for Job Profile Management such as Rating Model, School, School Type and Major.
If no integration point exists between PeopleSoft and Clairvia, you must manually map any desired setup
table data. For subsequent change to a PeopleSoft table value, you must manually update the information in
the Clairvia system. For example: adding a new location.
The following table describes the Clairvia fields and the corresponding Human Resources field data that is
sent to Clairvia:
HireDate The date on which the employee was Orig Start Date, Last Start Date
hired. For example: 19960702 for
July 2, 1996
976 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 977
Integrating with Clairvia Chapter 40
For the Person Basic Clairvia FullSync Current Effective dated message
(PERSON_BASIC_CV_FULLSYNC_EFF) the system uses the Enterprise Components Full Data Publish
Utility. The system uses the mapping views on the Full Publish Rule to override the actual message records
with views that extract only current effective dated rows for Clairvia employees.
The standard PERSON_BASIC_FULLSYNC message publishes information for all employees, regardless of
their enrollment in Clairvia, as well as all past, present and future dated rows of information that is not
relevant to Clairvia. Using the mapping views publishes only the current effective-dated information needed
by Clairvia to the PERSON_BASIC_CV_FULLSYNC_EFF message immediately. The Full Data Publish
Utility ignores historical data and writes future-dated rows to the EO_EFFDELAY delay record. The
Enterprise Components Effective Date Publish utility picks up any records from the delay table that are now
current and generates PERSON_BASIC_CV_SYNC_EFF messages.
The full data publish utility publishes a data message with all of the PERSON_DATA information for all
Clairvia integrated employees.
For the Workforce Clairvia FullSync message (WORKFORCE_CV_FULLSYNC) the system uses the
Enterprise Components Full Data Publish Utility. The system uses the mapping views on the Full Publish
Rule to override the actual message records with views that extract all historical, current and future dated
rows for Clairvia employees.
Using the mapping views publishes only the information needed by Clairvia to the
WORKFORCE_CV_FULLSYNC message immediately. This message does not use '_EFF' in the message
name, so it does not use current effective dating logic and passes all rows over to the new Clairvia message.
The full data publish utility publishes a data message with the workforce information for all Clairvia
integrated employees.
For the HR Manage Profiles JP Clairvia FullSync Current Effective dated message
(JPM_JP_CV_FULLSYN_EFF), the system uses the Enterprise Components Full Data Publish Utility. The
system uses the mapping views on the Full Publish Rule to override the actual message records with views
that extract only current effective dated rows for Clairvia employees for the desired HR Manage Profiles
content type, using the highest ranking qualifier instance content items.
The standard JPM_JP_FULLSYNC message publishes information for all employees, regardless of their
enrollment in Clairvia, as well as all qualifier instances and all past, present and future dated rows of
information that is not relevant to Clairvia. Using the mapping views publishes only the current effective-
dated information needed by Clairvia to the JPM_JP_CV_FULLSYNC_EFF message immediately. The Full
Data Publish Utility ignores historical data and writes future dated rows to the EO_EFFDELAY Delay record.
The Enterprise Components Effective Date Publish utility picks up any records from the delay table that are
now current and generates JPM_JP_CV_SYNC_EFF messages.
The full data publish utility publishes a data message with all of the Profile information for all Clairvia
integrated employees.
978 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
For the Person Basic Clairvia Sync Current Effective-dated message (PERSON_BASIC_CV_SYNC_EFF),
the system makes two passes to place the generic data into a format that Clairvia can use. A handler was
added to PERSON_BASIC_SYNC for the first pass and a handler added to PERSON_BASIC_CV_SYNC
for the second pass.
In the first pass, the data in the PERSON_BASIC_SYNC message is copied to an interim
PERSON_BASIC_CV_SYNC message that contains all data except for the PERS_ORG_REL_WK work
record, which is not required by Clairvia.
In the second pass, an Enterprise Components routine reads the PERSON_BASIC_CV_SYNC message and
determines if the message contains the current effective-dated row. Current effective-dated rows are copied to
the PERSON_BASIC_CV_SYNC_EFF message for publishing. Future-dated rows are copied to the
EO_EFFDELAY Delay record. The EC Effective Dating utility compares the future dated row to the date on
the utility and if the date is now current, generates the PERSON_BASIC_CV_SYNC_EFF message.
Historical rows are ignored and not copied to PERSON_BASIC_CV_SYNC_EFF. The Effective Dating
utility creates three messages: a header message where PSCAMA. MSG_SEQ_FLG = H, a data message
containing the actual data needed by Clairvia and a trailer message where PSCAMA. MSG_SEQ_FLG = T.
For the HR Manage Profiles Profile Clairvia Sync Current Effective-dated message
(JPM_JP_CV_SYNC_EFF), the system makes two passes to place the generic data into a format that Clairvia
can use. A handler was added to JPM_JP_SYNC for the first pass and a handler added to
JPM_JP_CV_SYNC for the second pass.
In the first pass, the data in the JPM_JP_SYNC message is copied to an interim JPM_JP_CV_SYNC message
after the system removes any content types that are not one of the Clairvia installation table content types.
In the second pass, an Enterprise Components routine reads the JPM_JP_CV_SYNC message and determines
if the message contains the current effective-dated row. Current effective-dated rows are copied to the
JPM_JP_CV_SYNC_EFF message for publishing. Future-dated rows are copied to the EO_EFFDELAY
Delay record. The Effective Dating utility compares the future dated row to the date on the utility and if the
date is now current, generates the JPM_JP_CV_SYNC_EFF messages. Historical rows are ignored and not
copied to JPM_JP_CV_SYNC_EFF. The Effective Dating utility creates three messages: a header message
where PSCAMA. MSG_SEQ_FLG = H, a data message containing the actual data needed by Clairvia and a
trailer message where PSCAMA. MSG_SEQ_FLG = T.
For the Workforce Sync Clairvia message (WORKFORCE_CV_SYNC), a handler for the message reads the
generic WORKFORCE_SYNC message and copies all rows over to WORKFORCE_CV_SYNC that are for
Clairvia Employees. All past, present and future data is copied to the WORKFORCE_CV_SYNC message.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 979
Integrating with Clairvia Chapter 40
PeopleSoft Human Resources and PeopleSoft Time and Labor are installed.
Clairvia is installed.
Time reporting codes and leave plans are manually entered in Clairvia.
The PeopleSoft employee must exist in Clairvia using the messages from PeopleSoft HR.
Publish Time and Labor TL_TIME_DATA Time and Labor, Process Send reported punch and
Data Time, Publish Time and approved time to Clairvia.
Labor Data Run the TL_PUB_TLDAT
process.
Publish Leave Balances TL_TIME_DATA Time and Labor, Process Send the Base Benefits
Time, Publish Leave leave balances for
Balances subscribed employees to
Clairvia.
980 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Publish Time and Labor Data page (showing Current Date time option)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 981
Integrating with Clairvia Chapter 40
Publish Time and Labor Data page (showing Start Date and End Date time option)
Time Option Select the time frame for the published data. The values are: Current Date and
Start Date and End Date. Select Current Date to use the system date as the
reporting period to collect the data for publishing. Select Start Date and End
Date to specify a reporting period.
Start Date and End Date Enter the range of dates to process. These fields are available if you select Start
Date and End Date in the Time Option field.
Prior Date Grace Days Enter the number of days before the current date you want to include in the data
published to Clairvia. The system uses a reporting period start date equal to the
system date minus the value in this field. This field is only available if you select
Current Date in the Time Option field.
Future Date Grace Days Enter the number of days in the future you want to include in the data published
to Clairvia. The system uses a reporting period end date equal to the system date
plus the value in this field. This field is only available if you select Current Date
in the Time Option field.
982 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Verify Presence Select to publish the punch time for all employees, or any employees specified in
the Employees to Process grid. For employees that have punch time when the
process initiates, the system publishes the punch time so that Clairvia can track
employees that are present at work. The system publishes any punch times that
are available at publishing time, with a status of SV- Saved, NA - Needs
Approval, AP Approved, and SB Submitted. Leave data is not included when
you select this option.
Reported Time Select to publish reported punch time, reported leave, and leave balances to
Clairvia. Only reported time with a status of SB-Submitted, or AP-Approved, is
published.
Payable Time Select to publish employee payable time to Clairvia. The system publishes
payable time with any status other than DN, CL, IG, OE, NP, PB, and RV. In
addition, payable time with a negative quantity that is not offset, is published to
Clairvia. If you specify a TRC List, the system only publishes payable time with
those TRC's in the TRC List to Clairvia.
Note. Payable Offsets are not published to Clairvia. The system identifies offset
rows where the ORIG_SEQ_NBR is not zero.
TRC List Select which TRCs the system uses when publishing payable time within the
reported period to Clairvia. Leave this field empty to publish all payable time
within the reported period. This field is only available when you select the
Payable Time option.
Select All Employees Select to publish the leave balance for all enrolled employees for the selected
date range. Deselect this field to specify employees to include or exclude from
processing.
The following examples illustrate the payable time published to Clairvia by Time and Labor in different
situations:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 983
Integrating with Clairvia Chapter 40
1. Scenario 1: For EMPLID KU0015, EMPL_RCD=0, the original and offset rows of payable time result in
a zero quantity for the DUR.
984 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
2. Scenario 2: For EMPLID KU0015, EMPL_RCD=0, the original, offset, and new rows of payable time
result in a positive quantity for the DUR.
Note. There are two KUREG for the same DUR in this scenario because there is a split in the task. For
example, the system allocates 80% to Department A and 20% to Department B.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 985
Integrating with Clairvia Chapter 40
3. Scenario 3: For EMPLID KU0015, EMPL_RCD=0, the user reports a negative quantity for regular time
(KUREG).
986 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
4. Scenario 4: For EMPLID KU0015, EMPL_RCD=0, the original row has a status of Ignored. The payable
time row never made it to payroll. This can be because the time reporting code is not mapped to an
earning or the time rejected by payroll is intentionally closed out and is never paid.
For this scenario, SEQ_NBR 543210001 is rejected by payroll, and then closed by the user. The user
intentionally did not want this row paid. SEQ_NBR 5643210002 (TL_QUANTITY=2) is in rejected
status, but this row could still be picked up for payroll. Then there is a change in reported time that causes
the system to create offsets. The offset row is SEQ_NBR 543210011, and new time is generated for
543210012 through 543210015.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 987
Integrating with Clairvia Chapter 40
5. Scenario 5: For EMPLID KU0015, EMPL_RCD=0, Adjust Paid Time added a row (SEQ_NBR starts
with '99999' and RECORD_ONLY_ADJ = Y).
For this scenario, Time and Labor does not publish any information to Clairvia.
6. Scenario 6: For EMPLID KU0015, EMPL_RCD=0, the employee has been paid and a check reversal has
been created.
For this scenario, Time and Labor publishes the following information to Clairvia:
988 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
7. Scenario 7: For EMPLID KU0015, EMPL_RCD=0, the employee has been paid and a check reversal has
been created. However, the user wants the new estimated rows to be generated for future payment.
For this scenario, Time and Labor publishes the following information to Clairvia:
Message Definition
When you run the TL_PUB_TLDAT process from the Publish Time and Labor Data page, the system
publishes the TL_TIME_DATA Integration Broker message to Clairvia.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 989
Integrating with Clairvia Chapter 40
TL_VP_MSG contains punch time data only. This is the information specified by the Verify Presence
option on the Publish Time and Labor Data page.
TL_RT_MSG contains reported time data including all punch time, reported leave, and leave balances.
This is the information specified by the Reported Time option on the Publish Time and Labor Data page.
TL_PT_MSG contains the payable time data. This is the information specified by the Payable Time
option on the Publish Time and Labor Data page.
Access the Publish Balance page (Time and Labor, Process Time, Publish Leave Balances).
990 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
Select All Employees Select to publish the leave balance, as of the current date, for all enrolled
employees. Deselecting this field enables you to specify employees to include or
exclude from processing.
Message Definition
When you run the TL_PUB_LVBL process from the Publish Leave Balance page, the system publishes the
TL_LB_MSGC Integration Broker message to Clairvia.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 991
Integrating with Clairvia Chapter 40
The TL_LB_MSGC message is a container with one part. The message, TL_LB_MSG, contains data from
the TL_OWSSR_RUNCTL, TL_RUN_CTRL_GRP, TL_COMPLEAV_TBL, and JOB tables.
Clairvia publishes finalized schedules and leave to Time and Labor using the SCH_OWS_SCHEDULE
message. The system performs the following steps after receiving the message:
1. Time and Labor validates the schedule punch time and leave time. The system performs basic leave
validations including validating the reporting code and the employee's leave balance.
2. The system inserts valid schedules into the PS_SCH_ADHOC_DTL table, and inserts a summary of
schedules into the PS_SCH_MNG_SCH_TBL table.
3. Valid leave is inserted into the PS_TL_RPTD_TIME table with a REPORTED_STATUS of AP. The
leave plan balance is updated in the TL_COMPLEAV_TBL table.
4. Invalid schedule and leave data is inserted into the SCH_INTEG_ERROR table.
When all rows are processed successfully, the system sends a success response message to Clairvia.
Information in error is returned to Clairvia for correction. The message includes the employee's
information a rejection reason code. You can review the error data with the
SCH_INTEGRATION_ERROR query.
5 Invalid Activity
7 Invalid Event
992 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Chapter 40 Integrating with Clairvia
The following graphic shows an example of the results of the SCH_INTEGRATION_ERROR query in the
Query Viewer:
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 993
Appendix A
Note. Please read this entire section before performing any steps.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 995
Group Build Implementation for Developers Appendix A
Group Build provides a standard Group Results Table called GB_GRP_RES_TBL. This table contains the
results of the groups that you build; its content is managed entirely by the Group Build application. This
table provides a central place for storing Group Build results, so the results can be shared by all
applications that use Group Build. Do not add, delete or modify rows in this table.
If you want a table for your application where you can add, delete, or modify rows, you must perform this
optional step. Your table will be taken into account for the construction and purge processes of the Group
Build application.
a. Log on to PeopleSoft Application Designer and clone the record GB_GRP_RES_TBL into
MyClientModuleResultTable.
b. Create a new record (MyClientModuleResultTable) into which you insert (at least) the subrecord
GB_GRP_RES_SBR (the minimal structure for a modified result table). The modified results table
can contain more fields than the one that is defined in the subrecord. However, you can't use the
standard query GB_DEFAULT_QUERY. You must create your modified developer query in which
the additional fields appear in the field tab. For example, if your result table is defined as DEPTID,
define your modified query as follows:
2. (Optional) Add two fields on the client application record to store the group ID and group as of date. If
you choose not to record this information, you can use a derived/work record (see step 3) or system
variables (such as system date).
In PeopleSoft Application Designer, add two fields to the client application record
(MyClientModuleRecord):
3. In PeopleSoft Application Designer, create a derived/work record to store your group generation button.
996 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix A Group Build Implementation for Developers
4. In PeopleSoft Application Designer, Include the work page GB_API_WRK in the client application
component.
b. Insert the page named GB_API_WRK (the Group Build work page) into MyClientModuleComponent
and mark it as hidden.
5. (Optional) Using PeopleSoft Query, define the query that you might want to add to for refining your
group - developer query definition.
b. Insert the record(s) that are needed for joins and criteria.
Warning! All calls to Group Build API must be done from level 0 of your client application page.
a. GB_GROUP_ID field must be on the page, and the recordfield properties must be set to prompt table
edit on Record GB_GROUP_SEC_VW.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 997
Group Build Implementation for Developers Appendix A
This list is a funclib (DERIVED_HR_GB.GB_API FieldFormula) for PeopleCode. Specifies which API
group, query name for refinement, and results table to use.
The parameter query_name specifies a developer query name for refinement. It is optional. The
default query name is GB_DEFAULT_QUERY (view PS_GB_QRY_LINK_VW).
The parameter result_table_name is needed if the results table has been modified. It is optional. The
default result table is PS_GB_GRP_RES_TBL. The result_table_name has to be complete; for
example, PS_MY_RESULT_TABLE .
Binding values.
&ret_bool = GB_BIND(prompt_code, value)
Enables you to bind values if prompts have been defined in the modified query developer. If you're
using the standard query GB_DEFAULT_QUERY, then the only value to be bound is the refinement
date: use the delivered API, GB_BIND_DATE.
Use this function when you use the standard query GB_DEFAULT_QUERY. It enables you to bind a
date (value) as a refinement.
The parameter value is optional and specifies a refinement date. The default is %date.
If the parameter refresh_flag is set to Y, the SQL statement is generated each time you call the
function. If the refresh_flag is set to N, the function checks to see if a generated group exists and
returns its version number. If the group doesn't exist, the parameter generates it. The refresh_flag is
required.
998 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix A Group Build Implementation for Developers
Disables/enables the generic workflow and the specific workflow according to job_name value.
Specifies the job (job_name) to be scheduled in place of the default job name (used for generic
workflow), if specified.
If the job_name is specified, then the job that is named job_name must be defined in PeopleSoft
Process Scheduler, as described in the workflow section.
Providing a non-null job_name enables the corresponding workflow. Generic workflow is disabled.
Providing a null job_name as parameter enables the generic workflow (workflow by default).
Scenario 1
If you implement Group Build calls using the standard Group Result Table and query, the FieldChange
PeopleCode for DERIVED_MyClientModule.MyClientModule_GEN_BTN looks like this:
Declare Function GB_DECLARE PeopleCode DERIVED_HR_GB.GB_API FieldFormula;
/* Bind all parameters for the default Query : The Effdt of JOB */
GB_BIND_DATE(Any Date ) ;
* The list of employees for the group is now available for your own usage */
/* The code presented above populates the Group Result table GB_GRP_RES_TBL */
/* You can now use this record to populate your scrolls or can be used as a join
for a SQL Statement */
/* Clear the group result table only in the case you know the group will not be
used anymore*/
[GB_DELETE() ;]
Scenario 2
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 999
Group Build Implementation for Developers Appendix A
If you implement Group Build calls using your own modified Group Result Table and query, the
FieldChange PeopleCode for DERIVED_MyClientModule.MyClientModule_GEN_BTN looks like this:
Declare Function GB_DECLARE PeopleCode DERIVED_HR_GB.GB_API FieldFormula;
/* Give your result table name to GB_DECLARE (STEP 1 must have been previously
performed) and your Query Name if you created one */
GB_BIND ( :1 , MyClientModuleRecord.MyField1) ;
[]
GB_BIND ( :n , MyClientModuleRecord.MyFieldn) ;
GB_BIND( :n , &MyLocalVarn) ;
/* You can now use this record to populate your scrolls or work on this table */
/* Clear the group result table only in the case you know the group will not be
used anymore*/
[GB_DELETE() ;]
1000 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix A Group Build Implementation for Developers
Records that you add in QUERY must have at least one criterion.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1001
Group Build Implementation for Developers Appendix A
A retrieval of parameters.
Step01.SQL:
GB_RESET();
&RET = GB_BIND_DATE(AE_GBP002_AET.GB_REFINE_DATE);
Call the section GB_API.GB_EXEC. You must not call GB_EXEC_LIB.GB_EXEC Directly.
You will always use the GB_API AppEngine Lib.
Note. Perform your own Application Engine processing using this group.
1002 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix A Group Build Implementation for Developers
4. Create reports, based on the group that you just created, by setting up a JOB.
When the system launches the SQR, you get the GB_GROUP_ID VERSIONGBQDM (version of the
group) from the Run Control record. This enables you to retrieve the group from the Group Results Table
and print or perform processing on it.
Question Answer
What are the differences between a PeopleCode API and a For building a group, there are not many differences
PeopleSoft Application Engine API? between the two APIs.
In both APIs, you use the PeopleCode function
GB_DECLARE, GB_BIND, or GB_BIND_DATE.
Why can't we use the PeopleCode API directly in a There is a PeopleTools limitation:
PeopleSoft Application Engine PeopleCode step?
The CallAppEngine() function is not intended to be
inserted into an Application Engine PeopleCode step. If
you need to call an Application Engine program from
another Application Engine program, you must use the
Call Section Action.
Although the business process diagram looks like the Group Build generic workflow business process, you
have to develop a business process for each client application to enhance the information that is provided by
the Group Build generic workflow. The reasons for this are:
The worklist routing to enhance user information should branch the user directly to the calling-client
application page.
The worklist record table has to contain key fields for accessing the client application page, so map those
fields to the appropriate client application page fields (the workflow is triggered from the calling page).
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1003
Group Build Implementation for Developers Appendix A
The Message Agent is responsible for entering data on the client application page for triggering the specific
workflow. The Database Agent executes a query that retrieves the values that are passed as Message Agent
input fields. Therefore, the Database Agent query should retrieve the necessary key values, plus the condition
for triggering the workflow.
You have to define a new client-specific table record (MySpecificWorkflowTable). This record stores all
client application key fields, the group ID (GB_GROUP_ID) field, and the version (VERSIONGBQDM)
field. Populate the MySpecificWorkflowTable after you call Group Build (to get the version number).
Summary
1. Define a new table (MySpecificWorkflowTable) for storing the page key, group ID, and version number
fields.
5. Provide PeopleCode for storing page key values before calling Group Build.
6. Define a Database Agent query for retrieving the key field values: group ID, version number, and user ID.
7. Design the business process (activities, steps, business event, worklist routing, email routing, Database
Agent, and Message Agent) and define the necessary attributes and field mappings.
8. Define a new process for the modified Database Agent (MyDBAGProcess) in PeopleSoft Process
Scheduler.
9. Define a new job (MySpecificJobName) that serializes PeopleSoft Application Engine, calling the section
GB_EXEC in Application Engine GB_API and the modified Database Agent process
(MyDBAGProcess).
10. Pass the new job name to Group Build as a parameter through a new API function,
GB_SET_JOB_WF(MySpecificJobName), which passes the new job name to be scheduled, enables the
specific workflow, and disables the generic workflow. The call to this function must be done before the
call to GB_EXEC.
11. Add PeopleCode to save the necessary information in MySpecificWorkflowTable (see the following
procedure).
1. Design MySpecificWorkflowTable so that all the key fields that are necessary for accessing your client
application page will be recorded.
1004 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix A Group Build Implementation for Developers
2. Design MySpecificWorkflowDerived/Work.
a. Add two fields: GB_TRIGGER_WF (responsible for triggering the workflow) and OPRID (important
for routings).
3. Define a worklist record, MyWorklistRecord, for routing to the calling client application page.
Add all of your page's key fields, plus the GB_GROUP_ID and VERSIONGBQDM fields.
The DBAG query is responsible for calling the client application key field values: group ID, group
version number, and user ID.
b. Go to PeopleSoft Query.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1005
Group Build Implementation for Developers Appendix A
MySpecificWorkflowModule
MySpecificWorkflowModuleResult
Each activity has only one step branching to the client application page:
d. Add workflow PeopleCode, using the button Edit Business Rules and write the code as displayed,
providing the condition for calling the TriggerBusinessEvent function. Write the correct parameters:
business process, activity, and business event to trigger.
e. On the Worklist Attributes page, select the record defined in step 4 as the worklist record. Specify the
Business Process, its activity that works the worklist (MySpecificWorkflowModuleResult).
f. On the Field Map page, specify the mapping between the worklist record fields and your client
application page keys.
g. For the OPRID field, select the role name Roleuser by Oprid Qry, binding the OPRID query variable
to the MySpecificWorkflowDerived/Work.OPRID field.
h. For the email routing, define the field map between your email fields (SUBJECT, NOTETEXT, TO,
CC, and BCC) and your application fields.
Define the target component on the Message Attributes page and provide the path to your client
application component.
In the Query Name field, enter the database agent query defined in Step 5.
Define the mapping between the query selection fields (second column) and your client application
page fields (last column).
1006 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix A Group Build Implementation for Developers
a. Add a new process of type Database Agent on the Process Definitions page.
b. On the Process Definition Options page, override the parameters list in Append mode, specifying the
following as parameters:
kbind1=:DERIVED_HR_GB.GB_GROUP_ID2 -kbind2=:DERIVED_HR_GB.VERSIONGBQDM
-kbind1 and kbind2 are bind variables from the API work page.
Add a new job serializing the Group Build Application Engine process (the one that calls
GB_API.GB_EXEC) and MySpecificWorkflowDBAG database agent process.
On the FieldChange PeopleCode event of your Group Build calling button, use Group Build API as
described at Step 7 in the first section of this documentation. Don't forget to call the GB_SET_JOB_WF
function to activate your specific workflow and disable the generic workflow.
Any parameters that you used to generate the group; for example, if you used effective-dated job data.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1007
Group Build Implementation for Developers Appendix A
The default developer query works with the default Group Result Table.
If you use your own query, you can define more parameters and/or more fields in a personal Group
Results Table.
However, you can use your own Group Results Table with the default developer query or use the default
Group Results Table with your own query, as long as the fields selected by the query match the default Group
Results Table structure.
This means that the system regenerates the group and changes the version number if either of the following
changed since the last time you executed this group:
Note. You can bypass the versioning mechanism by calling GB_EXEC("Y"). Then the group is generated
each time it is called.
Note. When using Developer Query or User Query, keep in mind that GB_QRY_LINK_VIEW is based on
the JOB record. When Group Build generates the SQL, the system replaces all references to
GB_QRY_LINK_VIEW with JOB. If, after this is done, the left REC.FIELD is the same as the right
REC.FIELD, Group Build will not process the line in the SQL generation.
For example, if you have the criteria GB_QRY_LINK_VIEW.EFFDT <= JOB.EFFDT in Query, Group
Build will replace it with JOB.EFFDT <= JOB.EFFDT. The system will then remove the line because the left
REC.FIELD is the same as the right REC.FIELD. As a result, the Query count may differ from the one
returned by Group Build.
1008 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B
Dynamic prompting, enabling you to restrict queries and include transactional data.
Send functionality, enabling you to send the output directly to the email address of the global support
center analyst working with you.
HRMS has delivered a number of diagnostic plug-ins, which are application-specific queries, with this
version. We will post any plug-ins we develop post-GA on My Oracle Support.
See Also
Enterprise PeopleTools PeopleBook: Data Management, "Running Diagnostics with Diagnostic Framework"
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1009
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
BA_EVENT_DIAGNOSTICS
The BA_EVENT_DIAGNOSTICS plug-in (Benefits Event Definition and Rules Setup Information):
Event Rule ID
Effective Date
Provides a diagnosis of the Benefit Event Setup and Coverage Code Rules associated with it.
Data is extracted from the three primary tables: BAS_EVENT_RULE, BAS_EVENT_CLASS, and
BAS_CVG_CD_RULE. Use this diagnostic to view the underlying data as it is defined in the database for
the processing to be used by the Benefits Administration processing.
SP_DIAGNOSTICS_SALARY_STEP
SetID
Grade
Effective Date
ePerformance
ePerformance delivers two plug-ins:
Document Templates
Note. This diagnostic script can also be used with Manage Employee Reviews.
Debug/Trace Results
Document Templates
1010 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B PeopleSoft HRMS Application Diagnostic Plug-ins
Template ID
Effective Date
Provides a diagnosis of the structure of the document template that created a particular document. This
provides critical information to the support analyst for resolving an issue with a document. These tables,
all keyed by template ID and effective date, are dumped:
Debug/Trace Results
Document ID
User Role
Provides a diagnosis of the Debug/Trace results table view (EP_DBG_DIAG_VW) that is created by the
built-in Debug/Trace facility. This information is keyed by document ID and user role.
Additionally, a Send to PeopleSoft link on the Calculation Debug/Trace inquiry page enables the user to
navigate to the Application Diagnostics launch page and send this data to PeopleSoft.
Global Payroll
Global Payroll provides the following plug-ins:
GP_DIAG_000
GP_DIAG_005
GP_DIAG_010
GP_DIAG_020
GP_DIAG_030
GP_DIAG_040
GP_DIAG_100
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1011
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
GP_DIAG_200
GP_DIAG_000
Operating System
Note. If COUNTRY parameter is empty, the system returns country information for the calendar
group. If COUNTRY parameter is equal to ALL, the system returns all countries.
GP_DIAG_005
Uses the full file path and file name to the location of file as a parameters.
Provides a diagnosis of the file specified in the "Full Path + the log file name" field.
GP_DIAG_010
Provides a diagnosis of PSSQLSTMT_TBL, which returns all SQL statements used for the COBOL name
specified in the COBOL Program Name field.
GP_DIAG_020
1012 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B PeopleSoft HRMS Application Diagnostic Plug-ins
PSAEAPPLDEFN
PSAEAPPLSTATE
PSAESECTDTLDEFN
PSAESTEPDEFN
PSAESTEPMSGDEFN
PSAESTMTDEFN
PSSQLTEXTDEFN
GP_DIAG_030
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1013
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
Provides a diagnosis of the following tables, based on the element type returned, for each of up to five
element definitions:
GP_DIAG_040
1014 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B PeopleSoft HRMS Application Diagnostic Plug-ins
PS_GP_DIAG_ARRAY_D: All arrays of a country not synchronized with the record definition.
PS_GP_DIAG_WA_D: All write arrays of a country not synchronized with the record definition.
GP_DIAG_100
GP_DIAG_200
EmplID
Calendar Group ID
Calendar ID
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1015
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
PS_GP_DIAG_EMPL_D: Dates.
TL_DIAGNOSTICS_TA_EMPL_PAY
TL_DIAGNOSTICS_TA_EMPL_GRP
TL_DIAGNOSTICS_TA_TACODE
TL_DIAGNOSTICS_TA_RPTD_TIME
TL_DIAGNOSTICS_PT_INV_PAYTIME
TL_DIAGNOSTICS_PT_DUP_SEQ
TL_DIAGNOSTICS_PT_INV_OFFSET
TL_DIAGNOSTICS_SETUP_TIMEPRD
TL_DIAGNOSTICS_SETUP_TIMEZONE
TL_DIAGNOSTICS_SETUP_RULEPGM
TL_DIAGNOSTICS_SETUP_ EXWRKGRP
TL_DIAGNOSTICS_SETUP_TCD
1016 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B PeopleSoft HRMS Application Diagnostic Plug-ins
TL_DIAGNOSTICS_TA_EMPL_PAY
Payable time for employees are displayed for the given date range. The exceptions created (if any) for that
date range are also displayed.
EmplID
Employee Record
Start Date
End Date
Create SQL:
TL_DIAGNOSTICS_TA_EMPL_GRP
If the Run Control ID has a dynamic group included, the list of employees in the group is resolved. These
employees are checked if they are Active between the Process Through Date and Process Through Date 31
days.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1017
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
SQLExec:
CreateSQL:
TL_DIAGNOSTICS_TA_TACODE
The TL_DIAGNOSTICS_TA_TACODE plug-in (listing of SQL Object IDs and SQL statements used in the
time administration process):
TL_DIAGNOSTICS_TA_RPTD_TIME
This lists the reported time details of an employee in a give date range based on the reported status (input
parameter). If the EmplID is not given as input this lists all the employees with the specific reported status in
the given date range.
EmplID
Start Date
End Date
1018 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B PeopleSoft HRMS Application Diagnostic Plug-ins
SQLExec:
SQLExec:
Create SQL:
Create SQL:
TL_DIAGNOSTICS_PT_INV_PAYTIME
The TL_DIAGNOSTICS_PT_INV_PAYTIME plug-in (lists payable time where payable status is rejected by
payroll for a date range):
Start Date
End Date
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1019
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
TL_DIAGNOSTICS_PT_DUP_SEQ
The TL_DIAGNOSTICS_PT_DUP_SEQ plug-in (lists duplicate sequence numbers for the offsets) provides
a diagnosis of SQL for the View: TL_DU_PT_SEQ_VW:
TL_DIAGNOSTICS_PT_INV_OFFSET
The TL_DIAGNOSTICS_PT_INV_OFFSET plug-in (lists the Payable time offsets rejected by Payroll)
provides a diagnosis of SQL for the View: TL_DU_PT_OFF_VW:
TL_DIAGNOSTICS_SETUP_TIMEPRD
The plug-in displays the Period IDs that are not built over the given date range, along with the workgroup
from PS_TL_WRKGRP_TBL.
1020 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix B PeopleSoft HRMS Application Diagnostic Plug-ins
Start Date
End Date
TL_DIAGNOSTICS_SETUP_TIMEZONE
The Plug-in obtains the time zone of the employee using the input EmplID and displays the time zone offsets
within the given date range.
EmplID
Start Date
End Date
TL_DIAGNOSTICS_SETUP_RULEPGM
The plug-in is used to display the list of workgroups that do not have Rule Programs associated to them.
TL_DIAGNOSTICS_SETUP_ EXWRKGRP
The plug-in displays the list of all exception time reporter type workgroups with missing Schedule ID.
Workgroups of exception time reporter type are displayed if a Schedule ID is not attached to them.
The TL_DIAGNOSTICS_SETUP_ EXWRKGRP plug-in provides a diagnosis of SQL for the View:
TL_DU_ST_SCH_VW.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1021
PeopleSoft HRMS Application Diagnostic Plug-ins Appendix B
TL_DIAGNOSTICS_SETUP_TCD
The plug-in verifies the TCD setup data. For the given TCD ID input, the plug-in traces the TCD (message
node name), message name, message status, transaction status and type of transaction. It also verifies checks
for the Integration type. Displays whether the Inbound, outbound directories are specified for Flat file type of
integration.
CreateSQL:
CreateSQL:
1022 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C
Administer Training
Administer Workforce
Plan Careers
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1023
Delivered Workflows for PeopleSoft HRMS Appendix C
Note. While several workflow business processes are delivered with your HRMS system, the system is
delivered with all workflow turned off. You must activate PeopleSoft Workflow to use it.
Note. You must set up workflow for PeopleSoft self service applications using pages on the Set Up HRMS,
Common Definitions, Self Service menu.
See Chapter 34, "Setting Up and Working with Self-Service Transactions," Using Workflow with Self-
Service Transactions, page 852.
While you could manually assign each employee to a role on the User Profile component, this process is
tedious if you're designating many employees as users. Some workflow processes could involve every
individual in your organization at one time or another. Using the message agent is a faster way to transform
your employees into workflow role users.
Functionality Query
Using the dynamic role user query method ensures that the Supervisor role user assignment is as accurate as
your live human resources data. The dynamic query also frees you from maintaining two sets of human
resources supervisor data, one in your human resources system and the other in the Role User Table.
The default query is [ROLE] Supervisor-Part Posn Mgt Role User Query. All generic PeopleTools workflows
use that query. The query does not run against your live human resources database, but against the Role User
Table.
To use one of the other Supervisor role user queries in PeopleSoft Workflow, you must modify all routings
involving supervisors.
1024 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description Upon enrolling a student for a course, a worklist item is sent to HR
Technical/Administrator notifying them of the training request for review and approval.
Workflow Objects
Event TRN_STUDNT_CRS_DT2
Role HR Technical/Admin
Description
Event Description Upon enrolling a student for a course, a worklist item is sent to Training Administrator
for authorization.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1025
Delivered Workflows for PeopleSoft HRMS Appendix C
Workflow Objects
Event TRN_STUDNT_CRS_DT2
Description
Event Description Upon enrolling a student for a course, a worklist item is sent to the supervisor (part
position management) notifying them of the training request for review and approval.
Workflow Objects
Event COURSE_ENROLLMENT1
1026 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description Upon enrolling a student for a course, a worklist item is sent to the supervisor (part
position management) notifying them of the training request for review and approval.
Workflow Objects
Event CRSE_ENRL_WL
Description
Event Description Upon enrolling a student for a course, a worklist item is sent to the supervisor (part
position management) notifying them of the training request for review and approval.
Workflow Objects
Event TRN_STUDNT_CRS_DT2
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1027
Delivered Workflows for PeopleSoft HRMS Appendix C
Send Confirmation
This section discusses the send confirmation workflow.
Description
Event Description Upon a student being enrolled in a class, the student will receive an email with the
details of the course in which he/she is enrolled.
Workflow Objects
Event RUNCTL_TRN001
Send Cancellation
This section discusses the send cancellation workflow.
1028 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description When a course has been cancelled, the enrolled students will receive email with the
details of the course in which he/she is enrolled and that has been cancelled.
Workflow Objects
Event RUNCTL_TRN001
Send Rescheduling
This section discusses the send rescheduling workflow.
Description
Event Description When a course has been rescheduled, the enrolled students will receive email with the
new schedule of the course in which he/she is enrolled.
Workflow Objects
Event RUNCTL_TRN001
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1029
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Action Description Upon the '60 Day Tenure Notices' process being run to identify Tenure Conversions, a
worklist item is sent to the supervisor(s) of all employees who will reach their Tenure
Conversion dates within the next 60 days.
Upon the '60 Day Probation Term Notices' process being run to identify Probation
Terms, a worklist item is sent to the supervisor(s) of all employees who will reach their
Probation Termination dates within the next 60 days.
Upon the '60 Day WGI Notices' process being run to identify WGI's (Within Grade
Increases), a worklist item is sent to supervisor(s) of all employee for whom WGI's are
due within the next 60 days.
Workflow Objects
Event GVT_60_DAY_REV
1030 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
(USF) Generic
This section discusses the Generic workflow.
Description
Event Description This is a common email and workflow event for administrator self-service notifications.
Workflow Objects
Event EE_HR_PROC
Hire Employees
This section discusses the Hire Employee workflow.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1031
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description The business event, Hire Employee, is triggered whenever a new employee is hired. The
entire Hire Employee business process takes place within this one event. The system
utilizes workflow to send notification about the new hire to various roles within the
organization required to take action.
Upon hiring an employee in France, the system also routes email/worklist items to the
Personal Administrator for various events.
Action Description Benefits Administrator - The system directs an email to the Benefits Administrator to the
Manage Benefit Enrollment activity for the new hire.
Facilities Manager - The system directs an email to the Facilities Administrator to the
Company Property pages to issue the appropriate company property to the new hire.
(USF) MIS Administrator - Sends an email to the MIS Administrator to let him/her
know about the new hire. Login ID's and/or PC equipment can be set up appropriately.
Payroll Administrator - The system directs an email to the Payroll Administrator to the
Update Deduction Data activity for the new hire.
Training Administrator - The system directs an email to the Training Administrator to
Enroll Students activity to enroll the new hire in company orientation classes.
Variable Compensation Administrator - The system routes an email to the Variable
Compensation Administrator to let him/her know about the new hire and determine if
this new hire can be included into a compensation plan.
Benefits Administrator - The system directs a worklist item to the Benefits Administrator
to the Manage Benefit Enrollment activity for the new hire.
Facilities Manager - The system directs a worklist item to the Facilities Administrator to
the Company Property pages to issue the appropriate company property to the new hire.
Payroll Administrator - The system directs a worklist item to the Payroll Administrator
to the Update Deduction Data activity for the new hire.
Training Administrator - The system directs a worklist item to the Training
Administrator to Enroll Students activity to enroll the new hire in company orientation
classes.
An email is sent to the Personal Administrator (FRA) to remind them that the Single
Hiring Statement should be sent with a minimum set of mandatory information prior the
hire date.
A worklist item is sent to the HR Administrator (FRA) to remind them that the Single
Hiring Statement should be sent with a minimum set of mandatory information prior the
hire date.
Action Description An email is sent to the HR Administrator (FRA) when an employee is hired into the
(continued) system with a start date in the future. This reminder warns them that the Single Hiring
Statement should be sent with a minimum set of mandatory information prior the hire
date.
A worklist item is sent to the HR Administrator (FRA) when an employee is hired into
the system and additional information regarding the employee is needed.
1032 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event JOB_DATA_EMP
EE_HIRE
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1033
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Action Description Upon a change to an employee's service date in the system, an email and worklist item
are sent to the Benefits Administrator so any further processing on the Benefits side can
occur.
When a job action change has been performed on an employee with multiple jobs, a
worklist item is sent to the Benefits Administrator notifying them to review the Primary
Job indicators and Flags.
An email is sent to notify the Variable Compensation Administrator to review the
changes and take appropriate action if necessary.
Upon a change to an employee's Benefits System, an email and worklist item are sent to
the Benefits Administrator so any further processing on the Benefits side can occur.
When a change is made to an employee's Job record, if the action added or changed
matches the Stock Action list (defined in Stock Action Reasons), then a worklist item is
sent to the Stock Administrator to take appropriate action.
Works Council Specific - Upon the HR Administrator making a decision on a job change
request, an email and worklist item is sent to the Works Council for review.
Works Council Specific - Upon the HR Administrator making a decision on a job change
request, an email is sent to notify the employee.
Works Council Specific - Upon the HR Administrator making a decision on a job change
request, an email and worklist item is sent to the new manager informing them of the
decision.
Works Council Specific - Upon the HR Administrator making a decision on a job change
request, an email and worklist item is sent to the current manager informing them of the
decision.
Works Council Specific - When the HR Administrator requests a job change for an
employee, the request is routed via email and worklist item to the Works council for
review and approval.
Workflow Objects
Event JOB_DATA
WC_JOB_CHG_REQ_HR
EE_HR_PROC
1034 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1035
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Action Description Upon a change to an employee's birth date in the system, an email and worklist item are
sent to the Benefits Administrator so any further processing on the Benefits side can
occur.
(CAN) Upon a change to an employee's Province of residence, an email and worklist
item are sent to the Payroll Administrator so any further processing on the Payroll side
can occur.
Upon a change to an employee's state of residence, an email and worklist item are sent to
the Payroll Administrator so any further processing on the Payroll side can occur.
Workflow Objects
Event PERSONAL_DATA
EE_HR_PROC
1036 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Action Description Upon the First Authorizer approving a PAR, a worklist item is sent to the Second
Authorizer for review/approval as the next step in the process.
When a request is routed to the First Authorizer for approval and is disapproved or
returned, a worklist item is sent to the employee's manager with requested information or
notifying them of the disapproved request.
When a request is routed to the First Authorizer for approval and is disapproved or
returned, an email is sent to the employee with requested information or notifying them
of the disapproved request.
Upon the Second Authorizer approving a PAR, a worklist item is sent to the final
approver in the process for Approval and Signature.
When a request is routed to the Second Authorizer for approval and is disapproved or
returned, a worklist item is sent to the employee's manager with requested information or
notifying them of the disapproved request.
When a request is routed to the Second Authorizer for approval and is disapproved or
returned, an email is sent to the employee with requested information or notifying them
of the disapproved request.
When a request is routed to HR for final approval and signature, a worklist item is sent
to the HR Administrator notifying them of the transaction to be processed.
When a request is disapproved or returned by the final approver, a worklist item is sent
to the employee's manager with requested information or notifying them of the
disapproved request.
When a request is disapproved or returned by the final approver, an email is sent to the
employee with requested information or notifying them of the disapproved request.
Upon an employee submitting a PAR request, a worklist item is sent to the employee's
manager for first level approval.
When a request is routed to HR for approval and final processing and is disapproved or
returned, a worklist item is sent to the employee's manager with requested information or
notifying them of the disapproved request.
When a request is routed to HR for approval and final processing and is disapproved or
returned, an email is sent to the employee with requested information or notifying them
of the disapproved request.
When a manager-submitted request is disapproved, a worklist item is sent to the
employee's manager notifying them of the disapproval.
When a manager-submitted request is disapproved, an email is sent to the employee
notifying them of the disapproval.
When an employee's manager submits a PAR request for an employee, a worklist item is
sent to the first level approver (First Authorizor) for review and approval.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1037
Delivered Workflows for PeopleSoft HRMS Appendix C
Action Description Once the Retro WGI request has passed the authorization and approval processes, it goes
(continued) directly to the Human Resources office for final processing. A worklist item is sent to
the employee's manager once HR has completed processing of the Retro WGI for that
employee.
Once the Manual WGI request has passed the authorization and approval processes, it
goes directly to the human resources office for final processing. A worklist item is sent
to the employee's manager once HR has completed processing of the Manual WGI for
that employee.
Once the Probation Termination request has passed the authorization and approval
processes, it goes directly to the human resources office for final processing. A worklist
item is sent to the appropriate manager once HR has completed processing.
Once the Tenure Conversion request has passed the authorization and approval
processes, it goes directly to the human resources office for final processing. A worklist
item is sent to the appropriate manager once HR has completed processing.
Once a WGI request has passed the authorization and approval processes, it goes directly
to the human resources office for final processing. A worklist item is sent to the
employee's manager once HR has completed processing of the WGI for that employee.
Workflow Objects
Event EE_1ST_AUTH
EE_2ND_AUTH
EE_APPROVAL
EE_EMPL_REQ
EE_HR_PROC
EE_SUP_REQ
GVT_COMP_ACTN
1038 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1039
Delivered Workflows for PeopleSoft HRMS Appendix C
Terminate Employee
This section discusses the Terminate Employee workflow.
Description
Event Description Upon termination of an employee, various notifications are sent to roles within the
organization to take action.
1040 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Action Description This event sends an email to the employee's manager notifying them that the employee
has been terminated.
This event sends an email to the Training Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel any
outstanding course enrollments.
This event sends a worklist item to the Training Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel any
outstanding course enrollments.
This event sends an email to the designated person notifying them that the employee has
been terminated so appropriate action can be taken to review profit sharing for the
employee.
This event sends a worklist item to the designated person notifying them that the
employee has been terminated so appropriate action can be taken to review profit sharing
for the employee.
This event sends an email to the Benefits Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel benefits for
the employee.
This event sends a worklist item to the Benefits Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel benefits for
the employee.
This event sends an email to the Payroll Administrator notifying them that the employee
has been terminated so appropriate action can be taken to process final pay for the
employee.
This event sends a worklist item to the Payroll Administrator notifying them that the
employee has been terminated so appropriate action can be taken to process final pay for
the employee.
This event sends an email to the terminating employee if that employee has profit-
sharing rights notifying them to choose how they want to manage their account going
forward.
This event sends a worklist item to the terminating employee if that employee has profit-
sharing rights notifying them to choose how they want to manage their account going
forward.
Workflow Objects
Event JOB_DATA
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1041
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description Upon termination of an employee, various notifications are sent to roles within the
organization to take action.
1042 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Action Description This event sends an email to the MIS Administrator notifying them that the employee
has been terminated so appropriate action can be taken to disable system accounts.
This event sends an email to the employee's manager notifying them that the employee
has been terminated.
This event sends an email to the Training Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel any
outstanding course enrollments.
This event sends a worklist item to the Training Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel any
outstanding course enrollments.
This event sends an email to the Benefits Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel benefits for
the employee.
This event sends a worklist item to the Benefits Administrator notifying them that the
employee has been terminated so appropriate action can be taken to cancel benefits for
the employee.
This event sends an email to the Payroll Administrator notifying them that the employee
has been terminated so appropriate action can be taken to process final pay for the
employee.
This event sends a worklist item to the Payroll Administrator notifying them that the
employee has been terminated so appropriate action can be taken to process final pay for
the employee.
This event sends an email to the Facilities Administrator notifying them that the
employee has been terminated so appropriate action can be taken to collect any
outstanding company property from the employee prior to leaving.
This event sends a worklist item to the Facilities Administrator notifying them that the
employee has been terminated so appropriate action can be taken to collect any
outstanding company property from the employee prior to leaving.
Workflow Objects
Event EE_HR_PROC
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1043
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
This section discusses the Approve or Deny Ad Hoc Salary Changes workflow.
Event Description An administrator or manager approves or rejects an ad hoc salary change request.
Action Description Employees receive an email when the administrator approves or rejects the ad hoc salary
change request.
Workflow Objects
1044 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description An administrator or manager approves or rejects a budgeted salary request for a group of
employees.
Action Description Manager receives an email when the administrator or approving manager approves or
rejects the budgeted salary request for a group of employees.
Workflow Objects
Description
Workflow Objects
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1045
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Workflow Objects
Description
Event Description When employees and managers use Employee Reviews to create evaluations, this
generic notification event is used to support email notifications that are sent to the
appropriate participant.
Action Description Email notifications are sent to inform the appropriate persons of: the availability of
documents for viewing and updating; a change in the status of documents; and the
transfer of documents to a new manager.
1046 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description Workflow is generated when an administrator approves an employee's request for release
of profit-sharing funds.
Action Description The email notifies employees that their fund release request is approved.
Workflow Objects
Event WP_PROFIT_SHARING
Role Employee
Error in Fund
This section discusses the Error in Fund workflow.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1047
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When the Process Interest and Payment process encounters an error an employee's fund,
an email is sent to the administrator to notify them to review.
Action Description The email notifies the administrator of an error in an employee's fund.
Workflow Objects
Event WP_FUND_STATUS
Description
Event Description When employees change the financial organization on the Investment page of the
Agreement Personalization component (WP_AGREEMENT_CUST), workflow is
generated to notify the administrator of the change.
Action Description Worklist and an email notify the administrator of the change in financial organization.
Workflow Objects
Event WP_AGREEMENT_CUST
1048 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description When the fund status for a fund is modified by the Process Interest and Payment process,
an email is sent to inform the member of the change.
Action Description The email notifies employees of the change of fund status.
Workflow Objects
Event WP_FUND_STATUS
Role Employee
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1049
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description Workflow is generated when an administrator rejects an employee's request for release
of profit-sharing funds.
Action Description The email notifies employees that their fund release request was rejected.
Workflow Objects
Event WP_PROFIT_SHARING
Role Employee
Description
Event Description Employee submits a request for release of profit-sharing funds from the Personal
Entitlements component (WP_FUND_RELEASE). Workflow is generated to notify the
administrator of the request.
Action Description From the email or worklist, the system transfers the administrator to the Employee
Release Detail page where he or she can view and approve or reject the fund release
request.
Workflow Objects
Event WP_FUND_RELEASE
1050 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description When a hiring is in progress and the employee record is updated, the system generates a
worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE.
Workflow Objects
Event HIRE
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1051
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When the headcount manager allocates the CAE, this workflow generates a worklist
entry
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation.
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description If the headcount manager denies the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who deletes
the hiring.
1052 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who deletes the CAE.
Workflow Objects
Event FPA_CA_STMP_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1053
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller approves the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who validates
the hiring.
Workflow Objects
Event FPA_CA_STMP_GRP
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates an email to
the manager.
Action Description The email informs the manager that the hiring is postponed
1054 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_STMP_GRP
Role FP_GEST_EFFECTIFS
Description
Event Description When the headcount manager deletes the CAE, the system generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the hiring.
Workflow Objects
Event FPA_CA_DENI_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1055
Delivered Workflows for PeopleSoft HRMS Appendix C
Grade Change
This section discusses the Grade Change workflow in the Grade Change activity.
Description
Event Description When a grade change is in progress and the employee record is updated, the system
generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE.
Workflow Objects
Event FPAEECAREER_PNL
Description
Event Description When the headcount manager allocates the CAE for the grade change, this workflow
generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation.
1056 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_CHNG_GRP
Description
Event Description If the headcount manager denies the allocation of the CAE for the grade change, this
workflow generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who deletes
the request for grade change.
Workflow Objects
Event FPA_CA_CHNG_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1057
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the headcount manager denies the allocation of the CAE for the grade change, this
workflow generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who deletes
the request for grade change.
Workflow Objects
Event FPA_CACH_STMP_GRP
Description
Event Description If the finance controller approves the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who validates
the grade change.
1058 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CACH_STMP_GRP
Description
Event Description If the finance controller holds or postpones the CAE for the grade change, this workflow
generates an email.
Action Description An email informs the manager that the grade change process is postponed.
Workflow Objects
Event FPA_CACH_STMP_GRP
Role FP_GEST_EFFECTIFS
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1059
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When the headcount manager deletes the CAE request for grade change, the system
generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the grade change.
Workflow Objects
Event FPA_CA_DENI_GRP
Description
Event Description When a Work Time Percentage (WTP) Change is in progress and the employee record is
updated, the system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE for WTP.
1060 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPAEEWORKRT_PNL
Description
Event Description When the headcount manager allocates the CAE for WTP, this workflow generates a
worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation.
Workflow Objects
Event FPA_CA_CHNG_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1061
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When the headcount manager denies the allocation of the CAE, this workflow generates
a worklist entry.
Action Description When this worklist is selected, the system transfers the control to the manager who
deletes the Work Time Percentage change.
Workflow Objects
Event FPA_CA_CHNG_GRP
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who deletes the CAE for work time percentage change.
1062 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CACH_STMP_GRP
Description
Event Description If the finance controller approves the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who validates
the Work Time Percentage Change.
Workflow Objects
Event FPA_CACH_STMP_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1063
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates a worklist
entry.
Action Description The email informs the manager that the approval for the Work time Percentage change is
postponed.
Workflow Objects
Event FPA_CACH_STMP_GRP
Role FP_GEST_EFFECTIFS
Description
Event Description Once the headcount manager has deleted the CAE, the system generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the work time percentage change.
1064 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_DENI_GRP
Double Change
This section discusses the Double Change workflow in the CAE and Grade and Work Time Percentage
Change activity.
Description
Event Description When a grade and work time percentage change is in progress and the employee record
is updated, the system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers the control to the headcount
manager who allocates a new CAE.
Workflow Objects
Event FPAEEWORKRT_PNL
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1065
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description Once the headcount manager allocates the CAE, this workflow generates a worklist
entry.
Action Description When the worklist entry is selected, the system transfers control to the Finance
Controller who stamps the CAE allocation for the grade and work time percentage
change.
Workflow Objects
Event FPA_CA_CHNG_GRP
Description
Event Description Once the headcount manager denies the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who deletes
the Grade and work time percentage change.
1066 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_CHNG_GRP
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager so
that he deletes the CAE for grade and work time percentage change.
Workflow Objects
Event FPA_CACH_STMP_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1067
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller approves the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who validates
the grade and work time percentage change.
Workflow Objects
Event FPA_CACH_STMP_GRP
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates an email.
1068 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Action Description An email informs the manager that the grade / work time percentage change is
postponed.
Workflow Objects
Event FPA_CACH_STMP_GRP
Role FP_GEST_EFFECTIFS
Description
Event Description Once the headcount manager has deleted the CAE, the system generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the grade and work time percentage change.
Workflow Objects
Event FPA_CA_DENI_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1069
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When a termination is in progress, once the employee record is updated, the system
generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who de-allocates the CAE.
Workflow Objects
Event FPAEELEGAL_PNL
Description
Event Description When the headcount manager de-allocates the CAE, this workflow generates a worklist
entry.
1070 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE de-allocation.
Workflow Objects
Event FPA_CA_DISCH_GRP
Description
Event Description Once the headcount manager denies the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who deletes
the termination.
Workflow Objects
Event FPA_CA_DISCH_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1071
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller denies stamping of the CAE for de-allocation, this workflow
generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who restores the CAE.
Workflow Objects
Event FPA_CA_STMP_DSCH
Description
Event Description If the finance controller approves the de-allocation of the CAE, this workflow generates
a worklist entry.
1072 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Action Description When this worklist is selected, the system transfers control to the manager who validates
the termination.
Workflow Objects
Event FPA_CA_STMP_DSCH
De-allocation Postponed
This section discusses the De-allocation Postponed workflow in the CAE De-allocation Stamp activity.
Description
Event Description If the finance controller holds or postpones the CAE for de-allocation, this workflow
generates an email.
Action Description An email informs the manager that the termination is postponed.
Workflow Objects
Event FPA_CA_STMP_DSCH
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1073
Delivered Workflows for PeopleSoft HRMS Appendix C
CAE Request
This section discusses the CAE Request workflow in the Return activity.
Description
Event Description When a return is in progress and the employee record is updated, the system generates a
worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE for the return
Workflow Objects
Event FPAEELEGAL_PNL
Description
Event Description When the headcount manager allocates the CAE, this workflow generates a worklist
entry.
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation for return.
1074 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description When the headcount manager denies the allocation of the CAE, this workflow generates
a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return.
Workflow Objects
Event FP_CA_CR_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1075
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who deletes the CAE allocation for the return.
Workflow Objects
Event FPA_CA_STMP_GRP
Description
Event Description If the finance controller approves the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who finalizes
the return.
1076 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_STMP_GRP
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates an email.
Action Description An email informs the manager that the return is postponed
Workflow Objects
Event FPA_CA_STMP_GRP
Role FP_GEST_EFFECTIFS
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1077
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description Once the headcount manager has deleted the CAE, the system generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return.
Workflow Objects
Event FPA_CA_DENI_GRP
Description
Event Description When a return and grade change activity is in progress and the employee record is
updated, the system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE.
1078 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPAEECAREER_PNL
Description
Event Description Once the headcount manager allocates the CAE, this workflow generates a worklist
entry.
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation for return and grade change.
Workflow Objects
Event FP_CA_CR_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1079
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When the headcount manager denies the allocation of the CAE, this workflow generates
a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return and grade change.
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who cancels the return and grade change.
1080 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_STMP_GRP
Description
Event Description If the finance controller approves the allocation of the CAE for the return and grade
change, this workflow generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who finalizes
the return and grade change.
Workflow Objects
Event FPA_CA_STMP_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1081
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates an email.
Action Description An email informs the manager that the return and grade change process is postponed.
Workflow Objects
Event FPA_CA_STMP_GRP
Role FP_GEST_EFFECTIFS
Description
Event Description When the headcount manager has deleted the CAE, the system generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return and grade change.
1082 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_DENI_GRP
Description
Event Description When a return and work time percentage change process is in progress and the employee
record is updated, the system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE.
Workflow Objects
Event FPAEEWORKRT_PNL
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1083
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When the headcount manager allocates the CAE, this workflow generates a worklist
entry.
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation for the return and work time percentage change.
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description When the headcount manager denies the allocation of the CAE, this workflow generates
a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return and work time percentage change.
1084 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who cancels the CAE corresponding to the return and work time percentage change.
Workflow Objects
Event FPA_CA_STMP_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1085
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller approves the allocation of the CAE for the Return and work time
percentage change, this workflow generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who finalizes
the return and work time percentage change.
Workflow Objects
Event FPA_CA_STMP_GRP
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates an email.
Action Description An email informs the manager that the return and work time percentage change is
postponed.
1086 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FPA_CA_STMP_GRP
Role FP_GEST_EFFECTIFS
Description
Event Description When the headcount manager has deleted the CAE, the system generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return and work time percentage change.
Workflow Objects
Event FPA_CA_DENI_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1087
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description When a return and grade and work time percentage change is in progress and the
employee record is updated, the system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the headcount
manager who allocates a new CAE.
Workflow Objects
Event FPAEEWORKRT_PNL
Description
Event Description When the headcount manager allocates the CAE, this workflow generates a worklist
entry.
Action Description When the worklist entry is selected, the system transfers control to the finance controller
who stamps the CAE allocation for the Return and Grade and Work Time Percentage
Change.
1088 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event FP_CA_CR_GRP
Description
Event Description When the headcount manager denies the allocation of the CAE, this workflow generates
a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the Return and Grade and Work Time Percentage Change.
Workflow Objects
Event FP_CA_CR_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1089
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description If the finance controller denies stamping of the CAE, this workflow generates a worklist
entry.
Action Description When this worklist is selected, the system transfers control to the headcount manager
who cancels the CAE corresponding to the return and grade and work time percentage
change.
Workflow Objects
Event FPA_CA_STMP_GRP
1090 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description If the finance controller approves the allocation of the CAE, this workflow generates a
worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who finalizes
the return and grade and work time percentage change.
Workflow Objects
Event FPA_CA_STMP_GRP
Description
Event Description If the finance controller holds or postpones the CAE, this workflow generates an email.
Action Description An email informs the manager that the return and grade and work time percentage
change is postponed.
Workflow Objects
Event FPA_CA_STMP_GRP
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1091
Delivered Workflows for PeopleSoft HRMS Appendix C
Role FP_GEST_EFFECTIFS
Description
Event Description When the headcount manager deletes the CAE, the system generates a worklist entry.
Action Description When this worklist is selected, the system transfers control to the manager who cancels
the return with grade and work time percentage change.
Workflow Objects
Event FPA_CA_DENI_GRP
Accept Tenure
This section discusses the Accept Tenure workflow in the Tenure Probation Period Validation activity.
1092 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description When a Tenure Probation Period is in progress and the manager approves the tenure, the
system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the HR manager who
grants tenure.
Workflow Objects
Event FPATEN_VALID_PNL
Description
Event Description When a Tenure Probation Period is in progress and the manager renews the tenure, the
system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the HR manager who
renews the probation period.
Workflow Objects
Event FPATEN_VALID_PNL
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1093
Delivered Workflows for PeopleSoft HRMS Appendix C
Refuse Tenure
This section discusses the Refuse Tenure workflow in the Tenure Probation Period Validation activity.
Description
Event Description When a tenure probation period is in progress and the manager refuses the tenure, the
system generates a worklist entry.
Action Description When the worklist entry is selected, the system transfers control to the HR manager who
issues the termination order.
Workflow Objects
Event FPATEN_VALID_PNL
1094 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description A person is hired and is subsequently added to the Professional Compliance business
process.
Note. This occurs only when a default Professional Compliance Type is associated with
the job code of the person being hired.
Workflow Objects
Description
Event Description A person is manually added to the Professional Compliance business process.
Action Description The PCMP_BUS_PROC business process sends an email notification to the general
supervisor of the person informing them that the person has been added within the
Professional Compliance business process and that further action is required.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1095
Delivered Workflows for PeopleSoft HRMS Appendix C
Workflow Objects
Description
Event Description There is a change in classification level for a person that is part of the Professional
Compliance business process.
Action Description The PCMP_BUS_PROC business process sends an email notification to the compliance
supervisor of the person informing them that there has been a change of classification
within the Professional Compliance business process and that further action is required.
If the change in classification is for a supervisor, their compliance manager should be
notified.
Workflow Objects
Description
Event Description There is a job change for a person that is part of the Professional Compliance business
process.
1096 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Action Description The PCMP_BUS_PROC business process sends an email notification to the compliance
supervisor of the person informing them that there has been a change of job and that
further action is required.
If the change in classification is for a supervisor, their compliance manager should be
notified.
Workflow Objects
Description
Event Description The recertification Application Engine program runs for persons in the Professional
Compliance business process.
Action Description The PCMP_BUS_PROC business process sends a notification to the compliance
supervisor informing them of lapsed or upcoming license and certification expiration
dates.
If the certification information is for a supervisor, their compliance manager should be
notified.
Workflow Objects
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1097
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description There is a termination of a person that is part of the Professional Compliance business
process.
Workflow Objects
Description
Event Description User changes the awards calculated or the award status of individual variable
compensation plans.
Action Description Manager approves changes that have been made to the calculated amounts or status of
individual variable compensation plans.
Workflow Objects
1098 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Description
Event Description User changes the awards calculated or the award status of individual variable
compensation plans.
Action Description Manager denies changes that have been made to the calculated amounts or status of
individual variable compensation plans.
Workflow Objects
Description
Event Description User changes the awards calculated for group members or the award status of individual
variable compensation plans.
Action Description Manager approves changes that have been made to the calculated amounts for group
members or the award status of individual variable compensation plans.
Workflow Objects
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1099
Delivered Workflows for PeopleSoft HRMS Appendix C
Description
Event Description User changes the awards calculated for group members or the award status of individual
variable compensation plans.
Action Description Manager denies changes that have been made to the calculated amounts for group
members or the status of individual variable compensation plans.
Workflow Objects
Description
Event Description Manager or approver makes changes to the variable compensation award for a group.
Action Description Approving manager approves or denies changes to the variable compensation award for
a group.
Workflow Objects
1100 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
VC Tree Changes
This section discusses the VC Tree Changes workflow.
Description
Action Description Approving manager approves or denies changes to the variable compensation tree.
Workflow Objects
VC Tree Delete
This section discusses the VC Tree Delete workflow.
Description
Action Description Approving manager approves or denies the deletions to the variable compensation tree.
Workflow Objects
Role VC Administrator
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1101
Delivered Workflows for PeopleSoft HRMS Appendix C
VC Tree Rename
This section discusses the VC Tree Rename workflow.
Description
Action Description Approving manager approves or denies the renaming of the variable compensation tree.
Workflow Objects
Role VC Administrator
Description
Event Description When a career plan is created or updated for an employee, a worklist entry is sent to the
Supervisor.
Action Description When a manager approves a career plan for an employee, a worklist entry is sent to the
HR Developmental Staff role.
When a manager disapproves a career plan for an employee, a worklist entry is sent back
to the Supervisor.
When HR disapproves a career plan for an employee, a worklist entry is sent back to the
Supervisor.
1102 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix C Delivered Workflows for PeopleSoft HRMS
Workflow Objects
Event CAREER_PLAN
Business Event Submit Plan to Manager; Manager Approves Plan; Manager Disapproves Plan; HR
Disapproves Plan.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1103
Appendix D
To offer our customers more robust and complete reporting solutions, Oracle's PeopleSoft Enterprise
development teams are converting some of the existing Crystal reports into XML Publisher (XMLP) format.
Oracle provides a standalone Java-based reporting technology named Oracle Business Intelligence Publisher
(BI Publisher) that streamlines report and form generation. XMLP uses select features from BI Publisher that
have been integrated into PeopleTools. XML Publisher for PeopleSoft Enterprise provides native XMLP
technology for PeopleSoft Query and Connected Query, as well as any PeopleSoft application.
XMLP separates the data extraction process from the report layout. XMLP provides the ability to design and
create report layout templates with the more common desktop applications of Microsoft Word and Adobe
Acrobat, and renders XML data based on those templates. With a single template, you can generate reports in
many formats (PDF, RTF, Excel, HTML, and so on) and in many languages.
This appendix provides summary tables of basic HRMS reports and Human Resources reports.
Note. For samples of these reports, see the PDF files published on CD-ROM with your documentation.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1105
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
FGPER808 Lists each LEO Special Pay Set Up HRMS, Product PRCSRUNCNTL
Area and associated Related, Compensation,
LEO Pay Area Table report
percentage. (XMLP, LEO Pay Area Rpt USF
Crystal)
1106 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
FGPER823 Prints a list of all job codes Set Up HRMS, Product PRCSRUNCNTL
and the date on which they Related, Workforce
USF Job Code Table report
become effective. (XMLP, Administration, Workforce
Crystal) Reports USF, Job Code
Table
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1107
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
PAY711 Prints each pay group and Set Up HRMS, Product PRCSRUNCNTL
its effective date along with Related, Payroll Interface,
Pay Group report
the processing Payroll Reports, Pay Group
characteristics that apply to Table
that group.
PER702 Lists default values for field Set Up HRMS, Install, PRCSRUNCNTL
defaults, such as company Installation Table Report
Installation Table report
code, minimum/maximum
standard hours, and Social
Security number. (XMLP,
Crystal)
1108 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
PER709A Prints a list of all job codes Set Up HRMS, Product PRCSRUNCNTL
and the date on which they Related, Workforce
US Job Code Table report
become effective. It also Administration, Jobcode
lists all Job Code page Rpt USA
information for U.S.-based
companies. (XMLP,
Crystal)
PER709B Prints a list of all job codes Set Up HRMS, Product PRCSRUNCNTL
and the date on which they Related, Workforce
Can Job Code Table report
become effective. It also Administration, Jobcode
lists all Job Code page Table Report CAN
information for Canada-
based companies. (XMLP,
Crystal)
PER709C Prints a list of all job codes Set Up HRMS, Foundation PRCSRUNCNTL
and the date on which they Tables, Job Attributes, Job
Job Code Table report
become effective. (XMLP, Code Table Report
Crystal)
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1109
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
CAR002 Print the results from the Benefits, Provide Company RUNCTL_COMPCAR001
CAR001 process in a Cars, Print P11D
Print P11D Section A
format similar to the UK Information
government form P11D.
Before using this page, you
must have run the CAR001
report process.
1110 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1111
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1112 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1113
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
TRN003 Lists all students who are on Enterprise Learning, Course RUNCTL_TRN003
the course or session wait Reports, Course Waiting
Course Waiting List
list for a course. (XMLP, List
Crystal)
1114 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1115
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1116 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1117
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1118 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1119
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1120 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1121
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1122 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1123
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
PER710 Lists the reason codes for Set Up HRMS, Product PRCSRUNCNTL
each personnel action code Related, Workforce
Action Reason Table
and arranges them Administration, Action
alphabetically by action. Reason Report
(XMLP, Crystal)
1124 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1125
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1126 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1127
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
BEN040 Prints a bill for all workers Benefits, Benefits Billing, RUNCTL_BEN040
with outstanding balances Create Statements, Print
Billing Statement
who are actively enrolled in Billing Statement
the Benefits Billing system.
Statements report activity
from/to dates; activity type,
plan type, benefit plan,
coverage, amount and due
dates. Also included is the
total due and total overdue
information, with any
comments entered on the
billing calendar.
1128 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1129
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
BEN110 Using the results from the Benefits, Interface with RUNCTL_BEN110
Benefits Enrollment Providers, Snapshot
Snapshot Premium
Snapshot, calculates the full Premium
Reporting
premium due to a benefit
provider and reports the
coverage and premium
amount for each covered
employee, sorted by Vendor
and Plan Type.
You can run this report
three ways: (1) Run just the
"Snapshot Premium -
Calculation" process, which
is an Application Engine
which calculates and stores
the individual premiums;
(2) Run just the "Snapshot
Premium - Report" which is
an SQR report that uses the
previously calculated
premiums to report by
Vendor and Plan Type; or
(3) Run the combined
"Snapshot Premium
Reporting" job, which links
both the calculation process
and the reporting process
together into a single run
using the same run control
criteria.
1130 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1131
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1132 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1133
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1134 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1135
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1136 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1137
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1138 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1139
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1140 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1141
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
HPCA012 Reports on the Pay Check Payroll for North America, HP_RCTL_GRSFR_RPT
Distribution records. Run Payroll Distribution, GL
Fringe and Gross Report
after you've completed the Interface Reports, Gross
Pay Check distribution and Fringe
process.
You must set up column
definitions and run the
Fringe Gross Load process
before running the Fringe
and Gross report.
1142 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1143
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1144 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1145
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1146 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1147
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1148 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Workforce
Administration, Labor
Administration, Layoffs
and Recalls,
Reinstatement Roster,
Reinstatement
Candidate List
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1149
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1150 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1151
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1152 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1153
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
JPM_CATI_RPT Lists the content items that Set Up HRMS, Product JPM_CATLIST_RPT
have been set up for a Related, Profile
Content Catalog Listing
selected content type or for Management, Content
all content types. Catalog, Content Catalog
Listing
1154 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1155
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1156 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1157
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1158 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1159
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1160 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1161
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
See Also
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(AUS) Meeting
Regulatory Requirements for Australia"
1162 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1163
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(CAN) Meeting
Regulatory Requirements for Canada"
1164 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1165
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(FRA) Meeting
Regulatory Requirements for France"
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(GBR) Meeting
Regulatory Requirements for the United Kingdom"
1166 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1167
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Meet Regulatory Requirements, "(USF)
Performing Regulatory Processing and Reporting"
1168 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
A2 X B
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1169
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1170 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1171
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1172 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1173
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1174 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1175
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1176 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1177
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1178 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1179
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
LMS001 and LMS002 Analyzes the impact on the Compensation, Forecast RUNCTL_LMS_REPORT
forecasted period of the Compensation FRA,
Forecasted Compensation
events defined in the Process Forecast,
scenario and the variations Forecasted Compensation
of the compensation and Rpt
headcount over the two
periods (LMS002:
Variations).
1180 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1181
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
1182 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1183
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
If the worker receives a seniority pay component as a result of belonging to a group associated with a
seniority rate code, the report displays the corresponding group ID for the seniority rate code.
If a worker receives the seniority pay component because the seniority rate code is associated with all
workers, the report displays All as the origin of the seniority rate code.
1184 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
If a worker receives the seniority pay component because you manually added it, the report displays
Manually Added as the origin for the seniority rate code.
See Also
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Entering Additional Data
in Human Resources Records," Managing Citizenship and Visa or Permit Information
This report lists all workers whose job records show the following potential problems:
Multiple primary jobs: More than one active job is currently designated as a primary job.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1185
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
Terminated primary job: The primary job was terminated and a nonprimary job is the active job.
No primary job: None of the person's concurrent jobs has been chosen as the primary job.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Workforce, "Updating Person and Job
Information," Running Job Data Reports
To run the report, at least one Department tree must be created. For the purposes of department security, the
DEPT_SECURITY tree usually already exists. You can either select this tree or create a new department
hierarchy beneath the DEPARTMENT tree structure.
Employees with supervisor levels registered in the Supervisor Level tree, in tree order.
Employees with supervisor levels not registered in the Supervisor Level tree, in alphanumeric supervisor
level order.
Note. The Supervisor Level tree that the system uses for sorting is the one used for the Appointment
Notification and Appointment List reports. It must be named SUPERVISOR_LEVEL if the system is to use
it. If you have not defined a Supervisor Level tree with that name, sorting will be in alphanumeric supervisor
level order.
You should run this report when you first enter the reporting relationships, any time you add new positions,
and when you change reporting relationships among existing positions. You must run this SQR before you
can run the Indented Position Hierarchy report, POS006.
When you run Build Position Structure, the system may generate one or more diagnostic messages to help
you understand the utility output. They are as follows:
If the utility doesn't find a root position (a position that reports to itself), it displays an error message. If
you do not have a root node, the utility can not produce a report.
If you have circular reporting conditions, such as when position 1 reports to position 2, and position 2
reports to position 1, the utility displays a warning message and the positions will not appear in the report.
1186 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
If you do not have data in the Reports To Position field for a position, the utility displays a warning
message. These positions will not appear in the report.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Maximizing Position Data,"
Running the Organizational Structure Reports
The Exception/Override report lists the position name and the name of the worker assigned to the position
and shows the data in the fields that match in the Position Data component and Job Data component. The
report displays those workers whose HR Status is Active, Leave of Absence, Suspended, or Leave with Pay.
When you run this report for exceptions and the Business Title in the incumbent Employment Data doesn't
match the Position Title in Position Data, the report prints an asterisk (*) next to the Position Title. The report
also prints Match or No Match in the Mail Drop column, depending on whether the data is the same in the
incumbent job and position data.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Positions, "Managing Position Data,"
Verifying Position Data
You can combine the information provided in the FBT Reconciliation report with information from your
other administrative systems to accurately complete your FBT return for the Australian Taxation Office.
Note. The FBT Reconciliation Report includes values calculated during the Package Expense Calculation. To
ensure that you get accurate totals included in the FBT Reconciliation report, execute the Package Expense
Calculation at the end of the FBT Year for which to run the FBT Reconciliation report. You must complete
this before running the report.
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1187
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Administer Salary Packaging, "Managing Salary
Packages," Running Salary Packaging Reports
The report consists of four pages; each includes full-time survey salary calculations based on different
selection criteria:
The Plan Goal Weights for the variable compensation plan ID and period ID.
A list of all organization weighted goals in the plan with their weighting percent and attainment percent.
A list of all group weighted goals in the plan by group with their weighting percent and attainment
percent.
If the group does not have goals, the report indicates that the child group's goals are the parent group's goals.
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Variable Compensation, "Setting Up and
Using Weighted Goals," Running the Organization and Group Goals Report
1188 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
See Also
PeopleSoft Enterprise Human Resources 9.1 PeopleBook: Manage Variable Compensation, "Managing
Awards Approval and Payout," Reporting on Award Payout and Distribution
For each plan type, it shows the total amount deducted for workers in the plan type and company
contributions. The report inserts page breaks and supplies totals at the company, benefit program, plan type,
and benefit plan levels.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1189
PeopleSoft Application Fundamentals for HRMS Reports Appendix D
The audits performed are Employees without Employment records, Employees without Job records,
Employees less than 16 years old, People with unusual dependents signed up for coverage, Employee and
spouse (or other dependent) both electing health benefits, Employees with over-age dependent coverage,
Employees with incorrect health plans set up on the Benefit Program Table, and audits for consistency of
marital and dependent relationships.
Perform these audits during implementation, before you enroll participants, and periodically during the plan
year.
See Also
See Also
You can use this report to analyze whether there is an overlap in COBRA and Active coverage, whether
dependents are being covered by more than one EMPLID or whether an overage dependent has not been
detected.
See Also
1190 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Appendix D PeopleSoft Application Fundamentals for HRMS Reports
You can use the COBRA Administration Error Report to identify and troubleshoot errors that surface as a
result of COBRA processing. You can also identify these errors online. You might want to print the report
and request that staff check off each error as they determine a resolution, thereby creating an audit trail for
verifying that all errors have been analyzed.
See Also
If this report is run mid-year and a forecast percentage is specified in the 401 NDT run control, the report also
shows forecasted year end earnings, contributions, and related ADP/ACP results.
This report does not attempt to recalculate the Actual Deferral Percentage (ADP) or to determine whether the
nondiscrimination tests passed. It assumes these tests were handled by the NDT002 or NDT003 SQRs.
However, in cases where the Aggregate Limit Test must be used, this report serves as the only method to
invoke the test; there is no separate SQR for this.
If the Aggregate Limit Test is invoked, each report includes results for both the 401(m) and 401(k) tests, as
well as the Aggregate Limit Test pass/fail status. The system prevents you from initiating NDT004 if the run
control has been updated and you have not initiated these SQRs:
NDT001: This SQR lists plan type, plan name, benefit plan name and ID, effective date, accrual process
date, accrual frequency, service interval, special calculations, year the plan begins, and the maximum
leave balance and carryover allowed.
NDT002: You initiate this SQR after NDT001 to update the actual and forecasted amounts in the
nondiscrimination testing run control table for the 401(k) NDT.
NDT003: This SQR updates the actual and forecast 401(m) amounts in the nondiscrimination testing run
control table for the 401(m) NDT.
See Also
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1191
Index
Administer Labor Relations
Numerics/Symbols reports list 1147
Administer Salaries for the Netherlands
(AUS) Australia reports
setting system defaults for Canada 142 list 1111
<Registry Entry Name> page 586, 593 Administer Salary Packaging
<Registry Folder Label> page 586, 589 reports
360 View 827 list 1111
Administer Service Registry component
(HMCR_CONTENT_ADMIN) 614
Administer Service Registry page 614
A Administer Training
reports
Accept Delegation Request page 735, 747 list 1112
accept tenure workflow 1092 Administer Workforce
Access Type field 863 reports
account ChartField 418 list 1117
account codes See ChartFields administrator notification rules
Accounts Payable setting up 838
setting defaults in HRMS 138 administrators
action reasons approvals, defining 661
specifying in mass updates 644 Admin Notification Setup page 836, 838
Action Status page 414 affiliate chartfields
activities setting up 421
defining processes for Work-in-Progress 819 agencies
Add Delegation Request component entering (USF) 271
(HCDL_ADMIN_ADD_DLG) 709 AGENCY_TABLE component 271
Add Delegation Request page 727 agency information
additional appointment Agency Location page 245
enabling security access types 77 Agency Location page 245
implementing data permission security 72 Agency State Tax Table USF component
additional appointment (JPN) (CO_STATE_TAX_TBL) 505
enabling security access types 77 Agency Table 271
implementing data permission security 72 Agency Table Report component
additional assignments (RUN_FGPER803) 271
enabling security access types 77 Agency USF component (AGENCY_TABLE)
implementing data permission security 72 271
Additional Changes page 640, 646 Agency USF table
Addresses page - Vendor Information 526 Agency Location page 245
Addresses page - Vendor Information component ECS Address page 271
525, 531 Payroll Interface Information page 271, 272
address format Payroll Office Address page 271
specifying for countries 153 reporting 272
Address Format page 151 Alternate Account page 424, 428
Address page - Tax Location Table 519, 520 alternate accounts
Address Type component (ADDR_TYPE_TBL) ChartField 419
328 alternate approvers 661
Address Type page 329 Alternate Character page 131, 149
address types alternate characters
defining 328 configuring your system 198
entering 329 entering 149
ad hoc approval 695 entering alternate character information 199
Administer Company Cars fields associated with Global pages 194
reports Human Resources reports that sort on name
list 1110 197
Administer Compensation search records with name fields 196
reports system architecture 194
list 1110 alternate character sets
Administer Delegation - Request Details page 729 working with 193
Administer Delegation component Alternate Names page 532
(HCDL_ADMIN_DLG) 709 Alternate Names page - Vendor Information 527
Administer Delegation page 729 alternate user IDs 661
analysts
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1193
Index
1194 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1195
Index
1196 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Comm. Acctg. and EG page 300, 306 Tips Processing (USA) page 246
Comments page - SetID 480, 483 Tips Processing page (USA) 264
Balance ID Table 480 Company Table Report component
Comments page - Vendor Information 528 (RUN_PER707) 243
commitment accounting company tax table (CAN) 515
enabling for a department 306 Company Tax Table component
Common Changes page 640, 642 (CO_CAN_TAX_TABLE) 515
common components Company Tax Table page 516
configuring 858 Company Tax Table page (CAN) 516
setting up direct reports functionality 858 company tax tables
understanding 857 company local tax table (USA) 514
Common Components company state tax table, setting up (USA)
configuring attachments 908 505
companies defining tax locations 518
creating locations 285 setting up company tax table (CAN) 515
defining 247 setting up for Payroll for North America 505
defining legal types 245 setting up for Payroll Interface 505
defining rules 270 compensation
setting default information 249 frequency conversion factors 213
setting up 243 frequency defaults 211
setting up company locations 298 selecting data for mass updates 639
special considerations (USA) 244 compensation frequency
COMPANY_TABLE component 243 and pay frequency 222
Company component (COMPANY_TABLE) 243 compensation rate codes
company information selecting defaults 134
Claeys Default (BEL) page 246 compensation rates
Claeys Defaults (BEL) page 267 converting from annual frequency 216
Company Location page 245, 247 converting to annual frequency 215
Default Settings page 245, 249 converting to other frequencies 213
External Providers BEL page 246, 268 defining full-time equivalency 214
General Ledger Liability Accts page (Payroll defining standard hours 213, 214
for North America) 246, 262 defining standard work period 213, 214
Phones page 246 defining the annualization factor 213
Phones Page 269 example of hourly to monthly conversion
Rules Definition page 246 216
Rules Definition Page 270 example of monthly to biweekly conversion
Tax Details page (USA) 246, 265 216
Tips Processing page (USA) 246, 264 frequency in job data 217
Company Legal Type component Complex Group Results Summary page 564, 565
(LEGAL_TYPE) 243 Component Defaults page 822
Company Legal Type page 245 WIP activity 819
Company Local Tax Report page 514 component interfaces
Company Local Tax Table (USA) 514 CI_BANK_EC 389
Company Local Tax Table component setting up rules for self-service 839
(COMP_LOCAL_TAX_TBL) 514 testing 579, 580
Company Local Tax Table page 514, 515 component interfaces, testing 579, 580
Company Location component components
(COMP_LOC_TBL) 298 approvals 665
Company Location page 245, 247, 298 Configurations Options page
company locations SS Component Interface Setup page 836
setting up 298 Configurations page 970
Company State Tax Report page 507 Configure Delegation Transaction page 724
company state tax table (USA) 505 Configure Direct Reports UI (HR_DR_UI_CFG)
Company State Tax Table component component 858
(CO_STATE_TAX_TBL) 505 Configure Direct Reports UI component 848
Company table Configure Keys page - HR Notepad Configuration
Claeys Default (BEL) page 246 888
Claeys Defaults (BEL) page 267 Configure Links page - HR Notepad
Company Location page 245, 247 Configuration 888
Default Settings page 245, 249 Configure page - Manager Desktop Transactions
External Providers BEL page 246, 268 860, 862
General Ledger Liability Accts page (Payroll Configure Person Search (HR_PSS_CONFIG)
for North America) 246, 262 component 870
Phones page 246 Configure Processor page 635
Phones Page 269 Configure Simple Person Search page 871
Rules Definition page 246 Configure Text Catalog: General page 898, 899
Rules Definition Page 270 Configure Text Catalog (HR_SSTEXT_CFG)
Tax Details page (USA) 246, 265 component 896
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1197
Index
1198 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
implementing data permission security 69, 72 creating requests through self-service 709
manually creating department security trees defining 661
85 enabling hierarchies 719
modifying 126 entering dates 739
modifying department security trees 85, 88 framework 708
renumbering gaps in department security help, viewing 737
trees 88 implementation considerations 711
setting up department security trees 81 installation settings 718
understanding 45 integrating with the approval framework 708
understanding data retrieval 46 managing delegated authorities 746
data regulation managing proxies 744
system 9 notifications 709
Data Security Profiles page permission lists and roles, setting up 716
See Security by Dept Tree page processing batch requests 732
data structures proxies, managing 744
common components 858 registering workflow transactions 713
dates request, selecting job for 738
understanding effective dates in HRMS 5 request acceptance, viewing confirmation
de-allocation denied workflow 747
CAE de-allocation 1071, 1072 request rejection, viewing confirmation 748
de-allocation postponed workflow requests, submitting 742
CAE de-allocation 1073 reviewing delivered notification templates
decimal 749
modifying precision in multicurrency 201 reviewing delivered transactions 722
decimals selecting a proxy by reporting hierarchy 741
activating currency precision 202 selecting transactions 740
expanding a database for currency precision self-service 733
203 setting up 707
reporting with currency precision 203 setup steps 712
Deduction Distribution Information page (USF) terminology 707
528, 539 understanding 707
Default Compensation page 336, 351 viewing details for multiple transactions 749
Default Frequencies by Country page 225, 227 viewing request details 745
default numbers viewing submission request confirmation 744
specifying system assigned numbers 144 working with 707
defaults Delegation Detail page - Create Delegation
business unit defaults 25 Request 735, 742
frequency 211 Delegation Installation Settings page 718
linking system defaults to business units 24 delegation proxies
regulatory regions 33 managing 744
setting HRMS implementation defaults 129 selecting by name 742
setting system defaults 149 selecting by reporting hierarchy 741
understanding differences 26 Delegation Request Details page 735, 745
Default Search Result page 182 delegation requests
Default Settings page 245, 249 viewing acceptance confirmation 747
Defaults page - Org Defaults by Permission Lst viewing details 745
313 viewing rejection confirmation 748
Define Events component (EOAW_NEM) 690 Delegation Setup Center page 712
Define Events page 691 delete confirmed workflow
Define Event Types component hiring 1055
(EOAW_NEM_EVENTS) 690 new grade 1060
Define Event Types page 691 new grade and WTP 1069
Define Geographical Areas page 465, 466 new work time percentage 1064
Define MU page 640 return 1078
Define Salary Survey Mapping component return, grade, and WTP change 1092
(SP_SURV_MAP_TBL) 473 return and grade change 1082
Define Salary Survey Mapping page 473, 474 return and WTP change 1087
Define Steps page 820 Delete Mass Updates page 657
Defining published content types deleting mapped HCM services 623
Clairvia 971 department
Definition page 357, 359 assigning data permission security to
delegated authorities, managing 746 permission lists 89, 90
delegation auditing department security trees 88
activation 671, 673, 674 automatically creating department security
adding requests by administrator 727 trees 86
administering 709, 729 creating data permission profiles for
components, navigating 712 managers based on the department security
configuring transactions 722 trees 118
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1199
Index
1200 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1201
Index
1202 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1203
Index
1204 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1205
Index
1206 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1207
Index
1208 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1209
Index
P
O
parameters
1210 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1211
Index
1212 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1213
Index
1214 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
for pay groups 365 Run Control page - Currency Code Table 207
retro pay trigger program Run Control page - Currency Rate Report 207
for paygroups 366 Run Control page - Department Table Report 300
reviewers Run Control page - Geographic Location 295
viewing approval transactions 663 Run Control page - Handicap Table 385
Review Transactions page 703 Run Control page - Installation Table Report 131
roles Run Control page - Job Code Table Report 371
approvals 692 Run Control page - Legal Authority Table 385
creating and assigning to users 39, 41 Run Control page - LEO Pay Area RPT USF 385
creating using a message agent 1024 Run Control page - Locality Pay Area Rpt USF
granting data access to permission lists by 295
field value 91 Run Control page - Location Table Report 285
using dynamic role user queries 1024 Run Control page - Nature of Action Table 385
Roles page - User Profiles 689 Run Control page - NOA/Authority 1 385
row class security Run Control page - Personnel Office ID Table 385
implementing data permission security 69, 72 Run Control page - Standard Letter Report 797
ROWSECCLASS Run Control page - Sub-Agency 385
assigning to users 42 Run Control page - Work Location Table 295
creating data permission profiles for RUNCTL_CITYUPDATE component 447
managers based on the department security
trees 118
granting data access by department tree to
row security permission lists 89 S
granting data access to permission lists by
field value 91 salary component settings (JPN) 452
refreshing security join tables 92, 102 salary factors
setting up department security trees 81 entering for companies (BEL) 267
understanding data retrieval and data salary plans
permission security 46 associating base pay rate codes with job
understanding security join tables 59 codes 351
understanding user security data 52 associating with job codes 351
row security Save/Load Query page 765, 771
See data permission security, data permission Save Attributes page 764
security Save Criteria page 765
row security permission list SCHDLDEFN component 690
assigning to users 42 Schedule JobSet Definition component
refreshing security join tables 92, 100, 102 (SCHDLDEFN) 690
setting up department security trees 81 Schedule JobSet Definitions page 691
understanding data retrieval and data SCRTY_SJT_SBP
permission security 46 refreshing security join tables
understanding security join tables 59 92, 99, 100, 102
understanding user security data 52 understanding security join tables 55
row security permission lists SCRTY_TBL_DEPT
creating data permission profiles for granting data access by department tree to
managers based on the department security row security permission lists 89
trees 118 refreshing security join tables 92, 102
granting data access by department tree to understanding security join tables 59
row security permission lists 89 search/match 165
granting data access to permission lists by using 181
field value 91 viewing results 186
refreshing SJT_CLASS_ALL 85 Search/Match pages
Royal Name Prefix component Search Criteria page 182
(NM_ROYAL_PREF) 323 Search Results page 186
royal name prefixes Search/Match Result Fields page 168, 174
defining 327 Search/Match Rules page 168, 169
Royal Name Prefix page 324, 327 Search Combination Codes page 441, 443
royal name suffixes Search Combo Codes page 441
defining 327 search criteria
Royal Name Suffix page 324, 327 selecting criteria for a search 182
Rules Definition page 246 Search Criteria page 182
Rules Definition Page 270 searches
RUN_BUD003 component 430 for persons 870
RUN_FGPER803 component 271 searching 181
RUN_PER705 component 283 Search Keys page - Define Matrices 466, 471
RUN_PER707 component 243 search parameters
RUN_POSTAL_NLD component 455 defining 171
Run Control page - Agency Table Report 272 Search Parameters page 168, 171
Run Control page - Country Table Report 152 Search Permissions page 168, 173
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1215
Index
1216 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Select Proxy by Name page - Create Delegation viewing balance setIDs 483
Request 742 Settings page - Org Defaults by Permission Lst
Select Proxy By Name page - Create Delegation 313, 315
Request 735 setting up national insurance prefixes (GBR) 457
Select Transactions page - Create Delegation Setup Global Security component
Request 734, 740 Excluded Panelgroups page 124
Select Value page 765, 769 Setup Global Security page 124, 125
self-service Setup Process Definitions page 676, 685
approvals transactions 702 Set Workflow Defaults component
self-service pages (WF_SYSTEM_DEFAULTS) 852
standard text 896 simple person search
self-service transactions person search 870
activating workflow message defaults 854 SJT_CLASS
configuration rules 832 granting data access to permission lists by
configuring 831 field value 91
defining workflow rules for notifications 855 refreshing security join tables 92, 102
determining manager access 848 understanding security join tables 59
exceptions for position management 835 SJT_CLASS_ALL
process flow 833 refreshing security join tables 92, 102
reviewing transaction activity 840 understanding security join tables 59
setting up access to direct reports data 847 SJT_DEPT
setting up administrator notification rules refreshing security join tables 92, 99, 100
838 understanding security join tables 55
setting up component interface rules 839 SJT_OPR_CLS
setting up direct reports 849 understanding security join tables 59
setting up transaction instructional messages SJT_PERSON
851 refreshing security join tables 92, 99, 100
setting up workflow approvals 836 understanding security join tables 55
setting up workflow database updates 836 SJT_PERSON_USF
setting user workflow notification 856 refreshing security join tables 92, 99, 100
using workflow 852 understanding security join tables 55
self approval 699 skip unauthorized users 684
Self Service Workflow Configurations component Source Bank Accounts component (SRC_BANK)
(WF_CO_CONFIG) 831 396
Self Service Workflow Configurations page Source Bank Accounts page 397
Admin Notification Setup page 836 source banks
send cancellation Canada Bank Additional Data page 397, 400
workflow 1028 defining 396, 397
send confirmation Japan Bank Additional Data page 397, 402
workflow 1028 Source Bank Accounts page 397
send rescheduling US Bank Additional Data page 400
workflow 1029 sources, approvals 664
service calls SP_MPAY_RPT_TBL component 473
setting up stale data checks 613 SP_SAL_SURV_TBL component 473
service calls, setting up stale data checks in 613 SP_SURV_MAP_TBL component 473
service interfaces SP_SURVLOAD_TBL component 473
invoking 611 Spain
Service Registry component setting up control tables 456
(HMCR_IFC_REGISTRY) 585 speed types for ChartField combinations 433
Service Registry page 586 SpeedTypes page 434
services, invoking 611 SQL
services, web 623 building SQL queries with Query Builder
Service Tester component 763
(HMCR_SRV_TESTER) 616 loading result attributes 768
Service Tester page 616 running predefined queries 771
Set / Execute page - Invoke Direct Reports API saving and loading the query 771
860, 864 selecting query attributes 766
setids selecting query criteria 768
(BEL) associating with providers for viewing query results 770
companies 268 SQLView interfaces, HCM, implementing 610
setIDs SQLViews
setting defaults for regulatory regions 159 consuming 614
system data regulation 18 SS_LINK_TBL component 859
tableset sharing and multiple setIDs 19 SS Component Interface Setup page 836, 839
understanding setIDs in HRMS 4 stages
understanding tablesets and setIDs 14 approvals, defining 660
understanding tableset sharing across stamp denied workflow
business units 16 hiring 1053
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1217
Index
1218 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1219
Index
1220 Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved.
Index
Copyright 1988, 2010, Oracle and/or its affiliates. All Rights Reserved. 1221