1Introduction to Integrating with Oracle HCM Cloud

This chapter contains the following:

Overview of Integrating with Oracle HCM Cloud

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

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


This table describes Chapter 1.

Chapter Title Contents


Introduction to Integrating with Oracle HCM Cloud

An introduction to this guide and an overview of the available approaches to data loading and extracts.

Data Loading Using HCM Data Loader

This table describes chapters related to bulk data loading with HCM Data Loader.

Chapter Title Contents


Introduction to HCM Data Loader

An introduction to HCM Data Loader and the data-loading process.


Data File Instructions and Delivery

Valid instructions to include in data files, how to deliver data files for upload, and how to generate and use business-object templates.


Preparing to Use HCM Data Loader

Setting configuration parameters, defining referenced objects, reviewing lists of values, and finding business-object information.


Data Preparation

General guidance for preparing various types of data, such as images and attachments, to ensure successful loading. Information about specifying the supported key types.


Loading Date-Effective Data

How to load date-effective objects successfully and achieve the required results.


Loading Flexfield Data

How to load data for descriptive and extensible flexfields.


Loading Setup Objects

How to load setup objects, such as Actions, Action Reasons, Name Format, and Person Type.


Loading Workers

How to load components of the Worker object.


Loading Worker-Related Objects

How to load worker-related objects, such as Area of Responsibility, Document Record, and User.


Loading Work Structures

How to load work structures, such as Grade, Job, and Organization.


Loading Compensation Objects

How to load compensation objects, such as Progression Grade Ladder, Salary Basis, and Salary.


Loading Payroll Relationships

How to load payroll information at the payroll relationship, payroll assignment records, and at assigned payroll levels.


Loading Payroll Setup Objects

How to load payroll setup objects, such as object groups, payroll consolidation groups, payroll definitions, time definitions, user-defined tables, fast formula, and elements.


Loading Elements and Element Entries

How to load elements, which determine the payment of base pay, benefits, absences, earnings and deductions.


Initializing and Adjusting Balances

How to load payroll balance groups and to initialize, and adjust balances.


Loading Payment Methods

How to load banks, bank branches, external bank accounts, and organization and personal payment methods.


Loading Payroll Costing

How to load payroll costing setup details for different payroll accounts.


Loading Payroll Data Using Transformation Formula

How to use transformation formula to transform your payroll data into a format that is supported by HCM Data Loader or HCM Spreadsheet Data Loader.


Loading Talent Objects

How to load talent objects, such as Goal and Goal Plan.


Loading Learning Objects

How to load learning objects, such as Course, Classroom Resource, and Legacy Learning Item.


Loading Absences Objects

How to load absences objects, such as Accrual Plan Enrollment and Absence Entry.


Loading Benefits Objects

How to load benefits objects, such as Beneficiary Enrollments, Person Benefit Groups, and Person Habits.


Importing and Loading Data Using HCM Data Loader

How to import and load data and correct any errors.

Data Loading Using Spreadsheet Loaders

This table describes chapters related to bulk data loading with spreadsheets.

Chapter Title Contents


Data Loading Using Spreadsheets

An overview of the available spreadsheet loaders and general setup requirements for spreadsheet usage.


Introduction to HCM Spreadsheet Data Loader

An overview of HCM Spreadsheet Data Loader, its processing, and its access requirements.


HCM Spreadsheet Data Loader Templates

How to create, edit, copy, export, and import spreadsheet templates.


Importing and Loading Data Using HCM Spreadsheet Data Loader

How to generate a spreadsheet from a template, populate the spreadsheet, import and load the data, and fix any errors.

Postload Processing

This table lists chapters related to postload processing for bulk data loading.

Chapter Title Contents


Postload Processing for HCM Data Loader

Processes that you must run after loading specific business objects using either HCM Data Loader or HCM Spreadsheet Data Loader.


Purging Person Data from Test Environments

Processes to run in test environments to purge person and dependent data.


HCM Extracts and Diagnostics for HCM Data Loader and HCM Spreadsheet Data Loader

How to configure and run HCM extracts for HCM Data Loader. How to run the HCM Data Loader Error Analysis Report diagnostic test and the HCM Spreadsheet Data Loader diagnostic report.

Best Practices

This table lists chapters that offer advice for your data loading efforts.

Chapter Title Contents


Best Practices for HCM Data Loader and HCM Spreadsheet Data Loader

Recommended approaches to data creation and maintenance.

Loading Payroll

This table lists chapters associated with loading third-party data.

Chapter Title Contents


Time, Absence, and Pension Data for Payroll

Loading third-party time entries, pension deductions, and absence information in XML format to Oracle Global Payroll.

Extracting Data

This table describes chapters that discuss data extracts.

Chapter Title Contents


Managing HCM Extracts

Using HCM Extracts to extract data from Oracle HCM Cloud.


Filtering and Delivering HCM Extracts

Filtering HCM Extracts data and selecting a delivery format.


Flow Patterns

Using flow patterns to complete extract reports and processes.


Benefits Data Extract

Setting up benefits plan carriers and extracting benefits enrollment information into an XML file for each carrier.


Talent Review and Succession Management Data Extract

The user entity, database items group, and extract definition type for the Talent Review and Succession Management data that you can extract using HCM Extracts.

Transferring Encrypted Data

This table describes chapters that relate to moving encrypted data.

Chapter Title Contents


Transferring Encrypted Data

How to set up data encryption. How to upload and extract encrypted data.

Oracle Taleo Recruiting Cloud Service Integration

This table describes chapters that cover integration between Oracle Taleo Recruiting and Oracle HCM Cloud.

Chapter Title Contents


Oracle Taleo Recruiting Cloud Service Integration

How integration between Oracle Taleo Recruiting Cloud Service and Oracle HCM Cloud is managed.

Web Services

This table lists chapters that discuss integrating web services with Oracle HCM Cloud.

Chapter Title Contents


Web Services

Using web services to integrate web-based applications with Oracle HCM Cloud.

This topic introduces ways of developing inbound integrations to Oracle HCM Cloud.

These include:

  • HCM Data Loader

  • HCM Spreadsheet Data Loader

HCM Data Loader

Use HCM Data Loader to load data in bulk from any source to Oracle HCM Cloud.

HCM Data Loader loads:

  • Complex, hierarchical data

  • Large volumes of data, such as complete system extracts

  • Object history

You can use HCM Data Loader for both data migration and ongoing data maintenance. Major benefits of HCM Data Loader include support for:

  • Most HCM business objects

  • Incremental or partial data loading

  • Four types of keys to identify records uniquely

  • Configured descriptive flexfields and extensible flexfields, translation data, tree hierarchies, person images, and document-record attachments

HCM Data Loader provides:

  • A comprehensive user interface for initiating data upload, monitoring progress, and reviewing errors

  • A template file for each supported business-object hierarchy, which you can use as the basis for your own data files

  • A user interface for reviewing the structure and attributes of every supported business-object hierarchy

  • A web service that you can use to automate data upload

Note: The precursor of HCM Data Loader is HCM File-Based Loader. For information, see Overview: Transitioning from HCM File-Based Loader to HCM Data Loader (2206596.1) on My Oracle Support at https://support.oracle.com.

HCM Spreadsheet Data Loader

Use HCM Spreadsheet Data Loader to import data to the HCM Data Loader stage tables from spreadsheets. HCM Spreadsheet Data Loader supports most of the business objects that HCM Data Loader supports. It offers both ease of use and flexibility. For example, you can configure spreadsheet templates to suit business needs by omitting attributes, changing attribute order, changing attribute labels, and adding help text.

This topic introduces ways of developing outbound integrations from Oracle HCM Cloud.

These include:

  • HCM Extracts

  • Oracle Business Intelligence Publisher (Oracle BI Publisher)

HCM Extracts

The main way to retrieve data in bulk from Oracle HCM Cloud is HCM Extracts, which is a tool for generating data 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 HCM Cloud. This feature enables you to automate the outbound extract as part of an overall integration flow.

HCM Extracts Output Formats

Using the built-in integration with Oracle BI Publisher, you can generate extracts in various formats, including CSV, XML, Microsoft Excel, HTML, RTF, and PDF.

You can download the raw hierarchical XML from a completed extract using the Extract Actions Service web service. Alternatively, you can download the formatted BI report (for example, the CSV file) using the BI ScheduleService. In both cases, the output is streamed in a byte array. Therefore, any orchestration mechanism must 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 can generate a BI report based on the extract using either Oracle BI Publisher or the BI ReportService. This technique uses a dedicated BI data model that interfaces with the generated HCM Extracts XML.

Oracle BI Publisher

Oracle BI Publisher supports both scheduled and unplanned reporting, based on either predefined Oracle Transactional Business Intelligence analysis structures or your own data models. You can generate reports in various formats. To use Oracle BI Publisher for outbound integrations, you generate reports in a format suitable for automatic downstream processing, such as XML or CSV.