Loading US Data with HCM

Data Loader:
Supporting BIPublisher
Reports
Oracle Payroll Cloud Release 13 / 19B

JULY 30, 2019

PURPOSE STATEMENT
This document provides an overview of the BI Publisher reports that support loading US data 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 shouldn’t 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 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
TABLE OF CONTENTS

Introduction 4
How to Use the Information in This Document 4

Importing BI Publisher Reports 5

Report Details 9
US Geography Vertex Codes 9

US State Taxes Value Definitions 11

US Involuntary Deduction Value Definitions by Element 13

REPORT OUTPUT EXAMPLES

Figure 1: US Vertex Geography Codes .................................................................................................................................................... 10

Figure 2: US State Taxes Value Definitions .............................................................................................................................................. 12
Figure 3: US Involuntary Deduction Values Definitions ............................................................................................................................ 14

3 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
INTRODUCTION

Whether implementing Oracle Payroll Cloud for the first time, or providing regular updates, you can
create and maintain US calculation cards with the global Calculation Card object available to HCM
Data Loader. Due to the generic nature of the global calculation card, it is sometimes necessary to
extract data, such as geo codes and payee names, in order to load US cards. This paper explains
how to import BI Publisher reports into your environment for this purpose, with an overview of each.

For general information about preparing data for loading using HCM Data Loader or the HCM Data
Loader file format, refer to the guide Integrating with Oracle HCM Cloud, available on the Oracle
Help Center.

HOW TO USE THE INFORMATION IN THIS DOCUMENT

This document provides the following topics:

Importing BI Publisher Reports - Describes how to import the shared BI Publisher resources into
your environment.

Report Overview - Describes each report, the information it extracts, and the report parameters.

4 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
IMPORTING BI PUBLISHER REPORTS
A number of BI Publisher reports are available in Customer Cloud Connect. Use these to extract the data required to successfully load
data for the US. Follow these steps to import a BI Publisher report to your environment:

1. Download the zip file for the report from Customer Cloud Connect.

2. Unzip the file to extract two files:

• The file ending xdm.catalog includes the data model for the report.

• The file ending xdo.catalog includes the report definition.

3. In the application, navigate to Tools > Reports and Analytics, and click Browse Catalog.

4. Navigate to the folder where you want to import the BI Publisher reports.

5. Click the Unarchive task.

5 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
6. In the Unarchive window, browse for the data model file and click OK.

7. Click the Unarchive task again, this time selecting the report file.

The report definition file now needs to be linked to the data model definition.

8. On the unarchived report definition file, click Edit.

9. Click the Select Data Model icon.

10. Search for and select the data model definition file, and then click OK.

6 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
11. Save the report and navigate back to the catalog.

12. You can now execute the report by clicking Open on the report definition.

Optionally, make the report accessible from the Reports and Analytics task by clicking More and selecting Add to Favorites.

7 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
8 Loading US Data with HCM Data Loader: Supporting BI
Publisher Reports
REPORT DETAILS

US GEOGRAPHY VERTEX CODES

This report extracts the vertex codes for the US states, counties and cities. The vertex codes identify the state, county and city when
providing state taxes and other state-specific card components or balances.

Parameters
PARAMTER DESCRIPTION

State The name of the state to extract vertex codes. Select one or all states.

County The name of the county within the selected state to extract vertex codes for.

Report Columns
COLUMN DESCRIPTION

State The name of the state.

County The name of the county.

City The name of the city.

Vertex Code The vertex code for the state, county and city combination. The vertex code comprises 3 components, delimited
by hyphens. The first component identifies the state, the second the county, and the third the city.

Report Definition Files

FILE TYPE FILE NAME

Data model US Vertex Geography Codes.xdm.catalog

Report definition US Vertex Geography Codes.xdo.catalog

These files are included in the BI Publisher Report - US Vertex Geography Codes.zip file.

9 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
Example Output
Figure 1: US Vertex Geography Codes

O R A CLE 'Bu si ness In telli gence Search All y Q. Advanced Administr ation OTBI Help Help • Sign

US Vertex Geogra phy Codes Home Catal og Favorites • Dashboards • New • Open ,.. Signed In As r

Stat e All y County All .. Apply

Oracle Bl Publisher Date: 2019.07.03 9:52:46 AM

Page 1 Of 1
- ·--
.f}
· i) Q

I
State County City Vertex_Codes
Alabam a AUTAUGA AUTAUGAVILLE 1-1-4151
Alabam a AUTAUGA BILLINGSLEY 1-1-4152
Alabama AUTAUGA Booth 1-1-4153
Alaba ma AUTAUGA Jones 1-1 -4154
Alabam a AUTAUGA Marbury 1-1-4155
Alabam a AUTAUGA Millbrook 1-1-4143
Alabam a AUTAUGA PRATTVILLE 1-1-870
Alab am a BALDWIN BAY MIN ETT'E 1 -3-120
Alabama BALDWIN Bon Secour 1-3-4156
Alabama BALDWIN DAPH E 1-3-3826
Alabam a BALDWIN ELBERTA 1-3-4158
Alab ama BALDWIN FAIRHOPE 1-3-380
Alabam a BALDWIN FOLEY 1-3-420
Alabam a BALDWIN Fort Morgan 1-3-4159
Alaba ma BALDWIN GULF SHORES 1-3-2200
Alabam a BAL DI/I/IN LOXLEY 1-3-2940
Alaba ma BALDWIN Lillian 1-3-4161
Alaba ma BALDWIN Little River 1-3-4162
Alabama BALDWIN Magnolia Springs 1-3-4163
Alabam a BALDWIN Malbis 1-3-4164
Alaba ma BALDWIN Montrose 1-3-4165
Alabama BALDWIN ORANGE BEACH 1-3-4166
Alabam a BALDWIN Perdido 1-3-4167
Alaba ma BALDWIN Point Clear 1-3-4168
Alaba ma BALDI/I/IN ROBERTSDALE 1-3-3822
Alaba ma BALDWIN SILVERHILL 1-3-4171
Alaba ma BALDWIN SUMMERDALE 1-3-4175
Alaba ma BALDWIN Seminole 1-3-4169
Alab ama BALDWIN Spani sh Fort 1-3-4172
Alab ama BALDWIN Stapleton 1-3-4173
Alab am a BALDWIN Stockton 1-3-4174
Al abama BALDWIN own of Perdi<lo Beach 1-3-61
Alaba ma BARBOUR BLUE SPRINGS 1-5-4177
Alaba ma BARBOUR Bak er Hill 1-5-4176
Alabama BARBOUR Bak erhill 1-5-4176
Alaba ma BARBOUR CLAYTON 1-5-2520
Alaba ma BARBOUR CLIO 1-5-2160
Alabama BARBOUR Comer 1-5-4178
Alaba ma BARBOUR EUFAULA 1-5-330
Al abam a BARBOUR LOUISVILLE 1-5-2930
Al aba ma BARBOUR Spring Hill 1-5-4179
Alaba ma BIBB BREN 1-7-4181
Alaba ma BIBB Briertietd 1 -7-4182
Alaba ma
Al::ih m ;:1
BIBB
RI RR
CENTREVILLE
n.ri?.:P.n P nnti
1-7-3348
1 -7 ..41 /l'\ ...

10 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
US STATE TAXES VALUE DEFINITIONS
This report extracts the supported value definitions by state for the State Taxes card component.

Parameters
PARAMTER DESCRIPTION

State The name of the state to extract state taxes value definitions for. Select one or all states.

Report Columns
COLUMN DESCRIPTION

State The name of the state.

Geo Code The unique vertex geography code for the state. Supply this in Context1 on the CalculationValueDefinition record
for the State Taxes card component.

Prompt The prompt for the value definition.

Type The type of value definition, such as Flat Amount, Rate or Text.

Value Definition Name The name of the value definition. Use this value for the ValueDefinitionName attribute on the
CalculationValueDefinition record for the State Taxes card component.

Data Type The data type of the value definition, such as Number or String.

Validated by Lookup Type The lookup type used to validate the value definition. You can review valid lookup codes for the specified type
using the Manage Common Lookups task.

Report Definition Files

FILE TYPE FILE NAME

Data model US State Taxes Value Definitions.xdm.catalog

Report definition US State Taxes Value Definitions.xdo.catalog

These files are included in the BI Publisher Report - US State Taxes Value Definitions.zip file.

11 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
Example Output
Figure 2: US State Taxes Value Definitions

O R A C LE • Business Intelligence Search All ... Q. Advanced Administration OTBI Help Help • Sign

US State Taxes Value Definitions Home Catalog Fav orit es ,.. D ashb oards • New ,.. Open • Signed In As

State All ... App ly

State Taxes
Ora.cle Bl Publisher Dale: 2019°07-02 10:22:1 4 AM
'}
-- · I) G
..
P age 1 0 1 I
S l ate Geo Prompt Type Value Definition Name Data Validated by Lookup
Code Type Type
Alabama 1 Allowances Fial Allowa11ces Num ber
Amount
Alabama Addltiona l Tax Amount Flat Addltional Tax Amoun t Num be r
An ount
Alabama Number of Complete Flat Number of Complete Exemption Number
Exemption D ependents Amount Dependents
Alabama f iling Status Text Filing Status String RX_U S_STATE _FILI
G_STATUS_AL
Alabama Resi dent Wage Accumu lation Text Resident Wage Accumu lation String H RX_US_STATE_WA
GE_ACCUM
Alabama Exemption Amount Flat Exemplion Amount Number
Amount
Alabama Voluntar y Inco me Tax Text Voluntary Income Tax Wi thholding String YES _ 0
Withholding
Alabama Nonresident Text Nonres iden t String YES_NO
Alabama Exemp t from Slate Disability Text Exempt rom State Disability String YES_NO
Alabama Exempt from Stale Income Tax Text Exempt rom State Income Tax String YES _NO
Alabama Exemp tion for Military Spouse Text Exempt ion for Military Spouse String YES _NO
Alabama Exemp t from Wage Text Exempt from VI/age Accumulation String YES_NO
Accumu lation
Alabama Exempt from Stale Text Exempt rom Sl ate Unemployment String YES_ NO
Unemployment
Alabama Resident Stale !neon e Tax Rale Res i dent Sl ale Income Tax Number
Supplemental Rate Supplemental Ra1e
Al abama Resi dent Slate !neon e Tax Flat Re sident Staie Income Tax Num be r
Supp l emen tal Amotmt An ount Supplemental Amount
Alabama Resident Slate Income Tax Flat Res i dent Slate Income Tax Number
Regular Amount Amount Regul ar Amoun l
Alabama Resi denl Slate Income Tax R ate Res ident Stale In come Tax Num ber
Regu lar Rale Regular Rafe
Alabama Nonresident State Income Tax Rate Nonresident Stale Income Tax Number
Supplemental Rate Supplemental Rat e
Alabama Nonresident Slate Income Tax Rate Non residen t State Income Tax Numbe r
Regu l ar Rate Regul ar Ra fe
Alabama Nonresiden t Sl ate Income Tax Fla! Nonresident State Income Tax Numbe r
Supp lemen tal An1ount Amount Supplemental Amoun t
Alabama N onresident State Income Tax Flat Nonresident State Income Tax Number
Regula r Amount Amount Regul ar Amount
Ala ska 2 Resi dent Wage Accumulation Text Resi dent Wage Accumulalion String HRX_US_STATE_WA
GE_ACCUM
Alaska 2 Volun tary Income Tax Text Voluntary Income Tax Withholding String YES _ 0
Wllhho lding
A J ..,,,.. 1,- ..., ,, ..................; .......... Ta-" ..,..._,....
.,.,; ........ , c, 4 ,.;..,,. VCC'
'"

12 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
US INVOLUNTARY DEDUCTION VALUE DEFINITIONS BY ELEMENT
This report extracts the supported value definitions for the specified involuntary deductions element.

Parameters
PARAMTER DESCRIPTION

Legislative Data Group The name of the legislative data group to report on.

Element Name The name of the involuntary deduction element to report on.

State The US state for state-specific involuntary deduction elements, or ‘All’ to extract the value definitions for all states.

Select ‘N/A’ for federal involuntary deduction elements, such as bankruptcy, education loan, DCIA and federal tax
levy.

Report Columns
COLUMN DESCRIPTION

State The name of the state.

Geo Code The geography code for the state.

Value Definition Name The name of the value definition that must be supplied when uploading override values with HCM Data Loader.

Type The value definition type, such as Text, Rate, or Flat Amount.

Report Definition Files

FILE TYPE FILE NAME

Data model US Involuntary Deductions Value Definitions.xdm.catalog

Report definition US Involuntary Deductions Value Definitions.xdo.catalog

These files are included in the BI Publisher Report - US Involuntary Deductions Value Definitions.zip file.

13 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
Example Output
Figure 3: US Involuntary Deduction Values Definitions

O RACLE"rransactional BusinessIntelligence Search All • Q. Advanced Administration OTBI Help Help •

US Inv oluntary Deductions Value Definitions Home Catal og Fav orites ,.. Dashboards ,.. New • Open • Signed In As ...

Legislative Data Group ABC US LDG • Element Name ABC Child Support ... State All Y Apply

US Involu nta ry Deduct io...

Oracle Bl Publisher Date: 2019-07-29 2:37:14 AM

Page 1 Of ·1

Parameters

Legisl ati ve Dala Group Element Nam e State

ABC US LDG ABC Child Support All

State Geo Value Defmition Name Type

Code
Bankruptcy Order Total Ovied Amoun l f lat Amount
Federal Minimum Wage f lat An ount
Tax Le vy Additional Allowances f lat Amoun t
Tax Levy Additional Order Amount Flat Amount
Tax Levy Deductions At li me of Writ Aner-Tax Amount Flat Amount
Tax l evy Deductions Al li me of Wri1 After-Tax Rate Rate
Tax Le vy Deductions At Time of Wri1 Defe rred Compensation Rate Rate
Tax l evy Deductions At Trrne of Writ Pretax Amount Flat Amount
Tax Le vy Deductions At Time of Writ Pretax Ra te Rate
Tax Levy Exemption Percentage Rate
Tax Levy Replacement Order Amount f lat An ount
Tax Levy Total Allowances Flat Antount
Alabama Alabama Child Support Add ional Order Am ount Flat Amount
Alabama Alabama Child Support Exemption Percentage Rate
Alabama Alabama Child Support Initial Fee Amount Flat An ount
Ala bama Alabama Child Support Max imum Organization Fee Per M onth Amount Flat An ount
Ala bama Alabama Child Support Ma ximum Organization Fee Per Year Amount Flat An ount
Alabama Alabama Child Support Max imum Processing f ee Per Month Amount Flat Amount
Alabama Alabama Child Support Max imum Processing fee Per Order Amount Flat Amoun t
Al abama Alabama Child Support Max imum \Nithholding Amount Flat Amount
Alabama Alabama Child Support Max imum \Nithholding Duration Days Flat An ount
Alabama Alabama Child Support Organiza tion Fee Amount Fial An ount
Ala bama Alabama Child Support Processing Fee Per Pay Period Amount Flat An ount
Alabama Alabama Child Support Prolec ted Pay Amount Flat Amount
Alabama Alabama Child Support Repla.cemen t Order Amount Flat Amount
Alabama Alabama Child Support State Minimum Wage Calculation Rule Text
Ala bama Alabama Child Support State Minimum Wage Facto r F lat Amount
Alabama Al abama Child Support Total Wrthholding Amount Flat Amount
Alabama Alabama Child Support Total Wrthho td ing R ate Rate
Alabama 1 Alabama State Minimum Wage Flat Amount
Alask a 2 Alaska Child Support Add iti onal Order Amount Flat An ount
Alaska 2 Al aska Child Support Exemption Percentage Rate
Alaska 2 Alaska Child Support Initial Fee Amount Flat An ount
Alaska 2 Alaska Child Support Maximum Organization fee Per Month Amount Flat An ount
Alaska 2 Alaska Child Support Maximum Organization fee Per Year Amount Flat Am ount
Alaska 2 Alaska Child Support Maximum Processing Fee Per Month Amoun t Flat Am ount
Alaska 2 Alaska Child Support Maximum Processing Fee Per Order Amount Flat Amount
Alaska 2 Alaska Child Support Maximum Withholding Amount Flat An ount
Alaska 2 Alaska Child Support Maximum Withholding Duration Days Flat Ani ount
Alaska 2 Alaska Child Support Organization Fee Amount Flat Amount
Alaska 2 Alaska Child Support Processing Fee Per Pay Period Amount f lat Amoun t
Alaska 2 Alaska Child Support Protected Pay Amounl Flat An ount
Aliii ? Afil k .;:i C"' h i1'1 11nn nrt R P..o l;ar.P.m Fm f OrriRr Am rn1n t F l.;::Jf Am n11nt

14 Loading US Data with HCM Data Loader: Supporting BI

Publisher Reports
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 WITH 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 © 2019, 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. 0719
Loading US Data with HCM Data Loader: Supporting
BI Publisher Reports
July 2019