Professional Documents
Culture Documents
Loading Salary and Salary Basis Using HCM Data Loader
Loading Salary and Salary Basis Using HCM Data Loader
Table of Figures
Figure 1: Create Salary Basis ................................................................................................................................... 7
Figure 2: Configure Salary Component Usage ......................................................................................................... 8
Figure 3: Manage Salary ........................................................................................................................................ 13
Figure 4: Manage Salary with Components ............................................................................................................ 15
For general information about preparing data for loading using HCM Data Loader or the HCM Data
Loader file format, see the HCM Data Loader User’s Guide (MOS Doc ID: 1664133.1).
Additional Information
For information about creating payroll elements used by salary, see the document Configuring
Payroll Elements for Use in Oracle Fusion Compensation, document ID 1589502.1
(https://support.oracle.com/epmos/faces/DocumentDisplay?id=1589502.1) on My Oracle Support.
HCM Data Loader Attribute The attribute name to supply when providing your data in the
business object data (.dat) file. Attribute names with a *1 suffix are foreign-object references
that support the integration key types. As source keys are recommended where possible, the
document describes how to supply source key values. User key attributes are identified for
when you do not have the source key value.
User Interface Prompt The prompt seen on the user interface. The data that you supply in
the associated attribute derives this field value, which is not necessarily the same as the value
that you supply. For example, for the Location field on an Organization page you can supply
the Oracle Fusion surrogate ID, source key, or Oracle Fusion GUID to identify the location
uniquely. The value seen on the user interface will be the location name.
If the User Interface Prompt is prefixed with an asterisk (*), then the attribute is mandatory
when you create a new record.
Functional Description Additional information describing the attribute and how to supply
valid values.
Payroll Elements
The payroll element and input value that you link to a salary basis are used to pay worker salaries. The input
currency determines the salary basis currency. Elements that you link to salary bases must exist in Oracle Fusion
applications before you load the salary bases. In addition, you must create all elements:
If any of the preceding conditions is not met, then your salary bases will load incorrectly. They will either not be
associated with a legislative data group or not be linked with a payroll element, and you will have to correct these
incorrect salary bases manually in the application.
The frequency of the grade rate does not have to match the salary basis frequency. For example, you can link a
grade rate defined with annual amounts to a salary basis defined with a monthly frequency. However, the grade rate
currency and currency of the element linked to the salary basis (salary basis currency) must match.
Salary Basis Provide this record when creating or updating a salary basis. SalaryBasis
Salary Basis Component Provide this record for each predefined component of your salary basis. The SalaryBasisComponent
salary basis component record should be provided only if the SalaryBasis
ComponentUsage attribute is SELECTED_COMPONENTS.
Salary Basis
The discriminator SalaryBasis is used to load salary basis records using HCM Data Loader. The following
SalaryBasis attributes are commonly used when loading a new salary basis.
SourceSystemId / * Name You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attribute SalaryBasisName.
SalaryBasisName * Name Descriptive name of the salary basis. Must be unique within a legislative data
group, for example, US Annual Salary or UK Hourly Salary With Components.
SalaryBasisCode * Frequency Frequency in which base pay is stored and displayed. Validated from the
CMP_SALARY_BASIS lookup type.
Valid values are:
ANNUAL
HOURLY
MONTHLY
PERIOD
PERIOD (payroll period) retrieves the salary frequency from the payroll defined at
the payroll terms level for workers. Use this value only when payroll is defined
at the payroll terms level.
SalaryAnnualizationFa Annualization Factor Value used to convert salary in the salary basis frequency to an annual amount,
ctor for example, 1 for annual, 12 for monthly, and 2080 for hourly.
When the SalaryBasisCode is PERIOD, leave this value blank.
LegislativeDataGroupI * Legislative Data Group Unique reference to the legislative data group in which you are creating the salary
*1
d basis.
If you are supplying the user key value, then use the LegislativeDataGroupName
attribute. This attribute also supports the integration key types. If you supplied a
source key for the legislative data group, then supply the same value here and
append the source key hint to the attribute name, for example,
LegislativeDataGroupId (SourceSystemId).
ElementName * Payroll Element The name of the payroll element linked to the salary basis.
InputValueName * Input Value The name of the element type’s input value. Salary is posted to the input value for
the linked element type.
*1
GradeRateId Grade Rate Unique reference to the grade rate linked to the salary basis. Determines the
salary range minimum and maximum for the grade associated with a person’s
assignment. This value must be defined in the same legislative data group as the
salary basis.
If you are supplying the user key value, then use the LegislativeDataGroupName
and GradeRateName attributes. This attribute also supports the integration key
types. If you supplied a source key for the grade rate, then supply the same value
here and append the source key hint to the attribute name, for example,
GradeRateId (SourceSystemId).
ComponentUsage Components to Display Determines whether components are used to itemize salary adjustments into
when Adjusting Salary different reasons.
Validated against CMP_COMPONENT_USAGE lookup type.
Valid values are:
NO_COMPONENT – components are not used
SELECTED_COMPONENTS – use selected components
USER_DECIDES_USAGE – managers select components to use while
adjusting salary
When SELECTED_COMPONENTS is used, you must supply the components
using the SalaryBasisComponent record type.
When you convert salaries from Oracle PeopleSoft or Oracle EBS and are unsure
about component usage, select USER_DECIDES_USAGE. This option is the least
restrictive.
User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference
LegislativeDataGroup * Legislative Data Group The name of the legislative data group for which you are creating the salary basis.
Name
GradeRateName Grade Rate The name of the grade rate linked to the salary basis.
*1
The foreign object references support use of all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and
user key.
The value supplied will derive the value seen in the field specified in the User Interface Prompt.
The discriminator SalaryBasisComponent is used to load salary basis component records using HCM Data
Loader. The following SalaryBasisComponent attributes must be supplied when loading a new salary basis
component.
SourceSystemId / * Name You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner source key or the user key attributes SalaryBasisName and AttributeValue.
SalaryBasisId *1 * Name Unique Reference to the salary basis the component is for. If you are using source
keys, then add the (SourceSystemId) hint to this attribute name. If you are
supplying the user key, then use the SalaryBasisName attribute.
User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference
SalaryBasisName * Name The salary basis name. Can be used to uniquely reference the parent Salary Basis
that this component is for.
*1
The foreign object references support use of all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and
user key.
The value supplied will derive the value seen in the field specified in the User Interface Prompt.
Error Resolution
You cannot select the payroll element because it is defined on a Select a payroll element that is defined on the employment tier on
different employment tier from the tier on which salary is stored for which the salary is stored.
the legal employer.
An annualization factor is required with the selected frequency. Provide an annualization factor.
You cannot select this element because element entries exist. The Select another element.
payroll element was already used in another transaction.
You cannot select this payroll element because it is linked to another Select another salary basis that is not linked to a salary basis
salary basis.
The element {ELEMENT_ID} cannot be associated with the salary You can associate only recurring elements that are: classified as
basis. earning or information; defined at the assignment or employment
terms level and in the same legislative data group; defined with
element eligibility; and with Automatic Entry not selected for both the
element and its eligibility.
The grade rate ID {GRADE_RATE_ID} is invalid The grade rate must be in the same legislative data group as the
salary basis and in the same currency as the element type.
Depending on how the legal employer is configured, salary can be held at the assignment or the terms level. When
held at the assignment level, if a person has multiple assignments, then each assignment has its own salary record.
There is no sum total of individual assignment records. When held at the terms level, salary is not allocated or
proportioned across assignments. A single salary record exists for all assignments.
Depending on how the salary basis is configured, salary can comprise zero or more components. Salary
components cannot exist independently of salary.
Changes in Behavior
From Release 10, it is no longer necessary to end the existing open-ended salary when creating a new salary record
that starts later than the open-ended salary record.
Employment Records
Employment records must be created before you load salaries. Workers must have a grade defined on their
assignment, and the grade must be attached to the grade rate that is linked to each worker’s salary basis. These
requirements must be met for salary range to display and salary metrics to calculate correctly on the salary record.
Payroll Assignment
If you create any salary basis with a frequency of payroll period, all employees assigned that salary basis must be
assigned to a payroll defined at the payroll terms level. Assignment of the payroll must be done prior to loading
salary. This can be done using the Payroll Batch Loader.
Grade and full-time equivalent (FTE) are obtained from the employment terms. FTE is determined by
comparing the standard working hours of the worker’s legal employer and the working hours on the
worker’s employment terms.
Grade and FTE are obtained from each assignment. FTE is determined by comparing the standard
working hours of the worker’s legal employer and the working hours on the assignment.
Loading Salary
Salary data must be supplied in the Salary.dat file for processing by HCM Data Loader.
SALARY HIERARCHY
Salary Provide this record when creating or updating a worker’s salary. Salary
Salary Component Provide this record for each salary component for your salary. SalaryComponent
Salary
The discriminator Salary is used to load worker salary records using HCM Data Loader. The following Salary
attributes are available.
SALARY ATTRIBUTES
SourceSystemId / * Assignment Number You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner Start Date source key or the user key attributes AssignmentNumber and DateFrom.
SalaryBasisId*1 * Salary Basis Unique reference to the salary basis associated with the salary record. If you are
supplying the user key value, then use the SalaryBasisName attribute. This
attribute also supports the integration key types. If you supplied a source key for
the salary basis, then you can supply the same value here. Simply add the source
key hint to the attribute name, for example, SalaryBasisId(SourceSystemId).
AssignmentId *1 * Assignment Number Unique reference to the worker the salary is for. If you are supplying the user key
value, then use the AssignmentNumber attribute.
This attribute also supports the integration key types. If you supplied a source key
for the assignment, then you can supply the same value here. Simply add the
source key hint to the attribute name, for example,
AssignmentId(SourceSystemId).
ActionId*1 * Action Unique reference to the action association with the salary record. If you are
supplying the user key value, then use the ActionCode attribute. This attribute also
supports the integration key types. If you supplied a source key for the action, then
you can supply the same value here. Simply add the source key hint to the
attribute name, for example, ActionId(SourceSystemId).
*1
ActionReasonId Reason Unique reference for the action reason associated with the salary record. If you are
supplying the user key value, then use the ActionReasonCode and ActionCode
attributes. This attribute also supports the integration key types. If you supplied a
source key for the action reason, then you can supply the same value here. Simply
add the source key hint to the attribute name, for example,
ActionReasonId(SourceSystemId).
DateTo End Date Date on which the salary record ends. Leave this value blank if this is the latest
salary record with no end date.
MultipleComponents Enter Y if you are using salary components. Enter N if you are not using salary
components. Salary components are provided using the SalaryComponent record
type.
SalaryAmount Salary Amount Base salary amount for the salary record. If you are using salary components, then
enter the sum of all salary component amounts plus the previous salary amount.
NextSalReviewDate Next Salary Review Date Date on which the salary should next be reviewed. This optional attribute must
either be blank or contain a date later than the DateFrom attribute value.
SalaryApproved Specify Y.
User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference
SalaryBasisName * Salary Basis The salary basis name. Can be used to uniquely reference the Salary Basis for
this Salary.
AssignmentNumber * Assignment Number The number of the assignment this salary is for.
ActionCode * Action The action associated with the salary record. This following values are valid:
HIRE - Hire an Employee
HIRE_ADD_WORK_RELATION - Add Employee Work Relationship
REHIRE - Rehire an Employee
PROMOTION - Promote
TRANSFER - Transfer
GLB_TRANSFER - Global Transfer
CHANGE_SALARY – Change Salary
ALLOCATE_GRP_CMP – Allocate Workforce Compensation
*1
The foreign object references support use of all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and
user key.
The value supplied will derive the value seen in the field specified in the User Interface Prompt.
SalaryComponent
The following SalaryComponent attributes must be supplied when loading a salary when MultipleComponents is Y.
The user interface prompts are also included.
SourceSystemId / * Assignment Number You must provide a unique reference for the record being created. Supply either a
SourceSystemOwner * Start Date source key or the user key attributes AssignmentNumber, DateFrom, and
ComponentReasonCode.
* Component
*1
SalaryId * Assignment Number You must provide a unique reference to the salary this component is for. If you are
* Start Date using source keys, then add the (SourceSystemId) hint to this attribute name. If
you are supplying user key values, then provide the user key attributes
AssignmentNumber and DateFrom.
This attribute also supports the integration key types. If you supplied a source key
for the salary, then you can supply the same value here. Simply add the source
key hint to the attribute name, for example, SalaryId(SourceSystemId).
ChangeAmount Amount Change amount associated with the salary component. This amount is added to
the previous base salary to derive the new salary amount for the salary record. If
ChangePercentage is supplied, then you can leave this attribute blank. The
corresponding amount is calculated.
ChangePercentage Percentage Change percentage associated with the salary component. This is a percentage of
the previous base salary amount. If ChangeAmount is supplied, then you can
leave this attribute blank. The corresponding percentage is calculated.
ComponentApproved Specify Y.
User key attributes that are required only if no other key type is supplied to uniquely identify the object they reference
AssignmentNumber * Assignment Number The number of the assignment the salary is for. This must be supplied if you are
not referencing the parent salary record with a source key.
DateFrom * Start Date Date on which the salary record starts. This value must be supplied if you are not
referencing the parent salary record with a source key.
*1
The foreign object references support use of all four key types: Oracle Fusion surrogate ID, Oracle Fusion GUID, source key, and
user key.
The value supplied will derive the value seen in the field specified in the User Interface Prompt.
Salary components are children of the salary record and can be loaded only for salary records whose salary bases
are configured to use components.
If an existing open-ended salary already exists, refer to the example in the Update Salary using Source Keys
section.
Salary.dat
METADATA|Salary|SourceSystemOwner|SourceSystemId|AssignmentId(SourceSystemId)|DateFro
m|SalaryAmount|SalaryBasisName|ActionCode|SalaryApproved|MultipleComponents
MERGE|Salary|VISION|1012SAL15|1012_EMP_ASG|2015/01/01|65000|SalBasis_1007|CHANGE_SALA
RY|Y|N
METADATA|SalaryComponent|SourceSystemOwner|SourceSystemId|SalaryId(SourceSystemId)|Da
teFrom|ComponentReasonCode|ChangeAmount|ComponentApproved
MERGE|SalaryComponent|VISION|1012SAL15_COL|1012SAL15|2015/01/01|COST_OF_LIVING|60000|
Y
MERGE|SalaryComponent|VISION|1012SAL15_ADJ|1012SAL15|2015/01/01|ADJUSTMENT|5000|Y
Salary.dat
METADATA|Salary|SourceSystemOwner|SourceSystemId|AssignmentId(SourceSystemId)|DateFro
m|DateTo|SalaryAmount|SalaryBasisName|ActionCode|SalaryApproved|MultipleComponents
MERGE|Salary|VISION|1012SAL16|1012_EMP_ASG|2016/01/01||70000|SalBasis_1007|CHANGE_SAL
ARY|Y|N
METADATA|SalaryComponent|SourceSystemOwner|SourceSystemId|SalaryId(SourceSystemId)|Da
teFrom|ComponentReasonCode|ChangeAmount|ComponentApproved
MERGE|SalaryComponent|VISION|1012SAL16_COL|1012SAL16|2016/01/01|COST_OF_LIVING|5000|Y
MERGE|SalaryComponent|VISION|1012SAL16_ADJ|1012SAL16|2016/01/01|ADJUSTMENT|0|Y
Salary.dat
METADATA|Salary|AssignmentNumber|DateFrom|SalaryAmount|SalaryBasisName|ActionCode|Sal
aryApproved|MultipleComponents
MERGE|Salary|1014|2015/01/01|53500|SalBasis_1007|CHANGE_SALARY|Y|N
METADATA|SalaryComponent|AssignmentNumber|DateFrom|ComponentReasonCode|ChangeAmount|C
omponentApproved
MERGE|SalaryComponent|1014|2015/01/01|COST_OF_LIVING|52000|Y
MERGE|SalaryComponent|1014|2015/01/01|ADJUSTMENT|1500|Y
Salary.dat
METADATA|Salary|AssignmentNumber|DateFrom|DateTo|SalaryAmount|SalaryBasisName|ActionC
ode|SalaryApproved|MultipleComponents
MERGE|Salary|1014|2016/01/01||53900|SalBasis_1007|CHANGE_SALARY|Y|N
METADATA|SalaryComponent|AssignmentNumber|DateFrom|ComponentReasonCode|ChangeAmount|C
omponentApproved
MERGE|SalaryComponent|1014|2016/01/01|COST_OF_LIVING|300|Y
MERGE|SalaryComponent|1014|2016/01/01|ADJUSTMENT|100|Y
Salary Errors
You may experience errors while loading salary bases if the data is not as expected. Some common errors are:
SALARY ERRORS
Error Resolution
The worker does not have valid assignment data as of the effective Verify or correct the assignment data.
date {EFFECTIVE_DATE}. The assignment information may be
inactive or ended.
The start date {START_DATE} or end date {END_DATE} for this Correct the start date or end date of the current or another record so
salary record is invalid because it overlaps with an existing record. that no records overlap.
The new salary start date must be later than the previous salary Provide a salary start date that is 1 day or more later than the start
record start date {PREV_SAL_START}. date of the previous salary record.
The salary basis cannot be used for the current employment terms Either correct the salary basis (by attaching an existing or new
or assignment. Either the salary basis is not defined at the same element defined at the correct employment level), or correct the
employment tier as the worker's salary, or the assignment or eligibility criteria of the element linked to the salary basis, or select a
employment terms do not match the eligibility criteria of the element different salary basis.
on the worker's salary basis.
Salary.dat
METADATA|Salary|SourceSystemOwner|SourceSystemId|AssignmentId(SourceSystemId)|DateFro
Salary.dat
METADATA|Salary|AssignmentNumber|DateFrom
DELETE|Salary|1014|2016/01/01
Copyright © 2014, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the
contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject to any other
warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or
fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are
formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any
means, electronic or mechanical, for any purpose, without our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and
are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
CONNECT W ITH US trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0516
blogs.oracle.com/oracle Loading Salary and Salary Basis using HCM Data Loader
May 2016
facebook.com/oracle
twitter.com/oracle
oracle.com