HDL Documnet 24B
HDL Documnet 24B
HCM Data Loader (HDL) supports a flexible, pipe-delimited file format that allows
you to provide just the business objects, components and component attributes that
are required for your use case. Full sets of data can be loaded, or just incremental
changes. To achieve this flexibility, each file must specify which of the business object
components and attributes are included in the file.
Oracle HCM Cloud business objects can be complex and are usually hierarchical,
allowing for multiple child records to be created for a business object, e.g., multiple
phone numbers for a Person, or multiple valid grades for a job.
When you supply data to be processed by HDL, you must uniquely identify each
record in the file. For new records, two mechanisms are supported:
Objectives
In this tutorial you will:
1|Page
Prerequisites
To complete this tutorial, you will require:
METADATA|JobFamily|JobFamilyCode|JobFamilyName|EffectiveStartDate|EffectiveEndDate
MERGE|JobFamily|SALES|Sales|2000/01/01|4712/12/31
1. In the application, on the home page, click My Client Groups > Data Exchange
2. Click Import and Load Data
3. Click Import File on the page header.
4. Drag and drop your .zip file from your file explorer to the Choose File button.
Alternatively, click the Choose File button to search and select your file.
5. Click Submit Now. You don't need to change the default parameter values.
6. Click OK on the Submitted confirmation page.
7. Click Refresh to see your data set information.
8. The Import Status indicates if the data in your file is imported into the
staging tables.
9. The Load Status indicates if the data is successfully loaded into the Oracle
HCM Cloud application tables.
Before you can load a file that uses source keys, you must first register your source
system owner value.
1. Log into the application with a user who can access Setup and Maintenance.
2. Navigate to My Enterprise > Setup and Maintenance.
3. Search for and select the Manage Common Lookups task.
4. Search for the Lookup Type HRC_SOURCE_SYSTEM_OWNER
5. Click the Add icon in the Lookup Codes table
2|Page
Creating a Simple Source Key File
In this step, you’ll create a simple source key file to load grades.
Updating Records
In this step, you'll learn how to update individual records and add new child records.
Tip:
Use the View Business Objects task to determine if an object supports updates.
METADATA|Answer|SubscriberName|QuestionCode|QstnVersionNum|AnswerCode|LongText|
SequenceNumber|Score
MERGE|Answer|Recruiting|FEEDBACK_1|1|FEEDBACK_1ANS11|Yes, I'm satisfied.|5|151
MERGE|Answer|Recruiting|FEEDBACK_1|1|FEEDBACK_1ANS21|No, I'm not satisfied.|3|151
MERGE|Answer|Recruiting|FEEDBACK_1|1|FEEDBACK_1ANS31|I have no opinion on this.|2|151
3|Page
Deleting Records
In this step, you'll learn how to delete individual records and complete objects.
METADATA|Question|QuestionCode|QstnVersionNum|SubscriberName
MERGE|Question|FEEDBACK_1|1|Recruiting
METADATA|Answer|QuestionCode|QstnVersionNum|SubscriberName|AnswerCode
DELETE|Answer|FEEDBACK_1|1|Recruiting|FEEDBACK_1ANS31
ElementEntry.dat.
METADATA|ElementEntry|...|SourceRef001=PersonNumber|
SourceRef002=ElementName|SourceRef003=Amount
MERGE|ElementEntry|...|892334|Travel Allowance|200
Next Steps
The following tutorials will further expand your HCM Data Loader knowledge:
4|Page
Create and Load New Hires with HCM Data Loader (HDL)
Understanding HCM Data Loader (HDL) Business Objects
Loading Flexfield Segments, Images and Attachments with HCM Data Loader (HDL)
Make Date-Effective Changes with HCM Data Loader (HDL)
Introduction
The Worker business object is complex with around 30 components in the object
hierarchy. This tutorial doesn't attempt to cover all available components of this
complex object but provides guidance on the rules you need to follow when
uploading new hires.
When you create a new hire, you must supply data for these components of the
Worker object hierarchy:
Worker
PersonName
WorkRelationship
WorkTerms
Assignment
It's recommended that you also supply PersonLegislativeData. If you don't supply it, a
legislative data record will be auto-generated, with an auto-generated source key.
Objectives
In this tutorial you will:
Create and upload a HCM Data Loader Worker.dat file to load new hires.
Understand the rules specific to loading new hires.
Prerequisites
To complete this tutorial, you will require:
5|Page
Task 1: Create the Source System Owner
Before you can load a file that uses source keys, you must first register your source
system owner value.
1. In the application, click on your username and click Setup and Maintenance.
2. Click on the side drawer icon and click Search.
3. Search for and select the Manage Common Lookups task.
4. Search for the Lookup Type HRC_SOURCE_SYSTEM_OWNER
5. Click the Add icon in the Lookup Codes table
6. Specify EMP(any name) in the lookup code and meaning, specify a Start Date
of 01/01/2000.
7. Click Save.
In this step you'll create a Worker.dat file containing records for the mandatory and
recommended components of the Worker object hierarchy.
Worker
The Worker component identifies the worker with the Person Number and Date of
Birth.
Create a new file and add these file lines:
METADATA|Worker|SourceSystemOwner|SourceSystemId|EffectiveStartDate|
PersonNumber|StartDate|DateOfBirth|ActionCode
MERGE|Worker|EMP|HDL001|2001/09/08|HDL-1001|2001/09/08|1952/05/21|HIRE
MERGE|Worker|EMP|HDL002|2005/02/08|HDL-1002|2005/02/08|1966/04/21|HIRE
In this example:
6|Page
The value for EffectiveStartDate must match the StartDate value when
creating new hires.
Person Name
The PersonName component records your employee's name.
METADATA|PersonName|SourceSystemOwner|SourceSystemId|
EffectiveStartDate|PersonId(SourceSystemId)|NameType|
LegislationCode|Title|LastName|FirstName
MERGE|PersonName|EMP|HDL001_NME|2001/09/08|HDL001|GLOBAL|US|
MR.|Wells|Christopher
MERGE|PersonName|EMP|HDL002_NME|2005/02/08|HDL002|GLOBAL|US|
MRS.|Hugh|Lorraine
In this example:
The LegislationCode determines the valid values for the Title attribute, so if
you change the legislation code you may need to change the value for
the Title attribute.
The value for EffectiveStartDate on the PersonName record must match that
of the Worker record for new hires.
METADATA|PersonLegislativeData|SourceSystemOwner|
SourceSystemId|EffectiveStartDate|PersonId(SourceSystemId)|
LegislationCode|Sex|MaritalStatus
7|Page
MERGE|PersonLegislativeData|EMP|HDL001_LEG|2001/09/08|HDL001|
US|M|M
MERGE|PersonLegislativeData|EMP|HDL002_LEG|2005/02/08|HDL002|
US|F|S
In this example:
Work Relationship
The WorkRelationship component specifies the legal employer for your employee.
METADATA|WorkRelationship|SourceSystemOwner|SourceSystemId|
PersonId(SourceSystemId)|LegalEmployerName|DateStart|
WorkerType|PrimaryFlag
MERGE|WorkRelationship|EMP|HDL001_POS|HDL001|Vision
Corporation|2001/09/08|E|Y
MERGE|WorkRelationship|EMP|HDL002_POS|HDL002|Vision
Corporation|2005/02/08|E|Y
In this example:
8|Page
Employment Terms are no longer visible in Oracle HCM, but you still need to supply
a skeleton WorkTerms record to link the WorkRelationship and Assignment records.
METADATA|WorkTerms|SourceSystemOwner|SourceSystemId|
PeriodOfServiceId(SourceSystemId)|ActionCode|
EffectiveStartDate|EffectiveSequence|EffectiveLatestChange|
AssignmentName|AssignmentNumber|PrimaryWorkTermsFlag
MERGE|WorkTerms|EMP|HDL001_TRM|HDL001_POS|HIRE|2001/09/08|1|Y|
ET-HDL001|ET-HDL001|Y
MERGE|WorkTerms|EMP|HDL002_TRM|HDL002_POS|HIRE|2005/02/08|1|Y|
ET-HDL002|ET-HDL002|Y
In this example:
Each WorkTerms record is uniquely identified by a source key. For example, EMP,
HDL001_TRM.
The parent for the WorkTerms is the WorkRelationship, the parent record is
identified by the PeriodOfServiceId attribute. The SourceSystemId hint is added, so
you can supply the source key to identify the parent work relationship.
As the parent work relationship record and the local employment terms record both
use the same source system owner, both references use the same
SourceSystemOwner attribute.
The EffectiveStartDate value must match that on the WorkRelationship record.
6. Assignment
The Assignment record type is where you specify your employee's department,
location, position, job etc.
METADATA|Assignment|SourceSystemOwner|SourceSystemId|
ActionCode|EffectiveStartDate|EffectiveSequence|
EffectiveLatestChange|WorkTermsAssignmentId(SourceSystemId)|
AssignmentName|AssignmentNumber|AssignmentStatusTypeCode|
PersonTypeCode|BusinessUnitShortCode|PrimaryAssignmentFlag|
JobId(SourceSystemId)|JobId(SourceSystemOwner)
MERGE|Assignment|EMP|HDL001_ASG|HIRE|2001/09/08|1|Y|
HDL001_TRM|HDL001|HDL001|ACTIVE_PROCESS|Employee|Vision
Operations|Y|SCN|VISION
MERGE|Assignment|EMP|HDL002_ASG|HIRE|2005/02/08|1|Y|
HDL002_TRM|HDL002|HDL002|ACTIVE_PROCESS|Employee|Vision
Operations|Y|MGR|VISION
In this example:
9|Page
Each Assignment record is uniquely identified by a source key. For example, EMP,
HDL001_ASG.
The parent for the Assignment is the WorkTerms, the parent record is identified by
the WorkTermsAssignmentId attribute. Using the SourceSystemId hint, you can use
the source key to identify the parent WorkTerms record.
The Job is also referenced by its source key, but because it has a different source
system owner value, it can't use the value supplied to
the SourceSystemOwner attribute.
To specify a different source system owner for a foreign object reference, add
the SourceSystemOwner hint to the attribute that identifies the foreign object,
i.e., JobId(SourceSystemOwner).
The EffectiveStartDate value must match that on the WorkTerms record.
Next Steps
The following tutorials will further expand your HCM Data Loader knowledge:
Understanding HCM Data Loader (HDL) Business Objects
Loading Flexfield Segments, Images and Attachments with HCM Data Loader (HDL)
Make Date-Effective Changes with HCM Data Loader (HDL)
Related Links
Overview of HCM Data Loader
Overview of Loading Workers
Business Objects
Oracle HCM Cloud business objects can be complex and are usually hierarchical,
allowing for multiple child records to exist for a business object. Each component
within a business object hierarchy supplies multiple attributes, some of which are
references to other objects, some are lookup validated, most are optional, while
some will be required for new records and others are always required.
The View Business Objects task describes the hierarchical shape and provides
attribute information for every business object supported for bulk-data loading by
HCM Data Loader and HCM Spreadsheet Data Loader.
Objectives
10 | P a g e
In this tutorial, you will:
Review available objects, the actions they allow and the attributes they provide.
Generate METADATA template files.
Download business object overview spreadsheets.
Prerequisites
To complete this tutorial, you will need:
Refreshing the object shape also generates the template file and overview
spreadsheet for an object. The following tasks in this tutorial will explain what these
are and how to access them.
In this step, you will refresh an individual object, then refresh all objects in a specific
product area.
1. Select the Job business object record and click Refresh Object.
11 | P a g e
2. Click Submit on the Schedule Request page.
2. Use the choice list to select the Global HR - Work Structures product area.
12 | P a g e
Tip:Select All to refresh all supported business objects but this can take
several minutes with around 350 object hierarchies to refresh.
3. Click Submit.
4. Click View Process Results.
5. Find the entry for the Global HR - Work Structures product area.
13 | P a g e
Task 7: Downloading METADATA Template Files
When you supply data to be bulk-loaded using HCM Data Loader, your file must use
the name defined for the business object and must include METADATA lines for the
components and attributes you are supplying data for.
Instead of generating this manually, you can download a template file which includes
all METADATA lines for the business object hierarchy.
1. On the View Business Objects page, select the Job business object and click the file
download icon in the Template File column.
A file named for the business object will be downloaded, in this case Job.dat.
Task 8: Generating Object Hierarchy Overview Spreadsheets
The overview spreadsheet supplies the same information as the View Business
Objects user interface, but in a spreadsheet format. This can be useful for reviewing
the business object shape offline and allows you to search for attributes across
components.
1. On the View Business Objects page, select the Job business object and click the file
download icon in the Overview column.
Next Steps
The following tutorials will further expand your HCM Data Loader knowledge:
Create and Maintain Data with HCM Data Loader (HDL)
Create and Load New Hires with HCM Data Loader (HDL)
Make Date-Effective Changes with HCM Data Loader (HDL)
Loading Flexfield Segments, Images and Attachments with HCM Data Loader (HDL)
14 | P a g e
Task 4: Delete Future Date-Effective Splits
In this task you'll replace the last two date-effective splits with a new record.
1. Save your file naming it Job.dat and compress it to a zip file named 4
Replace DE Split in Job.zip.
2. Import and load your zip file. This will have the following impact on your job:
In summary:
15 | P a g e
Task 5: Upload a Historic Change Retaining Future Dated Values
In this step you'll insert a date-effective record without overwriting any values on
future dated-records.
Effective Start Effective End Name Job Family Standard Full Part Time
Date Date Code Working
Hours
In summary:
16 | P a g e
o Attributes not supplied with values in the file will inherit their values from the
record that previously existed on the 1-Jan-2015; the value of
the EffectiveStartDate attribute specified in the file.
1.The SET PURGE_FUTURE_CHANGES N instruction tells HDL to retain any future
date-effective splits that exist.
2.The #NULL value supplied to
the StandardWorkingHours and StandardWorkingFrequency attributes tells
HDL to remove the value for these attributes.
3.The #ALL value supplied to the EffectiveEndDate attribute tells HDL to roll
forward the attribute values on all future date-effective records that exist.
Task 10: Loading Multiple Changes Per Day
The employment terms and assignment records within the Worker object hierarchy
support multiple changes per day (MCPD). This allows you to track individual
updates made on the same effective start date.
Loading Flexfield Segments, Images and Attachments with HCM Data Loader (HDL)
Introduction
You can use HCM Data Loader (HDL) to bulk-load data into your descriptive and
extensible flexfield segments and to upload attachments and images for those HDL
objects that support it.
Objectives
17 | P a g e
Prerequisites
18 | P a g e