Loading Element Entries Using HCM Data

Loader
Oracle Fusion Human Capital Management 11g Release 9
(11.1.9)
ORACLE WHITE PAPER | MAY 2017
Table of Contents

How to Use the Information in This Document 1

Example .dat Files 2

Considerations and Prerequisites for Element Entry 3

Loading Element Entry 3

Element Entry 3

Element Entry Value 5

Element Entry .dat File Example 7

Creating Element Entries Using Source Keys 7

Element Entry Errors 7

End Dating Recurring Element Entries 7

Changing the Logical End Date of an Element Entry 7

Deletion Support for Element Entry 8

Deleting an Element Entry 8

0 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

Introduction
Whether implementing Oracle Fusion Payroll for the first time or providing regular updates, you can
create element entry 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.
» Deletion Support Describes the extent to which the business object supports data deletion. Some
objects do not support deletion, while others may support deletion of child records only.
» Translation Information on how to provide translation data for the translatable attributes in the
business object hierarchy.

1 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

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.

2 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

Element Entry
Element entries are used to capture earnings, deductions, absences, and basic benefit details for an employee
assignment. For example, you can create element entries for an employee's overtime hours or medical premium
deduction amount.

See the Manage Element Entries topic in Applications Help for further information on element entries.

Considerations and Prerequisites for Element Entry

Elements are an important feature for several Oracle Fusion HCM products, including Global Payroll, Global Human
Resources, Compensation, and Time and Labor.

Refer to the appropriate implementation guide to understand the prerequisite setup for each HCM product. For
example, if you are loading element entries for processing in Global Payroll, then refer to the Elements topic in the
Implementing Global Payroll guide for your country.

If you are not loading element entries for capturing compensation information, such as salary, then refer to the
Elements, Balances and Formulas Task List in the Implementing Global Human Resources guide.

Loading Element Entry

Element Entry data must be supplied in the ElementEntry.dat file for processing by HCM Data Loader.

ELEMENT ENTRY HIERARCHY

Component Functional Description Discriminator

Element Entry An element entry holds the actual payroll element and benefits granted to a worker. ElementEntry
These may be ongoing, recurring entries, such as salary, or single-period, nonrecurring
entries, such as a bonus.

Element Entry Element entry values are the individual values that are contained in the input values for ElementEntryValue
Value an element entry. They can have default values or be entered by a user.

Element Entry
The Element Entry holds details of the payroll element and benefits granted to a worker.

The discriminator ElementEntry is used to load element entry records using HCM Data Loader. The following
ElementEntry attributes are commonly supplied when loading a new element entry.

ELEMENT ENTRY ATTRIBUTES

HCM Data Loader

User Interface Prompt Functional Description
Attribute

SourceSystemId / * Element You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner * Assignment Number source key or the user key attributes LegislativeDataGroupName, ElementName,
AssignmentNumber, and MultipleEntryCount.
* Sequence Number

EffectiveStartDate * Effective Start Date The start date of the element entry or the update to the element entry, if you are
supplying date-effective history.

EffectiveEndDate Effective End Date The end date of the element entry or the update to the element entry, if you are

3 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

HCM Data Loader
User Interface Prompt Functional Description
Attribute

supplying date-effective history. If left blank, this value is the end of time by
default.

AssignmentNumber * Assignment Specify the assignment number for the element entry. The feature creates the
entry in the appropriate employment record based on the element type definition.
For example, if the element is defined at assignment level, then the entry is
created for the assignment number passed in the batch. If the element is defined
at terms level, the entry is created for the terms associated with the assignment
number passed in the batch. If the element is defined at payroll relationship level,
then the entry is created for the terms associated with the assignment number
passed in the batch.

MultipleEntryCount * Sequence Number Supply the sequence number for the element entry. This value is 1 if this is the first
occurrence of this element on this date.

CreatorType Source This value is derived. It indicates whether the element entry was added through
the user interface, loaded by a batch, or created by an HCM product such as
Absence Management.

DateEarned

ElementName * Element The name of the element.

LegislativeDataGroupI * not displayed Provide a reference to the legislative data group. If you are using user keys, then
d *1 supply the attribute LegislativeDataGroupName.
This object also supports source keys. If you supplied a source key when you
created the legislative data group, then you can supply it here by adding the
source key hint to this attribute. For example,
LegislativeDataGroupId(SourceSystemId).

EntryType * Entry Type Supply the value E.

User key attributes that need to be supplied only if no other key type is provided.

LegislativeDataGroup The name of the legislative data group. Supply this value if no other key type is
Name provided to reference the legislative data group.

The attribute value supplied will derive the value seen in the field specified in the User Interface Prompt.
* Required
*1
The foreign object reference supports all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and user
key.

4 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

Figure 1. Create Element Entry
Navigation: Payroll Administration – Manage Element Entries

Figure 2. Manage Person Details

Navigation: Payroll Administration – Manage Element Entries – Create

Element Entry Value

Element entries are used to capture earnings, deductions, absences, and basic benefit details for an employee.
They can be defined at payroll relationship, terms, and assignment levels.

The element entry values hold the necessary values for the element type. For example, a salary entry may capture
the salary value and the salary frequency. A tax entry may capture the employee’s work location, as this information
is critical to the tax calculation.

Customers can also capture costing details for the entry. Refer to the Implementing Payroll Costing feature for more
details on this feature.

The discriminator ElementEntryValue is used to load element entry value records using HCM Data Loader. The
following ElementEntryValue attributes are commonly supplied when loading a new element entry.

5 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

ELEMENT ENTRY VALUE ATTRIBUTES

HCM Data Loader User Interface

Functional Description
Attribute Prompt

SourceSystemId / * Element You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner * Assignment Number source key or the user key attributes LegislativeDataGroupName, ElementName,
AssignmentNumber, MutipleEntryCount, and InputValueName.
* Sequence Number
* input value name (the
name is displayed on the
UI)
1
ElementEntryId * * Element The unique reference to the element entry this value is for. If supplying user keys,
* Assignment Number use the attributes LegislativeDataGroupName, ElementName,
AssignmentNumber, and MultipleEntryCount.
* Sequence Number
This attribute also supports the integration key types. If you supplied a source key
for the element entry, then supply the same value here and append the source key
hint to the attribute name, for example, ElementEntryId(SourceSystemId).

EffectiveStartDate * Effective Start Date The start date of the element entry value or the update to the element entry value,
if you are supplying date-effective history.

EffectiveEndDate Effective End Date The end date of the element entry value or the update to the element entry value,
if you are supplying date-effective history. If left blank, this value is the end of time
by default.

LegislativeDataGroupN * not displayed The name of the legislative data group.

ame

ElementName * Element Provide the name of the element this value is for.

AssignmentNumber * Assignment Number Specify the assignment number for the element entry. The feature creates the
entry in the appropriate employment record based on the element type definition.
For example, if the element is defined at assignment level, then the entry is
created for the assignment number passed in the batch. If the element is defined
at terms level, then the entry is created for the terms associated with the
assignment number passed in the batch. If the element is defined at payroll
relationship level, then the entry is created for the terms associated with the
assignment number passed in the batch.

InputValueName * Input Values names are The name of the element input value defined by the user.
specified by the user when
creating the element.
These user-defined names
are displayed in the Entry
Values region

ScreenEntryValue * value displayed The value for the input value name.
Note: For input values that have a Date data type the format of the date supplied
to this attribute should be YYYY-MM-DD.

MultipleEntryCount * Sequence Sequence of the entry values.

The attribute value supplied will derive the value seen in the field specified in the User Interface Prompt.
* Required
*1
The foreign object reference supports all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and user
key.

6 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

Element Entry .dat File Example

Creating Element Entries Using Source Keys

This file creates a recurring element entry.

METADATA|ElementEntry|SourceSystemOwner|SourceSystemId|AssignmentNumber|EffectiveStar
tDate|EffectiveEndDate|ElementName|LegislativeDataGroupName|MultipleEntryCount|EntryT
ype|CreatorType
MERGE|ElementEntry|VISION|1008_MISC_1|E1008|2015/01/01|4712/12/31|Misc Allowance|USA
LDG|1|E|H
METADATA|ElementEntryValue|SourceSystemOwner|SourceSystemId|ElementEntryId(SourceSyst
emId)|EffectiveStartDate|EffectiveEndDate|ElementName|LegislativeDataGroupName|Multip
leEntryCount|AssignmentNumber|InputValueName|ScreenEntryValue
MERGE|ElementEntryValue|VISION|1008_MISC_1_REASON|1008_MISC_1|2015/01/01|4712/12/31|M
isc Allowance|USA LDG|1|E1008|Reason|Away from home
MERGE|ElementEntryValue|VISION|1008_MISC_1_AMOUNT|1008_MISC_1|2015/01/01|4712/12/31|M
isc Allowance|USA LDG|1|E1008|Amount|500
MERGE|ElementEntryValue|VISION|1000_MISC_1_DATE|1000_MISC_1|2015/01/01|4712/12/31|Mis
c Allowance|USA LDG|1|E1008|Date|2015-01-16

Element Entry Errors

You may experience errors while loading element entries if the data is not provided as expected. Some of the more
commonly occurring errors are shown in this table.

Error Resolution

The value is not valid for the attribute The input value could not be identified, usually because not all attributes that identify it uniquely
InputValueId. were included. Ensure that ElementName, LegislativeDataGroupName, and InputValueName are
all specified.

End Dating Recurring Element Entries

To alter the last effective end date, also known as the logical end date, include the ReplaceLastEffectiveEndDate
attribute in your METDATA line and provide a Y value to indicate that the EffectiveEndDate supplied is a change to
the existing logical end date of your record. You must supply a record for the element entry and every element entry
value.

Changing the Logical End Date of an Element Entry

This file adjusts the logical end date of an existing element entry:

METADATA|ElementEntry|SourceSystemOwner|SourceSystemId|EffectiveStartDate|EffectiveEn
dDate|ReplaceLastEffectiveEndDate
MERGE|ElementEntry|VISION|1008_MISC_1|2015/01/01|4712/12/31|Y
METADATA|ElementEntryValue|SourceSystemOwner|SourceSystemId|ElementEntryId(SourceSyst
emId)|EffectiveStartDate|EffectiveEndDate|ReplaceLastEffectiveEndDate
MERGE|ElementEntryValue|VISION|1008_MISC_1_REASON|1008_MISC_1|2015/01/01|2015/12/31|Y
MERGE|ElementEntryValue|VISION|1008_MISC_1_AMOUNT|1008_MISC_1|2015/01/01|2015/12/31|Y
MERGE|ElementEntryValue|VISION|1000_MISC_1_DATE|1008_MISC_1|2015/01/01|2015/12/31|Y

7 | LOADING ELEMENT ENTRIES USING HCM DATA LOADER

Deletion Support for Element Entry
You can delete element entry data using HCM Data Loader.

Care should be taken when using HCM Data Loader to delete records, as deleted records cannot be recovered. Do
not supply DELETE instructions in the same file as MERGE instructions.

Deleting an Element Entry

This file deletes an existing element entry:

METADATA|ElementEntry|SourceSystemOwner|SourceSystemId|EffectiveStartDate
DELETE|ElementEntry|VISION|1008_MISC_1|2015/01/01

8 | LOADING ELEMENT ENTRIES 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 © 2017, 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
facebook.com/oracle warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or
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.com Oracle and Java are registered trademarks of Oracle 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 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. 0517

White Paper Title

May 2017