oracle human capital management cloud integrating with oracle

OracleHuman Capital ManagementCloudIntegrating with Oracle HCMCloud

Release 9 This guide also applies to on-premiseimplementations

Oracle® Human Capital Management Cloud Integrating with Oracle HCM Cloud

Part Number E55683-02

Copyright © 2011-2014, Oracle and/or its affiliates. All rights reserved.

Authors: Tim Bisset, Juthika Das, Scott Dunn, Carla Fabrizio, Alison Firth, Juliette Fleming, Hema Hardikar, Suzanne Kinkead, Janet McCandless, Jyothi Meruva, Barnali Roy, Srinivas Vellikad, Megan Wallace

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected byintellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast,modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, ordecompilation of this software, unless required by law for interoperability, is prohibited.

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 tous in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the followingnotice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulationand agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operatingsystem, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictionsapplicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use inany inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerousapplications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. OracleCorporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks orregistered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks ofAdvanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products and services from third parties. Oracle Corporationand its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. OracleCorporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products,or services.

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc


http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info


http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs

Oracle Human Capital Management CloudIntegrating with Oracle HCM Cloud

Contents

Preface i

1 Introduction 1Integrating with Oracle HCM Cloud: Overview .......................................................................................................... 1

Inbound Integrations: Explained ................................................................................................................................ 5

Outbound Integrations: Explained ............................................................................................................................. 7

2 HCM File-Based Loader Introduction 9HCM File-Based Loader: Explained .......................................................................................................................... 9

Use in Various Implementation Scenarios: Points to Consider ................................................................................. 13

Preparation: Critical Choices ................................................................................................................................... 14

Managing Data Upload: Points to Consider ............................................................................................................ 15

Security Considerations: Explained ......................................................................................................................... 15

3 HCM File-Based Loader Preparation 17Configuration Parameters ........................................................................................................................................ 17

Defining Oracle Fusion Business Objects: Explained ............................................................................................... 19

Generating the Mapping File: Explained .................................................................................................................. 21

Importing Cross-Reference Information: Explained .................................................................................................. 24

GUID Values: How They Are Processed ................................................................................................................. 25

Supported Data Operations: Explained ................................................................................................................... 27

Updating Logical Start and End Dates for Date-Effective Business Objects: Explained ............................................ 28

Preparing Source Data for Delivery to Oracle Fusion HCM: Explained ..................................................................... 29

Delivering Data to Oracle WebCenter Content: Explained ....................................................................................... 33

4 HCM File-Based Loader Example Data Files 36Creating Data Files: Points to Consider .................................................................................................................. 36

Changing the Logical Start Date of a Business Object: Example ............................................................................. 36

Changing the Logical End Date of a Business Object: Example .............................................................................. 37

Setting Attribute Values to NULL: Examples ........................................................................................................... 38


5 HCM File-Based Loader Data Loading 39Importing and Loading Data to Oracle Fusion HCM: Procedure .............................................................................. 39

Importing Data to Stage Tables and Fixing Import Errors: Explained ....................................................................... 40

Loading Data from Stage Tables to Application Tables: Procedure ......................................................................... 42

Monitoring Data Loads and Correcting Batch-Load Errors: Explained ..................................................................... 43

6 HCM File-Based Loader Post-Load Processes 45Running Post-Load Processes: Explained ............................................................................................................... 45

FAQs for File-Based Loader: Post-Load Processing ............................................................................................... 46

7 Data Loading Using Spreadsheets 48Spreadsheet Data Loaders: Explained .................................................................................................................... 48

Setting Up the Desktop Integration for Excel: Procedure ........................................................................................ 49

Working in Desktop Integrated Excel Workbooks: Points to Consider ..................................................................... 51

8 HCM Spreadsheet Data Loader 53Uploading Data: Explained ...................................................................................................................................... 53

When to Use: Explained ......................................................................................................................................... 55

Correcting Load Errors: Explained .......................................................................................................................... 55

Uploading Data: Worked Example .......................................................................................................................... 56

FAQs for HCM Spreadsheet Data Loader ............................................................................................................... 58

9 Payroll Data Loading 60Overview ................................................................................................................................................................. 60

10 Payroll Batch Loader 62Using Payroll Batch Loader .................................................................................................................................... 62

Loading Initial Balances .......................................................................................................................................... 73

11 Payroll Batch Loader Workbooks 85Workbook for Payroll Definitions ............................................................................................................................. 85

Workbook for Payroll Relationships ......................................................................................................................... 96

Workbooks for Bank Data ...................................................................................................................................... 98

Workbooks for Globals ......................................................................................................................................... 104

Workbooks for User-Defined Tables ..................................................................................................................... 105

Workbooks for Balance Groups ............................................................................................................................ 119


12 Time, Absence, and Pension Data for Payroll 122Overview ............................................................................................................................................................... 122

Setting Up and Processing Time Entries: Critical Choices ..................................................................................... 123

Validating, Transferring, and Correcting Time Entries: Explained ............................................................................ 126

File Format for Importing Time Entries .................................................................................................................. 128

Transferring Absence Information: Procedure ........................................................................................................ 131

File Format for Importing Absence Entries ............................................................................................................ 133

Running the Load Benefit Batches Process: Procedure ........................................................................................ 136

File Format for Importing Pension Deductions ....................................................................................................... 137

FAQs for Time, Absence, and Pension Data for Payroll ......................................................................................... 139

13 Upload Value Set Values Process 141Process Overview ................................................................................................................................................. 141

Importing Value Set Values: Procedure ................................................................................................................. 141

Flat-File Requirements: Explained .......................................................................................................................... 142

14 HCM Extracts 145Managing Extracts ................................................................................................................................................ 145

Filtering Extracts .................................................................................................................................................... 163

Delivering Extracts ................................................................................................................................................. 165

15 Payroll Outbound Interface 168Overview ............................................................................................................................................................... 168

Implementing Payroll Interface: Procedure ............................................................................................................ 169

Creating Extract Definitions: Procedure ................................................................................................................. 173

Global Payroll Interface Extract Definition .............................................................................................................. 174

Creating a Report from a Copy: Worked Example ................................................................................................ 180

Output File Templates: Highlights .......................................................................................................................... 182

16 Benefits Data Extract 183Configuring for Plan Carriers: Procedure ............................................................................................................... 183

Valid Extract Names: Explained ............................................................................................................................ 186

Generating and Transmitting Extracts: Procedure ................................................................................................. 187

Custom Layout ..................................................................................................................................................... 189


17 Oracle Taleo Recruiting Integration 196HCM and Oracle Taleo Recruiting Cloud Service Components: How They Work Together .................................... 196

Importing Data from Oracle Taleo Recruiting: Explained ........................................................................................ 196

Exporting Data to Oracle Taleo Recruiting: Explained ............................................................................................ 197

FAQs for Oracle Taleo Recruiting and HCM Integration ......................................................................................... 199

18 File Encryption Using HCM Connect 200HCM Connect: Explained ...................................................................................................................................... 200

19 Web Services 201Overview ............................................................................................................................................................... 201

HCM RESTful Services and Atom Feeds: Overview .............................................................................................. 202

20 Coexistence for HCM Introduction 203Offering Overview .................................................................................................................................................. 203

Task List Groups for Coexistence for HCM : Explained ......................................................................................... 203

HCM Coexistence: Explained ................................................................................................................................ 206

Oracle Fusion Workforce Directory Management: Explained .................................................................................. 208

21 Coexistence for HCM Security 211Implementation Users: Explained .......................................................................................................................... 211

Defining Security: Explained .................................................................................................................................. 211

Creating Job Roles: Procedure ............................................................................................................................. 213

Creating Users and Provisioning Roles: Explained ................................................................................................. 214

22 Coexistence for HCM Setup 216Configuration Parameters ...................................................................................................................................... 216

Initializing HCM Coexistence: Explained ................................................................................................................ 219

Sychronizing Data After Initial Data Load: Explained .............................................................................................. 222

Reference Data Sets: Points to Consider .............................................................................................................. 223

Enterprise Structures: Points to Consider ............................................................................................................. 223

Actions and Action Reasons: Points to Consider .................................................................................................. 224

Assignment Statuses: Explained ........................................................................................................................... 225

Person Types for HCM Coexistence: Explained .................................................................................................... 225

Elements: Explained .............................................................................................................................................. 226

FAQs for Coexistence for HCM: Setup ................................................................................................................. 227


23 Coexistence for HCM Data Mapping 229Generating Mapping Identifiers for HCM Business Objects: Explained ................................................................... 229

Mapping PeopleSoft HRMS Data for HCM Coexistence: Explained ....................................................................... 229

Mapping Oracle E-Business Suite HRMS Data for HCM Coexistence: Explained ................................................... 231

Mapping Subtasks for Oracle E-Business Suite HRMS Data : Explained ............................................................... 232

24 Coexistence for HCM Data Loading 234HCM Data: How It's Loaded ................................................................................................................................ 234

Loading Data Automatically: Explained .................................................................................................................. 236

Loading Business Objects in the Required Order: Explained ................................................................................. 237

Dependencies Between Business Objects: Explained ........................................................................................... 240

Loading Batch Data into Oracle Fusion HCM: Explained ....................................................................................... 242

Load Batch Data Parameters ................................................................................................................................ 243

Data-Load Batch-Status Values: Explained ........................................................................................................... 243

Data-Load Object-Status Values: Explained .......................................................................................................... 244

Deleted Source Records: How They Are Processed ............................................................................................. 245

Validation of Complex Business Objects by the Load Batch Data Process : Explained .......................................... 245

Frequency of Data Loads: Points to Consider ....................................................................................................... 246

Using Oracle Fusion Transactional Business Intelligence Reports to Validate Uploaded Data: Explained ................. 247

Running OTBI Reports to Validate Uploaded Data : Explained .............................................................................. 249

FAQs for Coexistence for HCM Data Loading ....................................................................................................... 250

25 Coexistence for HCM Post-Load Processes 251Processes Required After Loading Data: Explained ............................................................................................... 251

Processes Required After Loading Workforce Compensation Data: Explained ....................................................... 252

Extracting HCM Coexistence Data: Explained ....................................................................................................... 253

Deleting HCM Stage Data and Files: Explained ..................................................................................................... 253


Preface

i

PrefaceThis Preface introduces information sources available to help you use Oracle Applications.

Oracle Applications HelpUse the help icon to access Oracle Applications Help in the application.

Note

If you don't see any help icons on your page, click the Show Help button in the global area. Not all pages havehelp icons.

You can also access Oracle Applications Help at https://fusionhelp.oracle.com/.

Oracle Applications GuidesTo find other guides for Oracle Applications, go to:

• Oracle Applications Help, and select Documentation Library from the Navigator menu.

• Oracle Help Center at http://docs.oracle.com/

Other Information Sources

My Oracle SupportOracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if youare hearing impaired.

Oracle Enterprise Repository for Oracle Fusion ApplicationsOracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com) provides details on assets (suchas services, integration tables, and composites) to help you manage the lifecycle of your software.

Documentation AccessibilityFor information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Comments and SuggestionsPlease give us feedback about Oracle Applications Help and guides! - Send e-mail to:[email protected]. - Click your user name in the global area of Oracle Applications Help,and select Send Feedback to Oracle.

https://fusionhelp.oracle.com/

http://docs.oracle.com/



http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs

http://fusionappsoer.oracle.com




Chapter 1Introduction

1

1 Introduction

Integrating with Oracle HCM Cloud: OverviewThis guide describes the ways in which you can integrate applications with Oracle HCM Cloud. Most of the content describesways of loading or extracting data.

This topic shows the scope of this guide and summarizes the contents of each chapter.

Introduction

Chapter Title Contents

1

Introduction

An introduction to this guideand an overview of the availableapproaches to data loading andextracts.

Data Loading Using File-Based Loader


2

HCM File-Based LoaderIntroduction

An introduction to HCM File-Based Loader, including supportedobjects, implementation scenarios,best practices, and securityrequirements.

3

HCM File-Based LoaderPreparation

Setting configuration parameters,defining referenced objects andgenerating the associated mappingfile, supported data operations, anddelivery of data files to the OracleWebCenter Content server.

4

HCM File-Based Loader ExampleData Files

Examples showing how to performsupported data operations, such assetting attribute values to null andchanging the logical end date of anobject.



2


5

HCM File-Based Loader DataLoading

Importing and loading data,monitoring those processes, andcorrecting errors.

6

HCM File-Based Loader Post-LoadProcesses

Processes to run after loadingperson records.

Data Loading Using Spreadsheet Loaders


7

Data Loading Using Spreadsheets

An overview of the availablespreadsheet loaders and generalsetup requirements for spreadsheetusage.

8

HCM Spreadsheet Data Loader

Using HCM Spreadsheet DataLoader to load business objectssuch as locations, jobs, workers,and absence records to OracleHCM Cloud.

Loading Payroll Data


9

Payroll Data Loading

An overview of the ways in whichyou can load payroll data bothduring setup and later.

10

Payroll Batch Loader

Using the Payroll Batch Loaderto load payroll business objectssuch as balance groups, elements,element entries, and payrolldefinitions to Oracle HCM Cloud.Using the Payroll Batch Loader tomigrate payroll business objectsbetween environments.



3


11

Payroll Batch Loader Workbooks

Details of the workbooks for payrolldefinitions, payroll relationships,bank data, globals, user-definedtables, and balance groups.

12

Time, Absence, and Pension Datafor Payroll

Loading third-party time entries,pension deductions, and absenceinformation in XML format to OracleGlobal Payroll.

Uploading Value Set Values


13

Upload Value Set Values Process

Using a process to upload value setvalues from a .csv file.

Extracting Data


14

HCM Extracts

Using HCM Extracts to extract datafrom Oracle HCM Cloud, filteringthose extracts, and selecting adelivery format.

15

Payroll Outbound Interface

Extracting personal payrollinformation for delivery to athird-party payroll provider usingpredefined or custom extractdefinitions.

16

Benefits Data Extract

Setting up benefits plan carriersand extracting benefits enrollmentinformation into an XML file for eachcarrier.



4

Oracle Taleo Integration


17

Oracle Taleo Recruiting Integration

How integration between OracleTaleo and Oracle HCM Cloud ismanaged.

File Encryption


18

File Encryption Using HCMConnect

Using HCM Connect to encryptdata for loading to, or extractingfrom, Oracle HCM Cloud.

Web Services


19

Web Services

Using Oracle Fusion ADF andcomposite web services tointegrate web-based applicationswith Oracle HCM Cloud. UsingRESTful services and Atom feeds.

Coexistence for HCMThe Coexistence for HCM offering is available to existing Coexistence for HCM users only.


20

Coexistence for HCM Introduction

An introduction to the Coexistencefor HCM offering.



5


21

Coexistence for HCM Security

Security setup, including themanagement of implementationand application users.

22

Coexistence for HCM Setup

Setting up Coexistence for HCM.

23

Coexistence for HCM DataMapping

Mapping PeopleSoft HRMS orHCM data and Oracle E-BusinessSuite data to Oracle Fusion HumanCapital Management.

24

Coexistence for HCM Data Loading

Loading data to Oracle HCMCloud for an available coexistencescenario.

25

Coexistence for HCM Post-LoadProcesses

Processes to run after loadingperson records and compensationdata.

Inbound Integrations: ExplainedThis topic introduces ways of developing inbound integrations to Oracle Fusion HCM.

These include:

• HCM File-Based Loader

• HCM Spreadsheet Data Loader

• Payroll Batch Loader

• REST services

HCM File-Based LoaderUse HCM File-Based Loader to load data in bulk from any source to Oracle Fusion HCM.

HCM File-Based Loader is most suitable for:

• Loading complex, hierarchical data

• Loading large volumes of data

• Managing iterative loads



6

You deliver a compressed file of data in a prescribed format to the Oracle WebCenter Content server.

HCM File-Based Loader:

1. Imports the file contents to stage tables

2. Loads business objects from the stage tables to the application tables

You can perform both steps of this process interactively, for one file at a time, using Oracle Fusion HCM interfaces. You canalso perform step 2 without user intervention.

Alternatively, you can use the Loader Integration Service web service, which you call using generated proxy classes. Using awrapper function, you can also automate the process of delivering data to the Oracle WebCenter Content server. By includingboth the wrapper function and the Loader Integration Service web service in an orchestrated process flow, you can automatedata loading and control it outside Oracle Fusion HCM. For details of the Loader Integration Service web service, see theOracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com).

File EncryptionMany of the data files that you upload using HCM File-Based Loader contain sensitive information. You can protect sensitiveinformation from unauthorized access using HCM Connect.

HCM Connect:

• Transfers files encrypted using Pretty Good Privacy (PGP) encryption types to the Oracle WebCenter Content server

• Calls HCM File-Based Loader to upload the encrypted files

HCM File-Based Loader can process encrypted files and accept instructions to decrypt them before upload.

HCM Spreadsheet Data LoaderHCM Spreadsheet Data Loader generates spreadsheets dynamically for several Oracle Fusion HCM business objects. Eachspreadsheet contains columns for the object attributes, identifies required values, and uses lists of values (LOVs) for manyattributes to aid completion. Many spreadsheets also support flexfields. Once the spreadsheet is populated with data, theupload, validation, and correction of data are straightforward processes.

HCM Spreadsheet Data Loader is most suitable for loading:

• Setup data

• Nonhierarchical and simple hierarchical data

• Small-to-medium volumes of data

HCM Spreadsheet Data Loader is an interactive tool that is well suited to data loading for immediate or specific purposes.

Payroll Batch LoaderUse Payroll Batch Loader to load payroll business objects into Oracle Fusion HCM.

You deliver a compressed data file to the Oracle WebCenter Content server. Payroll Batch Loader:

1. Imports the file contents to the Payroll Batch Loader stage tables

2. Loads payroll business objects from the Payroll Batch Loader stage tables to the application tables



7

You can automate both steps in the Payroll Batch Loader process using the Flow Actions Service web service. For detailsof the Flow Actions Service web service, see the Oracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com).

REST ServicesOracle Fusion HCM includes a small set of REST services for the employee business object. These services allow you tomanage the employee lifecycle and maintain employee details, roles, and responsibilities. They also support the extraction ofindividual employee details, providing real-time outbound capability.

REST services are suited to integrations with applications on mobile devices.

Outbound Integrations: ExplainedThis topic introduces ways of developing outbound integrations from Oracle Fusion HCM.

These include:

• HCM Extracts

• Oracle Business Intelligence Publisher (BI Publisher) and services

• Atom feeds

HCM ExtractsThe primary means of retrieving data in bulk from Oracle Fusion HCM is HCM Extracts, which is a flexible tool for generatingdata files and reports.

HCM Extracts has a dedicated interface for specifying the records and attributes to be extracted. You:

• Identify records for extraction using complex selection criteria.

• Define data elements in an HCM extract using fast formula database items and rules.

You manage HCM Extracts either in the Data Exchange work area or using the Checklists interface in the Payroll work area.Alternatively, you can run extracts using the Flow Actions Service web service from outside Oracle Fusion HCM. This featureenables you to automate the outbound extract as part of an overall integration flow. For details of the Flow Actions Serviceweb service, see the Oracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com).

HCM Extracts Output FormatsUsing the built-in integration with BI Publisher, you can generate extracts in various formats, including CSV, XML, Excel,HTML, RTF, and PDF.

You can download the raw hierarchical XML from a completed extract using the Extract Actions Service web service. Fordetails of the Extract Actions Service web service, see the Oracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com). Alternatively, you can download the formatted BI report (for example, the CSV file) using the BIScheduleService. In both cases, the output is streamed in a byte array. Therefore, any orchestration mechanism must be ableto handle this output, possibly by means of wrapper code.

You can also generate an HCM Extract without specifying an output format at the design stage. Subsequently, you cangenerate a BI report based on the extract using BI Publisher or the BI ReportService. This technique uses a dedicated BI datamodel that interfaces with the generated HCM Extracts XML.



8

File EncryptionUsing HCM Connect, you can generate output from HCM Extracts that's encrypted using Pretty Good Privacy (PGP)encryption types and identify a destination server for the output. HCM Connect ensures that data remains encrypted whetherin transit or at rest.

BI Publisher and ServicesBI Publisher supports both scheduled and unplanned reporting, based on either predefined Oracle Transactional BusinessIntelligence analysis structures or custom data models. You can generate reports in various formats. To use BI Publisher foroutbound integration, you generate reports in a format suitable for automatic downstream processing, such as XML or CSV.

In addition, two BI services exist that may be of use when integrating BI reporting into an orchestrated flow:

• ReportService

You can use this service to run predefined reports and download their content.

• ScheduleService

You can use this service to retrieve the output of completed reports.

For more information about these services, see the Oracle Fusion Middleware Developer's Guide for Oracle BusinessIntelligence Publisher.

Atom FeedsAtom feeds provide notifications of Oracle Fusion HCM events and are tightly integrated with REST services.

When an event occurs in Oracle Fusion HCM, the corresponding Atom feed is delivered automatically to the Atom server. Thefeed contains details of the REST resource on which the event occurred. Subscribers who consume the Atom feeds can usethe REST resource to retrieve additional information about the resource. They can also orchestrate downstream processingbased on the Oracle Fusion HCM event.


Chapter 2HCM File-Based Loader Introduction

9

2 HCM File-Based Loader Introduction

HCM File-Based Loader: ExplainedUsing the Oracle Fusion Human Capital Management (Oracle Fusion HCM) File-Based Loader, you can load data in bulk,including business object history, from any data source to Oracle Fusion HCM.

Typically, you use File-Based Loader for an initial data upload and maintain the data in Oracle Fusion HCM thereafter. Youcan also use File-Based Loader to load data after the initial load in a variety of scenarios. You can:

• Upload changed data periodically if you're continuing to maintain the source data

• Perform periodic batch-loading of objects such as competencies or element entries

How File-Based Loader WorksFile-Based Loader uses the Oracle Fusion HCM Load Batch Data process to load your source data to the Oracle Fusionapplication tables. Load Batch Data is a generic utility for loading data to Oracle Fusion from external sources. It's used by:

• Oracle Fusion Coexistence for HCM

• Oracle Fusion Enterprise Structures Configurator (ESC)

• Oracle Fusion HCM Spreadsheet Data Loader

The Load Batch Data process:

1. Imports data initially in object-specific batches to stage tables.

2. Prepares the data for load in the stage tables.

3. Loads data from the stage tables to the Oracle Fusion application tables.

You can use File-Based Loader for loading large volumes (tens of thousands) of complex hierarchical objects. You can uploaddata from any source, provided that, when data is loaded to the Load Batch Data stage tables, it's in a format that satisfiesthe Oracle Fusion business rules.



10

The following figure shows the key stages of the data-load process using Oracle Fusion HCM File-Based Loader.

Business Objects for File-Based LoaderThe following table shows the business objects that you can upload to Oracle Fusion HCM using File-Based Loader. For theinitial load, you must load objects in the order shown here to respect dependencies between objects.

NoteDuring upload, you can create and update business objects, and upload the complete history for any object.However, you can't upload attachments or delete objects.



11

Order Business Object Dependency

1

Actions

None

2

Action Reasons

Actions

3

Location

None

4

Business Unit

None

Important You must map eachbusiness unit to a defaultset immediately after load.

5

Grade

None

6

Grade Rate

Grade, Business Unit

7

Job Family

None

8

Job

Job Family, Grade

9

Salary Basis

Grade Rate

10

Establishment

None

11

Rating Model

None

12

Talent Profile Content Item

Rating Model

13

Talent Profile Content ItemRelationship

Content Item, Establishment



12


14

Person

None

Note The person object includesemployees, contingentworkers, pending workers,and non workers/

15

Person Contacts

Person

16

Person Documentation

Person

Note Person documentationincludes citizenship,passports, and visas only.

17

Department

Location, Person, Business Unit

18

Position

Job, Department

19

Work Relationship

Person, Position

Note Work relationship includescontracts only for the 3-tier (Single Term SingleAssignment) employmentmodel.

20

Salary

Salary Basis

21

Element Entry

Work Relationship

22

Tree

None

23

Tree Version

Tree



13


24

Department Tree Node

Tree, Tree Version, Department

25

Person Accrual Detail

Person, Work Relationship

26

Person Absence Entry

Person

27

Person Maternity Absence Entry

Person

28

Person Entitlement Detail

Person, Work Relationship

Use in Various Implementation Scenarios: Points toConsiderYou can implement Oracle Fusion HCM fully either on-premises or in the cloud. Alternatively, you can implement OracleFusion HCM in a coexistence scenario, where you use Oracle Fusion Talent Management and Oracle Fusion WorkforceCompensation along with your existing HR applications.

Full ImplementationIf you're performing a full implementation of Oracle Fusion HCM, then you can use File-Based Loader to load your existingHCM data in bulk at appropriate stages in the implementation. Typically, you load each type of data once only for this type ofimplementation. After a successful upload, you manage your data in Oracle Fusion HCM.

Coexistence Implementation for Any Source EnvironmentIf you're implementing a new HCM coexistence scenario for any source application, you can use File-Based Loader for dataupload.

ImportantYou migrate talent management data to Oracle Fusion, which becomes the system of record for this data. Youmaintain all other data in the source application and upload the data periodically to Oracle Fusion. The sourceapplication remains the system of record for this data.

When using File-Based Loader:

• You must define the mapping between your source data and Oracle Fusion HCM and manage the data extract fromyour source system.

• You don't have to upload complete business objects in every data upload. However, when uploading workrelationship data, you must upload the entire work relationship object whenever you update any of its components.

ImportantNo mechanism exists in File-Based Loader for extracting compensation data from Oracle Fusion HCM andreturning it to the source environment. However, you can use HCM Extracts to extract compensation data if youplan to use Oracle Fusion Workforce Compensation in a coexistence scenario.



14

For more information about full implementation of Oracle Fusion HCM, see:

• Oracle Fusion Applications Workforce Deployment Implementation Guide

• Oracle Fusion Applications Workforce Development Implementation Guide

• Oracle Fusion Applications Compensation Management Implementation Guide

For more information about coexistence implementation of Oracle Fusion HCM, see the Oracle Fusion ApplicationsCoexistence for HCM Implementation Guide.

Preparation: Critical ChoicesFor successful use of File-Based Loader, follow these recommendations:

• Understand your deployment model.

• Prepare the source data.

• Prepare data for upload.

• Manage the upload process.

Understanding Your Deployment ModelUnderstand whether you're implementing Oracle Fusion HCM fully or implementing a coexistence scenario. Devise a strategyfor ongoing data maintenance if your deployment model requires that data be updated through upload.

Preparing the Source DataIdentify the business objects that you're planning to upload to Oracle Fusion HCM and their source systems. Review andanalyze this source data, and verify that it's both accurate and current. If it isn't, then devise a plan to correct any problemsbefore you attempt to load it. In particular:

• For work relationships, ensure that you identify a manager for every worker and that the information is accurate.

• For jobs and positions, ensure that accurate job codes and titles exist in the legacy system.

• For job history, establish the accuracy of any historical data. Understand whether all historical data must beuploaded or just key events, such as hire, promotion, and termination.

NoteCleaning up the legacy data minimizes the problems that can occur when you upload the data to Oracle FusionHCM.

Preparing Data for UploadBefore uploading data to Oracle Fusion HCM:

• Set the configuration parameters for the Load Batch Data process.



15

• Understand the Oracle Fusion HCM implementation to which you're importing data. For example, identify the legalemployers, business units, and reference data sets.

• Know which Oracle Fusion lookups you need to set and identify required functional mappings, for example, forworker numbers, job definitions, and position definitions.

• Design your data transformations. For any business object that you plan to load, identify the structure of the targetOracle Fusion object.

Managing Data Upload: Points to ConsiderFor successfully managing data upload using the File-Based Loader, follow these recommendations.

Test LoadPerform a test load to the stage environment of a small amount of data for all object types that you need to load. Load data tothe production environment only when the test loads are successful and you've validated the data transformations.

Data ValidationValidate your data using the Data-File Validator utility. Using the Data-File Validator, you can perform most data-formattingvalidations before you load data to Oracle Fusion HCM.

For more information, see the document Data File Validation for File Based Loader on My Oracle Support.

Business Object Load and MappingLoad objects in the prescribed order to avoid data-dependency errors. For initial loads, you're recommended to loadeach object type separately so that any problems can be more easily diagnosed and fixed. If errors occur, fix them beforeattempting to load the next object.Map each business unit to a default set immediately after load. The default set, also known as the Reference Data Set,corresponds to the Reference Data Set Code value on the Manage Business Unit Set Assignments page.

ImportantDon't combine your use of HCM File-Based Loader with HCM Spreadsheet Data Loader for the same data in asingle environment. File-Based Loader keeps track of the data it loads to determine whether data is to be createdor updated. If you load data either interactively or using HCM Spreadsheet Data Loader, File-Based Loader will beunaware of those changes. This may cause errors.

Data DeletionYou may need to delete data loaded to the stage environment. Deletion scripts are preinstalled in your stage environment. Beaware that these scripts delete all data rather than just the rows in error.

Security Considerations: ExplainedYou must have the required duty roles to load data.

To load data from the Oracle WebCenter Content server, you must have the duty role File Import and Export ManagementDuty. By default, these job roles inherit the File Import and Export Management Duty role:

• Human Capital Management Application Administrator



16

• Human Capital Management Integration Specialist

To load data from the Load Batch Data stage tables to the Oracle Fusion application tables, you must have the HCM BatchData Loading Duty role. By default, these job roles inherit the HCM Batch Data Loading Duty role:

• Application Implementation Consultant



Chapter 3HCM File-Based Loader Preparation

17

3 HCM File-Based Loader Preparation

Configuration ParametersThe Load Batch Data process in Oracle Fusion HCM loads data from the stage tables to the Oracle Fusion application tables.The configuration parameters determine how this process operates in your environment.

Use the Manage HCM Configuration for Coexistence task in the Setup and Maintenance work area to set the configurationparameters.

Configuration ParametersThe following table shows the configuration parameters and their default values. Several of these parameters aren't directlyrelevant to File-Based Loader, and in most cases you can use the default value shown here. No value is shown in the table forparameters that are blank by default. You can leave these parameters blank.

ImportantYou must set Loader Number of Processes to 4 or 8. When you run the Load Batch Data process for individualbatches, you can override the values of the Loader Chunk Size, Loader Maximum Errors, and LoaderNumber of Processes parameters. However, that may not be necessary. Typically, you set these configurationparameters once only.

Parameter Name Parameter Value

Allow Talent Data Increment Load

N

Enable Keyword Crawler

N

Environment Properties File

/ u01/ APPLTOP/ instance/ ess/ config/environmentproperties

HRC Product Top

/ u01/ APPLTOP/ fusionapps/ applications/ hcm/hrc

Load HCM Data Files Automatically

N

Loader Cache Clear Limit

99

Loader Chunk Size

200

Loader Maximum Errors

100

Loader Number of Processes 1



18

Parameter Name Parameter Value

Loader Save Size

1

ODI Context

DEVELOPMENT

ODI Log Level

ODI Language

AMERICAN_ AMERICA. WE8ISO8859P1

ODI Password

ODI Root Directory

/ u01/ APPLTOP/ instance/ odi/ file-root/ODIFILEROOT_HCM

ODI User

FUSION_ APPS_ HCM_ ODI_ SUPERVISOR_ APPID

ODI Work Repository

FUSIONAPPS_ WREP

On Demand FTP Root Directory

Use Python Loader

N

User Name Expression


This parameter is replaced by the AutoLoad parameter on the LoaderIntegrationService web service. If you're using SFTPrather than WebCenter Content, then you use the AutoLoad parameter on the InboundLoaderProcess web service to controlautomatic loading. You do not need to change the default value of this parameter.


The number of top-level business objects to be processed by Load Batch Data before the cache is cleared.

Loader Chunk Size

The number of top-level business objects a single Load Batch Data thread processes in a single action. Set the chunk sizebased on the total number of objects to be loaded and the Loader Number of Processes value.

Loader Maximum Errors



19

The maximum number of errors that can occur on a Load Batch Data thread before processing terminates. If an error occursduring the processing of a complex business object (such as a person record), then all rows for that business object are rolledback and marked as Error in Row. If you leave this parameter set to 100, then the load process stops after 100 errors occur.

Loader Number of Processes

The number of Load Batch Data threads to run in parallel. This value is 1 by default. You're recommended to set this valueto 4 or 8. If you leave this parameter set to 1, then the Load Batch Data process does not run multithreaded. For large datavolumes, the performance impact can be severe.

Loader Save Size

The number of top-level business objects to be processed before the objects are committed to the application tables.

ODI Language

Determines the character set used for data loading. Don't change the default value of this parameter.

ODI Root Directory

Used for staging .dat files. Don't change the default value of this parameter.

Use Python Loader

This parameter is replaced by the LoadType parameter on the LoaderIntegrationService web service. If you're using SFTPrather than WebCenter Content, then you use the LoadType parameter on the InboundLoaderProcess web service to selectthe load type. You don't need to change the default value of this parameter.


Determines how user names are constructed when you import person records. To use the enterprise default format, leavethis parameter value blank. If you prefer, you can specify that either person numbers or assignment numbers be used as usernames by setting User Name Expression to one of the following expressions:

• loaderCtx.getPersonAttr('PersonNumber')• loaderCtx.getAssignmentAttr('AssignmentNumber')

Defining Oracle Fusion Business Objects: ExplainedBusiness objects that originate in your source system may reference other business objects that originate in Oracle FusionHCM. For these referenced business objects, you must generate cross-reference information and include this information inyour source system.

The following table shows the Oracle Fusion business objects for which you may need cross-reference information, and theOracle Fusion task that you perform to define each business object. If you want to reference any of these business objects,you must perform the relevant Oracle Fusion task before generating the mapping file for the cross-reference information.

Business Object Oracle Fusion Task

Employment Action Reason

Manage Actions, Manage Action Reasons

Person Assignment Status Type

Manage Assignment Status



20

Business Object Oracle Fusion Task

Enterprise

Manage Enterprise HCM Information


Manage Profile Content Items

Talent Profile Content Type

Manage Profile Content Types

Talent Profile Type

Manage Profile Types

Talent Instance Qualifier Set

Manage Instance Qualifiers

Legal Entity

Manage Legal Entity

Legislative Data Group

Manage Legislative Data Groups

Payroll Element Type

Manage Elements

Payroll Element Input Value

Manage Elements

Person Type

Manage Person Types

Application Reference Data Set

Manage Reference Data Sets

ImportantWhen you load person records in bulk, the application:

• Creates user account requests by default and sends them to Oracle Identity Management (OIM) when you runthe Send Pending LDAP Requests process.

• Provisions roles to users, as specified by current role mappings.

Use the Manage Enterprise HCM Information task in the target environment to review current User and RoleProvisioning settings and update them as necessary.



21

Generating the Mapping File: ExplainedYou generate the mapping file of cross-reference information for any referenced business objects that you defined. The cross-reference information comprises Globally Unique Identifier (GUID) values for those business objects.

Mapping File GenerationTo generate the mapping file:

1. Open the Manage HCM Configuration for Coexistence page from the Setup and Maintenance work area.

2. Submit the Generate Mapping File for HCM Business Objects process for the business objects.

3. Note the process ID and click Search to refresh the results in the Generate Mapping File for HCM Business Objectssection.

You may need to click Search more than once until the process completes. Status 12 indicates that the processcompleted successfully.

For processes that complete with errors (status 10):

1. Navigate to the Scheduled Processes work area ( Navigator - Tools - Scheduled Processes ).

2. Search for the Process ID and view the associated log file.

NoteIf the process doesn't complete in a reasonable time, search for the Process ID in the Scheduled Processes workarea and note the Scheduled Time for your process. This time is set automatically to an occurrence after thesubmission time.

Important

• Whenever you make changes to any of the Oracle Fusion business objects, you must regenerate the mappingfile. For example, if you define additional person types, then you must regenerate the GUIDs for the Oracle Fusioninstance.

• The GUIDs associated with an Oracle Fusion instance don't change. However, GUIDs vary among instances.Therefore, the GUIDs that you generate from the stage environment are different from those that you generatefrom the production environment. You must generate them in both environments.

The following table describes the process status values.

Status Number Status Name Status Description

1

WAIT

The job request is awaitingdispatch.



22

Status Number Status Name Status Description

2

READY

The job request has beendispatched and is awaitingprocessing.

3

RUNNING

The job request is beingprocessed.

4

COMPLETED

The job request has completed andpostprocessing has started.

7

CANCELLING

The job request has been canceledand is awaiting acknowledgement.

9

CANCELLED

The job request was cancelled.

10

ERROR

The job request has run andresulted in an error.

11

WARNING

The job request has run andresulted in a warning.

12

SUCCEEDED

The job request has run andcompleted successfully.

13

PAUSED

The job request has paused forsub-request completion.

17

FINISHED

The job request and all child jobrequests have finished.

Mapping File DownloadThe Generate Mapping File for HCM Business Objects process creates one or more data files (.dat files) for each businessobject. The application packs .dat files automatically in a zipped data file that's written to the Oracle WebCenter Contentserver.

To download the mapping file:

1. Open the File Import and Export page ( Navigator - Tools - File Import and Export ).

2. Set the Account value in the Search section to hcm/dataloader/export and click Search.

The zip file of reference information appears in the search results.



23

3. Click the file name in the search results.4. When prompted, save the file locally.

The following table describes the individual .dat files in the zip file for the business objects that you defined.

Business Object Data File Name


XR_ACTION.dat XR_ ACTION_ REASON.dat XR_ ACTION_ REASON_ USAGE.dat XR_ ACTION_ TYPE.dat


XR_ ASSIGNMENT_ STATUS_ TYPE.dat

Enterprise

XR_ ENTERPRISE. dat


XR_ HRT_ CONTENT_ ITEM_ LANGUAGE.dat


XR_ HRT_ CONTENT_ TYPE.dat XR_ HRT_ CONTENT_ TYPE_ RELAT.dat

Talent Profile Type

XR_ HRT_ PROFILE_ TYPE.dat


XR_ HRT_ QUALIFIER.dat XR_ HRT_ QUALIFIER_ SET.dat XR_ HRT_ RELATION_ CONFIG.dat

Legal Entity

XR_ LEGAL_ ENTITY.dat


XR_ LEGISLATIVE_ DATA_ GROUP.dat


XR_ PAY_ ELEMENT_ TYPE_STD.dat XR_ PAY_ ELEMENT_ TYPE_ SUPPL.dat


XR_ PAY_ INPUT_ VALUE_STD.dat XR_ PAY_ INPUT_ VALUE_ SUPPL.dat



24

Business Object Data File Name

Person Type

XR_ PERSON_ TYPE.dat


XR_ SETID_SET.dat

Importing Cross-Reference Information: ExplainedYou must use the Globally Unique Identifier (GUID) values from the cross-reference information that you generated, to ensurethat foreign-key references in your source data to the existing Oracle Fusion objects are correct.

You must devise a way of generating the correct values in the business objects that you plan to extract and upload to OracleFusion. For example, you could store the mapping data in a temporary storage table and join this table to the table in theextract process.

The following example shows GUIDs from an XR_ASSIGNMENT_STATUS_TYPE.dat file.

The following table describes the values in the R_ASSIGNMENT_STATUS_TYPE.dat file:

Parameter Description

FusionGUID

A unique, 32-character alphanumeric identifier used byboth Oracle Fusion HCM and source applications suchas Oracle PeopleSoft and Oracle EBS.

FusionKey

The value that is used by Oracle Fusion HCM.

PeopleSoftKey

The value that is used by the source system (OraclePeopleSoft or any other system).

Description

Description of the value identified by the keys.

Description2

Description of the value identified by the keys.



25

GUID Values: How They Are ProcessedThe Load Batch Data task processes Globally Unique Identifier (GUID) values for records sourced externally or in OracleFusion HCM.

Key MappingThe Load Batch Data process identifies records loaded from an external source to Oracle Fusion HCM in both the source andtarget environments, and maintains a mapping between the source and target keys. Each record has a unique identifier.

Keys identify:

• The row being created or updated• The parent of the row being created or updated• Any objects referenced by the row being created or updated

Records Sourced ExternallyEach record sourced externally includes a pointer to the external record, which is the record's GUID. Oracle Fusion HCMmaintains a Key Mapping table (HRC_LOADER_BATCH_KEY_MAP) that records, for each business object, its type, sourceGUID, and Oracle Fusion ID (the ID by which it's identified in Oracle Fusion).

The following is an example of a Key Mapping table:

Object Type Source GUID Oracle Fusion ID

Person

PERS123

006854

Person

PERS456

059832

When the Load Batch Data process imports a record to the Load Batch Data stage tables, it compares the record's sourceGUID and object-type values with values in the Key Mapping table:

• If the values exist in the Key Mapping table, then the process replaces the source GUID in the stage tables with theOracle Fusion ID.

• If the values don't exist in the Key Mapping table, then the process generates an Oracle Fusion ID for the record,recorded in the Key Mapping table, and uses it to replace the source GUID in the stage tables.

By the time the data in the stage tables is ready for loading to the Oracle Fusion application tables, the process allocates allOracle Fusion IDs. The Oracle Fusion object services can process predefined Oracle Fusion IDs when creating new records.

For each reference object that originates in Oracle Fusion HCM, the Generate Mapping File for HCM Business Objectsprocess generates:

• A source GUID and creates a row in the Key Mapping table that holds both the newly-generated GUID and theexisting Oracle Fusion ID for the object.

• A zip file of data files containing the GUIDs for the reference objects, which you import into your source environment.

When you import source data that references these objects to the Load Batch Data stage tables, you must include thereference-object GUIDs so that the correct reference objects can be identified.



26

Key-Mapping ExampleYour source data includes the following records and business objects:

Object Type Source GUID Name Description Foreign Key toRecord

REC

ABC

Rec1

Record Number 1

REC

DEF

Rec2

Record Number 2

OBJ

TUV

Obj1

Object Number 1

ABC

OBJ

XYZ

Obj2

Object Number 2

DEF

The following table shows the key mapping:

Object Type Source GUID Oracle Fusion ID

REC

ABC

1

REC

DEF

2

OBJ

TUV

3

OBJ

XYZ

4

The following table shows the stage-table entries:

Oracle Fusion ID Name Description Foreign Key to Record

1

Rec1

Record Number 1

2

Rec2

Record Number 2

3

Obj1

Object Number 1

1



27

Oracle Fusion ID Name Description Foreign Key to Record

4

Obj2

Object Number 2

2

Supported Data Operations: ExplainedThis topic explains the data operations that are supported for data files uploaded using Oracle Fusion HCM File-BasedLoader. Use the Load Batch Data process in the Data Exchange work area or the LoaderIntegrationService web service toupload data.

Data Update After Initial Import and LoadYou upload changed information to Oracle Fusion in a zip file of data files (.dat files). If the zip file contains changes formultiple business objects, then the application processes the changes in multiple batches, one per business object.

Partial Object Hierarchy UploadMany Oracle Fusion HCM business objects comprise a hierarchy of related entities. When you update most of the complexbusiness objects, you need not upload the complete object. For example, a person object comprises not just the personentity but also person addresses, phones, names, ethnicity, and so on. If a person's address changes, then you can uploadjust the new address.

ImportantYou must upload all entities of the work relationship when updating. This requirement exists because of thecomplexity of the work relationship object, which comprises multiple dependent entities. Partial updates are likelyto cause inconsistencies among dependent entities. If inconsistencies occur, then the entire work relationshipobject may have to be deleted and reloaded.

For date-effective objects you can upload a partial history. You need not upload the complete history of the object.

NoteWhen creating or updating business objects, you can:

• Omit optional columns.

• Specify columns in any order.

NULL Attribute ValuesWhen creating a business object, you can omit optional attributes or leave them blank. File-Based Loader sets such attributesin new objects to NULL.

When updating a business object, any optional attribute that you omit or leave blank is excluded from the update and remainsunchanged in Oracle Fusion. However, you can set non-NULL attributes to NULL by specifying a NULL directive value, asfollows:

• If the attribute is a VARCHAR2 or NUMBER value, then you set it to #NULL.• If the attribute is a DATE value, then you set it to 31-Dec-0001 (or date-format equivalent).



28

File-Based Loader sets #NULL and 31-Dec-0001 values to NULL.

ImportantYou can't leave required attributes blank when you're creating or updating a business object. If you leave asurrogate key, parent key, or date-effective attribute blank in a business object, an error occurs.

Flexfield Data LoadYou can load data for the following descriptive flexfields:

Business Object Data File Flexfield

Department

F_ DEPARTMENT_ VO.dat

PER_ ORGANIZATIONS_ DF

Grade

F_GRADE_VO.dat

PER_GRADES_DF

Job

F_JOB_VO.dat

PER_JOBS_DFF

Location

F_ LOCATION_ VO.dat

PER_ LOCATIONS_DF

Person

F_ PERSON_ ETHNICITY_ VO.dat F_ PERSON_VO.dat

PER_ ETHNICITIES_ DFF PER_ PERSONS_DFF

Person Documentation

F_ PERSON_ CITIZENSHIP_VO.dat

PER_ CITIZENSHIPS_ DFF

Work Relationship

F_ ASSIGNMENT_ VO.dat

PER_ASG_DF

To load data for other flexfields:

• Configure and deploy your flexfields using the Manage Flexfields task.• Enter your flexfield data in a supplied data (.dat) file and save it in .csv format.• Open a service request to have the flexfield data loaded from the .csv file to your environment.

Example .dat files and other FBL sample files are provided in the document Oracle Fusion Human Capital Management File-Based Loader for Release 7 and Release 8 (Doc ID 1595283.1) on My Oracle Support.

Updating Logical Start and End Dates for Date-Effective Business Objects: ExplainedYou can specify a new start or end date for a logical row in a date-effective business object without having to load the entirehistory of the object.



29

For date-effective objects, two additional columns exist in the relevant data (.dat) file:

• LSD (Logical Start Date)• LED (Logical End Date)

Setting either of these columns to Y indicates to Oracle Fusion HCM that you've specified a new logical start date (LSD) orlogical end date (LED) for the row. The application ignores values other than Y in the LSD and LED columns.

In the following example, the logical row for the Sales Director job comprises three physical records:

Record Job Job Code Effective StartDate

Effective EndDate

1

Sales Director

SDR.450

01 January 2010

12 March 2011

2

Sales Director

SDR.450

13 March 2011

04 April 2012

3

Sales Director

SDR.450

05 April 2012

31 December2012

To set the logical end date of the logical row to 31 December 2012:

• Specify any required values and the new effective end date value of 31 December 2012.• Set the LED column to Y.

ImportantYou can't specify a logical end date for a primary object, such as a person's primary assignment or mailingaddress. You must make the object non-primary before attempting to specify a logical end date.

Preparing Source Data for Delivery to Oracle FusionHCM: ExplainedThis topic explains the following aspects of the delivery of your source data to Oracle Fusion HCM:

• Mapping of source data and cross-reference data• Extraction of source data• Structure of the zip file that you deliver to Oracle Fusion HCM• Batch names of the business objects• General format of data files in the zip file

Data MappingYou define mappings between your source data and the cross-reference data imported to the source environment beforeextracting your data. The mapping is dependent on the type of Oracle Fusion HCM implementation.

Source Data ExtractionAfter successfully mapping your source data, you extract the data and package it for delivery to Oracle Fusion HCM.



30

To perform the extract, you can use tools that are native to the source system, such as PL/SQL in Oracle E-Business Suite(EBS) or SQR in Oracle PeopleSoft. Alternatively, you can use an Extract, Transform, and Load (ETL) tool, such as OracleData Integrator (ODI) or PowerCenter Informatica.

Structure of the Zip FileYou deliver the data that you extract from your source system for upload to Oracle Fusion, as a set of data files (.dat files) in azip file. You group these data files by object type.

For example, jobs comprise job and job grade data, and departments comprise department and department details data. Ifyou load both in the same zip file, then the file structure will be as shown in the following table:

Object Folder Data-File Name

Department

F_ DEPARTMENT_ DETAIL_VO.dat F_ DEPARTMENT_ VO.dat

Job

F_ JOB_ GRADE_VO.dat F_JOB_VO.dat

No parent folder exists in the zip file.

The application processes each business object in the zip file as a separate batch. For example, if the zip file contains bothDepartment and Job business objects, then the application processes the zip-file contents as two separate batches, one forDepartments and one for Jobs.

The following table shows the directory names that you use to group data files by object type, and the data-file names thatyou must use.

Object Directory Name Data-File Name

Action

F_ ACTIONS_VO.dat F_ ACTION_ REASON_ USAGES_VO.dat

ActionReason

F_ ACTION_ REASONS_ VO.dat

BusinessUnit

F_ BUSINESS_ UNIT_VO.dat

ContentItem

F_ CONTENT_ ITEM_ RATING_ DESCRIPTION_ VO.dat F_ CONTENT_ ITEM_VO.dat

ContentItemRelationship

F_ CONTENT_ ITEM_ RELATIONSHIP_ VO.dat

Department F_ DEPARTMENT_ DETAIL_VO.dat



31


F_ DEPARTMENT_ VO.dat

DepartmentTreeNode

F_ PER_ DEPT_ TREE_NODE.dat

ElementEntry

F_ ELEMENT_ ENTRY_ VALUE_VO.dat F_ ELEMENT_ ENTRY_VO.dat

Establishment

F_ ESTABLISHMENT_ VO.dat

Grade

F_GRADE_VO.dat

GradeRate

F_ GRADE_ RATE_ VALUE_VO.dat F_ GRADE_ RATE_VO.dat

Job

F_ JOB_ GRADE_VO.dat F_JOB_VO.dat

JobFamily

F_ JOB_ FAMILY_VO.dat

Location

F_ LOCATION_ VO.dat

Person

F_ PERSON_ ADDRESS_ VO.dat F_ PERSON_ EMAIL_VO.dat F_ PERSON_ ETHNICITY_ VO.dat F_ PERSON_ LEGISLATIVE_ DATA_VO.dat F_ PERSON_ NAME_VO.dat F_ PERSON_ NATIONAL_ IDENTIFIER_ VO.dat F_ PERSON_ PHONE_VO.dat F_ PERSON_ RELIGION_ VO.dat F_ PERSON_ TYPE_ USAGE_VO.dat F_ PERSON_VO.dat



32


PersonAbsenceEntry

F_ PERSON_ ABSENCE_ ENTRY_VO.dat

PersonAccrualDetail

F_ PERSON_ ACCRUAL_ DTL_VO.dat

PersonContact

F_ PERSON_ CONTACT_ VO.dat

PersonDocumentation

F_ PERSON_ CITIZENSHIP_ VO.dat F_ PERSON_ DOCUMENTATION_ VO.dat F_ PERSON_ VISA_VO.dat F_ PERSON_ PASSPORT_ VO.dat

PersonEntitlementDetail

F_ PERSON_ PLAN_ ENTRY_ DTL_VO.dat

PersonMaternityAbsenceEntry

F_ PERSON_ MAT_ ABS_ ENTRY_VO.dat

Position

F_ POSITION_ GRADE_VO.dat F_ POSITION_ VO.dat

Profile

F_ PROFILE_ ITEM_VO.dat F_ PROFILE_ RELATION_ VO.dat F_ PROFILE_ VO.dat

RatingModel

F_ RATING_ LEVEL_VO.dat F_ RATING_ MODEL_VO.dat

Salary

F_ SALARY_ COMPONENT_ VO.dat F_ SALARY_VO.dat

SalaryBasis

F_ SALARY_ BASIS_VO.dat

Tree

F_FND_TREE.dat



33


TreeVersion

F_ FND_ TREE_ VERSION.dat

WorkRelationship

F_ ASSIGNMENT_ SUPERVISOR_ VO.dat F_ ASSIGNMENT_ VO.dat F_ ASSIGNMENT_ WORK_ MEASURE_ VO.dat F_ WORK_ RELATIONSHIP_ VO.dat F_ WORK_ TERMS_VO.dat F_ CONTRACT_ VO.dat

Batch NamesEach business object is processed as a separate batch. The batch name is formed automatically by prefixing the objectdirectory name (for example, SalaryBasis or GradeRate) with the internal loader batch ID. For example:

123456789:Person

987654321:WorkRelationship

• If you import and load data manually, then you can specify a meaningful batch name when you schedule the importor load process.

• If you import and load data automatically, then the batch names that are generated automatically are used.

Data-File FormatEach data file has a predefined format. You construct the heading row in the data file for each business object type byconcatenating the Datastore Attribute Names with pipe separators.

• Heading rows must be in capital letters and spelled correctly.• Data lines follow this heading row, with data items also being separated by the pipe character.• Columns can appear in any order.

NoteThe pipe character (|) isn't supported in data values.

Example .dat files and other FBL sample files are provided in the document Oracle Fusion Human Capital Management File-Based Loader for Release 7 and Release 8 (Doc ID 1595283.1) on My Oracle Support.

Delivering Data to Oracle WebCenter Content:ExplainedYou can use the following methods to deliver your data to the WebCenter Content server:

• Oracle Fusion HCM File Import and Export interface



34

• WebCenter Content Document Transfer Utility• Remote Intradoc Client (RIDC)

Delivering Data Using Oracle Fusion HCM File Import and ExportInterfaceTo deliver files individually to the WebCenter Content server:

1. Open the File Import and Export page Navigator - Tools - File Import and Export .2. Click the Upload icon in the Search Results section.3. In the Upload File dialog box, browse for your zip file of data, and set the Account value to hcm/dataloader/

import.4. Click Save and Close.

The zip file is uploaded to the hcm/dataloader/import account and appears automatically in the Search Resultssection of the File Import and Export page.

WebCenter Content automatically allocates a content ID to uploaded files. To see the content ID for a file, select View -Columns - Content ID in the Search Results section of the File Import and Export page. The search results now include theContent ID column.

Delivering Data Using WebCenter Content Document Transfer UtilityThe WebCenter Content Document Transfer Utility for Oracle Fusion Applications is a feature-set Java library that providescontent export and import capabilities.

You can evaluate the utility from the Individual Component Downloads section of the Oracle WebCenter Content 11g R1Downloads tab on Oracle Technology Network (OTN). Existing customers can download the utility from Oracle SoftwareDelivery Cloud.

1. Open the Individual Component Downloads section on the Downloads tab.2. Accept the license agreement and download the WebCenter Content Document Transfer Utility.3. Extract the JAR file once the component zip file download completes.

Review the readme file downloaded with the WebCenter Content Document Transfer Utility for a list of all parameters,including advanced networking options for resolving proxy issues.

Delivering Data Using Remote Intradoc Client (RIDC)RIDC is the recommended approach if you want to use native Java APIs. The RIDC communication API removes dataabstractions to Oracle Content Server while still providing a wrapper to handle connection pooling, security, and protocolspecifics.

RIDC supports the following three protocols:

Protocol Description

Intradoc

Communicates with Oracle Content Server over theIntradoc socket port (typically, 4444). This protocoldoesn't perform password validation and so requiresa trusted connection between the client and OracleContent Server. Clients that use this protocol areexpected to perform any required authentication.Intradoc communication can also be configured to runover SSL.



35

Protocol Description

HTTP

RIDC communicates with the web server for OracleContent Server using the Apache HttpClient package.Unlike Intradoc, this protocol requires authenticationcredentials for each request.

JAX-WS

Supported only in Oracle WebCenter Content 11g withOracle Content Server running in Oracle WebLogicServer. To provide JAX-WS support, several additionalJAR files are required.

For more information about the Document Transfer Utility and RIDC, see the document Oracle Fusion Human CapitalManagement File-Based Loader for Release 7 and Release 8 (Doc ID 1595283.1) on My Oracle Support.


Chapter 4HCM File-Based Loader Example Data Files

36

4 HCM File-Based Loader Example Data Files

Creating Data Files: Points to ConsiderYou prepare data for upload by HCM File-Based Loader in a set of data files (.dat files), grouped by object type. Youcompress the data file sets and deliver them as a single file for upload.

Each data file has a predefined format. This topic describes the general data-file format and includes an example file.

Header RowsHeader rows in the data files:

• Comprise the Datastore Attribute Names for the object, separated by pipe (|) characters• Must be in uppercase characters and spelled correctly• Can have columns in any order, and optional columns can be omitted

Data RowsData rows in the data files:

• Comprise object attribute values separated by pipe (|) characters• Must contain at least one row• Must follow the header row in a new line• Must follow the order of the header row• Can omit optional attribute values

Example Data FileThe following example shows the F_WORK_RELATIONSHIP_VO.dat file with one data row. The object columns appear in anonstandard order. Optional attributes such as DATE_START, REHIRE_REASON, and WORKER_NUMBER are omitted fromthe data line.

PERIOD_OF_SERVICE_ID|PERIOD_TYPE|PERSON_ID|ACCEPTED_TERMINATION_DATE|ACTION_OCCURRENCE_ID|ACTUAL_TERMINATION_DATE|ADJUSTED_SVC_DATE|BUSINESS_GROUP_ID|DATE_EMPLOYEE_DATA_VERIFIED|DATE_START|FAST_PATH_EMPLOYEE|LAST_WORKING_DATE|LEGAL_ENTITY_ID|LEGISLATION_CODE|NOTIFIED_TERMINATION_DATE|ON_MILITARY_SERVICE|ORIGINAL_DATE_OF_HIRE|PRIMARY_FLAG|PROJECTED_TERMINATION_DATE|REHIRE_AUTHORIZOR|REHIRE_REASON|REHIRE_RECOMMENDATION|TERMINATION_ACCEPTED_PERSON_ID|WORKER_NUMBER|COMMENTS|REHIRE_AUTHORIZER_PERSON_ID|FT_ALTERNATE_REC|FT_ALTERNATE_KEYTestWRPOS4222|E|TestPerWR4222||0|||0||2004-01-03|Y||C257EBABE0775312E0436F45F00AC5E1|US||N|2004-01-03|Y||||Y|||||JOB|HXPSFT018::0::2004-01-03::0

Changing the Logical Start Date of a Business Object:ExampleYou can change the logical start date of a business object and its related objects in the hierarchy.

In this example, you've changed the hire date of an existing worker from 2004-01-03 to 2005-01-03 by updating the workrelationship object (F_WORK_RELATIONSHIP_VO.dat). You now update the F_ASSIGNMENT_SUPERVISOR_VO.dat objectto change the hire date.



37

You must also change the hire date in all the following objects in the work relationship hierarchy:

• F_ASSIGNMENT_VO.dat

• F_WORK_TERMS_VO.dat

• F_ASSIGNMENT_WORK_MEASURE_VO.dat

All the four objects are effective-dated. Therefore, you include the LSD attribute in these objects to indicate a change to thelogical start date of the object.

Changing the Effective Start DateThe following example shows the change in the effective start date for the assignment supervisor object.

You make the same change in other effective-dated objects in the work relationship object hierarchy. You set theLSD attribute to Y to indicate a change in the logical start date. The new hire date (2005-01-03) appears in theEFFECTIVE_START_DATE column.

• Set the LSD attribute to Y to indicate a change in the logical start date.

• Set the EFFECTIVE_START_DATE attribute to 2005-01-03 to indicate the the new hire date.

LSD|ACTION_OCCURRENCE_ID|ASSIGNMENT_ID|ASSIGNMENT_SUPERVISOR_ID|BUSINESS_GROUP_ID|EFFECTIVE_END_DATE|EFFECTIVE_START_DATE|MANAGER_ASSIGNMENT_ID|MANAGER_ID|MANAGER_TYPE|PERSON_ID|PRIMARY_FLAGY||TestWRAS4076|testmanager4076||4712-12-31|2005-01-03|B05823515344EDDAE040F40A46006C6D|B0582351513EEDDAE040F40A46006C6D|LINE_MANAGER|TestPerWR4076|N

Changing the Logical End Date of a Business Object:ExampleYou can change the logical end date of a business object and its related objects in the hierarchy.

In this example, you've created a person record and are now updating one of the person's addresses to specify a new logicalend date. You don't need to upload the entire person object again to update the address. You can upload the updatedaddress object only.

This example shows how to update a partial object hierarchy and how to specify a new logical end date for an object.

Updating the Person AddressIn this example, you change the effective end date of the person's mail address from 4712-12-31 to 2010-12-31. The LEDvalue of Y at the start of the data line indicates that this record includes a new logical end date for the object.

The EFFECTIVE_END_DATE column includes the new logical end date for the address, 2010-12-31.

LED|PERSON_ADDR_USAGE_ID|EFFECTIVE_START_DATE|EFFECTIVE_END_DATE|PERSON_ID|BUSINESS_GROUP_ID|BUSINESS_GROUP_ID1|ADDRESS_TYPE|ADDRESS_LINE_1|ADDRESS_LINE_2|ADDRESS_LINE_3|ADDRESS_LINE_4|BUILDING|FLOOR_NUMBER|TOWN_OR_CITY|REGION_1|REGION_2|REGION_3|COUNTRY|POSTAL_CODE|LONG_POSTAL_CODE|TIMEZONE_CODE|DERIVED_LOCALE|DQ_VALIDATION_LEVEL|FORMATTED_SINGLE_LINE_ADDRESS|FORMATTED_MULTI_LINE_ADDRESS|MAILING_ADDRESS_FLAGY|2671MailAdd|2005-01-01|2010-12-31|TestPerWR4671|0|0|MAIL|101 St.||||||Sanramon|Sanramon|CA||US|94583||||0|||N



38

Setting Attribute Values to NULL: ExamplesYou can remove attribute values in the data files by setting them to null. You can specify a NULL directive value as follows:

• If the attribute is a VARCHAR2 or NUMBER value, then you set it to #NULL.

• If the attribute is a DATE value, then you set it to 31-Dec-0001 (or date-format equivalent).

The following examples show two scenarios:

1. Setting the effective start date of a location to null: In this case, you set a DATE value to null.

2. Setting the annualization value of a grade rate to null: In this case, you set a NUMBER value to null.

Setting the Effective Start Date of a Location to NullIn this example, the EFFECTIVE_START_DATE attribute of a location is removed by setting it to 0001-12-31.

LOCATION_ID|EFFECTIVE_START_DATE|EFFECTIVE_END_DATE|SET_ID|BUSINESS_GROUP_ID|LOCATION_IMAGE_URL|ADDRESS_USAGE_TYPE|ACTIVE_STATUS|TELEPHONE_NUMBER_1|MAINPHONE_AREA_CODE1|MAINPHONE_COUNTRY_CODE1|MAINPHONE_EXTENSION1|MAINPHONE_SUBSCRIBER_NUM1|OFFICIAL_LANGUAGE_CODE|EMAIL_ADDRESS|SHIP_TO_SITE_FLAG|SHIP_TO_LOCATION_ID|RECEIVING_SITE_FLAG|BILL_TO_SITE_FLAG|OFFICE_SITE_FLAG|DESIGNATED_RECEIVER_ID|INVENTORY_ORGANIZATION_ID|GEO_HIERARCHY_NODE_ID|GEO_HIERARCHY_NODE_VALUE|INTERNAL_LOCATION_CODE|LOCATION_CODE1|LOCATION_NAME|DESCRIPTION|AC_LOCATION_CODE|ADDRESS_LINE_1|ADDRESS_LINE_2|ADDRESS_LINE_3|ADDRESS_LINE_4|BUILDING|COUNTRY|FLOOR_NUMBER|LONG_POSTAL_CODE|POSTAL_CODE|REGION_1|REGION_2|REGION_3|TIMEZONE_CODE|TOWN_OR_CITY|BUSINESS_GROUP_ID1lcid6|0001-12-31|4712-12-31|C257EBABE0315312E0436F45F00AC5E1||||A||||||US||Y||Y|Y|Y|||||HYU_AT|AT_HYU|AT_HYU|HYU Integration||20|Vallw Street||||US|||93919|USA|CA|||Pleasuw|

Setting the Annualization Factor of a Grade Rate to NullIn this example, the ANNUALIZATION_FACTOR attribute (a number) of a grade rate is removed by setting it to NULL.

RATE_ID|EFFECTIVE_END_DATE|EFFECTIVE_START_DATE|LEGISLATIVE_DATA_GROUP_ID|LEGISLATION_CODE|ACTION_OCCURRENCE_ID|RATE_TYPE|RATE_OBJECT_TYPE|NAME|CURRENCY_CODE|RATE_UOM|RATE_FREQUENCY|ANNUALIZATION_FACTOR|ACTIVE_STATUS|ATTRIBUTE_CATEGORYHydIDCGradeID-16|4712-12-31|2005-01-01|C257EBABE1F25312E0436F45F00AC5E1|US||SALARY|GRADE|HydIDCGradeName-16|USD|M|ANNUAL|#NULL|A|


Chapter 5HCM File-Based Loader Data Loading

39

5 HCM File-Based Loader Data Loading

Importing and Loading Data to Oracle Fusion HCM:ProcedureOnce you've placed the zip file containing your .dat files in the account hcm/dataloader/import on the Oracle WebCenterContent server, you can either import or import and load the data:

• From the Load HCM Data for Coexistence page

• Using the LoaderIntegrationService web service

Importing and Loading Data from the Load HCM Data for CoexistencePageTo import or import and load a zip file from the hcm/dataloader/import account on the Oracle WebCenter Content server:

1. Select Navigator - Workforce Management - Data Exchange to open the Data Exchange work area.

2. Select the task Load Data for Coexistence.

3. On the Load Data for Coexistence page, click Import.

4. In the Import and Load HCM Data dialog box, enter the content ID that you obtained when loading the file to theWebCenter Content server using the File Import and Export interface.

5. Select an individual business object or All to load all business objects from the zip file.

6. Provide a meaningful batch name. Object names are prefixed with the batch name to provide a unique batch namefor each batch.

7. If you set the Loader Run Type parameter to Import, then data is imported to the stage tables. You can reviewthe results of this process and correct any import errors before proceeding with the load to the application tables.When you first start to use File-Based Loader, this is the recommended approach.

If you set the Loader Run Type parameter to Import and Load Batch Data, then data is imported to the stagetables. All objects imported successfully to the stage tables are then loaded automatically to the application tables.You may prefer this approach when import errors are few and your data-loading is routine.

8. Click Submit.

Your data is imported to the stage tables and also loaded to the application tables, if appropriate.

Importing and Loading Data Using the Loader Integration Service WebServiceYou can import and load data using the Loader Integration web service.

The following table describes the Loader Integration Service parameters:



40

Parameter Description

ZipFileName

Content ID of the file on the WebCenter Content server(the same value as dDocName in the WebCenterContent Java call)

BusinessObjectList

Name of the business object to be loaded. Repeat thistag for each business object to be loaded.

BatchName

Name of the batch when it's created in Oracle Fusion.

LoadType

The type of load. Can be either FBL or HR2HR. UseFBL.

AutoLoad

Indicates whether to load the data into Oracle Fusion.

• N = Import only

• Y = Import and Load

Note This parameter in the service replacesthe setup parameter Load HCM DataFiles Automatically on the Manage HCMConfiguration for Coexistence page.

For more information about using the Loader Integration Service, see the document Oracle Fusion Human CapitalManagement File-Based Loader for Release 7 and Release 8 (Doc ID 1595283.1) on My Oracle Support.

Loading Person Records in BulkWhen you load person records in bulk, the application:

• Creates user account requests by default and sends them to Oracle Identity Management when you run the SendPending LDAP Requests process.

• Provisions roles to users, as specified by current role mappings.

Use the Manage Enterprise HCM Information task in the target environment to review current User and Role Provisioningsettings and update them as necessary.

Importing Data to Stage Tables and Fixing ImportErrors: ExplainedYou can either import or import and load data using the LoaderIntegrationService web service or the Load Data forCoexistence task.



41

Importing and Loading Data Using the LoaderIntegrationService WebServiceYou can find service invocation details for the LoaderIntegrationService web service in the public Oracle Enterprise Repository(OER) at http://fusionappsoer.oracle.com.

When using the LoaderIntegrationService web service:

• If you set the AutoLoad parameter to N, you load data to the application tables manually after import. You can fixany import errors before loading the data.

• If you set the AutoLoad parameter to Y, the application loads data automatically to the application tables for all thebusiness objects imported successfully. You can proceed to review the import log.

For more information about loading data using the LoaderIntegrationService web service, see the document Oracle FusionHuman Capital Management File-Based Loader for Release 7 and Release 8 (Doc ID 1595283.1) on My OracleSupport.

Importing Data to Stage Tables Using the Load Data for CoexistenceTaskWhen using the Load Data for Coexistence task:

• If you set the Loader Run Type parameter to Import, then the application imports data to the stage tables, and noattempt is made to load the data to the application tables. You run the load process separately. You can review theresults of this process and correct any import errors before proceeding with data load to the application tables. Thisis the recommended approach when you first use File-Based Loader.

• If you set the Loader Run Type parameter to Import and Load Batch Data, then the application imports data tothe stage tables and all objects imported successfully are loaded automatically to the application tables. You mayprefer this approach when import errors are few and your data-loading is routine.

To import your zip file:

1. Select the Load Data for Coexistence task from the Data Exchange work area.

2. On the Load Data for Coexistence page, click Import.

3. In the Import and Load HCM Data dialog box, enter the Content ID that you obtained when loading the file to theOracle WebCenter Content server.

4. Select an individual business object or All to load all business objects from the zip file.

5. Specify a batch name.

This value forms the prefix for each business object in your file. For example, if your file contains Job and Job Familyobjects and you specify the batch name MyData, then your batch names are MyData:Job and MyData:JobFamily.

6. Select Import or Import and Load Batch Data as the Loader Run Typevalue and click Submit.

Reviewing the Import Log and Fixing Import ErrorsTo see the results of the import process, click Refresh in the Search Results section on the Load Data for Coexistence page.



42

All import processes produce a log file.

• For successful imports, the log file summarizes the process of unzipping the file and creating the object batches.

• If errors occur during import to the stage tables, the log file summarizes the errors.

You can access the log file for a selected zip file in the Log column of the Search Results region. Click the Log icon todownload the log file to your desktop.

Errors identified in the log file relate to records that the Load HCM Data for Coexistence process couldn't import to the stagetables. Typically, the errors relate to:

• Missing primary or parent keys

• Incorrect or missing reference-data Globally Unique Identifiers (GUIDs)

• Invalid data formats

• Incorrect date-effective records

ImportantYou must correct these errors in the source data before attempting to import the records to the stage tablesagain.

Loading Data from Stage Tables to ApplicationTables: ProcedureYou can load data to the application tables manually or automatically using the Load Batch Data process. This topic explainsthe settings required to load data automatically and the procedure to load data manually.

Loading Data AutomaticallyThe Load Batch Data process runs automatically for batches imported successfully to the stage tables if you:

• Set the AutoLoad parameter to Y, when you run the Loader Integration Service.

• Specify the Run Type value as Import and Load when you import and load data using the Load Data forCoexistence task.

Loading Data ManuallyTo load data manually:

1. Access the Load Batch Data task from the Data Exchange work area or the Setup and Maintenance work area.

2. On the Load Batch Data page, click Schedule.

3. On the Schedule Request page, in the Batch Name field, select the name of the batch to load.

Each batch contains a single object type.

4. Retain the default values for the remaining parameters.



43

5. Click Submit.

ImportantFor the initial load, you must load objects in the predefined order to respect dependencies between businessobjects.

Monitoring Data Loads and Correcting Batch-LoadErrors: ExplainedYou can monitor the status of a data load, fix batch-load errors, and rerun the data load on the Load Batch Data page inOracle Fusion HCM.

Monitoring Data LoadsYou can monitor the status of a data load in the Batch Status column of the Search Results section on the Load Batch Datapage. The Details section of the page displays detailed information about a data load that you select.

You can see the load status of individual business objects from the Batch Summary and Failed tabs in the Details section ofthe Load Batch Data page.

Correcting Data ErrorsYou can see the details of any errors on the Failed tab in the Details section for a batch data load and correct them asfollows:

• Resolve the errors and complete the data load:

a. Click the number in the Total Objects column to navigate to the Details page for the object.

b. Review the attributes of a selected object and correct any errors in the stage tables.

c. Set the object status to Ready to Process.

• Change the status of objects with errors to Ignore to prevent them from being processed when you next run thedata load.

• Remove objects in error from the original batch:

a. Select the objects that you want to remove.

b. Click Create Batch.

The application removes the selected objects from the original batch and adds them to a new batch, so thatyou can fix the errors later.

Rerunning Data LoadsAfter correcting any errors, select the batch file in the Search Results section and click Run. The application:

• Resets the objects with the status Error in Row to Ready to Process and includes them in the load.



44

• Doesn't process objects with the status Successful or Ignore.

Related Topics

• Data-Load Batch-Status Values: Explained

• Data-Load Object-Status Values: Explained


Chapter 6HCM File-Based Loader Post-Load Processes

45

6 HCM File-Based Loader Post-Load Processes

Running Post-Load Processes: ExplainedAfter an initial or incremental load of person records, you run a set of processes to complete data setup in the Oracle FusionHCM environment. You run these processes in the following order from the Scheduled Processes work area:

1. Synchronize Person Records

2. Update Person Search Keywords

3. Refresh Manager Hierarchy

4. Send Pending LDAP Requests

The following table describes these processes in detail:

Process Description

Synchronize Person Records

Communicates changes to person and assignmentrecords that have occurred since the last data load toconsuming applications, such as Oracle Fusion TradingCommunity Model and Oracle Identity Management.

Update Person Search Keywords

Copies attributes of person, employment, and profilerecords that are used as search keywords to thePER_KEYWORDS table, where they're indexed toimprove search performance. The process updates theentire PER_KEYWORDS table.

Refresh Manager Hierarchy

Populates the denormalized manager hierarchytables with latest information after each data load. Forperformance reasons, the complete manager hierarchyfor each person is extracted from live data tables andstored in a separate manager-hierarchy table, known asthe denormalized manager hierarchy.



46

Process Description

Send Pending LDAP Requests

Sends bulk requests to Oracle Identity Managementimmediately to create (and also suspend or re-enable)user accounts, as appropriate. When you load personrecords, the application automatically creates user-account requests by default and provisions roles tousers in accordance with role-provisioning rules.

Important Before you run this process, review your dataconversion fully and confirm its accuracy. Ifyou need to purge your data and repeat theconversion, it will take much longer if you'vecreated user accounts and notified users oftheir sign-in details. You can control aspectsof the provisioning process for the enterpriseby setting the User and Role Provisioningoptions on the Manage Enterprise HCMInformation page. For example, you cansuppress the automatic creation of useraccounts.

Compensation ProcessesDepending on the business objects that you're loading and how you plan to use them, you may also need to run the followingprocesses:

• Start Compensation Cycle: You run this process when all data is loaded and the compensation cycle is ready tostart.

• Refresh Workforce Compensation: You run this process if changes that you upload to Oracle Fusion HCM need tobe reflected in the compensation cycle.

For more information about the post-load processes, see:

• Oracle Human Capital Management Cloud Implementing Workforce Compensation

• Oracle Human Capital Management Cloud Integrating with Oracle HCM Cloud

FAQs for File-Based Loader: Post-Load Processing

How can I validate data loaded using File-Based Loader?You can validate your loaded data interactively by searching for a representative sample. For example, you can search forperson records in the Person Gallery and jobs on the Manage Jobs page. You could also use predefined Oracle TransactionalBusiness Intelligence (OTBI) reports or BI Publisher to define your own reports.



47

How can I delete data loaded to the stage environment usingFile-Based Loader?Use the deletion scripts that are pre-installed in your stage environment. Be aware that these scripts delete all data ratherthan just the rows in error.


Chapter 7Data Loading Using Spreadsheets

48

7 Data Loading Using Spreadsheets

Spreadsheet Data Loaders: ExplainedThis topic introduces the various spreadsheet data loaders provided with Oracle Fusion HCM. To use any of the spreadsheetdata loaders, you must install the Oracle ADF Desktop Integration Add-in for Excel.

HCM Spreadsheet Data LoaderHCM Spreadsheet Data Loader is a generic data loader that supports creation of several HR, compensation, absence, andtalent business objects. Using HCM Spreadsheet Data Loader, you can also update the person, assignment, and salarybusiness objects.

Payroll Batch LoaderPayroll Batch Loader is a generic data loader that supports creation of several payroll business objects, including elements,element entries, external bank accounts, and payroll definitions. Using Payroll Batch Loader, you can also update or deleteseveral of the supported objects.

Single-Object Spreadsheet LoadersOracle Fusion HCM provides many spreadsheet loaders for specific object types.

In most cases, you:

• Create the spreadsheet on the page where you manage the object.• Load the objects directly to the application tables.• Correct any errors in the spreadsheet.

In many cases, you can both create and update the object in a spreadsheet.

Single-object spreadsheets are most useful for end users, such as HR specialists and benefits specialists, who are creatingobjects of a specific type in bulk. You're less likely to use these types of spreadsheet loaders for integrations.

This table shows some key objects that you can create in bulk using this type of spreadsheet. It also identifies the page or tabwhere you generate spreadsheet.

Business Object Page or Tab

Benefit enrollments

Evaluation and Reporting work area, Enrollment Uploadstab

Benefit plans

Manage Benefit Plans page

Benefit programs

Manage Benefit Programs page

Competencies

Manage Content Items page



49

Business Object Page or Tab

Departments

Manage Departments page

Jobs

Manage Jobs page

Locations

Manage Locations page

Performance ratings

Manage Content Items page

Postal code ranges and service areas

Manage Postal Code Ranges and Service Areas page

Regulations

Manage Regulations page

Reporting groups

Manage Reporting Groups page

Stock grants

Manage Stock Grants page

Variable rate profiles

Manage Benefit Rates page

Work patterns

Manage Work Schedules page

Work schedule assignments

Manage Work Schedule Assignment Administrationpage

Work schedules

Manage Work Schedules page

Worker goals

Administer Goals page

For some objects, such as benefit rates, person habits, and assignments, you can perform a mass update in a spreadsheet.To update these objects, you download existing objects to a generated spreadsheet, edit the objects, and upload thechanges.

Setting Up the Desktop Integration for Excel:ProcedureTo use a desktop integrated Excel workbook to create or edit records that you can upload to the application, you must meetsoftware requirements, install a desktop client (and reinstall when necessary), and set up Microsoft Excel.



50

Meeting Software RequirementsMake sure that you have:

• Microsoft Excel 2007 or 2010

• Microsoft Windows XP Professional, Vista - Business, Vista - Ultimate, or 7

Installing the Desktop ClientInstall the Oracle ADF Desktop Integration Add-in for Excel, which is a desktop client that lets you use the integratedworkbooks that you download from the application.

1. Make sure you are signed in to your computer with your account. For example, you can't have someone else sign inas an administrator and make the installation available for everyone using your computer.

2. In the application, look for the client installer under Navigator - Tools . If it's not there, then ask your administratorwhere you can find the installer.

3. Run the installer as you would any program that you install on your computer.

Reinstalling the ClientYou must reinstall the desktop client if:

• The client version changes and you don't get automatic updates.

TipYou can find your client version in the About section of the workbook and ask your administrator if thatversion is the latest.

• The location of the client installer ever changes. You must use the installer from the new location.

To reinstall for any reason:

1. Uninstall the Oracle ADF Desktop Integration Add-in for Excel client, using Add or Remove Programs as youwould to uninstall any program on your computer.

2. Follow the steps above to install the client.

Setting Up Microsoft ExcelPerform the following steps in Microsoft Excel only once, even if you reinstall the desktop client.

1. Click the Microsoft Office button, and click the Excel Options button.

2. In the Excel Options dialog box, select the Trust Center tab, and click Trust Center Settings.

3. In the Trust Center dialog box, select the Macro Settings tab, and select the Trust access to the VBA projectobject model check box.



51

NoteThe exact steps can vary depending on your version of Microsoft Excel.

Related Topics

• Troubleshooting the Desktop Integration for Excel: Procedure

Working in Desktop Integrated Excel Workbooks:Points to ConsiderWhere available, you can download a desktop integrated Microsoft Excel workbook and use it to create or edit records.When you're using the workbook, no changes are actually made in the application; your edits take effect only after youupload the records back. As you work, keep in mind the following points to consider.

What You Must Not DoTo make sure that the upload to the application goes smoothly, don't:

• Rename text from the integrated workbook, for example the worksheet or tab names.

• Use your own styles in the file.

• Add columns.

• Delete any part of the template, for example columns.

• Hide required columns and status columns or headers.

ConventionsSome column headers in the integrated workbook might include [..]. This means that you can double-click or right-click withinany cell in the column to open a dialog box that lets you select a value to insert into the cell.

StatusesIn the workbook, you might find statuses for:

• Worksheet: The status in the header area applies to the entire worksheet, or tab, within the integrated workbook.

• Table: The status applies to only the corresponding table.

• Row: The status applies to the state of the row within the workbook, not to the record itself. For example, if the rowis for a business document, the status does not mean the status of the document itself, but of the data in the row, inthe context of the workbook.

SearchesSome integrated workbooks have searches. For the search to work within the workbook, you must sign in to the application.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=BB9C94EBFE4402D9E040D30A688117D3



52

Refreshes After UploadAfter you upload to the application, you might need to refresh the data in the table if your changes are not reflected in theapplication. You can use the refresh option for the table, or perform a filter or search on the table.

Related Topics

• Troubleshooting the Desktop Integration for Excel: Procedure

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=BB9C94EBFE4402D9E040D30A688117D3


Chapter 8HCM Spreadsheet Data Loader

53

8 HCM Spreadsheet Data Loader

Uploading Data: ExplainedHCM Spreadsheet Data Loader enables you to upload business objects to Oracle Fusion Human Capital Management(HCM) from a spreadsheet. Business objects that you can upload include person and assignment data, grades, jobs, talentprofiles, educational establishments, and salaries. You can view the complete list of supported business objects on the InitiateSpreadsheet Load page, where objects appear in the recommended load order. You can include descriptive flexfields in datauploads.

This topic describes:

• How data is uploaded using HCM Spreadsheet Data Loader

• Support for date-effective updates

• Who can use HCM Spreadsheet Data Loader

• Spreadsheet and batch names

How Data Is Uploaded Using HCM Spreadsheet Data LoaderUploading business objects using HCM Spreadsheet Data Loader is a two-stage process.

1. You generate a spreadsheet for a selected HCM business object, enter data in the spreadsheet, and click Upload.This action imports the data to a named batch in the Load Batch Data stage tables.

2. The Load Batch Data process, which loads data from the stage tables to the Oracle Fusion application tables, runsautomatically when valid data rows are imported to the stage tables.

Load Batch Data is a generic process for loading data to Oracle Fusion HCM from external sources.

Errors from both stages of the process are reported in the original spreadsheet. You can fix the errors in this spreadsheet andclick Upload again.



54

The following figure summarizes both stages of this process.

Support for Date-Effective UpdatesWhen updating worker and assignment objects, you can both correct and update records.

• To correct a record, you specify the same effective start date as was used to create the record.

• To update a record, you specify a different effective start date from the date that was used to create the record.

Who Can Use HCM Spreadsheet Data LoaderTo use HCM Spreadsheet Data Loader, you can:

• Perform the Initiate HCM Spreadsheet Load task from the Setup and Maintenance work area or an implementationproject.

You can perform this task if you have the Application Implementation Consultant job role.

• Perform the Initiate Spreadsheet Load task from the Data Exchange work area.

You can perform this task if you have the Human Capital Management Application Administrator or ApplicationImplementation Consultant job role.

Spreadsheet and Batch NamesSpreadsheet names are generated automatically, but you can replace them. If you are uploading several types of businessobjects, devise a naming scheme that enables you to identify spreadsheets easily. For example, you could include both the



55

business-object type and the date in the spreadsheet names. If you upload several batches of data of a single type on onedate, use a suffix to differentiate spreadsheets.

Batch names are generated automatically, but you can overwrite them. They identify batches submitted to the LoadBatch Data process and must be unique. Using the same names for spreadsheets and batches helps you to associatea spreadsheet with its batch. For example, for uploading jobs on 01/08/13, you could use the spreadsheet nameJobs010813.xlsx and the batch name Jobs010813.

Related Topics• Setting Up the Desktop Integration for Excel: Procedure

When to Use: ExplainedYou can use HCM Spreadsheet Data Loader to create any of the business objects that it supports. You can also edit personand assignment data. However, you can't use HCM Spreadsheet Data Loader to delete business objects. Supported actionsfor each business object appear on the Initiate Spreadsheet Load page.

Each business object is represented as a single row in the spreadsheet. Any hierarchical data that you can upload with HCMSpreadsheet Data Loader has been flattened to accommodate single-row representation.

HCM Spreadsheet Data Loader is most efficient for uploading small-to-medium amounts of data. For example, uploading 100job definitions is likely to be more efficient than creating them individually using the Create Job task. However, to create just afew business objects it may be quicker to perform the relevant tasks.HCM Spreadsheet Data Loader isn't suitable for loadinglarge numbers (tens of thousands) of records.

Approval processes don't apply to data uploaded using HCM Spreadsheet Data Loader.

After loading person records in bulk, you are recommended to run the following processes in the order shown here. Allow thefirst process to complete before starting the second.

Process Description

Send pending LDAP Requests

Sends bulk requests for user accounts to Oracle IdentityMangement (OIM).

Send Personal Data for Multiple Users to LDAP

Ensures that personal data held by Oracle Fusion HCMand OIM is synchronized.

Correcting Load Errors: ExplainedThis topic explains how you can correct both import and load errors in the spreadsheet that you used to upload data usingHCM Spreadsheet Data Loader.

Correcting Import ErrorsWhen you import data from a spreadsheet, the status of each spreadsheet row is updated automatically to show whether therow was inserted successfully in the batch. If any row fails, you can display information about the error by double-clicking thestatus value. After correcting any errors, you click Upload to import the corrected data to the existing batch.



56

Correcting Load ErrorsAs each spreadsheet row is successfully imported to the batch in the stage tables, the Load Batch Data process runsautomatically. This process loads the data from the stage tables to the Oracle Fusion application tables. The system validatesthe data during this transfer.

When you click Refresh, the system reports the errors at this stage in the original spreadsheet. After correcting the errorsin the spreadsheet, you click Upload again to import the corrected data to the same batch in the Load Batch Data stagetables. The Load Batch Data process runs automatically for the corrected rows.

Uploading Data: Worked ExampleThis example shows how to upload jobs for the Sales Department using the Initiate HCM Spreadsheet Load task.

The following table summarizes key decisions for this scenario.

Decisions to Consider In This Example

Which business objects am I loading?

Jobs

What is my spreadsheet name?

SalesJobs113012Batchnn. xlsx

What is my batch name?

SalesJobs113012Batchnn

Summary of the TasksUpload the jobs data by:

1. Selecting the Initiate HCM Spreadsheet Load task

2. Creating the jobs spreadsheet

3. Entering data in the jobs spreadsheet

4. Importing jobs and correcting import errors

5. Reviewing and correcting load errors

PrerequisitesBefore you can complete this task, you must have:

1. Installed the desktop client Oracle ADF Desktop Integration Add-in for Excel

2. Enabled the Trust Center setting Trust access to the VBA project object model in Microsoft Excel



57

Selecting the Initiate HCM Spreadsheet Load Task

1. On the Overview page of the Setup and Maintenance work area, click the All Tasks tab.

2. In the Search region, complete the fields as shown in this table.

Field Value

Search Task

Name Initiate HCM Spreadsheet Load

3. Click Search.

4. In the search results, click Go to Task for the Initiate HCM Spreadsheet Load task.

Alternatively, you can start the Initiate HCM Spreadsheet Load task from an implementation project or select theInitiate Spreadsheet Load task in the Data Exchange work area.

Creating the Jobs Spreadsheet

1. On the Initiate Spreadsheet Load page, find the entry for Create HR Job in the list of business objects.

Create HR Job appears after other business objects such as grades, locations, and job families. You must createthose business objects before jobs, regardless of how you create them.

2. Click Create Spreadsheet for the Create HR Job entry.

3. Save the spreadsheet locally using the name SalesJobs113012Batch01.xlsx, when you get a prompt.

4. Sign in to Oracle Fusion Applications using your Oracle Fusion user name and password, when you get a prompt.

Entering Data in the Jobs Spreadsheet

1. In the Batch Name field of the spreadsheet SalesJobs113012Batch01.xlsx, replace the default batch name withthe batch name SalesJobs113012Batch01.

2. Click Configure Flexfield to configure flexfield data.

3. In the Configure Flexfield window, select a Job Attributes value and click OK.

4. See the Flexfields Reference tab for information about the configured flexfield.

5. Enter jobs data in the spreadsheet.

Ensure that you provide any required values in the jobs rows and follow instructions in the spreadsheet for creatingrows.



58

Importing Jobs and Correcting Import ErrorsUse the default values except where indicated.

1. In the jobs spreadsheet, click Upload.

2. In the Upload Options window, click OK.

As each row of data imports to the Load Batch Data stage tables, its status updates.

3. When uploading completes, identify any spreadsheet rows with the status Insert failed, which indicates that therow didn't import to the stage tables.

4. For any row that failed, double-click the status value to display a description of the error.

5. Correct any import errors and click Upload again to import the remaining rows to the same batch.

As rows import successfully to the stage tables, the data loads automatically to the application tables.

Reviewing and Correcting Load Errors

1. In the spreadsheet, click Refresh to display latest load status.

Any errors that occur during the load process appear in the spreadsheet.

2. Correct any load errors in the spreadsheet.

3. Repeat this process from Importing Jobs and Correcting Import Errors until all spreadsheet rows both import andload successfully.

4. Close the spreadsheet.

To load a second batch of jobs for the Sales Department on the same date, increment the batch number in thespreadsheet and batch names (for example, SalesJobs113012Batch02).

Related Topics• Setting Up the Desktop Integration for Excel: Procedure

FAQs for HCM Spreadsheet Data Loader

How can I fix errors?You fix errors in the spreadsheet that you used to upload the data.

Errors that occur during the import to the Load Batch Data stage tables report automatically in the spreadsheet. For any rowthat fails to load, double-click the status value for a description of the error. After correcting any errors, click Upload again.



59

Errors that occur as data is loaded from the stage tables to the application tables also report in the spreadsheet. ClickRefresh to display these errors. After correcting any load errors, click Upload again.

How can I avoid data-dependency errors?You can avoid data-dependency errors by following the order in which business objects appear on the Initiate SpreadsheetLoad page. For example, Create Location appears before Create Business Unit on the Initiate Spreadsheet Load page. Thisindicates that you must create locations before you can create business units.

You can create business objects using any of the available methods. For example, you can create locations on the CreateLocation page before uploading business units using HCM Spreadsheet Data Loader.

Can I load date-effective data?Yes. You can create date-effective business objects. You can also update date-effective person and assignment data usingHCM Spreadsheet Data Loader.

You can't delete or correct date-effective data using HCM Spreadsheet Loader.


Chapter 9Payroll Data Loading

60

9 Payroll Data Loading

OverviewYou can load payroll data for initial migration or mass data entry using the payroll batch loader, predefined processes,and web services. You can also automate the regular import of time cards, absence entries, and benefit enrollments usingpredefined flows.

This overview outlines your options to meet the following data loading requirements:

• Loading setup data

• Exporting and importing setup data between test and production environments

• Ongoing data loading

Loading Setup DataYou can use HCM File-Based Loader during implementation to migrate HCM setup data, including element entries andsalaries. However, for most payroll-related setup data and worker data, as shown in the following table, use the payroll batchloader. You can load the data from a spreadsheet or a file.

Payroll Setup Data Worker Data

Balances in balance groups Elements Formula globals Object groups Payroll definitions User-defined tables

Assigned payrolls Bank details for personal payment methods Element entries Initial balance values

Use the Batch Loader task in the Payroll Administration or Data Exchange work area to perform the following actions:

1. Enter the data in a workbook format that's specific to the object type or create a batch from a file using atransformation formula.

2. Save your entries to staging tables.

3. Validate the data in staging tables.

4. Submit the Transfer Batch flow to load the data to the application tables. For initial balance values, use the LoadInitial Balances flow instead.


Chapter 9Payroll Data Loading

61

Exporting and Importing Setup Data Between EnvironmentsTypically, you initially migrate data to a test environment. After successful testing, you can move the data to your productionenvironment using one of the following tasks:

• Use the Manage Configuration Packages task in the Setup and Maintenance work area to export and import aconfiguration package.

• Use the Create Batch for an Object process in the Payroll Administration work area to select specific objects, suchas elements or formulas, to migrate.

Ongoing Data LoadingYou can use the payroll batch loader and predefined batch processes to load element entries and other payroll data on anongoing basis. You can automate the submission of the flows using the flow action web service.

Specific flows exist for loading payroll-related data for payroll processing, such as the Load Absence Batches process, whereyou specify the interface type and XML file containing the data to load.

To meet other data loading requirements, you can create, update, and delete objects directly in application tables using webservices. You can find details of the services in Oracle Enterprise Repository (https://fusionappsoer.oracle.com).

Related Topics

• Payroll Batch Loader Tasks: Explained

• Exporting and Importing Setup Data: Explained

• Web Services: Overview

• Oracle Fusion HCM File-Based Loader: Explained

• Uploading Data Using HCM Spreadsheet Data Loader: Explained

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=A48BC766452FB084E040D30A6881408B


Chapter 10Payroll Batch Loader

62

10 Payroll Batch Loader

Using Payroll Batch Loader

Payroll Batch Loader Tasks: ExplainedPayroll managers and administrators use the batch loader for a variety of purposes when migrating and loading data duringimplementation and on an ongoing basis. This topic compares the different tasks to help you determine which approach totake when loading data.

You can use the batch loader tasks and processes to perform the following actions:

• Create, update, and delete data for supported objects

• Create elements and formulas using template questions

• Create batches from files

• Migrate objects between environments

The following table describes the tasks and processes that you might use when working with the batch loader. You canaccess these tasks and processes in the Payroll Administration work area or using the Enter Batch task in a payroll flow.

Task or Process Description Comments

Batch Loader

Launches a workbook where youcan create a batch or search forand view an existing batch.

Access this task in the Tasks pane.

Create Batch

Creates a batch to load elemententries or balances by objectgroup. Populates a workbookwith all the elements or people inthe object group you select whensubmitting the process.

Access this process from theSubmit a Payroll Flow task.

Create Batch for an Object

Downloads some or all records andhistory for a specified object, suchas an element or formula, into abatch for data migration.

Copy the batch lines to a newbatch in another environment andsubmit the Transfer Batch flow tocreate the data. Access this process from theSubmit a Process or Report task.

Enter Batch

For user-defined flows, launches aworkbook for a single batch.

Sequence tasks in the flow patternso that the Transfer Batch taskfollows the Enter Batch task.



63

Task or Process Description Comments

Access this process from thechecklist of a user-defined flowpattern.

Load Batch from File

Uploads a file and transforms itsdata using the specified formulainto a batch that you can transfer.

Access this process from theSubmit a Payroll Flow task.

Purge Batch

Removes the specified batch.

You can purge a batch at any time.You can't transfer or view purgedbatches. Access this process from theSubmit a Process or Report task.

Transfer Batch

Creates entries in the applicableHCM tables for the specified batch.

Access this process from theSubmit a Process or Report task.



64

Creating, Updating, and Deleting DataThe batch loader workbooks provide a fast way to upload batches of data. You create batches based on predefinedtemplates, enter your data, load data into staging tables, and then transfer the batch into the HCM tables. The following figureillustrates the basic process and the tasks you use.

The task names in the workbook represent the type of object the batch loader supports. The task actions available dependon the task name you select, shown in the following table.

Task Name Task Action

Balance Group

Add Balance Definition Remove Balance Definition

Bank

Create

Bank Branch

Create



65

Task Name Task Action

Element

Create Update Delete

Element Entry

Create

Element Input Value


External Bank Account

Create

Fast Formula


Object Group

Create Update

Payroll Definition


Payroll Relationship

Add Payroll End Payroll

Personal Payment Method

Create

User-Defined Table

Create Update



66

Importing Data: ProcedureThe payroll batch loader imports data from integrated Microsoft Excel workbook templates into the staging tables andtransfers that data into the application.

The upload tasks available vary depending on the data type that you want to load. Each workbook template includes requiredand optional columns for loading data.

TipYou perform tasks with interdependencies sequentially, creating separate workbooks for each task. For example,a bank must exist before you associate its branches, so you first create banks in one workbook, and then createthe branches in the next workbook.

The following figure illustrates the basic process for importing data using the batch loader.

PrerequisitesBefore you can populate worksheets, you must have installed Oracle ADF Desktop Integration for Excel.

Populating the WorkbookWhen you download the batch loader workbook, you use it to enter your data. The following steps show how to downloadthe workbook, add your data, and upload the data to the staging tables.

1. In the Payroll Administration work area, click Batch Loader, and then click Download. Open the workbook andsign in.

2. On the last row of the Batch Header Sheet tab, in the Batch Name field, enter a name for the batch.

Use this name when submitting the transfer process that moves the data from the staging tables.

3. In the same row, select the legislative data group from the list, then click Save.

4. On the Batch Content Sheet tab, under Batch Contents Action, click Add, and then select the task you want.

5. In the Batch Content Line Details section, insert rows for each data item that you want to add and enter all requiredvalues.

6. Click Save and leave the workbook open.

Transferring the BatchAfter you have saved your data to the staging tables, you submit a process to transfer the batch. The following steps showhow to move the data from the staging tables and verify that the transfer succeeded.

1. In the Payroll Administration work area, click Submit a Process or Report.

2. Select your legislative data group.

3. In the Flow Pattern column, select Transfer Batch, and then click Next.



67

4. In the Payroll Flow field, enter a name for the process. You can use this name later when looking for process status.

5. In the Batch field, search for and select the batch name you want to transfer, and then click Next.

6. On the Enter Flow Interaction page, click Next.

7. On the Review page, click Submit, and then click OK and View Checklist.

8. Click Refresh until the Transfer Batch process status displays as complete.

9. In the workbook, display the Batch Messages Sheet, then display the Batch Content Sheet. Verify that the statusshows as Transferred.

10. Display the Batch Message Sheet. You should see no error messages

Related Topics• Payroll Batch Loader Workbooks for Bank Data

Payroll Batch Statuses: ExplainedThe payroll batch loader workbooks display a status on the Batch Header Sheet. The status reflects the status of thebatch header, all the batch lines, and any control totals specified for the batch. Use the Batch Loader task from the PayrollAdministration work area to download the workbooks.

On the Batch Header Sheet, you can see the following status values.

Status Meaning

Valid

All of the lines, totals, and header are valid

Transferred

All of the lines, totals, and header are transferred fromthe staging tables to the applicable HCM tables

Transfer incomplete

The header and totals are transferred along with onlysome of the lines

Unprocessed

At least one line, total, or the header is unprocessed,and no lines transferred

Error

The header wasn't transferred and at least one line,total, or the header is in error

Creating Element Entries: Worked ExampleThis example demonstrates how to create element entries for bonus earnings for two workers in the InFusion US Sun Powerlegislative data group using the payroll batch loader. Nancy is an executive and receives a bonus based on ten percent of hersalary. Joseph is an instructor and receives a fixed amount of 500.



68

You select the annual bonus element and create element entries in the workbook.

PrerequisitesThis worked example assumes that you completed the following prerequisites:

1. Install Oracle ADF Desktop Integration Runtime Add-in for Excel

2. Create a bonus element at the assignment level for element entries

3. Identify the assignment numbers of the workers who receive the bonus element entries

Creating a Batch Header1. From the Payroll Administration work area, select the Batch Loader task.

2. On the Batch Loader page, click Download.

3. After the DesktopGenericBatch.xlsx file downloads, open the file.

4. When prompted to connect, click Yes.

5. In the Login dialog box, enter your user ID and password, and then click Sign In.

6. Navigate to the Batch Header Sheet at the bottom of the workbook.

7. In the Batch Name column of the Search Results section, enter InFusion Bonus.

8. In the Legislative Data Group list, select InFusion US Sun Power.

9. Click Save.

10. In the Upload Options dialog box, accept the default selection and click OK.

Once your selections are saved, the Batch Status text for that row displays that the row inserted successfully.

Creating Batch Content1. On the Batch Header Sheet, double-click the batch name InFusion Bonus to prepare for data entry.

2. Navigate to the Batch Content Sheet.

3. Under Batch Contents Action, click Add.

4. Search for and select the Bonus - Annual task name, and then click OK.

The workbook refreshes to display the columns for the selected element, ready for data entry.

5. In the Batch Line Content Details section, enter the values for Nancy as shown in this table.

Field Value

Line Sequence 1

Effective Start Date 2012-12-15

Assignment Number E1000842

Percentage 10



69

Field Value

Legislative Data Group InFusion US Sun Power

6. Right-click the next row number and insert a row for Joseph's details.

7. Enter the values for Joseph as shown in this table.

Field Value

Line Sequence 2


Assignment Number E1003564

Pay Value 500

Legislative Data Group InFusion US Sun Power

8. Click Save.

9. In the Upload Options dialog box accept the default selection and click OK.

ImportantKeep the workbook open. You verify the transfer of the element entries in the final step of this example.

Transferring the Batch1. From the Payroll Administration work area, click Submit a Process or Report.

2. In the Legislative Data Group field, select InFusion US Sun Power.


4. In the Payroll Flow field, enter a name for the process, such as InFusion Bonus Batch.

5. In the Batch field, search for and select InFusion Bonus, and then click Next.


7. On the Review page, click Submit.

8. Click OK and View Checklist.


Verifying the Transfer1. In the workbook, navigate to the Batch Content Sheet.



70

Notice that the status displays as transferred.

2. Navigate back to the Batch Message Sheet.

You should see no error messages. Nancy and Joseph should now have the bonus element entries. You can usethe Manage Element Entries task to find the workers and view the element entries.

Related Topics• Working in Desktop Integrated Excel Workbooks: Points to Consider

Creating Globals: Worked ExampleThis example demonstrates how to enter globals for two types of bonuses in the InFusion US legislative data group using thepayroll batch loader workbook. You set the bonus values for executives at ten percent of their salary and instructors at a fixedvalue of 500. You can change these values later in the global to apply the same value in any formulas that use them.

The following table summarizes key decisions for this scenario.


Load what type of data?

Fast Formula Global

Create which globals?

Executive Bonus for a percentage and Instructor Bonusfor a fixed amount.

PrerequisiteThis worked example assumes that you installed Oracle ADF Desktop Integration Runtime Add-in for Excel.

Creating a Batch Header1. From the Payroll Administration work area, select the Batch Loader task.

2. On the Batch Loader page, click Download.

3. After the DesktopGenericBatch.xlsx file downloads, open the file.

4. When prompted to connect, click Yes.

5. In the Login dialog box, enter your user ID and password, and then click Sign In.

6. Navigate to the Batch Header Sheet at the bottom of the workbook.

7. In the Batch Name column of the Search Results section, enter InFusion Globals.

8. In the Legislative Data Group list, select InFusion US.

9. Click Save.

10. In the Upload Options dialog box, accept the default selection and click OK.

After you save your selections, the Batch Status text for that row displays that the row inserted successfully.



71

Creating Batch Content1. On the Batch Header Sheet, double-click the batch name InFusion Globals to prepare for data entry.

2. Navigate to the Batch Content Sheet.

3. Under Batch Contents Action, click Add.

4. In the Task Name field, enter Fast Formula Global.

5. Click Search.

6. Select Fast Formula Global, and then click OK.

The workbook should update to display the columns for the selected task, ready for data entry.

7. In the Batch Line Content Details section enter the values for each global as shown in this table.

Field First Global Value Second Global Value

Line Sequence 1

2


2011-01-01

Effective End Date 2020-12-31

2020-12-31

Value .10

500

Data Type N

N

Name Executive Bonus

Instructor Bonus

NoteTo insert more lines for additional global values, right-click on the row number where you want to add arow, and then select Insert.

8. Click Save.

9. In the Upload Options dialog box accept the default selection and click OK.

ImportantKeep the workbook open. You verify the transferred globals in the final step of this example.

Transferring the Batch1. From the Payroll Administration work area, click Submit a Process or Report.

2. In the Legislative Data Group field, select InFusion US.



72


4. In the Payroll Flow field, enter a name for the process, such as InFusion Globals Batch.

5. In the Batch field, search for and select InFusion Globals, and then click Next.


7. On the Review page, click Submit.

8. Click OK and View Checklist.


Verifying the Transfer1. In the workbook, navigate to the Batch Content Sheet.

You should see the status displayed as transferred.

2. Navigate back to the Batch Message Sheet.

You should see no error messages. You can use the new globals in your formulas.

Related Topics• Working in Desktop Integrated Excel Workbooks: Points to Consider

Migrating Objects: ProcedureUsing the Create Batch for an Object process in the Payroll Administration work area, you can migrate objects betweenenvironments. To copy or migrate elements or formulas, follow these steps:

1. In the source environment, submit the Create Batch for an Object flow in the Payroll Administration work area.

2. Enter the name of the batch, the object type and object name.

NoteFor object type, enter either Element or Fast Formula.

3. Download the batch loader workbook.

4. In the target environment, use the Batch Loader task in the Payroll Administration work area to create a batch.

5. Copy and paste the corresponding lines from the source environment's workbook to the target environment'sworkbook.

6. Save and transfer the batch on the target environment.

Loading a Batch From a File: ProcedureYou can upload a file and use the Load Batch from File process to transform the data in the file into a batch. Each file requiresa transformation formula that you create using the Batch Loader formula type.

1. Use the Submit a Payroll Flow task from the Payroll Administration work area, and select the Load Batch from Fileflow pattern.



73

2. Enter a name for the flow, a name for the batch, and then select the transformation formula.

3. Submit the flow and click OK and View Checklist.

4. In the row for the Upload File task, click Go to Task.

5. Select your file.

6. Verify the content and save the workbook to upload any changes you made.

7. Transfer the batch.

FAQs for Payroll Batch Loader

How can I access the payroll batch loader?For payroll managers and administrators, select the Batch Loader task in the Payroll Administration work area. If a flowincludes the batch loader, you can also access it from the Payroll Checklist work area using the Enter Batch task on thePayroll Flow page.

Can I use the batch loader to upload a spreadsheet I create?No, you can't if you didn't download the payroll batch loader workbook. The batch loader workbook automatically insertsmacros essential to successful processing. You can download the batch upload workbook to your desktop and edit the databefore loading it.

How do I modify an Excel workbook template for the payroll batch loader?You can't modify the structure of integrated Microsoft Excel workbooks because they're based on predefined templates. Thisrestriction ensures the fields entered correspond exactly to the HCM tables that receive the uploaded data.

Loading Initial Balances

OverviewSetting initial balances values is an essential task when you migrate payroll data from another application. First you loadbalance values into batch views, then submit the Load Initial Balances process from the Payroll Calculation work area. Theprocess validates the information then loads the batch.

Balance Initialization ElementsFor each initialized balance, you must create elements in the Balance Initialization classification and add them to the balanceas balance feeds.

You can create up to three balance initialization elements for the following levels:

1. Assignment

2. Employment terms

3. Payroll relationship

Each balance initialization element must:

• Be nonrecurring and for balance adjustments only.



74

• Be capable of being processed in the payroll run.

• Have an input value to feed the balance and an input value for each context required by the balance.

TipIf you need to set initial values for a large number of balances you can define multiple input values for asingle element with each input value feeding a different balance.

• Have an eligibility record associated with it, with an early effective start date.

Batch ViewsTo populate the batch views with the balance values for the initialization date, use the Payroll batch loader workbook, whichyou can download from the Payroll Administration work area.

The views include:

• PAY_BALANCE_BATCH_HEADER

• PAY_BALANCE_BATCH_LINES

ImportantThe PAY_BALANCE_BATCH_LINES view has a complex definition. You can't directly insert balance values intothis view. You must use the batch loader workbook.

When you create the batch header and lines, consider the following points:

• Divide your employees into separate batches to limit the size of each batch.

• Within a batch, ensure that you include batch lines for every balance to be initialized for a person. You can't split linesfor a person across multiple batches.

• The date you specify on the batch header applies to all lines unless you enter an override date at the line level. Thedate at line level must be on or before the date on the header.

• You can't initialize balances once you have run any payroll processes.

• Every line must include a value for payroll relationship number. If the line is initializing a terms-level balance, you mustalso enter a term number. If the line is initializing an assignment-level balance, you must also enter a term numberand an assignment number.

Initial Balances: How They're LoadedThe Load Initial Balances process validates then processes the initial balance values you load into batch views. It createsbalance adjustments to set the required values. To load initial balances, use the Submit a Process or Report task in thePayroll Calculation work area.

Settings That Affect Initial BalancesThe data you load into the batch views determines which defined balances the process initializes and the values it uses.Typically, you group employees into batches to manage the initialization of their balances.



75

How the Balances Are InitializedThe Load Initial Balances process validates the existence of the entities referenced in the batch data, including:

• Balances• Balance dimensions• Tax reporting units• Payrolls• Payroll relationships• Employment terms• Assignments

It also checks that values are available for the contexts used by each balance dimension. It doesn't check, for example, thatan employee is assigned to a specified organization. After successful validation, the process creates balance adjustments.

Batch Line Status Description

V

Batch line is valid.

T

Batch line has been successfully processed.

ExamplesThe following table shows a simple three-line batch loaded on 18 June.

Defined Balance Value

Total_ Earnings_PTD

100

Total_ Earnings_QTD

250

Total_ Earnings_YTD

500

For this batch, the process creates an adjustment on the first day of the time period relevant to each dimension, as shown inthe following table:

Adjustment Date Adjustment Value Balances Adjusted

1 June

100

Total_ Earnings_PTD Total_ Earnings_QTD Total_ Earnings_YTD



76

Adjustment Date Adjustment Value Balances Adjusted

1 April

150

Total_ Earnings_QTD Total_ Earnings_YTD

1 Jan

250

Total_ Earnings_YTD

Balance Batch Header and Lines ViewsThe Load Initial Balances process uses the PAY_BALANCE_BATCH_HEADER and PAY_BALANCE_BATCH_LINES views tohold the data to initialize balance values.

You must load data into these views using the Payroll batch loader workbook or API in thePAY_BALANCE_BATCH_LINES_PKG PL/SQL package.

Create each batch line with a BATCH_LINE_STATUS of U (unprocessed) and leave the PAYROLL_REL_ACTION_ID columnblank. The batch upload process updates these two columns.

Required Columns

NoteYou can view the full column listing by querying the view in the Oracle Enterprise Repository at https://fusionappsoer.oracle.com/oer/.

The PAY_BALANCE_BATCH_LINES view requires the columns shown in the following table. Where there is both an IDcolumn and a name column for the same entity, for example, PAYROLL_ASSIGNMENT_ID and ASSIGNMENT_NUMBER,you can populate either column. You must, however, populate at least one. If you leave the ID column blank, the batchupload process uses the name column value to derive the ID value.

Column Comments

PAYROLL_ RELATIONSHIP_ ID + PAYROLL_RELATIONSHIP_ NUMBER

Identify the payroll relationship for this balance value.

BALANCE_ TYPE_ID + BALANCE_NAME

Identify the balance for this balance value.

BALANCE_ DIMENSION_ID + DIMENSION_ NAME

Identify the balance dimension for this balance value.DIMENSIONNAME should be populated with thecountry-specific dimension usage dimension namerather than the global DIMENSION_ NAME held onPAY_ BALANCE_ DIMENSIONS.

VALUE

Identify the numerical value of the balance on the uploaddate.



77

Column Comments

UPLOAD_DATE

Identify the date of the balance value. This date must beon or before the upload date for the batch header.

PAYROLL_ID + PAYROLL_NAME

Identify the context required for evaluating a balancevalue, even though it may not be a context for thedimension.

Core ContextIf the balance dimension expects a value for this context, you must populate the core contexts shown in the following table.

Column Comment

PAYROLL_ TERM_ID + TERM_NUMBER

Identify the payroll terms for this balance value, ifrequired. Where there is both an ID column and anumber column for the same entity, you can populateeither column, but you must populate at least one.

PAYROLL_ ASSIGNMENT_ID + ASSIGNMENT_NUMBER

Identify the payroll assignment for this balance value, ifrequired.

LEGAL_ EMPLOYER_ID + LEGAL_ EMPLOYER_NAME

TAX_UNIT_ID + TAX_UNIT_NAME

AREA1 + AREA2 + AREA3 + AREA4

Identify state and country code information.

Note In Oracle E-Business Suite these items wereSTATE_CODE, COUNTY_CODE and so on.

THIRD_ PARTY_PAYEE_ID + THIRD_ PARTY_PAYEE_NAME

TIME_ DEFINITION_ID + TIME_ DEFINITION_ NAME

RUN_TYPE_NAME + RUN_TYPE_ID

ELEMENT_ ENTRY_ID



78

Column Comment

BALANCE_DATE

CALC_ BREAKDOWN_ID

Identify the ID associated with the payroll terms. If thecalculation breakdown is:

• The calculation card, enter thePAY_DIR_CARDS_F.DIR_CARD_ID.

• The calculation component, enter thePAY_DIR_CARD_COMPONENTS_F.DIR_CARD_COMP_ID.

Legislative or User-defined Context ColumnsThere are six legislative or user-defined contexts that you must populate if the balance dimension expects a value for thesecontexts. For each context, there is a context ID, name, and value. For example:

• CONTEXT1_ID + CONTEXT1_NAME• If the balance dimension uses CONTEXT1 populate CONTEXT1_VALUE

NoteThe values of the core contexts are the IDs themselves, while the values of the legislative contexts are separatefrom the ID of the context.

Populate CONTEXT[1-6]_NAME with the name of the context usage for that legislative or user-defined context. PopulateCONTEXT[1-6]_VALUE with the actual value of that context.

Adjusting Balances: Critical ChoicesUse balance adjustment in exceptional circumstances when you can't correct the source data by submitting the appropriaterecalculation process. For example you might process an adjustment to correct an initialized balance or correct a balanceincluded in statutory reports at the end of a quarter or year. You can also use the balance adjustment process in situationswhere, an employee moves at the end of the year and you don't receive a notification in time. In this case you might need toadjust the employee's tax balance and refund the amount collected by mistake.

Before performing a balance adjustment, review the following factors:

• Regulated limits and related balances• Adjustment methods• Element to adjust• Input values to adjust• Processing balance adjustments and payroll• When to cost adjustments

If you are processing a payroll, also consider:

• When to pay refunds• Reporting an adjustment



79

Regulated Limits and Related BalancesBalance adjustments update the selected balance but not related balances, because you aren't recalculating the element andits balances. Balance adjustments also bypass system validation, which means that limits aren't verified. Before performing anadjustment, consider whether related balances require adjustment, and whether your adjustment exceeds statutory regulatedlimits. For example, raising the upper limit of one balance might require correcting the lower limit of a related balance andensuring that they both meet statutory limits.

Adjustment MethodsTwo factors determine where you can adjust the balance: whether you processed the element in the payroll run for theperson, and whether you need to adjust the context of the balance dimension.

You initiate a balance adjustment from the Payroll Calculation work area. From here, you can:

• Use the Adjust Individual Balances task

• Select Adjust Balances from the Action menu on the View Person Process Results page, Balance Results section.

The following table contrasts the two tasks.

Adjustment Tasks Can Adjust Elements Processedin the Run

Can Update Context

Adjust Individual Balances

Yes You can also create new balanceresults for element not processed ina payroll run.

Yes

Adjust Balances

Yes

No, the context is the one used forthe payroll run.

Elements to AdjustThe best practice is to adjust the balance of an existing element, instead of creating a new element for balance adjustmentpurposes. Creating a new element isn't recommended because you must create the balance feeds and input values, andensure that you adjust all the related balances.

When you create an element using the Manage Elements task, you complete a template to create the element definition. Forsome element classifications, submitting the template automatically creates related elements, such as results elements. Referto the following table to determine which element and input value to use for a balance adjustment.

PrimaryClassification

SecondaryClassifications

TemplateCategory

Element to Usefor Adjustments

Element InputValues to Use forAdjustments

Standard Earnings

All

Standard

Base element

Pay Value

SupplementalEarnings

All

Standard

Base element

Pay Value



80



TemplateCategory



Direct Payments

All

Standard

Base element

Pay Value

Employee TaxCredits

All

Standard

Results

Pay Value,Accrued, Arrear,Not Taken

Employer Charges

All

Standard

Results


Employer Taxes

All

Standard

Results


InvoluntaryDeductions

All

InvoluntaryDeduction

Results

DeductionsCalculated


All


Maintenance

Amount Accrued,Not TakenAmount, ArrearsAmount


All


Processing FeeResults

Fee Calculated,Initial FeeCalculated


All


Organization FeeResults

Fee Calculated


All


Person FeeResults

Fee Calculated

Pre-StatutoryDeductions

All

Standard

Results




81



TemplateCategory



Pre-StatutoryDeductions

Pre-StatutoryDeductions Pension Plan Pre-Statutory

Benefit

EmployeeContributions EmployerContributions AdditionalContributions

ContributionAmount

Taxable Benefits

All

Standard

Base element

Pay Value

VoluntaryDeductions

All

Standard

Results

Pay Value,Accrued, NotTaken

VoluntaryDeductions

VoluntaryDeductions Pension Plan AfterTax

Benefit

EmployeeContributions EmployerContributions AdditionalContributions

ContributionAmount

The display options for the element and balance depend on the date you specify and the employment level associated to theelement. For example, the balances available on the Manage Balance Adjustment page display only balances processed inthe payroll run for the selected level of the employment hierarchy.

Input Values to AdjustAdjust the appropriate input values required to adjust the balance. For example, you might enter a different start date for apension plan element, or geography values for an earnings element. If you adjust an element processed in a payroll period,input values that you skip use the values from the original entry.

When to Pay RefundsSome balance adjustments result in refunds that you process when calculating payroll. For example, when you adjust abalance, such as a tax that increases or decreases the amount owed, the balance is adjusted in the next payroll calculationfor the person. If you adjust an input value that results in a refund, a payment is due to the person.

To pay the adjustment:

1. Select the option to include the adjustment in the payment balance on the Costing and Payment details section onthe Adjust Individual Balances page.

2. Pay the refund by one of these methods:

◦ Process the payment in the next payroll run.



82

◦ Submit the Calculate Prepayments process to pick up the adjustment amount, and pay it as an externalpayment.

When to Cost AdjustmentsConsider costing adjustments if you calculate payroll. As a guideline, if you cost the original balance and the adjustmentchanges the amount or account number, you cost the adjustment. To cost the adjustment, select the option to include theadjustment in the costing process on the Costing and Payment details section on the Adjust Individual Balances page.

The following table shows two examples.

Adjustment Cost the Adjustment Explanation

An earnings element or pretaxdeduction

Yes

You cost the original balanceand the adjusted balance affectsquarterly wage and tax reportingrequirements.

An incorrect value of an initializedbalance

No

Typically the cost of the balancewas entered correctly in theprevious application.

Reporting Balance AdjustmentsReports that you submit after you calculate the payroll include balance adjustments if the effective date of the balanceadjustment falls in the date range you specify for the report submission parameters. For example, you might submit theGross-to-Net report to view the results in the current payroll run. Or, you can submit the Payroll Activity to view balanceadjustments before archiving year-end run results.

NoteIf you submit year-end reports, perform your balance adjustments before archiving the year-end payroll runresults.

Adjusting Balances: Worked ExampleThis example demonstrates how to adjust an individual balance for an employee whose initial balance was loaded incorrectly.

The following table summarizes the key decisions for this scenario.


What effective date should I use for the adjustment?

June 30, 2013 This is the date the initial balance was loaded.

Do I adjust the base or results element?

Results element

Do I owe the person a refund? No



83


Does the balance adjustment require costing?

No

Your enterprise initialized balances during a mid-year implementation on June 30. The initial balance included a life insurancededuction for Marie Kleim for 200 USD, instead of 300 USD. In the monthly payroll on July 31, Marie's payroll run resultsincluded a 50 USD deduction for her life insurance, which brings the year-to-date total to 250 USD. Marie received her July31 payment, so it's not practical to roll back the run result to correct the underlying entry. Also, the balance adjustment to herlife insurance deduction doesn't affect her taxable wages. You correct the balance by submitting an adjustment of 100 USDfor Marie's life insurance deduction.

Adjusting an Individual Balance

1. From the Payroll Calculations work area, select Adjust Individual Balances

2. Search for and display Marie Kleim's record.

3. On the Manage Person Details page in the Adjust Individual Balances Element Details section, complete the fieldsas shown in this table. Use the default values except as indicated in this table.

Field Value

Effective Date

June 30, 2013

Element Name

Life Insurance Results

Assignment Number

E33312345

4. In the Adjustment Values section, enter 100 USD for the Pay Value.

In this example, the results element for the pretax deduction uses the pay value as the calculated value.

5. In the Costing and Payment Details section, enter No for both questions.

You don't owe a refund, because the person's net pay doesn't change. You don't cost the adjustment, becausethe costing for the deduction was processed in the previous application before the mid-year implementationoccurred.

Reviewing the Balance AdjustmentAfter completing the balance adjustment, you can review Marie's balance adjustment.

1. From the Payroll Calculation work area, select View Person Process Results.

2. On the View Person Process Results page, search for Marie Kleim's balance adjustment, processed July 31, 2013.

3. Click the link for Marie's record in the Search Results section.



84

4. On the View Person Process Results page, click the arrow to display the Balance Results section.

5. In the Search Balances section, complete the search criteria as shown in the table.

Field Value

Search Criteria

Balance Group

Balance Group

Pretax Deductions for Statement of Earnings

The Search Results display the run result for the balance adjustment of 100 USD. When you later submit the August31 monthly payroll run, the run results for Marie's new balance for the life insurance deduction display 400 USD,which includes the balance adjustment of 100 USD and the August 31 payroll deduction of 50 USD.

Related Topics

• Viewing and Verifying Payroll Run Results: Points to Consider

• When do I cost a payroll balance adjustment

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=BF78CFED856DF601E040D30A68811218

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=A5DD4A63F80BED7CE040D30A688116A1


Chapter 11Payroll Batch Loader Workbooks

85

11 Payroll Batch Loader Workbooks

Workbook for Payroll DefinitionsImport payroll definitions using the Batch Loader task in the Payroll Administration work area. You enter the data in integratedMicrosoft Excel workbooks, save it to the staging tables, and then transfer the data into the application. This topic explainsthe tasks you can add to the workbook and the columns you complete for each task.

Using the payroll batch loader, you can create, update, or delete multiple payroll definitions for multiple legislative data groupsat the same time. This table describes the batch upload tasks that manage payroll definitions.

Task Name Purpose

Create Payroll Definition

Create a payroll definition and generate a schedule ofpayroll periods based on the specified dates, periodtype, and number of years.

Update Payroll Definition

Update an existing payroll definition, for example, toextend the number of years or change the associatedledger.

Delete Payroll Definition

Delete an unused payroll definition.

Note You can't delete a payroll definition that isyou associated with a person or that youused in a payroll run.

Columns for Create Payroll DefinitionsCreating payroll definitions using the batch loader supports only dynamic date generation for payroll periods based on thecalculation rules you specify in the workbook.

To specify calculation rules for dates:

1. Load rules for calculating the dates for payroll cycle events, such as date earned and payslip availability date.

2. For each date, you define the rules by specifying number of days (calendar or work days) before or after a basedate.

Column Required Comments

Line Sequence

Yes

NUMBER



86


Enter 1 for the first row andcontinue sequentially forsubsequent rows.


Yes

VARCHAR2(240) Name of the existing legislative datagroup in which to create the payrolldefinition. Legislative group names are case-sensitive. Enter the name exactly.

Effective As-of Date

Yes

DATE The first date that processescan use the payroll definition foremployee data. Use a date onor before the earliest date of anyhistorical data you load. Must be in the format YYYY-MM-DD.

Name

Yes

VARCHAR2(80) Name of the payroll definition tocreate. Payroll definition namesare case-sensitive. Enter the nameexactly.

Consolidation Group

Yes

VARCHAR2(60) Name of the existing consolidationgroup in the specified legislativedata group to use for the payrolldefinition. Consolidation group names arecase-sensitive. Enter the nameexactly.



87


Period Type

Yes

VARCHAR2(30) Frequency of the payroll cycle forthe payroll definition. Valid valuesare Annually, Bimonthly, Biweekly,Monthly Calendar, MonthlyLunar, Quarterly, Semiannually,Semimonthly, and Weekly. Use the Manage Common Lookupstask to see the lookup meanings forthe PAY_ PROC_ PERIOD_TYPElookup type. Period types are case-sensitive.Enter the period type exactly.

First Period End Date

Yes

DATE Last date in the first payroll periodduring which the payroll is availablefor processing. Must be in theformat YYYY-MM-DD.

Tip For semimonthly payrolldefinitions, the first periodend date is typically the15th of the month.

Number of Years

Yes

INTEGER(5) Number of years of time periodsto generate starting from thebeginning of the first period. Valid values are 1 through 10.

Payroll Run Days

Yes

NUMBER(2) Number of days that the payroll runfalls before or after the base date.Valid values are 0 through 99.



88


Date Earned Days

Yes

NUMBER(2) Number of days that date earnedfalls before or after the base date.Valid values are 0 through 99.

Date Paid Days

Yes

NUMBER(2) Number of days that date paid fallsbefore or after the base date. Validvalues are 0 through 99.

Payslip Availability Days

Yes

NUMBER(2) Number of days that payslipavailability falls before or afterthe base date. Valid values are 0through 99.

Cutoff Days

Yes

NUMBER(2) Number of days that the cutoff datefalls before or after the base date.Valid values are 0 through 99.

Payslip Available Before or AfterBase Date

No

VARCHAR2(1) Indicates whether the payslipavailability date should fall on, after,or before the base date for thepayroll cycle event. Valid values are case-sensitive,either A (after), B (before), or O (on).Use the Manage Common Lookupstask to see the lookup codes forthe PAY_ DATE_OFFSET lookuptype.



89


Payroll Run Before or After BaseDate

Yes

VARCHAR2(1) Indicates whether the payroll runshould fall on, after, or before thebase date for the payroll cycleevent. Valid values are case-sensitive,either A (after), B (before), or O (on).Use the Manage Common Lookupstask to see the lookup codes forthe PAY_ DATE_OFFSET lookuptype.

Cutoff Before or After Base Date

Yes

VARCHAR2(1) Indicates whether the cutoff dateshould fall on, after, or before thebase date for the payroll cycleevent. Valid values are case-sensitive,either A (after), B (before), or O (on).Use the Manage Common Lookupstask to see the lookup codes forthe PAY_ DATE_OFFSET lookuptype.

Date Paid Before or After BaseDate

Yes

VARCHAR2(1) Indicates whether date paid shouldfall on, after, or before the basedate for the payroll cycle event. Valid values are case-sensitive,either A (after), B (before), or O (on).Use the Manage Common Lookupstask to see the lookup codes forthe PAY_ DATE_OFFSET lookuptype.



90


Date Paid Day Type

Yes

VARCHAR2(1) Type of days used to calculatepayroll cycle event dates, such ascalendar days or work days. Valid values are case-sensitive,either C (calendar days) or W (workdays). Use the Manage CommonLookups task to see the lookupcodes for the PAY_ BASE_OFFSETlookup type.

Payslip Availability Day Type

Yes


Cutoff Day Type

Yes




91


Payroll Run Date Day type

Yes


Date Earned Day Type

Yes


Payslip Availability Base Date

Yes

VARCHAR2(1) Date used as the basis forscheduling when workers can viewtheir payslips. Valid values are case-sensitive,either E (period end date) orS (period start date). Use theManage Common Lookups taskto see the lookup codes for thePAY_BASE_DATE lookup type.



92


Cutoff Base Date

Yes

VARCHAR2(1) Date used as the basis forscheduling the final date forentering payroll information in thepayroll period. Valid values are case-sensitive,either E (period end date) orS (period start date). Use theManage Common Lookups taskto see the lookup codes for thePAY_BASE_DATE lookup type.

Payroll Run Date Base Date

Yes

VARCHAR2(1) Date used as the basis forscheduling the date used by payrollcalculation processes to retrieveeffective values, such as employeedetails. Valid values are case-sensitive,either E (period end date) orS (period start date). Use theManage Common Lookups taskto see the lookup codes for thePAY_BASE_DATE lookup type.

Date Earned Base Date

Yes

VARCHAR2(1) Date used as the basis forscheduling the date on which theapplication processes elemententries for the payroll run. Valid values are case-sensitive,either E (period end date) orS (period start date). Use theManage Common Lookups taskto see the lookup codes for thePAY_BASE_DATE lookup type.



93


Date Paid Base Date

Yes

VARCHAR2(1) Date used as a basis for schedulingthe date the application marksemployee records as paid. Valid values are case-sensitive,either E (period end date) orS (period start date). Use theManage Common Lookups taskto see the lookup codes for thePAY_BASE_DATE lookup type.

Allow Negative Payments

No

VARCHAR2(80) Whether the prepayments processcan include negative payments. Valid values are case-sensitive,either Yes or No. Use the ManageCommon Lookups task to see thelookup meanings for the YES_NOlookup type.

Ledger

No

VARCHAR2(30) Name of general ledger used tocost entries for the payroll runresults in the legislative data group. Ledger names are case-sensitive.Enter the ledger name exactly toensure the association with theledger is correct. The batch uploadand transfer processes don'tperform validation on this value.

Default Payment Method

No

VARCHAR2(80) Name of a payment methodalready defined in the organizationpayment method to use for workerswith no personal payment methodsdefined.

Columns for Update Payroll DefinitionsThe Update Payroll Definitions task workbook uses the following columns to update existing payroll definitions.



94


Line Sequence

Yes

NUMBEREnter 1 for the first row andcontinue sequentially forsubsequent rows.


Yes

VARCHAR2(80) Name of the existing legislative datagroup for the payroll definition toupdate.

Effective Start Date

Yes

DATE Effective start date of the payrolldefinition to update. Must be in theformat YYYY-MM-DD.

Effective End Date

Yes

DATE The end date of the payrolldefinition to update. Must be in theformat YYYY-MM-DD.

Name

Yes

VARCHAR2(30) Name of the payroll definition toupdate for the specified legislativedata group. Payroll definition names are case-sensitive. Enter the name exactly.

Ledger

No

VARCHAR2(30) Name of the general ledger usedto cost entries for the payroll runresults in the specified legislativedata group. Ledger names are case-sensitive.Enter the ledger name exactly.



95


Number of Years

No

INTEGER(5) Incremental number of years oftime periods to generate startingfrom the beginning of the firstpayroll period. Valid values are 1 through 10.

Allow Negative Payments

No

VARCHAR2(80) Whether the prepayments processcan include negative payments. Valid values are case-sensitive,either Yes or No. Use the ManageCommon Lookups task to see thelookup meanings for the YES_NOlookup type.

Columns for Delete Payroll DefinitionThe Delete Payroll Definition task workbook uses the following columns.


Line Sequence

Yes



Yes

VARCHAR2(80) Name of the existing legislative datagroup for the payroll definition todelete.


Yes

DATE Effective start date of the payrolldefinition to delete. Must be in theformat YYYY-MM-DD.

Effective End Date

Yes

DATE End date of the payroll definitionto delete. Must be in the formatYYYY-MM-DD.



96


Name

Yes

VARCHAR2(80) Name of the existing payrolldefinition to delete for the specifiedlegislative data group. Payroll definition names are case-sensitive. Enter the name exactly.

Related Topics

• Payroll Definitions: Explained

Workbook for Payroll RelationshipsImport payroll assignment information using the Batch Loader task in the Payroll Administration work area. You enter the datain integrated Microsoft Excel workbooks, save it to the staging tables, then transfer the data into the application. This topicexplains the tasks you can add to the workbook and the columns you complete for each task.

This table explains the tasks that you can add to the workbook to manage the assigned payrolls for workers.

Task Name Purpose

Add Payroll

Assign an existing payroll to an employee

End Payroll

End-date an assigned payroll and update the elementduration dates.

Columns for Add PayrollThe Add Payroll task workbook uses the following columns to assign existing payrolls to employees.


Line Sequence

Yes


Assignment Number Yes NUMBER(18)

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=B48ED9A7B38831B4E040D30A688101BC



97


The terms or assignment numberof the employee. Must begin witheither of the following uppercaseletters:

• E (for assignment)

• ET (for terms)

Payroll

Yes

VARCHAR2(80) Name of the payroll to assign to theemployee. Payroll definition names are case-sensitive. Enter the name exactly.


Yes

DATE The first date the payroll is availablefor the employee. Must be on orbefore the earliest date of anyhistorical data you load for theemployee.

Columns for End PayrollThe End Payroll task workbook uses the following columns.


Line Sequence

Yes


Assignment Number

Yes

NUMBER(18)The existing terms or assignmentnumber of the employee. Mustbegin with either of the followinguppercase letters:

• E (for assignment)

• ET (for terms)

Payroll

Yes

VARCHAR2(80)



98


Name of the payroll to remove fromthe payroll relationship. Payroll definition names are case-sensitive. Enter the name exactly.


Yes

DATE The end date of the assignedpayroll.

Workbooks for Bank DataImport bank data using the Batch Loader task in the Payroll Administration work area. You enter the data in integratedMicrosoft Excel workbooks, save it to the staging tables, then transfer the data into the application. This topic explains thetasks you can add to the workbook and the columns you complete for each task.

This table explains the four tasks that you can add to the workbook that load bank information.

Task Name Purpose

Create Bank

Create a bank name and optional bank code, making itavailable when creating bank branches.

Create Bank Branch

Create a branch of an existing bank. Branch dataincludes name, number, and identifiers for electronicfunds transfer (EFT) payments.

Create External Bank Account

Create a bank account, based on an existing bank andbranch, to use in personal payment methods.

Restriction You can't create bank account numbers ofsource accounts for payments to workersusing this task.



99

Task Name Purpose

Create Personal Payment Method

Create personal payment methods details, such asallocation of EFT payments to a worker.

Tip To create personal payment details forexternal payees, use the Manage Third-Party Payment Methods task in the PaymentDistribution work area. The batch loaderdoesn't include a task to manage paymentsto third parties.

These four tasks have interdependencies. Create separate workbooks for each task, for each legislative data group whereyou add bank information, to preserve the data dependency. For example, you can first create multiple banks in oneworkbook, and then create all of the branches in the next workbook, and so on.

Bank ColumnsThe Create Bank task workbook uses the following columns to create a bank name and optional bank code identifier.


Line Sequence

Yes


Bank Name

Yes

VARCHAR2(1440) Name of the bank to create.

Important Ensure that no with thesame name exists inyour database and thatyou follow all namingconventions.

Bank Number

No

VARCHAR2(400) Bank number of bank to create.Bank number validation variesdepending on country-specificrules.



100

Bank Branch ColumnsThe Create Bank Branch task workbook uses the following columns to create branch information for a specified bank name.


Line Sequence

Yes


Bank Name

Yes

VARCHAR2(1440) Name of the existing bank for thebranch to create. Bank names are case-sensitive.Enter the name exactly.

Bank Branch Name

Yes

VARCHAR2(1440) Name of branch to create. Mustbe unique for the bank name andlegislative data group that youselect in the batch header.

Bank Branch Number

Yes

VARCHAR2(120) Branch number of branch tocreate. Must be unique for the bankname and legislative data groupthat you select in the batch header. Branch number validation variesdepending on country-specificrules. For example, in Australia, thecombined value of bank numberand branch number must notexceed six numbers.

BIC/SWIFT Code

No

VARCHAR2(120) Bank identifier code or SWIFT codethat identifies bank and branchinformation for payments betweentwo financial institutions.



101

External Bank Account ColumnsThe Create External Bank Account task workbook uses the following columns to create bank accounts, based on existingbanks and branches. After you create external bank accounts, you can use them in personal payment methods for workersand third-party payees.


Line Sequence

Yes


Bank Name

Yes

VARCHAR2(1440) Name of existing bank. Banknames are case-sensitive. Enter thename exactly.

Bank Branch Name

Yes

VARCHAR2(1440) Name of existing branch. Branchnames are case-sensitive. Enter thename exactly.

Bank Account Number

Yes

NUMBER(18) The bank account number toreceive EFT payments.

IBAN

No

VARCHAR2(200) International bank account numberconforming to the ISO standard foruniquely identifying a bank accountfor payments between banks. Forsome legislations only.



102


Account Type

No

CHAR(32)Based on values in theAR_IREC_BANK_ACCOUNT_TYPESlookup table. Valid values are:

• CHECKING

• MONEYMRKT

• SAVINGS

• UNKNOWN

Secondary Account Reference

No

VARCHAR2(120) Usage varies by legislation, forexample, Building Society Numberin the UK.

Account Name

No

VARCHAR2(1440) Label used to identify bank accountwhen there are multiple accounts,for example, Checking or Savings.

Person Number

Yes

NUMBER(18) Payroll relationship ID or third-partypayee ID of an existing person witha corresponding TCA party.

Personal Payment Method ColumnsThe Create Personal Payment Methods task workbook uses the following columns to set up payment details for individualworkers, such as allocations of EFT payments. To create personal payment details for external payees instead of workers,use the Manage Third-Party Payment Methods task from the Payment Distribution work area.


Line Sequence

Yes




103



Yes

DATE The first date the payment methodis available for use. Must be in theformat YYYY-MM-DD.

Name

Yes

VARCHAR2(250) Name of the payment method tocreate.

Payroll Relationship Number

Yes

NUMBER(18) Existing payroll relationship IDthat identifies the person whosepayment information you want tocreate.

Amount

No

NUMBER If you select Amount as thepayment amount type, the amountvalue.

Priority

Yes

NUMBER(18) When multiple payment methodsexist for a person, priority identifieswhich payment method to processfirst.

Organization Payment Method

Yes

NUMBER(18) The existing ID of the organizationpayment method for the worker'spayroll. If you also provide bankaccount information, this valuemust be the ID of an EFT method.The upload fails if you use the ID ofanother method, such as check orcash.

Percentage

No

NUMBER(22) If you select Percentage asthe payment amount type, thepercentage value.



104


Payment Amount Type

Yes

VARCHAR2(30) Determines whether to use theAmount or Percentage columnsto specify how much is paid. Validvalues are Amount or Percentage.

Bank Account Number

Yes

NUMBER(18) The existing bank account numberto receive EFT payments.

Workbooks for GlobalsImport globals using the Batch Loader task in the Payroll Administration work area. You enter the data in integrated MicrosoftExcel workbooks, save it to the staging tables, and then transfer the data into the application. This topic explains the tasksyou can add to the workbook and the columns you complete for each task.

Globals are used to store values that are constant over a period of time and may be referenced in formulas, such as the nameof a rate, a specific date, or a company terms.

This table explains the task that you can add to the workbook to create global values.

Task Name Task Action Purpose

Fast Formula Global

Create

Create global values for referencein fast formulas.

Columns for Create GlobalsThe Create task workbook uses the following columns to create global values.


Line Sequence

Yes



Yes

DATE Effective start date of the globalvalue definition. Must be in theYYYY-MM-DD format.



105


Effective End Date

Yes

DATE Effective end date of the globalvalue definition. Must be in theYYYY-MM-DD format.

Value

Yes

VARCHAR2(240) Value corresponding to the globalthat is defined by the customer.

Data Type

Yes

VARCHAR2(1) Type of data used to create thefast formula definition. Data typesinclude date, number and string.Accepts values like N for Numberand so on.

Name

Yes

VARCHAR2 Name of the global value definition.Definition names are case-sensitive.Ensure that you enter the nameexactly.


No

VARCHAR2(240) Name of the existing legislative datagroup used to create a global valuedefinition. Legislative group namesare case-sensitive. Make sure thatyou enter the name exactly.

Related Topics• Importing Data Using the Payroll Batch Loader: Procedure

Workbooks for User-Defined TablesImport user-defined columns, rows, tables, and column instances using the Batch Loader task in the Payroll Administrationwork area. You enter the data in integrated Microsoft Excel workbooks, save it to the staging tables, and then transfer thedata into the application. This topic explains the tasks you can add to the workbook and the columns you complete for eachtask.

This table explains the tasks that you can add to the workbook.



106


HCM User-Defined Table

Create Table

Create a structure of rows andcolumns to maintain lists of valuesfor use in the application.


Create Column

Create user-defined columns tostore values for various types ofoperations. This action adds acolumn to an existing table.


Create User-Defined Row

Create user-defined rows tomaintain values that are stored intables. This action adds rows to anexisting table.


Create Column Instance

Create user-defined instances ofcolumns to uniquely identify andstore values used in the application.

This table explains the tasks that you can add to the workbook to update user-defined columns, rows, tables, and columninstances.



Update Table

Update a structure of rows andcolumns to maintain lists of valuesfor use in the application.


Update Column

Update user-defined columns tostore values for various types ofoperations.


Update Row

Update user-defined rows tomaintain values that are stored intables.


Update Column Instance

Update user-defined instances ofcolumns to uniquely identify andstore values used in the application.

Columns for Create User-Defined TableThe Create User-Defined Table task workbook uses the following columns.



107


Line Sequence

Yes



Yes

VARCHAR2(240) Name of the existing legislative datagroup used to create the payrolldefinition. Legislative group namesare case-sensitive. Make sure thatyou enter the name exactly.

User-Defined Row Title

No

VARCHAR2(80) Name that refers to the values inthe row.

User-Defined Table Name

Yes

VARCHAR2(80) Name of the user-defined table.Ensure that you enter the nameexactly. The table should be a validuser table defined in the system forthe given LDG.

Range Or Match

Yes

VARCHAR2(30) Indicates the type of table: either Rfor Range and M for Match. The lookup type table behindthis row is: FF_ USER_ TABLE_RANGE_ OR_MATCH.

User Key Units

Yes

VARCHAR2(30) Indicates what data type will besupported by the table: N forNumber, D for Date, and T for Text.

Note N is supported for Rangetype tables. All data typesare supported for Matchtype tables.



108

Columns for Create User-Defined ColumnThe Create User-Defined Column task workbook uses the following columns to create columns that can be referenced informulas or used in the user interface.

NoteThis action is adding a column to an existing table.


Line Sequence

Yes



Yes



Yes

VARCHAR2(80) The name of the user-defined tablethat you are uploading.

Data Type

No

VARCHAR2(1) If the type of user-defined table isRange, then the column data typecan only be N for Numeric. If thetable is another type, use N forNumeric, T for Text, or D for Date.

Formula Effective Date

No

DATE The first date the data can be used.Must be on or before the earliestdate of any historical data to load.Must be in the YYYY-MM-DDformat.

Formula Name

No

VARCHAR2(80) The name of the formula you areuploading.



109


Note The formula name shouldbe both a valid compiledformula and a User TableValidation formula type.

User-Defined Column Name

Yes

VARCHAR2(80) The name of the column you aredefining.

Columns for Create User-Defined RowThe Create User-Defined Row task workbook uses the following columns.


Line Sequence

Yes


Match Value Or Low Range Value

No

VARCHAR2(80) This is a single attribute whichcaptures the low range of the rowwhen the type of user-defined tableis Range. If the type of user definedtable is Match, the value you entermust be an exact match.


Yes



Yes

VARCHAR2(80) User provided table name for whichyou want to create user rows. Usethe same name you provided whenyou created the user-defined table.



110


High Range

No

VARCHAR2(80) High range of the row in caseswhere the type of user-definedtable is Range. For Match typetables, this column can be leftblank.

Sequence

No

NUMBER(5) Number to indicate where the rowshould appear sequentially in thetable.

Row Name

Yes

VARCHAR2(80) Name of the row, which uniquelydefines a row. Ensure that youenter the name exactly.

Note The row name shouldalways be equal to the rowlow range or name duringcreation of the user row tomaintain uniqueness of therow.


No

DATE Effective start date of the row. Mustbe in the YYYY-MM-DD format.

Note If left empty, the systemwill, by default, use thecurrent system date asthe .



111


Effective End Date

No

DATE Effective end date of the row. Mustbe in the YYYY-MM-DD format.

Note If left empty, the systemwill, by default, use the endof time as the effective enddate.

Columns for Create User-Defined Column InstanceThe Create User-Defined Column Instance task workbook uses the following columns.


Line Sequence

Yes



Yes


Note The LDG should be samefor the user table, user rowand user column.



112



Yes

VARCHAR2(80) Name of the user-defined table forwhich you want to create a columninstance. Provide the same namethat you used when you createdthe table.

Note The name should be a validuser table that is definedin the system for the givenLDG.

Row Name

Yes

VARCHAR2(80) Name of the row for which youwant to create a column instance.Ensure that you enter the nameexactly.

Note The row name should bea valid user row that isdefined in the user table.


Yes

VARCHAR2(80) Name of the column for which youwant to create a column instance.Ensure that you enter the nameexactly.

Note Column names should bea valid user column that isdefined in the user table.



113



No

DATE Date on which the user columninstance will take effect. If thiscolumn is left empty, the systemwill, by default, use the currentsystem date as the effective startdate. Must be in the YYYY-MM-DDformat.

Effective End Date

No

DATE Date on which the user columninstance will be end dated. If thiscolumn is left empty, the systemwill, by default, use the end of timeas the effective end date. Must be in the YYYY-MM-DDformat.

Value

No

VARCHAR2(255) Value that can be referenced in aformula or in the user interface.

Columns for Update User-Defined TableThe Update User-Defined Table task workbook uses the following columns.


Line Sequence

Yes



Yes


User-Defined Table Name Yes VARCHAR2(80)



114


Name of the user-defined table.Ensure that you enter the nameexactly.

User-Defined Row Title

No

VARCHAR2(80) Name that refers to the values inthe row. Ensure that you enter thename exactly.

Columns for Update User-Defined ColumnThe Update User-Defined Column task workbook uses the following columns


Line Sequence

Yes



Yes



Yes

VARCHAR2(80) The name of the user-defined tablethat you are uploading to updatethe user column.


Yes

VARCHAR2(80) Name of the user-defined columnfor which you want to update therecord. Ensure that you enter thename exactly.

Formula Effective Date

No

DATE The first date the data can be used.Must be on or before the earliest



115


date of any historical data to load.Must be in the YYYY-MM-DDformat.

Formula Name

No

VARCHAR2(80) Name of the new formula used tovalidate the values of the column.The formula should be effectivedated. The formula effective date istaken into consideration when thecolumn is updated.

Note You can use any compiledformula of formula typeUser Table Validation.This is the only supportedattribute that you can useto update user columns.

Columns for Update User-Defined RowThe Update User-Defined Row task workbook uses the following columns.


Line Sequence

Yes



Yes



Yes

VARCHAR2(80) Name of the user-defined table forwhich you want to update a userrow. Use the same name that youprovided when you created theuser-defined table.



116


Ensure that you enter the nameexactly.

Row Name

Yes

VARCHAR2(80) Unique identifier which youprovided during row creation. Youcannot update this column.


Yes

DATE Effective start date of the row thatyou want to update. This dateshould exactly match the effectivestart date of the user row and be inthe YYYY-MM-DD format. The effective date is required touniquely identify the row. Theupdate operation will correct therecord.

Effective End Date

Yes

DATE Effective end date of the row thatyou want to update. This dateshould exactly match the effectiveend date of the user row and be inthe YYYY-MM-DD format. The effective date is required touniquely identify the row. Theupdate operation will correct therecord.

Match Value Or Low Range Value

No

VARCHAR2(80) New low range or name that youwant to update. You can updatethe value. If you want to keep itsame, provide the same value thatis present in the database.



117


High Range

No

VARCHAR2(80) New high range that you want toupdate. You can update the value.If you want to keep it same, providethe same value that is present inthe database.

Sequence

No

NUMBER New sequence number to indicatewhere the row should appearsequentially in the table. You can update the value. If youwant to keep it same, provide thesame value that is present in thedatabase.

Columns for Update User-Defined Column InstanceThe Update User-Defined Column Instance task workbook uses the following columns.


Line Sequence

Yes



Yes




118



Yes

VARCHAR2(80) Name of the user-defined table ofthe column instance that you wantto update. Ensure that you enterthe name exactly.

Note The user-defined tableshould be valid andcorrespond to the usercolumn.


Yes

VARCHAR2(80) The user column name for whichyou want to update the columninstance.

Row Name

Yes

VARCHAR2(80) Name of the row of the columninstance that you want to update.Ensure that you enter the properrow name for which you want toedit the column instance value.


Yes

DATE Effective start date of the of thecolumn instance that you want toupdate. This date should exactlymatch the effective start date ofthe column instance and be in theYYYY-MM-DD format. The effective date is required touniquely identify the row. Theupdate operation will correct therecord.



119


Effective End Date

Yes

DATE Effective end date of the of thecolumn instance that you want toupdate. This date should exactlymatch the effective end date ofthe column instance and be in theYYYY-MM-DD format. The effective date is required touniquely identify the row. Theupdate operation will correct therecord.

Value

No

VARCHAR2(255) New value that can be referencedin a formula or in the user interface.

Related Topics

• Importing Data Using the Payroll Batch Loader: Procedure

Workbooks for Balance GroupsImport balance groups using the Batch Loader task in the Payroll Administration work area. You enter the data in integratedMicrosoft Excel workbooks, save it to the staging tables, and then transfer the data into the application. This topic explainsthe tasks you can add to the workbook and the columns you complete for each task.

Using the payroll batch loader, you can create, update, or delete multiple balance groups for multiple legislative data groupsat the same time. This table describes the batch upload tasks that manage payroll definitions.


Add a Balance

Add

A balance group represents acollection of defined balances,which can be used to retrievebalance values for reporting, pagedisplays, and payroll processes.

Remove a Balance

Remove

Remove an unused balance groupdefinition.



120

Columns for Add a Defined BalanceThe Add a Defined Balance task workbook uses the following columns to add balance definitions.


Line Sequence

Yes


Attribute Definition

Yes

VARCHAR2(240) Attribute definitions identifyseparate components of acomponent group that are usedin the application or referenced informulas.

Balance Type (Name)

Yes

VARCHAR2(120) Name of the balance. Balancenames are case-sensitive. Ensurethat you enter the name exactly.

Balance Dimension

Yes

VARCHAR2(160) Balance dimensions describe thescope of a balance value, such asthe period of time over which it isaccumulated and whether it relatesto a single assignment, terms, orpayroll relationship.

Columns for Remove a Defined BalanceThe Remove a Defined Balance task workbook uses the following columns to delete an unused balance definition.


Line Sequence

Yes


Attribute Definition

Yes

VARCHAR2(240)



121


Attribute definitions identifyseparate components of acomponent group that are usedin the application or referenced informulas.

Balance Type (Name)

Yes

VARCHAR2(120) Name of the balance. Balancenames are case-sensitive. Ensurethat you enter the name exactly.

Balance Dimension

Yes

VARCHAR2(160) Balance dimensions describe thescope of a balance value, such asthe period of time over which it isaccumulated and whether it relatesto a single assignment, terms, orpayroll relationship.

Related Topics

• Importing Data Using the Payroll Batch Loader: Procedure


Chapter 12Time, Absence, and Pension Data for Payroll

122

12 Time, Absence, and Pension Data for Payroll

OverviewYou can automate the regular import of time card entries, absence entries, and pension enrollments. You use predefinedflows where you specify the interface type and XML file containing the data to load, unless the application pushes the datadirectly to payroll. For example, recording an absence in Oracle Fusion Absence Management automatically transfers the datato payroll.

To meet additional data loading requirements, you can create, update, and delete objects directly in application tables usingweb services. You can find details of the services in Oracle Enterprise Repository (https://fusionappsoer.oracle.com).

This topic covers:

• Loading data options

• Using an XML file to load data

If you're loading data to element entries and not to calculation cards, you can use the payroll batch loader.

Loading Data OptionsThe application you use to record time, absences, and pensions determines options for importing data to payroll, as shown inthe following table.

Source Application Data Load Options

Time card

• For Oracle Fusion Time and Labor, submit theLoad Time Card Batches process.

• For a third-party time application, submit the LoadTime Card Batches process and load an XML file.

• Use the time card web service.

Absences

• For Absence Management, use the ManageAbsence Records task to record an absenceand transfer it directly to the person's absencecalculation card.

NoteWhen you set up the plan in AbsenceManagement, you must select the Transferabsence payment information for payrollprocessing check box. Find this setting inthe Payroll Integration section of the Entriesand Balances tab on the Create AbsencePlan page.



123

Source Application Data Load Options

• For third-party absence applications, submit theLoad Absence Batches process and load an XMLfile.

Pensions

• Submit the Load Benefit Batches process and loadan XML file.

NoteThe availability of this process dependson the implementation for your country orterritory.

Using an XML File to Load DataTo load data by submitting a process to transfer data using an XML file format, you perform the following steps:

1. Extract your data into an XML file, using the required XML file format and tags.

2. Stage the XML file on Oracle WebCenter Content Server.

3. Select the Submit Processes and Reports task and select the appropriate process: Load Time Card Batches, LoadAbsences Batches, or Load Benefits Batches.

4. Select the XML file as an attachment. If necessary, enter the system-defined ID for the Document of Record for theXML file.

5. Optionally, schedule the process to transfer the time card entries, absences, or benefit enrollments to payroll.

6. Submit the process.

When the process completes successfully, it creates or updates a calculation card for each person included in the XML file.Use the Manage Calculation Cards task in the Payroll Calculation work area to view the new entries on the cards.

Related Topics• Creating Element Entries Using the Batch Loader: Worked Example

Setting Up and Processing Time Entries: CriticalChoicesBefore you can process time entries in a payroll run, you complete setup tasks which vary depending on your configuration.For example, if your enterprise requires time cards, you select a Time Card Required field. If you use a third-party timeprovider, you determine which process to use to transfer time entries.

All configurations create elements for time entries and submit a process to create time card calculation components. Thefollowing table describes the remaining setup tasks and processes that vary based on your configuration.



124

Configuration Setup Tasks

Time card required

Indicate a time card is required for workers whose payis calculated using time entries. Inform HR specialists toselect this field when completing the new hire flow.

Oracle Fusion Time and Labor

Determine whether to schedule the process thattransfers time card entries to payroll.

Third-party time provider

Create an extract definition of time entry elements thatincludes the element and mapping IDs. Determine which process to use to transfer time cardentries to payroll.

Third-party payroll provider

Create an extract definition that includes the timeentries.

Review the following sections based on your configuration.

• Requiring time cards

• Using Oracle Fusion Time and Labor

• Using a third-party time provider

• Using a third-party payroll provider

Requiring Time CardsTypically, enterprises that calculate pay based on the reported time require workers to complete time cards. You indicate thisoption with the Time Card Required field. You wouldn't select this field under these circumstances:

• Enterprise has persons, such as salaried employees, who complete time cards, but their time entries aren't used tocalculate their pay. They report time for billing purposes and enter time using project time cards.

• Enterprise doesn't require hourly employees who work a predefined schedule to submit a time card unless they workovertime or are absent for part of the period.

You have two options for where to select the Time Card Required field.

• HR specialists can select the field on the Employment Information page of the new hire flow.

• Payroll managers can select the Manage Payroll Relationship task in the Payroll Calculations or Payroll Administrationwork areas, and complete the information in the Payment Details section of the Manage Person Details page.

The following table shows how the selection of the Time Card Required field determines the hours to process for payrollcalculations based on hours multiplied by rate.

Time Card Required Hours Used in Calculations

Yes

Time card entries



125

Time Card Required Hours Used in Calculations

No

Work schedule, if the hours aren't entered as elemententries

Using Oracle Fusion Time and LaborIf you transfer a high volume of time card entries to payroll, consider scheduling the transfer process. For example, youmight specify a time after normal working hours to distribute the load on the servers, or increase the frequency to cover peakperiods when you expect employees to complete their time cards.

You submit the Load Time Card Batches process flow to validate and transfer new and changed time card entries. Youcan submit the process manually or include it in a payroll flow. When you submit the flow, you can indicate your schedulingpreferences on the Schedule page.

Using a Third-Party Time ProviderYou must complete the following steps to use a third-party time provider to transfer time entries to payroll for payrollcalculation.

1. Create elements for time entry.

2. Submit the Create Time Card Calculation Components flow to create calculation cards components for theelements and mapping IDs.

3. Create an extract of these elements and their mapping IDs for your time provider to use when transferring timeentries to payroll.

4. Decide which process to use to load and transfer a batch of the time card entries.

You have several options for how to load time card entries to payroll, as shown in the following figure.

Determine which option to use based on the best practices for your enterprise. All options create or update existingcalculation cards for each person whose time entries you transfer in the batch.



126

Option Action

Use the Payroll Batch Loader

Submit the Create Batch process from the PayrollAdministration work area to load time card entries.

Submit the Load Time Card Batches Process

Create an XML file as an attachment using the fileformat for transferring a batch of time cards. Submitthe Load Time Card Batches process from the PayrollAdministration or Payroll Checklist work areas to load anXML file.

Call the Time Card Web Service

Pass the time entries to payroll using the time webservice.

Using a Third-Party Payroll ProviderIf you are using Payroll Interface to transfer information to a third-party payroll provider, you can create an extract thatincludes the time card entries. Your payroll provider can then use the time card entry data when processing a payroll.

Related Topics• Scheduling Flows: Explained

• Creating Elements for Time Card Entries: Explained

• Payroll Batch Loader Tasks: Explained

• Creating Extract Definitions for Payroll Interface: Procedure

• Extracting Payroll Data for Third-Party Processing: Worked Example

Validating, Transferring, and Correcting Time Entries:ExplainedMost time card applications and providers apply validation rules when workers submit their time cards, such as a minimumand maximum amount of enterable hours, or rules for overtime entry. When you transfer time card entries to payroll, validationincludes confirming that HR didn't terminate the person and that the person is eligible for the time card element.

Aspects of working with time card entries include:

• Validating time entries

• Transferring time for terminated workers

• Resolving transfer errors

• Viewing time entries

• Correcting time entries

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=DD4337D7D5D1E28DE040D30A68813C3C

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=DDCF356F0F6065D3E040D30A6881657F

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=BF4F40758A9001D8E040D30A68814BAE



127

Validating Time EntriesIf you are using Oracle Fusion Time and Labor, payroll validations occur when the worker saves or submits a time card.After a manager approves the time card, and the status is Submitted and Approved, Time and Labor updates the Ready toTransfer indicator to yes.

When you transfer time card entries to payroll from Oracle Fusion Time and Labor or a third-party supplier, the payrollapplication validates the time card entries to confirm that the worker isn't terminated and is eligible for the element.

Transferring Time for Terminated WorkersTo avoid release of information on planned terminations, several applications, such as Oracle Fusion Time and Labor, hideand ignore the future termination date until it's formally announced. Workers reporting time in Time and Labor can report timeentries beyond their termination date, without any indication that they are ineligible for the time entered. Line managers canview and approve these entries, but the Load Time Card Batches process will reject time card entries beyond the terminationdate.

Resolving Transfer ErrorsIf you use Oracle Fusion Time and Labor, the time entry and calculation rules reduce the likelihood of an error when youtransfer the time entries. Depending on the error, you can take the following steps:

1. Roll back individual records or the entire transfer process in payroll.2. The Time and Labor administrator corrects the cause of the error, and resets the status of the corrected time cards

to Submitted.3. The administrator routes the time card for approval.4. The next time you transfer the time cards using the Load Time Card Batches process, the process retrieves the

corrected time card entries.

If you use a third-party time provider, you can roll back the Load Time Card Batches process, resolve the transfer error withthe time provider, and resubmit the Load Time Card Batches process.

Viewing Time EntriesSubmitting the Load Time Card Batches process from the Payroll Checklist or Payroll Administration work areas:

• Transfers time card entries• Creates or updates a time calculation card for each person included in the batch

You use the Manage Calculation Cards task in the Payroll Calculation work area to view the time entries. There is only onetime calculation card for each payroll relationship. The card includes time entries for multiple assignments for the same payrollrelationship.

Correcting Time EntriesAny updates and corrections must occur in the application used to report time. You can continue to transfer new andupdated time entries to payroll until you calculate the payroll for the period that includes the time entries.

If the payroll run starts and you transfer a late time card entry for that payroll period, process the entries using one of thefollowing methods:

• If several workers submit late time cards, create a payroll relationship group that includes these workers and processa payroll run for the time card entries.

• If only a few workers submit late cards, process the additional time entries separately by submitting the CalculateQuickPay process.

• If the payroll run occurs frequently, you can choose to pay the time card entries in the next payroll run as retroactivepay.



128

The application creates element entries for the adjusted entries, which you can process retroactive pay in the nextpayroll run.

Related Topics• Payroll Batch Loader Tasks: Explained

File Format for Importing Time EntriesWhen you transfer time entries from a third-party provider by submitting the Load Time Card Batches process from thePayroll Checklist or Payroll Administration work areas, you specify the attachment for the XML file. The process creates a newcalculation card or updates an existing card for each worker with time entries included in the batch. When creating the file,use the XML file format and XML tags described in this topic.

XML File Format for Transferring Time EntriesWhen you create a file to transfer time card entries to payroll, use the following structure.

<TIME_CARD_LIST><TIME_CARD>...<ACTION><TIME_CARD_ID><MAPPING_ID><MAPPING_NAME><LDG_ID><LDG_NAME><HR_TERM_ID><TERM_NUMBER><HR_ASSIGNMENT_ID><ASSIGNMENT_NUMBER><LEGAL_EMPLOYER_ID><LEGAL_EMPLOYER_NAME><TIME_CARD_START><TIME_CARD_END><TIME_ITEM_LIST>...<TIME_ITEM><TIME_TYPE>{<PAYMENT_RATE_ID><PAYMENT_RATE_NAME> |<RATE_AMOUNT><PERIODICITY><FACTOR> |<AMOUNT><PERIODICITY>}<TIME_UNIT><TIME_UOM><TIME_ITEM_START><TIME_ITEM_END><COST_SEGMENTS><SEGMENT1..30></COST_SEGMENTS><PROPERTIES_LIST>..<PROPERTY_ITEM><NAME><VALUE></PROPERTY_ITEM></PROPERTIES_LIST></TIME_ITEM></TIME_ITEM_LIST></TIME_CARD>



129

</TIME_CARD_LIST>

XML TagsThis table describes the purpose of the tags used in the XML file.

XML Tag Description

TIME_CARD_LIST

Parent tag that contains a set of time cards.

TIME_CARD

Object that contains the information about a specifictime card.

ACTION

Action to perform, such as CREATE, REMOVE,MODIFY.

TIME_CARD_ID

Unique identifier for this time card.

MAPPING_ID

Identifier for the payroll component definition. Specify the Mapping ID or the Mapping Name. If noneis included, the process uses the default interface typeImport Time XML and attempts to find a mapping.

MAPPING_NAME

Name used for the mapping. Specify the mapping name or the mapping ID. If noneis included, the process uses the default interface typeImport Time XML and attempts to find a mapping.

LDG_NAME

Name of the legislative data group for this record. Specify the identifier or name of the legislative datagroup. The records in the XML file must belong to thesame legislative data group. If you don't include theLDG_ID or the LDG_NAME, the application uses thelegislative data group you entered for the Load TimeCard Batches process.



130

XML Tag Description

LDG_ID

Identifier for the legislative data group for this record. Specify the identifier or name of the legislative datagroup. The records in the XML file must belong to thesame legislative data group. If you don't include theLDG_ID or the LDG_NAME, the application uses thelegislative data group you entered for the Load TimeCard Batches process.

TERM_NUMBER

Number that identifies the employment terms for thetime card.

ASSIGNMENT_ NUMBER

Number that identifies the employment assignment forthe time card.

TIME_ CARD_START

Start date of the time card.

TIME_CARD_END

End date of the time card.

TIME_ITEM_LIST

Tag that contains a set of time items.

TIME_ITEM

Object that contains information about a specific houritem.

TIME_TYPE

Name supplied by the time application that maps to thepayroll element and calculation component.

PAYMENT_ RATE_ID

Identifier for the rate used to calculate the paymentamount.

PAYMENT_ RATE_NAME

Name of the rate used to calculate the payment amount.

RATE_AMOUNT

Actual rate used to calculate the payroll amount.

AMOUNT

Flat amount used to calculate the rate based onperiodicity

PERIODICITY

Frequency that determines the rate value, used withamount or rate amount



131

XML Tag Description

FACTOR

Percentage applied to the rate amount to calculate thepayment amount

TIME_UNIT

Number of units for the hours item, for example 8 hoursis 8 units

TIME_UOM

Unit of measure for specifying time unit, such as hours

TIME_ ITEM_START

Start time for the time item

TIME_ITEM_END

Ending time for the time item.

COST_SEGMENTS

List of the costing segments.

PROPERTY_LIST

Set of properties for the time item.

PROPERTY_ITEM

Additional information that is captured. For example, avalue definition for the property item State would returnState and the name of the State.

NAME

Name of a property for the time item.

VALUE

Value of a property for the time item.

Related Topics• Creating Elements for Time Card Entries: Explained

Transferring Absence Information: ProcedureYou can transfer absence information from Oracle Fusion Absence Management or another absence application to absencecalculation cards for payroll processing. You must complete the required setup in both applications to enable the transfer.You can transfer entitlement, accrual, final disbursement, and discretionary disbursement information..

Transferring absence information to payroll includes the following aspects:

• Creating elements for absence information

• Setting up absence plans

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=DDCF356F0F6065D3E040D30A6881657F



132

• Transferring absence entries

• Processing absence entries in payroll

Creating Elements for Absence InformationTo create elements and associated items:

1. Open the Manage Elements page in the Payroll Calculation or Setup and Maintenance work areas.

2. Create an element with a primary classification of Absences and a category of Absence.

3. Complete the element template for the type of absence plan that the element supports. The element templateprompts you for the type of plan. Your selection determines the questions that you need to answer.

4. Submit the element.

5. On the Element Overview page, create at least one element eligibility record.

6. If you want to process absence entries in Oracle Fusion Global Payroll, create a payroll formula and associate it tothe absence element by creating a status processing rule on the Element Summary page.

Setting Up Absence PlansTo set up absence plans in Oracle Fusion Absence Management:

1. Open the Manage Absence Plans page in the Setup and Maintenance work area.

2. Create absence plans, which can be Accrual, Accrual with Entitlement, or Entitlement plans.

3. Select the Transfer absence payment information for payroll processing check box in the Payroll Integrationsection of the Entries and Balances tab on the Create Absence Plan page.

4. Select the element for the plan in the Element field to provide a link between the absence plan, the element, and thecalculation component shown on workers' calculation cards.

Transferring Absence EntriesWhen an absence is recorded in Oracle Fusion Absence Management, the absence information is automatically transferred tothe worker's absence calculation card.

If you use another absence application, you transfer absence information as follows:

1. Extract your absence data into an XML file, which must use the required file format and XML tags.

2. Stage the file on the Oracle WebCenter Content Server.

3. Select the Submit Processes and Reports task in the Payroll Calculation, Data Exchange, or Payroll Administrationwork areas.

4. Select the Load Absence Batches process. This process transfers absence entries to absence calculation cards,where they can be processed by payroll.

5. Select the XML file as an attachment.

6. Submit the process.

Processing Absence Entries in PayrollYou can process the component details on the absence calculation card in a payroll run.



133

If you use a third-party payroll application, you can create an HCM extract of the absence entries for processing by yourpayroll application.

Related Topics• Creating Payroll Elements for Absence Management: Worked Example

File Format for Importing Absence EntriesWhen you submit the Load Absence Batches process, you specify the attachment for the XML file that contains the absencedata. This topic explains the XML file format and XML tags you must use in the file.

You submit the Load Absence Batches process from the Data Exchange, Payroll Checklist, or Payroll Administration workareas. The process creates a new calculation card or updates an existing card for each worker whose absence information istransferred.

XML File Format for Importing Absence Information to PayrollWhen you create a file to transfer absence information to payroll, use the following format.

<ABSENCE_LIST><ABSENCE><ABSENCE_TYPE><ACTION><ABSENCE_ID><MAPPING_ID><MAPPING_NAME><LDG_ID><LDG_NAME><HR_TERM_ID><TERM_NUMBER><HR_ASSIGNMENT_ID><ASSIGNMENT_NUMBER><ABSENCE_RATE_ID><ABSENCE_RATE_NAME><ABSENCE_UNIT><ABSENCE_UOM><ADJUSTMENT_UNIT><FACTOR><PERIODICITY><ABSENCE_START><ABSENCE_END><ABSENCE_DATE_LIST><ABSENCE_DATE><LEAVE_DATE><ACCRUED_DATE><OVERRIDING_FACTOR><OVERRIDING_RATE_ID><OVERRIDING_RATE_NAME><OVERRIDING_UOM><OVERRIDING_UNIT><\ABSENCE_DATE><\ABSENCE_DATE_LIST><\ABSENCE><\ABSENCE_LIST>


https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=E5276E1723124F79E040D30A688150BC



134

XML Tag Description

ABSENCE_LIST

Outermost tag that contains a set of absences.

ABSENCE

Tag containing information about a particular absence.

ABSENCE_TYPE

Type of absence that is being transferred to payroll,such as accrual, accrual with entitlement, or entitlement.

ACTION

Type of action that will be performed, such as CREATE,REMOVE, and MODIFY.

ABSENCE_ID

Unique identifier for the absence from the sourceapplication. Never use the same ID twice to identifyanother absence.

MAPPING_ID

Identifier for the payroll component definition, which isused to create the absence in payroll.

MAPPING_NAME

Name used for the mapping.

LDG_ID

ID of the legislative data group associated with therecord.

LDG_NAME

Name of the legislative data group associated with therecord.

HR_TERM_ID

Unique ID for the HR Terms. You can provide either the TERM_NUMBER or the HR_TERM_ID. If you provide the TERM_NUMBER then youmust also provide the legal employer details.

TERM_NUMBER

Number that identifies the employment terms for theabsence.

HR_ ASSIGNMENT_ID

This is the HR Assignments unique ID. You can provide either the ASSIGNMENT_ NUMBERor the HR_ ASSIGNMENT_ID. If you provide theASSIGNMENT_ NUMBER then you must also providethe legal employer details.



135

XML Tag Description

ASSIGNMENT_ NUMBER

Number that identifies the employment assignment forthe absence.

ABSENCE_ RATE_ID

Unique identifier for the absence rate.

ABSENCE_ RATE_NAME

Name of the rate used to calculate the payment amount.

ABSENCE_UNIT

Unit of time in which the absence is recorded.

ABSENCE_UOM

Unit of measure being used for the absence (forexample, days, hours or weeks).

ADJUSTMENT_ UNIT

Unit of time in which an adjustment is being made to theabsence.

FACTOR

Factor that is used in the calculation of the absence.

PERIODICITY

Used with the amount or rate, the periodicity is thefrequency that determines the absence rate.

ABSENCE_START

Date the absence started.

ABSENCE_END

Date the absence ended

ABSENCE_ DATE_LIST

List of dates in which the absence occurred.

ABSENCE_DATE

Date the absence is being reported.

LEAVE_DATE

Date on which the leave of absence took place.

ACCRUED_DATE

Date on which the absence was accrued.

OVERRIDING_ FACTOR

Factor that is being used to override the calculation ofthe absence.



136

XML Tag Description

OVERRIDING_ RATE_ID

Unique identifier for the rate being used to override theabsence.

OVERRIDING_ RATE_NAME

Name of the overriding rate that will be used to calculatethe absence.

OVERRIDING_UOM

Unit of measure being used to override the absence (forexample, days, hours or weeks).

OVERRIDING_ UNIT

Unit of time in which an override is being made to theabsence.

Running the Load Benefit Batches Process:ProcedureUse the Load Benefit Batches process to transfer pension deduction information from a benefits application to benefits andpensions calculation cards for payroll processing.

Submitting the ProcessYou can submit the process from the Payroll Checklist or Payroll Administration work areas, or you can add it to a payroll flowpattern so that it runs as part of your regular payroll flow.

To submit the process:

1. Extract your pension data into an XML file, which must use the required file format and XML tags.

2. Stage the file on the Oracle WebCenter Content Server.

3. In the Payroll Checklist or Payroll Administration work areas, click Submit a Process or Report.

4. Select the Load Benefit Batches process and click Next.

5. Enter a name to identify the flow.

6. Select a process date, which is the date on which the transfer process runs.

7. Enter the system-defined ID for the Document of Record for the XML File that contains the pension data.

8. Select a process configuration group if you want to override the default (for example, to collect detailed logginginformation).

9. Click Next until you reach the review page, then click Submit.

Resolving Transfer ErrorsWhen you load a benefits batch, the application validates the entries to confirm that the worker has not been terminated andis eligible for the deduction. The application rejects entries for any date beyond the worker's termination date.



137

If the process ends in error, you can roll it back, resolve the error in the source application, and resubmit the Load BenefitBatches process.

Viewing and Correcting EntriesWhen the process completes successfully, it creates or updates a calculation card for each person included in the XML file.Use the Manage Calculation Cards task in the Payroll Calculation work area to view the new entries on the cards.

You can enter or update the following values on the cards, if required:

• Payee

• Reference Number

• Employee Additional Contribution

The other values are view-only and must be maintained in the source application.

Related Topics• Entering Calculation Values for Pensions: Points to Consider

File Format for Importing Pension DeductionsWhen you submit the Load Benefit Batches process, you specify the attachment for the XML file that contains the benefitdata. This topic explains the XML file format and XML tags you must use in the file. You submit the Load Benefit Batchesprocess from the Payroll Checklist or Payroll Administration work areas. The process creates a new calculation card orupdates an existing card for each worker whose pension information is transferred.

XML File Format for Importing Pension Deductions to PayrollWhen you create a file to transfer pension deduction information to payroll, use the following format.

<BENEFIT LIST><BENEFIT>...<ACTION><BENEFIT_ID><MAPPING_ID><LDG_ID><LDG_NAME>{<HR_TERM_ID><TERM_NUMBER><HR_ASSIGNMENT_ID><ASSIGNMENT_NUMBER>}<LEGAL_EMPLOYER_ID><LEGAL_EMPLOYER_NAME><BENEFIT_START><BENEFIT_END>{<BENEFIT_RATE_ID><BENEFIT_RATE_NAME> |<AMOUNT><PERIODICITY><BENEFIT_MAX_ELECTION><BENEFIT_REF_NUMBER>}</BENEFIT></BENEFIT_LIST>

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=E33ABFE1DF6A51D4E040D30A68812B15



138


XML Tag Description

BENEFIT_LIST

Outermost tag that contains a set of benefits.

BENEFIT

Tag containing information about a particular benefit.

ACTION

The type of action that will be performed, such asCREATE, REMOVE, and MODIFY.

BENEFIT_ID

Unique identifier for the benefit from the sourceapplication. Never use the same ID twice to identifyanother benefit.

MAPPING_ID

Identifier for the payroll component definition, which isused to create the benefit in payroll.

LDG_ID

ID of the legislative data group associated with therecord.

LDG_NAME

Name of the legislative data group associated with therecord.

HR_TERM_ID

Unique ID for the employment terms. You can provide either the TERM_NUMBER or the HR_TERM_ID. If you provide the TERM_NUMBER then youmust also provide the legal employer details.

TERM_NUMBER

Number that identifies the employment terms for thepension deduction.

HR_ ASSIGNMENT_ID

Unique ID for the assignment. You can provide either the ASSIGNMENT_ NUMBERor the HR_ ASSIGNMENT_ID. If you provide theASSIGNMENT_ NUMBER then you must also providethe legal employer details.



139

XML Tag Description

ASSIGNMENT_ NUMBER

Number that identifies the employment assignment forthe pension deduction.

LEGAL_ EMPLOYER_ID

ID of the legal employer name that the term orassignment belongs to.

LEGAL_ EMPLOYER_NAME

Legal employer name that the term or assignmentbelongs to.

BENEFIT_START

Start date of the benefit.

BENEFIT_END

End date of the benefit.

BENEFIT_ RATE_ID

ID of the rate that will be used to calculate the paymentamount.

BENEFIT_ RATE_NAME

Name of the rate that will be used to calculate thepayment amount.

AMOUNT

Amount that is used to calculate the rate using theperiodicity.

PERIODICITY

Used with the amount or rate, the periodicity is thefrequency that determines the rate value.

BENEFIT_ MAX_ELECTION

Annual maximum election amount that can beprocessed.

BENEFIT_ REF_NUMBER

Employee's reference number with the provider of thepension (benefit organization).

FAQs for Time, Absence, and Pension Data for Payroll

Can I correct a time entry in payroll?You can't correct time card entries displayed within the calculation cards. You correct reported time in the time cardapplication and then transfer the time cards to payroll by submitting the Load Time Card Batches process from the PayrollChecklist or Payroll Administration work areas. You can continue correcting and transferring entries until the time entries are



140

processed in the payroll run. If you transfer corrected time entries after the payroll run begins, the Load Time Card Batchesprocess creates retroactive entries that are processed in the next payroll.

What happens if a time card is transferred after the payroll runstarts?The payroll run doesn't process the time card entries. You can process these entries by performing one of the followingactions:

• For the current payroll period, process the entries as an additional payroll run, or submit QuickPay calculations tocalculate and pay the time worked.

• For the next payroll period, process the entries as retroactive pay.

The application creates element entries for the adjusted entries, which are included as retroactive pay in the nextpayroll run.

What happens if time is reported beyond a termination date?Workers can enter time beyond their termination in many time applications, but the Load Time Card Batches process rejectstime card entries for:

• Entries for elements beyond the termination date

• Entries for elements that are end-dated

• Entries where the element eligibility criteria no longer applies

To avoid release of information on planned terminations, several applications, such as Oracle Fusion Time and Labor, hideand ignore the future termination date until it's formally announced. Workers reporting time in Time and Labor can report timeentries beyond their termination date, without any indication that they are ineligible for the time entered. Line managers canview and approve these entries. The Load Time Card Batches process will reject the entries beyond the termination date.

Related Topics

• Terminations: How They Affect Payroll Processing

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=C1D3F552AAAA5C5CE040D30A68813939


Chapter 13Upload Value Set Values Process

141

13 Upload Value Set Values Process

Process OverviewThis process uploads a flat file containing value set values for flexfields. You can use this scheduled process to upload afile containing values you want to edit or add to an existing independent or dependent value set. This process is useful foradding or updating large volumes of value set value data in an automated or recurring fashion. For example, you can uploada hundred values on a recurring basis when scheduled as a recurring process. This method may be more efficient than usingthe one-time Import action in the Manage Value Sets tasks in the Setup and Maintenance work area. However, for an ad hoctask of uploading a hundred values, it may be quicker to use the Import action in the relevant tasks.

Run this process from the Scheduled Processes Overview page. You can run it on a recurring basis whenever the flat file inthe content repository account is updated.

You must create the flat file containing the values data, and upload the flat file to the content repository using the Files forImport and Export page.

ParametersFlat File Name

Enter the name of the flat file you uploaded using the Files for Import and Export page.

Account

Select the user account containing the flat file in the content repository to upload.

Related Topics

• Files for Import and Export: Explained

• Scheduled Processes: Explained

Importing Value Set Values: ProcedureYou can import a file containing values that you want to edit or add to a given independent or dependent value set.

For example, uploading a hundred values may be more efficient than creating them individually using the Manage Value Setstask. However, for just a few values, it may be quicker to perform the relevant tasks.

Importing Value Set ValuesTo import value set values:

1. Create a flat file containing the values in the value set that you want to add or update.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=D081979965B2AA65E040D30A68811A08

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=96D9675F3D4CC07DE040D30A68813CF9



142

Important

◦ When creating the file, you must specify an existing value set code to which you want to add valuesor edit existing values. If the value set does not exist, add the value set using the appropriate ManageValue Sets setup task in the Setup and Maintenance work area.

◦ The file that you create must adhere to the formatting and content requirements for creating flat filescontaining value set values.

2. Upload the flat file to the content repository using the Files for Import and Export page.3. Import the file using the appropriate Manage Value Sets setup task in the Setup and Maintenance work area. To

import the file:a. Click Actions - Import in the Manage Value Sets page.b. In the File Name field, enter the name of the flat file you uploaded using the Files for Import and Export page.c. In the Account field, select the user account containing the flat file.d. Click Upload.

NoteAlternatively, you can import the file using either of the following methods:

◦ Run the Upload Value Set Values scheduled process.

◦ Use the Applications Core Metadata Import web service. For more information on the ApplicationsCore Metadata Import web service, see assets with the ADF Service type in Oracle EnterpriseRepository for Oracle Fusion Applications (http://fusionappsoer.oracle.com).

Related Topics• Files for Import and Export: Explained

Flat-File Requirements: ExplainedYou can import large volumes of value set value data from the content repository. To upload value set values to the contentrepository, create a flat file containing the values in the value set that you want to add or update. You upload these flat files tothe content repository using the Files for Import and Export page.

General RequirementsThe first line of the flat file must contain the column names for the value set value data, including all mandatory columns, andseparated by the '|' (pipe) character. Each subsequent line should contain a row of data specified in the same order as thecolumn names, also separated by the '|' character.

The requirements for creating flat files vary with the type of value sets:

• Independent value sets




143

• Dependent value sets

Independent Value SetA flat file for uploading values for independent value sets must contain the following mandatory columns:

Column Name Data Type

ValueSetCode

VARCHAR2(60)

Value

VARCHAR2(150)

Enabled Flag

VARCHAR2(1), Y or N

NoteYou can also specify optional columns.

Examples:

• To upload values to a COLORS independent value set with the minimum columns, you can use the following flat file:ValueSetCode | Value | EnabledFlagCOLORS | Red | YCOLORS | Orange | YCOLORS | Yellow | Y

• To upload values to a STATES independent value set with more (optional) columns, you can use the following flat file:ValueSetCode | Value | Description | EnabledFlagSTATES | AK | Alaska | YSTATES | CA | California | YSTATES | WA | Washington | Y

Dependent Value SetsA flat file for uploading values for dependent value sets must contain the following mandatory columns:

Column Name Data Type

Value Set Code

VARCHAR2(60)

Independent Value

VARCHAR2(150)

Value

VARCHAR2(150)

Enabled Flag

VARCHAR2(1), Y or N



144

NoteYou can also specify optional columns.

Example:

To upload values to a CITIES dependent value set (dependent on the STATES independent value set), you can use thefollowing flat file:

ValueSetCode | IndependentValue | Value | EnabledFlagSTATES | AK | Juneau | YSTATES | AK | Anchorage | YSTATES | CA | San Francisco | YSTATES | CA | Sacramento | YSTATES | CA | Los Angeles | YSTATES | CA | Oakland | Y

Additional Optional ColumnsIn addition to the mandatory columns, you can add the following optional columns for both dependent and independent valuesets:

Column Name Type

Translated Value

VARCHAR2(150), for use in value sets that aretranslatable

Description

VARCHAR2(240)

Start Date Active

DATE, formatted as YYYY-MM-DD

End Date Active

DATE, formatted as YYYY-MM-DD

Sort Order

NUMBER(18)

Summary Flag

VARCHAR2(30)

Flex Value Attribute1 ... Flex Value Attribute20

VARCHAR2(30)

Custom Value Attribute1 ... Custom Value Attribute10

VARCHAR2(30)

Related Topics

• Files for Import and Export: Explained



Chapter 14HCM Extracts

145

14 HCM Extracts

Managing Extracts

Extract Components: How They Work TogetherThe HCM Extracts feature is a flexible tool for generating data files and reports. This topic covers how you can use the extractcomponents to define what information you want the application to extract and report on. It also explains how the applicationdisplays, formats, and delivers the information.

Extract DefinitionsAn extract definition refers to the complete setup of an extract, that consists of extract data groups, criteria, records,attributes, advanced conditions and output delivery options. An extract definition consists of:

• One or more extract data groups, depending on how many logical entities you want to extract.

• One or more extract records depending on how many groups of information you want to collect.

• One or more attributes depending on how many individual fields of data you want to collect.

You use HCM extracts to extract, archive, transform, report, and deliver high volumes of HCM data from the Fusion HCMdatabase. You can generate the output in the following formats:

• CSV

• XML

• Excel

• HTML

• RTF

• PDF

You can distribute the extracted information by e-mail, fax and other delivery modes. Some common examples of extractsare: PDF payslips delivered to employees' mailboxes, payroll or benefits data transferred to third-party service providers, HRand talent data exchange between Fusion and legacy applications, for example in a coexistence scenario.

Data GroupsExtract data groups represent a business area or logical entity, for example person, assignment, or benefits. The applicationuses this information to retrieve the database item groups. You define one data group as the primary or root data group andthis data group is the starting point of the data extraction.

Extract data group connections capture the association details between the current data group and the parent data group.The data group connections form the hierarchical relationship among the data groups.

You can define a set of filtering conditions the application must perform on an extract data group using the extract data groupcriteria. You specify the criteria conditions using an expression or fast formula.



146

Extract RecordsExtract records represent a grouping of related data or a physical collection of all fields required in the extract. For example,the Employee data group can have records such as Basic Details, Pay Details, Location Details, and Primary Contact. Anextract record is a collection of attributes which you can organize in a required sequence. For example, if a data group has 3records, then you can specify the sequence in which the application processes the records. You can also select the next datagroup to identify which data group the application processes next.

AttributesAttributes are the individual fields inside the extract record. An attribute is the lowest attribute level of a HCM extract andrepresents a piece of information, for example, person first name, person last name or person date of birth.

This figure demonstrates the hierarchy of information within a data group definition.



147

Related Topics

• Generating Flexfield Database Items: Explained

HCM Extract Types: ExplainedThe type of extract you select determines the purpose of the extract. It also determines the parameters that are automaticallygenerated. For example, if you select the Payroll Interface extract type, then the application creates a changes onlyparameter, as well as the other parameters. You can select the extract type on the Manage HCM Extract Definitions page.

This table lists the different extract types and why you select them.

Extract Type Purpose

Full Profile

Use for complete employee and payroll data archives.

Payroll Interface

Use for providing data to third party payroll serviceproviders.

Payments

Use for salary payment method archives. For example,Paid through cheque or bank transfer.

Benefit Carrier

Use for providing data to third party benefits serviceproviders.

Archive Retrieval

Use for reports based on permanently archived data, forexample, payslip.

EOY Archive

Use for end of year archives (HR, Benefits).

HR Archive

Use for all HR archives.

Payroll Archive

Use for all payroll or payslip archives.

Other Payroll Archive

Use for all payroll archives.

Frequently Used User EntitiesA user entity is a logical entity associated with a data group defined using HCM extracts. This topic describes user entitiesrelated to people and payroll, and describes the type of data you can extract by using those user entities. You select userentities in the application when you define a data group.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=E01816674B301ACBE040D30A68815636



148

The following table lists the most frequently used user entities.

User Entity Name and Code Description

Person (PER_ EXT_ SEC_ PERSON_UE)

Retrieves all persons across the enterprise and allperson related attributes.

Worker (PER_ EXT_ SEC_ ASSIGNMENT_ UE)

Retrieves all workers across the enterprise and allperson, worker related attributes. For example,relationship, term and assignment details.

Worker Payroll (PER_ EXT_ PAY_ EMPLOYEES_UE)

Retrieves all workers and their payrolls across theenterprise, all person, worker, payroll related attributes,and element entry data.

This table describes the most frequently used user entities related to person and payroll in HCM extracts.

Related Topics• Generating Flexfield Database Items: Worked Example

Defining an Extract: Worked ExampleThis example demonstrates the steps required to create an extract definition using the Desktop interface. You can access theDesktop interface by clicking the Switch Layout button on the Manage HCM Extract Definitions page.

Before you create an extract definition, you should understand the following details:

• Information that you want to extract

• Structure in which the data must be extracted

• How you want to deliver this data (including file format, delivery mechanism, and frequency information)

FAST bank is a global organization with subsidiaries all over the world. As part of an external business reporting requirement,FAST bank is required to extract the department and employee details (grouped by department) across the entire company.This information must be sent to a third party in an XML file and to HR Managers in a PDF file using e-mail.

The following table summarizes the key decisions in this scenario:


How many extracts do I create to produce this type ofreport?

You create one extract definition to define a headcountreport.

How many data groups do I create?

In this example there are 2 functional groups ofinformation, therefore you create two data groups, onefor department and one for employees.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=E0A3618E7911CC6FE040D30A68811FAB



149


How many records do I create?

You decide the number of records based on thesubgroup of attributes within a data group. In thisexample, you create two records for the departmentdata group:

• Department Details

• Department Summary

You create one record for the employees data group:Employee Details.

How many attributes do I create?

You decide the number of attributes based on thespecific information required for that report. In thisexample, create the following attributes for theDepartment Details record:

• Department Name

• Department Location

For the Department Summary record, create thefollowing attributes:

• Record Code

• Report Date

• Employee Count

For the Employees Details record, create the followingattributes:

• Full Name

• Gender

• Date of Birth

• Salary

• Bonus

• Tax Rate



150


Do I create any fast formulas?

You can use fast formulas at the following levels:

• Extract Criteria level to determine certainconditions.

• Extract Rule level to derive attribute values.

• Extract Advanced Condition level to specifycomplex conditions.

• Extract Record level to automatically generateformulas when you use the Generate Formulaoption.

Creating an Extract Definition1. On the Manage HCM Extract Definitions page click on the Create icon.

2. Use the Switch Layout button to open the extract in the Desktop interface.

3. Enter 01-Jan-2000 as the Session Effective Date.

The session effective date is an effective start date that applies to all date-effective interactions in the currentsession.

4. Enter FAST Bank Extract as the name and select HR Archive as the type. The application automatically creates thetag name based on the extract name and uses this name to generate the XML output file.

5. Click Save and the application saves the extract definition and automatically generates the parameters based onthe type of extract. The parameters control the output of an extract. In this example, the application creates thefollowing parameters:

◦ Effective Date

◦ Legislative Data Group

◦ Parameter Group

◦ Report Category

◦ Request ID

◦ Start Date

Creating Extract Data Groups1. Select the Extract Data Group link from the navigation tree to open the Extract Data Groups region.

2. Click on Create to define a new data group. A data group represents data that belongs to one or more logical dataentities.



151

3. Complete the general fields, as shown in this table:

Field Name Entry

Name

Departments

User Entity

PER_ EXT_ SEC_ ORGANIZATION_ UE

Root Data Group

Yes (By selecting this checkbox you select thisdata group as the starting point for the extractexecution.)

4. Select Save and Create Another to create a data group for Employees.


Field Name Entry

Name

Employees

User Entity

PER_ EXT_ SEC_ ASSIGNMENT_UE

Root Data Group

No

Creating Extract Data Group Connections1. Select Extract Data Group in the navigation tree to display the data groups in a table.

2. Select the Employees Data Group and define the data group connection details.


Field Name Entry

Parent Data Group

Departments

Parent Data Group Database Item

PER_ EXT_ ORG_ ORGANIZATION_ ID

Data Group Database Item

PER_ EXT_ ASG_ORG_ID

4. Define the data group criteria for each data group.



152

Creating Extract Records1. Select the Departments Data Group from the navigation tree and select the Create icon in the Extract Records

region. Extract records represent a physical collection of all required fields. If a data group has 3 records, then youcan specify the sequence in which the application processes the records using the sequence field. You can alsoselect the Next Data Group to identify which data group the application processes next.

2. Create two records for the Departments Data Group.


Field Department Summary Department Details

Name

Department Summary

Department Details


1/1/00

1/1/00

Sequence

20

10

Type

Trailer Record

Header Record

Process Type

Fast Formula

Fast Formula

Next Data Group

NA

Employees

4. Save the records, then select the Employees Data Group and select the Create icon in the Extract Records region.

5. Create one record for the Employees Data Group.


Field Name Entry

Name

Employee Details


1/1/00

Sequence

10

Type

Detail Record

Process Type

Fast Formula



153

Creating Attributes1. Select the Departments Data Group from the navigation tree and select the Department Details record.

An extract attribute is an individual field of a record.

2. Create the following extract attributes for the Department Details record and select Save.


Field Name Attribute Entry Attribute Entry

Name

Department Name

Department Location

Type

Database item group

Database item group

Database Item Group

Organization Name

Organization Location Country

4. Save the record, then select the Department Summary record.

5. Select the Create icon in the Extract Attributes region.

6. Create the following extract attributes for the Department Summary record and select Save.


Field Name Attribute Entry Attribute Entry Attribute Entry

Name

Record Code

Report Date

Employee Count

Data Type

Text

Date

Number

Type

String

Parameter Element

Summary Element

String Value

999

NA

NA

Parameter

Effective Date

NA

NA

Aggregate Function

NA

NA

Count

Aggregate RecordName

NA

NA

Employees EmployeeDetails

8. Select the Employees Data Group from the navigation tree and select the Employee Details record.



154

9. Create the following extract attributes for the Employee Details record and select Save.



Name

Full Name

Gender

Date of Birth

Start Date

1/1/00

1/1/00

1/1/00

Data Type

Text

Text

Date

Type

Database Item Group

Decoded databaseitem group

Database item group

Database Item Group

Person Full Name

Person Gender

Person Date of Birth


Name

Salary

Bonus

Tax rate

Start Date

1/1/00

1/1/00

1/1/00

Data Type

Number

Number

Text

Type

Database item group

Record Calculation

Rule

Database Item Group

Assignment SalaryAmount

NA

NA

Calculation Expression

NA

Salary * 0.5

NA

Rule

NA

NA

FAST Bank Tax Rule

Defining the Delivery Options1. Navigate to the Extract Execution Tree to validate the extract definition setup.

2. Select Export XSD to download the XML Schema Definition (.XSD) file for this extract setup. This exported filecontains the structure of the extract definition: the data groups, records, and attributes.



155

3. Select the Extract Delivery Options region to define the formatting and layout options for the extract definition.


Field Value Value

Start Date

1/1/00

1/1/00

End Date

12/31/12

12/31/12

BI Publisher Template

ReportLayout

EFTLayout

Output Type

PDF

EFT

Delivery Type

E-mail

FTP

Delivery Option Name

E-mail to HR

FTP to 3rd Party

Output Name

HeadcountReport

EFTReport

5. Define further information for each delivery option in the Additional Details region. For example, add the server,username and password for the FTP delivery type.

6. Enter FAST Bank Extract as the reporting category and click Submit.

Submitting an ExtractAn extract definition automatically creates an extract process (payroll flow) with the same name as the extract. The extractprocess enables you to define an execution sequence of multiple tasks, including pre and post tasks using the extractprocess. You can use the Refine HCM Extracts task to view and modify the extract process submission parameters, ifrequired.

1. Select the Submit an HCM Process task and select the FAST Bank Extract process.

2. Enter FAST Bank Extract - Jan 2012 as the Payroll Flow (extract process).

3. Enter 1/1/12 as the Effective Date.

4. Select Next. You can specify interaction details if the task is dependent on other tasks with different extractprocesses. For example, this task must wait because another task is running.

5. Select Next and review the extract. You can schedule the extract, or run it immediately.

6. Select Submit.

7. Select OK and View Checklist to view the status of the process.

8. Select the View an HCM Process task to review the results of the extract run. Search for the FAST Bank Extractprocess.

9. Select Go to Task for FAST Bank Extract - Jan 2012, click the eyeglasses, and view the report output by selectingthe report name.



156

Related Topics• How do I create a BI Publisher template for HCM extract

Using the Simplified Interface: Worked ExampleThis example topic demonstrates how to create a HCM extract including creating data groups, records, and attributesusing the Simplified interface. You can access the Simplified interface by clicking the Switch Layout button on the ManageHCM Extract Definitions page. FAST Bank is a global organization with subsidiaries all over the world. As part of an externalreporting requirement, FAST Bank must obtain the department and employee details across the entire company. Thisinformation must be sent to a third party in an XML file and to the HR manager with employee details grouped by departmentas a Headcount Report.

The following table summarizes the key decisions in this scenario:


How many extracts do I create to produce this type ofreport?

You create one extract definition to define a headcountreport.

How many data groups do I create?

In this example there are 2 functional groups ofinformation, therefore you create two data groups, onefor department and one for employees.

How many records do I create?

You decide the number of records based on thesubgroup of attributes within a data group. In thisexample, you create two records for the departmentdata group:

• Department Details

• Department Summary

You create one record for the employees data group:Employee Details.

How many attributes do I create?

You decide the number of attributes based on thespecific information required for that report. In thisexample, create the following attributes for theDepartment Details record:

• Department Name

• Department Location

For the Department Summary record, create thefollowing attributes:

• Record Code

• Report Date

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=E40DD6A92747E1BEE040D30A688154E2



157


• Employee Count

For the Employees Details record, create the followingattributes:

• Full Name

• Gender

• Date of Birth

• Salary

• Bonus

• Tax Rate

Do I create any fast formulas?

You can use fast formulas at the following levels:

• Extract Criteria level to determine certainconditions.

• Extract Rule level to derive attribute values.

• Extract Advanced Condition level to specifycomplex conditions.

• Extract Record level to automatically generateformulas when you use the Generate Formulaoption.

Creating an Extract Definition1. On the Manage Extract Definitions page click on the Create icon to create a new extract.

Use the Switch Layout button to open the extract in the Desktop interface. Use the Desktop interface to createand define HCM extracts without using a drag and drop system. You can perform most of the tasks for definingthe extract in the Simplified interface. To enter an effective date for the extract, you must switch to the Desktopinterface.

2. Enter FAST Bank Extract as the name and select HR Archive as the type. The application automatically creates thetag name based on the extract name and uses this name to generate the XML output file.

3. Click Save and the application saves the extract definition and automatically generates the parameters based on thetype of extract. The parameters control the output of an extract.

Creating Extract Data Groups1. Select the Design icon to create the data groups.

2. Select the Create icon or use the HCM Data Objects tree to drag and drop a data group into the local area. A datagroup represents data that belongs to one or more logical data entities.



158

3. Using the drag and drop action, the application automatically creates the following information:

Field Name Entry

Name

Departments

User Entity

PER_ EXT_ SEC_ ORGANIZATION_ UE

Root Data Group

Yes (By selecting this checkbox you select thisdata group as the starting point for the extractexecution.)

4. Select Save and create another data group with the following information:

Field Name Entry

Name

Employees

User Entity

PER_ EXT_ SEC_ ASSIGNMENT_UE

Root Data Group

No

Creating Extract Data Group Connections1. Ensure you enter the following details to create the extract data group connections.


Field Name Entry

Parent Data Group

Departments

Parent Data Group Database Item

PER_ EXT_ ORG_ ORGANIZATION_ ID

Data Group Database Item

PER_ EXT_ ASG_ORG_ID

3. Define the data group criteria for each data group.

Creating Extract Records1. Select the Department Data Group and ensure it includes the following extract record details. Extract records

represent a physical collection of all required fields. If a data group has 3 records, then you can specify the



159

sequence in which the application processes the records using the sequence field. You can also select the NextData Group to identify which data group the application processes next.


Field Department Summary Department Details

Name

Department Summary

Department Details


1/1/00

1/1/00

Sequence

20

10

Type

Trailer Record

Header Record

Process Type

Fast Formula

Fast Formula

Next Data Group

NA

Employees

3. Save the records and then select the Employees Data Group. Ensure this data group includes the following extractrecord details.


Field Name Entry

Name

Employee Details


1/1/00

Sequence

10

Type

Detail Record

Process Type

Fast Formula

Creating Attributes1. Select the Departments Details record within the Department Data Group and ensure it includes the following

extract attribute details.




160

Field Name Attribute Entry Attribute Entry

Name

Department Name

Department Location

Type

Database item group

Database item group

Database Item Group

Organization Name

Organization Location Country

3. Select the Department Summary record and ensure it includes the following extract attribute details.



Name

Record Code

Report Date

Employee Count

Data Type

Text

Date

Number

Type

String

Parameter Element

Summary Element

String Value

999

NA

NA

Parameter

Effective Date

NA

NA

Aggregate Function

NA

NA

Count

Aggregate RecordName

NA

NA

Employees EmployeeDetails

5. Select the Employee Details record within the Employees Data Group and ensure it includes the following extractattribute details.



Name

Full Name

Gender

Date of Birth

Start Date

1/1/00

1/1/00

1/1/00



161


Data Type

Text

Text

Date

Type

Database Item Group

Decoded databaseitem group

Database item group

Database Item Group

Person Full Name

Person Gender

Person Date of Birth


Name

Salary

Bonus

Tax rate

Start Date

1/1/00

1/1/00

1/1/00

Data Type

Number

Number

Text

Type

Database item group

Record Calculation

Rule

Database Item Group

Assignment SalaryAmount

NA

NA

Calculation Expression

NA

Salary * 0.5

NA

Rule

NA

NA

FAST Bank Tax Rule

Defining the Delivery Options1. Select the Deliver icon to define the delivery options.2. Select Export XSD to download the XML Schema Definition (.XSD) file for this extract setup. This exported file

contains the structure of the extract definition: the data groups, records, and attributes.3. Use the delivery options page to define the formatting and layout options for the extract definition.4. Complete the general fields, as shown in this table:

Field Value Value

Start Date

1/1/00

1/1/00

End Date

12/31/12

12/31/12



162

Field Value Value

BI Publisher Template

ReportLayout

EFTLayout

Output Type

PDF

EFT

Delivery Type

E-mail

FTP

Delivery Option Name

E-mail to HR

FTP to 3rd Party

Output Name

HeadcountReport

EFTReport

5. Ensure you enter the additional information such as, the server, username, and password for the FTP delivery type.6. Enter FAST Bank Extract as the reporting category and click Submit.

Submitting an ExtractAn extract definition automatically creates an extract process (payroll flow) with the same name as the extract. The extractprocess enables you to define an execution sequence of multiple tasks, including pre and post tasks using the extractprocess. You can use the Refine HCM Extracts task to view and modify the extract process submission parameters, ifrequired.

1. Select the Submit an HCM Process task and select the FAST Bank Extract process.2. Enter FAST Bank Extract - Jan 2012 as the Payroll Flow (extract process).3. Enter 1/1/12 as the Effective Date.4. Select Next. You can specify interaction details if the task is dependent on other tasks with different extract

processes. For example, this task must wait because another task is running.5. Select Next and review the extract. You can schedule the extract, or run it immediately.6. Select Submit.7. Select OK and View Checklist to view the status of the process.8. Select the View an HCM Process task to review the results of the extract run. Search for the FAST Bank Extract

process.9. Select Go to Task for FAST Bank Extract - Jan 2012, click the eyeglasses, and view the report output by selecting

the report name.

Related Topics• How do I create a BI Publisher template for HCM extract

FAQs for Managing Extracts

What's the Simplified interface in HCM Extracts?The Simplified interface is an easy-to-use graphical interface for defining and designing HCM extracts. You can perform mostof the tasks for defining the extract in the Simplified interface, however to enter an effective date, you must use the Desktopinterface.




163

What's an extract data group connection?Data group connections enable you to define the master-detail of parent-child relationship between the entities. For example,the Employees and Departments data groups are linked with Department ID.

Filtering Extracts

Using Extract Modes: ExplainedYou can create an extract to output data in different modes in the Manage Extract Definitions page. Use modes to extractdata that has changed since the previous extract runs. For example, you can extract employee details whenever there is achange in the employee's location.

Extract ModesTo enable different modes in an extract, you include the CHANGES_ONLY parameter and set up threading details inthe extract definition. While running the extract you can use the CHANGES_ONLY parameter to control the extractmode. For example, to find out if the job name has changed on a person's assignment , set up multi-threading databaseitems at assignment level and include the CHANGES_ONLY parameter. When you run the extract in the ATTRIBUTEmode, the extract compares data from the multi-threading level and outputs the incremental changes. You can link thePER_EXT_CHANGES_ONLY lookup to the CHANGES_ONLY parameter so that you can select a mode when you submit theextract.

The following table describes the different extract modes, their lookup values and descriptions.

Mode Lookup Value Description

N

All attributes

Includes all data in the extract

Y

Changed attributes

Compares this extract run with theprevious extract runs and displaysthe data that has changed only.

ATTRIBUTE

Changed and marked attributes

Includes elements that havechanged or marked as mandatory

ATTRIB_OLD

Changed and marked attributeswith previous values

Displays elements that havechanged or marked as mandatoryplus their previous value

Note You must run the PayrollInterface with the Attrib_Old mode whenever youuse the US ADP PayForceThird-Party PeriodicExtract.



164

Mode Lookup Value Description

ATRIB_BLOCK

Changed, marked attributes,previous data under threadinggroup

Displays the following data underthreading data group: Changed data Data marked as mandatory Previous values Parent data group values

FAQs for Filtering HCM Extracts

How can I restrict the records to be extracted?You can use extract data group criteria to define a set of filtering conditions the application performs on an extract datagroup. For example, you can use database items in the fast formula to represent the town_or_city and primary_flag columnsin the per_addresses table to restrict the data to people living in London only. The extract definition would then excludepeople with a primary address of anywhere other than London. You can specify the criteria conditions using an expression orfast formula.

What's a threading database item and what is its connection to the extract data group?A threading database item is required for implementing the Changes Only feature. The threading database item is a unique IDin the chosen user entity (UE). Generally, for Pay Employee UE and Assignment UE it would be DBI with %ASSIGNMENT%ID.For Person UE, it would be DBI with pattern %PERSON%ID. You can declare one threading database item at the root datagroup or any child data group level. For example, you declare the threading database item from the location where you needchanges only.

What's a conditional action?A conditional action identifies the action to perform, and optionally, a message based on the outcome of a conditionalexpression or a predefined fast formula. Conditional actions are applied on the extracted data similar to criteria conditions thatare applied prior to extraction. Actions and messages are predefined in lookups, and you can add your own messages bycreating new values for the lookup.

When a condition is satisfied, you can use this feature to perform certain predefined actions. For example, you can excludeemployees that satisfy a condition, such as all employees from a predefined country. You can also configure this feature toraise a warning when an employee's salary is blank or beyond a specific level.

What's an exclusion rule?You can't exclude or override a record that doesn't suit your requirements with your own record by using an exclusion rule.The extract process doesn't process excluded records based on the legislative data group.

What is extract data group filtering?Extract data group filtering filters data extracted in the data group. You can specify to filter data group as an expression(in popup) or as fast formula, and you can choose one or both. You can build criteria using the available database items,parameters and operators (conditional and logical). The filter criteria will be more efficient as it gets appended to the UserEntity SQL at the time of execution. If you can't specify the criteria as an expression, then you can place logic inside a fastformula and select here. Fast formulas return values of Y or N to indicate if you must extract the record or not. If both criteriaand formula are specified, then both the conditions are applied.



165

What are extract data group criteria?You can specify the filter conditions of what data you want to archive by using the data group criteria. You can specify thefilter conditions as an expression or fast formula.

Delivering Extracts

Delivery Options: ExplainedYou specify delivery options as part of the extract definition. Delivery option parameters specify the output format, the deliverymethod (email, FTP), and other parameters required for integration with BI Publisher layer.

How Delivery Options WorkHCM Extracts archives the extracted data into result tables and stores it as an XML output in the database. The applicationtransforms the XML output into a formatted output such as HTML, PDF, EDT, or XLS. The formatted output is then deliveredthrough email, fax, FTP, or print, depending on the delivery options you set in the extract definition. You can define deliveryoptions for an extract using a BI Publisher template, with the following delivery file output types: PDF, XLS, XML, DOC, andthe following delivery modes: FTP, email, and fax.

Using Delivery TypesThe type of delivery you select determines the destination of the extract. Some delivery types require additional information.You can select Documents of Record as the delivery mode to store the output in the database and allow employees to viewthe output from document of records. An example of a document is a payslip. If the XML output is split and burst as separatefiles, then you can select the bursting node. For example, if you want all employees to receive an email with their payslip,then set the bursting node to Employee_ID. For HCM Connect users only, select the HCM Connect delivery type to create anencrypted extract and transmit securely using HCM Connect.

Defining the BI Publisher Template: Worked ExampleThis example demonstrates how to set up a BI Publisher template and make it available for you to create a document in therequired format, suing the extracted data. You access BI Publisher using the Reports and Analytics link from the navigator.When the Reports and Analytics page is accessible, you can browse through the catalog.FAST bank must send an XML file on their employees and departments to a third party and the HR Manager with employeedetails grouped by departments as a Headcount Report.

The following table summarizes some key decisions:

Decisions to Consider In this Example

Why do I have to set up BI Publisher?

You set up BI Publisher to format the extracted XMLdata into the required format and to deliver the report orbusiness document to the appropriate destination.

How does BI Publisher connect to HCM extracts?

You install the Template Builder for Word plug-in.

Do I need a separate license?

No, BI Publisher is included with Core HR.



166

Tasks

1. Setting up the Data Model

2. Creating the BI Publisher Report Template

3. Uploading the Report

Setting up the Data Model1. Select the Reports and Analytics option from the navigator.

2. Select the Browse Catalog icon.

3. Select the New menu option, and under the Published Reporting section, select Report.

4. Select the Use the existing data model option to create a report using the existing data model.

5. In the window that displays, select the data model and select Next.

6. Select the Report Editor option and select Finish to complete the data model setup.

7. Save the report as HR Data Report in the following folder: /Shared Folders/Custom/Human Capital Management/

Creating the BI Publisher Report Template1. Install the Template Builder for Word plug-in from the BI Publisher Enterprise Home page.

This plug-in provides sample documents, demos, templates and Template Viewer. Use these samples to help youunderstand the concepts and to create templates such as EFT and RTF to view the formatted XML output.

2. Create a BI Publisher template using the Export XSD option in the extract execution tree.

3. Open MS Word and locate the Add-Ins tabbed region to view the Oracle BI Publisher option.

4. Select the Load XML Schema option. After the XML schema has loaded, you can arrange the fields and alter thelayout, if required.

Uploading the Report1. Select the Upload option from the Upload or Generate Layout region and enter the following information:

Parameters Details

Layout Name

RTF Layout

Template File

Select the file name of the RTF template saved onyour local drive.

Type

RTF Template



167

Parameters Details

Locale

English (United States)

2. Save the BI report in the following location: /Shared Folders/Custom/Human Capital Management/.

This BI Publisher report template is now ready for you to select in the Delivery Options section when creating theextract definition.

Related Topics

• How do I create a BI Publisher template for HCM extract

FAQs for Delivering HCM Extracts

Can I use Oracle Transaction Business Intelligence (OTBI) with HCM Extracts?Yes. You have two options:

HCM Extracts can extract the data and produce an output using CSV, XML, or PDF. OTBI can then accept a data source inexcel or XML format.

BI Publisher can also accept a data source in excel or XML format. HCM Extracts has integration with BI Publisher.

What's BI Publisher and how does it work with HCM extracts?BI Publisher is a set of tools you use to create highly-formatted reports based on data models. With BI Publisher, you can:

• Author, manage, and deliver documents

• Create interactive management reports

• Create highly-formatted, customer-facing documents

• Create government documents

• Create electronic funds transfer (EFT) documents

BI Publisher transforms the extracted data from the database and presents that data into a report.

How do I deliver an HCM extract using HCM Connect?For HCM Connect users only, use the HCM Connect delivery type in the Deliver page of the Manage Extract Definitions task.This delivery type enables you to create an encrypted extract which you can transmit securely to HCM Connect. By selectingthe HCM Connect delivery type you can enter additional details to ensure the extract is identifiable in HCM Connect. Forexample, specify the Integration Name as it appears in HCM Connect, an encryption mode to suit your requirement, anda file name for your reference. This additional set up ensures the document is encrypted and transmitted securely by HCMConnect.



Chapter 15Payroll Outbound Interface

168

15 Payroll Outbound Interface

OverviewYou can create your own HCM extract definitions to extract and send personal payroll information to a third-party payrollprovider. In a legislative data group that uses the Payroll Interface payroll product usage setting, payroll coordinators can usethe following features to more easily validate and extract payroll information:

• Two predefined extract definitions, which you can copy and adapt to your requirements:

◦ Global Payroll Interface

◦ US ADP PayForce Periodic Extract

• Calculate Gross Earnings process, which you can run each period to update earnings balances. If you use thisprocess, you can check gross earnings results using:

◦ View Person Process Results page, which includes the statement of earnings

◦ Element Result Register

◦ Payroll Balances Report



169

Payroll coordinators use the following tasks on a periodic basis to manage and extract data to send to third-party providers.

These processes use element entries, payroll relationships, and calculation cards to determine payroll-related values toretrieve and calculate along with other HR-related values for a worker, such as benefits information.

Related Topics

• Calculating Gross Earnings for Payroll Interface: Overview

Implementing Payroll Interface: ProcedureUse predefined Payroll Interface extract definitions to send payroll-related employee information to a third-party payrollprovider. The setup steps required for Payroll Interface vary depending on your business requirements, the Oracle productsand features you use, and the data required by your third-party payroll provider.

Generate the task list in the Setup and Maintenance work area using the Workforce Deployment offering. This topic helps youdetermine which implementation steps to complete for the following task areas and the roles that can perform them.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=C0BDD268A5B62C4DE040D30A68814764



170

Task Area Role Work Area

Defining Enterprise Structures

Application ImplementationConsultant

Setup and Maintenance

Defining Payroll Product Usage



Defining Elements, Balances, andFormulas



Managing Data Security

IT Security Manager


Creating an Extract Definition



Managing Payroll ProcessConfiguration Groups



Managing Personal PayrollInformation

Payroll Coordinator

Payroll Administration, PayrollCalculation, and PaymentDistribution

NoteOther topics may provide additional setup guidance specific to your third-party provider.

Defining Enterprise StructuresEnsure that your implementation includes the enterprise structures required to support payroll relationships for your workers.To confirm your enterprise structures setup:

1. In the Define Geographies for HCM task list, verify the predefined geographies and load any additional localgeographies, as needed.

2. In the Define Legal Jurisdictions and Authorities task list, perform the following actions:

◦ Create a legal jurisdiction if not already created or predefined for your country or territory.

◦ Create a legal authority for each government body you interact with.

◦ Create addresses for legal entities and legal authorities

3. In the Define Legal Entities for HCM task list, perform the following actions:

◦ Create a legislative data group (LDG) for each country of operation, to partition your payroll data.

◦ Create at least one legal entity designated as a payroll statutory unit (PSU) for each LDG.



171

◦ Associate each PSU with one LDG.

◦ Optionally, create calculation cards for statutory deductions for each PSU, if supported by the LDG.

4. In the Define Legal Reporting Units for HCM task list, perform the following actions:

◦ Create any additional tax reporting units (TRUs) that you need.

◦ Optionally, create calculation cards for statutory deductions for each TRU, if supported by the LDG.

5. In the Define Business Units for HCM task list, create business units that you use to associate other objects.

Defining Payroll Product UsageSelect the correct payroll product for each of your countries and territories to ensure that payroll-related features workcorrectly in your implementation. For example, the earnings element template for Payroll Interface creates necessary objects,such as input values, balances, and formulas, so that the Calculate Gross Earnings process includes the element.

1. Use the Manage Payroll Product Usage task to set the product usage value for each country or territory to PayrollInterface.

Defining Elements, Balances, and FormulasConfigure the payroll objects for employee-level information required by your third-party provider. For example, to captureemployees' payment details, such as bank information for electronic funds transfer payments, you must create organizationpayment methods. An application implementation consultant must perform the following steps:

1. Use the Manage Consolidation Groups task to create at least one consolidation group for each LDG where youcreate elements. The payroll definitions you create later require a consolidation group.

2. Optionally, if your payroll provider requires any employee bank data, use the Manage Organization Payment Methodtask to create a payment method for each LDG.

3. Use the Manage Payroll Definitions task to create a payroll definition for each payroll frequency, such as weekly orsemimonthly.

TipTo upload a batch of payroll definitions, use the Batch Loader task in the Payroll Administration workarea.

4. Use the Manage Elements task to create any earnings or deduction elements. After creating an element, edit itto create at least one element eligibility record. The newly created element generates database items that theCalculate Gross Earnings process can use to get earnings information and the extract process can use to getdeduction information.

NoteBefore you enable multiple entries of the same element, confirm that your third-party provider canmanage them.

5. Use the Manage Elements task to create element eligibility records for predefined statutory deduction elements.You must complete this task before you hire employees.



172

Managing Data SecurityThe security setup provides payroll coordinators access to the appropriate tasks, data, and features through the payrollcoordinator job role.

An IT security manager must perform the following security-related configuration actions:

1. For each payroll definition, use the Manage Payroll Security Profiles task to set up the payroll security profile.

2. For each legislative data group, use the Manage Legislative Data Group Security Profiles task to set up security.

3. Use the Assign Security Profiles to Role task to create at least one data role for the payroll coordinator job role withthe appropriate security profiles.

4. Use the Manage Role Provisioning Rules task to provision the payroll coordinator role.

Creating an Extract DefinitionCreate the extract definition and process that extracts data from HCM for your third-party payroll provider. The requirementsof your third-party provider determine which data to extract, and how to structure and deliver it.

An application implementation consultant must perform the following steps:

1. Use the Manage Extract Definitions task to copy the predefined extract definition you use for your report, and save itunder a new name.

2. Edit the extract definition to meet the requirements of your payroll provider.

3. Submit your changes.

The application generates an extract process using your modified definition.

Managing Payroll Process Configuration GroupsAn application implementation consultant must perform the following configuration step:

1. Use the Manage Default Process Configuration Group Profile Option Values task to select the default group as thevalue for the Process Configuration Group profile option.

2. Use the Manage Payroll Process Configuration task to review the default settings in the default configuration group.For example, you might change the values for chunk size or number of threads to optimize performance whencalculating gross earnings.

Managing Personal Payroll InformationA payroll manager performs the following steps to optionally upload personal payroll information, such as initial balance valuesor employee bank details.

1. Optionally, to load initial balances:

◦ Create balance initialization elements.

◦ Use the batch loader to load the initial values to the staging tables.

◦ Submit the Load Initial Balances task to initialize the balances in the Payroll Calculation work area.



173

2. Optionally, if you created any organization payment methods and want to load personal bank information for EFTpayments, use one of the following methods to migrate bank data:

◦ Batch Loader task in the Payroll Administration work area

◦ Manage Personal Payment Methods task in the Payment Distribution work area (for individual employees)

◦ Manage Personal Payment Methods web service

Related Topics• Creating Legal Entities, Registrations, and Reporting Units: Examples

• Payroll Statutory Units, Legal Employers, and Tax Reporting Units: How They Work Together

• Creating Payroll Elements for Payroll Interface: Worked Example

Creating Extract Definitions: ProcedureDesign an extract definition to meet the requirements of your third-party payroll provider using the Manage Extract Definitionstask from the Data Exchange work area. Copy a predefined extract or create a new one, and optionally, refine the reportprocess extract, such as its flow submission parameters.

When you create an extract definition, you define data groups, records, and attributes. You define what you want to extract,how to extract, and how to deliver the extracted data.

When you submit the extract definition, the application creates a payroll interface report process that you run to perform theactual extraction of data. Any subsequent changes you make to the extract definition will affect your extract process.

Creating a New Extract DefinitionTo create an extract definition to use for a new extract process:

1. On the Manage Extract Definitions page, click Create.

2. Select the Payroll Interface extract definition type.

This predefined definition type includes basic parameters that support the extract process, such as the parameterthat enables extracting only changed data since the previous extract.

3. Build data groups, records, and attributes for the data that you want to extract.

4. Generate formulas.

5. Define delivery options and submit your changes.

Copying an Existing Extract DefinitionTo copy an existing extract definition:

1. On the Manage Extract Definitions page, select the extract definition you want to copy, and then click Copy.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=B488C3E89316D723E040D30A68816C2C

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=9647DD0BCC9F8A0BE040D30A68813BC2

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=C1461A92E2913ACAE040D30A68817500



174

2. Use one of the predefined extract definitions shown in the following table.

Extract Definition Description

US ADP PayForce Third-Party Periodic Extract

Designed for Automatic Data Processing (ADP) inthe US, but suitable for other third parties in the USwith modifications.

Global Payroll Interface Extract

Designed for global applications. Includes allemployee attributes organized by data groups fornew hire, changed, or termination data.

3. Enter a name for the extract. This is the name the application uses for extract process that it creates for this extractdefinition.

4. Select a legislative data group.

5. Modify the records and attributes as needed, and then generate formulas.

6. Define delivery options and submit your changes.

Refining the Extract ProcessTo refine the extract process:

1. Select the Refine Extract task from the Data Exchange work area.

2. Edit the parameters to determine which parameters should display and which values are required.

For example, hide a specific parameter, or set a specific parameter so its value is required to run the extractprocess.

3. Add parameters, as needed, that you want available for entry when submitting the extract process.

Related Topics

• Payroll Interface Reports: How They Are Processed

• Extract Components: How They Work Together

Global Payroll Interface Extract DefinitionThis topic describes the data components of the predefined Global Payroll Interface extract definition. The structure of thisextract and its HCM data objects determine what data you can extract and send to your third-party payroll provider. If yourpayroll provider requires additional information, you can modify the extract definition using the Manage Extract Definitions taskin the Data Exchange work area.




175

The structure of data groups in this extract provides the ability to isolate changed data based on the business event for thedata change, such as new hire or termination. The root data group contains the following primary data groups:

• New Hire Records

• Changed Records

• Terminated Employee Records

New Hire RecordsAll attributes for all records in this data group include Record ID, Record Type, Employee ID, Effective Date, in addition to theattributes listed in the following table.

Record Name Included Attributes

Key Data

Payroll Name, Data Extract Date, Data Extract Time,Business Event Type, Retroactive Payroll Period

Hire Data

Hire Date, Hire Action Type, Hire Reason

Personal Identification Data

Document Type, National ID, Expiration Date, Place ofIssue, Date of Issue

Personal Name Data

First Name, Last Name, Middle Name, Initials, Title,Preferred Name, Name Suffix, Full Name, Local FirstName, Local Last Name, Name Type, Name Prefix

Basic Pay Salary Data

Salary Basis, Basic Pay, Salary, Salary Basis Name,Payment Frequency, Currency Code

Contract Data

Contract Code, Contract Type, Qualification Code,Contract Start Date, Contract End Date, Hire Reason,Contract End Reason, Contract Change Reason,Probation Period, Employment Rate

Deduction for Loan Data

Reserved Input Value, Input Value, Deduction End Date,Deduction Code, Autoindirect Only, Processing Type,Usage Level, Assignment ID, Element Classification,Secondary Classification

Deduction for Social Insurance Data




176


Supplemental Earnings Data

A placeholder used for context of supplementalearnings.

Address Data

Address Type, Address Line 1, Address Line 2, AddressLine 3, Address Line 4, House Number, House NumberSuffix, City, Postal Code, Postal Code Extension,Country, District, Region, Country Code

Bank Data

IBAN, Bank Number, Bank Code, Bank Name, AccountOwner, Account Number, Account Type, Bank BranchNumber, Country, Payment Percentage, PaymentMethod, BIC, Currency Code

Communication Data

Business E-Mail, Fax Number, Business Phone Number,Personal E-Mail, Home Fax Number, Home PhoneNumber

Marital Status Data

Gender, Marital Status, Marital Status Effective Date

Family Data

Relationship, First Name, Last Name, Name Prefix, Title,Date of Birth, Gender, Marital Status, Country of Birth,Dependent Relative

Hire Date Details

Group Hire Date

Seniority Date Data

Seniority Date

Job Position Data

Job Code, Job Title

Leave of Absence Data

Absence Start Date, Absence End Date, Absence Code,Absence Reason, Absence Type

Organization Assignment Cost Center Data

Primary Cost Center

Organization Assignment Data

Location, Organizational Unit, Company Code,Establishment Code, Department Code, EmploymentStatus



177


Personal Data

Date of Birth, Name Type, Place of Birth, Country Codeof Birth, Last Name, District of Birth, Middle Name,Preferred Name, Country of Birth, Name Prefix, NameSuffix, Highest Level of Education, Date of Death,Disabled, Ethnicity, Disability Percentage, Religion

Social Insurance Data

Social Insurance Code, Social Insurance Number

Regular Earnings Data

A placeholder used for context of regular earnings.

Changed RecordsAll attributes for all records in this data group include Record ID, Record Type, Employee ID, Effective Date, in addition to theattributes listed in the following table.


Key Data

Payroll Name, Data Extract Date, Data Extract Time,Business Event Type, Retroactive Payroll Period

Hire Data

Hire Date, Hire Action Type, Hire Reason

Personal Identification Data

Document Type, National ID, Expiration Date, Place ofIssue, Date of Issue

Personal Name Data

First Name, Last Name, Middle Name, Initials, Title,Preferred Name, Name Suffix, Full Name, Local FirstName, Local Last Name, Name Type, Name Prefix

Basic Pay Salary Data

Salary Basis, Basic Pay, Salary, Salary Basis Name,Payment Frequency, Currency Code

Contract Data

Contract Code, Contract Type, Qualification Code,Contract Start Date, Contract End Date, Hire Reason,Contract End Reason, Contract Change Reason,Probation Period, Employment Rate, Normal WorkingHours



178


Deduction for Loan Data


Deduction for Social Insurance Data


Supplemental Earnings Data


Address Data

Address Type, Address Line 1, Address Line 2, AddressLine 3, Address Line 4, House Number, House NumberSuffix, City, Postal Code, Postal Code Extension,Country, District, Region, Country Code

Bank Data

IBAN, Bank Number, Bank Code, Bank Name, AccountOwner, Account Number, Account Type, Bank BranchNumber, Country, Payment Percentage, PaymentMethod, BIC, Currency Code

Communication Data

Business E-Mail, Fax Number, Business Phone Number,Personal E-Mail, Home Fax Number, Home PhoneNumber, Person ID, Home Mobile Phone, Work MobilePhone, Home E-Mail, Work E-Mail

Marital Status Data

Gender, Marital Status, Marital Status Effective Date

Family Data

Relationship, First Name, Last Name, Name Prefix, Title,Date of Birth, Gender, Marital Status, Country of Birth,Dependent Relative

Hire Date Data

Group Hire Date

Hire Seniority Date Data

Seniority Date

Job Position Data

Job Code, Job Title



179


Leave of Absence Data

Absence Start Date, Absence End Date, Absence Code,Absence Reason, Absence Type

Organization Assignment Cost Center Data

Primary Cost Center

Organization Assignment Data

Location, Organizational Unit, Company Code,Establishment Code, Department Code, EmploymentStatus

Personal Data

Date of Birth, Name Type, Place of Birth, Country Codeof Birth, Last Name, District of Birth, Middle Name,Preferred Name, Country of Birth, Name Prefix, NameSuffix, Highest Level of Education, Date of Death,Disabled, Ethnicity, Disability Percentage, Religion

Social Insurance Data

Social Insurance Code, Social Insurance Number

Regular Earnings Data


Termination Data

Termination Date, Termination Type, Termination ActionCode, Termination Reason

Terminated Employee RecordsAll attributes for all records in this data group include Record ID, Record Type, Employee ID, Effective Date, in addition to theattributes listed in the following table.


Key Data

Payee ID, Payroll Period, Company Code, CountryCode, Payroll Name, Data Extract Date, Data ExtractTime, Business Event Type, Retroactive Payroll Period

Termination Data

Termination Date, Termination Type, Termination ActionCode, Termination Reason



180

Creating a Report from a Copy: Worked ExampleThis example demonstrates how to create an payroll interface report by copying an existing extract definition. The generatedprocess extracts payroll-related employee and assignment information to submit to a US third-party payroll provider.This worked example assumes that you completed the setup steps during implementation according to your businessrequirements.

The following table summarizes the key decisions for the scenario of building an extract definition.


What special parameters does the extract use?

Parameters that support the option of extracting onlychanged records since the previous periodic extract run.

What special employee information does the payrollprovider require?

Employee and assignment data for recurring earningseach payroll period.

The steps in this scenario are:

1. Copy the existing extract definition for US third-party payroll providers.

2. Submit the copied extract definition to create the extract process.

3. Edit the parameters of the generated extract process, as needed.

You can perform all of these steps from the Data Exchange work area.

Copying the Extract Definition

1. Select the Manage Extract Definitions task in the Data Exchange work area.

2. In the Name field in the Search section, enter US ADP.

3. In the Search Results section, select the row containing US ADP PayForce Third-Party Periodic Extract, and thenclick Copy.

4. Enter a name for the new extract definition, for example US Payroll EFT Report, and the click OK.

NoteThe name assigned here for the generated extract process displays in the list of available processeswhen you select the Submit a Process or Report task.

5. Search for your extract definition.

6. In the Search Results section, select the name of your new extract definition.

7. Edit the basic information about your extract definition as shown in the following table, and then click Save.



181

Field Value

Tag Name Name used in the XML data file. Generatedautomatically, but you can modify it.

Description Optional text that displays in the search resultsabout the generated report process for this extract.

8. Click Save.

9. Click Design to make any changes to data groups, records, or attributes.

10. Click Deliver and change the delivery options to use the template created for your extract.

Compiling Formulas

1. Click Validate.

2. Click Compile All Formulas.

NoteCompiling formulas can take several minutes. Collapse and expand your extract in the hierarchy torefresh. You must wait for all formulas to compile before moving to the next step.

3. Scroll down to verify that the formulas compiled without error.

4. Click Submit.

Refining the Extract ProcessAfter you submit an extract definition, you can further refine how to use its extract process, which parameters should display,and which values are required. This example specifies flow parameters so that a person submitting the extract process canchoose values from choice lists.

1. From the Data Exchange work area, select Refine Extracts.

2. In the Flow Pattern field, enter you extract name, for example, US Payroll EFT Report.

3. In the Search section, select the legislative data group, and then click Search.

4. In the Search Results section, in the row containing your extract, click Edit.

5. On the Parameters tab, click Edit to modify each of the following parameters as shown in this table.

Flow Parameter Display Format Lookup Display

Changes Only

Lookup Choice List

PER_ EXT_CHANGES_ONLY

Yes



182

Flow Parameter Display Format Lookup Display

Payroll Name

SmartLOV

Payroll

Mandatory

Payroll Period

SmartLOV

Payroll Period

Mandatory

6. Verify that the remaining parameters are set to your preference. Decide whether to display other parameters ormake other parameters required to submit the process.

7. Click Submit.

Related Topics

• Extract Components: How They Work Together

• Payroll Interface Reports: How They Are Processed

Output File Templates: HighlightsThe delivery options for predefined extract definitions specify eText templates that Oracle BI Publisher uses to produce theoutput files sent to third-party payroll providers for payment processing. If you have additional information to send that isn'tsupported by the predefined eText templates, you must modify them or create a new ones, as needed.

Understanding eText TemplatesAn eText template is an RTF-based template that you use to generate text output for electronic funds transfer (EFT) andElectronic Data Interchange (EDI) information. At run time, BI Publisher applies this template to an input XML data file tocreate an output text file for submission to a bank or other customer. The delivery file for electronic communication requiresthat eText templates follow specific format instructions for exact placement of data.

• For information about creating and modifying eText templates to use for formatting output files, refer to the followingsection in the Report Designer's Guide for Oracle Business Intelligence Publisher:

See: Creating eText Templates



Chapter 16Benefits Data Extract

183

16 Benefits Data Extract

Configuring for Plan Carriers: ProcedureThis topic covers how to set up benefit plan carriers and offerings so that you can then generate and transmit enrollment dataextracts. You extract benefits enrollment information into a single XML file for each benefits carrier.

To configure the benefits data extract, you complete these tasks in the Plan Configuration work area:

1. Create the plan carrier and configure extract settings.

2. Add the benefits extract plan type name.

3. Add the benefits extract plan code.

4. Add the benefits extract option name.

Creating Plan CarrierSet up carrier data and configure extract options in the Plan Configuration work area that apply whenever you run the extractfor that carrier.

1. Click the Manage Plan Carriers task.

On the Mapping tab, you can view the mapping of lookup codes to the lookup value that you transmit to carriers.Edits to mapping values affect all plan carriers that use the lookup.

2. On the Search Results toolbar, click the Create icon button.

3. Enter the carrier information.

In the Active field, select Active.

4. Enter the extract options.

The following table provides comments to help you with your extract field entries and selections.

Field Comments

Extract Type Select whether to run a full extract or extract onlythe changes since the previous extract. Generally, you run a full extract after an enrollmentperiod closes and enrollments are completed. Yourun subsequent extracts on a periodic or scheduledbasis, in either full or changes only mode.

Output File Name Obtain the value that you enter here from theextract file recipient.



184

Field Comments

Processing Frequency A common practice is to schedule your extracts torun after your regular payroll runs. You might wantto set the processing frequency accordingly.

Processing Type By default, all extracts have the same format,regardless of which carrier receives the extract. Youcan contract with Oracle's partner, BenefitsXML,to have a carrier's extract data transformedand delivered to the carrier, according toits specifications. For more information onBenefitsXML, see http://www. benefitsxml. com. If you don't use this partner, you can transform anddeliver the extract data file directly to each of yourplan carriers, according to their specifications.

Upload Custom Layout This button is available if you select the Customlayout processing type.

◦ Specify the layout for the individual carrier.For details, see the Benefits Extract: CustomLayout topic

5. Enter the file transfer details, which you obtained from the extract file recipient.

You can transmit extract files directly to the recipient.

Alternatively, you can transmit extract files to the Oracle cloud, using its file transfer details, and have your recipientdownload its extract from there.

Field Comments

Host The name of the server to which you transmit therecipient's extract files.

Remote Folder Path on the host to the location where yourtransmission places the extract file.

User Name Part of the sign-in credentials required for yourtransmission to access the host.

Password Part of the sign-in credentials required for yourtransmission to access the host.

6. Click Save and Close to return to the Manage Plan Carriers page.



185

Adding Benefits Extract Plan Type NameComplete these steps in the Plan Configuration work area to identify each type of plan included in the extract file for therecipient.

1. Click the Manage Plan Types task.

2. Search for and click the plan type, for example, Medical.

3. On the Plan Type Definition section Actions menu, select Update.

4. Enter the benefits extract plan type name, for example, Health.

For a list of valid extract names, which are provided by the Oracle partner BenefitsXML, see the Valid Extract Namesfor Benefits Plan Types and Options: Explained reference topic.

5. Click Save and Close to return to the Manage Plan Types page.

Adding Benefits Extract Plan CodeComplete these steps in the Plan Configuration work area to link the plan to the extract file recipient.

1. Click the Manage Benefits Plan Details task.

2. Search for and click the plan that you want to link to the extract file recipient.

3. Click Next to open the Edit Plan Additional Configuration page.

4. On the Configuration Details section Actions menu, select Update.

5. Enter the benefits extract plan code, which the extract file recipient provided to you for this specific plan.

6. Click Save and Close to return to the Plans tab.

Adding Benefits Extract Option NameComplete these steps in the Plan Configuration work area to identify each option included in the extract file for the recipient.

1. Click the Manage Benefit Options task.

2. Search for and click the participant option, for example, Participant Only.

3. On the Basic Details section Actions menu, select Update.

4. Enter the benefits extract option name, for example, Employee Only.

For a list of valid extract names, which are provided by the Oracle partner BenefitsXML, see the Valid Extract Namesfor Benefits Plan Types and Options: Explained reference topic.

5. Click Save and Close to return to the Manage Benefit Options page.

Next StepsAfter you finish configuring your extract settings and adding benefits extract data to your plan types, plans, and options,you are ready to generate and transmit the extract data. The details of this process are covered in the Generating andTransmitting Benefits Data Extract for Plan Carriers: Procedure topic.



186

Valid Extract Names: ExplainedOracle partner BenefitsXML provides valid extract names that you can enter for benefits plan types and options. You canextend these lists of values, as required.

Benefit Extract Plan Type NamesValid benefits extract names for plan types:

• 24 Care

• Dental

• Dental Capitation

• Exclusive Provider Organization

• Health

• Health Maintenance Organization

• Hearing

• Long Term Care

• Long Term Disability

• Mail Order Drug

• Major Medical

• Medicare Risk

• Mental Health

• Point of Service

• Preferred Provider Organization

• Prescription Drug

• Preventative Care

• Short Term Disability

• Utilization Review

• Vision

Benefits Extract Option NamesValid benefits extract names for options

• Children Only



187

• Dependents Only

• Employee and Children

• Employee and Five or More Dependents

• Employee and Four or More Dependents

• Employee and One Dependent

• Employee and One or More Dependents

• Employee and Spouse

• Employee and Three Dependents

• Employee and Three or More Dependents

• Employee and Two Dependents

• Employee and Two or More Dependents

• Employee Only

• Family

• Individual

• Not Applicable

• Spouse and Children

• Spouse Only

• Two Party

• Employee and Domestic Partner

• Domestic Partner and Children

• Domestic Partner Only

• Employee and Spouse or Domestic Partner

• Child or Children of a Domestic Partner

Generating and Transmitting Extracts: ProcedureYou can extract benefits enrollment information into a single XML file for each benefits carrier and transmit it to the carrier.This topic covers how to generate and transmit the extract file.

NoteIf a carrier provides more than one plan, the single extract contains information related to all plans provided bythat carrier.

Example: Four different carriers provide ten plans. You run four separate extracts, one for each carrier.



188

To generate and view the extract, you complete these tasks in the Evaluation and Reporting work area.

1. Submit the extract request.

2. View and transmit the extract details.

PrerequisitesYou must first configure your plan carriers, or extract recipients, and add the relevant extract data to the appropriate plantypes, plans, and options. The details of this process are covered in the Configuring Benefits Data Extract for Plan Carriers:Procedure topic.

Submitting Extract RequestTo run and monitor extracts, in the Evaluation and Reporting work area:

1. Click the Extract Benefits Data task.

2. On the Search Results toolbar, click Submit.

3. Enter the extract request options.

Field Comments

Extract Type

For a particular carrier, you can select whether torun a full extract or extract only the changes sinceyou ran the previous extract.

◦ Generally, you run a full extract after anenrollment period closes and enrollments arecompleted.

◦ You run subsequent extracts on a periodic orscheduled basis, in either full or changes onlymode. Common practice is to schedule yourextracts to run after your regular payroll runs.

Transmit

You can transmit the extract as part of the extractrequest, or after the requested extract completesand before or after you view the extract details.

4. Click Submit to submit your process and return to the Extract Benefits Data page.

Viewing and Transmitting Extract DetailsYou can view, query, and download extracted records for a specific extract run after it completes. You can also transmit theextract after the requested extract completes and before or after you view the extract details.

1. In the Search Results section of the Extract Benefits Data page, click the Request ID for the most recent extractrequest for the plan carrier.

2. Review, query by example, and download to a spreadsheet the extracted data, as appropriate.



189

3. Click Done to return to the Extract Benefits Data page.

4. In the Search Results section, click the Transmit icon button for the most recent extract request.

Related Topics

• Configuring Benefits Data Extract for Plan Carriers: Procedure

Custom LayoutAn implementor or developer can create a custom layout to transform the format of extracted benefits enrollment data tomatch the specifications of a particular carrier. This topic provides:

• Descriptions of the tags that you require to create the custom layout

• Table aliases and a sample custom layout

The custom layout becomes the default layout for the plan carrier after you upload it to the plan carrier's extractoptions.

This figure illustrates the structure of the XML tags in the custom layout.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=DC22087B0C39EA31E040D30A6881647C



190

The data source for a field on the custom layout can be a:

• Column on the benefits extract staging tables

• Column on one of the other tables listed in the Source tag description

• Constant into which you enter the exact value

TipTo identify table column names, you can use the data model query builder in Oracle BI Publisher. Search for thetable name and view the columns.

XML Tag DescriptionsThis section describes each XML tag and lists its attributes, elements (subtags), and parent tags.

Description: Root tag.

Attributes: None

Elements (Subtags) Parent Tag

Table

None

Description: Specifies the database table from which to extract the data.

Attributes: 1. tableName: Supported values = {BEN_EXTRACT_REQ_DETAILS,BEN_EXTRACT_REQUEST,DUAL,PER_ALL_PEOPLE_F,PER_PERSONS,PER_ALL_ASSIGNMENTS_M,PER_PEOPLE_LEGISLATIVE_F,BEN_PL_F,BEN_PL_TYP_F,BEN_OPT_F,BEN_PGM_F }


1. RecordType 2. Field: See Field tag description

Layout

Description: Specifies how to delimit or lay out the data in the extract file.

Attributes: Supported values: {FIXEDWIDTH, CSV}

NoteAnything other than CSV is delimited as FIXEDWIDTH by default.


None

Table



191

Description: Corresponds to one column in the extracted document. Source the text in this column from a database table, anSQL function, or a constant.

Attributes: None


1. Name

2. Source

3. Width

4. Padding

Table

Description: Name of the field

Attributes: None


None

Field

Description: Specifies the source of data for the current field.

• If the source is a table, the value passed is the column name.

• If multiple tables are involved, use a fully qualified column name.

The list of allowed tables includes the table aliases.

SQL functions in place of column names: Values in this tag are treated as column names if the type is set to TABLE. Thecolumn name is used directly while constructing a query, so an SQL function can be used on a column.

• Example 1

<Source type="TABLE">GENDER_FLAG</Source>

• Example 2

<Source type="TABLE">DECODE(GENDER_FLAG,'F',1,2)</Source>

Attributes:

1. type:

◦ Supported values = {TABLE, CONSTANT}

• TABLE specifies that the data comes from a database table.

• CONSTANT specifies that the data is given in the value column of this tag.



192

2. table: Use this tag only if the intended column isn't from the table given in the 'tableName' attribute of this Tabletag. If this tag isn't used, the column is searched for in the table given in 'tableName'.

◦ Supported values:

• {BEN_EXTRACT_REQ_DETAILS

• PER_ALL_PEOPLE_F

• PER_PERSONS

• PER_ALL_ASSIGNMENTS_M

• PER_PEOPLE_LEGISLATIVE_F

• BEN_PL_F

• BEN_PL_TYP_F

• BEN_OPT_F

• BEN_PGM_F


None

Field

Description: Specifies the intended width of this field in the extract file. The number passed is the number of character spaceson the file.

Attributes: Supported values are positive integers.


None

Field

Description: Specifies the alignment of data in each column.

Attributes: Supported values: {LEFT, RIGHT}


None

Field



193

Table Aliases

Allowed Table Alias

BEN_ EXTRACT_ REQ_DETAILS

REQ

PER_ ALL_PEOPLE_F

PEO

PER_PERSONS

PER

PER_ ALL_ ASSIGNMENTS_M

ASG

PER_ PEOPLE_ LEGISLATIVE_F

LEG

BEN_PL_F

PLN

BEN_PL_TYP_F

TYP

BEN_OPT_F

OPT

BEN_PGM_F

PGM

Sample XML Layout<?xml version="1.0" encoding="utf-8"?><Layout> <Table tableName="DUAL"> <RecordType>FIXEDWIDTH</RecordType> <Field> <Name>"Record Type"</Name> <Source type="CONSTANT">001</Source> <Width>3</Width> <Padding>Left</Padding> </Field> </Table> <Table tableName="BEN_EXTRACT_REQ_DETAILS"> <RecordType>CSV</RecordType> <Field> <Name>"Last Name"</Name> <Source type="TABLE">LAST_NAME</Source> <Width>25</Width> <Padding>Left</Padding> </Field> <Field> <Name>"First Name"</Name> <Source type="TABLE">FIRST_NAME</Source>



194

<Width>50</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Filler"</Name> <Source type="CONSTANT">XXXXXXXXXX</Source> <Width>10</Width> <Padding>None</Padding> </Field> <Field> <Name>"Plan Name"</Name> <Source type="TABLE">PLAN</Source> <Width>70</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Coverage Start Date"</Name> <Source type="TABLE">COVERAGE_START_DATE</Source> <Width>15</Width> <Padding>Left</Padding> </Field> <Field> <Name>"SSN"</Name> <Source type="TABLE">NATIONAL_IDENTIFIER</Source> <Width>12</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Gender"</Name> <Source type="TABLE">DECODE(GENDER_FLAG,'F',1,2)</Source> <Width>1</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Person Number"</Name> <Source type="TABLE" table="PER_ALL_PEOPLE_F">PERSON_NUMBER</Source> <Width>30</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Country of Birth"</Name> <Source type="TABLE" table="PER_PERSONS">COUNTRY_OF_BIRTH</Source> <Width>30</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Assignment type"</Name> <Source type="TABLE" table="per_all_assignments_m">assignment_type</Source> <Width>30</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Legislation code"</Name> <Source type="TABLE" table="per_people_legislative_f">LEG.LEGISLATION_CODE</Source> <Width>30</Width> <Padding>Left</Padding> </Field> <Field> <Name>"Legislation code"</Name> <Source type="TABLE" table="ben_pl_f">PLN.PL_ID</Source> <Width>30</Width> <Padding>Left</Padding> </Field> </Table> <Table tableName="DUAL"> <RecordType>FIXEDWIDTH</RecordType> <Field> <Name>"Record Type"</Name> <Source type="CONSTANT">999</Source> <Width>3</Width> <Padding>Left</Padding> </Field>



195

<Field> <Name>"Record Type"</Name> <Source type="SYSTEM">RECORDCOUNT</Source> <Width>3</Width> <Padding>Left</Padding> </Field> </Table></Layout>


Chapter 17Oracle Taleo Recruiting Integration

196

17 Oracle Taleo Recruiting Integration

HCM and Oracle Taleo Recruiting Cloud ServiceComponents: How They Work TogetherThe integration between HCM and Oracle Taleo Recruiting Cloud Service facilitates seamless flow of the recruitment processfrom creating a job requisition to hiring a worker.

HCM and Oracle Taleo Recruiting Cloud Service IntegrationThe integration between HCM and Oracle Taleo Recruiting Cloud Service involves the following stages:

1. HCMExporting work structures and worker data to Oracle Taleo Recruiting Cloud Service.

2. Oracle Taleo Recruiting Cloud Servicea. Creating a job requisition using the data imported from HCMb. Selecting candidates for a job requisitionc. Hiring a candidated. Importing candidate data from Oracle Taleo Recruiting Cloud Service

3. HCMa. Creating a pending workerb. Converting the pending worker to an employeec. Exporting changed data to Oracle Taleo Recruiting Cloud Service

Importing Data from Oracle Taleo Recruiting:ExplainedOnce a candidate is selected in Oracle Taleo Recruiting Cloud Service, you must import the candidate data to HCM tofacilitate hiring the candidate as an employee or contingent worker in HCM.

Imported DataThe data that is imported from Oracle Taleo Recruiting to HCM includes the following:

• Candidate data, including:

◦ Person and employment data

◦ Compensation and payroll data



197

◦ Education, certification, and previous experience details, which are captured as a part of HCM Talent• Requisition data

Scheduled ProcessesYou can access the Import Oracle Taleo Recruiting Cloud Service Data process from the Scheduled Processes work area.You can run this process manually or schedule it to run at regular intervals (for example, weekly at a specified time). The likelyvolume and frequency of hiring persons in your enterprise determines how often you run this process.

After you run the import process, you can view the selected candidates in the New Person Overview page. The SelectedCandidates page displays a list of candidates ready to be added as pending workers. Once you add a candidate as apending worker, the candidate appears in the Pending Workers list. You can then convert the pending worker to an employeeor a contingent worker. The imported person, payroll, compensation, and talent (education, certification, and previousexperience) details appear by default in the Convert Pending Worker flow.

NoteAfter you import a candidate from Oracle Taleo Recruiting to HCM, if you make any changes to the candidate orrequisition in Oracle Taleo Recruiting, these changes aren't included in the subsequent import runs.

Exporting Data to Oracle Taleo Recruiting: ExplainedOracle Taleo Recruiting Cloud Service uses HCM work structures and worker data to create and process job requisitions.You can export this data from HCM to Oracle Taleo Recruiting Cloud Service.

HCM and Oracle Taleo Recruiting Cloud Service MappingThe following table lists the business objects that HCM exports and the corresponding business objects that they aremapped to in Oracle Taleo Recruiting Cloud Service.

HCM Oracle Taleo Recruiting Cloud Service

Departments

Departments

Jobs

Requisition Templates

Business Units

Organizations

Users

Users

Employees

Candidates

Locations

Locations

Positions

Large User Data Selection, used in offer



198

HCM Oracle Taleo Recruiting Cloud Service

Grades

Large User Data Selection, used in requisition

Legal Employers

Large User Data Selection, used in requisition

Job Families

Job Fields

About Exporting Employees and UsersAs a part of the integration, HCM exports employees and users such as Managers, Hiring Managers, and Recruiters, whohave the privilege to create requisitions in Oracle Taleo Recruiting Cloud Service. From the HCM perspective, user andemployee data are the same, and use the same data mapping. The employee or user creation process relies on certaindefault user types provisioned in Taleo. The following table lists the users exported from HCM, and the user types they aremapped to in Oracle Taleo Recruiting Cloud Service.

(Fusion) User (Taleo) User Type

Employee

Employee

Manager or Hiring Manager

Recruiting - PowerManager

Recruiter

Recruiting - PowerRecruiter

NoteThe later versions of Taleo (version 13B and later) include new default user types, which may not comply withthe user-mapping definition shown in the table. In this case, the Taleo Application Administrator can manuallyconfigure the user groups for all users imported from Fusion HCM. For more information about the new defaultuser types and configuring user types in Taleo, see the Fusion-Taleo Integration Taleo Configuration Guide.

Scheduled ProcessesYou can schedule the following process in the Scheduled Processes work area:

• Export All Oracle Taleo Recruiting Cloud Service Data

Exports all work structures and worker data from HCM to Oracle Taleo Recruiting Cloud Service. You need to runthis process typically only once, in the beginning, to send all HCM data to Oracle Taleo Recruiting Cloud Service toenable creation of job requisitions.

• Export Changed Oracle Taleo Recruiting Cloud Service Data

Exports any changed work structures and worker data from HCM to Oracle Taleo Recruiting Cloud Service. You canrun this process manually or schedule it to run at regular intervals (for example, weekly at a specified time). The likelyvolume and frequency of hiring persons in your enterprise will determine how often you run this process.



199

FAQs for Oracle Taleo Recruiting and HCMIntegration

What are Large User Defined Selections (LUDS)?Some business objects in HCM don't map directly to any business objects in Oracle Taleo Recruiting Service, when exportingdata from HCM to Oracle Taleo Recruiting Service. These business objects (for example, legal employers, jobs, and positions)are mapped to Large User Defined Selections (LUDS) instead. LUDS are custom, user-defined fields in Oracle TaleoRecruiting Service, specifically configured for the integration with HCM. The mappings are defined in the Taleo application.


Chapter 18File Encryption Using HCM Connect

200

18 File Encryption Using HCM Connect

HCM Connect: ExplainedHCM Connect allows you to encrypt files of data so that you can transfer them between your servers and Oracle WebCenterContent Server. For example you can encrypt and decrypt files with sensitive employee data or confidential documents. HCMConnect allows you to create inbound and outbound integrations and automate the process of file transfers. HCM Connectsupports the transfer of encrypted files and invokes the HCM File-Based Loader program to decrypt and load the data withinthe files.

Inbound IntegrationsFor inbound integrations, HCM Connect picks up the files from your file server, places them into OracleWebCenter ContentServer and invokes the HCM File-Based Loader program to decrypt and load the data within the file into Oracle Fusion HCMCloud.

Outbound IntegrationsFor outbound integrations, you can extract data from Oracle Fusion HCM Cloud using HCM Extracts to Oracle WebCenterContent Server, and then use HCM Connect to encrypt that data to export it to your server. You can specify that you wantto encrypt a specific HCM Extract file when the file is generated using the supported encryption methods. Oracle Fusionautomatically transports the file to your server or 3rd party server for processing and it stays securely encrypted until yourprogram uses HCM Connect V1 APIs, or your own PGP or X509 algorithm, to decrypt the file before processing.

SchedulingSet up scheduling options to automate the process of picking up the files, transporting them to Oracle WebCenter ContentServer, and loading the files into Oracle Fusion HCM. You can also set up HCM Connect to schedule a process to runperiodically, to pick up files generated by HCM Extract (with HCM Connect as a destination).

Encryption TypesOracle Fusion HCM Connect V1 supports the following types of Pretty Good Privacy (PGP) encryption and decryption types:

1. PGP Signed

2. PGP Unsigned

3. PGP X.509 Signed

4. PGP X.509 Unsigned

For more information on HCM Connect, see the HCM Connect User's Guide available on My Oracle Support.

Related Topics

• HCM Connect User Guide

https://support.oracle.com/epmos/faces/DocumentDisplay?id=1934637.1


Chapter 19Web Services

201

19 Web Services

OverviewUse web services to integrate web-based applications into your Oracle Fusion applications. Web services expose OracleFusion Applications business objects and processes to other applications through the use open standards-basedtechnologies. Some of these technologies include Extensible Markup Language (XML), Simple Object Access Protocol(SOAP), Business Process Execution Language (BPEL), Web Services Description Language (WSDL), and XML schemadefinitions (XSD). Oracle Fusion Applications web services support development environments and clients that comply withthese open standards.

Oracle Fusion Applications includes two types of web services: Application Development Framework (ADF) services andcomposite services. The following table describes the two types.

Web Service Type Description

ADF services

ADF services usually represent business objects, suchas employees or purchase orders. ADF services typicallyexpose standard operations, such as create, update,and delete. However, for locally-persisted objects, ADFservices are not limited to these operations.Examples of ADF services include:

• Worker.changeHireDate - a service that updates thehire date of the worker business object.

• ProjectTask.createTask - a service that adds a task tothe project task business object.

Composite services

Composite services usually represent end-to-endbusiness process flows that act on business eventsproduced by the ADF services. Composite servicesorchestrate multiple object-based services, rulesservices, and human workflows. Examples of compositeservices include:

• ProjectStatusChangeApproval.process - a service thataccepts the change in project status.

• ScheduleOrchestrationOrderFulfillmentLineService.scheduleOrders- a service that schedules resources used to fulfillan order.

Access Oracle Enterprise Repository for Oracle Fusion Applications to find detailed information about integration assets, suchas web services. To view lists of web services, select these asset types:

• ADF Service

• ADF Service Data Object


Chapter 19Web Services

202

• Composite Service

• Composite

Service methods and parameters, the service path, the WSDL URL and other technical data, appear on the Detail tabof each web service. Step-by-step instructions regarding the invocation of a service and the service XSD appear on theDocumentation tab.

Related Topics

• Oracle Enterprise Repository for Oracle Fusion Applications: Explained

HCM RESTful Services and Atom Feeds: OverviewREST (representational state transfer) services, or RESTful services, are available for these human capital management (HCM)resources:

• Employee

• Employee's assignment

• Employee's job roles

The available operations for these services allow the query, creation and update of an employee or his assignments or jobroles.

REST services provide some architectural and framework advantages over a SOAP-based approach, and are driven by ause case-based approach. Instead of creating an employee as a resource and adding the employeeâ��s phone number, E-Mail address, nation ID number, and other child objects as child resources, REST services create a simple flattened employeeresource, where the most commonly referenced child objects are included as attributes on the main employee resource. Thisenables you to create all child object records using a single REST service call to create the employee.Atom, or RSS, feeds allow software programs (or an RSS Reader) to subscribe to updates published to an Atom or RSSserver. The updates are published when the change occurs in Oracle Fusion. The primary Atom feeds supported foremployee are:

• New Hire

• Terminations

• Assignment Update

For more information about how to use RESTful services and Atom feeds, see the Oracle Enterprise repository (OER).

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=CDDB78657865FD14E040D30A68817D37


Chapter 20Coexistence for HCM Introduction

203

20 Coexistence for HCM Introduction

Offering OverviewUsing the Coexistence for HCM offering, you can integrate your existing Oracle Human Capital Management (HCM)applications with a hosted Oracle Fusion HCM implementation. You can use Oracle Fusion Workforce Compensation andOracle Fusion Talent Management functionalities alongside of your existing applications.

ImportantThe Coexistence for HCM offering is supported only for existing customers of Coexistence for HCM.

Before you begin:

1. Use the Getting Started page in the Setup and Maintenance work area to access:

◦ Reports for the offering, including full lists of setup tasks

◦ Descriptions of the options and features that you can select when you configure the offering

◦ Lists of business objects and enterprise applications associated with the offering

2. Create one or more implementation projects for the offering to generate task lists for each project. The applicationimplementation manager can customize the task list and assign and track each task.

Task List Groups for Coexistence for HCM : ExplainedThe application generates task list for one or more implementation projects that you have created for the Coexistence forHCM offering. The application implementation manager can customize the task list and assign and track each task.


The task list for the Coexistence for HCM offering contains the following groups of tasks.

Task List Description

Define Synchronization of Users and Roles from LDAP

Run a process to populate the product tables containinguser and role information with the users and roles heldin LDAP. This process is always the first implementationtask but can also run periodically to keep the producttables synchronized with subsequent updates to LDAP.

Define Implementation Users

Create implementation users and roles. Provisionimplementation users with job and data roles.



204


Review Enterprise Information

Review the employment model, enterprise name, andother information required in an HCM coexistenceimplementation between Oracle Fusion Applications anda source application, such as Oracle PeopleSoft HRMS.

Define HCM Configuration for Coexistence

Define the configuration between a source applicationand Oracle Fusion Applications.

Define Reference Data Sharing

Specify how reference data in the application should bepartitioned and shared.

Define Legal Jurisdictions and Authorities for HumanCapital Management

For HCM coexistence, create the address a legal entityuses to register with a legal authority. Legal entitiescan use different addresses for different authorities;therefore, they may have more than one registeredaddress. The legal address must be located within theterritory entered.

Define Currencies and Currency Rates

Define the currencies and currency rates in which yourorganization does business.

Define Legal Entities for Human Capital Management

Access your companies or other registered legal entitiesand specify attributes relevant to Oracle Fusion HumanCapital Management. Create and maintain informationfor legal entities and legal reporting units for businessactivities handled by the Oracle Fusion applications.

Define Legal Reporting Units for Human CapitalManagement

Define legal reporting units, also known as tax reportingunits in HCM, for the enterprise to report on tax andsocial insurance for employee records.

Define Lookups

Review and manage sets of codes and their displayedmeanings in applications.

Define Human Resource Records for Coexistence

Define human resource records required in acoexistence implementation between Oracle FusionApplications and a source application.

Define Data Mapping for Coexistence

Define data mapping between your source applicationand Oracle Fusion Applications in a coexistenceimplementation.



205


Load Coexistence Data for Work Structures Records

Load work structures records from your sourceapplication to Oracle Fusion Applications in acoexistence implementation.

Define Business Units for Human Capital Management

Access your business units and specify units andattributes relevant to Oracle Fusion Human CapitalManagement. Create and maintain information on unitsof an enterprise to allow for flexible implementation, toprovide a consistent entity for controlling and reportingon transactions, and to be an anchor for the sharing ofsets of reference data across applications.

Load Coexistence Data for People

Load person data from your source application to OracleFusion Applications in a coexistence implementation.

Load Coexistence Data for Employment

Load employment data from your source applicationto Oracle Fusion Applications in a coexistenceimplementation.

Run Post-Data-Load Processes for HCM Person andEmployment

Run processes to enable successful deployment ofperson and employment data in Oracle Fusion.

Define Security for Human Capital Management forCoexistence

Define security for Human Capital Management for acoexistence implementation.

Define Data Security for Human Capital Management

Define data security for Human Capital Management.

Define Users for Human Capital Management forCoexistence

Define users for Human Capital Management for acoexistence implementation.

Define Help Configuration

Define what users can see and do in a local deploymentof Oracle Fusion Applications Help.

Load Coexistence Data for Workforce Compensation

Load workforce compensation records from yoursource application to Oracle Fusion Applications in acoexistence implementation.

Run Post-Data-Load Processes for WorkforceCompensation

Run processes to enable successful deployment ofworkforce compensation data in Oracle Fusion.



206


Load Coexistence Data for Talent Management

Load talent records from your source applicationto Oracle Fusion Applications in a coexistenceimplementation.

Load Coexistence Data for Profile Management

Load profiles records from your source applicationto Oracle Fusion Applications in a coexistenceimplementation.

Configure Oracle Fusion Global Human Resources,Talent Management, and Workforce Compensation

Complete the implementation in Oracle Fusion ofOracle Fusion Talent Management and Oracle FusionWorkforce Compensation.

HCM Coexistence: ExplainedUsing HCM coexistence, you can integrate your existing Oracle Human Resource (HR) applications with specific OracleFusion Human Capital Management (HCM) features without migrating fully to Oracle Fusion HCM.


The HCM coexistence interface in the Data Exchange work area manages data loads and data extracts between your sourceapplication and Oracle Fusion. It's prebuilt, fully supported, and leverages Oracle's integration framework and guidelines. Youcan synchronize business object data between your source application and Oracle Fusion HCM applications based on datamaps, which you create.

The Oracle Fusion HCM features that you can use in the HCM coexistence scenario are:

• Talent Review

• Worker Goal Setting

• Worker Performance

• Workforce Compensation

• Social Networking

The Oracle Applications Unlimited applications that you can integrate with Oracle Fusion Applications are:

• Oracle PeopleSoft Enterprise HRMS 8.9

• Oracle PeopleSoft Enterprise HRMS 9.0

• Oracle PeopleSoft Enterprise HCM 9.1

• Oracle E-Business Suite HRMS 11i

• Oracle E-Business Suite HRMS 12.1



207

The following figure summarizes key components of the HCM coexistence scenario.

Core HR DataCore HR data related to person, employment, workforce structures, and compensation data is owned by the sourceapplication but uploaded periodically to Oracle Fusion. The source application remains the source of truth for this data, andyou maintain the data in the source application.

Talent Management DataTalent management data is migrated to Oracle Fusion. Thereafter, Oracle Fusion is the source of truth for this data, and youmaintain this data in Oracle Fusion.



208

Workforce Compensation DataCompensation data is owned by the source application. Changes made to compensation data using the WorkforceCompensation for Coexistence feature are extracted following a compensation-review cycle and returned to the sourceapplication for further processing, such as payment through the payroll application.

Workforce Directory ManagementOracle Fusion Workforce Directory Management (WDM) provides HR functionality in the HCM coexistence environment. Italso provides Oracle Fusion users with access to the Oracle Fusion HCM Person Gallery.

A Hosted SolutionIn the HCM coexistence scenario, Oracle Fusion HCM features are hosted by a service provider, such as Oracle On Demand.The service provider sets up the connection between your source application and Oracle Fusion. You work with the serviceprovider to configure the Oracle Fusion environment before performing the initial data load.

NoteHCM coexistence must not be considered an interim stage in a full migration to Oracle Fusion Applications. HCMcoexistence is designed to work permanently alongside your existing Oracle Applications Unlimited applications.

Related Topics

• Initializing HCM Coexistence: Explained

Oracle Fusion Workforce Directory Management:ExplainedOracle Fusion Workforce Directory Management (WDM) provides access to a subset of Oracle Fusion Human CapitalManagement (HCM) functions in the HCM coexistence environment. This topic summarizes any limitations on the PersonGallery, Manager Resources dashboard, and Human Resources dashboard functions for HCM coexistence users.


Person GalleryAll Person Gallery tabs (Person Gallery, Organization Chart, My Portrait, and dynamic portrait tabs) and most Person Galleryfeatures are available to HCM coexistence users.

Therefore, user roles may need to be customized (by removing duty roles) to prevent users from performing transactionsthat update data for which Oracle Fusion is not the system of record. For example, users can update their address from theMy Portrait tab. However, users must make that change in the source application, from where it will be uploaded to OracleFusion.

If Oracle Fusion Talent Management is installed, transactions that update talent-related data can be initiated from the PersonGallery.



209

Portrait CardsA person's portrait comprises multiple portrait cards, each of which is populated with relevant data. For example, a portraitcan include Contact Information, Employment, Development and Growth, and User Account Details cards.

Cards appear in the portrait only when the underlying function is available. For example, the Compensation card appears onlyif you use Oracle Fusion Workforce Compensation, and the Career Planning card appears only if you use Oracle Fusion TalentManagement.

The following portrait cards never appear because the underlying functions aren't available in the HCM coexistenceenvironment:

• Availability

• Payroll

• Benefits

Manager Resources DashboardThe Manager Resources dashboard provides analytics of interest to line managers. In the HCM coexistence environment,some analytics don't appear because the relevant data is not available. For example, the Compensation tab in the MyOrganization region of the dashboard appears only if you use Oracle Fusion Workforce Compensation. The followingtable shows the analytics that are available in the HCM coexistence environment and identifies any Oracle Fusion productdependencies.

Dashboard Analytic Requires

My Organization, General tab

My Organization, Employment tab

My Organization, Compensation tab

Oracle Fusion Workforce Compensation

My Organization, Performance tab

Oracle Fusion Talent Management

Promotion Potential

Oracle Fusion Workforce Compensation Oracle Fusion Talent Management

Performance and Potential


My Organization Rating Distribution


Task Completion Status




210

Human Resources DashboardThe Human Resources dashboard provides analytics of interest to human resource specialists. In the HCM coexistenceenvironment, some analytics don't appear because the relevant data isn't available. The following analytics are available in theHCM coexistence environment:

• Service Anniversaries

• Work Structures with No Assignments

• Grade Salary Ranges

• Assignments with No Manager


Chapter 21Coexistence for HCM Security

211

21 Coexistence for HCM Security

Implementation Users: ExplainedThe following tasks are relevant to the creation of implementation users who can complete the setup of HCM coexistence:

1. Create Implementation Users

2. Create Data Role for Implementation Users

3. Provision Roles to Implementation Users

To perform these tasks, you must have the IT security manager role. Depending on how you're implementing HCMcoexistence, a local security administrator or your service provider (for example, Oracle On Demand) may perform thesetasks.


Creating Implementation UsersImplementation user is a user name and password for the person or people who will be performing the setup tasks for theHCM coexistence offering. Implementation users don't need to be associated with HCM person records.

Creating Data Roles for Implementation UsersBy default, the application implementation consultant job role has view-all access to all HCM data resources that are relevantto the job role, and is sufficient for the implementation of HCM coexistence. You don't need to create an HCM data role forthe application implementation consultant job role.

Provisioning Roles to Implementation UsersImplementation users can't perform the setup tasks for HCM coexistence until you provision relevant roles to them.

You provision the following roles to implementation users:

• IT security manager job role

• Application implementation consultant job role

ImportantWhen the implementation of HCM coexistence is complete, you're strongly recommended to revoke theseroles from implementation users. The level of access that they provide to HCM data is not required outside theimplementation phase and may constitute a security exposure.

Defining Security: ExplainedYou can manage job roles and duties for HCM coexistence using the Manage Job Roles and Manage Duties tasks, if you'reassigned the IT Security Manager role. You perform these tasks during implementation using the Oracle Fusion Functional



212

Setup Manager and subsequently in the Oracle Fusion Human Capital Management (HCM) Setup and Maintenance workarea.


Reviewing the Security Reference ImplementationOracle Fusion HCM provides a comprehensive set of predefined security data, known as the security referenceimplementation, which includes multiple instances of each of the components in the following table.

Security Reference Implementation Component Example

Job role

Human Resource Specialist

Abstract role

Employee

Duty role

Worker Work Relationship Termination Duty

Privilege

Terminate Work Relationship

Data security policy

A Human Resource Specialist can terminate workrelationship for persons and assignments in their personand assignment security profile

Security profile

View All Workers

You review the security reference implementation to determine whether the predefined components, in particular the job andduty roles, meet enterprise requirements.

For more information on the security reference implementation for Oracle Fusion HCM, see:

• Oracle Fusion Applications Human Capital Management Security Reference Manual

• Oracle Fusion Applications Common Security Reference Manual

Managing Job RolesYou use Oracle Identity Management (OIM) to implement job and abstract roles, and manage them using the Manage JobRoles task. If the security reference implementation contains all enterprise job and abstract roles, you don't need to performthis task. Otherwise, you may need to create new job or abstract roles.

NoteYou may retain predefined job or abstract roles that the enterprise doesn't use because you don't have toprovision those roles to users.



213

Managing DutiesUse the Manage Duties task to manage the duty-role hierarchy. The security reference implementation provides one or moreduty roles for every function in Oracle Fusion Applications. Therefore, you need to create new duty roles only if you createcustom functions. For example, if you create new job or abstract roles, you must assign duties to those roles.

You must remove unused duty roles from abstract and job roles. Otherwise, HCM coexistence users will have access tofunctions aren't relevant to them. For example, the predefined job role Human Resource Specialist inherits the duty roleWorker Work Relationship Termination Duty. In the HCM coexistence environment, work relationships must be terminatedin the source application. Therefore, the Worker Work Relationship Termination Duty is an unused duty role that needs to beremoved from the job role.

You may need to remove duty roles from the following predefined roles, because these roles aren't specific to a single featureof the HCM coexistence offering:

• Contingent worker

• Employee


• Human Resource Analyst

• Human Resource Specialist

• Human Resource Vice President

• Line manager

You manage duty roles in the Oracle Fusion Middleware Authorization Policy Manager (APM) using the Manage Dutiestask. For guidance about the duty roles that you may need to remove from job and abstract roles, see the Oracle FusionApplications Human Capital Management Security Reference Manual.

Creating Job Roles: ProcedureIf the enterprisejob roles don't exist in the security reference implementation, you must create new job roles. This procedureexplains how to create new job roles.


1. Create the new job roles in Oracle Identity Management (OIM).

If you create new job or abstract roles, add them to role categories that end with Job Roles or Abstract Roles, asappropriate. For example, you could create a new category for job roles called ABC - Job Roles.

2. Attach duty roles to the new job roles in the Oracle Fusion Middleware Authorization Policy Manager (APM).

3. Run the Oracle Fusion Human Capital Management (HCM) process Retrieve Latest LDAP Changes so that the newjob roles appear in the Oracle Fusion HCM Create Data Role interface.

If you add custom job or abstract roles to role categories that don't end with Job Roles or Abstract Roles, theydon't appear in the list of jobs in Create Data Role.

4. Create HCM data roles for the new job roles using the Manage Data Role and Security Profiles task in Oracle FusionHCM.



214

5. Create role mappings for the new data roles using the Manage Role Mappings task in Oracle Fusion HCM so thatthe roles can be provisioned to users.

Creating Users and Provisioning Roles: ExplainedLoading workers to Oracle Fusion from your source application creates requests for user accounts by default. Oracle IdentityManagement (OIM) processes these requests to create and maintain user accounts. You work with your service provider toconfigure items such as identity policy and password policy in OIM. Users have a user name and password that are specificto their use of Oracle Fusion applications.


The process for creating users and provisioning roles to them varies according to whether you're performing an initial orincremental data load.

Initial Data LoadTo create users and provision roles to them during the initial data load, you:

1. Create the role provisioning rules required by your enterprise.

To manage both automatic and manual provisioning of roles to users, you create role mappings. For example, youcreate role mappings to provision abstract roles, such as employee, automatically to all employees. A typical userhas multiple roles. To create role mappings, you perform the Manage HCM Role Provisioning Rules task.

NoteIf your initial data load includes large volumes of person and employment data, you're recommended toperform step 1 (this step) after step 3.

2. Load person and employment data.

Perform the task Load HCM Data for Coexistence in the Setup and Maintenance work area.

NoteOIM doesn't support duplicate e-mails. You can perform the Manage Users task to change a duplicatee-mail to a unique value. However, you must also change the source value to ensure that you don'toverwrite the updated e-mail when you next load person records.

3. Run the Send Pending LDAP Requests process.

This process sends bulk requests to OIM to create, suspend, and reenable user accounts, as appropriate.

4. Apply autoprovisioning, on the Manage Role Mappings page to assign all roles with the Autoprovision optionselected to eligible workers.

5. Manually assign roles, as appropriate.

◦ Managers and human resource specialists who satisfy the role mapping conditions can assign some roles toother workers. The roles must have the Requestable selected in the role mapping.



215

◦ Workers who satisfy the role mapping conditions can request for themselves roles identified in your roleprovisioning rules as Self-requestable.

ImportantOnce users exist in OIM, you must not delete them from OIM.

Incremental Data LoadAfter the initial data load, the process for managing users and role provisioning is as follows:

1. Update role provisioning rules, if necessary.

The role mappings for the initial data load may be sufficient. However, you're recommended to validate them andmake any changes before you perform an incremental data load.

2. Load person and employment data using the Load Data for Coexistence task in the Data Exchange work area.

3. Run the Send Pending LDAP Requests process.

You can schedule this process to run daily, for example.

4. Manually assign requestable roles, as appropriate.

Related Topics

• Synchronization of User and Role Information with Oracle Identity Management: How It's Processed

• Role Mappings: Explained

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=992DEABE263D7A22E040D30A68813391

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=9633D922BF48554FE040D30A68815494


Chapter 22Coexistence for HCM Setup

216

22 Coexistence for HCM Setup

Configuration ParametersThe HCM Configuration for Coexistence parameters determine how the Load Batch Data process operates. Theseparameters apply whether you run the process independently or as part of the Load HCM Data for Coexistence process.


Use the Manage HCM Configuration for Coexistence task to set these parameters during implementation. You don't need toalter them later, unless for a specific purpose such as error correction.

ImportantUnless otherwise indicated, you can't override the values of these parameters for individual data-load processes.

Oracle On Demand Parameters

Parameter Name Default Value Can Be Overridden?


Null

No


Name of the Oracle On Demand server's mounted root directory.

Oracle Data Integrator Parameters


ODI Context

DEVELOPMENT

No

ODI Log Level

2

No

ODI NLS Language

AMERICAN_ AMERICA.WE8ISO8859P1

No

ODI Password

Null

No



217


ODI Root Directory

Null

No

ODI User

Null

No

ODI Work Repository

FUSIONAPPS_ WREP

No

ODI Context

The logical name of the group of logical-to-physical mappings for connections in Oracle Data Integrator (ODI).

ODI Log Level

A numerical value between 1 and 5, where 5 is high, indicating the level of detail included in the ODI log file. Don't change thedefault value unless requested to do so by Oracle Support.

ODI NLS Language

The ODI import file language and encoding settings.

ODI Password

The password for the ODI user name.

ODI Root Directory

The file system directory where ODI creates work and log files.

ODI User

The ODI user name.

ODI Work Repository

The ODI repository that contains ODI-related code definitions.

Loader Parameters



N

No


N

No


N

No



218



500

No

Loader Chunk Size

100

Yes

Loader Maximum Errors Allowed

100

Yes


1

Yes

Loader Save Size

1

No


Determines whether incremental loads of talent-management data overwrite existing Oracle Fusion records. If you leave thedefault value N, then any talent-management data uploaded after the first load overwrites existing records. If you set thisparameter to Y, then only new talent-management records are processed. Records that already exist in Oracle Fusion areignored.

Typically, you migrate talent-management data to Oracle Fusion. After the initial load, you maintain existing records andcreate new records in Oracle Fusion. However, if you need to create new talent-management records in your sourceenvironment, then you can upload them to Oracle Fusion. In this case, you set Allow Talent Data Increment Load to Yso thatonly the new records are uploaded.


Determines whether person-search keywords are updated during the load process for individual person business objects. Ifyou set this parameter to Y, then the load process slows down. Instead, you are recommended to run the Update PersonSearch Keywords process during post-load processing for HCM person and employment data.


Indicates, for the enterprise, whether the Load HCM Data for Coexistence process runs automatically on receipt of a zippeddata file from a source application. If you leave this parameter set to N, then you must run Load HCM Data for Coexistencemanually.


The number of logical business objects to be processed before the Load Batch Data process clears the cache. Don't changethis value unless requested to do so by Oracle Support.

Loader Chunk Size

The number of logical business objects a single Load Batch Data thread processes in a single action.

Set this value based on the total number of objects to be loaded and the Loader Number of Processes value.




219

The maximum number of errors in a thread before processing terminates. If an error occurs when processing a complexlogical business object (such as a person record), then all rows for that business object are rolled back and marked as Error inRow.


The number of Load Batch Data threads to run in parallel. If you're processing large amounts of data (for example, more than1000 rows) or complex data (such as person and work relationship data), consider running 4 or 8 threads in parallel.

Loader Save Size

The number of logical business objects to be processed before committing the objects to the database. Don't change thisvalue unless requested to do so by Oracle Support.

User Name Parameters



Null

No


User name of an HCM coexistence user. By default, it's the person's e-mail address. You can set the user name to either theperson number or an assignment number by entering one of the following expressions in the User Name Expression field:

• loaderCtx.getPersonAttr("PersonNumber")

• loaderCtx.getAssignmentAttr("AssignmentNumber")

Initializing HCM Coexistence: ExplainedOnce you configure your source application for use with Oracle Fusion and establish connections between the two systems,you're ready to perform the initial load of business objects from the source application to Oracle Fusion.




220

The following figure summarizes the initial data-load process.

Definition of Business Objects in Oracle FusionYou define the following business objects in Oracle Fusion by performing the associated tasks in the order specified by theOracle Fusion Functional Setup Manager.

Business Object Task


Manage Reference Data Sets

Employment Action

Manage Actions


Manage Action Reasons

Enterprise

Manage Enterprise HCM Information



221


Legal Employer Organization Payroll Statutory Unit Organization

Manage Legal Entity HCM Information

Legal Entity

Manage Legal Entity


Manage Legislative Data Groups


Manage Elements


Manage Elements


Manage Assignment Status

Person Type

Manage Person Types

You define the following objects only if you use Oracle Fusion Talent Management for Coexistence.



Manage Profile Content Types

Talent Profile Type

Manage Profile Types

Talent Instance Qualifier




Generation and Export of Mapping Identifiers from Oracle FusionYou generate and export mapping identifiers for the business objects using the Manage HCM Configuration for Coexistencetask. The mapping identifiers are placed automatically in a zipped data file that is written to the file server, from where thesystem administrator for the source application can retrieve it.

Creation of Data Maps in the Source ApplicationYou map business objects in the source application to Oracle Fusion objects so that data can be exchanged between thetwo data models. The detail of this task depends on the source application.



222

Extraction of Data from the Source ApplicationWhen the data-mapping task is complete, you extract data for upload to Oracle Fusion from the source application andtransfer it to the file server. The detail of this task depends on the source application.

Initial Data LoadYou load data to Oracle Fusion by performing the Load Data for Coexistence task. For the initial data load, you perform thetask once for each of the following groups of business objects:

1. Work structures records

2. Person records

3. Employment records

4. Workforce compensation records

5. Talent management records

You perform the initial data load in the order in which the data-load tasks appear in the Oracle Fusion Functional SetupManager. In addition, you load the business objects within each group in a specified order to respect dependencies betweenthem.

Related Topics• Generating Mapping Identifiers for HCM Business Objects: Explained

• HCM Data for Coexistence: How It's Loaded

• Mapping Oracle E-Business Suite HRMS Data for HCM Coexistence: Explained

• Mapping PeopleSoft HRMS Data for HCM Coexistence: Explained

Sychronizing Data After Initial Data Load: ExplainedAfter the initial data load completes successfully and you begin to use Oracle Fusion, you must take steps to keep datasynchronized between your source application and Oracle Fusion.


The initial data load migrates Talent Management records to Oracle Fusion Talent Management, which becomes the sourceof truth for that data. However, all the other data that you upload is managed in the source application. Therefore, you mustupload this data to Oracle Fusion regularly to ensure that data in both the environments remains synchronized. The frequencyof incremental data loads (also performed using the Load Data for Coexistence task) depends on the frequency of changes tothe source data and your use of Oracle Fusion.

Traffic between the source application and Oracle Fusion is two-way. You must extract data updated by Oracle FusionWorkforce Compensation and return it to the source application for further processing. For example, you must return aworker's salary amount to the source application for payment by the payroll system. To extract data from Oracle Fusion,you perform the Extract Data for Coexistence task. You must upload data to Oracle Fusion again only after loading thecompensation changes to the source application.



223

Reference Data Sets: Points to ConsiderWhen you set up an HCM coexistence environment, you must identify the reference data sets you need. Reference datasets provide a mechanism for separating and sharing definitions of specific business objects among business units. The set-enabled business objects that are relevant to all uses of HCM coexistence are locations, grades, jobs, and departments.Performance templates, which are relevant to Oracle Fusion Talent Management, are also set-enabled.

You must create reference data sets before you load data from your source application. Use the Manage Reference DataSets task in Oracle Fusion to create the data sets. The approach you take varies with the source application. However, theaim is to reflect your source configuration of relevant business objects as efficiently as possible in Oracle Fusion.


Oracle PeopleSoft EnterpriseIf your source application is Oracle PeopleSoft Enterprise, depending on how you want to partition your data in Oracle Fusion,you can:

• Create in Oracle Fusion, the same reference data sets that you use in PeopleSoft Enterprise and map any set-enabled data to a corresponding reference data set in Oracle Fusion.

• Map all set-enabled data in PeopleSoft Enterprise to the common set provided in Oracle Fusion.

Oracle E-Business SuiteIf your source application is Oracle E-Business Suite, you map each business group to a business unit and identify areference data set for each business unit. The mapping between a business group, a business unit, and a reference data setmust be one-to-one to ensure that jobs, grades, locations, and departments are unique within a reference data set.

ImportantIf you use the predefined common reference data set for all business groups, errors may occur during dataloading. However, you can use the predefined common set for your global location and competency values.

Related Topics• Business Units and Reference Data Sets: How They Work Together

Enterprise Structures: Points to ConsiderFor HCM coexistence, you need not specify Oracle Fusion enterprise structures in as much detail as you would for a fullinstall. This topic identifies the HCM coexistence requirements for enterprise structures.


EnterpriseYour service provider defines the enterprise. You can change the enterprise name, if appropriate. However, you must leaveall other enterprise values as specified by the service provider. In particular, you must use the two-tier multiple-assignmentemployment model when using HCM coexistence.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=A1DA1323224F708DE040D30A688137C1



224

Legislative Data GroupsCreate a legislative data group for each currency in which you pay workers. If you use Oracle Fusion WorkforceCompensation, you later define a set of elements for each legislative data group.

Legal EntitiesThe minimum requirement is to create a legal entity for each country in which you pay workers. You must define each legalentity as both a legal employer and a payroll statutory unit (PSU), and associate the relevant legislative data group with thePSU.

ImportantAny attempt to load element entries will fail if you don't define the legal entity as a PSU. Don't changeemployment-model settings inherited from the enterprise.

If you are using Oracle E-Business Suite HRMS, you specify a default legal entity for each business group when mapping databetween your source application and Oracle Fusion. You can't map multiple business groups to a single legal entity.

DepartmentsYou upload departments from the source application when you load work structure records using the Load Data forCoexistence task. You upload each E-Business Suite HR Organization to Oracle Fusion as a department.

Business UnitsYou upload business units from the source application when you load work structure records using the Load Data forCoexistence task. You use business units for sharing reference data sets among organizations. There is a one-to-onecorrespondence between business groups in E-Business Suite HRMS and business units. You identify a business unit foreach business group during the data-mapping phase prior to uploading data to Oracle Fusion.

NoteIf you use another Oracle Fusion product that shares business units with HCM coexistence, then the business unitmay be updated outside the context of HCM coexistence. You must coordinate such updates and ensure thatany changes are applied also in the source application to avoid conflict.

Related Topics

• Legal Entities: Explained

• Legislative Data Groups: Explained

• The Two-Tier Employment Model: Explained

Actions and Action Reasons: Points to ConsiderActions track changes to Human Capital Management (HCM) data, such as employment and compensation records. Whenyou create or update a record, the action value identifies the cause of the record creation or change. Action reasons, whichare optional, provide additional information about the action. Oracle Fusion Workforce Compensation uses workforcecompensation components and salary components, in addition to compensation actions and action reasons, to trackchanges to compensation records.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=8C12D145B79B7225E040D30A688125D0

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=92E9A012F2DE1198E040D30A68817CA6

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=9643AF7224ABF359E040D30A6881273A



225


Action and action reason values that are predefined in both Oracle Fusion and your source application are already mapped.If you have created additional values in the source application, you must ensure that they are mapped to values in OracleFusion. You can:

• Map them to predefined Oracle Fusion values.• Create new actions, action reasons, workforce compensation components, or salary components in Oracle Fusion,

as appropriate, and map your source-application values to these new values.

You must complete this task before you load data from your source application to Oracle Fusion.

ImportantIf your source application is Oracle E-Business Suite HRMS, you must map leaving reasons and salary componentcodes to Oracle Fusion actions and action reasons. For all other relevant transactional changes, the default OracleFusion action (Assignment Change, Hire, or Add Contingent Worker, as appropriate) is used automatically.

Related Topics• Action Components: How They Work Together

• Actions and Reasons, Salary Components and Plan Components: How They Work Together

Assignment Statuses: ExplainedIn Oracle Fusion, the predefined assignment status values indicate whether an assignment is active, inactive, or suspendedand whether the assignment is eligible for payroll processing.

You must complete the setup of assignment statuses in Oracle Fusion and map the assignment status values in your sourceapplication to equivalent Oracle Fusion values before you can load data from the source application.


Use the Manage Assignment Statuses task in Oracle Fusion to define status values. You can:

• Rename the user status values associated with the predefined assignment status values• Create new assignment status values

Related Topics• Assignment Statuses: How They are Set Up

Person Types for HCM Coexistence: ExplainedYou can extract only those person records with person type employee and contingent worker from your source applicationfor upload to Oracle Fusion. Other person types are not supported. Use the HCM Coexistence tasks in the Data Exchangework area to load and extract data.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=9393F190A356BAF2E040D30A68810282

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=C90B6E0D7AB4420EE040D30A688144B1

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=9382C1E4870E6AAFE040D30A68812A18



226


Before performing the initial data load, you must define in Oracle Fusion:

• Any employee and contingent worker person types in your source application as user person types.

• All the predefined and custom person types that exist in your source application.

You must select the correct system person type for the user person type you're creating. For example, select the employeesystem person type when you create employee user person types in Oracle Fusion.

Related Topics• Person Types: Explained

Elements: ExplainedHCM coexistence uses elements to hold basic compensation data that you transfer from your source application for use byOracle Fusion Workforce Compensation during a review cycle. HCM coexistence uses elements to also send compensationbonus amounts from Oracle Fusion back to Oracle PeopleSoft HRMS variable compensation plans, so that bonus paymentscan be made using the PeopleSoft HRMS payroll application.


If you're using Workforce Compensation as part of your HCM coexistence implementation, you must set up elements totransfer compensation data from your source application to Oracle Fusion. Use the Manage Elements task in Oracle Fusion toset up the elements.

Simplified Element SetupThis section describes the simplest way of setting up elements for HCM coexistence. For each currency in which youpay workers, you create the set of elements described in the following table and associate the elements with the relevantlegislative data groups. For example, if you pay workers in the United States, the United Kingdom, Ireland, France, andGermany, you need one set of elements in US Dollars, one in GB Pounds, and one in Euros.

Name Base Pay Bonus Allowance

Type

Recurring

Recurring

Recurring

Classification

Information

Information

Information

Input Currency

Local

Local

Local

Allow multiple entries insame period

No

Yes

Yes

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=98AE9DEE6EECA91BE040D30A68814B00



227

For HCM coexistence, the emphasis is on simplicity of setup, so the recommended approach is different from theapproach you would use if Oracle Fusion were your system of record. All you need to create is a simple element to hold thecompensation information that you transfer from your source application. The recommendation in Oracle Fusion is to use anelement of type Recurring with the classification Information.

Element Input ValuesFor base pay elements, you typically specify either a rate input value (for hourly pay) or an amount input value (for salariedpay). Similarly, for the bonus element, you usually specify an amount input value only. You must select the special purposeof Primary Input Value for the Amount input value to include the values in compensation history. You can complete theremaining fields as required by your enterprise.

The following table summarizes the recommended approach to setting up input values for your elements.

ElementName

InputValueName

EntrySequence

SpecialPurpose

UOM Displayed AllowUserEntry

CreateDatabaseItem

Base Pay

Rate

1

Rate

Money

Y

Y

Y

Amount

2

PrimaryInputValue

Money

Y

Y

Y

Bonus

Percentage

1

Percentage

Money

Y

Y

Y

Amount

2

PrimaryInputValue

Money

Y

Y

Y

Allowance

Amount

1

PrimaryInputValue

Money

Y

Y

Y

Element EligibilityYou must create element eligibility for each of your elements. The recommended approach is to create open eligibility. Youcreate element eligibility with a name but no criteria, so that the elements are available in all circumstances.

FAQs for Coexistence for HCM: Setup

Why do I need to use salary bases?You use salary bases in HCM coexistence to:

• Create and store base pay records for workers in Oracle Fusion Workforce Compensation.



228

• Link base pay and grade rates for the calculation of compa-ratio values in Oracle Fusion Workforce Compensation.


Why do I need to use grade rates?You must use grade rates in HCM coexistence if you want to see compa-ratio values in Oracle Fusion WorkforceCompensation.



Chapter 23Coexistence for HCM Data Mapping

229

23 Coexistence for HCM Data Mapping

Generating Mapping Identifiers for HCM BusinessObjects: ExplainedAfter you define all the required business objects in Oracle Fusion, you must generate and export mapping identifiers for theseobjects. The mapping identifiers are an essential input to the data-mapping process.


To generate and export the business-object mapping identifiers, you run the Generate Mapping File for HCM BusinessObjects process from the Manage HCM Configuration for Coexistence page. This process creates .dat files containing GlobalUnique Identifiers (GUIDs) for each business object. The .dat files are packaged automatically in a zipped data file that iswritten to the file server. The system administrator for your source application retrieves and imports the zipped data file sothat you can create data mappings in the source application.

ImportantIf you create additional records in Oracle Fusion for the mapped business objects, you must rerun the GenerateMapping File for HCM Business Objects process to generate additional GUIDs. The system administrator for yoursource application can then update the mappings with the new values.

Mapping PeopleSoft HRMS Data for HCMCoexistence: ExplainedYou use Domain Value Maps (DVMs) to map Oracle PeopleSoft HRMS objects to Oracle Fusion objects. You must completethis mapping to import PeopleSoft HRMS data into Oracle Fusion. This topic provides a summary of the DVM review andcompletion tasks. You can find complete instructions in the following documents on My Oracle Support:

• Integrating PeopleSoft HRMS 8.9 with Fusion Talent Management and Fusion Workforce Compensation (DocumentID 1480967.1)


• Integrating PeopleSoft HCM 9.1 with Fusion Talent Management and Fusion Workforce Compensation (DocumentID 1480996.1)




230

Understanding System Data Codes in DVMsPeopleSoft HRMS (and HCM) supply multiple DVMs. Each of the supplied DVMs has a system data code that identifieswhether the DVM contains system data values (equivalent to predefined values in Oracle Fusion). The system data code alsospecifies how to complete the DVM definition such that:

• Every PeopleSoft HRMS data value has a corresponding Oracle Fusion data value.

• Every Oracle Fusion data value is accounted for in the mapping.

You must review and complete the DVMs to import data successfully to Oracle Fusion.

Completing the DVM DefinitionsFor this activity, you work in both PeopleSoft HRMS and Oracle Fusion. You also need the .dat files from the GenerateMapping File for HCM Business Objects process in Oracle Fusion.

The following table summarizes how to complete the DVM for each system data code.

System Data Code Meaning

PF

The DVM contains both PeopleSoft HRMS system datavalues and their corresponding Oracle Fusion values. Noaction is required unless you need to modify any of thedelivered values.

P

The DVM contains PeopleSoft HRMS system datavalues only. You must:

1. Verify the delivered values.

2. Review the equivalent Oracle Fusion values inOracle Fusion.

3. Add PeopleSoft HRMS values that have noexisting Oracle Fusion equivalents to the OracleFusion lookup type.

To complete the mapping you add all of the OracleFusion values to the DVM, including any that youadded to the lookup type, using the PeopleSoft HRMSPopulate Domain Value Maps page.

M

The DVM contains neither PeopleSoft HRMS nor OracleFusion system data values. This system data codeidentifies values such as action and action reason codesthat exist in Oracle Fusion only. To populate this DVM,you need to import the Oracle Fusion values.



231

System Data Code Meaning

N

The DVM contains neither PeopleSoft HRMS nor OracleFusion system data values. The PeopleSoft HRMSvalues exist, but not as system data values. To populatethe DVM, you:

1. Retrieve the PeopleSoft HRMS values using theSQL script supplied in the DVM.

2. Compare the PeopleSoft HRMS values to those inthe corresponding Oracle Fusion lookup.

3. Add PeopleSoft HRMS values that have noexisting Oracle Fusion equivalents to the OracleFusion lookup.

To complete the mapping, you add both sets of valuesto the DVM using the PeopleSoft Populate Domain ValueMaps page.

X

The DVM contains neither PeopleSoft HRMS nor OracleFusion data. Steps for completing this DVM are identicalto those for completing DVMs with the system datacode M, except that you must add specific values tothese DVMs.

NoteJob codes imported to Oracle Fusion HCM must not be more than 25 characters.

Mapping Oracle E-Business Suite HRMS Data forHCM Coexistence: ExplainedYou use Web Applications Desktop Integrator (Web ADI) spreadsheets to map Oracle E-Business Suite Human ResourcesManagement Systems (HRMS) objects to Oracle Fusion objects. You must complete this mapping to import E-Business SuiteHRMS data into Oracle Fusion. This topic provides a summary of the Web ADI spreadsheet review and completion tasks, forwhich you use the E-Business Suite HRMS responsibility HCM Coexistence Manager. You can find complete instructions inthe following documents on My Oracle Support:

• HCM Coexistence - Integrating EBS HCM 11i and Fusion Talent Management and Workforce Compensation(Document ID 1460869.1)

• HCM Coexistence - Integrating EBS HCM R12.1 and Fusion Talent Management and Workforce Compensation(Document ID 1460868.1)




232

Identifying Business Groups for IntegrationYou perform the task Identify Business Groups for Integration. In the Web ADI spreadsheet used by this task, you indicate, foreach business group in the E-Business Suite HRMS instance, whether its data is to be integrated with Oracle Fusion.

Once this task is complete, you can import cross-reference data from Oracle Fusion and complete the mapping task.

Mapping E-Business Suite HRMS Data to Oracle FusionYou perform the Define Mapping task (Release 12.1) or the Setup: Mapping function (Release 11i) so that:

• Every E-Business Suite HRMS data value has a corresponding Oracle Fusion data value.

• Every Oracle Fusion data value is accounted for in the mapping.

Validating the Mapping SelectionsOnce the mapping subtasks are complete, you perform the task Process and Validate to ensure that the mapping selectionsmade for specific subtasks are valid. Once you successfully validate the mapping, you can extract E-Business Suite HRMSdata for delivery to Oracle Fusion. For this task, you use the E-Business Suite HRMS responsibility HCM CoexistenceIntegrator.

Mapping Subtasks for Oracle E-Business Suite HRMSData : ExplainedMapping the Oracle E-Business Suite objects to Oracle Fusion objects comprises several mapping subtasks, You mustcomplete a Web ADI spreadsheet for each of the mapping subtasks.


The following table summarizes the mapping subtasks.

Mapping Subtask Description

Map business group defaults

For a specified business group, you:

• Select the name of a default reference data setand a default legal employer.

• Enter the name of the business unit to be createdfor the business group.

• Optionally select an eligibility profile to filter persondata.

You perform this task for every business group identifiedfor integration.

Map HR organizations to legal employers

For each HR organization in a specified business group,you can select the name of the legal employer in Oracle



233

Mapping Subtask Description

Fusion to which the HR organization maps. You performthis subtask only to map HR organizations to legalemployers.

Map key flexfield segments for job, position, grade, andcompetency flexfields

In E-Business Suite HRMS, you use key flexfields tohold job, position, grade, and competency definitions.In Oracle Fusion, the code and name attributes for job,position, grade, and competency are stored in the basetables rather than in key flexfields. Therefore you mustmap the data captured in segments for these entities inE-Business Suite HRMS to the code and name values inOracle Fusion.

Important Job codes imported to Oracle Fusion HCMmust not be more than 25 characters.

Map user defined lookups

For each lookup type in E-Business Suite HRMS, theOracle Fusion equivalent lookup type is preselected.For each lookup code, you enter the Oracle Fusionequivalent value.

Map EBS person types to Fusion person types

For each person type in a specified business group, youselect an equivalent in Oracle Fusion.

Map actions and action reasons

For E-Business Suite HRMS entities such as employeeleaving reasons and salary components, you selectequivalent actions and action reasons in Oracle Fusion.

Map qualification type category to content type (forOracle Fusion Talent Management)

For each qualification type category in E-Business SuiteHRMS, you select a content type in Oracle Fusion fromthe imported list of values.

Map elements (for Oracle Fusion WorkforceCompensation)

For each element and associated element input value ina specified business group, you select an equivalent inOracle Fusion.


Chapter 24Coexistence for HCM Data Loading

234

24 Coexistence for HCM Data Loading

HCM Data: How It's LoadedYou can transfer data from a source application, such as Oracle PeopleSoft HRMS or Oracle E-Business Suite HRMS, toOracle Fusion, using the Load HCM Data for Coexistence process. You run this process manually from the Data Exchangework area.


Settings That Affect the Load HCM Data for CoexistenceProcessThe following parameters control the Load HCM Data for Coexistence process.

Parameter Name Description

File Name

The zipped data file to be loaded.

Business Object to Import

The business object to be loaded. To load all businessobjects in the zipped data file, select All. For aninitial load, process business objects individually. Forincremental loads, you can select All.

Loader Run Type

Indicates whether to import the data or both importand load the data. If you select Import (for example,to complete checks for basic errors before attemptingto load the data), then you must load the datasubsequently using the Load Batch Data process.For an initial data load, you're recommended to selectImport so that you can identify and resolve any issuesas they occur. For incremental data loads, select Importand Load Batch Data, unless you have reasons forperforming the steps separately.

Batch Name

A name that identifies the data load.


The maximum number of errors in a thread beforeprocessing terminates. If an error occurs whenprocessing a complex logical business object (such asa person record) then the application rolls back all therows of the business object and marks them as Error inRow.



235

Parameter Name Description


The number of Load Batch Data threads to run inparallel. If you're processing large amounts of data (forexample, more than 1000 rows) or complex data (suchas person and work relationship data) consider running4 or 8 threads in parallel.

Loader Chunk Size

The number of logical business objects a single LoadBatch Data thread processes in a single action.

How HCM Data for Coexistence Is LoadedThe Load HCM Data for Coexistence process retrieves the zipped file of source data from the Oracle Data Integrator (ODI)root directory on the Oracle Fusion Application Server, validates the data, and loads it into Oracle Fusion. The process hasthree phases, as summarized in the following figure.

During the first phase, the Load HCM Data for Coexistence process:

• Decompresses the data file

• Checks the file for basic errors

NoteThe pipe character (|) isn't supported in data values.

During the second phase, for each business object, the Load HCM Data for Coexistence process:

• Maps the data from the source application to the Oracle Fusion data model



236

• Identifies new, changed, and deleted data

ImportantAll incremental data loads must contain the same set of data as the initial data load. The data-importprocess identifies any differences between latest data and data already loaded to Oracle Fusion andperforms an incremental load of the changes. If you omit data from the data load (for example, bychanging the export filter settings), then Oracle Fusion identifies it as data to be deleted.

• Imports business objects to stage tables

During the final phase, for each business object, the Load HCM Data for Coexistence process:

• Validates the data in the stage tables against relevant business rules in Oracle Fusion

• Loads each business object that is processed successfully to the Oracle Fusion application tables

• Reports any errors in the Data Exchange work area

ImportantIn an incremental data load, you can't upload date-effective changes to terminated work relationships. You mustapply such changes manually to the Oracle Fusion data using the Oracle Fusion interface before attempting anincremental data load. Otherwise, the data load to Oracle Fusion will fail.

Related Topics• Processes Required After Loading Data for HCM Coexistence: Explained

• Processes Required After Loading Workforce Compensation Data for HCM Coexistence: Explained

• Deleting HCM Stage Data and Files for Coexistence: Explained

Loading Data Automatically: ExplainedDuring implementation of HCM coexistence, you can set the Load HCM Data for Coexistence process to run automaticallyfor the enterprise. In this scenario, data loading to HCM coexistence occurs automatically. You can't override this setting forindividual data loads or schedule the process to run at a particular time.


The following table lists the values for the parameters to the Load HCM Data for Coexistence process:

Parameter Name Value

File Name

The name of the zipped data file to be loaded.



237

Parameter Name Value

Business Object to Import

All

Loader Run Type

Import and Load Batch Data

Batch Name

Generated automatically by concatenating the loaderbatch ID with the business object name. For example, 12345:Work Relationship.


As specified for the enterprise during implementation.



Loader Chunk Size


Related Topics• Processes Required After Loading Workforce Compensation Data for HCM Coexistence: Explained

• Processes Required After Loading Data for HCM Coexistence: Explained

• Deleting HCM Stage Data and Files for Coexistence: Explained

Loading Business Objects in the Required Order:ExplainedTo load business objects from a source application to Oracle Fusion, you perform the Load Data for Coexistence task.You run this task in the Setup and Maintenance work area when you load HCM data for the first time. For subsequent orincremental loads, you can perform the Load Data for Coexistence task in the Data Exchange work area.


Business Object Load OrderWhen you load business objects, for the first time or subsequently, you must follow the general load order shown in thefollowing table so that you satisfy the dependencies between business objects. For example, you must load all work structurerecords before salary bases. Within the work structure records grouping, you must load locations before business units,business units before grades, grades before grade rates, and so on. All business objects to be loaded can be in the samecompressed data file.



238

Important

• For the initial data load, you're recommended to load one business object at a time, following the load ordershown in the following table. Select the Loader Run Type value Import rather than Import and Load. Usingthis approach, you can diagnose any loading issues as they occur and fix them before loading the next businessobject.

• For incremental data loads, you can load all business objects at once (select the All option) and specify theLoader Run Type value Import and Load. When you load all business objects at once, the data-load processautomatically loads them in the appropriate order. You can use the automated loading process (where the LoadHCM Data for Coexistence process runs automatically on receipt of a file) for incremental data loads.



239

The following table shows the load order of the business objects:

Order Business Object Group Business Object

1

Work Structures

1. Locations

2. Business units

3. Grades

4. Grade rates

5. Job families

6. Jobs

2

Workforce Compensation

1. Salary bases

3

Talent Management

1. Establishments

2. Rating models

3. Content items

4. Content item relationships

4

Person

1. Persons

2. Person documentation

3. Departments

4. Department trees

5. Positions

5

Employment

1. Work relationships

6

Workforce Compensation

1. Salary elements

2. Element entries

7

Profile Management

1. Profiles



240

ImportantAfter loading business units, you must open each one using the Oracle Fusion Manage Business Unit SetAssignment task and save the default reference data set assignments. Otherwise, set-enabled data may not bevisible to users.

Dependencies Between Business Objects: ExplainedThis topic explains about the dependencies between business objects for loading Workforce Compensation and TalentManagement data. You must follow the general load order to satisfy the dependencies between business objects.


Dependencies Between Business Objects for WorkforceCompensationThe following figure illustrates dependencies between business objects relevant to workforce compensation.

These dependencies determine the order in which you must load the business objects. For example, positions require jobsand departments to be loaded first, and work relationships require persons and positions to be loaded first. Arrows point frombusiness objects to other business objects that they are dependent on.

Dependencies Between Business Objects for Talent ManagementThe following figure illustrates dependencies between business objects relevant to talent management.



241

These dependencies determine the order in which you must load the business objects. For example, profiles require workrelationships, establishments, and content items to be loaded first, and content items require rating models to be loaded first.Arrows point from business objects to other business objects that they are dependent on.

System-of-Record ConsiderationsAfter the initial load, Oracle Fusion Applications are the system of record for business objects that are specific to talentmanagement. Therefore, for incremental loads you don't load establishments, rating models, content items and relationships,or profile data. In effect, the initial load migrates talent-management business objects from the source application to OracleFusion Applications. Thereafter, you create records directly in Oracle Fusion.

ImportantIf you include talent-management objects in incremental loads, then they overwrite existing Oracle Fusion records.If you create talent-management records in your source environment, then set the configuration parameter AllowTalent Data Increment Load to Y. With this setting, the application processes only additional records duringincremental uploads and ignores existing records.

For all data other than talent-management data, the source application remains the system of record. Youmaintain the data in the source application and upload it periodically to Oracle Fusion Applications.



242

Loading Batch Data into Oracle Fusion HCM:ExplainedThe Load Batch Data process, which you run from the Data Exchange work area, imports data into Oracle Fusion HumanCapital Management (HCM) from external sources.

NoteThe Coexistence for HCM offering is supported only for existing customers of Coexistence for HCM.

From the Load Batch Data page, you can:

• Load data to the Oracle Fusion application tables (for example, for HCM coexistence or HCM Spreadsheet DataLoader).

• Monitor data loads.

• Correct data errors.

• Rerun data loads.

Loading Data for HCM CoexistenceTo load data for HCM coexistence, you run the HCM coexistence process Load HCM Data, which comprises two phases:Import and Load. If you select:

• Both phases, then the Load Batch Data process runs automatically to complete the Load phase.

• The Import phase only, then you must run the Load Batch Data process manually to complete the Load phase.When running Load Batch Data, you select the batch name that you created for the HCM coexistence process LoadHCM Data.

Monitoring Data LoadsYou can monitor the status of a data load in the Batch Status column of the Search Results section of the Load Batch Datapage. Detailed information about any data load that you select in the Search Results section appears in the Details section ofthe page.

Correcting Data ErrorsYou can see the details of any errors on the Failed tab in the Details section for a batch data load.

To resolve the errors and complete the data load, you can:

• Change the status of objects with errors to Ignore to prevent them from being processed when you next run thedata load.

• Select all objects with errors in the Details section and select Create Batch. The selected objects are removed fromthe original batch and added to a new batch, so that you can fix the problems later.

• View the details of objects with errors from the Failed Objects column of the Batch Summary tab in the Detailssection, and correct the data. These corrections are applied to the data in the stage table. This approach ishelpful if you want to be sure that the correction has fixed the original error before applying it to the source data.However, when uploading HCM coexistence data you must still apply any corrections to the source data. Otherwise,discrepancies between the source data and the data loaded into Oracle Fusion will cause errors when you next loadthe data.



243

Rerunning Data LoadsAfter correcting any errors, you can select the batch file in the Search Results section and click Run. Any object with thestatus Error in Row is reset to Ready to Process and included in the load. Objects with the status Successful or Ignorearen't processed.

Load Batch Data ParametersThe Load Batch Data process imports batch data into the Oracle Fusion application tables from the Load Batch Data stagetables. You run this process from the Data Exchange work area.


When you schedule the Load Batch Data process, you specify values for the following parameters.

Load Batch Data ParametersBatch Name

The name of the batch file to be loaded.

Loader Chunk Size

The number of logical business objects that a single Load Batch Data thread processes in a single action.


The maximum number of errors in a thread before processing terminates. If an error occurs during the processing of acomplex logical business object (such as a person record), then all rows for that business object are rolled back and markedas Error in Row.


The number of Load Batch Data threads to run in parallel. If you're processing large amounts of data (for example, more than1000 rows) or complex data (such as person and work relationship data) consider running 4 or 8 threads in parallel.

Data-Load Batch-Status Values: ExplainedThe Data Exchange work area displays batch-status values for the Load Batch Data and Load Data for Coexistence tasks.This topic explains the batch-status values.


Batch Status Description

New

The batch is new and hasn't been processed.



244

Batch Status Description

Processing

The data-load process for the batch is currently running.

Refresh AM

The data-load process for the batch is performing aninternal refresh against the Application Module (clearingthe loader cache).

Canceled

The data-load process for the batch was canceled.

Complete with Errors

Data-load processing for the batch is complete; objectinstance errors exist.

System Error

The data-load process for the batch was terminated bya system error.

Complete

The data-load process for the batch completedsuccessfully.

Data-Load Object-Status Values: ExplainedYou can see information about the load status of individual business objects from the Batch Summary and Failed tabs in theDetails section of the Load Batch Data page.

NoteThe Coexistence for HCM offering is supported only for existing customers of Coexistence for HCM.

The following table describes the object-status values.

Object Status Description

New

The object is new and hasn't been processed.

Pending Action

During the import phase, a validation error occurredfor the object instance. (Typically, this status is set byOracle Data Integrator.)

Ready to Process

The object is ready for processing.

Error in Row

The object is in error. Either the object itself is in erroror the complex business object to which it belongs is inerror.



245

Object Status Description

Ignore

The object is ignored during processing.

Successful

The object was successfully processed.

Deleted Source Records: How They Are ProcessedWhen you run the Load HCM Data for Coexistence process, the application identifies differences (including any deletions)between the data in the load and any data previously loaded into Oracle Fusion, and applies these differences to OracleFusion data.


The application applies deletions to Oracle Fusion data if:

• You have deleted the object record in the source application.

• You have changed the object record such that it fails the export filter.

• You have changed the export filter settings.

ImportantYou're recommended not to change the export filter settings once you have performed an upload to OracleFusion. Files must contain all records, both changed and unchanged, that were in the initial data load.

Deleted Person and Employment RecordsIf the application detects a deleted person or employment record (such as an assignment) during the Load HCM Data forCoexistence process, it creates an exception, and doesn't apply the deletion to Oracle Fusion data. You must delete anysuch records manually (or inactivate them, if deletion isn't possible) using the Oracle Fusion user interface.

Validation of Complex Business Objects by the LoadBatch Data Process : ExplainedA complex business object is a logical business object comprising multiple related entities. For example, a person businessobject comprises a basic person entity and multiple child entities, such as person address details, person e-mails, personnational IDs, and so on. Together, these entities constitute the person logical business object.

How Complex Business Objects Are ValidatedThe Load Batch Data task processes each logical business object as a single item. All parent and child entities of the logicalbusiness object must be validated successfully before the object can be loaded to Oracle Fusion. If any single entity fails



246

validation, then the logical business object itself is in error. For example, if the address details in a person record contain adata error, then the person record itself is in error. You can view details of such errors and determine how to correct them.


Frequency of Data Loads: Points to ConsiderYou perform initial load of business objects from your source application to Oracle Fusion during implementation of HCMcoexistence. The frequency of subsequent loads or incremental loads depends on how you're using Oracle Fusion and thefrequency of changes made to your source data. Your data-load schedule must ensure that activities planned for OracleFusion Talent Management and Oracle Fusion Workforce Compensation have access to the latest data.


Loading Oracle Fusion Talent Management Business ObjectsIf you're using Oracle Fusion Talent Management:

• Infrequently, for example, for yearly or occasional performance reviews, then you load business objects to OracleFusion immediately before the activities.

• Frequently, and your source data is also changing frequently, then you may need to upload business objects weeklyor monthly.

Loading Oracle Fusion Workforce Compensation Business ObjectsIf you're using Oracle Fusion Workforce Compensation to perform compensation reviews at specific times (for example, atyear end), then you load business objects to Oracle Fusion immediately before the review starts. Otherwise, managers maynot have access to the latest information about their workers.

To load updated business objects to Oracle Fusion after a compensation review cycle has started:

1. Load the latest objects successfully.

2. Run the Refresh Workforce Compensation Data process in Oracle Fusion Workforce Compensation.

ImportantYou must load establishments, rating models, content items, and profile data during the initial implementation ofOracle Fusion Talent Management and not subsequently. For all other business objects, files to be uploaded mustcontain all records, changed and unchanged, that they contained during the initial upload.

Once a compensation review cycle is complete, you must extract the updated results and send them to thesource application (where they must be successfully loaded) before performing further data loads to OracleFusion.



247

Using Oracle Fusion Transactional BusinessIntelligence Reports to Validate Uploaded Data:ExplainedYou can use Oracle Fusion Transactional Business Intelligence (OTBI) reports to validate data that you upload to OracleFusion.


The following table identifies predefined reports that are most relevant in the HCM coexistence environment. You can editthese reports and create additional reports.

Type Report Name Product Folder Description

WorkforceCompensation

Salary Basis Report

Compensation -Transactional AnalysisSamples - Salary Basis

Displays details of salarybases that are active in aspecified period.


Salary Components

Compensation -Transactional AnalysisSamples - SalaryComponents

Displays total adjustmentamounts by salarycomponent, thepercentage oftotal salaries in thecomponent, and thenumber of workerswho received anadjustment for a specificcomponent.


Salary Detail Report

Compensation -Transactional AnalysisSamples - SalaryDetail Report

Displays salary detailsfor a set of workers,including salary basis,currency, and currentsalary amount.


Stock Detail Report

Compensation -Transactional AnalysisSamples - Stock DetailReport

Displays award detailsby grant, including thegrant price, total sharesgranted, exercise price,and expiration date.



248


Global HumanResources

Absence Details

WorkforceManagement -Transactional AnalysisSamples - AbsenceDetails

Displays absence detailsby worker.


Assignment Details

WorkforceManagement -Transactional AnalysisSamples - AssignmentDetails

Displays assignmentdetails by worker.


Assignment Headcountby Department

WorkforceManagement -Transactional AnalysisSamples - AssignmentHeadcount byDepartment

Displays the assignmentheadcount for eachdepartment.


Department Details

WorkforceManagement -Transactional AnalysisSamples - DepartmentDetails

Displays departmentsavailable betweenspecified dates.


Grade Details

WorkforceManagement -Transactional AnalysisSamples - GradeDetails

Displays grades withtheir start and end dates.


Job Details

WorkforceManagement -Transactional AnalysisSamples - Job Details

Displays jobs with theirstart and end dates.


Location Details

WorkforceManagement -Transactional AnalysisSamples - LocationDetails

Displays location codesand addresses.


Position Details

WorkforceManagement -Transactional AnalysisSamples - PositionDetails

Displays positions withtheir start and end dates.



249


Worker Performance

Identify Risk of LossReasons

Career - Performance- TransactionalAnalysis Samples -Identify Risk of LossReasons

Displays the mostcommon leaving reasonduring a specific periodfor workers with highperformance ratings.

Worker Performance

Identify Top Talent(using Performance andPotential)

Career - Performance- TransactionalAnalysis Samples -Identify Top Talent(using Performanceand Potential)

Displays workers withboth high performanceand high potential in aspecified period.

Running OTBI Reports to Validate Uploaded Data :ExplainedYou can use predefined Oracle Fusion Transactional Business Intelligence (OTBI) reports and create new reports to validatedata that you upload to Oracle Fusion.


• To run predefined OTBI reports, navigate to the Reports and Analytics work area and select a report from therelevant product-area folder under Shared Folders - Human Capital Management

• To create new reports, click Create in the Reports and Analytics work area and access Oracle BI Publisher.

For more information, see the Oracle Fusion Transactional Business Intelligence Administrator's Guide.

Security ConsiderationsThe following security considerations apply to OTBI reports:

• The job role HR Analyst has the duty roles required to run the predefined OTBI reports for Global Human Resourcesand Worker Performance.

• The job role Compensation Analyst has the duty roles required to run the predefined reports for WorkforceCompensation.

The user running any of these reports must also have security access to the data in the report.

For more information, see the Oracle Fusion Applications Human Capital Management Security Reference Manual.



250

FAQs for Coexistence for HCM Data Loading

What happens if I cancel a Load Batch Data process?The Load Batch Data process completes the processing of any business objects currently in progress, but doesn't processfurther objects.

How can I confirm that data was loaded successfully?Start by reviewing the results of the data load in the Data Exchange work area. You can see the status of the load process, itsresults once it completes, and the details of any errors.

After a successful data load, you can validate the results in relevant Oracle Fusion user interfaces. For example, you canreview worker details in the worker's portrait. You can also use Oracle Fusion Transactional Business Intelligence (OTBI)reports to confirm that uploaded data is as expected.



Chapter 25Coexistence for HCM Post-Load Processes

251

25 Coexistence for HCM Post-Load Processes

Processes Required After Loading Data: ExplainedAfter the successful completion of an initial or incremental data load, you must run a set of processes to complete data setupin the Oracle Fusion environment. You run these processes from the Scheduled Processes work area. Select Navigator -Tools - Scheduled Processes .


This table describes the purpose of each of the processes. Run the processes in the order in which they appear in the table.

Process Description

Synchronize Person Records

This process sends changes to person and assignmentdetails that have occurred since the last data loadto consuming applications in the Oracle Fusionenvironment. These applications include OracleFusion Trading Community Model and Oracle IdentityManagement (OIM).

Update Person Search Keywords

This process copies keyword values from the originatingrecords to the PER_KEYWORDS table, and indexesthem to improve search performance. You useattributes of person, employment, and profile recordsas person-search keywords. When you run theUpdate Person Search Keywords process, it refreshesthe PER_KEYWORDS table. Therefore, you'rerecommended to run the process at times of low activityto avoid performance problems.

Refresh Manager Hierarchy

This process populates the denormalized managerhierarchy table with latest information after each dataload. For performance reasons, the application extractsthe complete manager hierarchy for each person fromactive data tables and stores it in a separate managerhierarchy table, known as the denormalized managerhierarchy. This approach ensures that a person'smanager hierarchy is both easily accessible and up-to-date.

Send Pending LDAP Requests

This process sends bulk requests to OIM to create,suspend, and re-enable user accounts, as appropriate.



252

Process Description

Send Personal Data for Multiple Users to LDAP

This process ensures that OIM and Oracle FusionHCM hold the same person details for users. The orderin which person records are created when you loadthem in bulk is undefined. Therefore, a person's recordmay exist before the manager record. As a result,person details sent to OIM with requests to create useraccounts may not include manager information.

Related Topics• Communicating Person and Assignment Changes to Consumer Applications: Explained

• Update Person Search Keywords: Explained

• The Manager Hierarchy: How It Is Maintained

• Sending Personal Data to LDAP: Explained

Processes Required After Loading WorkforceCompensation Data: ExplainedAfter loading workforce compensation data to Oracle Fusion, you must run processes from the Scheduled Processes workarea to populate and maintain the workforce compensation tables.


The following table describes the purpose and frequency of each of the post-data-load processes.

Process Description

Start Compensation Cycle

The Start Compensation Cycle process copies datafrom the HR tables into the workforce compensationtables. It also creates the reporting hierarchy, budgetsheets, and worksheets that managers use. You runthis process once only, after the initial load of workforcecompensation data has completed successfully and youhave created the compensation plan.

Refresh Workforce Compensation Data

The Refresh Workforce Compensation Data processupdates the workforce compensation tables so that up-to-date data is used in the compensation cycle. You runthis process after every incremental data load, and alsowhen you change your compensation-plan setup.

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=AE78B1CB81BD7BA2E040D30A68815466

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=86EEE80D8C82F984E040D30A68817C93

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=99B8F56334F05BD8E040D30A68815535

https://fusionhelp.oracle.com/helpPortal/faces/AtkHelpPortalMain?TopicId=E34B29B507B7FF27E040D30A688137C1



253

Extracting HCM Coexistence Data: ExplainedOnce you have completed a compensation review cycle in Oracle Fusion Workforce Compensation, you must extract theresults of the review using the Extract Data for Coexistence task and return them to your source application.


If you have loaded salary data to Oracle Fusion Workforce Compensation as separate components, then you'rerecommended to return it to the source application as separate components. The returned data must be successfully loadedin the source application, where it's usually subject to further processing. For example, bonus and salary information froma completed compensation review in Oracle Fusion Workforce Compensation may be included in person and employmentrecords and used to pay employees from the payroll system in the source environment.

Each business object change (assignment, salary, and bonus) for the selected compensation cycle process is reported inseparate XML files that are added to a single zip file. The zip file is placed in the outgoing directory on the file server, fromwhere you can retrieve it and load it into the source application.

For more information, see the following documents on My Oracle Support:



• Integrating PeopleSoft HCM 9.1 with Fusion Talent Management and Fusion Workforce Compensation (DocumentID 1480996.1)

• HCM Coexistence - Integrating EBS HCM 11i and Fusion Talent Management and Workforce Compensation(Document ID 1460869.1)

• HCM Coexistence - Integrating EBS HCM R12.1 and Fusion Talent Management and Workforce Compensation(Document ID 1460868.1)

Deleting HCM Stage Data and Files: ExplainedThis topic explains how to delete data batches from the Load Batch Data stage tables. It also describes the circumstances inwhich the associated zip files and directory structures are deleted from the Oracle Fusion Application Server.

Data that you upload to Oracle Fusion Human Capital Management (HCM) is imported first to the Load Batch Data stagetables. Following validation against Oracle Fusion business rules, data is loaded from the stage tables to the applicationtables. Whenever you upload changed data to Oracle Fusion HCM, you must resend all of the original data for a businessobject type. For example, if you update one person's home address, then you must upload all person records again. If youregularly upload changes for several types of business objects, then the Load Batch Data stage tables can grow very quickly.


Identifying Batches for DeletionTo identify batches for deletion from the Load Batch Data stage tables:

1. Use the Delete Stage Data and Files for Coexistence task in the Data Exchange work area.



254

2. Search for batches to delete by entering From Date, To Date, and Batch Status values.

If you specify no From Date value, then 01/01/0001 is used.

NoteBatches with both the specified status and a processing time stamp that falls in the specified date range appearin the search results. For example, you could search for all Completed batches for the previous week or all NotProcessed batches for today.

A batch's processing time stamp is derived as follows:

• If an attempt has been made to load a batch to the application tables, then the processing time stamp records whenthe attempt was made.

• If no attempt has been made to load a batch to the application tables, then the processing time stamp records whenthe batch was generated in the stage tables.

Submitting the Deletion ProcessWhen you submit the deletion process, all batches that appear in the Search Results region are deleted. To remove batchesfrom these results, you must adjust the search criteria and search again.

ImportantYou cannot delete batches that are in progress.

When you're ready to proceed, you schedule the Delete HCM Stage Data and Files for Coexistence process. The searchcriteria are carried forward automatically to the Schedule Process page.

Use the process ID to monitor the process in the Scheduled Processes work area.

Deleting the Files Associated with BatchesIn some circumstances, the Delete HCM Stage Data and Files for Coexistence process also deletes the following items fromthe Oracle Fusion Application Server:

• The original zip file associated with a batch

• The decompressed file and its directory structure

The process deletes files that were imported to the stage tables within the specified dates and for which no associatedbatches remain.. However, if any of the associated batches remains, then no file or directory deletion occurs.

Security ConsiderationsTo perform the task Delete Stage Data and Files for Coexistence, you must have the HCM Co-Existence Management Dutyrole. By default, the Application Implementation Consultant and Human Capital Management Application Administrator jobroles have this duty role.


Glossary

255

Glossary

abstract role

A description of a person's function in the enterprise that is unrelated to the person's job (position), such as employee,contingent worker, or line manager. A type of enterprise role.

action

Tracks changes to certain Human Capital Management (HCM) records, for example, changes to employment and assignmentrecords. You can create your own actions and associate them with the predefined action types. You can optionally associateaction reasons with actions.

action

The kind of access named in a security policy, such as view or edit.

action reason

Action reasons provide further explanation to actions, for example, an action of transfer could have reasons such asreorganization or career progression.

assignment

A set of information, including job, position, pay, compensation, managers, working hours, and work location, that defines aworker's or nonworker's role in a legal employer.

balance dimension

The scope of a balance value, such as the period of time over which it accumulates, and whether it relates to an assignment,terms, or a payroll relationship.

balance feed

Input value from an element, or all elements in a classification, that adds to, or subtracts from, a balance.

business object

A resource in an enterprise database, such as an invoice or purchase order.

business unit

A unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy.

calculation card

Captures values required for payroll calculations for some earnings and deductions, such as absence payments andinvoluntary deductions. For some countries, you can also create various types of cards to hold default values for tax reportingunits or payroll statutory units.


Glossary

256

compa-ratio

Salary as a percentage of salary range midpoint. 100 denotes salary at midpoint.

competency

Any measurable behavior required by an organization, job, or position that a person may demonstrate in the work context. Acompetency can be a piece of knowledge, a skill, an attitude, or an attribute.

condition

An XML filter or SQL predicate WHERE clause in a data security policy that specifies what portions of a database resourceare secured.

content item

An individual quality, skill, or qualification within a content type that you track in profiles.

content type

An attribute such as a skill, quality, or qualification that is added to a profile.

contingent worker

A self-employed or agency-supplied worker. Contingent worker work relationships with legal employers are typically of aspecified duration. Any person who has a contingent worker work relationship with a legal employer is a contingent worker.

data dimension

A stripe of data accessed by a data role, such as the data controlled by a business unit.

data role

A role for a defined set of data describing the job a user does within that defined set of data. A data role inherits job orabstract roles and grants entitlement to access data within a specific dimension of data based on data security policies. Atype of enterprise role.

data security

The control of access to data. Data security controls what action a user can taken against which data.

data security policy

A grant of entitlement to a role on an object or attribute group for a given condition.

database item

An item of information that has special programming attached, which formulas and HCM extracts use to locate and retrievethe data.

database resource

An applications data object at the instance, instance set, or global level, which is secured by data security policies.


Glossary

257

department

A division of a business enterprise dealing with a particular area of activity.

descriptive flexfield

Customizable expansion space, such as fields used to capture additional descriptive information or attributes about an entity,such as customer cases. Information collection and storage may be configured to vary based on conditions or context.

duty role

A group of function and data privileges representing one duty of a job. Duty roles are specific to applications, stored in thepolicy store, and shared within an Oracle Fusion Applications instance.

educational establishment

A school, college, university, or other learning institution.

effective start date

For a date-effective object, the start date of a physical record in the object's history. A physical record is available totransactions between its effective start and end dates.

element

Component in the calculation of a person's pay. An element may represent a compensation or benefit type, such as salary,wages, stock purchase plans, pension contributions, and medical insurance.

element eligibility

The association of an element to one or more components of a person's employment record. It establishes a person'seligibility for that element. Persons are eligible for the element if their assignment components match the components of theelement eligibility.

element entry

The record controlling an employee's receipt of an element, including the period of time for which the employee receives theelement and its value.

eligibility profile

A user-defined set of criteria used to determine whether a person qualifies for a benefits offering, variable rate or coverage,compensation plan, checklist task, or other object for which eligibility must be established.

enterprise

An organization with one or more legal entities under common control.

enterprise role

Abstract, job, and data roles are shared across the enterprise. An enterprise role is an LDAP group. An enterprise role ispropagated and synchronized across Oracle Fusion Middleware, where it is considered to be an external role or role notspecifically defined within applications.


Glossary

258

entitlement

Grant of access to functions and data. Oracle Fusion Middleware term for privilege.

fast formula

A simple way to write formulas using English words and basic mathematical functions. Formulas are generic expressions ofcalculations or comparisons that repeat with different input values.

flexfield

A grouping of extensible data fields called segments, where each segment is used for capturing additional information.

function security

The control of access to a page or a specific widget or functionality within a page. Function security controls what a user cando.

gallery

A searchable collection of portraits that combines the functions of the person directory with corporate social networking andself-service applications for both workers and managers.

globals

Store values that are constant over a period of time. You can reference them in several formulas. Examples include the nameof a rate, a specific date, or a company term.

grade

A component of the employment model that defines the level of compensation for a worker.

grade rate

Used to define pay values for grades in a legislative data group.

HCM data role

A job role, such as benefits administrator, associated with instances of HCM data, such as all employees in a department.

headcount

A work measure recorded on an assignment. By default, the headcount of an organization is the total of primary assignmentsin primary work relationships.


Glossary

259

HR

Abbreviation for human resource.

identity

A person representing a worker, supplier, or customer.

job

A generic role that is independent of any single department or location. For example, the jobs Manager and Consultant canoccur in many departments.

job family

A group of jobs having different but related functions, qualifications, and titles. For example, you may group a trust analystand an operations analyst into the Analyst job family.

job role

A role for a specific job consisting of duties, such as an accounts payable manager or application implementation consultant.A type of enterprise role.

key flexfield

Configurable key consisting of multiple parts or segments, each of which have meaning either individually or in combinationwith other segments. Examples of key flexfields are part numbers, asset category, and accounts in the chart of accounts.

LDAP

Abbreviation for Lightweight Directory Access Protocol.

legal authority

A government or legal body that is charged with powers such as the power to make laws, levy and collect fees and taxes,and remit financial appropriations for a given jurisdiction.

legal employer

A legal entity that employs people.

legal entity

An entity identified and given rights and responsibilities under commercial law through the registration with country'sappropriate authority.

legal reporting unit

The lowest level component of a legal structure that requires registrations. Used to group workers for the purpose of tax andsocial insurance reporting or represent a part of your enterprise with a specific statutory or tax reporting obligation.

legislative data group

A means of partitioning payroll and related data. At least one legislative data group is required for each country where theenterprise operates. Each legislative data group is associated with one or more payroll statutory units.


Glossary

260

lookup code

An option available within a lookup type, such as the lookup code BLUE within the lookup type COLORS.

lookup type

The label for a static list that has lookup codes as its values.

object group

User-defined set of elements or people that restrict the items you want to include in various processes and reports.

payroll batch loader

An integrated Microsoft Excel workbook loader that helps you enter data more easily into HCM tables. Used for enteringbalances, balance groups, elements, element entries, payroll definitions, assigned payrolls, bank information for personalpayment methods, formula global values, and user-defined tables.

payroll interface report

A process to extract and generate a report of payroll-related data sent to a third-party payroll provider.

payroll relationship

Defines an association between a person and a payroll statutory unit based on payroll calculation and reporting requirements.

payroll statutory unit

A legal entity registered to report payroll tax and social insurance. A legal employer can also be a payroll statutory unit, but apayroll statutory unit can represent multiple legal employers.

person number

A person ID that is unique in the enterprise, allocated automatically or manually, and valid throughout the enterprise for all of aperson's work and person-to-person relationships.

person type

A subcategory of a system person type, which the enterprise can define. Person type is specified for a person at theemployment-terms or assignment level.

portrait

A selection of information about a worker or nonworker, including contact details, social connections, and activities andinterests, that can be viewed and edited. Both the amount and type of information and the available actions depend on therole of the portrait user.

position

A specific occurrence of one job that is fixed within one department. It is also often restricted to one location. For example,the position Finance Manager is an instance of the job Manager in the Finance Department.


Glossary

261

privilege

A grant of access to functions and data; a single, real world action on a single business object.

rating model

A scale used to measure the performance and proficiency of workers.

reference data set

Contains reference data that can be shared across a number of business units or other determinant types. A set supportscommon administration of that reference data.

role

Controls access to application functions and data.

role mapping

A relationship between one or more roles and one or more assignment conditions. Users with at least one assignment thatmatches the conditions qualify for the associated roles.

role provisioning

The automatic or manual allocation of a role to a user.

salary basis

Characterizes worker's base pay. Identifies payroll details used to pay base earnings, period of time pay is quoted, factorused to annualize base pay, components used to itemize adjustments into different reasons, and grade rate used for salaryvalidation.

salary component

Change reasons that enable itemization of salary adjustments by entering amounts or percentages for one or morecomponents, such as merit or cost of living adjustment.

scheduled process

A program that you run to process data and, in some cases, generate output as a report.

security profile

A set of criteria that identifies HCM objects of a single type for the purposes of securing access to those objects. The relevantHCM objects are persons, organizations, positions, countries, LDGs, document types, payrolls, and payroll flows.

security reference implementation

Predefined function and data security in Oracle Fusion Applications, including role based access control, and policies thatprotect functions, and data. The reference implementation supports identity management, access provisioning, and securityenforcement across the tools, data transformations, access methods, and the information life cycle of an enterprise.


Glossary

262

SQL predicate

A type of condition using SQL to constrain the data secured by a data security policy.

system person type

A fixed name that the application uses to identify a group of people.

tax reporting unit

A legal entity that groups workers for the purpose of tax and social insurance reporting.

user person type

A name, derived from a system person type, that you can configure to your requirements to identify a group of people.

value set

A set of valid values against which values entered by an end user are validated. The set may be tree structured (hierarchical).

work relationship

An association between a person and a legal employer, where the worker type determines whether the relationship is anonworker, contingent worker, or employee work relationship.

XML

Abbreviation for eXtensible markup language.

XML filter

A type of condition using XML to constrain the data secured by a data security policy.