Professional Documents
Culture Documents
June 2016
Introduction ....................................................................................... 1
Disclaimer...................................................................................... 1
Structure of This Red Paper .......................................................... 2
Related Materials........................................................................... 2
Overview ........................................................................................... 4
Who Should Read This Paper? ..................................................... 4
Before You Begin .......................................................................... 4
Using Delivered Functionality ............................................................ 5
Transaction Details ........................................................................ 5
Approval Routing / Definitions........................................................ 6
Changing the Decision Support Text ............................................. 6
Transaction Questions ................................................................... 8
Approval Routing / Definitions...................................................... 14
Activity Guide Setup .................................................................... 15
Activity Guide Security ................................................................. 15
Activity Guide Advanced Options................................................. 15
Activity Guide Actions .................................................................. 17
Extending Delivered Functionality.................................................... 18
Creating New Transactions ......................................................... 18
Customizing Transactions ........................................................... 24
Activity Guide Template Customization ....................................... 29
Authors ............................................................................................ 34
Revision History .............................................................................. 34
PeopleSoft HCM 9.2 Guided Self Service
Introduction
This red paper is a practical guide for technical users, installers, system administrators, and
programmers who implement, maintain, or develop applications for your PeopleSoft system. In
this red paper, we discuss guidelines on how to configure and customize Guided Self Service,
including PeopleSoft Internet Architecture and Portal configuration. This document does not
cover configuring batch processes.
Much of the information in this document originated within the Oracle Global Support Center
and is therefore based on “real-life” problems that have been encountered in the field.
Although this document does not address every conceivable problem that one could encounter
with [list products and technology], the issues that appear in this document are the problems
that prove to be the most common or troublesome.
Disclaimer
This material has not been submitted to any formal Oracle test and is published as is. It has
not been the subject of rigorous review. Oracle assumes no responsibility for its accuracy or
completeness. The use of this information or the implementation of any of these techniques is
a customer responsibility and depends on the customer's ability to evaluate and integrate them
into the customer's operational environment. While each item may have been reviewed by
Oracle for accuracy in a specific situation, there is no guarantee that the same or similar
results will be obtained elsewhere. Customers attempting to adapt these techniques to their
own environments do so at their own risk.
Information in this red paper was developed in conjunction with use of the products specified
and is limited in application to those specific hardware and software products and levels.
Oracle may have patents or pending patent applications covering subject matter in this
document. The furnishing of this document does not give you any license to these patents.
1
PeopleSoft HCM 9.2 Guided Self Service
This red paper provides guidance for HCM Guided Self Service.
Oracle updates this document as needed so that it reflects the most current feedback from the
field. Therefore, the structure, headings, content, and length of this document may vary with
each posted version. To see if the document has been updated since you last downloaded it,
compare the date of your version to the date of the version that is posted on My Oracle
Support.
Related Materials
This paper is written for experienced IT professionals with a good understanding of the
PeopleSoft Internet Architecture. To take full advantage of the information in this document,
you should have a basic understanding of system administration, basic Internet architecture,
integration technologies, relational database concepts and SQL, and how to use PeopleSoft
applications.
This document does not replace the PeopleTools 8.4x or 8.5x product documentation. Before
you read this document, you should become familiar with the PeopleSoft Internet Architecture
information in the PeopleTools product documentation to ensure that you have a well-rounded
understanding of the technology.
Note. Much of the information in this document may eventually be incorporated into
subsequent versions of the product documentation.
The following product documentation discusses many of the fundamental concepts that are
related to the PeopleSoft Internet Architecture:
2
PeopleSoft HCM 9.2 Guided Self Service
Additionally, you should be familiar with the documentation that is delivered with Oracle
Tuxedo, Jolt, and WebLogic.
3
PeopleSoft HCM 9.2 Guided Self Service
Overview
This red paper discusses the HCM Guided Self Service (GSS) feature administration and configuration
options, as well as an in depth review of the design architecture involved.
This section includes the following topics:
• Who should read this paper?
• Before you begin
• Common terms
4
PeopleSoft HCM 9.2 Guided Self Service
Transaction Details
Each Guided Self Service transaction is keyed by a transaction ID and effective date. The transaction
ID used here must be the same as the transaction name used in the Workflow Transaction setup. On
the Configuration page, enter the title text to use as the page title during the transaction. Use the
Comments field to provide more details about the transaction.
5
PeopleSoft HCM 9.2 Guided Self Service
6
PeopleSoft HCM 9.2 Guided Self Service
Use HTML tags to provide formatting for the decision support text in a Message Catalog entry. You
can include HTML tags for bold, italics, line breaks, font color and size, hyperlinks, and so on. See
Figure 4 for an example of the HTML tags used in the sample data entries. If you choose to include
hyperlinks in your text, you must remember to include a “target=_blank” attribute to enable the link to
open in a new tab or window.
Because the Message Catalog does not provide a formatting preview to display and view your
formatting, use an external tool or use the Decision Support display.
7
PeopleSoft HCM 9.2 Guided Self Service
Transaction Questions
Two of the delivered transactions, Promote Employee and Transfer Employee, are delivered with
questions that need to be answered before continuing to the transaction data pages. The other six
transactions are delivered with hidden questions only, so for these transactions you do not need to
view the Questionnaire page before continuing to the transaction data pages.
8
PeopleSoft HCM 9.2 Guided Self Service
You can reconfigure the questions for the delivered transactions to rephrase them, reorder them, add
additional questions, or hide them.
Question Text
Define text for the questions on the Transaction Configuration - Questionnaire page, shown in Figure
5. The text that you define on this page is stored in the HCM Text Catalog.
The Question Text ID field is a reference to the text catalog entry. The View/Edit Text link launches a
modal popup where you can modify the text for a question. Do not use HTML within the question
text. The system is not designed to look for HTML tags here.
As of PUM Image 18, we provide a separate page for specifying and editing the question text for Small
Form Factor devices, as shown in figure 5a.
The question text is found in the Text Catalog with the following standard values:
• Object Owner ID: HELM
• Sub ID: CT
• Usage: Page Instructions
9
PeopleSoft HCM 9.2 Guided Self Service
Hiding Questions
You can hide a question from users by setting its Default Response to Yes, and selecting the Hide
Question check box. When all of the questions defined for a transaction are hidden, the system skips
the Questionnaire page of the transaction because it assumes that all of the defined questions are
answered Yes.
The hidden questions still contribute to determining which fields are displayed as part of the
transaction, and which Action codes end up written to the Job record. The system simply treats them
asthough they were answered Yes interactively.
HCM Guided Self Service includes a set of delivered transaction subpages. The Page Name field on the
Transaction Configuration - Questionnaire page displays the transaction page that is associated with
the transaction ID. For phase one, Oracle delivers the following transaction subpages:
• HR_MSS_CT_JOB_SBF for job data.
• HR_MSS_CT_COMP_SBF for compensation data.
• HR_MSS_CT_JOBC_SBF for creating additional fields related to Job Data (see Customizing
Transactions at the end of this document).
10
PeopleSoft HCM 9.2 Guided Self Service
You can use each transaction page as delivered or, as shown in Figure 6, you can access the
Transaction Configuration to control which fields are visible on the transaction page.
Note, that the Position Number field has special logic built into the transaction such that the field is
visible only when the employee is currently in a position. It is hidden otherwise, even if marked Visible
on the setup.
Also, note that two fields exist for Full/Part Time Status. The Change Full/Part Status field is an
editable dropdown field, while the Full/Part Time field is a read-only field. It would not make sense to
put both of these on the same transaction, but the configuration does not prevent it. You must
consider your own business use and determine which field is appropriate for the transaction.
Additionally, you can select the Display Only check box for those fields that should appear on the
transaction but be presented as read-only data.
11
PeopleSoft HCM 9.2 Guided Self Service
The delivered functionality enables you to configure HCM Guided Self Service questions and
transactions to best suit your business needs. For example, perhaps instead of having the answers to
questions determine what appears on a transaction page, you want all of the fields to appear on the
transaction page to enable the manager to determine which fields to change. If so, you can create a
single hidden (on the Questionnaire page, set the question’s Default Response field to Yes and select
the Hide Question check box) and select the Visible check box for all of the fields on the PeopleSoft
12
PeopleSoft HCM 9.2 Guided Self Service
HCM 9.2 Guided Self Service 12 configuration. Set up this way, the transaction does not display the
questions page and available fields are available on the transaction page.
The question setup also contains a specification for the action and action reason for each question. As
shown in Figure 7, on the Action Reasons page, you can indicate which action reasons to display and
which action reason, if any, should be presented as the default. You can also choose to hide the action
reason altogether if the transaction does not need to display a reason.
13
PeopleSoft HCM 9.2 Guided Self Service
14
PeopleSoft HCM 9.2 Guided Self Service
15
PeopleSoft HCM 9.2 Guided Self Service
Finally, the Instance Creation application class for Guided Self Service determines which of the steps
are displayed within the GSS transaction. For example, during an ad hoc salary change transaction, only
the Compensation Detail and Review and Submit steps are visible at runtime. For a location change
transaction, only the Job Details and Review and Submit steps are visible. This is controlled by the
Instance Creation logic, along with the answers to GSS questions (both visible and hidden questions)
and the configuration data for the transaction.
Figure 10 shows an example of the application header generated by the Activity Guide.
16
PeopleSoft HCM 9.2 Guided Self Service
Shown in Figure 11, the configuration of the action items includes the title of the action, which is what
appears in the header of the transaction (train stops). This is where customers can change the label
used by each step in the Guided Self Service process.
17
PeopleSoft HCM 9.2 Guided Self Service
In support of the new Activity Guide for GSS, three new components were created. Each new
component is specified as an action item in the activity guide. For each of the new components, a new
page was created:
• Job Details Component: HR_MSS_CT_JB_AGFL
o Page: HR_MSS_CT_PG1_AGFL
• Compensation Details Component: HR_MSS_CT_CMP_AGFL
o Page: HR_MSS_CT_PG2_AGFL
• Review and Submit: HR_MSS_CT_SBM_AGFL
o Page: HR_MSS_CT_SBM_AGFL
The mobile approval framework requires that an application class matching the name of the approval
process ID exists. When you create a new approval process ID, which would be the case for a new
18
PeopleSoft HCM 9.2 Guided Self Service
GSS transaction, it is necessary to use App Designer to clone an existing application class and change
the naming as required for the new approval process.
In App Designer, open the application package HR_MSS_CT_APPR. The structure of the application
package is shown in Figure 12.
When cloning these application classes, do not modify this application package because you want to
avoid losing your changes during future updates. Instead, put them in your own custom package, but
maintain the same structure within the package as HR_MSS_CT_APPR.
It is necessary to create a DataHandler, a DetailDocument and a SubPage class for your new approval
process ID.
Use the GSSPromoteEmployee class, as an example, for the DataHander, open
HR_MSS_CT_APPR:DataHandler:GSSPromoteEmployee, and copy the code within.
19
PeopleSoft HCM 9.2 Guided Self Service
Then in your new DataHandler application class for your approval process, paste in this code and
make the changes to the areas indicated in Figure 13. Replace the circled code with the name of your
approval process ID.
Next, repeat the same steps for the DetailDocument using GSSPromoteEmployee as an example.
Open HR_MSS_CT_APPR:DetailDocument:GSSPromoteEmployee, and copy the code within.
Then in your new DetailDocument application class for your approval process, paste in this code and
make the changes to the areas indicated in Figure 14. Replace the circled code with the name of your
approval process ID.
Next, repeat the same steps for the SubPage using GSSPromoteEmployee as an example. Open
HR_MSS_CT_APPR:SubPage:GSSPromoteEmployee and copy the code within.
Then in your new SubPage application class for your approval process, paste in this code and make the
changes to the areas indicated in Figure 15. Replace the circled code with the name of your Approval
Process ID.
20
PeopleSoft HCM 9.2 Guided Self Service
After you have created the new code, you can then add your transaction to the Mobile Approvals setup
pages. Access the setup pages by navigating to Enterprise Components > Approvals > Approvals >
Mobile Approval Options.
Access the Transactions page and add a new row for your transaction. Again, you can use the row for
GSSPromoteEmployee as an example. Remember to specify your new Root Package ID as the
application package you created for your DataHandler, DetailDocument, and SubPage code.
Once you configure a new transaction, you need a means to access it. You can access the delivered
transactions through the Classic menu using conditional navigation tied to the existing Manager Self
Service transactions. You can also access the delivered transactions through the Related Actions
framework, which also uses conditional navigation.
21
PeopleSoft HCM 9.2 Guided Self Service
You are not required to use conditional navigation, but it makes sense when creating a GSS transaction
that is a virtual equivalent to an existing MSS transaction. With conditional navigation you will not see
the same transaction twice on the menu – instead letting the system decide whether to display the
Classic PIA transaction, or the Fluid GSS transaction. For more information on conditional navigation,
see Understanding Conditional Navigation.
When adding a GSS transaction to the menu, you must include the TRANS_NAME= parameter
within the Content Reference in the Additional Parameters field as shown in Figure 17. The value you
specify is the transaction name you created in the Guided Self Service setup. Note also that the Menu
Name field has a value of EL_MANAGER_FL and the Component field has a value of
HR_MSS_CT_FL.
For a related content reference, the delivered transactions are linked to many different components.
For the Fluid My Team related content reference for example, each transaction is defined four times,
once for each tab of the My Team page. Because the My Team related content definitions for Guided
Self Service use conditional navigation, there is not a reference to the Transaction Name within the
22
PeopleSoft HCM 9.2 Guided Self Service
definition. Instead, a CREF used by conditional navigation contains the TRANS_NAME parameter as
was shown in Figure 17.
Figure 18 shows an example of the existing configuration for the Change Full/Part Time Status service
from the My Team page. Notice here that the Service ID referenced is HR_MGR_FULL_PART,
which is the existing PIA service.
If you are not using conditional navigation to create the related content, use the new Service ID of
HR_MSS_CT_FL instead, similar to what is shown in Figure 19. When using this service definition,
specify the TRANS_NAME variable value within the related content definition itself, rather than
within a CREF.
23
PeopleSoft HCM 9.2 Guided Self Service
Customizing Transactions
Oracle does not provide support for customizations made by a customer, or the impacts that
customizations have on the delivered feature. Customizations might or might not transfer in any future
HCM Guided Self Service updates, and may or may not require significant customer intervention to
reimplement. Given that, this section provides general guidance for customers who might still need or
want to enhance HCM Guided Self Service to include additional data fields beyond those that are
delivered.
Built into the Guided Self Service component, in the Job Details page, is a subpage
HR_MSS_CT_JOBC_SBF.
This page is already included as a subpage in the HR_MSS_CT_PG1 Fluid page.
24
PeopleSoft HCM 9.2 Guided Self Service
The goal of this page is to provide a place for customers to add additional fields related to Job Data for
displaying on the transactions.
You can add fields for display-only from the Job Data records without having to make any changes to
the data model.
It is a considerably larger task to add fields that can be editable, are expected to be carried through the
transaction for display in approvals, and that are expected to be updated in the Job Data record.
This is an example of the process required to add existing fields from the Job Data (JOB) record as
display fields within Guided Self Service
The Derived/Work record HR_GSS_PG_FLDS is used by the transaction configuration to present
the list of which fields can be selected for display within GSS. You first need to add your fields to this
record. In our example, we have added the JOB_ENTRY_DT field as shown in Figure 20.
Next, you can modify the HR_MSS_CT_JOBC_SBF subpage to add your new field(s) as shown in
Figures 21 and 22.
25
PeopleSoft HCM 9.2 Guided Self Service
Figure 22. Field Detail from HR_MSS_CT_JOBC_SBF subpage with JOB_ENTRY_DT added
When adding details to this subpage, to get the display to look the same as the rest of Guided Self
Service, follow the layout pattern used in the delivered HR_MSS_CT_JOB_SBF subpage. This
includes the added group box fields, Page Field Name values, and the Fluid attributes of each field. If
you don’t do this, the layout of the new data may not align properly with the existing fields.
The next step in the process is adding the new field as part of the Transaction Configuration. In this
example, we added a new hidden question after creating another Text Catalog entry for the question.
The hidden question specifies the HR_MSS_CT_JOBC_SBF customer subpage, and then we selected
the new field to be visible as shown in Figure 23.
26
PeopleSoft HCM 9.2 Guided Self Service
Figure 23. Transaction Configuration for new question and Job Entry Date
With this configuration complete, when we perform the GSS transaction, the new Job Entry Date field
is displayed as shown in Figure 24.
27
PeopleSoft HCM 9.2 Guided Self Service
The process to add an editable field from Job Data to your GSS transaction is similar to the process
for a read-only field, but it is complicated by requiring a change to the GSS data model. Also, you need
to be aware of any business logic that may be tied to the field(s) that you are allowing to be modified
during a transaction. There is existing validation logic built into the Job Data page for many fields, thus
you need to be aware that any validations run by the Job Data Component Interface may cause issues
when your transaction is processed for update.
In addition to the steps already covered, you must add your data fields to the HR_MSS_CT_DAT data
record. Also, add the data field to the following views:
• HR_MSS_CT_PNDG,
• HR_GSS_APDTL_VW,
• HR_MSS_CT_APRVW and
• HR_MSSCT_DTL_VW.
Your changes to the customer job subpage HR_MSS_CT_JOBC_SBF should include the new field(s)
from the HR_MSS_CT_DAT record as editable fields, instead of the read-only example provided
earlier.
If you need to display the additional field(s) as part of the approval process, modify the Mobile
Approvals interface and/or the PIA Guided Self Service Approvals page.
Mobile Approvals requires changes to code in application class
HR_MSS_CT_APPR:DetailDocument:GuidedSelfService to display additional Before and After values
as shown in Figure 25. The data that appears comes from the HR_GSS_APDTL_VW view that you
modified to include your changed fields.
28
PeopleSoft HCM 9.2 Guided Self Service
29
PeopleSoft HCM 9.2 Guided Self Service
After cloning the Activity Guide and making modifications, update the Guided Self Service transaction
configuration setup to use your new Activity Guide template. If desired, you can use a different
Activity Guide template for each GSS transaction. The Activity Guide ID setting is shown in Figure
27.
The use of Activity Guides provides the option to add additional action item components to the
Guided Self Service process. Components added to the template need to be Fluid components, and
they need to interact with the Activity Guide context data, where they get their key data from the
context data defined in the Activity Guide, and they pass values out to other action items within the
template.
You must define components used within an Activity Guide as a Related Content service. The service
definition details the parameters used to pass data into the component. For example, the
HR_MSS_CT_JB_AGFL component service is shown in Figure 28.
30
PeopleSoft HCM 9.2 Guided Self Service
The components used with an Activity Guide use context data at the action item level to indicate
which parameters are passed INTO the component, and what values are passed OUT of the
component. Any new component added into an Activity Guide needs to follow this same design
pattern as is done for the existing components defined for Guided Self Service. Figure 29 shows the
input and output parameters defined for the Job Detail component (HR_MSS_CT_JB_AGFL).
31
PeopleSoft HCM 9.2 Guided Self Service
Activity Guides do not process SavePostChange or SavePreChange PeopleCode logic for components
until you submit the Activity Guide during its final step when using a Single Unit of Work type Activity
Guide as we use in Guided Self Service. Because of this, we use a button hook to execute some
validation logic when using the Next button within an Activity Guide to move to the next step. For
Guided Self Service, we do not want users moving to the next steps in the process until completing the
current step. This may also be required for any new component that is added into the Activity Guide.
To execute the validation logic, you must place a hidden button on the page in App Designer. The
buttons must have a specific Fluid style name specified in order to hook into the validation executed
for the activity guide.
Guided Self Service populates this Fluid style at runtime, thus it is not specified in the App Designer
page field. The style used is called ps_ag-custom-step-button- plus the Item ID from the Activity
Guide. For example, the delivered Activity Guide for the Job Details component for GSS is
JOBIIIIIII1, thus the style applied to our hidden validation button is ps_ag-custom-step-button-
JOBIIIIIII1
When a user clicks the Next button in the Activity Guide, and the hooked hidden button is found, the
system executes the code linked to this button. For Guided Self Service, this code is placed on the
Component Record Field. Refer to the Activity Guide documentation for further details on this
feature. Figure 30 shows the hidden buttons placed on the HR_MSS_CT_PG1_AGFL Job Details
page.
32
PeopleSoft HCM 9.2 Guided Self Service
One final point to note about the Activity Guide version of Guided Self Service is the change to
Workflow Configurations (Set Up HCM > Common Definitions > Self Service > Workflow
Configurations). For each of the Guided Self Service transactions, a new entry was created in the
Notification Setup for the new HR_MSS_CT_SBM_AGFL component. This is required to route
notifications when approvals are turned off for a transaction. This is shown in Figure 31.
33
PeopleSoft HCM 9.2 Guided Self Service
Authors
PeopleSoft HCM Development Team
Revision History
DATE CHANGE
34
PeopleSoft HCM 9.2 GSS Red Paper Copyright © 2014, Oracle and/or its affiliates. All rights reserved.
October 2014
Author: PeopleSoft HCM Development This document is provided for information purposes only, and the contents hereof are subject to change without notice. This document
is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law,
including implied warranties and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any liability
Oracle Corporation
with respect to this document, and no contractual obligations are formed either directly or indirectly by this document. This document
World Headquarters
may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our prior written
500 Oracle Parkway
permission.
Redwood Shores, CA 94065
U.S.A.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Worldwide Inquiries:
Phone: +1.650.506.7000 Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and
Fax: +1.650.506.7200 are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0113
oracle.com