1. Administering Oracle Payroll Interface
  2. Loading Payroll Interface Inbound Records

Loading Payroll Interface Inbound Records

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

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.

These are the PayrollInterfaceInboundRecord attributes commonly supplied when loading a new Inbound Record:

HCM Data Loader Attribute

User Interface Prompt

Functional Description

SourceSystemId / SourceSystemOwner

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

FunctionalCategory

Functional Category

Functional Category of Inbound Record. Validated by the lookup 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:

Source Type

Value to Supply

Person

Person number

Payroll Terms

Payroll Terms number

Payroll Assignment

Payroll Assignment number

Payroll Relationship

Payroll Relationship number

LegislativeDataGroupName

Legislative Data Group Name

Legislative data group name to store this record against.

PayrollName

Payroll Name

The name of the payroll.

DocumentType

DocumentType

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

Name of the Vendor, validated by the lookup

ORA_HRY_INBD_REC_VEND during upload.

Eg. Look up code : ORA_HMRC, HRY_ADP

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’.

BatchDate

Batch Date

Batch or file date.

Payroll Interface inbound record information:

HCM Data Loader Attribute

User Interface Prompt

Functional Description

SourceSystemId / SourceSystemOwner

You must provide a unique reference for the record being created. 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_RECORDS_INFO_EFF

Payroll Interface Inbound Record EFF Context

Supply the context code for the category of data being loaded.

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
Note: This value must match the source type supplied for the parent record.

EntityIdentifier

Entity Identifier

Number or name of entity. The value to supply is determined by the SourceType:

Source Type

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 Name

Legislative data group name against which the record is to be stored. 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 Record EFF Context

Supply the context code for the category of data being loaded. This is 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)

HCM Data Loader Attribute

User Interface Prompt

Functional Description

PaymentType(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Payment Type

Type of payment, such as cash, check, or electronic funds transfer.

CheckNumber (ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Check Number

Check number issued to the employee.

BankName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Bank Name

Employee bank name for electronic funds transfer payments.

BranchName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Branch Name

Employee branch name for electronic funds transfer payments.

AccountName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Account Name

Employee bank account name for electronic funds transfer payments.

IBAN(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

IBAN

International Bank Account Number to facilitate the communication and processing of cross-border transactions.

Amount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Amount

Amount paid to the employee.

Currency(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Currency

Currency of the payment.

PaymentDate(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYMENT_INFO)

Payment Date

Date the instruction was given to transfer the payment from the source bank account to the employee’s bank account.

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

HCM Data Loader Attribute

User Interface Prompt

Functional Description

PayrollRunType(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Payroll Run Type

Type of payment, such as cash, check, or electronic funds transfer.

PayrollRunSequence(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Payroll Run Sequence

Order in which payroll run type is processed.

ElementClassification(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Element Classification

Primary element classification, such as Standard Earnings or Supplemental Earnings.

ElementName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Element Name

Name of the element.

CostCenter(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Cost Center

Cost center for employee payments.

CurrentAmount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Current Amount

Total amount for the element in the current payroll period.

QuarterToDateAmount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Quarter-to-Date Amount

Total amount for the element in the current quarter.

YearToDateAmount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Year-to-Date Amount

Total amount for the element in the current financial year.

Currency(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

Currency

Currency of payment.

GeneralLedgerCreditAccount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

General Ledger Credit Account

Code of the General Ledger account to credit earnings or deductions.

GeneralLedgerDebitAccount(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_PAYROLL_INFO)

General Ledger Debit Account

Code of the General Ledger account to debit earnings or deductions.

NetPayment(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_THIRD_PARTY_PAYSLIP)

Net Payment

The net payment amount.

PayslipViewDate(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_THIRD_PARTY_PAYSLIP)

Payslip View Date

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

HCM Data Loader Attribute

User Interface Prompt

Functional Description

AbsenceName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)

Absence Name

Name of the absence for the employee.

AbsenceBalance(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)

 Absence Balance

Balance of hours or days remaining for the balance.

AbsenceUnit(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)

Absence Unit

Total number of absence units.

AbsenceUnitOfMeasure(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)

Absence Unit of Measure

Type of unit of measure, such as day or hour.

AbsenceMessage(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_LEAVE_INFO)

Absence Message

 Message from the third-party payroll provider containing absence information, such as remaining balance for the employee.

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

HCM Data Loader Attribute

User Interface Prompt

Functional Description

MessageType(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)

Message Type

Severity level of the message.

MessageId(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)

 Message ID

A short code for the message received from the third-party payroll provider.

MessageText(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)

Message Text

Message from the third-party payroll provider containing information about any errors that occurred during file upload.

OutboundFileName(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)

Outbound File name

Name of the file sent to the third-party payroll provider.

OutboundFileReceivedDate(ORA_HRY_PI_INBD_RECORDS_INFO_EFF=ORA_HRY_MESSAGE_INFO)

Outbound File Received Date

 Date the outbound file was received by the third-party payroll provider.