2
HCM Data Loader Business
Objects and File Formats
Copyright © 2016, Oracle and/or its affiliates. All rights reserved.
Lesson Objectives
After completing this lesson you should be able to:
• Describe the Oracle HCM Cloud business object shape
• Describe the business object hierarchy
• Describe the HCM Data Loader dat file format
• Understand how to create a basic dat file
• Understand how to generate HCM Data Loader template files
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-2
Understanding the Business Object Shape
• Hierarchical shape
• Made up of one or more business object components
Job
Job Valid Grade
Job Evaluation
Job Extra Information
Job Legislative Extra Information
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-3
Component Attributes: Keys
Component attributes hold data for the component, including:
• Unique key for the record
• For child components
– Unique key to the parent record
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-4
Component Attributes: Data
A set of attributes holds each component’s data:
– A
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-5
Business Object Hierarchy: Multiple Child Occurrences
You can supply multiple child occurrences for one parent:
Job
Job Valid Grade
Job Valid Grade
Job Valid Grade
Job Evaluation
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-6
Business Object Hierarchy: Date-Effective History
You can supply comprehensive date-effective history without
impacting other record types:
Attributes
Job Attributes
Attributes
Attributes
Job Valid Grade
Attributes
Job Valid Grade Attributes
Job Valid Grade Attributes
Job Evaluation Attributes
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-7
Business Object Hierarchy: Independent Child Records
You can supply child records independently:
Attributes
Job Attributes
Attributes
Attributes
Job Valid Grade
Attributes
Job Valid Grade Attributes
Job Valid Grade Attributes
Job Evaluation Attributes
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-8
HCM Data Loader Business Object Files
You supply one file for all components in the business object
hierarchy. The file is named after the business object that it
contains. For example, Job.dat could contain these components:
Job
Job Valid Grade
Job Evaluation
Job Extra Information
Job Legislative Extra
Information
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4-9
Business Object Dat File Format
COMMENT Create Accountant Job
METADATA|Job|EffectiveStartDate|SourceSystemOwner|SourceSyste
mId|Name|JobCode|ActiveStatus|SetCode
MERGE|Job|2010/01/01|EBS-UK|103|Accountant|ACC|A|COMMON
METADATA|JobGrade|EffectiveStartDate|SourceSystemOwner|Source
SystemId|JobId(SourceSystemId)|GradeCode|SetCode
MERGE|JobGrade|2010/01/01|EBS-UK|235|103|AC1|FIN
MERGE|JobGrade|2010/01/01|EBS-UK|238|103|AC2|FIN
MERGE|JobGrade|2010/01/01|EBS-UK|241|103|AC3|FIN
MERGE|JobGrade|2010/01/01|EBS-UK|233|103|AC4|FIN
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 10
Instruction Tags
Each line in the business object file must start with one of these
instructions:
Instruction Tag Description
SET Overrides default behavior
COMMENT Ignored (supplied for user information)
METADATA Defines components and attributes included in the file
MERGE Unique record identifier with values to be added to
Oracle HCM Cloud
DELETE Unique identifier for the record to be deleted
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 11
Instruction Tags: Examples
SET FILE_ESCAPE ,
COMMENT Job Maintenance File
METADATA|Job|JobCode|SetCode|EffectiveStartDate|EffectiveEndDate|ActiveStatu
s|Name
MERGE|Job|SE|COMMON|2000/01/01||A|Software Engineer
MERGE|Job|ACC|COMMON|2000/01/01||A|Accountant
DELETE|Job|AC1|COMMON||||
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 12
METADATA Instruction
• Each DAT file must have at least one METADATA line
• METADATA defines the components and attributes included
in the file
• Include a METADATA line only for the components you have
data for
• Specify only the attributes you are supplying values for
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 13
METADATA Instruction: Examples
METADATA|Job|FLEX:PER_JOBS_DFF|JobId|JobCode|JobFamilyId|ActiveStatus|FullPartTime|JobFunctionCode|ManagerLevel|MedicalCh
eckupRequired|RegularTemporary|BenchmarkJobFlag|BenchmarkJobId|ProgressionJobId|SetId|EffectiveStartDate|EffectiveEndDate
|Name|Language|ApprovalAuthority|SetCode|BenchmarkJobCode|ProgressionJobCode|JobFamilyName|ActionReasonCode|_JOB_LEVEL(PE
R_JOBS_DFF=US)|_CONTRACT(PER_JOBS_DFF=Global Data
Elements)|SourceSystemOwner|SourceSystemId|GUID|CategoryCode|SourceRefTableName=<source-table-name>|SourceRef001=<source-
column-001>|SourceRef002=<source-column-002>|SourceRef003=<source-column-003>|SourceRef004=<source-column-
004>|SourceRef005=<source-column-005>|SourceRef006=<source-column-006>|SourceRef007=<source-column-
007>|SourceRef008=<source-column-008>|SourceRef009=<source-column-009>|SourceRef010=<source-column-010>
METADATA|JobEvaluation|FLEX:PER_EVALUATION_CRITERIA_DFF|JobId|DateEvaluated|Knowhow|Accountability|EvaluationSystem|JobEv
aluationId|MeasuredIn|ProblemSolving|JobCode|SetCode|SourceSystemOwner|SourceSystemId|GUID|SourceRefTableName=<source-
table-name>|SourceRef001=<source-column-001>|SourceRef002=<source-column-002>|SourceRef003=<source-column-
003>|SourceRef004=<source-column-004>|SourceRef005=<source-column-005>|SourceRef006=<source-column-
006>|SourceRef007=<source-column-007>|SourceRef008=<source-column-008>|SourceRef009=<source-column-
009>|SourceRef010=<source-column-010>
METADATA|JobGrade|GradeId|JobId|EffectiveStartDate|EffectiveEndDate|Editable|ValidGradeId|GradeCode|SetCode|JobCode|Sourc
eSystemOwner|SourceSystemId|GUID|SourceRefTableName=<source-table-name>|SourceRef001=<source-column-
001>|SourceRef002=<source-column-002>|SourceRef003=<source-column-003>|SourceRef004=<source-column-
004>|SourceRef005=<source-column-005>|SourceRef006=<source-column-006>|SourceRef007=<source-column-
007>|SourceRef008=<source-column-008>|SourceRef009=<source-column-009>|SourceRef010=<source-column-010>
METADATA|JobExtraInfo|FLEX:PER_JOBS_EIT_EFF|EFF_CATEGORY_CODE|ActionOccurrenceId|EffectiveEndDate|EffectiveStartDate|Info
rmationType|JeiInformationCategory|JobExtraInfoId|JobId|LegislationCode|SequenceNumber|SourceSystemOwner|SourceSystemId|G
UID|JobCode|SetCode|SetId|SourceRefTableName=<source-table-name>|SourceRef001=<source-column-001>|SourceRef002=<source-
column-002>|SourceRef003=<source-column-003>|SourceRef004=<source-column-004>|SourceRef005=<source-column-
005>|SourceRef006=<source-column-006>|SourceRef007=<source-column-007>|SourceRef008=<source-column-
008>|SourceRef009=<source-column-009>|SourceRef010=<source-column-010>
METADATA|JobLegislative|FLEX:PER_JOBS_LEG_EFF|EFF_CATEGORY_CODE|JobId|JobLegId|EffectiveStartDate|EffectiveEndDate|Inform
ationCategory|LegislationCode|ActionOccurrenceId|SourceSystemOwner|SourceSystemId|GUID|JobCode|SetCode|SetId|SequenceNumb
er|SourceRefTableName=<source-table-name>|SourceRef001=<source-column-001>|SourceRef002=<source-column-
002>|SourceRef003=<source-column-003>|SourceRef004=<source-column-004>|SourceRef005=<source-column-
005>|SourceRef006=<source-column-006>|SourceRef007=<source-column-007>|SourceRef008=<source-column-
008>|SourceRef009=<source-column-009>|SourceRef010=<source-column-010>
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 14
MERGE Instruction
• Used to create, correct, or update data in Oracle HCM Cloud
• MERGE lines appear after the METADATA line for the
component
• Include the component discriminator after the MERGE
instruction
• Supply attribute values in the order you defined them in the
METADATA line
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 15
MERGE Instruction: Examples
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 16
DELETE Instruction
• DELETE lines appear after the METADATA line for the
component
• Include the component discriminator after the DELETE
instruction
• Supply attribute values in the order you defined them in the
METADATA line
• Do not attempt to MERGE and DELETE the same record in
the same file
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 17
DELETE Instruction: Examples
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 18
Component Discriminators
• Supplied directly after the following instructions:
– METADATA
– MERGE
– DELETE
• Determines which component of the hierarchy the line relates
to
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 19
COMMENT Instruction
• Can be supplied anywhere within the DAT file
• Provides user information
• Ignored by HCM Data Loader
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 20
SET Instruction
• Used to override default settings
• Must be placed at the top of the dat file
SET FILE_DELIMITER <new value>
SET FILE_ESCAPE <new value>
SET FILE_NEW_LINE <new value>
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 21
Generating Templates
• The Initiate Data Load page lists all supported business
objects
• Starting point to learning more about an object
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 22
Business Object Spreadsheets on My Oracle Support
• Document the attributes available for each component of the
object hierarchy
• Include
– Key Type
– Alternate User Key
– Data Type
– Length
– Primary Key
– Lookup Name
– Description
Continued...
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 23
Business-Object White Papers
Provide business-object-specific guidance for bulk loading:
• Considerations and prerequisites
• Loading guidelines
– Attribute descriptions
– UI screen shots
• Common errors
• Deletion support
• Loading translation data
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 24
File Lines, Logical Records, and Logical Objects
HCM Data Loader loads only valid objects:
• Related file lines are grouped into logical records
• Logical records are formed into logical objects
• Logical object = one occurrence of the object (for example,
the job Software Engineer)
Continued...
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 25
Demonstration
• 4-1 Generating Template Files
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 27
Practice
• 4-1: Generating Template Files
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 28
Quiz
Q
All business object components need a key that can be used to
locate the record, either to maintain it or to reference it from
another object.
a. True
b. False
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 29
Quiz
Q
HCM Data Loader does not allow you to supply data for child
components independently.
a. True
b. False
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 30
Quiz
Q
You can supply DELETE and MERGE instructions in the same
file, but you cannot MERGE and DELETE the same record in the
same file.
a. True
b. False
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 31
Lesson Summary
In this lesson you should have learnt about:
• Oracle HCM Cloud business object shape
• HCM Data Loader business object hierarchy
• HCM Data Loader dat file format
• How to create basic dat files
• How to generate HCM Data Loader business object template
files
Copyright © 2016, Oracle and/or its affiliates. All rights reserved. 4 - 32
