hcm data loader users guide r10

8/19/2019 HCM Data Loader Users Guide R10

1/71

HCM Data Loader User’s Guide

Oracle Fusion Human Capital Management 11g Release 10 (11.1.10)

O R A C L E W H I T E P A P E R | F E B R U A R Y 2 0 1 6


2/71

HCM DATA LOADER USER’S GUIDE

Table of Contents

Introduction 1

HCM Data Loader Data Flow 2

Who Can Load Data Using HCM Data Loader? 3

Supported Key Types 3

Object References 5

Key Resolution Sequence 5

Oracle Fusion Business-Object Structure 6

Terminology 6

Zip File Structure 7 Dat File Structure 7

File Line Instruction Tags 8

File Discriminators 8

Line Structure 9

Line Ordering 9

Metadata Line Validation 10

Data Line Validation 10

Preparing the Source Data 10

Reviewing and Cleansing the Source Data 10

Defining Referenced Oracle Fusion HCM Objects 10

Reviewing Lists of Values (LOVs) 11

Preparing the Oracle Fusion Human Capital Management Environment 12

Specifying the HCM Data Loader Scope 12

Defining Your Source Owner 14

Reviewing Enterprise Settings 14

Objects in Multiple Languages 14

Review HCM Data Loader Configuration Parameters 15

Supported Business Objects 15

Reviewing Business Objects 15

Supplied Business-Object Documentation 16

Generating and Modifying Template Files 17


3/71


Extracting Data into the HCM Data Loader File Format 19

Developing an Extract for Each Business Object 19

Retaining Current Values 20

Setting Not Null Attribute Values to Null 20

Lookup Validated Attributes 20

Number Attributes 20

Date and Time Attributes 20

CLOB and BLOB Attributes 20

Supplying Key Values 21

Date Effective and MCPD Components 24

Reserved Characters 29

Flexfields 29

Source-System References 33

Maintaining Existing Date-Effective Data 34

Date-Effective Maintenance Modes 35

Retaining Existing Date-Effective Records 35

Replace Future Dated Records 39

Updating the First Effective Start Date or Last Effective End Date 39

Translation Data 41

Translation-File Discriminators 42

Updating Translation Data 42

Deleting Data from Oracle Fusion 42

Importing and Loading Data 43

Using the HCM Data Loader Interface for File Submission 43

Monitoring Progress 47

Import and Load Data User Interface 47

Extracting Data 55

Status and Errors 55

Compensation Changes 55

Required Post Processes 55

Maintaining Stage Table Data 56


4/71


Deleting a Single Data Set 56

Deleting Multiple Data Sets 57

Best Practices 59

File Shape 59

Data Migration 59

Ongoing Interfaces 59

Additional Help 60

HCM Data Loader Data Set Status Diagnostic 60

Glossary 64


5/71


Table of Figures

Figure 1: User Key: Create Department - The User Key is the Organization Name ......... ........ ......... ........ ......... ....... 3 Figure 2: Example of an HCM Data Loader Zip File ................................................................................................. 7

Figure 3: Example of the BlobFiles Folder Content .................................................................................................. 7 Figure 4: METADATA and Data Line Structure ........................................................................................................ 9 Figure 5: SET Line Structure .................................................................................................................................... 9 Figure 6: COMMENT Line Structure ......................................................................................................................... 9 Figure 7: Manage Lookups (Navigator - Setup and Maintenance) .......................................................................... 12 Figure 8: Initiate Data Load (Navigator - Data Exchange - Initiate Data Load)........................................................ 16 Figure 9: Initiate Data Load Page (Navigator - Data Exchange - Initiate Data Load) ................ ......... ........ ......... ... 18 Figure 10: Generate HCM Data Loader Templates Submission Page ......... ........ ......... ......... ........ ......... ......... ...... 18 Figure 11: Review Template Files (Navigator - Data Exchange - Initiate Data Load - Processes) ........ ......... ......... 19 Figure 12: Loading Attachments - Supplying References to Attachment Files ........ ......... ........ ......... ........ ......... ..... 21 Figure 13: BloblFiles Folder to Deliver Attachment Files for Documents of Record ................................................ 21 Figure 14: Supplying a Source Key for the Local Record ....................................................................................... 22 Figure 15: Supplying a Source Key for a Foreign Object ........................................................................................ 22 Figure 16: Supplying the User Key for the Local Record ........................................................................................ 23 Figure 17: Supplying the User Key for a Foreign Object ......................................................................................... 23

Figure 18: Supplying the Oracle Fusion Surrogate ID for the Local Record ......... ......... ........ ......... ......... ........ ........ 23 Figure 19: Supplying the Oracle Fusion Surrogate ID for a Foreign Object ............................................................ 24 Figure 20: Supplying the Oracle Fusion GUID for the Local Record ....................................................................... 24 Figure 21: Supplying the Oracle Fusion GUID for a Foreign Object ....................................................................... 24 Figure 22: Overwriting Reserved Characters with the SET Command ................................................................... 29 Figure 23: Descriptive Flexfield Code Format ......................................................................................................... 30 Figure 24: Descriptive Flexfield Attribute Name Format ......... ........ ......... ......... ........ ......... ......... ........ ......... ......... ... 30 Figure 25: Descriptive Flexfield METADATA Example ........................................................................................... 31 Figure 26: Extensible Flexfield METADATA Example............................................................................................. 31 Figure 27: Defining DFF Attributes in METADATA ................................................................................................. 32 Figure 28: Supplying Descriptive Flexfield Data ..................................................................................................... 32 Figure 29: Supplying Descriptive Flexfield Data for Multiple Flexfield Codes ........ ......... ......... ........ ......... ......... ...... 32 Figure 30: Defining EFF Attributes in METADATA ................................................................................................. 33 Figure 31: Supplying Descriptive Flexfield Data ..................................................................................................... 33 Figure 32: Specifying a Source System Reference Table Name ............................................................................ 34 Figure 33: Setting the Update Mode for Future-Dated Records ........ ......... ........ ......... ......... ......... ........ ......... ......... 35 Figure 34: SET Command to Retain Existing Date-Effective Records .................................................................... 35 Figure 35: SET Command to Replace Future-Dated Changes ............................................................................... 39 Figure 36: Import and Load Data - Import Local File............................................................................................... 44 Figure 37: Select local file ...................................................................................................................................... 44 Figure 38: Submit Import and Load HCM Data File ................................................................................................ 44 Figure 39: Import and Load Data - Import File ........................................................................................................ 46 Figure 40: Available WebCenter Content Files ....................................................................................................... 46 Figure 41: Submit Load for an Individual Business Object ......... ......... ........ ......... ......... ........ ......... ......... ........ ........ 47 Figure 42: Submit the Load Business Object ESS job ............................................................................................ 47 Figure 43: Import and Load Data Progress Icons ................................................................................................... 48 Figure 44: Import and Load Data Counts ................................................................................................................ 48 Figure 45: Error Management File Structure........................................................................................................... 49 Figure 46: Error Management Physical Row .......................................................................................................... 49 Figure 47: Error Management Attribute Values ........ ......... ......... ........ ......... ......... ......... ........ ......... ......... ......... ....... 50 Figure 48: Error Management Source System References .................................................................................... 50

Figure 49: Correcting Attribute Values .................................................................................................................... 51 Figure 50: Correcting the Date Value for an Attribute ............................................................................................. 52 Figure 51: Corrected Objects Count ....................................................................................................................... 52 Figure 52: Corrected Records and Attributes.......................................................................................................... 53 Figure 53: Stopping a Data Set .............................................................................................................................. 53 Figure 54: Stopping a Business Object ................................................................................................................... 54 Figure 55: Confirming Stop ..................................................................................................................................... 54 Figure 56: Deleting an Individual Data Set ............................................................................................................. 57 Figure 57: Delete Stage Table Data ....................................................................................................................... 58 Figure 58: Schedule Delete HCM Data Loader Stage Table Data .......................................................................... 58 Figure 59: Diagnostic Dashboard (Settings and Actions - Troubleshooting - Run Diagnostic Tests) ...................... 61 Figure 60: Searching for the HCM Data Loader Data-Set Status Diagnostic Test .................................................. 62


6/71


Figure 61: Selecting the HCM Data Loader Data-Set Status Diagnostic Test ......... ......... ........ ......... ........ ......... ..... 62 Figure 62: Supply or Edit Input Parameters ............................................................................................................ 62 Figure 63: Enter the Parameter Values .................................................................................................................. 63 Figure 64: Submitting the HCM Data Loader Data-Set Summary ........................................................................... 63

Figure 65: Reviewing the HCM Data Loader Data-Set Summary Test Run Status ................................................. 63


7/71

1 | ENTER TITLE OF DOCUMENT HERE

Introduction

HCM Data Loader is a powerful tool for bulk-loading data from any source to Oracle Fusion HumanCapital Management (Oracle Fusion HCM).

HCM Data Loader:

Supports important business objects belonging to key Oracle Fusion HCM products, including

Oracle Fusion Global Human Resources, Compensation, Absence Management, Performance

Management, Profile Management, Global Payroll, Talent and Workforce Management.

Is available in cloud, on-premises, and on-demand environments.

Supports one-time data migration, maintenance of Oracle Fusion HCM data via upload, and

coexistence scenarios, where core HR data exists outside Oracle Fusion.

Provides a comprehensive user interface for initiating data upload, monitoring progress, and

reviewing errors, with real-time information provided for both the import and load stages of its

processing.

Supports multithreaded processing, which enables you to upload complete system extracts without

severe performance impacts. HCM Data Loader manages references among objects that are

processed on separate threads.

Includes a delimited-file reader that can identify file contents from metadata included in the file that

you upload. This feature enables you to perform partial or incremental loads, thereby minimizing

the related processing.

Supports user keys for all objects. Knowledge of Oracle Fusion internal IDs is not required.

Enables bulk update of objects, regardless of whether they were created using HCM Data Loader.

Loads all data files from the Oracle WebCenter Content server, which provides a single point of

entry to Oracle Fusion HCM.

Can be initiated using a web service call, which enables you to automate data upload.

Is function-rich. For example, you can upload:

o Current and historical records for date-effective objects. You determine the amount of

history to load.

o End-dated, terminated, or inactive records.

o Translated attributes in multiple languages. You can specify the character set of the data

file by naming any Java supported character set on the File Character Set configuration

parameter.

o Descriptive flexfields and extensible flexfields.

o Hierarchical tree data, such as Organization and Department Trees.

o Attachments and pictures.

o Data from multiple sources. You can include source-system references in uploaded data.


8/71

2 | HCM DATA LOADER USER’S GUIDE

HCM Data Loader Data Flow

This figure summarizes the process of loading data using HCM Data Loader.

1. You place a zip file containing your data on the WebCenter Content server.

2. You submit a request to HCM Data Loader to import and load the zip file of data. For this step, you can

use either the HCM Data Loader interface or the HcmCommonDataLoader web service.

3. HCM Data Loader decompresses the zip file and imports individual data lines to its stage tables, grouping

those distinct file lines into Oracle Fusion HCM business objects.4. It calls the relevant logical object interface method (delivered in product services) to load objects to the

Oracle Fusion application tables.

5. Any errors that occur during the import or load phase are reported in the HCM Data Loader interface.

6. Having reviewed import and load errors in the HCM Data Loader interface or via the Data Set Summary

extract, you correct them in your source data. You load a new zip file containing the corrected data to the

WebCenter Content server.

You repeat this process until all of the data is successfully loaded.


9/71


Who Can Load Data Using HCM Data Loader?

To load data using HCM Data Loader, you must have the Human Capital Management Integration Specialist jobrole.

Supported Key Types

A common problem when integrating data from one system to another is how to identify a record uniquely both when

creating it in a new system and for continuing updates.

HCM Data Loader resolves this by supporting four different key types for all types of object reference:

User Key

Oracle Fusion Surrogate ID

Source Keys

Oracle Fusion GUID (Globally Unique Identifier)

User Key

HCM business objects are published with one or more attributes defined as a user, or natural, key. The user key is

always visible on the user interface and can be used to identify a business object occurrence uniquely. For example,

the user key for organization is the organization name.

Figure 1: User Key: Create Department - The User Key is the Organization Name

This key solution is suitable for both the initial creation and later update of a logical object.

User keys are part of the business object definition and are always mandatory when creating a logical object,

regardless of how you create it.

You must take care when using user keys to reference a logical object to update. The user key value can change

over time and some user key attributes are translatable. In addit ion, not al l records s upp ort update if only us er

keys are suppl ied. You are recomm ended to use sourc e keys wherever possible.


10/71


User Keys for Child Objects

When a business object is bound by another, the user key will also need to include the user key for its parent. For

example, jobs are always part of a set, so JobCode alone would not uniquely identify a job; the SetCode must be

part of the user key for Job. Job grades are for a specific job, so the user key for a job grade would include the user

key for the parent job too; for example GradeCode, JobCode, or SetCode.

The user key is recommended when referencing or maintaining an Oracle Fusion HCM record that was not created

with a source key or where the source key value is unknown.

Oracle Fusion Surrogate ID

The Oracle Fusion surrogate ID is the Oracle Fusion internal system identifier, generated by Oracle Fusion on the

initial creation of the component data in the database. As it is not generated until the data is committed to thedatabase, this value is not available to uniquely identify a record for creation. Oracle Fusion Cloud customers are

unlikely to have access to the Oracle Fusion surrogate ID, so its use is primarily by on-premise customers.

Source Keys

Integration-enabled business objects can be referenced by the internal ID from your source system. This key

solution is suitable for the initial creation and subsequent update of a business object occurrence. This solution

requires two values to be supplied, the SourceSystemOwner and SourceSystemId. The SourceSystemOwner

specifies the system where the data originated. The SourceSystemId specifies the ID from that source system and

must be unique for the business object component and SourceSystemOwner value.

If you do not have a genuine source system ID to reference your record uniquely, then you can generate or derive

one. For example, you could derive a source system ID for a Person Address using the person number

concatenated with the address type. If you are supplying date-effective history for a record, then the source system

IDs must be supplied for every date-effective record in the file. The values would be identical for each line of the

date-effective history.

If you supply a SourceSystemOwner, then multiple source systems can provide data for the same business objects.

For example, you have Person data on both US and UK databases and these are to be combined into one Oracle

Fusion system. If you provide the SourceSystemOwner, then the SourceSystemID does not need to be unique

across both source systems. It needs to be unique only in its originating database.

Source keys are supported only for integration-enabled business objects. Source keys are not held against the

created record, but in an Integration Key Map table.

You can supply a source key only to uniquely identify new and existing records using HCM Data Loader.

If you do not provide a source key when creating a new object it will be defaulted for you. The SourceSystemOwner

will have a value of FUSION and the SourceSystemId will use the surrogate ID value. You cannot change the

source key once a record has been created.

The SourceSystemOwner value is validated against the HRC_SOURCE_SYSTEM_OWNER lookup. You must add

your source system name to this lookup prior to loading data using source system references


11/71


The source key is the recommended key type to use for all implementations. If you supply a source key when you

create your data in Oracle Fusion, then you can continue to reference your Oracle Fusion data using source systemidentifiers when maintaining or referencing that data.

Oracle Fusion GUID

When an integration-enabled business object is created in Oracle Fusion, an Oracle Fusion GUID (globally unique

identifier) is generated. As the GUID is generated on creation of a business object, it is suitable only for identifying

business objects that already exist. It is not available for the initial creation of a business object occurrence. The

GUID is not held against the created record, but in an Integration Key Map table. The GUID is useful for reporting

changes from downstream systems, such as a third-party payroll provider. You extract the changes for the third-

party payroll, providing the GUID as the unique reference to the worker. If you need to report the changes back to

Oracle Fusion HCM, you can provide the GUID to identify the records to update.

Object References

In HCM Data Loader the four key types can be used to identify:

The row being changed.

The parent of the row being changed. The parent could be supplied in the same file of data to be loaded, or it

may already exist in Oracle Fusion.

Any objects referenced by the row being changed.

Note: Oracle Fusion GUIDs and Oracle Fusion surrogate IDs are not generated until the record has been

successfully created in Oracle. Source keys are not recognized in Oracle until the record using them has been

successfully created in Oracle. For these reasons, you need to be careful when referencing foreign objects to

ensure the foreign object already exists in Oracle Fusion HCM, prior to attempting to import your data into HCM

Data Loader. For a new Oracle Fusion HCM implementation, the simplest way to achieve that is to load each

business object in a separate zip file and ensure that each zip file has loaded successfully before importing the next.

If you decide to supply all business objects in the same zip file, then HCM Data Loader loads the business objects in

order of potential dependency. In this case, a foreign object reference fails only if the referenced object failed to load

due to an error.

Key Resolution Sequence

Key references are resolved in the following order:

Oracle Fusion GUID

Oracle Fusion surrogate ID

Source key

User key


12/71


Oracle Fusion Business-Object Structure

Many Oracle Fusion HCM business objects comprise a hierarchy of business-object components. At the top of the

hierarchy is the parent component, and beneath it are child (and, sometimes, grandchild) components. Each

business-object component is made up of multiple attributes:

For example, the rating model business-object comprises rating model, rating level, and rating categorycomponents. The rating model component is the parent of the other two components. Each of these components is

made up of attributes such as rating model name, rating model code, rating level code, and so on.

The most complex business object supported by HCM Data Loader is the worker object, where 5 levels exist in the

object hierarchy. These range from the worker component at the top to assignment work measure, assignment

manager, assignment grade steps, and assignment extra information at level 5. By contrast, the person type object

comprises only the person type component.

When different components for the same business object are delivered together, HCM Data Loader groups them

into logical objects and loads the complete logical object in its entirety. It does not process the individual

components separately. If any part of the logical object fails validation, then the whole logical object is rejected. As

only complete logical objects are loaded, you can be sure of exactly what data has been loaded. For example, the

Accountant job loaded successfully, but the Accounts Clerk job failed.

Terminology

In this User’s Guide, the term object or business object always refers to the complete object (the parent component

and all child components). For example, grade and worker are business objects. The terms component or business-

object component refer to individual components of a business object. For example, person name and work

relationship are business-object components. The term logical object refers to a group of related components that

form one occurrence of a business object. For example, the grade IC1 is a logical object.


13/71


Zip File Structure

HCM Data Loader accepts compressed zip files that have been uploaded to the WebCenter Content server. These

compressed zip files can be encrypted as a whole, but HCM Data Loader does not support the encryption of files

within the compressed zip file.

The zip file can contain one or more business object specific dat files. Each dat file corresponds to a single business

object, such as location, grade, worker, or salary. Dat files should not be placed within folders in the zip file, and

each dat file must have the name of an HCM Data Loader supported business object.

You supply dat files only for the business objects you are updating.

Figure 2: Example of an HCM Data Loader Zip File

You can define the name of the zip file, which must be in alphanumeric characters (a-z and 0-9). Both upper and

lowercase letters are acceptable.

The only folder names that can be included in the zip file are:

BlobFiles

ClobFiles

You place files to be loaded as attachments or into large objects within these folders. You must ensure that the file

names of these attachments or images are in alphanumeric characters. The data type of the attribute that is used to

load your attachment or large object data determines which folder to use. For example, the File attribute in

Documents of Record (DOR) is used for loading attachment files. It has a data type of BLOB; therefore, files to be

loaded as DOR attachments must be placed in the BlobFiles folder.

Figure 3: Example of the BlobFiles Folder Content

Dat File Structure

HCM Data Loader dat files are business object specific. All components for a business object hierarchy are provided

in the same dat file. For example, job, job valid grade, job evaluation, job extra information, and job legislative extra

information can all be provided in Job.dat.


14/71


This single business object file approach makes it easier to see all the data for a business object and its

components, and aids with the validation of parent references on all child components. It also simplifies the

construction of the zip file as separate directories are not required and there are fewer files to generate.

File Line Instruction Tags

Dat file flexibility is achieved with the use of instruction tags:

Tag Line Type Description

METADATA Definition Identifies the business-object component and its attributes for which values are included in the

data file.

MERGE Data Provides data to be added to Oracle Fusion. You use the MERGE instruction whether creating

or updating objects. Oracle Fusion identifies the appropriate action. The MERGE instruction

accepts complete or partial objects. The data supplied with the MERGE instruction is merged

into the existing Oracle Fusion data.

Note: HCM Data Loader cannot accept multiple MERGE lines for the same record in the same

dat file if that object is not date-effective. For example, you cannot create a Person Ethnicity

record and then correct it from the same file. As the object is not date-effective, you are

attempting to correct the created data, not update it. In such a situation, you can supply only the

current data. Alternatively, you can insert a record in one file and update the record in a second

file.

HCM Data Loader does not process individual file lines but groups related lines. This grouping

works for date-effective records because the file lines are processed in effective start date order.

DELETE Data Identifies business-object components to be purged from Oracle Fusion HCM. You cannot

delete individual date-effective records. DELETE supports only the removal of the entire record.

Note: Do not provide a DELETE instruction along with a MERGE instruction for the same

record. HCM Data Loader cannot guarantee the order in which the two instructions will be

processed, so you could either delete and create the record, or update and delete the record.

Caution: Deleted data cannot be recovered. It is recommended that you try to correct your data

rather than delete and recreate it.

SET Control Enables override of the default behavior for the file.

COMMENT Comment Adds a comment to the data file. The comment has no effect on processing.

File Discriminators

File discriminators are used to uniquely identify the business object component you wish to update. For example,

the available file discriminators for the Job business object are:

Component Name File Discriminator

Job Job

Job Valid Grade JobGrade

Job Evaluation JobEvaluation

Job Extra Information JobExtraInfo

Job Legislative Extra Information JobLegislative


15/71


Line Structure

METADATA, MERGE and DELETE line structure

The shape of each METADATA and data line will be primarily derived by the shape of the view object supporting the

business object component. METADATA, MERGE, and DELETE data lines must have the following structure:

||||. . .|

Figure 4: METADATA and Data Line Structure

For example:

METADATA|Job|SetCode|JobCode|JobFamilyName|JobName|EffectiveStartDate|EffectiveEndDate

SET line structure

SET lines have the following structure:

SET

Figure 5: SET Line Structure

For example:

SET FILE_DELIMITER ,

COMMENT line structure

COMMENT lines have the following structure:

COMMENT

Figure 6: COMMENT Line Structure

Line Ordering

METADATA lines define which attributes are supplied in the file for a business object component. Therefore, the

definition of a component must appear before any data for that component. You can include multiple METADATA

lines in the same business object file. However, each METADATA line must be for a different discriminator of the

owning business object hierarchy.

SET lines can override how the file is read by default; therefore, they must be supplied before any METADATA lines.There are no other restrictions for line ordering in the file.

The order of the data lines in the file does not impact the order in which they are processed.

You should not supply DELETE and MERGE lines for the same logical object. There is no guarantee that the object

will first be deleted and then created, or updated and then deleted. Similarly, you must not provide multiple MERGE

lines for the same object. Provide only the latest data, unless the component supports date-effectivity, in which case

you can provide date-effective history for a logical object.


16/71


Metadata Line Validation

Each METADATA line must:

Reference a valid discriminator for the object specified by the dat file name.

Reference a unique discriminator for the object. You cannot supply multiple METADATA lines for the same

discriminator.

List only valid attributes for that discriminator. Attribute names are case sensitive.

Specify the attributes for at least one of the supported key mechanisms to uniquely reference the component

defined by the discriminator.

Data Line Validation

Each data line must:

Be preceded by the METADATA line for the same discriminator.

Contain the same number of attributes as the relevant METADATA line and in the same order.

Not include values for attributes that do not appear in the METADATA line.

Contain a unique reference for itself, using any one of the supported key types.

Each data line for a child component must include a unique reference to its parent. For example,

GradeRateValue must include a unique reference to its GradeRate: .

You can provide MERGE and DELETE instructions in the same file, but not for the same record. For example,

when loading jobs, you cannot provide MERGE and DELETE instructions for the same job.

Preparing the Source Data

This section identifies some tasks to perform before you begin mapping your data to the Oracle Fusion HCM object

model.

Reviewing and Cleansing the Source Data

Identify the business objects that you are planning to upload to Oracle Fusion HCM and their source systems.

Review this source data, and verify that it is both accurate and current. If it is not, then correct any problems before

you attempt to extract it. For example:

Ensure that a manager is identified for every worker and that the information is accurate.

For jobs and positions, ensure that correct job codes and titles exist in the source systems.

For worker history, establish the accuracy of any historical data. Understand whether all historical data must be

uploaded or just key events, such as hire, promotion, and termination.

Preparing the source data in this way will minimize the problems that can occur when you upload data to Oracle

Fusion HCM. It will also make it less likely that you copy any inaccuracies to the new environment.

Defining Referenced Oracle Fusion HCM Objects

Business objects that originate in your source environment may reference a small number of business objects that

cannot be loaded using HCM Data Loader. Some of these objects are predefined. Others need to be defined or

updated in the target Oracle Fusion HCM environment before you load data that references them.

You may have performed this step during implementation of Oracle Fusion HCM.


17/71


The following table identifies the main objects of this type and the Oracle Fusion HCM tasks that you use to review

or create them.

Business Object Oracle Fusion HCM Task

Schedule Manage Work Schedules

Official Language Code Manage Languages

Currency Code Manage Currencies

Business Unit Manage Business Unit

Legal Entity Manage Legal Entity

Content Type Manage Profile Content Types

Profile Type Manage Profile Types

Assignment Status Type Manage Assignment Status

Element Type Manage Elements

Application Reference Data Set Manage Reference Data Sets

When referring to these objects in the objects that you are loading, you use their user keys. (Alternatively, you can

use their surrogate IDs, if available.)

HCM Data Loader provides business-object documentation for all supported objects. This documentation specifies

the user key that you can use to reference other objects. For example, the position component includes a reference

to the business unit object, which is not integration enabled. The position documentation identifies the business unit

name as its user key. Therefore, when loading a position component you can refer to the associated business unit

using the business unit name. (For more information about keys, see page 3.)

Reviewing Lists of Values (LOVs)

The permitted values of many object attributes are defined in Oracle Fusion HCM in LOVs. Some LOVs are

predefined and cannot be updated in any way. Others contain some values but you can also add your own. And in

some cases, you can edit or remove predefined values.

In Oracle Fusion HCM, LOVs are defined as lookups. You are recommended to review the predefined lookups and

make any updates before you attempt to load data that uses them. You may have completed this process during

implementation of Oracle Fusion HCM.

Relevant lookups are identified in the business-object documentation for HCM Data Loader supported objects.

To manage lookups, search for relevant tasks by entering Manage % Lookups in the Setup and Maintenance work

area. All available lookups tasks are listed. For example, to manage person lookups, select the Manage Person

Lookups task. On the Manage Person Lookups page, select a lookup to edit:


18/71


Figure 7: Manage Lookups (Navigator - Setup and Maintenance)

Ensuring that lookups contain appropriate values will reduce validation errors when you load data.

Preparing the Oracle Fusion Human Capital Management Environment

Specifying the HCM Data Loader Scope

HCM Data Loader cannot be used in parallel with HCM File-Based Loader or HCM Spreadsheet Data Loader for

maintaining the same business objects. The HCM Data Loader Scope parameter on the Configure HCM Data

Loader page controls whether HCM Data Loader is used for all bulk data loading or just for those objects that are

not supported by HCM File-Based Loader. The HCM Data Loader Scope parameter has two settings:

Settings Description

Limited Only business objects not supported by HCM File-Based Loader can be loaded using HCM Data

Loader.

Full HCM Data Loader is used for bulk loading data into all supported business objects. HCM File Based

Loader and HCM Spreadsheet Data Loader are disabled.

For upgrading customers, the default value of this parameter is Limited. If you attempt to load data for a business

object that is not supported in the Limited mode, then your whole data set will fail to process.

For new customers in Release 10, the default value of this parameter is Full and it cannot be changed to Limited.

Upgrading customers who do not intend to use HCM File-Based Loader or HCM Spreadsheet Data Loader must set

this parameter to Full to ensure complete business object support when using HCM Data Loader.

To update the HCM Data Loader Scope parameter:

1. Open the Configure HCM Data Loader page (Setup and Maintenance - Configure HCM Data Loader).

2. For the HCM Data Loader Scope parameter, select Full.


19/71


Impor tant : The HCM Data Loader Scope parameter cannot be set back to Limited once it has been set to Ful l .

Once this parameter is set to Ful l , HCM File-Based Loader and HCM Spreadsheet Data Loader no longer function.

Restricted Objects

The HCM Data Loader registered objects that cannot be loaded using HCM Data Loader when the HCM Data

Loader Scope parameter is set to Limited are:

Global HR Action Reasons

Action Reasons Translation

Actions

Actions Translation

Location

Location Translation

Job Family

Job Family Translation

Grade

Grade Translation

Grade Step Translation

Grade Ladder

Grade Ladder Translation

Step Rate Translation

Grade Rate

Grade Rate Translation

Job

Job Translation

Organization

Organization Translation

Position

Position Translation

Department Tree

Department Tree Node

Person Contact

Person Contact Relationship

Worker

Global Payroll Element Entry

Compensation Salary Basis Salary

Absences Person Absence Entry Person Entitlement Detail

Talent Education Establishment

Education Establishment Translation

Rating Model

Rating Model Translation

Rating Category Translation

Rating Level Translation

Content Item

Content Item Translation

Content Item Rating Description Translation

Content Items Relationship

Talent Profile

Talent Profile Translation

Restricted Business Object SpreadsheetsYou cannot upload the following business object spreadsheets available from the HCM Spreadsheet Data Loader

task in the Data Exchange work area when the HCM Data Loader Scope parameter is set to Full. However, you

can still use specialized data loaders such as Payroll Batch Loader, Compensation and Benefits Data Loaders,

Talent Data Loaders, and Core HR Data Loaders.

Global HR Create Location

Create Grade Ladder (Grades)

Create Grade Ladder (Grades with

Steps)

Create Grade

Create HR Job Family

Create HR Job

Create Department

Create Position

Create Worker

Create Work Relationship and Assignment

Update Person

Update Assignment

Compensation Create Market Data: Survey

Create Market Data: Jobs

Create Market Data: Job Function

Create Market Data: Job Family

Create Market Data: Career Stream

Create Market Data: Career Level

Create Market Data: Other Level

Absences Create Absence Record

Create Absence Reasons

Create Absence Certifications

Create Absence Plans

Create Absence Types

Create Absence Categories

Talent Create Educational Establishments

Create Talent Profile Content Item

Create Talent Profile

Create Talent Profile Content Type

Create Talent Profile Rating Model

Create Section Definition

Create Template Definition

Create Template Section

Create Template Period


20/71


Defining Your Source Owner

If you plan to use source-system IDs, then you must add your source-system owner values to the

HRC_SOURCE_SYSTEM_OWNER lookup before you load data.

To edit this lookup:

1. In the Setup and Maintenance work area, search for the Manage Common Lookups task.

2. In the Search Results section, click Go to Task for the Manage Common Lookups task.

3. On the Manage Common Lookups page, search for the lookup type value

HRC_SOURCE_SYSTEM_OWNER.

4. In the Search Results, select the lookup type to display its lookup codes.

5. In the Lookup Codes section of the page, click New ( ) to add a lookup-code row. Complete the fields

in the row. Ensure that the new code is enabled and that the start and end dates are valid for the data that

you are loading.

6. Repeat Step 5 for additional source-system owner values.7. Click Save and Close.

Reviewing Enterprise Settings

When you load worker records, by default:

A user-account request is created automatically for each worker. (The request is sent to Oracle Identity

Management when you run the Send Pending LDAP Requests process, as described on page 55.) User

names are in the format specified by Oracle Identity Management.

Roles are provisioned automatically to workers, as specified by current role-provisioning rules.

Workers are notified automatically of their sign-in details.

You are recommended to review the enterprise settings that control user provisioning and make any updates beforeyou load worker records. For example, you may want to prevent the automatic creation of user-account requests

during initial data loads to the stage environment.

To review the enterprise user-provisioning settings:

1. Open the Manage Enterprise HCM Information page (Navigator - Setup and Maintenance - Manage

Enterprise HCM Information).

2. In the section User and Role Provisioning Information, review current settings and make any updates.

3. Click Submit.

Any changes that you make to the User and Role Provisioning settings apply to the enterprise, regardless of how

person records are created.

Objects in Multiple Languages

If you are using an on-premise version of Oracle Fusion HCM, then to enable support for multiple languages you

install the appropriate language packs during setup. For example, if you want to store translatable values in both

Spanish and German, then you must install the language pack for those languages during enterprise setup. (For

more information about this, see the Oracle Fusion Applications Installation Guide.) For cloud implementations,

requested language packs may be installed before the environment is delivered. Alternatively, you can request

language packs by raising a service request (SR).


21/71


Review HCM Data Loader Configuration Parameters

The HCM Data Loader configuration parameters control the HCM Data Loader import and load processes. The

default settings of the parameters suit most requirements and do not need to be changed. You can review the

delivered settings by performing the task Configure HCM Data Loader (Navigator - Setup and Maintenance -

Configure HCM Data Loader ).

The configuration parameters are:

Parameter Default Description

Delete Source File Yes Delete the source file from the WebCenter Content server when processed.

File Action Import and

Load

Default file-processing action.

File Character Set UTF-8 Character set for business object and attachment files. You can update this to any

Java supported character set.

File Encryption None Default file encryption.

Import Cache Clear Limit 2400 Number of file lines to be processed before the cache is cleared.

Import Commit size 100 Number of file lines to import between each commit.

Maximum Percentage of Import Errors 100 Percentage of file lines in error that can occur in a business object before the

import process stops for the object.

Maximum Percentage of Load Errors 100 Percentage of business-object instances in error that can occur for a business

object before the load process stops.

Data Error Stack Trace Occurrences

by Thread

2 Maximum number of data error message occurrences on a processing thread for

which stack trace is recorded.

Complex Error Stack Trace

Occurrences by Thread

5 Maximum number of complex error message occurrences on a processing thread

for which stack trace is recorded.

Load Cache Clear Limit 500 Number of business-object instances to be loaded from the stage tables before

the cache is cleared.

Maximum Concurrent Threads for

Load

8 Maximum number of threads to run concurrently when loading data from the stage

tables to the application tables.

Load Group size 100 Number of business objects processed as a single unit of work by a single thread.

Supported Business Objects

Reviewing Business Objects

The Initiate Data Load page provides a list of HCM Data Loader registered business objects. These are displayed in

the order in which it is recommended that you load them, if performing data migration.


22/71


Figure 8: Initiate Data Load (Navigator - Data Exchange - Initiate Data Load)

From this page you can generate business object templates that provide METADATA lines for all components of the

business object hierarchy. These are useful for identifying the attribute name to use for loading data. See the

Generating and Modifying Template Files section on page 17 for more information.

However, to load a business object successfully to Oracle Fusion HCM, you need to understand its Oracle Fusion

structure, supported key systems, data formats, valid values, and required values.

Supplied Business-Object Documentation

HCM Data Loader provides a spreadsheet containing all the required information for each supported business

object. These are available from the MOS document, HCM Data Loader: Business Object Documentation (Doc ID

2020600.1).

Each spreadsheet is named for its top-level business object. For example, the file Location.xls includes the

information that you need about the location business object.

For complex business objects, the spreadsheet includes one tab for each component of the object. For example, the

Location.xls spreadsheet includes Location and Location Other Address tabs. Objects that support extensible

flexfields (EFFs) also include one tab for each EFF.

General information about a component appears at the top of its tab. This information includes:

The name of the Oracle Fusion HCM product that owns the object.

The name of the data file that you load (for example, Location.dat).

The component’s identifier (referred to as its discriminator ). For example, LocationOtherAddress.

The date type for the components, such as Simple Date, Effective Date, Multiple Changes Per Day (MCPD), or

not dated.

The level at which the component appears in its object hierarchy.

For child and grandchild components, the parent discriminator is also identified.

Following the general information about the component, these details appear for each attribute of the component:

https://support.oracle.com/epmos/faces/DocumentDisplay?_afrLoop=279365466961826&id=2020600.1&_afrWindowMode=0&_adf.ctrl-state=1al38wanwb_9https://support.oracle.com/epmos/faces/DocumentDisplay?_afrLoop=279365466961826&id=2020600.1&_afrWindowMode=0&_adf.ctrl-state=1al38wanwb_9https://support.oracle.com/epmos/faces/DocumentDisplay?_afrLoop=279365466961826&id=2020600.1&_afrWindowMode=0&_adf.ctrl-state=1al38wanwb_9https://support.oracle.com/epmos/faces/DocumentDisplay?_afrLoop=279365466961826&id=2020600.1&_afrWindowMode=0&_adf.ctrl-state=1al38wanwb_9https://support.oracle.com/epmos/faces/DocumentDisplay?_afrLoop=279365466961826&id=2020600.1&_afrWindowMode=0&_adf.ctrl-state=1al38wanwb_9https://support.oracle.com/epmos/faces/DocumentDisplay?_afrLoop=279365466961826&id=2020600.1&_afrWindowMode=0&_adf.ctrl-state=1al38wanwb_9


23/71


Value Description

Attribute Name The attribute name as it appears in the data file that you load for the component.

Key Type For attributes that are key values or can be used as key values, identifies the key type. For example, user key, GUID or

Foreign Surrogate ID.

Alternate User

Key for Surrogate

IDs

Identifies the attributes that you can use in place of surrogate IDs. For example, the LocationId is the surrogate ID

attribute for Location. To refer to the location from another business object, you can use the LocationCode and

SetCode user keys in place of the surrogate ID. The alternate user key for an attribute comprises all values that appear

in this column.

Integration Object

Name

For attributes that refer to other business objects, this column provides the name of the referenced object type. If that

object is not integration enabled, then the column contains the text not integration enabled . Integration enabled objects

can be referenced using Integration keys. Objects that are not integration enabled can only be referenced by user key

or Oracle Fusion surrogate ID.

Data Type The data type of the attribute. For example, Number or String.

Length The maximum attribute length.

Scale For Number values, the number of decimal places.

Primary Key Indicates whether the attribute is a component of the primary key. For example, for the location business object,

LocationId, EffectiveStartDate, and EffectiveEndDate are primary key values.

Mandatory Indicates whether the attribute is required. You must include required attributes when you create or update objects.

Lookup Name For attributes that are lists of values, provides the name of the Lookup. To see valid values for an attribute, review the

Lookup as described on page 11.

Description Provides additional information about the attribute.

For each integration-enabled component, the following attributes appear at the end of the attribute list for each

object component:

Oracle Fusion GUID for the component. This value is generated in Oracle Fusion and is described on page 5.

Source Key attributes SystemOwnerId and SourceSystemId values. For more information, see page 4.

For all business object components, the following information attributes appear at the end of the attribute list:

Source-system reference information (the table name, and up to 10 reference values). For more information,

see section Source-System References on page 33.

The spreadsheet for each supported business object also includes an Overview tab which summarizes the hierarchy

of components for the business object.

Generating and Modifying Template Files

HCM Data Loader provides a template file for each supported business object hierarchy.

The template contains:

A COMMENT line, which identifies the business object, its version, and the file creation date.

A METADATA line for each component of the business object hierarchy that you can load for the business

object. The METADATA line includes every attribute of the component, including environment specific

configured flexfield attributes.

You can generate business object template files and use them as the basis of your own data files.

To generate business object template files, navigate to the Data Exchange work area and select the Initiate Data

Load task.


24/71


Figure 9: Initiate Data Load Page (Navigator - Data Exchange - Initiate Data Load)

The Initiate Data Load page lists all HCM Data Loader supported business objects. You can generate a template for

a single business object or multiple business objects.

Generating a Single Business Object Template

Select the business object and click the Generate Template button on the table toolbar. This action opens the

Generate HCM Data Loader Template File submission page. Click Submit to initiate the process that identifies the

business object shape and generates the template file. You can download the newly created template file by

clicking the download icon ( ) in the File column for the business object.

Generating Multiple Business Object Templates

Click the Generate Templates button in the top right of the Initiate Data Loader page. This action opens the

Generate HCM Data Loader Templates submission page.

Figure 10: Generate HCM Data Loader Templates Submission Page

If you set the Module field to All, then templates for every supported business object will be generated.

Alternatively, select a specific module to generate business object templates for.


25/71


To access template files individually from the Business Objects table, click on the file download icon ( ) in the File

column for the business object. Alternatively, you can download a single zip file for all the business object templates

you generated in a single process. To view all the processes submitted to generate template files, click theProcesses tab. Click the file download icon ( ) for your process.

Figure 11: Review Template Files (Navigator - Data Exchange - Initiate Data Load - Processes)

Modifying METADATA Lines

Do not simply copy the METADATA lines from the template file and use them in your own data files. The template

files are to help you identify the names of all available attributes, including environment-specific attributes such as

flexfield segments. Your own data files should include only the METADATA lines for the components you want to

load and the attribute names for the values you want to supply.

HCM Data Loader validates every attribute name on every METADATA line. It also determines any potential

dependencies on other business objects in the same zip file by reviewing the attributes supplied in METADATA. For

example, if the Job.dat file contains the ValidGrade METADATA line with the GradeId attribute, HCM Data Loader

assumes that the Job.dat has a potential dependency on Grades.

You can improve the speed and efficiency of the import and load processes by declaring only the attributes that you

are supplying data for.

Extracting Data into the HCM Data Loader File Format

This section describes how HCM Data Loader expects your data to be formatted in order for it to be successfully

imported into the HCM Data Loader stage tables.

Developing an Extract for Each Business Object

You need to define mappings between your source data and the Oracle Fusion business-object model by comparing

source attributes with attributes in Oracle Fusion HCM objects. For information on Oracle Fusion HCM objects, refer

to the supplied business-object spreadsheets. You must also define the transformation logic and build extraction


26/71


routines. You can use tools that are native to the source system, such as PL/SQL in Oracle E-Business Suite or

SQR in Oracle PeopleSoft. Alternatively, you can use an ETL (Extract, Transform, and Load) tool, such as Oracle

Data Integrator (ODI) or PowerCenter Informatica.

Retaining Current Values

When you are updating existing Oracle Fusion data, you need to supply only the attributes that have changed, along

with a unique identifier to identify the record being updated. Any attribute values not supplied will not be updated.

However, for date-effective records all attribute values you do supply will be updated for the date-range specified.

For more information, see the section Maintaining Existing Date-Effective Data on page 34.

Setting Not Null Attribute Values to Null

If you want to set an attribute value explicitly to null, you cannot just leave the attribute value blank. Instead, you

must supply the #NULL token.

Lookup Validated AttributesFor attributes that are defined in Oracle Fusion HCM as lookups, you can specify either the lookup code or its

meaning. For example, the gender attribute of the person object can be specified using:

M (the code value) or Male (the code meaning)

F (the code value) or Female (the code meaning)

This is true for non-flexfield attributes only. For more information on lookup meaning values for lookup validated

flexfield segments, see page 33.

Number Attributes

For numbers, only the decimal separator is supported. Do not include currency symbols, scientific notation, or

thousands separators.

To set an existing numeric value to null, specify the tag #NULL as the attribute value.

Date and Time Attributes

The expected formats for date and time values are:

Date YYYY/MM/DD

Time YYYY/MM/DD HH24:MI:SS

For example, 2013/11/05 18:35:00

To set an existing date or time value to null, specify the tag #NULL as the attribute value.

CLOB and BLOB Attributes

The method for providing data for Character Large OBjects (CLOB) and Binary Large OBjects (BLOB) differs from

that for all other attributes. Instead of supplying the data directly, you supply the data in a separate file and reference

the filename in the CLOB or BLOB attribute.

This approach is used because data for these data types tends to be very large. Additionally, content to be loaded

directly (rather than by attachment) may need to include new line characters, making it complex to include in the

business object dat file.


27/71


The business object documentation specifies the data type of all attributes. To load data into a CLOB attribute, you

supply that data in a separate file and place that file in a folder named ClobFiles in the same zip file as the business

object dat file. Similarly, to load data or upload an attachment to a BLOB attribute, you supply the data or file toattach in a folder named BlobFiles in the same zip file.

Files in the ClobFiles and BlobFiles folders can have any name and most extensions are supported.

In the business object dat file you specify the file name for the CLOB or BLOB attribute. For example:

METADATA|DocumentAttachment|DocumentType|File|PersonNumber|..MERGE|DocumentAttachment|Drivers License|file01.txt|23901|..MERGE|DocumentAttachment|Drivers License|file02.txt|64235|..

Figure 12: Loading Attachments - Supplying References to Attachment Files

For DocumentAttachment the File attribute has a BLOB data type. Referenced files should be placed in the

BlobFiles folder:

Figure 13: BloblFiles Folder to Deliver Attachment Files for Documents of Record

Supplying Key Values

Creating a New Record

When supplying a unique reference for a new record, only the user key and source key are supported. Both the

Oracle Fusion Surrogate ID and Oracle Fusion GUID are system generated when the record is committed to the

database.

Note: If the source key is not specified on the initial creation of a record it cannot be used later to update that record.

Updating Existing Records

HCM Data Loader does not differentiate between create and update. All records to be loaded into Oracle Fusion

are simply tagged as MERGE requests. For integration-enabled objects, all four key types can be used to reference

an existing object for update or delete. For non-integration-enabled objects, only user key and Oracle Fusion

Surrogate IDs can be used.


28/71


Supplying Source Key Values

The source key comprises two attributes, SourceSystemOwner and SourceSystemId. If supplying a source key to

uniquely reference the record being merged, you can also supply source key values for integration-enabled foreign-

object references, including the parent record for child component records.

Note: You cannot use source keys for foreign-object references, including parents, if you are not supplying a source

key for the local record.

The SourceSystemOwner attribute is common for all source keys supplied in a record. Therefore, the foreign objects

being referenced by source key must have the same SourceSystemOwner value as the record being merged.

Before source keys can be used, the SourceSystemOwner value must be created in the

HRC_SOURCE_SYSTEM_OWNER lookup. See page 12 for additional details.

Specifying a Source Key for the Local Record

Supply values for both of the source key attributes SourceSystemId and SourceSystemOwner

METADATA|Job|SourceSystemId |SourceSystemOwner|JobCode|JobName|SetCode|EffectiveStartDate|EffectiveEndDateMERGE|Job|12349|EBS-UK|SE|Software Engineer|COMMON|2010/01/01|4712/12/31

Figure 14: Supplying a Source Key for the Local Record

Specifying a Source Key for a Foreign Object

Append the (SourceSystemId) hint to the surrogate ID attribute for the foreign object being referenced. In this

example Job, the Job must have been created using HCM Data Loader with the source key supplied.

METADATA|Assignment|SourceSystemId|SourceSystemOwner|JobId(SourceSystemId )|EffectiveStartDate|EffectiveEndDateMERGE|Assignment|234234|EBS-UK|12349|2013/01/01|4712/12/31

Figure 15: Supplying a Source Key for a Foreign Object

Source keys can be used only for integration-enabled foreign objects. The business object documentation identifies

which foreign objects are integration enabled.

If you do not specify a source key when a record is created using HCM Data Loader, then the source key will be

defaulted. The SourceSystemOwner will be FUSION and the SourceSystemId will be the Oracle Fusion surrogate

ID. You can still use source keys to reference records with default source keys, but there is no supported solution for

extracting source key information.

Supplying User Key Values

User keys are specific to the business object component being loaded. The business object documentation identifies

the user key attributes available for each business object component and all foreign objects referenced.


29/71


The user key attributes are mandatory when you first create a record and mandatory for updates unless you supply

a different key type to uniquely reference the record being updated.

Caution: Some user keys can change over time, which can make using the user key for historical references

challenging.

If you are loading date-effective history for a business object component where the user key does change, you must

also supply a source key. This approach allows HCM Data Loader to group related date-effective records correctly

to form the object being loaded.

Specifying a User Key for the Local Record

User keys can comprise multiple attributes, all of which must be supplied if no other key type is being used:

METADATA|Job|JobCode|JobName|SetCode|EffectiveStartDate|EffectiveEndDateMERGE|Job|SE|Software Engineer|COMMON|2010/01/01|4712/12/31

Figure 16: Supplying the User Key for the Local Record

Specifying a User Key for a Foreign Object

In this example the Assignment is uniquely referenced by a source key. However, the Job is referenced by its user

key:

METADATA|Assignment|SourceSystemId|SourceSystemOwner|JobCode|SetCode|EffectiveStartDate|EffectiveEndDateMERGE|Assignment|234234|EBS-UK|SE|COMMON|2013/01/01|4712/12/31

Figure 17: Supplying the User Key for a Foreign Object

Supplying Oracle Fusion Surrogate ID Values

Oracle Fusion Surrogate IDs are specific to the business object component being loaded. The Business Object

documentation identifies the Oracle Fusion Surrogate ID attribute for the business object component and all foreign

objects referenced.

Oracle Fusion Surrogate IDs cannot be assigned when you create data in Oracle Fusion. Oracle Fusion generates

these IDs internally at commit. Therefore, for new records either a source key or a user key must be supplied.

Specifying Oracle Fusion Surrogate ID for the Local Record

METADATA|Job|JobId |JobName|EffectiveStartDate|EffectiveEndDateMERGE|Job|13413|Software Engineer - Java|2013/01/01|4712/12/31

Figure 18: Supplying the Oracle Fusion Surrogate ID for the Local Record

Specifying Oracle Fusion Surrogate ID for a Foreign Object

In this example the Assignment is uniquely referenced by a source key. However, the Job is referenced by its

Oracle Fusion Surrogate ID:


30/71


METADATA|Assignment|SourceSystemId|SourceSystemOwner|JobId |EffectiveStartDate|EffectiveEndDate

MERGE|Assignment|234234|EBS-UK|13413|2013/01/01|4712/12/31 Figure 19: Supplying the Oracle Fusion Surrogate ID for a Foreign Object

Supplying Oracle Fusion GUID Values

The Oracle Fusion GUID is a hexadecimal value assigned by Oracle Fusion when a record is committed to the

database.

Specifying an Oracle Fusion GUID for the Local Record

When you supply an Oracle Fusion GUID value to uniquely reference the record being merged or deleted, the

attribute name is identical for all business object components: GUID.

METADATA|Job|GUID|JobName|EffectiveStartDate|EffectiveEndDateMERGE|Job|2342UJFHI2323|Software Engineer - Java|2013/01/01|4712/12/31

Figure 20: Supplying the Oracle Fusion GUID for the Local Record

Specifying an Oracle Fusion GUID for a Foreign Object

Append the (GUID) hint to the surrogate ID attribute for the foreign object being referenced. See this example Job:

METADATA|Assignment|SourceSystemId|SourceSystemOwner|JobId(GUID)|EffectiveStartDate|EffectiveEndDateMERGE|Assignment|234234|EBS-UK|2342UJHFI2323|2013/01/01|4712/12/31

Figure 21: Supplying the Oracle Fusion GUID for a Foreign Object

Oracle Fusion GUIDs can be used only for integration-enabled foreign objects. The business object documentation

identifies which foreign objects are integration enabled.

Date Effective and MCPD Components

Data-Effective Maintenance Mode

If you provide changes for a date range where date-effective or MCPD records already exist, then HCM Data Loader

provides two modes that determine how existing Oracle Fusion date-effective records are manipulated.

For more details and examples of how these modes will impact your data, see the Maintaining Existing Date-

Effective Data section on page 34.

Date effective records have common attributes that are normally mandatory when loading data:

EffectiveStartDate The start date for the attribute values. This value is always mandatory for date-effective components.

EffectiveEndDate The end date for the attribute values. If this value is left blank, then the end of time is defaulted, meaning

the date effective record will continue on with no end.

EffectiveSequence When multiple changes per day (MCPD) can be recorded, the EffectiveSequence provides the order in

which the changes occurred.


31/71


EffectiveLatestChange A Y/N flag. For MCPD records, this attribute indicates which record is the latest for the EffectiveStartDate.

Supplying Date-Effective History

You can choose how much history to load into Oracle Fusion for new objects, but the history you provide must be

complete and valid.

Retaining Existing Values

When you supply date-effective history for a record that is new to Oracle Fusion, Oracle Fusion deems only the first

date-effective record to be a new record and later-dated records to be updates. To retain the values from the

previous date-effective record, you can either leave the attribute values blank or repeat the value that is to continue.

Leaving an attribute value blank does not set the attribute to null in Oracle Fusion.

For example, loading date-effective history for a new object:

METADATA|Job|EffectiveStartDate|EffectiveEndDate|Attribute1|Attribute2|..MERGE|Job|1950/01/01|2012/03/04| W |X|..MERGE|Job|2012/06/02|2013/02/03||Y|..MERGE|Job|2013/02/04|4712/12/31|Z||..

The resulting data in Oracle Fusion:

EffectiveStartDate EffectiveEndDate Attribute1 Attribute2

1950/01/01 2012/03/04 W X

2012/06/02 2013/02/03 W Y

2013/02/04 Z Y

Attribute 1 will retain the W value on the second row, as no value was specified. Similarly, Attribute2 will retain the Yvalue on the final row.

Setting Not Null Values to Null

To change a not null value to null you must supply the #NULL token.

For example:

METADATA|Job|EffectiveStartDate|EffectiveEndDate|Attribute1|Attribute2|..MERGE|Job|1950/01/01|2012/03/04|W|X|..MERGE|Job|2012/06/02|2013/02/03|#NULL|Y|..MERGE|Job|2013/02/04|4712/12/31|Z|#NULL|..

The resulting data in Oracle Fusion:

EffectiveStartDate EffectiveEndDate Attribute1 Attribute2

1950/01/01 2012/03/04 W X

2012/06/02 2013/02/03 (null) Y

2013/02/04 Z (null)


32/71


It is advisable to use the #NULL token to ensure a null value in Oracle Fusion. Leaving an attribute with no value will

roll forward any existing value that attribute may have.

Rules for Supplying Date-Effective History

There Must Be No Gaps in the Date-Effective Records

There is no restriction on the order in which date effective records are provided in the dat file, but there must be no

break in the dates.

Example:

This example is not valid as the information between 5-Mar-2012 and 1-Jun-2012 is missing.

METADATA|Job|EffectiveStartDate|EffectiveEndDate|JobCode|..

MERGE|Job|1950/01/01|2012/03/04|ACC1|..MERGE|Job|2012/06/02|||ACC1|..

The Unique Key Value Must Not Change Over Time

HCM Data Loader groups your distinct file lines into logical objects, a logical object being one occurrence of the

business object, such as a job or a worker. The logical object grouping is performed on the unique key for the

component, so the key value must be the same across the date-effective history. Any of the four keys types can be

used to uniquely identify the records.

Example:

This example is not valid as the SourceSystemId used to uniquely identify Job ACC1 changes with the date-effective

history.

METADATA|Job|SourceSystemId|EffectiveStartDate|EffectiveEndDate|JobCode|..MERGE|Job|JB394_19500101|1950/01/01|2012/03/04|ACC1|..MERGE|Job|JB394_20120305|2012/03/05|2012/06/01|ACC1|..MERGE|Job|JB394_20120602|2012/06/12||ACC1|..

The EffectiveSequence Must Be Sequential for MCPD Records

When you report multiple changes on the same effective start date, the EffectiveSequence value must start at 1 and

increase sequentially. The same EffectiveSequence value cannot be repeated for the same logical object on the

same date, nor can there be any gaps. If there is only one change for an effective start date the EffectiveSequence

will always be 1. You cannot leave the EffectiveSequence blank when providing multiple changes per day. Withoutthis information there is no guarantee of the order in which records starting on the same EffectiveStartDate will be

processed.

Example:

This example is not valid as each sequence starts at zero and the sequence number 2 is missing.

METADATA|Assignment|SourceSystemId|EffectiveStartDate|EffectiveSequence|EffectiveEndDate|..


33/71


MERGE|Assignment|2724|2010/06/08|0|2012/03/03|..MERGE|Assignment|2724|2012/03/04|0|2012/03/04|..

MERGE|Assignment|2724|2012/03/04|3|2012/03/04|..MERGE|Assignment|2724|2012/03/04|4|2012/06/01|..MERGE|Assignment|2724|2012/06/02|1||..

The EffectiveLatestChange Must Be Y on the Latest MCPD Record

When you report multiple changes on the same effective start date, the latest record must have an

EffectiveLatestChange value of Y. All earlier records must have an N value. This attribute is always mandatory for

MCPD records.

If there is only one change for an effective start date, then the EffectiveLatestChange is always Y.

Example:

This example is not valid as the EffectiveSequence of 3 is the latest change but the EffectiveLatestChange value is

not Y.

METADATA|Assignment|SourceSystemId|EffectiveStartDate|EffectiveSequence|EffectiveLatestChange|EffectiveEndDate|..MERGE|Assignment|2724|2010/06/08|1|Y|2012/03/03|..MERGE|Assignment|2724|2012/03/04|1|N|2012/03/04|..MERGE|Assignment|2724|2012/03/04|2|N|2012/03/04|..MERGE|Assignment|2724|2012/03/04|3| N|2012/06/01|..MERGE|Assignment|2724|2012/06/02|1|Y||..

For MCPD Records That Are Not the Latest, the EffectiveEndDate Must Match the EffectiveStartDate.

When you report multiple changes on the same effective start date, all MCPD records that are not the latest change

must have an EffectiveEndDate matching the EffectiveStartDate.

Example:

This example is not valid because the EffectiveEndDate of those records with an EffectiveLatestChange of N have

an EffectiveEndDate that does not match the EffectiveStartDate.

METADATA|Assignment|SourceSystemId|EffectiveStartDate|EffectiveSequence|EffectiveLatestChange|EffectiveEndDate|..MERGE|Assignment|2724|2010/06/08|1|Y|2012/03/03|..MERGE|Assignment|2724|2012/03/04|1|N|2012/06/01|..MERGE|Assignment|2724|2012/03/04|2|N|2012/06/01|..MERGE|Assignment|2724|2012/03/04|3|Y|2012/06/01|..

MERGE|Assignment|2724|2012/06/02|1|Y||..

An Example of a Valid MCPD History

METADATA|Assignment|SourceSystemId|EffectiveStartDate|EffectiveSequence|EffectiveLatestChange|EffectiveEndDate|..MERGE|Assignment|2724|2010/06/08|1|Y|2012/03/03|..MERGE|Assignment|2724|2012/03/04|1|N|2012/03/04|..


34/71


MERGE|Assignment|2724|2012/03/04|2|N|2012/03/04|..MERGE|Assignment|2724|2012/03/04|3|Y|2012/06/01|..

MERGE|Assignment|2724|2012/06/02|1|Y||..

The following rules have been observed:

There are no gaps in the dates.

The unique key is identical for all date-effective records.

The EffectiveSequence starts at 1 for all new effective start dates and is sequential for matching effective start

dates.

The EffectiveLatestChange is always N when the record is not the latest change for an effective start date and

Y when it is.

The EffectiveEndDate matches the EffectiveStartDate when the MCPD record is not the latest change for an

effective start date.

Supplying Incremental Date Effective Changes

When your object already exists in Oracle Fusion you may not know exactly what is recorded. The change you need

to add may be the latest change, or future changes may already exist. For MCPD records, you may not know the

next available sequence number, or you may want to correct existing data. This section describes how to maintain

existing date-effective and MCPD records.

Updating a Date-Effective Record

Simply supply the data that has changed with the effective start date on which the change became effective.

METADATA|Job|SourceSystemId|SourceSystemOwner|EffectiveStartDate|EffectiveEndDate|ActiveStatusMERGE|Assignment|2724|EBS-UK|2015/01/01||I

Note: The EffectiveEndDate value has not been supplied, ensuring that this change will take effect until the end of

time.

Generating a New MCPD Split

For MCPD records, if you do not know the next available sequence number, then you can generate it simply by

leaving the EffectiveSequence attribute blank.

METADATA|Assignment|SourceSystemId|EffectiveStartDate|EffectiveSequence|EffectiveLatestChange|EffectiveEndDate|..MERGE|Assignment|2724|2010/06/08||Y|4712/12/31|..

Correcting an Existing MCPD Split

By supplying an EffectiveSequence value that already exists you will be correcting the existing record, not creating a

new MCPD split. To correct MCPD records, you must supply all MCPD attributes to uniquely identify the MCPD

record to correct.

METADATA|Assignment|SourceSystemId|EffectiveStartDate|EffectiveSequence|EffectiveLatestChange|EffectiveEndDate|..MERGE|Assignment|2724|2010/06/08|3|N|4712/12/31|..


35/71


Reserved Characters

By default, these characters are reserved and cannot be included in attribute values:

Delimiter (pipe |)

Escape (slash \)

To include the new line and pipe characters in attribute values, you precede them immediately with the escape

character (slash \). For example:

METADATA|Address|AddressLine1MERGE|Address|TheSteading\|Kier Allan

This entry enables the pipe character to appear in AddressLine1:

The Steading|Kier Allan

To include the new-line character in a value, you specify \n. For example:

METADATA|Address|AddressLine1MERGE|Address|TheSteading\nKier Allan

This entry results in the following value for AddressLine1:

The Steading

Kier Allan

The SET File-Line Instruction

You can override the reserved characters for a file by using the SET file-line instruction, which must appear before

any METADATA lines in the file.

The format of the SET command for overriding reserved characters is:

SET FILE_ESCAPE SET FILE_DELIMITER SET FILE_NEW_LINE

Figure 22: Overwriting Reserved Characters with the SET Command

The new value can be up to 10 characters. For example, you could set the new-line character to newline and the file

delimiter to comma (,) using the following SET commands:

SET FILE_DELIMITER ,SET FILE_NEW_LINE newline

In this case, METADATA and MERGE lines could appear as follows:

METADATA,Address,AddressLine1MERGE,Address,TheSteading\newlineKier Allan

Flexfields

Using HCM Data Loader, you can load both descriptive flexfield and extensible flexfield data.


36/71


After configuring your descriptive and extensible flexfields, open the Initiate Data Load page to generate a template

for your object. The generated template will include in the METADATA lines all the attributes required to successfully

load data into your configured flexfields. For more information about generating business object templates, refer topage 17.

This section explains the concepts that are common to supplying descriptive and extensible flexfield data, followed

by the specific information required for each flexfield type.

Flexfield Code

If you are supplying flexfield attribute values, in addition to providing the flexfield attribute names, you must also

supply the flexfield code in the METADATA line, in the format:

FLEX:

Figure 23: Descriptive Flexfield Code Format

The available flexfield codes will be included in your generated template file.

Both descriptive and extensible flexfields have one or more contexts. This attribute will be used to supply the

context information on your MERGE lines.

Flexfield Attribute Names

Flexfield attribute names are derived from the name you configured for the flexfield segment. However, they must

also be provided with a hint that tells HCM Data Loader which flexfield the attribute belongs to, and which context it

is applicable to:

()

Figure 24: Descriptive Flexfield Attribute Name Format

Some business object components support multiple descriptive flexfields. By supplying both the flexfield code andcontext against each flexfield attribute, you can supply all descriptive flexfield attributes together for every supported

flexfield and every configured context. Although extensible flexfields do not support multiple flexfield codes on the

same line, the format of the attribute name is the same for consistency.

Descriptive Flexfield Example

The contract component of the worker business object supports both the PER_CONTRACT_DF and

PER_CONTRACT_LEG_DDF descriptive flexfields.

These flexfields have the following configuration:

DFF Context Attribute Hint

PER_CONTRACT_DF Global _CONTRACT_GLB (PER_CONTRACT_DF=Global Data

Elements)

CONTRACT_DF _Currency (PER_CONTRACT_DF=CONTRACT_DF)

PER_CONTRACT_LEG_DDF CH _MAIN_CONTRACT (PER_CONTRACT_LEG_DDF=CH)

CN _CONST_PROB_DATE (PER_CONTRACT_LEG_DDF=CN)

CN _NDA (PER_CONTRACT_LEG_DDF=CN)

CN _COMPETITION_CLAUSE (PER_CONTRACT_LEG_DDF=CN)


37/71


CN _NOTICE_DURATION_UNIT (PER_CONTRACT_LEG_DDF=CN)

If you were to generate a Worker.dat template file, the Contract METADATA line would include these attributes:

METADATA|Contract|...|_CONTRACT_GLB(PER_CONTRACT_DF=Global Data Elements)|_Currency(PER_CONTRACT_DF=CONTRACT_DF)|_MAIN_CONTRACT(PER_CONTRACT_LEG_DDF=CH)|_CONST_PROB_DATE(PER_CONTRACT_LEG_DDF=CN)|_NDA(PER_CONTRACT_LEG_DDF=CN)|_COMPETETION_CLAUSE(PER_CONTRACT_LEG_DDF=CN)|_NOTICE_DURATION_UNIT(PER_CONTRACT_LEG_DDF=CN)

Figure 25: Descriptive Flexfield METADATA Example

Extensible Flexfield Example

The Job hierarchy provides the JobLegislative extensible flexfield. This flexfield has the following configuration:

EFF Context Attribute Hint

PER_JOBS_LEG_EFF CA _EE0G (PER_JOBS_LEG_EFF=CA)

CA _NOC_CODE (PER_JOBS_LEG_EFF=CA)