Loading Payroll Interface Inbound Records Using HCM Data Loader

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 18

Loading Payroll Interface Inbound Records

Using HCM Data Loader

Oracle Fusion Human Capital Management 11g Release 11 (11.1.11)


ORACLE WHITE PAPER | FEBRUARY 2019
Table of Contents

Loading Payroll Interface Inbound Records Using HCM Data Loader 0


Introduction 1
How to Use the Information in This Document 1
Example Dat Files 1
Payroll Interface Inbound Records 2
Considerations and Prerequisites for Payroll Interface Inbound Record 2
Extensible Flexfield 2
Record Type 2
Loading Pregenerated Pay Slips 2
Loading Payroll Interface Inbound Records 2
Payroll Interface Inbound Record 2
Payroll Interface Inbound Record Information 4
Payroll Interface Inbound Record Dat File Examples 7
Pregenerated Pay Slip 10
Interface Inbound Records Errors 15

Table of Figures ÿ
þ
Figure 1: Employee Self Service – About Me ........................................................................................................ 12
Figure 2: Employee Self Service - Personal Information ........................................................................................ 12
Figure 3: Employee Self Service – My Documents ................................................................................................ 13
Figure 4: Employee Self Service - Personal Information ........................................................................................ 13
Figure 5: Employee Self Service - Payroll ............................................................................................................. 14
Figure 6: Employee Self Service – View Payslip ................................................................................................... 14
Figure 7: Person Management – View Payslip ...................................................................................................... 15
Figure 8: Person Management – View Payslip ...................................................................................................... 15

LOADING PAYROLL INTERFACE INBOUND RECORD USING HCM DATA LOADER


Introduction
Whether implementing Inbound Interface back feed for the first time or providing regular updates, you can create
PayrollInterfaceInboundRecord records using HCM Data Loader.

For general information about preparing data for loading using HCM Data Loader or the HCM Data Loader file format,
see the HCM Data Loader User’s Guide (MOS Doc ID: 1664133.1).

How to Use the Information in This Document


This document provides a separate section for each business object that it describes. Each section covers the following
topics:

 Considerations and Prerequisites What to consider before attempting to load data


 Loading Describes the business object hierarchy. For each business object component, a table of the attributes
that are commonly supplied when creating new records is provided. These tables have the following columns:

 HCM Data Loader Attribute The attribute name to supply when providing your data in the business object data
(.dat) file. Attribute names with a *1 suffix are foreign-object references that support the integration key types.
As source keys are recommended where possible, the document describes how to supply source key values.
User key attributes are identified for when you do not have the source key value.
 User Interface Prompt The prompt seen on the user interface. The data that you supply in the associated
attribute derives this field value, which is not necessarily the same as the value that you supply. For example,
for the Location field on an Organization page you can supply the Oracle Fusion surrogate ID, source key, or
Oracle Fusion GUID to identify the location uniquely. The value seen on the user interface will be the location
name.
If the User Interface Prompt is prefixed with an asterisk (*), then the attribute is mandatory when you create a
new record.
 Functional Description Additional information describing the attribute and how to supply valid values.

 Errors Identifies errors that may occur when loading data for the business object. Information about resolving the
error is provided.

Example Dat Files


This document provides working dat file examples for loading and deleting data using HCM Data Loader. To use the
source key examples, change the source system owner to a lookup code you have preconfigured in the
HRC_SOURCE_SYSTEM_OWNER lookup.

For both user key and source key examples, ensure that any references to foreign objects refer to data that exists in
your test environment.
Payroll Interface Inbound Records
The Payroll Interface Inbound Record object allows you to import a third-party provider’s processed payroll data into Oracle Human
Capital Management Cloud. The Payroll Interface Inbound Record is defined to load the following record types from the payroll vendor
into Oracle HCM Cloud.

 Processed payroll data

 Pregenerated pay slip

The imported payroll data can be used to perform the following actions in Oracle HCM Cloud:

 Create custom reports in the OTBI tool

 View imported pay slips from the employee portrait

Considerations and Prerequisites for Payroll Interface Inbound Record

Extensible Flexfield
A new extensible flexfield, Payroll Interface Inbound Record EFF, has been used to capture inbound payroll data from third-party
vendors. Different contexts with predefined segments are created to capture specific processed payroll values.

Record Type
Record type is specified in the extensible flexfield. Currently supported are payroll-processed data and pregenerated pay slip files, such
as PDF files.

Loading Pregenerated Pay Slips


When loading pay slip files, the Document of Record object is used to load the pregenerated pay slip. You must load this data either
with or before loading the payroll interface inbound record that references it.

Loading Payroll Interface Inbound Records


Payroll Interface Inbound Records data must be supplied in the PayrollInterfaceInboundRecord.dat file for processing by HCM Data
Loader.

PAYROLL INTERFACE INBOUND RECORDS HIERARCHY

Component Functional Description Discriminator


Payroll Interface Inbound Stores summary information from third-party payroll providers, such PayrollInterfaceInboundRecord
Record as the name and payroll period of the processed payroll.

Payroll Interface Inbound Stores details about payrolls processed by third-party payroll PayrollInterfaceInboundRecordInfo
Record Information providers, such as earnings, deductions, and messages.

Payroll Interface Inbound Record


The Payroll Interface Inbound Record component holds summary information from third-party payroll providers, such as the name and
payroll period of the processed payroll.

The discriminator PayrollInterfaceInboundRecord is used to load Payroll Interface Inbound Record records using HCM Data Loader.
The following PayrollInterfaceInboundRecord attributes are commonly supplied when loading a new Inbound Record.

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


PAYROLL INTERFACE INBOUND RECORD ATTRIBUTES

User Interface
HCM Data Loader Attribute Functional Description
Prompt

SourceSystemId / You must provide a unique reference for the record being created. Supply
SourceSystemOwner either a source key or the user key attributes RecordType, PayrollName,
LegislativeDataGroupName, PeriodName, BatchCode,
FunctionalCategory, SourceType, and EntityIdentifier.

FunctionalCategory * Functional Functional Category of Inbound Record. Validated by the lookup


Category ORA_HRY_INBD_FUNCTIONAL_CATG.
Functional Category lookup value examples:
 ADP Payforce
 Celergo
RecordType * Record Type Type of Inbound Record. Validated by the lookup
ORA_HRY_INBD_REC_RECORD_TYPE. Currently supported values are:
 Payroll Data Indicates importing processed payroll data
 Payslip Data Pregenerated pay slip files, such as PDF files.
BatchCode * Batch Code Batch or file identifier.

SourceType * Source Type Type of entity. Valid source types are:


 Person
 Payroll Terms
 Payroll Assignment
 Payroll Relationship
When supplying Payslip data you must supply the Payroll Relationship.
EntityIdentifier * Entity Identifier Number or name of entity. The value to supply is determined by the
SourceType.

SourceType Value to Supply

Person Person number

Payroll Terms Payroll terms number

Payroll Assignment Payroll assignment number

Payroll Relationship Payroll relationship number

LegislativeDataGroupName * Legislative Data Legislative data group name to store this record against.
Group Name

PayrollName * Payroll Name The name of the payroll.

DocumentType Document Type The type of document used to store the third-party payslip. The value is
required when the RecordType is Payslip Data and must be Third Party
Payslip.

DocumentCode Document Code The document code to uniquely identify the third-party payslip. This should
be the document code specified in the DocumentsOfRecord.dat used to
load the third-party payslip.
Required when the RecordType is ‘Payslip Data’.

StartDate Start Date Start date of the Inbound Record. The format is yyyy/mm/dd hh24:mi:ss.

PeriodName * Period Name Period to which the record relates.

VendorCode Vendor Code Inbound Record vendor name.

CategoryCode * Category Code Category against which the record is to be stored. For Third Party Payslip
data specify ‘ORA_HRY_INBD_PAYSLIP’. When supplying data for other
context specify ‘ORA_HRY_INBD_PAYROLL’.

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


User Interface
HCM Data Loader Attribute Functional Description
Prompt

BatchDate Batch Date Batch or file date.

The value supplied will derive the value seen in the field specified in the User Interface Prompt.
*1
The foreign object references support use of all key types: Oracle Fusion surrogate ID, source key, and user key.

Payroll Interface Inbound Record Information


The Payroll Interface Inbound Record Information component holds the details of payroll data processed by third-party payroll providers,
such as earning, deductions, and messages.

The discriminator PayrollInterfaceInboundRecordInfo is used to load Payroll Interface Inbound Record Information records using HCM
Data Loader. The following PayrollInterfaceInboundInfo attributes are commonly supplied when loading a new Payroll Interface Inbound
Record Information record.

PAYROLL INTERFACE INBOUND RECORD INFORMATION ATTRIBUTES

HCM Data Loader Attribute User Interface Functional Description


Prompt

SourceSystemId / You must provide a unique reference for the record being created.
SourceSystemOwner Supply either a source key or the user key attributes RecordType,
PayrollName, LegislativeDataGroupName, PeriodName, BatchCode,
FunctionalCategory, SourceType, EntityIdentifier, and
IriInformationContext

FLEX:ORA_HRY_PI_INBD_RECOR Payroll Interface Inbound Supply the context code for the category of data being loaded.
DS_INFO_EFF Record EFF Context
Context Value to Supply

Absence Information ORA_HRY_LEAVE_INFO

Message Information ORA_HRY_MESSAGE_INFO

Payment Information ORA_HRY_PAYMENT_INFO

Payroll Information ORA_HRY_PAYROLL_INFO

Third Party Payslip ORA_HRY_THIRD_PARTY_PAYSLIP

EFF_CATEGORY_CODE * EFF Category Code Supply the EFF Category Code. For Third Party Payslip information
supply ‘ORA_HRY_INBD_PAYSLIP’. For other context supply
‘ORA_HRY_INBD_PAYROLL’

FunctionalCategory * Functional Category Functional Category of Inbound Record. Validated by the lookup
ORA_HRY_INBD_FUNCTIONAL_CATG.
This value must match the functional category supplied for the parent
record.

RecordType * Record Type Type of Inbound Record. This value must match the record type
supplied for the parent record.

BatchCode * Batch Code Batch or file identifier. This value must match the batch code supplied
for the parent record.

SourceType * Source Type Type of entity. Valid source types are:


 Person
 Payroll Terms
 Payroll Assignment
 Payroll Relationship
This value must match the source type supplied for the parent record.
When supplying Payslip data you must supply the Payroll Relationship.

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


HCM Data Loader Attribute User Interface Functional Description
Prompt

EntityIdentifier * Entity Identifier Number or name of entity. The value to supply is determined by the
SourceType.

SourceType Value to Supply

Person Person number

Payroll Terms Payroll terms number

Payroll Assignment Payroll assignment number

Payroll Relationship Payroll relationship number


This value must match the entity identifier supplied for the parent
record.

LegislativeDataGroupName * Legislative Data Group Legislative data group name against which the record is to be stored.
Name This value must match the legislative data group name supplied for the
parent record.

PayrollName * Payroll Name Payroll name against which the record is to be stored. This value must
match the payroll name supplied for the parent record.

StartDate Start Date Start date of the Inbound Record. The format is yyyy-mm-dd. Note that
this format is different from that for the parent record. See bug
24931627 for details.

PeriodName * Period Name Period to which the record relates. This value must match the period
name supplied for the parent record.

IriInformationContext Payroll Interface Inbound Supply the context code for the category of data being loaded. This is
Record EFF Context the same value as for the
FLEX:ORA_HRY_PI_INBD_RECORDS_INFO_EFF attribute.

Extensible Flexfield Attributes to Supply When Loading Payment Information (Context: ORA_HRY_PAYMENT_INFO)

PaymentType(ORA_HRY_PI_INBD_ Payment Type Type of payment, such as cash, check, or electronic funds transfer.
RECORDS_INFO_EFF=ORA_HRY_
PAYMENT_INFO)

CheckNumber(ORA_HRY_PI_INBD_ Check Number Check number issued to the employee.


RECORDS_INFO_EFF=ORA_HRY_
PAYMENT_INFO)

BankName(ORA_HRY_PI_INBD_RE Bank Name Employee bank name for electronic funds transfer payments.
CORDS_INFO_EFF=ORA_HRY_PA
YMENT_INFO)

BranchName(ORA_HRY_PI_INBD_R Branch Name Employee branch name for electronic funds transfer payments.
ECORDS_INFO_EFF=ORA_HRY_P
AYMENT_INFO)

AccountName(ORA_HRY_PI_INBD_ Account Name Employee bank account name for electronic funds transfer payments.
RECORDS_INFO_EFF=ORA_HRY_
PAYMENT_INFO)

AccountNumber(ORA_HRY_PI_INBD Account Number Employee bank account number for electronic funds transfer
_RECORDS_INFO_EFF=ORA_HRY payments.
_PAYMENT_INFO)

IBAN(ORA_HRY_PI_INBD_RECOR IBAN International Bank Account Number to facilitate the communication and
DS_INFO_EFF=ORA_HRY_PAYME processing of cross-border transactions.
NT_INFO)

Amount(ORA_HRY_PI_INBD_RECO Amount Amount paid to the employee.


RDS_INFO_EFF=ORA_HRY_PAYM
ENT_INFO)

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


HCM Data Loader Attribute User Interface Functional Description
Prompt

Currency(ORA_HRY_PI_INBD_REC Currency Currency of the payment.


ORDS_INFO_EFF=ORA_HRY_PAY
MENT_INFO)

PaymentDate(ORA_HRY_PI_INBD_ Payment Date Date the instruction was given to transfer the payment from the source
RECORDS_INFO_EFF=ORA_HRY_ bank account to the employee’s bank account.
PAYMENT_INFO)

Extensible Flexfield Attributes to Supply When Loading Payroll Information (Context: ORA_HRY_PAYROLL_INFO)

PayrollRunType(ORA_HRY_PI_INBD Payroll Run Type Type of payroll run, such as regular or supplemental.
_RECORDS_INFO_EFF=ORA_HRY
_PAYROLL_INFO)

PayrollRunSequence(ORA_HRY_PI_ Payroll Run Sequence Order in which payroll run type is processed.
INBD_RECORDS_INFO_EFF=ORA_
HRY_PAYROLL_INFO)

ElementClassification(ORA_HRY_PI_ Element Classification Primary element classification, such as Standard Earnings or


INBD_RECORDS_INFO_EFF=ORA_ Supplemental Earnings.
HRY_PAYROLL_INFO)

ElementName(ORA_HRY_PI_INBD_ Element Name Name of the element.


RECORDS_INFO_EFF=ORA_HRY_
PAYROLL_INFO)

CostCenter(ORA_HRY_PI_INBD_RE Cost Center Cost center for employee payments.


CORDS_INFO_EFF=ORA_HRY_PA
YROLL_INFO)

CurrentAmount(ORA_HRY_PI_INBD Current Amount Total amount for the element in the current payroll period.
_RECORDS_INFO_EFF=ORA_HRY
_PAYROLL_INFO)

QuarterToDateAmount(ORA_HRY_PI Quarter-to-Date Amount Total amount for the element in the current quarter.
_INBD_RECORDS_INFO_EFF=ORA
_HRY_PAYROLL_INFO)

YearToDateAmount(ORA_HRY_PI_I Year-to-Date Amount Total amount for the element in the current financial year.
NBD_RECORDS_INFO_EFF=ORA_
HRY_PAYROLL_INFO)

Currency(ORA_HRY_PI_INBD_REC Currency Currency of payment.


ORDS_INFO_EFF=ORA_HRY_PAY
ROLL_INFO)

GeneralLedgerCreditAccount(ORA_H General Ledger Credit Code of the General Ledger account to credit earnings or deductions.
RY_PI_INBD_RECORDS_INFO_EFF Account
=ORA_HRY_PAYROLL_INFO)

GeneralLedgerDebitAccount(ORA_H General Ledger Debit Code of the General Ledger account to debit earnings or deductions.
RY_PI_INBD_RECORDS_INFO_EFF Account
=ORA_HRY_PAYROLL_INFO)

Extensible Flexfield Attributes to Supply When Loading Third-Party Pay Slip Information (Context:
ORA_HRY_THIRD_PARTY_PAYSLIP)

NetPayment(ORA_HRY_PI_INBD_R Net Payment The net payment amount.


ECORDS_INFO_EFF=ORA_HRY_T
HIRD_PARTY_PAYSLIP)

PayslipViewDate(ORA_HRY_PI_INB Payslip View Date


D_RECORDS_INFO_EFF=ORA_HR
Y_THIRD_PARTY_PAYSLIP)

Extensible Flexfield Attributes to Supply When Loading Absence Information (Context: ORA_HRY_LEAVE_INFO)

AbsenceName(ORA_HRY_PI_INBD_ Absence Name Name of the absence for the employee.

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


HCM Data Loader Attribute User Interface Functional Description
Prompt

RECORDS_INFO_EFF=ORA_HRY_
LEAVE_INFO)

AbsenceBalance(ORA_HRY_PI_INB Absence Balance Balance of hours or days remaining for the balance.
D_RECORDS_INFO_EFF=ORA_HR
Y_LEAVE_INFO)

AbsenceUnit(ORA_HRY_PI_INBD_R Absence Unit Total number of absence units.


ECORDS_INFO_EFF=ORA_HRY_L
EAVE_INFO)

AbsenceUnitOfMeasure(ORA_HRY_ Absence Unit of Measure Type of unit of measure, such as day or hour.
PI_INBD_RECORDS_INFO_EFF=O
RA_HRY_LEAVE_INFO)

AbsenceMessage(ORA_HRY_PI_IN Absence Message Message from the third-party payroll provider containing absence
BD_RECORDS_INFO_EFF=ORA_H information, such as remaining balance for the employee.
RY_LEAVE_INFO)

Extensible Flexfield Attributes to supply when loading Message Information (Context: ORA_HRY_MESSAGE_INFO)

MessageType(ORA_HRY_PI_INBD_ Message Type Severity level of the message.


RECORDS_INFO_EFF=ORA_HRY_
MESSAGE_INFO)

MessageId(ORA_HRY_PI_INBD_RE Message ID A short code for the message received from the third-party payroll
CORDS_INFO_EFF=ORA_HRY_ME provider.
SSAGE_INFO)

MessageText(ORA_HRY_PI_INBD_ Message Text Message from the third-party payroll provider containing information
RECORDS_INFO_EFF=ORA_HRY_ about any errors that occurred during file upload.
MESSAGE_INFO)

OutboundFileName(ORA_HRY_PI_I Outbound File name Name of the file sent to the third-party payroll provider.
NBD_RECORDS_INFO_EFF=ORA_
HRY_MESSAGE_INFO)

OutboundFileReceivedDate(ORA_HR Outbound File Received Date the outbound file was received by the third-party payroll provider.
Y_PI_INBD_RECORDS_INFO_EFF= Date
ORA_HRY_MESSAGE_INFO)

The value supplied will derive the value seen in the field specified in the User Interface Prompt.
*1
The foreign object references support use of all key types: Oracle Fusion surrogate ID, source key, and user key.

Payroll Interface Inbound Record Dat File Examples


This dat file data is classified into two sections.

 Inbound Record
 Inbound Record Info
The above attribute tables describe the respective record level information.

Supplying Payroll Interface Inbound Records


PayrollInterfaceInboundRecord.dat

This example provides the parent records for the Payroll Interface Inbound Record object. Source keys are not supplied, because this
data is usually sourced from a third-party payroll provider with no knowledge of existing source key values.

Examples for the child Payroll Interface Inbound Record Information are supplied below, describing each use case.

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


METADATA|PayrollInterfaceInboundRecord|SourceType|EntityIdentifier|FunctionalCategory|RecordT
ype|PeriodName|StartDate|BatchCode|BatchDate|VendorCode|LegislativeDataGroupName|PayrollName|
CategoryCode
MERGE|PayrollInterfaceInboundRecord|Person|955160008166185|ADP Payforce|Payroll Data|1 2015
Monthly (Calendar)||Monthly Payroll Data Jan15|2015/1/31 00:00:00|ADP|Vision Corporation US
LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYROLL
MERGE|PayrollInterfaceInboundRecord|Person|955160008166527|ADP Payforce|Payroll Data|1 2015
Monthly (Calendar)||Monthly Payroll Data Jan15|2015/1/31 00:00:00|ADP|Vision Corporation US
LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYROLL
MERGE|PayrollInterfaceInboundRecord|Person|955160008166310|ADP Payforce|Payroll Data|1 2015
Monthly (Calendar)||Monthly Payroll Data Jan15|2015/1/31 00:00:00|ADP|Vision Corporation US
LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYROLL
MERGE|PayrollInterfaceInboundRecord|Person|955160008166310|ADP Payforce|Payroll Data|2 2015
Monthly (Calendar)||Monthly Payroll Data Feb15|2015/1/31 00:00:00|ADP|Vision Corporation US
LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYROLL
MERGE|PayrollInterfaceInboundRecord|Payroll Terms|ET955160008166310|ADP Payforce|Payroll
Data|1 2015 Monthly (Calendar)||Monthly Payroll Data Jan15|2015/1/31 00:00:00|ADP|Vision
Corporation US LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYROLL
MERGE|PayrollInterfaceInboundRecord|Payroll Assignment|E955160008166310|ADP Payforce|Payroll
Data|1 2015 Monthly (Calendar)||Monthly Payroll Data Jan15|2015/1/31 00:00:00|ADP|Vision
Corporation US LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYROLL

Supplying Payroll Interface Inbound Record Information


The following examples provide the employee’s detailed level transaction for payroll processed result data. The following record types
can be supplied using the Payroll Interface Inbound Record object.

 Payment Info
 Payroll Info
 Message Info
 Absence Info
The Inbound Record Information component uses descriptive flexfields to support each record type. Each record type has its own
flexfield context structure.

PayrollInterfaceInboundRecord.dat

This first example provides the descriptive flexfield segments for all record types.

Scenario 1: The detailed Inbound Record Info has all flexfield context information for an employee.

METADATA|PayrollInterfaceInboundRecordInfo|SourceType|EntityIdentifier|RecordType|FunctionalCatego
ry|LegislativeDataGroupName|PayrollName|PeriodName|BatchCode|FLEX:ORA_HRY_PI_INBD_RECORDS_INFO_EFF
|IriInformationContext|EFF_CATEGORY_CODE|PaymentType(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYM
ENT_INFO)|CheckNumber(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|BankName(ORA_HRY_PI_I
NBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|BranchName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAY
MENT_INFO)|BranchNumber(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|AccountName(ORA_HRY
_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|AccountNumber(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA
_HRY_PAYMENT_INFO)|IBAN(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|Amount(ORA_HRY_PI_I
NBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|Currency(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYME
NT_INFO)|PaymentDate(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)|PayrollRunType(ORA_HRY
_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|PayrollRunSequence(ORA_HRY_PI_INBD_RECORDS_INFO_EF
F=ORA_HRY_PAYROLL_INFO)|ElementClassification(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INF
O)|ElementName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|CurrentAmount(ORA_HRY_PI_INB
D_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|QuarterToDateAmount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_
HRY_PAYROLL_INFO)|YearToDateAmount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|Currency
(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|CostCenter(ORA_HRY_PI_INBD_RECORDS_INFO_EF
F=ORA_HRY_PAYROLL_INFO)|GeneralLedgerDebitAccount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL
_INFO)|GeneralLedgerCreditAccount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|MessageTy
pe(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)|MessageId(ORA_HRY_PI_INBD_RECORDS_INFO_E
FF=ORA_HRY_MESSAGE_INFO)|MessageText(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)|Outbou

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


ndFileName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)|OutboundFileReceivedDate(ORA_HRY
_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)|AbsenceName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_H
RY_LEAVE_INFO)|AbsenceBalance(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)|AbsenceUnit(ORA
_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)|AbsenceUnitOfMeasure(ORA_HRY_PI_INBD_RECORDS_INF
O_EFF=ORA_HRY_LEAVE_INFO)|AbsenceMessage(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_PAYMENT_INFO|ORA_HRY_PAYMENT_INFO|ORA_HRY_INBD_PAYROLL|Direct
Deposit1|12345|HDFC2|ABCD|D0231|Gerry
Mars|90004|876454224|13000|INR|2015/01/28|||||||||||||||||||||||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_PAYROLL_INFO|ORA_HRY_PAYROLL_INFO|ORA_HRY_INBD_PAYROLL||||||||||||General
Payroll|1|EARNINGS|BASIC PAY|550|550|550|INR|G1234|900-00-456|800-00-456||||||||||||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_PAYROLL_INFO|ORA_HRY_PAYROLL_INFO|ORA_HRY_INBD_PAYROLL||||||||||||General
Payroll|1|DEDUCTIONS|VOLUNTARY DEDUCTION|550|550|550|INR|G1234|900-00-456|800-00-456||||||||||||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_PAYROLL_INFO|ORA_HRY_PAYROLL_INFO|ORA_HRY_INBD_PAYROLL||||||||||||General
Payroll|1|DEDUCTIONS|INCOME TAX|550|550|550|INR|G1234|900-00-456|800-00-456||||||||||||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_MESSAGE_INFO|ORA_HRY_MESSAGE_INFO|ORA_HRY_INBD_PAYROLL|||||||||||||||||||||||ERROR|E
RROR-211|Invalid Employee Number|OUBNDJNJPAYROLL23|2014/01/24|||||||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_LEAVE_INFO|ORA_HRY_LEAVE_INFO|ORA_HRY_INBD_PAYROLL||||||||||||||||||||||||||||CASUAL
|8|4|Day|||

Scenario 2: This example shows how to load only the payroll info flexfield context.

METADATA|PayrollInterfaceInboundRecordInfo|SourceType|EntityIdentifier|RecordType|FunctionalC
ategory|LegislativeDataGroupName|PayrollName|PeriodName|BatchCode|FLEX:ORA_HRY_PI_INBD_RECORD
S_INFO_EFF|IriInformationContext|EFF_CATEGORY_CODE|ElementClassification(ORA_HRY_PI_INBD_RECO
RDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|ElementName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYRO
LL_INFO)|CurrentAmount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|QuarterToDateAm
ount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|YearToDateAmount(ORA_HRY_PI_INBD_
RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|Currency(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYR
OLL_INFO)|CostCenter(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|GeneralLedgerDebi
tAccount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|GeneralLedgerCreditAccount(OR
A_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|PayrollRunSequence(ORA_HRY_PI_INBD_RECOR
DS_INFO_EFF=ORA_HRY_PAYROLL_INFO)|PayrollRunType(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAY
ROLL_INFO)
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP
Payforce|Vision Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll
Data Jan15|ORA_HRY_PAYROLL_INFO|ORA_HRY_PAYROLL_INFO|ORA_HRY_INBD_PAYROLL|EARNINGS|BASIC
PAY|10000|10000|10000|INR|G1234|900-00-456|800-00-456||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP
Payforce|Vision Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll
Data Jan15|ORA_HRY_PAYROLL_INFO|ORA_HRY_PAYROLL_INFO|ORA_HRY_INBD_PAYROLL|DEDUCTIONS|INCOME
TAX|550|550|550|INR|G1234|900-00-456|800-00-456||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP
Payforce|Vision Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll
Data
Jan15|ORA_HRY_PAYROLL_INFO|ORA_HRY_PAYROLL_INFO|ORA_HRY_INBD_PAYROLL|DEDUCTIONS|VOLUNTARY
DEDUCTION|800|800|800|INR|G1234|900-00-456|800-00-456||

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


Scenario 3: This example shows how to load only the Absence Info flexfield context.

METADATA|PayrollInterfaceInboundRecordInfo|SourceType|EntityIdentifier|RecordType|FunctionalCatego
ry|LegislativeDataGroupName|PayrollName|PeriodName|BatchCode|FLEX:ORA_HRY_PI_INBD_RECORDS_INFO_EFF
|IriInformationContext|EFF_CATEGORY_CODE|AbsenceName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAV
E_INFO)|AbsenceBalance(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)|AbsenceUnit(ORA_HRY_PI
_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)|AbsenceMessage(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY
_LEAVE_INFO)|AbsenceUnitOfMeasure(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166527|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_LEAVE_INFO|ORA_HRY_LEAVE_INFO|ORA_HRY_INBD_PAYROLL|CASUAL|8|4||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166310|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|1 2015 Monthly (Calendar)|Monthly Payroll Data
Jan15|ORA_HRY_LEAVE_INFO|ORA_HRY_LEAVE_INFO|ORA_HRY_INBD_PAYROLL|VACATION|20|4||
MERGE|PayrollInterfaceInboundRecordInfo|Person|955160008166310|Payroll Data|ADP Payforce|Vision
Corporation US LDG|Monthly Payroll|2 2015 Monthly (Calendar)|Monthly Payroll Data
Feb15|ORA_HRY_LEAVE_INFO|ORA_HRY_LEAVE_INFO|ORA_HRY_INBD_PAYROLL|VACATION|20|8||

As shown in these scenarios, you can either load all flexfield context information in a single file load or load with individual flex field
context information.

Pregenerated Pay Slip


This scenario is importing a pregenerated pay slip from a third-party vendor system to Oracle HCM Cloud.

The discriminator PayrollInterfaceInboundRecord is used to load the pregenerated pay slip files using HCM Data Loader with the same
attributes that are commonly supplied when loading payroll data for an employee.

The Payroll Inbound Record Info component holds the pay slip file details of an employee, which are loaded to the Document of
Records business object.

The important difference to be noted in payslip data upload is that the source type must always be a payroll relationship and the
EntityIdentifier field must carry the respective source type value (payroll relationship number).

The DocumentsOfRecord.dat file used to load the PDF pay slips can be provided together with the PayrollInterfaceInboundRecord.dat
file in the same compressed zip file for processing by HCM Data Loader. Alternatively, preload the DocumentOfRecord.dat file.

PayrollInterfaceInboundRecord.dat

METADATA|PayrollInterfaceInboundRecord|InbdRecordId|SourceType|EntityIdentifier|FunctionalCate
gory|RecordType|PeriodName|StartDate|BatchCode|BatchDate|VendorCode|LegislativeDataGroupName|P
ayrollName|CategoryCode|DocumentCode|DocumentType
MERGE|PayrollInterfaceInboundRecord||Payroll Relationship|955160008173009|ADP Payforce|Payslip
Data|11 2015 Monthly (Calendar)||Monthly Payroll Data Nov15|2015/11/01 00:00:00|ADP|Vision
Corporation US
LDG|ZHRX_US_PayrollOne|ORA_HRY_INBD_PAYSLIP|ThirdPartyPayslip_955160008173009_Nov2015|Third
Party Payslip
METADATA|PayrollInterfaceInboundRecordInfo|FLEX:ORA_HRY_PI_INBD_RECORDS_INFO_EFF|EFF_CATEGORY_
CODE|InbdRecordInfoId|InbdRecordId|SourceType|RecordType|BatchCode|FunctionalCategory|EntityId
entifier|LegislativeDataGroupName|PayrollName|PeriodName|IriInformationContext|SourceSystemOwn
er|SourceSystemId|GUID|NetPayment(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_THIRD_PARTY_PAYSLIP
)|PayslipViewDate(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_THIRD_PARTY_PAYSLIP)
MERGE|PayrollInterfaceInboundRecordInfo|ORA_HRY_THIRD_PARTY_PAYSLIP|ORA_HRY_INBD_PAYSLIP|||Pay
roll Relationship|Payslip Data|Monthly Payroll Data Nov15|ADP Payforce|955160008173009|Vision
Corporation US LDG|ZHRX_US_PayrollOne|11 2015 Monthly
(Calendar)|ORA_HRY_THIRD_PARTY_PAYSLIP|HRC_SQLLOADER|ADP_955160008173009_ORA_HRY_THIRD_PARTY_P
AYSLIP_0101||5550|2015/11/20

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


The actual pay slip files that are generated in PDF format from a third-party vendor would be uploaded into Documents of Record
business object using HCM Data Loader.

The pay slip data has two sections. The first part is a data file with a list of employees for whom a pay slip is being provided in this load
along with their respective pay slip PDF filenames. The pay slip data file must be named DocumentsOfRecord.dat.

The second part is the collection of actual pay slip PDF files. These PDF files must be grouped into a BlobFiles subfolder in the zip file.

This data file should be provided in the form of a compressed zip file. This zip file should contain the DocumentsOfRecord.dat file and
the subfolder BlobFiles containing the pay slip PDF files as mentioned above. This compressed file should be provided to the data
loader utility for loading the data.

This example shows the DocumentsOfRecord.dat file. The DocumentsOfRecord discriminator is used for the header record and the
DocumentAttachment record provides the attachment details. You must reference the PDF file placed in the BlobFiles folder by name
against the File attribute in the DocumentAttachment record.

DocumentsOfRecord.dat

METADATA|DocumentsOfRecord|PersonNumber|DocumentType|Country|DocumentCode|DocumentName|Docume
ntNumber|DateFrom|DateTo|IssuingAuthority|IssuedDate|IssuingCountry|IssuingLocation|Comments|
Publish|PublishDate|Status|VerifiedBy|VerifiedDate
MERGE|DocumentsOfRecord|955160008173009|Third Party
Payslip||ThirdPartyPayslip_955160008173009_Nov2015|USThirdPartyPayslip||2015/11/01|2015/11/30
||2015/11/30||||||||
METADATA|DocumentAttachment|PersonNumber|DocumentType|Country|DocumentCode|DataTypeCode|Title
|URLorTextorFileName|File
MERGE|DocumentAttachment|955160008173009|Third Party
Payslip||ThirdPartyPayslip_955160008173009_Nov2015|FILE|November
Payslip|USOnlinePayslip_November_2015.pdf|USOnlinePayslip_November_2015.pdf

The Following screen shots would help the user/employee to Navigate into view the imported payslips,

This feature is effective from Rel 13 onwards:

There are three ways to access the imported pay slips from Fusion system

Access Method Navigation Comments

Access Point 1 About MePersonal Information 


My Document

Access Point 2 About Me  Personal Information  This screen looks same as “My
Payroll  View Payslip Portrait” Navigation which
users/employee have used in prior to
Rel 13.

Access point 3 Person Management  View Payslip

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


Access Point 1:

Figure 1: Employee Self Service – About Me

Navigation: Employee Self Service

Figure 2: Employee Self Service - Personal Information

Navigation: Employee Self Service  About Me  Personal Information

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


Figure 3: Employee Self Service – My Documents
Navigation: Employee Self Service  About Me  Personal Information  My Documents

Access Point 2:

Figure 4: Employee Self Service - Personal Information


Navigation: Employee Self Service  About Me  Personal Information

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


Figure 5: Employee Self Service - Payroll
Navigation: Employee Self Service  About Me  Personal Information  Payroll  View Payslip

Figure 6: Employee Self Service – View Payslip


Navigation: Employee Self Service  About Me  Personal Information  Payroll  View Payslip

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


Access Point 3:

Figure 7: Person Management – View Payslip


Navigation: Person Management  Payroll  View Payslip

Figure 8: Person Management – View Payslip


Navigation: Person Management  Payroll  View Payslip

Interface Inbound Records Errors


You may experience errors while loading Payroll Interface Inbound Record if the data is not provided as expected. Some of the more
commonly occurring errors are:

Error Resolution

The Function Category for Person Number Ensure that the value passed for Functional Category for a Person Number is
{PERSON_NUMBER} is invalid. valid.

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER


Oracle Corporation, World Headquarters Worldwide Inquiries
500 Oracle Parkway Phone: +1.650.506.7000
Redwood Shores, CA 94065, USA Fax: +1.650.506.7200

CONNECT W ITH US

blogs.oracle.com/oracle Copyright © 2019, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the
contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject to any other
warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or
facebook.com/oracle fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are
formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any
twitter.com/oracle means, electronic or mechanical, for any purpose, without our prior written permission.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
oracle.com
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and
are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0219

Loading Payroll Interface Inbound Records using HCM Data Loader


February 2019

LOADING PAYROLL INTERFACE INBOUND RECORDS USING HCM DATA LOADER

You might also like