Understanding PeopleSoft Search Framework Implementation for HCMThis chapter provides the following overviews:
Understanding PeopleSoft Search Framework implementation for HCM
Understanding PeopleSoft HCM search definitions
Using PeopleSoft HCM search definitions
Configuring PeopleSoft HCM and ELM for Learning search
Note. PeopleTools 8.52 is required for PeopleSoft SES Search. To become familiar with PeopleSoft Search terminology and learn how to create and implement the application-specific items described in this chapter, you must read PeopleTools 8.52 PeopleBook: PeopleTools: PeopleSoft Search Technology.
Understanding PeopleSoft Search Framework Implementation for HCMPeopleSoft Search Framework is a PeopleTools indexed search technology that relies on Oracle SES (Secure Enterprise Search) engine by way of Integration Broker. It leverages indexes, and requires the use of PeopleSoft Query or Connected Query to create search definitions that identify the objects and attributes to make available to the indexes. Integration Broker provides the interface between PeopleSoft Search Framework and Oracle SES engine to deploy the search definitions, build the indexes, and return the search results.
Note. PeopleSoft Search Framework requires PeopleTools 8.52 or higher and requires SES, but will co-exist with Verity. You must have Oracle SES configured for use with PeopleSoft to use PeopleSoft Search Framework and any of the features that are based on PeopleSoft Search Framework. However, SES does not replace any Verity functionality. PeopleSoft applications through Release 9.1 continue to support the use of the Verity search engine. If your system has both search engines active, PeopleSoft Search will use SES, and the existing Verity-based searches will continue to work with Verity.
PeopleSoft Search Framework supports both application (global) and search pages (component) search capabilities. Application search provides an alternate navigation mechanism that bypasses the classic PeopleSoft navigation. The Search Pages feature allows keyword-based searches within administrative components. Both searches target the PeopleSoft pages and components as if you navigated directly to them, while providing flexibility in searching. Data is secured so that search results return only data rows to which the user has role and permission list access. Users can choose to display the search results in list or grid format.
PeopleSoft Search Framework provides a consistent technology by which to deploy and maintain search indexes regardless of PeopleSoft application. However, each application provides and maintains its own application-specific search definitions. This chapter describes the search definitions that Oracle delivers preconfigured for PeopleSoft HCM.
For more information about PeopleSoft Search Framework, including application and search pages (keyword) searches, see PeopleTools PeopleBook: PeopleTools: PeopleSoft Search Technology, “Understanding PeopleSoft Search Framework”, PeopleSoft Search Features.
Understanding PeopleSoft HCM Search DefinitionsEach PeopleSoft application provides predefined application-specific search definitions for implementation within PeopleSoft Search Framework. Tables later in this chapter provide a list of the search definitions that Oracle delivers preconfigured for PeopleSoft HCM.
PeopleSoft HCM Search ConsiderationsWhen implementing PeopleSoft Search Framework for HCM, keep these general considerations in mind.
PeopleSoft HCM searches:
Consider only current effective-dated rows. Incremental indexing should be run daily to index changed data into the SES system and return most recent information. Consider the rate at which your data changes to determine the frequency for incremental indexing. For example, the Time and Absence indexes may need to be incrementally indexed multiple times in a day, whereas Succession Planning might only need to be incrementally indexed once in a quarter.
Are based solely on the fields and values that are indexed.
Rely on the last updated date time stamp field for incremental search indexing. (If a date time stamp field is not present in the underlying tables of a search definition, then changes to that table will not be tracked by SES. Date and numeric fields cannot be added as facets.)
Are based on keyword entry of the complete value of an indexed field. (Partial entry is not allowed.)
Allow non case-sensitive free text search.
Accept only an asterisk (*) as a wildcard in keyword search due to SES limitations. (Wildcards are not allowed at the beginning of keywords. Other wildcards may be available in advance search. Consult your SES documentation for more information about wildcard use and limitations.)
Do not update navigational bread crumbs. (The browser back button must be used to return to search results from the target page.)
For optimized performance, return only up to three levels of indirect reports for application searches that use Direct Reports API for Manager Self Service security.
In addition to these general considerations, each PeopleSoft HCM search definition may have its own more specific set of considerations.
Using PeopleSoft HCM Search DefinitionsThis sections discusses:
PeopleSoft HCM search definitions
PeopleSoft HCM application search definitions
PeopleSoft HCM search pages definitions
For information about the elements that are required to comprise or are associated with a search definition (query types, delete query, security type, attributes, facets, search category, and so on), and to learn how to create and implement search definitions, you must read your PeopleTools PeopleBook: PeopleTools: PeopleSoft Search Technology.
PeopleSoft HCM Search Definitions
You can use PeopleSoft HCM definitions as delivered, copy and modify them, or create new ones.
Note. For easier maintenance and patch upgrades, Oracle recommends that you preserve the preconfigured application-specific search definitions as default definitions. To modify a delivered search definition, manually copy it and then modify the copy.
To view any of the preconfigured HCM search definitions that are listed in this section, access the Search Definition component (PeopleTools, Search Framework, Designer, Search Definition).
PeopleSoft HCM Application Search Definitions
This table lists and describes the PeopleSoft HCM application search definitions that Oracle delivers preconfigured for use within PeopleSoft Search Framework.
|
Search Definition Name |
Target Component and Classic Navigation |
Usage |
Considerations |
|
Absence Request Search (HC_GP_ABS_RQST) |
Absence Request
|
Employees can enter keywords to search for and submit their own self-service absence requests and view their absence history.
Managers can enter keywords to search for self-service absence requests for their own direct reports to approve them and view absence history.
Keyword Examples:
|
Only employee self-service page or manager self-service page absence requests are considered. Entries that are sourced from Extended Absence Request, Administer Workforce, or Time and Labor are not supported |
|
Career Planning (HC_HR_CAREER_PLAN) Application Search |
Career Progression Chart
|
Employees can enter keywords to search for and view their own career progression chart.
Managers can enter keywords to search for career progression charts for their own direct reports. They can also filter results by employees that report to them.
Keyword Examples:
|
N/A |
|
Compensation History (HC_COMP_COMPENSATION_HISTORY) |
Compensation History
|
Employees can enter keywords to search for their own compensation details, including stop option summary.
Managers can enter keywords to search for and manage compensation details about their own direct or indirect reports. Managers can also filter results based on the year when the compensation change took place, or the action that triggered the compensation change.
Keyword Examples:
|
|
|
Learning (LS_LM_ACT_CI and LS_LM_PRG) |
Search Catalog Any User: (Course = LM_SEARCH; Program = LM_PRG_DTLS_ESS) Self Service, Learning, Search Catalog, Search Catalog |
From within HCM, users can enter keywords to search for and enroll in courses and programs without logging out of HCM and without logging into ELM. Users can also filter the search for courses based on location and course type or category.
Keyword Examples:
|
See Configuring PeopleSoft Human Resources and ELM for Learning Search. |
|
ePerformance Perf / Dev Doc (HC_EP_PERF_DEV) |
Current Performance Documents
Current Development Documents
|
Employees can enter keywords to search for their own performance appraisal or development documents.
Managers can enter keywords to search in ePerformance for initiated performance appraisals or development documents for their own direct reports.
Keyword Examples:
|
|
|
Person (HC_HR_COMPANY_DIRECTORY1) |
Company Directory
(HRCD_CO_DIRECTORY) OrgChart Viewer, Company Directory |
Any user can enter keywords to search for employees in the Company Directory.
Keyword Examples:
|
Only the address, phone, and email marked as Business in Personal information is indexed. If no business address is available, the location address from Job information is indexed. |
|
Succession Planning (HC_HR_SUCC_PLAN) |
Succession 360o
Manager: (HR_VT_DASHBOARD) Manager Self Service, Succession Planning, Succession 360 |
Managers (only) can enter keywords to search for and manage succession planning for their own direct reports.
Keyword Examples:
|
|
|
Time and Labor Time Sheet (HC_TL_GBL_TIMESHEET) |
Timesheet
|
Employees can enter keywords to search for their own time entry information to view or modify.
Managers can enter keywords to search for any employee's time entry information. They can also search for timesheets based on report status (Submitted) or severity of exceptions (High, Medium, Low).
Keyword Examples:
|
|
PeopleSoft HCM Search Pages Definitions
This table lists and describes the PeopleSoft HCM search pages definitions that Oracle delivers preconfigured for use within PeopleSoft Search Framework.
|
Search Definition Name |
Target Component and Classic Navigation |
Usage |
Considerations |
|
Health Benefit (HC_BEN_HEALTH_BENEFIT) |
Health Benefits
Administrator: (HEALTH_BENEFITS) Benefits, Enroll in Benefits, Health Benefits |
Administrators (only) can enter keywords to search for employee benefits information based on plan type, coverage type, and benefit plans.
Keyword Examples:
|
N/A |
|
Job Data (HC_HR_JOB_DATA) |
Job Data
Administrator: (JOB_DATA) Workforce Administration, Job Information, Job Data |
Administrators can enter keywords to search for all jobs in a location or by job type(Parttime, On Demand). They can also filter or drill down on search results based on preferences using the facets and configure related actions.
Keyword Examples:
|
|
Related Actions
As part of the HCM 9.1 Feature Pack 2 release, PeopleSoft is delivering a number of related actions for Manager Self Service as well as Employee Self Service for different modules. All or a subset of these related actions are being initiated from Org Chart Viewer, Manager Dashboard, Talent Summary and Application Search.
In PeopleTools 8.52, PeopleSoft delivers Authorization as a Service (AaaS) framework to provide row level security to different transactions. HCM has leveraged AaaS framework to secure the different related actions using application classes.
The Related Actions are listed in the Related Actions in HCM 9.1 FP2 documentation. This document includes details of Related Content Services (RCS) and AaaS implementations for PeopleTools 8.52 . It also includes the following information: 1) Defining related content services; 2) Steps for configuring related actions from different sources; 3) HCM implementation of AaaS framework; and 4) Comprehensive list of related actions.
To view the Related Actions in HCM 9.1 FP2 documentation, visit the PeopleSoft Human Capital Management 9.1 Documentation Home Page in My Oracle Support. Find the link to the My Oracle Support page for the feature and the related actions documentation is linked from that page
To view the Authorization as a Service documentation, see PeopleTools: Security Administration PeopleBook, “Using Web Services for Object and Row-Level Data Authorization”.
Configuring PeopleSoft Human Resources and ELM for Learning SearchThe Learning application search definition is the only PeopleSoft HCM search definition for which all of the search artifacts do not reside in the PeopleSoft Human Resources database. Instead, they reside in the PeopleSoft Enterprise Learning Management (ELM) database. For the Learning search to work from the Human Resources database, several steps must be executed. This section provides an overview of those steps.
Steps for Configuring Human Resources and ELM Databases for Learning Search
With Integration Broker set to allow the PeopleSoft Human Resources and ELM databases to communicate, follow these steps to further configure the databases for the Learning application search.
Add the Integration Administration role to user ID PS in both the ELM and Human Resources databases.
Add the ELM default local node as the network node in the Human Resources database, and add the Human Resources default local node as the network node in the ELM database(PeopleTools, Integration Broker, Integration Network, Network Setup).
Set up the Human Resources portal node Portal URI and Content URI in the ELM database, and set up the ELM portal node Portal URI and Content URI in the Human Resources database.(PeopleTools, Integration Broker, Integration Setup, Nodes).
Add the Search- Learning role to all users in ELM who will use the Learning application search.
Import the remote search group from ELM into the Human Resources database (PeopleTools, Search Framework, Administration, Remote Search Groups). All of the search elements for the Learning search reside in the ELM database, but for the Learning search to work from the Human Resources database, the remote search group for learning must be imported.
To import, enter the ELM default local node PSFT_LM in the Content Provider field on the Remote Search Groups page, and click Import. Then, on the Import Search Groups page, select the Search Category Name of LS_LM_LEARNING_<ELM Database Name>.
Set search group security in the Human Resources database so that the Learning search group will be available from the application search drop-down list (PeopleTools, Security, Permissions & Roles, Permission Lists).
Add the imported search group to the home search context (PeopleTools, Search Framework, Administration, Define Search Contexts).
Add the Human Resources and ELM default local nodes to the Single Signon page in the Human Resources database and in the ELM database (PeopleTools, Security, Security Objects, Single Signon).
See PeopleTools PeopleBook: PeopleTools: PeopleSoft Search Technology,“Administering PeopleSoft Search Framework” Importing Remote Search Groups