Setting Up PreBoarding and OnBoarding Activity Guides
PeopleSoft OnBoarding uses activity guides, which provides your workers with a simplified and streamlined approach to complete the OnBoarding business process. Activity guides track and maintain the users' progress as they performs prescribed tasks, or steps. The PeopleSoft OnBoarding process uses the PeopleSoft Activity Guide Composer framework that is designed to improve the deployment and management of fluid activity guides. This framework provides utilities and configurable steps that are commonly utilized in activity guides.
Although the PeopleSoft application delivers several ready to use OnBoarding templates, your organization may clone or define your own templates that you can assign to your workforce.
These topics that follow provide an overview of the setup steps involved in creating OnBoarding activity guides:
To support your OnBoarding processes (including both the PreBoarding and OnBoarding phases), you will use the following steps to configure and assign OnBoarding activity guide templates to your new hires. For more detailed information on these procedures, see the corresponding documentation.
Assign the Administrator Role
The OnBoarding Administrator role grants administrators access to manage updates to the activity guide composer template configuration and OnBoarding administration pages.
Set Up Activity Guide Categories
Categories contain the technical components that are utilized to define an activity guide template. For example, categories contain the technical definition of one or more steps that can be included in an activity guide. This includes the configuration of steps to be part of the PreBoarding (pre-hire) and/or OnBoarding (on or after the hire) phase of the process.
(For multi-participant activity guides) Configure the following information for the OnBoarding category:
AG Composer Categories - Assignees Page: Define users that you will assignee to activity guides, such employee and manager.
AG Composer Categories - Steps Page: Update the MGR_CHKLST step (if used), Additional Step Context section to have the CHECKLIST_CO parameter point to your own checklist data.
This section maps additional non-key context data fields to related content service parameters. It associates the step to the related content service HR_AG_CHECKLIST that navigates the manager to the application transaction page to review a list to perform manual tasks from the specified checklist (
).
For a list of delivered OnBoarding category steps, see the Working with OnBoarding Categories topic that follows.
For more detailed information on creating and working with categories templates, see Setting Up Activity Guide Categories.
Create OnBoarding Activity Guide Templates
Activity guide templates identify the exact configuration and steps end users will follow to complete their OnBoarding experience. To allow individuals to start the OnBoarding process before their start date, select steps that have been configured for PreBoarding. Activity guide templates are created and managed by template administrators—functional personnel who are very familiar with your organization's HR transaction processes.
(For multi-participant activity guides) Configure the following information:
Activity Guide Composer - Security Page: Identify the roles that will access the activity guide, including the employee and manager user.
Configure Attributes Page: Associate the assignees that need to complete a step. For example, employees will need to be identified as assignees to most all steps, but for the delivered template, only the manager will have access to the Manager Checklist step. Both the employee and manager will see the Before you Start step.
Note: For the delivered OBDMULT template, the Hide Steps option is selected to hide steps for a user when not assigned to him or her. With this option selected, users will only see the steps for which they need to take action.
(Optional) Set the manager tasks to Required to ensure the employee cannot mark the OnBoarding activity guide complete before the manager completes his or her tasks.
For a list of delivered OnBoarding templates steps, see the Working with OnBoarding Templates topic that follows.
For more detailed information on creating and working with templates, see Managing Activity Guide Templates.
Configure Documents for PreBoarding and OnBoarding
Documents can be associated with your OnBoarding activity guide templates and enable your employees to download and view, take action, or attach documents that are vital to the employment process.
See the Configure Documents - Documents Page and Configure Documents - Templates Page.
(Optional) Set Up Template Assignment
Template Assignment is a feature within the Activity Guide Composer framework that enables you to define tables and rules to automatically assign activity guide templates. See the Setting Up Activity Guide Utilities for Template Assignment documentation and the Working with Template Assignments topic below.
Define OnBoarding Installation Settings
Use the OnBoarding Installation table to assign OnBoarding information to OnBoarding participants. This includes the employee and manager roles, attachment storage location, activity guide category, template assignment method (by using a default template or the Template Assignment feature), administrator options, and methods for creating a user profile.
Delivered roles are:
Employee Role: OnBoarding Employee
Manager Role: OnBoarding Manager User
For a list of delivered OnBoarding templates, see the Working with OnBoarding Templates topic that follows.
See the OnBoarding Installation Page documentation.
Manage OnBoarding Events (as needed)
Use the Manage OnBoarding Event page to add an OnBoarding activity guide trigger for a person who is missing a job assignment trigger or to correct an incorrect template assignment.
See the Manage OnBoarding Event Page.
Note: An administrator would not normally access this page except in rare cases to correct invalid template assignments or to add a trigger that got missed.
Run the Application Engine process HR_OBD_NOTFY on a regularly occurring interval (
and adding a new value for process HR_OBD_NOTFY. Indicate the Specify Process Frequency as Always).This process generates reminder notifications for employees on their first day of work if they previously completed PreBoarding steps and there are OnBoarding steps remaining in the activity guide.
Note: The reminder notifications use the Notification Composer definition OnBoardingContinue. This notification ID can be tailored to your organization’s needs and can be overridden by defining a new notification ID and then specifying this new notification ID as the override for the notification event OnBoardingContinue.
A category definition contains the properties, contextual data, steps, and other options that can be included in an activity guide template. You will use the Categories component to associate these steps to a related content service that navigates the user to an application transaction page to perform a specific task. Not all steps need be included in a template, but all possible steps must be included in the category to be considered for a template. For example, you may have a step for workers to add their address, another to enter dependent data, one for US worker to grant W-2 and W-2c consent, and a step for Canadian workers to grant T4/T4 slip consent. You may also have steps that should be completed before the first day of work as well as steps that will not be available until the hire date. The template administrator will then determine which steps to include in a template. The template administrator might create one template for all employees or several templates to accommodate for different locations, such as US workers and Canadian workers, only including the steps relevant to workers in that country.
The PeopleSoft application delivers the OnBoarding (ONBOARDING) activity guide category.
Delivered OnBoarding Category Steps
The following table lists the delivered steps for the ONBOARDING category:
Step |
Description |
Additional Information |
---|---|---|
ACA_1095_CONSEN |
ACA 1095–Consent |
|
ACKNOWLEDGEMENT |
Acknowledgement |
The system delivers the OB1 parameter value as temporary data for this step as the acknowledgement parameter under the Additional Step Content section of the AG Composer Categories - Steps Page. Important! You will need to change the parameter based on the Acknowledgement ID you create using the Acknowledgement Framework. For information on Acknowledgement Framework, see Understanding the Acknowledgement Framework. |
BANK_ACCT_DSTRB |
Banking |
|
BENEFITS_ENROLL |
Benefits Enrollment |
|
BEN_ENROLL_FL |
Fluid Benefits Enrollment |
|
COMPETENCIES |
Competencies |
|
COPY_JOB_ITEMS |
Copy Job Profile Items |
Note: This step will display profile items from all the job profiles associated with the employee's job. Through this step, the employee can add the profile items to his or her own profile. See also Accessing Additional Profile Actions and Copy Job Items Page. |
DEGREES |
Degrees |
|
DEPBENEFICIARY |
Dependent/Beneficiary Info |
|
DIRECT_DEPOSITS |
Direct Deposits |
|
DIRECT_DEPOSITS_FL |
Fluid Direct Deposits |
|
DISABILITY |
Disability |
|
DOC_DOWNLOAD |
Documents |
The download Documents step is preconfigured for the OnBoarding process. All preconfigured documents matching the template will be selected for this step regardless of an assigned Document Group when no Related Data, Data Field 1 value on the AG Composer Categories - Steps Page is specified. |
DOC_DOWNLOAD1 |
Documents - Group 1 |
The system delivers the DOCGROUP1 document group and this value is associated with the DOC_DOWNLOAD1 step under the Related Data section, Data Field 1 field on the AG Composer Categories - Steps Page. If you use different document groups then the ones that are delivered, you will need to update the data field value based on the document groups you create. |
DOC_DOWNLOAD2 |
Documents - Group 2 |
The system delivers the DOCGROUP2 document group and this value is associated with the DOC_DOWNLOAD2 step under the Related Data section, Data Field 1 field on the AG Composer Categories - Steps Page. If you use different document groups then the ones that are delivered, you will need to update the data field value based on the document groups you create. |
DOC_UPLOAD |
Attachments |
|
EMERGEN_CONTACT |
Emergency Contacts |
|
ETHNIC_GROUPS |
Ethnic Groups |
|
I9 |
I-9 |
|
I9_FL |
Fluid I-9 |
|
INTRODUCTION |
Before the start video |
|
LICENSE_CERTIFI |
Licenses and Certifications |
|
LM_SS_LEARNING |
My Learning |
You must have the Enterprise Learning application installed and configured to view data on this page. When this configuration is incomplete, the page will display the message that data is not available. |
MARITAL_STATUS |
Marital Status |
|
MGR_CHKLST |
Manager Checklist |
The Additional Step Context section is used to map additional non-key context data fields to the related content service parameters and associates the step to the related content service HR_AG_CHECKLIST that navigates the manager to the transaction page to review the list to perform manual tasks. Important! If you use this step, you need to update the CHECKLIST_CD parameter value to map to the checklist the manager should use. |
ONBOARD_DOC |
OnBoarding Document Acknowledgement |
This step is configured to show only during the OnBoarding phase of the guided process. |
ONBOARD_INSTR |
OnBoarding Instructions |
This step is configured to show only during the OnBoarding phase of the guided process. |
PHOTO_UPLOAD |
Photo / Preferred Name |
|
PREBD_SUMMARY |
PreBoarding Summary |
This step is configured to show only during the PreBoarding phase of the guided process. |
PREBOARD_DOC |
PreBoarding Document Acknowledgement |
This step is configured to show only during the PreBoarding phase of the guided process. |
PREBOARD_INST |
PreBoarding Instructions |
This step is configured to show only during the PreBoarding phase of the guided process. |
RL1_RL2_CONSENT |
RL1/RL2 Consent |
|
SUMMARY |
Summary |
|
SURVEY |
OnBoarding Survey |
Surveys are set up using the Questionnaire framework. For more information on this, see Understanding Questionnaire Framework. |
T4_T4A_CONSENT |
T4/T4A Consent |
|
T4_T4A_CONS_FL |
T4/T4A Consent (Fluid version) |
|
TAX_WITHHOLDING |
Tax Withholding |
|
VERIFY_ADDRESS |
Verify Addresses |
|
VERIFY_ADT_INFO |
Verify Additional Information |
|
VERIFY_CONT_DTL |
Verify Contact Details |
|
VERIFY_NAME |
Verify Name |
|
VETERAN_STATUS |
Veteran Status |
|
VOLUNTARY_DEDUC |
Voluntary Deductions |
|
W2_W2C_CONSEN |
W-2/W-2C Consent |
|
WELCOME_VIDEO |
Welcome Video |
Setting Up Steps for PreBoarding or OnBoarding
When a person can access the OnBoarding activity guide and complete individual steps is based on the step definition. While the entire guided process is called OnBoarding, the PreBoarding phase includes steps that are available prior to hire and the OnBoarding phase displays steps available on or after the employee’s first day.
This example shows an example of the steps for the PreBoarding phase in the left screenshot and the steps for the OnBoarding phase in the left screenshot.

Note: PreBoarding can include steps that are also part of the OnBoarding phase but typically include steps that are requested prior to the first day of employment.
PreBoarding-only and OnBoarding-only Steps
There are some steps that are defined to appear only during the PreBoarding phase before their first day of employment and some that are defined to appear during the OnBoarding phase on and after their first day of employment. By default, all steps, other than the following, will be available for both the PreBoarding phase (future-dated hire) and OnBoarding phase (current employee):
Step |
Description |
Step for PreBoarding/OnBoarding Only |
Additional Information |
---|---|---|---|
ONBOARD_DOC |
OnBoarding Document Acknowledgement |
OnBoarding |
|
ONBOARD_INSTR |
OnBoarding Instructions |
OnBoarding |
|
PREBD_SUMMARY |
PreBoarding Summary |
PreBoarding |
Important! The PreBoarding Summary step should only be included in the template if there are some (but not all) OnBoarding-only steps included. This step provides a summary of all steps in the activity guide and allows the user to mark the PreBoarding phase as complete while the activity guide status is still in-progress. |
PREBOARD_DOC |
PreBoarding Document Acknowledgement |
PreBoarding |
|
PREBOARD_INST |
PreBoarding Instructions |
PreBoarding |
Note: The instructions and document acknowledgement steps are provided as an example of the setup required when defining a template to support PreBoarding and OnBoarding phases. You can configure these steps with the text and documents required for your organization.
During the PreBoarding and OnBoarding phases, the following happens:
If the PreBoarding configured step is defined as required and has not been completed by their first day, it will continue to appear in the activity guide during the OnBoarding phase.
If the PreBoarding configured step is not required, then it will no longer display on or after their first day.
When a step is defined for OnBoarding only, that step will not display until the employee’s first day of employment.
PreBoarding-Only and OnBoarding-Only Configuration
A special configuration exists in the ONBOARDING category to support PreBoarding and OnBoarding only steps.
To define a step as PreBoarding- or OnBoarding-only, use the AG Composer Categories - Steps Page, Additional Step Context section to specify the following parameters:
PreBoarding-only step:
Parameter Name = PROCESS_TYPE
Parameter Type = P
This example illustrates the Additional Step Context section for a step configured for PreBoarding only.
OnBoarding-only step:
Parameter Name = PROCESS_TYPE
Parameter Type = O)
This example illustrates the Additional Step Context section for a step configured for OnBoarding only.
When you do not specify a PROCESS_TYPE parameter, then that step applies to both phases.
Note: All delivered category steps support the PROCESS_TYPE parameter. However, if you add a new step, then you must include the PROCESS_TYPE Service URL Parameter in the related content service definition ( ).
Setting Up Steps for Multi-Participant Activity Guides
Multi-participant OnBoarding activity guide processes allow both the employee and the manager to share the same activity guide instance based on an assigned template. This allows the specific activity guide processes to divide action tasks or steps between the employee and their manager.
The PeopleSoft application delivers the OBDMULT (Standard Multi-Participant OnBoarding) template, which provides tasks for the employee as well as tasks for the manager to complete for the employee's OnBoarding process.
You will need to perform the following tasks for the OnBoarding category:
Identify assignees on the AG Composer Categories - Assignees Page. The delivered ONBOARDING category comes with the EMPLOYEE and MANAGER assignees already enabled. All steps, except the MGR_CHKLST step, have been given the default assignee of Employee.
(Optional) If you use the checklist, insert a new category row to update the MGR_CHKLST (Manager Checklist) step, Additional Step Context section. Enter the CHECKLIST_CD parameter value to point to the appropriate checklist the manager will need to complete for the employee's onboarding process.
This example illustrates the Additional Step Context section for the MGR_CHKLST step.
The Activity Guide Composer uses fluid pages to create templates that identify the steps a user should take to perform a transaction or process. You will use the Activity Guide Composer - Templates component to define the activity guide layout, assign a category, identify the security roles that can access the OnBoarding templates and activity guides, identify actions the user can take, and identify the steps that a new employee would need to complete during the OnBoarding process.
Delivered OnBoarding Template and Steps
All delivered templates use the vertical non-sequential layout that has the navigation steps appear in the left panel of the page.
The following table lists the delivered, ready to use, OnBoarding activity guide templates and their corresponding page steps:
Template |
List of Page Steps |
---|---|
OBDPRBD – Standard PreBoarding |
See also Understanding the Delivered Standard PreBoarding Activity Guide Steps. |
OBDSTND – Standard OnBoarding |
See also Understanding the Delivered Standard OnBoarding Activity Guide Steps. |
OBDMULT – Standard Multi-Participant OnBoarding |
Available to the employee:
Available to the manager:
See also Understanding the Delivered Standard Multi-Participant OnBoarding Activity Guide Steps. |
OBDCAN1 – OnBoarding for CAN |
See also (CAN) Understanding the Delivered OnBoarding for Canada Activity Guide Steps. |
OBDUSA1 – OnBoarding for USA |
See also (USA) Understanding the Delivered OnBoarding for USA Activity Guide Steps. |
Considerations for Configuring Templates with PreBoarding and OnBoarding Steps
The following are guidelines for the template configuration based on the organization’s scenario:
Processing Scenario |
Category/Template Requirements |
---|---|
All steps can be completed during either the PreBoarding or OnBoarding phase. |
|
Some steps should be completed during the OnBoarding-only phase. All others can be completed at any time. |
|
Some steps should be completed during the PreBoarding-only phase. All others can be completed at any time. |
|
Some steps should be completed during the PreBoarding-only phase and some should be completed during the OnBoarding-only phase. |
|
The PeopleSoft HCM system delivers the OBDPRBD template as an activity guide that supports both PreBoarding and OnBoarding phases. When using this activity guide template, a person accessing the activity guide process prior to the first day of employment will see those steps that are marked for PreBoarding-only as well as those that have no designation. On the first day of employment and after, the person will see those steps marked as OnBoarding-only and those without any designation. If the person did not complete a required PreBoarding-only step it will also appear.
Important! You must always start the OnBoarding activity guides from the delivered OnBoarding Activities Tile (for Employees). The creation of the activity guide instance includes special processing that is mandatory for the successful transition between the PreBoarding and OnBoarding phases.
Setting Up Templates for Multi-Participant Users
The PeopleSoft application delivers the OBDMULT (Standard Multi-Participant OnBoarding) template, which provides tasks for the employee as well as tasks for the manager to complete for the employee's OnBoarding process. This template is already configured with the following.
The Activity Guide Composer - Security Page includes the following roles:
Administrator: OnBoarding Administrator
End User: OnBoarding Employee
End User: OnBoarding Manager User
Note: The End User roles for the employee and manager user should match the Employee Role and Manager Role defined on the OnBoarding Installation Page.
The Configure Attributes Page includes the OnBoarding Manager assignees for the following steps:
Before you Start
This example illustrates the Assignees for the Before you Start step on the OBDMULT template.
Manager Checklist
This example illustrates the Assignees for the Manager Checklist step on the OBDMULT template.
Note: For the delivered OBDMULT template, the Hide Steps option is selected to hide steps for a user when not assigned to him or her. With this option selected, users will only see the steps for which they need to take action.
You will need to perform the following additional tasks for templates that use multi-participants:
Although the application delivers categories and templates for your OnBoarding activity guides, you have the ability to create your own categories and templates or use the delivered data as a starting point for your own categories and activity guide templates.
The fields for delivered data are disabled and unavailable for update. Although you cannot update the delivered data, you can make modifications to delivered or existing categories and templates to suit your organization's needs. This is done by using one of these methods and making the modifications:
Inserting a new effective dated row.
Cloning a category or template.
Warning! When you make modifications to a template (by either inserting a row or cloning), you cannot change the activity guide type (layout) or category. To have a template that does not use the same layout type or category, you will need to create a new template instead of cloning or inserting a new effective dated row.
For more information on setting up activity guide categories or templates, see the Setting Up Activity Guide Categories and Managing Activity Guide Templates documentation.
Important! When there are updates for the delivered OnBoarding category or templates, Oracle will only update the 01/01/1900 row and will not modify effective dated rows entered by the customer.
Considerations for Configuring Categories for Your Environment
If you want to use the delivered categories as a basis for your OnBoarding categories, or create your own, consider the following:
OnBoarding categories should always use the EMPLID and EMPL_RCD context key fields. The OnBoarding template creation process makes the assumption that an OnBoarding process is created for a job assignment.
You should always have a Summary step that can be included as the last step in the activity guide process where users can review their progress and mark the activity guide as complete.
To add or remove steps from an existing category, you will need to add a new effective dated OnBoarding category row and add or delete the steps.
Important! If you do this for a category that is already associated with a template, you will need to insert a row in the template with a date equal to or later than the row with the new or deleted step to apply those changes to your template. The system will not automatically insert the step into the template, but you can now opt to include this new step into the template.
For example, you want to add a new step to the ONBOARDING category that enables an employee to enter their car information for parking purposes. Access the ONBOARDING category and insert a new effective dated row of January 1, 2024. In order to add that new step to your OnBoarding templates, you will need to insert an effective dated row equal to or greater than January 1, 2024 to see that new step you added to the category. To insert the new row in the template, access the Activity Guide Composer - Select Steps Page. The new step will be available to add to the template.
You can clone the delivered ONBOARDING category by accessing the Clone Category Page, selecting the category and effective dated row you want to copy, enter the new category details, and click Clone Category to save a copy of the category. You will need to navigate to the Categories component where you can update this new category (see Setting Up Activity Guide Categories).
Considerations for Configuring Templates for Your Environment
If you want to use the delivered templates as a basis for your OnBoarding templates, consider the following:
In order to make modifications to delivered templates, access the Activity Guide Templates Page and do one of the following:
Insert a new effective dated row by selecting the Update Template button to access the Update Template Page and click the Add button, This will insert a new effective dated row where you can enter the new date. Apply the change and click the Update Template button to access the template and make the changes.
Clone a delivered OnBoarding template by clicking the Clone Template button for the desired template. On the Clone Template Page select the effective dated row you want to copy, enter the new template details, and click Continue to save a copy of the template. You will be returned to the Activity Guide Templates page where you can select to update this template.
Note: These actions will copy all the configuration setup for this template, including the status of the template at the time of inserting a row or cloning. You can change the auto save functionality, security roles, actions, step configuration, and status, but you cannot change the activity guide layout type and category.
To inactivate a delivered template, insert a row with a new effective date, access the Activity Guide Composer - Review and Activate Page and click the Deactivate Activity Guide button.
If you do not want to use the same category or activity guide type (layout style) as an existing template, create a new template instead of cloning or inserting a new effective dated row.
If you have documents that must be acknowledged, updated and uploaded, or just uploaded, make the document-related steps (Documents, Attachments, and so forth) required on the Configure Attributes Page.
You should always have a Summary step that can be included as the last step in the activity guide process where users can review their progress and mark the activity guide as complete.
The Activity Guide Composer framework provides you with the ability to configure rules to determine which OnBoarding template that should be assigned to a person. This is configured through the Activity Guide Utilities - Template Assignment feature. For detailed information on setting up template assignments, see the corresponding documentation.
To set up template assignments for OnBoarding:
Identify source criteria fields that are derived from the key structure of a source table using the Search Key Source Tables Page.
Identify search key source configurations using the Search Keys Page.
Enter search keys and values for the template assignment definition in the Template Assignment component (AG Composer Tmplt Asgnmt - General Page and AG Composer Tmplt Asgnmt - Template Assignment Page).
Test the Template Assignment process using the Test Template Assignment Page.
Set up the OnBoarding Installation Page to use the Template Assignment feature to customize which OnBoarding activity guide templates are assigned to individuals.
Delivered Search Keys Source Tables
The following table lists the delivered search key source tables for template assignment, but you can add your own:
Search Key |
Description |
---|---|
BEN_PROG_PTC_VW |
Employee Benefit Programs |
JOB |
Employee Job History |
JOB_ACTION_VW |
Job - Action view |
JOB_ACTRSN_VW |
Job - Action Reason view |
JOB_JOBCD_VW |
Job - Jobcode view |
JOB_POSN_VW |
Job - Position view |
Delivered Search Keys
The following table lists the delivered search keys for template assignment, but you can add your own:
Search Key |
Description |
---|---|
ACTION |
Action |
ACTION_REASON |
Action Reason |
ACTION_TYPE |
Action Type |
ACTN_REASON_TYPE |
Action Reason Type |
BENEFIT_PROGRAM |
Benefit Program |
BUSINESS_UNIT |
Business Unit |
COMPANY |
Company |
DEPARTMENT |
Department |
EMPLOYEE_TYPE |
Employee Type |
FULL_PART_TIME |
Full/Part Time Indicator |
GRADE |
Salary Grade |
JOBCODE |
Job Code |
JOB_FAMILY |
Job Family |
JOB_FUNCTION |
Job Function |
LOCATION |
Location |
PER_ORG |
Organization Relationship |
POSITION |
Position |
REG_REGION |
Regulatory Region |
UNION |
Union |