Load Element Entries Using HDL
Load Element Entries Using HDL
Loader
Oracle Fusion Human Capital Management 11g Release 9
(11.1.9)
ORACLE WHITE PAPER | MAY 2017
Table of Contents
Element Entry 3
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).
For both user key and source key examples, ensure that any references to foreign objects refer to data
that exists in your test environment.
See the Manage Element Entries topic in Applications Help for further information on element entries.
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.
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.
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
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
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).
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.
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.
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.
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.
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.
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
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.
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
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.
METADATA|ElementEntry|SourceSystemOwner|SourceSystemId|EffectiveStartDate
DELETE|ElementEntry|VISION|1008_MISC_1|2015/01/01
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