Loading Calculation Cards For Qatar Using HCM Data Loader: Oracle Payroll Cloud Release 13 / 19B

Loading Calculation Cards for
Qatar Using HCM Data

Loader
Oracle Payroll Cloud Release 13 / 19B
WHITE PAPER / JANUARY 3, 2020

PURPOSE STATEMENT
This document provides an overview of bulk loading Calculation Card data for Qatar localization in Release 13.
DISCLAIMER
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your
access to and use of this confidential material is subject to the terms and conditions of your Oracle software license and service
agreement, which has been executed and with which you agree to comply. This document and information contained herein may
not be disclosed, copied, reproduced or distributed to anyone outside Oracle without prior written consent of Oracle. This document
is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or
affiliates.
This document is for informational purposes only and is intended solely to assist you in planning for the implementation and
upgrade of the product features described. It is not a commitment to deliver any material, code, or functionality, and should not be
relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this
document remains at the sole discretion of Oracle.
Due to the nature of the product architecture, it may not be possible to safely include all features described in this document without
risking significant destabilization of the code.
2 W HITE PAPER / Loading Calculation Cards for Qatar Using HCM Data Loader
TABLE OF CONTENTS
Introduction 5
How to Use the Information in This Document 5
Example .dat Files 5
Reviewing HCM Data Loader File Examples 5
Calculation Cards 6
Considerations and Prerequisites for Maintaining Calculation Cards 6
Employee Social Insurance Details Calculation Card 7

Considerations and Prerequisites 7
Employee Social Insurance Details Calculation Card Record Types 7
Calculation Card: Employee Social Insurance Details 9
Card Component: Social Insurance Details 10
Card Association: Employee Social Insurance Details 13
Example Files 15
Employee Gratuity Details Calculation Card 16

Employee Gratuity Details Calculation Card Record Types 16
Calculation Card: Employee Gratuity Details 17
Card Component: Gratuity Details 18
Card Association: Employee Gratuity Details 21
Example Files 23
Court Orders Calculation Card 24

Court Orders Calculation Card Record Types 24
Calculation Card: Court Orders 25
Card Component: Court Orders 26
Card Component: Name from Element Template 27
Common Errors 30
FILE EXAMPLES
Example File 1: Update an Auto-Generated Employee Social Insurance Details Card. ........................................................................... 12
Example File 2: Add Component Detail Qatar Social Insurance Contributory Salary Adjustment to an Auto-Generated Employee Social
Insurance Details Card ............................................................................................................................................................................. 12
Example File 3: Create Card Association and Detail for an Auto-Generated Employee Social Insurance Details Card ........................... 15
Example File 4: Create a Complete Employee Social Insurance Details Card ......................................................................................... 15
Example File 5: Update an Auto-Generated Employee Gratuity Details Card .......................................................................................... 20
Example File 6: Create an Employee Gratuity Details Card ..................................................................................................................... 23
Example File 7: Create a Court Orders Card ............................................................................................................................................ 29
INTRODUCTION
Whether implementing Oracle Payroll Cloud for the first time, or providing regular updates, you can
create and maintain calculation cards using HCM Data Loader.
For general information about preparing data for loading using HCM Data Loader or the HCM Data
Loader file format, refer to guide Integrating with Oracle HCM Cloud, available on the Oracle Help
Center.
HOW TO USE THE INFORMATION IN THIS DOCUMENT
This document provides a separate section for each calculation card that it describes. Each section
covers the following topics:
Calculation Card Hierarchy - Describes the hierarchy of the localization calculation card.
Component Information - Describes how the localization calculation card uses the component in
the generic Calculation Card object hierarchy, explains the attributes to supply and provides
example file lines for the record type.
Example .dat Files - Provides complete but simple .dat file examples for the localization card.
For each Card Component and Card Assocaition you will find:
Object Information - Describes how the global Calculation Card object is used by the localization
card, explains the attributes to supply and where appropriate, provides sample HCM Data Loader
file lines for the record type.
EXAMPLE .DAT FILES
This document provides sample CalculationCard.dat files for loading Qatar Localization calculation
card data using HCM Data Loader. To use the source key examples, change the source system
owner to a lookup code you have preconfigured in the HRC_SOURCE_SYSTEM_OWNER lookup.
For both user key and source key examples ensure any references to foreign objects refer to data
that exists in your test environment.
REVIEW ING HCM DATA LOADER FILE EXAMPLES
To review the shape of the file, it is recommended that you copy and paste the examples into Excel,
converting each line into individual columns with the Text to Columns capability.
CALCULATION CARDS
Calculation cards capture values required for payroll calculations for certain earnings and
deductions, such as absence payments, statutory deductions, pensions, and involuntary
deductions.
For Qatar, the following types of calculation card are supported for bulk loading using HCM Data
Loader (HDL):
• Employee Social Insurance Details
• Court Orders
• Employee Gratuity Details
CONSIDERATIONS AND PREREQUISITES FOR MAINTAINING CALCULATION CARDS
Identifying Auto-Generated Calculation Cards
Some calculation cards are auto-generated and you are unlikely to know the source key values that
uniquely identify the calculation card records.
You can supply user key values to identify these records, but this relies on you knowing the
assignment number of your employee’s assignment. If you do not know this you can:
Extract the auto-generated source key values using the Integration Object User Key Map extract.
Reference the HCM Data Loader Extracts: Explained topic in the Integrating with Oracle HCM
Cloud guide, available on the Oracle Help Center.
Optionally update the auto-generated source key. Reference the Updating Source Keys:
Explained topic in the Integrating with Oracle HCM Cloud guide, available on the Oracle Help
Center.
Creating New Calculation Cards
If you are creating a new Calculation Card you are recommended to use source keys to uniquely
identify the records being loaded. This will simplify the file shape and allow you to more easily
identify your calculation card records when you need to maintain them.
EMPLOYEE SOCIAL INSURANCE DETAILS CALCULATION CARD
Employee Social Insurance Details cards store all information required to accurately compute social insurance contributions, such
employee details, annuity information and reference salary.
One Employee Social Insurance Details card must be created for each Qatar employee and Tax Reporting Unit (TRU) that the
employee belongs to.
CONSIDERATIONS AND PREREQUISITES

If the product license is set to Payroll or Payroll Interface, Employee Social Insurance Details calculation cards are automatically
created when a new employee is entered using the New Hire task with a set of values entered at person level, such citizenship and
social insurance information. Only the Employee Social Insurance Details card component is auto-generated. You only create the other
card components if you need to supply override values. There may be cases where this information must be loaded in bulk.
– During implementation for data migration:
– Employee Social Insurance details information must exist in Oracle Fusion Payroll, in order to ensure that contributions are
calculated correctly. If HDL is used to migrate employee records, a default Employee Social Insurance Details card is
automatically created. In most cases, the default will not reflect the employee’s actual Social Insurance information, and
therefore the card must be updated.
– Ongoing bulk updates
– Bulk loading of new hire data: If you have to do a mass upload of New Hire information, a default Employee Social Insurance
Details calculation card may be generated automatically (if the new hire records are created through HDL or the interface with
Taleo). In this case, you need to update the default card with the correct Social Insurance information.
It is recommended to have a good understanding of the Employee Social Insurance Details card and the information it contains prior to
attempting mass upload as it has a direct impact on statutory deductions and reporting. For further information, see Oracle Fusion
HRMS (Qatar): Payroll Implementation and Functional Considerations (Document 2329792.1).
EMPLOYEE SOCIAL INSURANCE DETAILS CALCULATION CARD RECORD TYPES

Upload the Employee Social Insurance Details card with HCM Data Loader using the Global Payroll Calculation Card business object.
This generic object hierarchy provides record types to support the various localization requirements. The Employee Social Insurance
Details card utilizes the following record types:
Calculation Card Record Types for Employee Social Insurance Details
COMPONENT FUNCTIONAL DESCRIPTION DISCRIMINATOR
Calculation Card Defines the calculation card type and which employee assignment it captures CalculationCard
information for.
Card Component Used to group and segregate data required by the calculation card. CardComponent
The following sections describe the card components applicable to this
calculation card and which child records are required for each card component.
Component Detail Supply a component detail record for each flexfield context required by each ComponentDetail
card component.
Card Association Associates the calculation card with the Tax Reporting Unit the employee CardAssociation
reports to.
Card Association Associates card components with the employee’s assignments. CardAssociationDetails
Detail
Calculation Card Hierarchy

This diagram describes the hierarchy of Calculation Card record types applicable to Employee Social Insurance Details card:
A separate section follows to describe how to provide data for each card component and the card association.
CALCULATION CARD: EMPLOYEE SOCIAL INSURANCE DETAILS
Supply one Calculation Card record for every Qatar employee you are maintaining Social Insurance Details for. Even if you are
updating an existing calculation card and the calculation card itself is not being updated, still include the calculation card record to group
other related data supplied in the file.
Calculation Card
The Employee Social Insurance Details calculation card uses these attributes:
Calculation Card Attributes for Employee Social Insurance Details
HCM DATA LOADER

ATTRIBUTE ALTERNATIVE USER KEY ATTRIBUTES FUNCTIONAL DESCRIPTION
SourceSystemId CardSequence, AssignmentNumber, The value that uniquely identifies the Employee Social
DirCardDefinitionName, Insurance Details calculation card. For new calculation card
LegislativeDataGroupName supply the source key attributes. You can also identify
calculation cards with the user key attributes.
Source System Owner The name of the source system used to generate the source
system ID.
LegislativeDataGroupName The name of the Legislative Data Group for the calculation
card.
DirCardDefinitionName The name of the card definition. Specify ‘Employee Social

Insurance Details’
CardSequence A number to uniquely identify this card when multiple

calculation cards for the same card definition exist for the
employee. Not required when source keys are used.
AssignmentId(SourceSyste AssignmentNumber The employee assignment the calculation card is for. Either the
mId) source system ID or assignment number can be used to identify
the employee assignment.
EffectiveStartDate The start date of the calculation card, typically the employee’s
start date.
CARD COMPONENT: SOCIAL INSURANCE DETAILS
The Social Insurance Details card component records social insurance related information.
Card Component Hierarchy
Supply a Social Insurance Details card component with a Component Detail record for each flexfield context relevant to the employee.
The following sections describe how to supply valid file lines for these record types.
Card Component
The Social Insurance Details card component uses these attributes:
Card Component Attributes for Social Insurance Details
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Social Insurance Details
AssignmentNumber, card component. For new card components supply the source
DirCardDefinitionName, key attributes. You can also identify card component records
LegislativeDataGroupName, using the user key attributes.
DirCardCompDefName
system ID.
LegislativeDataGroupName The name of the legislative data group for the card component
definition.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Employee Social Insurance Details calculation
DirCardDefinitionName, card. Use the same key type used to identify the calculation
LegislativeDataGroupName card.
When using source keys supply this attribute with the value
supplied for the calculation card’s SourceSystemId attribute.
Otherwise supply the user key attributes with the same values
as the parent calculation card.
EffectiveStartDate The start date of the card component, typically the employee’s
start date. This must be after or equal to the EffectiveStartDate
on the Employee Social Insurance Details calculation card.
EffectiveEndDate An optional end date for the card component.
HCM DATA LOADER
DirCardCompDefName The name of the card component definition. Specify ‘Social

Insurance Details’
ComponentSequence A number to uniquely identify this card component when

multiple card components for the same card component
definition exist on the same card. Not required when source
keys are used.
Component Detail
Social Insurance Details utilizes three flexfield contexts. Use the Component Detail record types to load the flexfield segment values.
In addition to the attributes defined below, include the necessary flexfield segment attributes for
these flexfield contexts.
– Qatar Employee Details (ORA_HRX_QA_SI_PREL) Finding Flexfield Segment Attributes
– Qatar Social Insurance Contributory Salary Override You can find the flexfield segment attributes for each
flexfield context using the View Business Object task.
(ORA_HRX_QA_SI_CONT_SAL_OVR_PREL)
– Qatar Social Insurance Contributory Salary Adjustment (ORA_HRX_QA_SI_CONT_SAL_ADJ_PREL)
Only the Qatar Employee Social Details is required. The other component details are optional.
Component Detail Attributes for Social Insurance Details
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the component detail. For
DirInformationCategory, new component detail records supply the source key attributes.
LegislativeDataGroupName, You can also identify component detail records using the user
AssignmentNumber, key attributes.
DirCardDefinitionName,
DirCardCompDefName
system ID.
LegislativeDataGroupName The name of the legislative data group. Required to identify the
component flexfield.
DirCardCompId CardSequence, ComponentSequence, The parent Social Inurance Details card component. Use the
(SourceSystemId) AssignmentNumber, same key type used to identify the card component.
DirCardDefinitionName, When using source keys supply this attribute with the value
LegislativeDataGroupName, supplied for the card component’s SourceSystemId attribute.
DirCardCompDefName Otherwise, supply the user key attributes with the same values
as the parent card component.
HCM DATA LOADER
EffectiveStartDate The start date of the component detail, or update to the

component detail if you are providing date-effective history. This
must be after or equal to the EffectiveStartDate provided for the
Social Insurance Details card component.
EffectiveEndDate The optional end date of the component detail, or if you are
providing date-effective history the last day of the date-effective
changes.
DirCompFlexId DirInformationCategory, The component flexfield ID. Provide the user key attributes
LegislativeDataGroupName, listed to identify the component flexfield.
DirCardCompDefName
DirInformationCategory The code for the flexfield context data is provided for.
FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
DF DirInformationCategory attribute.
Example Files
This example updates the Qatar Employee Social Insurance Details for the Social Insurance Details card component for an auto-
generated Employee Social Insurance Details card.
Example File 1: Update an Auto-Generated Employee Social Insurance Details Card.
METADATA|CalculationCard|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|Assignment
Number|CardSequence
MERGE|CalculationCard|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1
METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|AssignmentNu
mber|CardSequence|DirCardCompDefName|ComponentSequence
MERGE|CardComponent|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1|Social Insurance
Details|1
METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|Assignment
Number|CardSequence|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction
Developer DF|oraHrxQaCitizenship(Deduction Developer
DF=ORA_HRX_QA_SI_PREL)|oraHrxQaRegisteredForSi(Deduction Developer
DF=ORA_HRX_QA_SI_PREL)|oraHrxQaCtzenContryToPay(Deduction Developer DF=ORA_HRX_QA_SI_PREL)
MERGE|ComponentDetail|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1|Social Insurance
Details|1|ORA_HRX_QA_SI_PREL|ORA_HRX_QA_SI_PREL|QA|Y|Y
User keys are used to identify the parent Employee Social Insurance Details Card, the Social Insurance Details Card Component and Component Detail records.
This example uploads component detail Qatar Social Insurance Contributory Salary Adjustment for the Social Insurance Details card
component for an auto-generated Employee Social Insurance Details card.
Example File 2: Add Component Detail Qatar Social Insurance Contributory Salary Adjustment to an Auto-Generated Employee Social Insurance Details
Card
Number|CardSequence
METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|AssignmentNu
mber|CardSequence|DirCardCompDefName|ComponentSequence
MERGE|CardComponent|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1|Social Insurance
Details|1
METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|Assignment
Number|CardSequence|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction
Developer DF|oraHrxQaContribSalAdjsmnt(Deduction Developer DF=ORA_HRX_QA_SI_CONT_SAL_ADJ_PREL)
MERGE|ComponentDetail|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1|Social Insurance
Details|1|ORA_HRX_QA_SI_CONT_SAL_ADJ_PREL|ORA_HRX_QA_SI_CONT_SAL_ADJ_PREL|5000.00
User keys are used to identify the parent Employee Social Insurance Details Card, the Social Insurance Details Card Component and Component Detail records.
CARD ASSOCIATION: EMPLOYEE SOCIAL INSURANCE DETAILS

The card association record associates the Employee Social Insurance Details calculation card with a tax reporting unit.
Card Association Hierarchy
The associated tax reporting unit is defined in the card association. The card association details records allows the Employee Social
Insurance Details card components to be associated with the employee assignment.
Card Association
Card Association Attributes for the Employee Social Insurance Details
HCM DATA LOADER

SourceSystemId CardSequence, TaxReportingUnitName, The value that uniquely identifies Employee Social Insurance
LegislativeDataGroupName, Details card association. For new card associations supply the
AssignmentNumber, source key attributes. You can also identify component
DirCardDefinitionName association records using the user key attributes.
SourceSystemOwner The name of the source system owner used to generate the
source system ID.
LegislativeDataGroupName The name of the legislative data group for the tax reporting unit.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Employee Social Insurance Details calculation
DirCardDefinitionName, card. Use the same key type used to identify the calculation
LegislativeDataGroupName card.
When using source keys supply this attribute with the value
HCM DATA LOADER
EffectiveStartDate The start date of the card association or the update to the card
association if you are providing date-effective history. This must
be after or equal to the EffectiveStartDate provided for the
Employee Social Insurance Details calculation card.
TaxReportingUnitName The name of the tax reporting unit to associate with the
Employee Social Insurance Details calculation card.
If source keys are used to identify the card association, you
must also specify the LegislativeDataGroupName attribute to
identify the tax reporting unit.
Card Association Details

The card association details record associates the Social Insurance Details card component with the assignments for the employee. If
the employee has more than one assignment provide a card association detail record for each payroll assignment.
Card Association Detail Attributes for Employee Social Insurance Details
HCM DATA LOADER

SourceSystemId DirCardDefinitionName, The value that uniquely identifies card association detail. For
AssignmentNumber, new records supply the source key attributes. If updating an
LegislativeDataGroupName, existing card association detail you can identify the record using
CardSequence, TaxReportingUnitName the user key attributes.
Source System Owner The name of the source system owner used to generate the
source system ID.
DirRepCardId(SourceSyste CardSequence, TaxReportingUnitName, The parent card association record. For new records supply the
mId) LegislativeDataGroupName, source system ID you provided on the card association record.
AssignmentNumber, You can identify existing card association records using the
DirCardDefinitionName user keys. Supply user key attributes with the same values
supplied on the parent card association record.
EffectiveStartDate The start date of the component association.
EffectiveEndDate The end date of the component association.
DirCardCompId(SourceSys CardSequence, ComponentSequence, The card component the association is for. Supply either the
temId) AssignmentNumber, source system ID value or user key attributes to identify the
DirCardDefinitionName, Social Insurance Details card component.
LegislativeDataGroupName,
DirCardCompDefName
AssociationAssignmentId(S AssociationAssignmentNumber The surrogate ID of the payroll assignment to associate a

ourceSystemId) unique reference to the assignment to associate.
Example File
This example creates the card association and detail for an auto-generated Employee Social Insurance Details card.
Example File 3: Create Card Association and Detail for an Auto-Generated Employee Social Insurance Details Card
Number|CardSequence
METADATA|CardAssociation|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|Assignment
Number|CardSequence|TaxReportingUnitName
MERGE|CardAssociation|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1|QA Legal Entity
METADATA|CardAssociationDetail|LegislativeDataGroupName|DirCardDefinitionName|EffectiveStartDate|Assi
gnmentNumber|CardSequence|TaxReportingUnitName|DirCardCompDefName|ComponentSequence|AssociationAssign
mentNumber
MERGE|CardAssociationDetail|QA LDG|Employee Social Insurance Details|2019/01/01|E3434|1|QA Legal
Entity|Social Insurance Details|1|E3434
User keys are used to identify the auto-generated parent Employee Social Insurance Details Card, the Social Insurance Details Card Component and Component Detail records.
EXAMPLE FILES
Creating a complete Employee Social Insurance Details Card

This example uploads the Employee Social Insurance Details calculation card for employee assignment E3434 on the 1st January
2019. If your Employee Social Insurance Details cards are not auto-generated it is recommended that you use source keys to create
the card.
The CalculationCard.dat file is used to upload Employee Social Insurance Details calculation cards with HCM Data Loader.
Example File 4: Create a Complete Employee Social Insurance Details Card
METADATA|CalculationCard|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardDefinitionN
ame|EffectiveStartDate|AssignmentNumber
MERGE|CalculationCard|HRC_SQLLOADER|E3434_SI|QA LDG|Employee Social Insurance
Details|2019/01/01|E3434
METADATA|CardComponent|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSyst
emId)|EffectiveStartDate|DirCardCompDefName
MERGE|CardComponent|HRC_SQLLOADER|E3434_SI_DET|QA LDG|E3434_SI|2019/01/01|Social Insurance Details
METADATA|ComponentDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardCompId(Sour
ceSystemId)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|oraHrxQaCitizenship(Deduction Developer DF=ORA_HRX_QA_SI_PREL)|oraHrxQaRegisteredForSi(Deduction
Developer DF=ORA_HRX_QA_SI_PREL)|oraHrxQaCtzenContryToPay(Deduction Developer DF=ORA_HRX_QA_SI_PREL)
MERGE|ComponentDetail|HRC_SQLLOADER|E3434_SI_PREL|QA LDG|E3434_SI_DET|2019/01/01|Social Insurance
Details|ORA_HRX_QA_SI_PREL|ORA_HRX_QA_SI_PREL|QA|Y|Y
METADATA|CardAssociation|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSy
stemId)|EffectiveStartDate|TaxReportingUnitName
MERGE|CardAssociation|HRC_SQLLOADER|E3434_SI_TRU|QA LDG|E3434_SI|2019/01/01|QA Legal Entity
METADATA|CardAssociationDetail|SourceSystemOwner|SourceSystemId|DirRepCardId(SourceSystemId)|DirCardC
ompId(SourceSystemId)|EffectiveStartDate|AssociationAssignmentNumber
MERGE|CardAssociationDetail|HRC_SQLLOADER|E3434_SI_TRU|E3434_SI_TRU|E3434_SI_DET|2019/01/01|E3434
Source keys are used to identify the parent Employee Social Insurance Details Card, the Social Insurance Details Card Component and Component Detail records.
EMPLOYEE GRATUITY DETAILS CALCULATION CARD
Employee Gratuity Details cards store all information required to calculate and process the gratuity payment, such employee gratuity
details (override amount and latest gratuity payment date).
The Employee Gratuity Details Card is created automatically upon employee termination and gratuity amount calculated. When the
gratuity card is created, the Employee Gratuity Details component, Qatar Employee Gratuity Details component details, and card
association are also automatically created.
One Employee Gratuity Calculation card will be created for terminated employees at the payroll relationship level.

If the product license is set to Payroll or Payroll Interface, Employee Gratuity Details cards are automatically created upon employee
termination.
However there may be cases where this information must be loaded in bulk.
– During implementation for data migration:
– Employee Gratuity details information must exist in Oracle Fusion Payroll, in order to ensure that values are calculated
correctly. If HDL is used to migrate employee termination records, a default Employee Gratuity card is automatically created.
For historical reasons you may wish to upload gratuity calculation cards to record the ‘Latest Gratuity Payment Date’, the last
date a gratuity payment was made, in a previous employment.
– Ongoing bulk updates
– Bulk loading of termination data: If you have to do a mass upload of termination information, a default Employee Gratuity
Details calculation card may be generated automatically (if the termination records are created through HDL). In this case, you
need to update the default card with the correct Gratuity information and create a component detail to store a gratuity override
amount (if needed).
It is recommended to have a good understanding of the Employee Gratuity Details calculation card and the information it contains prior
to attempting mass upload as it has a direct impact on calculation and reporting. For further information, see Oracle Fusion HRMS
(Qatar): Payroll Implementation and Functional Considerations (Document 2329792.1).
EMPLOYEE GRATUITY DETAILS CALCULATION CARD RECORD TYPES

The Employee Gratuity Details card can be updated with HCM Data Loader using the Global Payroll Calculation Card business object.
This generic object hierarchy provides record types to support the various localization requirements. The Employee Gratuity Details
card utilizes the following record types:
Calculation Card Record Types for Employee Gratuity Details
information for.
card component.
Card Association Associates the calculation card with the Tax Reporting Unit the employee CardAssociation
reports to.
Card Association Associates card components with the employee’s assignments. CardAssociationDetails
Detail

The hierarchy of Calculation Card components applicable to Employee Gratuity Details is described in this diagram:
CALCULATION CARD: EMPLOYEE GRATUITY DETAILS

Supply one Calculation Card record for every Qatar employee you are maintaining Gratuity Details for. Even if you are updating an
existing calculation card and the calculation card itself is not being updated, still include the calculation card record to group other
related data supplied in the file.
Calculation Card
The Employee Gratuity Details calculation card uses these attributes:
Calculation Card Attributes for Employee Gratuity Details
HCM DATA LOADER

SourceSystemId CardSequence, AssignmentNumber, The value that uniquely identifies the Employee Gratuity Details
DirCardDefinitionName, calculation card. For new calculation card supply the source key
LegislativeDataGroupName attributes. You can also identify calculation cards with the user
key attributes.
system ID.
card.
HCM DATA LOADER
DirCardDefinitionName The name of the card definition. Specify ‘Employee Gratuity

Details’

termination date.
CARD COMPONENT: GRATUITY DETAILS

The Gratuity Details card component records social insurance related information.
Supply a Gratuity Details card component with a Component Detail record for each flexfield context relevant to the employee.
Card Component
The Gratuity Details card component uses these attributes:
Card Component Attributes for Employee Gratuity Details
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Gratuity Details card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName, attributes. You can also identify card component records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName
system ID.
definition.
HCM DATA LOADER
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Employee Gratuity Details calculation card. Use
DirCardDefinitionName, the same key type used to identify the calculation card.
LegislativeDataGroupName When using source keys supply this attribute with the value
termination date. This must be after or equal to the
EffectiveStartDate on the Employee Gratuity Details
calculation card.
DirCardCompDefName The name of the card component definition. Specify ‘Gratuity

Details’

keys are used.
Component Detail
Gratuity Details utilizes one flexfield context. Use the Component Detail record types to load the flexfield segment values.
– Qatar Employee Gratuity Details (ORA_HRX_QA_GRATUITY_PREL) Finding Flexfield Segment Attributes

You can find the flexfield segment attributes for each
Component Detail Attributes for Gratuity Details
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the component detail. For new
DirInformationCategory, component detail records supply the source key attributes. You
LegislativeDataGroupName, can also identify component detail records using the user key
AssignmentNumber, attributes.
DirCardCompDefName
system ID.
DirCardCompId CardSequence, ComponentSequence, The parent Gratuity Details card component. Use the same
(SourceSystemId) AssignmentNumber, key type used to identify the card component.
HCM DATA LOADER
LegislativeDataGroupName, When using source keys supply this attribute with the value
DirCardCompDefName supplied for the card component’s SourceSystemId attribute.
EffectiveStartDate N/A The start date of the component detail, or update to the
Gratuity Details card component.
EffectiveEndDate N/A The optional end date of the component detail, or if you are
changes.
DirCardCompDefName
DirInformationCategory N/A The code for the flexfield context data is provided for.
FLEX:Deduction Developer N/A The flexfield context code. Supply the same value as for the
Example File
This example updates an auto-generated Employee Gratuity Details card component of the Employee Gratuity Details card.
Example File 5: Update an Auto-Generated Employee Gratuity Details Card
METADATA|CalculationCard|LegislativeDataGroupName|DirCardDefinitionName|CardSequence|EffectiveStartDa
te|AssignmentNumber
MERGE|CalculationCard|QA LDG|Employee Gratuity Details|1|2019/12/15|E3434
METADATA|CardComponent|LegislativeDataGroupName|DirCardDefinitionName|CardSequence|EffectiveStartDate
|AssignmentNumber|DirCardCompDefName|ComponentSequence
MERGE|CardComponent|QA LDG|Employee Gratuity Details|1|2019/12/15|E3434|Gratuity Details|1
METADATA|ComponentDetail|LegislativeDataGroupName|DirCardDefinitionName|CardSequence|EffectiveStartDa
te|AssignmentNumber|DirCardCompDefName|ComponentSequence|DirInformationCategory|FLEX:Deduction
Developer DF|oraHrxQaOverrideAmount(Deduction Developer
DF=ORA_HRX_QA_GRATUITY_PREL)|oraHrxQaLstGratPymtDate(Deduction Developer DF=ORA_HRX_QA_GRATUITY_PREL)
MERGE|ComponentDetail|QA LDG|Employee Gratuity Details|1|2019/12/15|E3434|Gratuity
Details|1|ORA_HRX_QA_GRATUITY_PREL|ORA_HRX_QA_GRATUITY_PREL|10050.00|2019/12/31
User keys are used to identify the parent Employee Gratuity Details Card, the Employee Gratuity Details Card Component and Component Detail records.
CARD ASSOCIATION: EMPLOYEE GRATUITY DETAILS
The card association record associates the Employee Gratuity Details calculation card with a tax reporting unit.
Card Association Hierarchy
The associated tax reporting unit is defined in the card association. The card association details records allows the Employee Gratuity
Details card components to be associated with the employee assignment.
Card Association
Card Association Attributes for the Employee Gratuity Details
HCM DATA LOADER

SourceSystemId CardSequence, TaxReportingUnitName, The value that uniquely identifies Employee Gratuity Details
LegislativeDataGroupName, card association. For new card associations supply the source
AssignmentNumber, key attributes. You can also identify component association
DirCardDefinitionName records using the user key attributes.
source system ID.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Employee Gratuity Details calculation card. Use
DirCardDefinitionName, the same key type used to identify the calculation card.
EffectiveStartDate The start date of the card association or the update to the card
association if you are providing date-effective history. This must
be after or equal to the EffectiveStartDate provided for the
Employee Gratuity Details calculation card.
LegislativeDataGroupName The name of the legislative data group for the tax reporting unit.
TaxReportingUnitName The name of the tax reporting unit to associate with the
Employee Gratuity Details calculation card.
If source keys are used to identify the card association, you
must also specify the LegislativeDataGroupName attribute to
identify the tax reporting unit.
Card Association Details
The card association details record associates the Gratuity Details card component with the payroll assignments for the employee. If
the employee has more than one assignment provide a card association detail record for each assignment.
Card Association Detail Attributes for Employee Gratuity Details
HCM DATA LOADER

SourceSystemId DirCardDefinitionName, The value that uniquely identifies card association detail. For
AssignmentNumber, new records supply the source key attributes. If updating an
LegislativeDataGroupName, existing card association detail you can identify the record using
CardSequence, TaxReportingUnitName the user key attributes.
source system ID.
DirRepCardId(SourceSyste CardSequence, TaxReportingUnitName, The parent card association record. For new records supply the
mId) LegislativeDataGroupName, source system ID you provided on the card association record.
AssignmentNumber, You can identify existing card association records using the
DirCardDefinitionName user keys. Supply user key attributes with the same values
supplied on the parent card association record.
EffectiveStartDate The start date of the component association.
EffectiveEndDate The end date of the component association.
DirCardCompId(SourceSys CardSequence, ComponentSequence, The card component the association is for. Supply either the
temId) AssignmentNumber, source system ID value or user key attributes to identify the
DirCardDefinitionName, Gratuity Details card component.
DirCardCompDefName
AssociationAssignmentId(S AssociationAssignmentNumber The surrogate ID of the payroll assignment to associate a

ourceSystemId) unique reference to the assignment to associate.
EXAMPLE FILES
Creating a complete Employee Gratuity Details Card

This example uploads the Employee Gratuity Details calculation card for employee assignment E3434 on the 1st August 2019, for a
payment date 31st August 2019. If your Employee Gratuity Details cards are not auto-generated it is recommended that you use source
keys to create the card.
Source keys are used to uniquely identify all records.
The CalculationCard.dat file is used to upload Employee Gratuity Details calculation cards with HCM Data Loader.
Example File 6: Create an Employee Gratuity Details Card
ame|EffectiveStartDate|AssignmentNumber
MERGE|CalculationCard|HCMQA-001|CARD_QA|QA LDG|Employee Gratuity Details|2019/08/01|E3434
emId)|EffectiveStartDate|DirCardCompDefName
MERGE|CardComponent|HCMQA-001|CARD_COMP_QA|QA LDG|CARD_QA|2019/08/01|Gratuity Details
ceSystemId)|EffectiveStartDate|DirCardCompDefName|DirInformationCategory|FLEX:Deduction Developer
DF|oraHrxQaOverrideAmount(Deduction Developer
DF=ORA_HRX_QA_GRATUITY_PREL)|oraHrxQaLstGratPymtDate(Deduction Developer DF=ORA_HRX_QA_GRATUITY_PREL)
MERGE|ComponentDetail|HCMQA-001|CARD_QA|QA LDG|CARD_COMP_QA|2019/08/01|Gratuity
Details|ORA_HRX_QA_GRATUITY_PREL|ORA_HRX_QA_GRATUITY_PREL|10000.00|2019/08/31
METADATA|CardAssociation|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirCardId(SourceSy
stemId)|EffectiveStartDate|TaxReportingUnitName
MERGE|CardAssociation|HCMQA-001|CARD_ASSO_QA|QA LDG|CARD_QA|2019/08/01|QA Legal Entity
METADATA|CardAssociationDetail|SourceSystemOwner|SourceSystemId|LegislativeDataGroupName|DirRepCardId
(SourceSystemId)|EffectiveStartDate|DirCardCompId(SourceSystemId)|AssociationAssignmentNumber
MERGE|CardAssociationDetail|HCMQA-001|ASSO_DTL_QA|QA LDG|CARD_ASSO_QA|2019/08/01|CARD_COMP_QA|E3434
Source keys are used to identify the Employee Gratuity Details Card, the Gratuity Details Card Component and Component Detail records.
COURT ORDERS CALCULATION CARD
The Court Orders card holds information on whether an employee is subject to court order deductions, and, if yes, then the details
regarding amount, frequency, or payee. Use the Manage Element task to create Court Orders elements. When you create the
element, a card component of the same name as the element is created. Those components are then available to use on the
predefined Court Orders calculation card.
Unlike Employee Social Insurance Details or Employee Gratuity Details cards, the Court Order card is not generated automatically. It
only needs to be created for those employees who are subject to those types of deductions. However, there may be cases where they
need to be uploaded in bulk:
– Data migration:
– Employee’s Court Orders must be migrated to the Oracle Payroll Cloud to ensure that appropriate deductions are considered.
Using HCM Data Loader you must create the card and all the necessary components and component details.
– Ongoing bulk updates:
– New hires may have Court Orders that need to be uploaded in bulk.
It is advised to have a good knowledge of the Court Orders card in order to upload data using HCM Data Loader. For further
information, see Oracle Fusion HRMS (Qatar): Payroll Implementation and Functional Considerations (Document 2329792.1).

– Eligibility for the Court Order element must be created.
– Create third-party payee and third-party payment methods for people and organizations the payment of the court order is made to.
– Court orders issuing authorities must be added to the lookup type PAY_INVLN_DEDN_ORDER_AMOUNT_PAYEE.
COURT ORDERS CALCULATION CARD RECORD TYPES

Upload the Court Orders card with HCM Data Loader using the Global Payroll Calculation Card business object. This generic object
hierarchy provides record types to support the various localization requirements. Qatar Court Orders utilizes the following record types:
Calculation Card Record Types for QA Court Orders
information for.
card component.
The hierarchy of Calculation Card components applicable to Court Orders is described in this diagram:
CALCULATION CARD: COURT ORDERS

The Court Orders calculation card uses these attributes:
Calculation Card Attributes for Court Orders
HCM DATA LOADER

SourceSystemId CardSequence, AssignmentNumber, The value that uniquely identifies the Court Orders calculation
DirCardDefinitionName, card. For new calculation card supply the source key attributes.
LegislativeDataGroupName You can also identify calculation cards with the user key
attributes.
system ID.
card.
DirCardDefinitionName The name of the card definition. Specify ‘Court Orders’

start date of the court order.
CARD COMPONENT: COURT ORDERS
The Court Orders card component records social insurance related information.
Supply a Court Order Details card component for each Court Orders card.
The following section describes how to supply valid file lines for this record type.
Card Component
The Court Order Details card component uses these attributes:
Card Component Attributes for Court Orders Details
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the Court Order Details card
AssignmentNumber, component. For new card components supply the source key
DirCardDefinitionName, attributes. You can also identify card component records using
LegislativeDataGroupName, the user key attributes.
DirCardCompDefName
system ID.
definition.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Court Orders calculation card. Use the same key
DirCardDefinitionName, type used to identify the calculation card.
start date for the court order. This must be after or equal to the
EffectiveStartDate on the Court Orders calculation card.
DirCardCompDefName The name of the card component definition. Specify ‘Court

Order Details’

keys are used.
Context1 Reference code of the court order
CARD COMPONENT: NAME FROM ELEMENT TEMPLATE
The Court Orders card component records social insurance related information.
Supply a card component as a child of the Court Order Details card component, with a component detail record to capture the flexfield
details. The name of the card component is defined by the element template.
Card Component
The card component uses these attributes:
Card Component Attributes for the named court order
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the card component. For new
AssignmentNumber, card components supply the source key attributes. You can
DirCardDefinitionName, also identify card component records using the user key
LegislativeDataGroupName, attributes.
DirCardCompDefName
system ID.
definition.
DirCardId(SourceSystemId) CardSequence, AssignmentNumber, The parent Court Orders calculation card. Use the same key
DirCardDefinitionName, type used to identify the calculation card.
ParentDirCardCompId(Sour CardSequence, The parent Court Order Details card component. Use the
ceSystemId) ParentComponentSequence, same key type used to identify the Court Order Details card
AssignmentNumber, component.
ParentDirCardCompDefName
HCM DATA LOADER
start date of the court order. This must be after or equal to the
EffectiveStartDate on the Court Orders calculation card.
DirCardCompDefName The name of the card component definition. Specify ‘Court

Order Details’

keys are used.
Context1 Reference code of the court order
Component Detail
Court Orders utilizes a single flexfield context. Use the Component Detail record type to load the flexfield segment values.
– Qatar Involuntary Deduction Details Finding Flexfield Segment Attributes

(ORA_HRX_QA_INVOL_DED_DETAILS)
You can find the flexfield segment attributes for each
Component Detail Attributes
HCM DATA LOADER

SourceSystemId CardSequence, ComponentSequence, The value that uniquely identifies the component detail. For new
DirInformationCategory, component detail records supply the source key attributes. You
LegislativeDataGroupName, can also identify component detail records using the user key
AssignmentNumber, attributes.
DirCardCompDefName
system ID.
DirCardCompId CardSequence, ComponentSequence, The parent card component which is named by the element
(SourceSystemId) AssignmentNumber, template. Use the same key type used to identify the card
DirCardDefinitionName, component.
LegislativeDataGroupName, When using source keys supply this attribute with the value
DirCardCompDefName supplied for the card component’s SourceSystemId attribute.
HCM DATA LOADER
EffectiveStartDate The start date of the component detail, or update to the

Court Orders card component.
EffectiveEndDate The optional end date of the component detail, or if you are
changes.
DirCardCompDefName
DirInformationCategory The code for the flexfield context data is provided for.
FLEX:Deduction Developer The flexfield context code. Supply the same value as for the
Example File
This example creates the Court Orders calculation card.
Example File 7: Create a Court Orders Card
ame|AssignmentNumber|EffectiveStartDate
MERGE|CalculationCard|HRC_SQLLOADER|E3434_CO|QA LDG|Court Orders|E3434|2019/07/07
emId)|DirCardCompDefName|EffectiveStartDate|Context1|ParentDirCardCompId(SourceSystemId)
MERGE|CardComponent|HRC_SQLLOADER|E3434_COD|QA LDG|E3434_CO|Court Order Details|2019/07/07||
MERGE|CardComponent|HRC_SQLLOADER|E3434_QACO|QA LDG|E3434_CO|PM QA Court
Order|2019/07/07|7777|E3434_COD
ceSystemId)|DirCardCompDefName|EffectiveStartDate|DirInformationCategory|FLEX:Deduction Developer
DF|oraHrxQaAmount(Deduction Developer DF=ORA_HRX_QA_INVOL_DED_DETAILS)|oraHrxQaDateOfIssue(Deduction
Developer DF=ORA_HRX_QA_INVOL_DED_DETAILS)|oraHrxQaThirdPartyPayee_Display(Deduction Developer
DF=ORA_HRX_QA_INVOL_DED_DETAILS)
MERGE|ComponentDetail|HRC_SQLLOADER|E3434_QACO_ID_DET|QA LDG|E3434_QACO|PM QA Court
Order|2019/07/07|ORA_HRX_QA_INVOL_DED_DETAILS|ORA_HRX_QA_INVOL_DED_DETAILS|1000.00|2019/07/07|PM QA
Court Order Payee
Source keys are used to identify the parent Court Order Card, the Card Components and Component Detail records.
COMMON ERRORS
You may experience errors while loading the calculation cards for Qatar, if the data is not provided as required. The following is a list of some of
the common errors that may occur:
MESSAGE RESOLUTION
You cannot enter zero or less than zero as the override amount. Change the override amount as value zero is not allowed.
You cannot enter zero as the adjustment amount. Change the adjustment amount as value zero is not allowed.
You cannot create a calculation card named You can't change the card name, you can select a different
{CALCULATION_CARD_NAME} because one already exists for calculation card to create.
this employee.
The date of receipt must be equal to or later than the date of issue. Change the date to a date equal or later than the date of issue.
You cannot deselect the registered for social insurance option for Qatari citizens must be registered for social insurance.
Qatari citizens.
ORACLE CORPORATION
Worldwide Headquarters
500 Oracle Parkway, Redwood Shores, CA 94065 USA
Worldwide Inquiries
TELE + 1.650.506.7000 + 1.800.ORACLE1
FAX + 1.650.506.7200
oracle.com
CONNECT W ITH US
Call +1.800.ORACLE1 or visit oracle.com. Outside North America, find your local office at oracle.com/contact.
blogs.oracle.com/oracle facebook.com/oracle twitter.com/oracle
Copyright © 2020, 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 trademarks or registered trademarks
of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0120
White Paper Loading Calculation Cards for Qatar Using HCM Data Loader
January 2020

Loading Calculation Cards For Qatar Using HCM Data Loader: Oracle Payroll Cloud Release 13 / 19B

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Loading Calculation Cards For Qatar Using HCM Data Loader: Oracle Payroll Cloud Release 13 / 19B

Uploaded by

Copyright:

Available Formats

Loading Calculation Cards for

Qatar Using HCM Data

WHITE PAPER / JANUARY 3, 2020

Example .dat Files 5

Reviewing HCM Data Loader File Examples 5

Employee Social Insurance Details Calculation Card 7

Calculation Card: Employee Social Insurance Details 9

Card Component: Social Insurance Details 10

Card Association: Employee Social Insurance Details 13

Employee Gratuity Details Calculation Card 16

Employee Gratuity Details Calculation Card Record Types 16

Calculation Card: Employee Gratuity Details 17

Card Component: Gratuity Details 18

Card Association: Employee Gratuity Details 21

Court Orders Calculation Card 24

Court Orders Calculation Card Record Types 24

Calculation Card: Court Orders 25

Card Component: Court Orders 26

Card Component: Name from Element Template 27

HOW TO USE THE INFORMATION IN THIS DOCUMENT

EXAMPLE .DAT FILES

REVIEW ING HCM DATA LOADER FILE EXAMPLES

• Employee Social Insurance Details

• Employee Gratuity Details

CONSIDERATIONS AND PREREQUISITES FOR MAINTAINING CALCULATION CARDS

Identifying Auto-Generated Calculation Cards

Creating New Calculation Cards

CONSIDERATIONS AND PREREQUISITES

– During implementation for data migration:

– Ongoing bulk updates

EMPLOYEE SOCIAL INSURANCE DETAILS CALCULATION CARD RECORD TYPES

Calculation Card Record Types for Employee Social Insurance Details

COMPONENT FUNCTIONAL DESCRIPTION DISCRIMINATOR

Calculation Card Hierarchy

Calculation Card Attributes for Employee Social Insurance Details

HCM DATA LOADER

DirCardDefinitionName The name of the card definition. Specify ‘Employee Social

CardSequence A number to uniquely identify this card when multiple

Card Component Hierarchy

Card Component Attributes for Social Insurance Details

HCM DATA LOADER

EffectiveEndDate An optional end date for the card component.

DirCardCompDefName The name of the card component definition. Specify ‘Social

ComponentSequence A number to uniquely identify this card component when

– Qatar Employee Details (ORA_HRX_QA_SI_PREL) Finding Flexfield Segment Attributes

– Qatar Social Insurance Contributory Salary Adjustment (ORA_HRX_QA_SI_CONT_SAL_ADJ_PREL)

Component Detail Attributes for Social Insurance Details

HCM DATA LOADER

EffectiveStartDate The start date of the component detail, or update to the

Example File 1: Update an Auto-Generated Employee Social Insurance Details Card.

CARD ASSOCIATION: EMPLOYEE SOCIAL INSURANCE DETAILS

Card Association Hierarchy

Card Association Attributes for the Employee Social Insurance Details

HCM DATA LOADER

Card Association Details

Card Association Detail Attributes for Employee Social Insurance Details

HCM DATA LOADER

EffectiveStartDate The start date of the component association.

EffectiveEndDate The end date of the component association.

AssociationAssignmentId(S AssociationAssignmentNumber The surrogate ID of the payroll assignment to associate a

Creating a complete Employee Social Insurance Details Card

Example File 4: Create a Complete Employee Social Insurance Details Card

CONSIDERATIONS AND PREREQUISITES