HCM Cloud

Inbound Interface
Technical Design Document

Dividend Equivalent Feed from UBS

Document Control

Date Author Version Revision Description

08/01/2017 Ian Abastillas 0.1 Initial Draft

Update TD base on review points during Integration

08/18/2017 Ian Abastillas 0.2
Requirements & Technical Design Working Session

09/14/2017 Ian Abastillas 0.3 Update Error Log and Error Log Email Sections

09/18/2017 Ian Abastillas 0.4 Add Current File initial processing for Boomi.

Update Section #4 to remove Division and Summay

09/22/2017 Ian Abastillas 0.5
Report Layout

Add Extract Definition to data of Cost Center and ROE

09/26/2017 Ian Abatillas 0.6
using BI Report

10/06/2017 Ian Abastillas 0.7 Refine TD

Update the Amount in Local Currency to 2 decimal

02/06/2018 Maricar Gomez 0.8
places.

Updated the new Input file layout for PBL load

02/09/2018 Juan Carlo Culibra 0.8
Addition of Apache Date in the input file.

Project HeRO Dividend Equivalent Feed from UBS 2

 Date Author Version Revision Description

Updated the following:

1. The parameter to be used when running the

BI Report from TrnDate to ApacheDate.

2. The Vendor Input File Detail Record

Validations section to use ApacheDate
instead of TrnDate.

3. Added a validation for the ROE wherein If no

exchange rate (ROE) is pulled by the BI
Report, then an error notification email will
be sent.
07/27/2018 Gene Carino 0.9
4. The EffectStartDate attribute to derive its
value from the ApacheDate instead of the
TrnDate from the input file.

5. The Amount attribute when currency is not

equal to ‘USD’ , it will derive the Local
Currency Amount using the ApacheDate
instead of TrnDate.

6. The Amount in Local Currency under the

Summary Report section to derive its value
using the ApacheDate instead of TrnDate.

Project HeRO Dividend Equivalent Feed from UBS 3

1. Overview

The purpose of this document is to provide a detailed functional design of the interfaces required for Project
HeRO, the TI HCM Cloud Implementation Project.

Interface Details

SR# 63
Short Title Dividend Equivalent Feed from UBS
Description Dividend Equivalent Feed from UBS
Interface Type Inbound
Integrating Application UBS

Encryption Required? Yes

Encryption Method PGP

2. Integration Method

This section provides the details on the methods and impacted business objects on where the data will be
loaded.

Integration Method

Method Payroll Batch Loader

Workbook Object Element Entry
Workbook Object
Templates Create Element Entry

Invoke via Flow Action web service

Project HeRO Dividend Equivalent Feed from UBS 4

 Input File Encryption? Yes
Encryption Method PGP

3. Extract Definition

This section will identify the User Entity associated with the data group of this extract. A reference to the
common data category superset document is also provided.

HCM Extract Details

Extract Name N/A

Extract Type Full Profile
Description Cost Center Details of Every Employee of Texas Instrument in HCM

User Entity Used N/A

Root Data Group N/A

Shared Folder/Custom TI
Schema Report/Integration/ZUBSDE/ZUBSDE_TI_CONS_CENTER_RPT.xdo

Use $ApacheDate from Input File as the value for the criteria.
Processing Type Full

Sample BI Report Output:

PERSON_NUMBER,COST_CENTER,ROE

0000616,003,1

0002771,003,1

0006120,003,1

0011451,003,1

Project HeRO Dividend Equivalent Feed from UBS 5

 0011470,003,1

4. Assumptions

This section details out the set of assumptions captured for this interface that will serve as a guide for the
scope and limitations of the integration.

# Assumption(s)
1 The Dividend equivalent payments file provided by UBS is pipe delimited and the payment amount is
in USD for all employees.
2 The integration will need to determine if it is a US employee or not.

a. The load will contain Active, Terminated, & Leaves. The dividend is to be paid for all
employees loaded.

b. Processing of US payroll on cycle or off-cycle should not affect the integration as long as
element are loaded

3 For non-US employees, amount will be converted from USD to the user’s local currency and load into
the countries corresponding element.

If the integration cannot convert, then it should not load the Non US employees but should instead
parse out the data and log or save into a file that can be emailed to the equity team. The file needs to
include the employees current currency and country.

a. Non-U.S. payouts are converted to local currency based on the employee’s current payroll
currency and a 12/1 ROE unless local country rules require the use of an ROE per that
countries bank.

4 The summary report should be generated for finance in USD and local currency.

Project HeRO Dividend Equivalent Feed from UBS 6

 Key fields to provide are :

 EmployeeID

 Division (3 digits; derived from Cost Center/dept)

 Country

 Amount in USD

 Amount in local currency”

5. PBL Input File Layout, Mapping and Transformations

This section will contain the details on how the PBL Input file template should be created. It will also
contain

Notes:
(1) All discriminators that fall under one Business Object should be contained on one PBL Template (.dat) file.
Filename should be the Business Object name (i.e. [Link]).
(2) Zip file must contain all the Business Object files

5.1. Current Input File Layout and Mapping

This section contains details of the current input file being received from the vendor.

Sample Input File Path: /usrdata/hris/vendortmp/UBS/dividend_equivalent_mocked_version.txt

Sample Input File:

 This is the Current Input File layout of Dividend Equivalent Payments in Pipe Delimited that was
provided by UBS and amount is in USD.

Project HeRO Dividend Equivalent Feed from UBS 7

  Below are the proposed input file layout to include the 3 (three) additional fields, Boomi will generate
this file and broken down by Country and Division.

- Expat Flag

- Current/Work Currency

- Current/Work Country

Field Max
Field Format Oracle Field Comment
# Length

HDR|TXN|001|MMDDYYYY|[Link]|DVDN
Header
D

Person
1 Emplid Alphanumeric 10
Number

2 Name Alphanumeric No max

Payment
3 Numeric No max
Amount

Y or N; Y =
4 Expat Flag Alphanumeric
expat

Employees
Employee
current
5 Current Alphanumeric
Currency
Currency
Code

Employees
Employee
current
6 Current Alphanumeric
country
Country
location

TRL|TXN|001|MMDDYYYY|[Link]|DVDND
Footer
|# records|total $ amount

Project HeRO Dividend Equivalent Feed from UBS 8

  Below are the Current Summary Report Layout that is provided to Finance in USD.

Input File Mapping:

Source Application/Database PeopleSoft

File Format Pipe Delimited

File Name Format [Link]

Header Records

Field Order Table Field Name Variable Value

1 - $LineID ‘HDR’

2 - $Company ‘TXN’

3 - $CompCd ‘001’

4 - $TrnDate --

5 - $TrnTime --

6 - $DistribName ‘DVDND’

Detail Records

Field Order Table Field Name Variable Value

1 - $Emplid --

2 - $Name --

Project HeRO Dividend Equivalent Feed from UBS 9

 3 - $PayAmt --

4 - $ExpatFlg --

5 - $EmplCurr --

6 - $EmpCountry --

Footer Records

Field Order Table Field Name Variable Value

1 - $LineID ‘TRL’

2 - $Company ‘TXN’

3 - $CompCd ‘001’

4 - $TrnDate --

5 - $TrnTime --

6 - $DistribName ‘DVDND’

7 - $RecCnt --

8 - $TotalAmt --

Summary Report Records for Finance

File Format CSV

File Name Format [Link]

Field Order Table Field Name Variable Value

1 - $Enplid --

2 - $Division --

3 - $Country --

4 - $AmtUSD --

5 - $AmtLoc --

Project HeRO Dividend Equivalent Feed from UBS 10

 5.2. Current Input File Layout Initial Processing.
a. Boomi will remove Header and Footer lines

b. Boomi will add new field (Transaction Date from Input File) at the end of each detail records.

c. Boomi will Generate new file and will be broken down by Country.

d. Boomi will add new field $ApacheDate (value from apache card, ‘YYYYMMDD’ format) after
$TrnDate.

NEW FILE LAYOUT FOR PBL LOAD

File Format Pipe (|)

File Name [Link].vendor_<country>

Field Order Table Field Name Variable Value

1 - $Emplid --

2 - $Name --

3 - $PayAmt --

4 - $ExpatFlg --

5 - $EmplCurr --

6 - $EmpCountry --

7 - $TrnDate --

8 - $ApacheDate --

5.3. Validations Required in Loading Dividend Equivalent file:

This section contains details of the new input file to be created from the input file received from the vendor.

Business Object Element Entries

PBL Template File Name N/A

Delimiter N/A

Project HeRO Dividend Equivalent Feed from UBS 11

 File Location UCM (HCM Connect)

PBL Input file layout N/A

File Validations – Monday - Friday

Vendor Input File Header Record N/A

Validations

Vendor Input File Validate each Detail Records based on below criteria

Detail Record Validations

 IF $ExpatFlg = ‘Y’
OR $EmpCountry = ‘ISR’
THEN Generate Error Log save to file.

 IF $ExpatFlg = ‘N’
AND $EmpCountry <> ‘ISR’
AND $EmplCurr <> ‘USD’ THEN
Retrive the value from BI Report using $ApacheDate
to determine the exchange rate and use it with $PayAmt to
convert the value to Local Currency Amount.
*Note:
The BI Report includes a criteria to pull data when ROE (rate of
exchange) date is the same with the apache date. If this
condition is not satisfied, the BI Report will not return any
data. Boomi needs to identify this scenario and trigger email
notification stating that there is no ROE loaded for the day.
(See the second email details under the email notification
section for details)

Vendor Input File N/A

Trailer Record Validations

5.4. Loading of Dividend Equivalent Payments by Employee:

This section contains details of the new input file to be created from the input file received from the
vendor. Load amount to element based on employee current country.

Project HeRO Dividend Equivalent Feed from UBS 12

 Discriminator: Create Element Entry

Business Object Element Entry

Discriminator Create Element Entry

(1) Retrieve the element name.

a. TI_GET_ELEMENT_NAME value set will be use to retrieve the element name
in TI_PBL_ELEMENT_CROSSWALK UDT using the following values..
1. Assignment HOME country code
2. Zscript name
3. Apache date
b. For US, retrieve value as element name.
c. For Non US, concatenate the country code with the value for the element
name,

UDT structure:

General
Validation

Project HeRO Dividend Equivalent Feed from UBS 13

 PBL Template Vendor
Transformation Logic
Attributes Layout/Fields

Element Entry Hardcoded Value: Element Entry

Create Element
Hardcoded Value: Create Element Entry
Entry

Derived Use $Emplid from vendor file to pull Assignment ID from the
Assignment
TI_GET_ASSIGNMET_NUMBER value set as of the apache date which is
Number
included in fast formula.

$ApacheDate Retrieve value from input file

EffectiveStartDate Format: YYYY/MM/DD

EffectiveEndDate Derived Null - This will be auto populated with the pay period end date.

Derived For US Employees on File.

Value: ‘E B Div Equiv’

For Non-US Employee on the File

Value: ‘xxx Div Equiv’

Element Name
(where xxx = a 3 (three) digit Assignment Home Country Code taken
from Value Set)

The element name will be retrieved based on Assignment Home Country Code.

Refer to the value returned on the General Validations section.

Derived Value: UBS || - || Current date

Reason
Where Current date format is YYYYMMDD

Project HeRO Dividend Equivalent Feed from UBS 14

 Ex: UBS-20170619

Use $Emplid from vendor file to pull Assignment Employee Salary Code
then evaluate

If value is ‘USD’

Retrieve data from $PayAmt

Amount
otherwise

Retrive the value from BI Report using $ApacheDate to determine the

exchange rate and use it with $PayAmt to convert the value to Local
Currency Amount.

5.5. Output File Layout and Mapping.

4.4.1. Summary Output File Layout

The details of the summary report below will be retrieved from the New Input File broken down by
Country and Division. The summary report should be generated for finance in USD and Local Currency.

Boomi will use BI Report to pull the details of Cost Center to be use on this Summary Report.

Key fields to provide are:

 Employee ID

 Division (3 digits; Derived from Cost Center/Dept)

 Country

 Amount in USD

 Amount in Local Currency

Project HeRO Dividend Equivalent Feed from UBS 15

 Summary Report

File Name [Link]

File Format CSV

File Location N/A

Transformation/Business Logic
HCM Cloud
Vendor Layout Extract Field Data
Attribute Extract Filter Criteria
Transformation

Retrieve value from $Emplid in the input

Employee ID Derived
file.

Retrieve value from Cost_Center from BI

Division Derived
Report.

Retrieve value from $EmpCountry in the

Country Derived
input file.

Retrieve value from $PayAmt in the

Amount in USD Derived
input file.

Retrive the value from BI Report using

$ApacheDate to determine the exchange
rate and use it with “Amount in USD” to
convert the value to Local Currency
Amount in Local Currency Derived Amount.

*Note: Round of the value to 2 decimal

places.

Project HeRO Dividend Equivalent Feed from UBS 16

6. Error Log

This section will define the mappings, transformations and/or details of the Error log and email notification
to be sent. This will be done by Fast Formula in HCM.

Log Data Details

Filename N/A

File Format N/A

Vendor Layout Field HCM Cloud Attribute Transformation Logic

Header Records

LineID Derived
Retrieve value from $LineID in the input file.
Company Derived
Retrieve value from $Company in the input file.
CompCd Derived
Retrieve value from $CompCd in the input file.
TrnDate Derived
Retrieve value from $TrnDate in the input file.
TrnTime Derived
Retrieve value from $TrnTime in the input file.
DistribName Derived
Retrieve value from $DistribName in the input file.
Detail Records

Emplid Derived
Retrieve value from $Emplid in the input file.
Name Derived
Retrieve value from $Name in the input file.
PayAmt Derived
Retrieve value from $PayAmt in the input file.
ExpatFlg Derived
Retrieve value from $ExpatFlg in the input file.
EmplCurr Derived
Retrieve value from $EmplCurr in the input file.
EmpCountry Derived
Retrieve value from $EmpCountry in the input file.
Footer Records

LineID Derived
Retrieve value from $LineID in the input file.
Company Derived
Retrieve value from $Company in the input file.

Project HeRO Dividend Equivalent Feed from UBS 17

 CompCd Derived
Retrieve value from $CompCd in the input file.
TrnDate Derived
Retrieve value from $TrnDate in the input file.
TrnTime Derived
Retrieve value from $TrnTime in the input file.
DistribName Derived
Retrieve value from $DistribName in the input file.
RecCnt Derived
Retrieve value from $RecCnt in the input file.
TotalAmt Derived
The summation of $PayAmt from Detail Records.

7. Error Log Email Details

This section will define the mappings, transformations and/or details of the email notification to be sent.

Email Details or Parameters

Criteria Transformation

Email Trigger
When annual file is received and processed
Email From
[Link]@[Link]
Email To
soauditors@[Link]
Email CC
N/A
Value is “Inbound Process
Subject
ZUBSDE_TI_PBL_LOAD_AND_TRANSFER_BATCH Completed”

Attachment File
N/A
Name

Value: “Inbound Process

ZUBSDE_TI_PBL_LOAD_AND_TRANSFER_BATCH Completed”

Email Body
In Order to access process output and logs - kindly refer to
the procedure document
[Link]
[Link]?id=/sites/hroperations/hero/Technology/Integr

Project HeRO Dividend Equivalent Feed from UBS 18

 ation/Technical%20Designs/04-
Final/PBL%20Log/How%20to%20find%20ESS%20Log%20an
d%20Output%20File%20Details%20for%20a%20PBL%20Pr
[Link]&Source=https%3A%2F%2Fsps09%2Eitg%2Eti%
2Ecom%2Fsites%2Fhroperations%2Fhero%2FTechnology%2
FForms%2FAllItems%2Easpx%3FRootFolder%3D%252Fsites
%252Fhroperations%252Fhero%252FTechnology%252FInte
gration%252FTechnical%2520Designs%252F04%252DFinal
%252FPBL%2520Log%26InitialTabId%3DRibbon%252EDoc
ument%26VisibilityContext%3DWSSTabPersistence&DefaultIt
emOpen=1

Email Details or Parameters

Criteria Transformation

The BI Report includes a criteria to pull data when ROE (rate of

exchange) date is the same with the apache date.
Email Trigger If this condition is not satisfied, the BI Report will not return any
data.
Boomi needs to identify this scenario and trigger email notification
stating that there is no ROE loaded for the day.
Email From

Email To
esppadmin@[Link]
Email CC
compsys@[Link]
Subject Dividend Equivalent Payments feed - no match on ROE date.

Attachment File
N/A
Name

The Dividend equivalent payment feed cannot process because the

ROE for the same process date has not been loaded. Please
Email Body confirm the ROE data has been loaded with an ROE date and
values equal to the run date. Once complete, work with IT to re-
run this process

Project HeRO Dividend Equivalent Feed from UBS 19

 8. Summary Reports Email Details
This section will define the mappings, transformations and/or details of the email notification to be sent.

Email Details or Parameters

Criteria Transformation

Email Trigger
When annual file is received and processed
Email From
[Link]@[Link]
Email To
soauditors@[Link]
Email CC
N/A
Subject
Annual Dividend Equivalent Summary Report
Attachment File
Name DEQ_PBLSummary.txt

Email Body Attached is the summary report for Annual Dividend Equivalent
load.

9. Execution

This section will define the execution frequency and attributes.

Execution Details

Frequency Annual

Payroll Flow name

Payroll Flow Name ZUBSDE_TI_PBL_LOAD_AND_TRANSFER_BATCH

Parameter Value Details

Content ID UCM ID – This is the UCM ID of the vendor file.

Transformation
TI_ ZUBSDE _BATCH_LOAD_FF
Formula

Project HeRO Dividend Equivalent Feed from UBS 20

 Process Configuration
ElementEntryLock
Group

SFTP Parameters/Details

HCM Public PGP Key

fusion-key_pub.asc

Vendor Private Key TBD – PGP Key to be provided by the client team

Source System UBS

TI Point Of Contact TBD

Vendor Point Of
TBD
Contact

10. RAID log items

This section will include any related RAID log decisions.

ID Source Title Item Description Work stream Owner Date Due Status Updates/Next
Type Create Date Steps
d
DDMM Initials:
Action Verb
(Newest Updates at
Top)

N/A

Project HeRO Dividend Equivalent Feed from UBS 21

11. Test Scenarios

This section will include any relevant testing scenarios that needs to be accounted for during Test phases.

ID Test Condition Expected Result

1 Load Required attributes and needed Business Successfully loaded attributes required and
Objects business objects needed

2 Validate that the input file is successfully Input Data are loaded successfully in Fusion.
processed by the middleware and is loaded
successfully into Fusion.
3 Verify that the integration is able to insert new New Data are being inserted successfully into
Data into Fusion. Fusion.
4 Verify that the integration is able to Update Existing Data are being updated successfully into
existing data into Fusion. Fusion.

Project HeRO Dividend Equivalent Feed from UBS 22