Standard Integration SF SAP

Integration Guide | PUBLIC
Document Version: 1H 2022 – 2022-10-14
Standard Payroll Integration Template for SAP

SuccessFactors Employee Central
© 2022 SAP SE or an SAP affiliate company. All rights reserved.
THE BEST RUN

Content
1 Change History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1 Standard Payroll Integration Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Integration via Process Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
3 Employee Data Replication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.1 Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configurations for Compound Employee API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Preparations Required at Third-Party Provider's End. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.2 Integration Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Person Information [Employee Central hris-element-id: personInfo]. . . . . . . . . . . . . . . . . . . . . . . . . . 9
Personal Information [Employee Central hris-element-id: personalInfo]. . . . . . . . . . . . . . . . . . . . . . .10
Address Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Phone Information [Employee Central hris-element-id: phoneInfo]. . . . . . . . . . . . . . . . . . . . . . . . . . 11
Email Information [Employee Central hris-element-id: emailInfo]. . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Employment Information [Employee Central hris-element-id: employmentInfo]. . . . . . . . . . . . . . . . . 13
Compensation Information [Employee Central hris-element-id: compensationInfo] . . . . . . . . . . . . . . 15
Pay Compensation Recurring Information [Employee Central hris-element-id:
payCompensationRecurring]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Pay Compensation Non-Recurring Information [Employee Central hris-element-id:
payCompensationNonRecurring] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Pay Compensation Deduction Recurring Information [Employee Central hris-element-id:
deduction_Recurring]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Pay Compensation Deduction Non-Recurring Information [Employee Central hris-element-id:
deduction_non_Recurring]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Alternative Cost Distribution [Employee Central hris-element-id: alternative_cost_distribution]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
National ID Card. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Dependents Information [Employee Central hris-element-id: PerPersonRelationship]. . . . . . . . . . . . . 19
Direct Deposit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3 Integration Process Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.4 Getting Access to the Process Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
3.5 Setting Up the Standard Data Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Connection Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Process Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
Cross-Reference Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.6 Output File Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Standard Payroll Integration Template for SAP SuccessFactors Employee Central

2 PUBLIC Content
4 Example Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4.1 Specification of an Example Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
4.2 Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
5 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
5.1 Country-Specific Mapping of Address Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Content PUBLIC 3
1 Change History
Learn about changes to the documentation for Standard Payroll Integration Template for SAP SuccessFactors
Employee Central in recent releases.
1H 2021
Type of Change Description More Info
New / Added / Changed
New / Added / Changed
2H 2020
The following table summarizes changes to this guide for the 2H 2020
What's new Description More Info
Added a note under Standard Payroll This change is applicable to the 2H 2020 Standard Payroll Integration Template
Integration Template. preview environment only. [page 5]
1H 2020
The following table summarizes changes to this guide for the 1H 2020
What's new Description More Info
No changes There are no updates to this document.

4 PUBLIC Change History
2 Overview
This guide is for Professional Services, SAP consultants, and partner consultants to integrate SAP SuccessFactors
Employee Central with any payroll provider.
Integration is through the process library. This is not an out-of-box solution to integrate with any payroll provider.
The process library is a collection of modules (standalone design patterns) that can be used to integrate Employee
Central with payroll providers, with some modifications and manual mapping to achieve the provider-specific
integration use case.
For more information about Employee Central, see the Employee Central Master document https://help.sap.com/
viewer/b14dd15ca58f43e0856184a740a4b212/latest/en-US on SAP Help Portal at https://help.sap.com/viewer/
index → SAP SuccessFactors Employee Central.
2.1 Standard Payroll Integration Template
Standard payroll integration is a template process with a collection of standalone generic functionalities that can be
used by consultants to build Employee Central integrations with any third-party payroll provider.
This process is to be treated as a template with a collection of generic modules to build a provider-specific
integration process. It is not an executable process. The modules must be chosen based on the provider’s
requirements and with little custom development (like certain provider-specific logic). The process is to be
developed and only then executed. The standard process cannot be consumed directly.
Dell’s Boomi is used as middleware to integrate Employee Central with payroll providers via a CSV file or XML file.
These outbound files (CSV or XML) contain data only for those employees that have undergone a change/
modification in the Employee Central system since the previous execution of the Boomi process. During the initial
run, the process fetches all changes in the system; for subsequent runs, it fetches only the changes since the last
run.
 Note
Whenever you run a query using the Compound Employee API, ensure that the timestamp is not older than
three months from the current date. In case, the timestamp is older than three months, an error is logged. This
change is applicable to the 2H 2020 preview environment only.
The outbound file contains only one type of record that comprises the entire employee data.
 Note
Separate mapping is required for fields that are country-dependent (for example, Ethnicity). Accommodating
mapping for each country-specific field would not be feasible. Hence, some manual effort is required to adapt
this process to a specific country. As a standard, this process has been adapted to work for the USA.

Overview PUBLIC 5
2.2 Integration via Process Library
Use the following steps as a guideline to successfully integrate Employee Central with the payroll provider. This is a
simplified approach to a possible integration process. You have to determine your provider’s business
requirements. Based on their requirements, you will need to adjust these processes.
Using the Integration Solution as a Process Library
1. Set up Employee Central.

2. Make third-party provider-specific settings.
3. Get access to the Boomi process library.
4. Install the process library.
5. Modify/develop the process as per the provider’s requirements.

6 PUBLIC Overview
3 Employee Data Replication
The replication of employee master data from Employee Central to any payroll provider uses the compound
employee service from Employee Central. The data used for replication contains the following elements.
For Information on Compound Employee Element Structure

… See Employee Central hris-element
Person Information Person Information [Employee Central hris-element-id: per

sonInfo] [page 9]
Personal Information Personal Information [Employee Central hris-element-id: per

sonInfo] [page 10]
Address Information Address Information [Employee Central hris-element-id: ad

dressInfo] [page 11]
Phone Information Phone Information [Employee Central hris-element-id: pho

neInfo] [page 11]
Email Address Information E-Mail Information [Employee Central hris-element-id: emai

lInfo] [page 12]
Employment Information Employment Information [Employee Central hris-element-id:

employmentInfo ] [page 13]
National ID Card National ID Card [page 16]
3.1 Prerequisites
3.1.1 Configurations for Compound Employee API
The compound employee API extracts employee data from Employee Central and returns it in a (normalized)
hierarchically structured response XML (root node: employee person data).
Choose your regional API endpoint from the following table:

Employee Data Replication PUBLIC 7
Location End Point
Europe https://api.successfactors.eu/sfapi/v1/soap
USA, New Jersey https://api.successfactors.com/sfapi/v1/soap
USA, Arizona https://api4.successfactors.com/sfapi/v1/soap
Get the generic WSDL by adding ?wsdl to the above addresses, for example,
https://api.successfactors.eu/sfapi/v1/soap?wsdl
Apart from the endpoints, an XML schema is provided that describes the XML response of the compound API
including all substructures and elements. The XML schema is required for integration purposes. The new API
provides only the query and the queryMore operation. All other operations such as list, describe, and describeEx
are not supported.
You may have to make more settings for the following:
• Web service setup.

Follow the standard process [page 35]for SF APIs to set up SF API operations login and logout and to enable
the API.
• Thresholds and limits
The compound employee API has similar thresholds and limitations as the other SF APIs. You can set this
number to a value between 1 and 800 by specifying the maxRows parameter in the query method.
• API enhancements and compatibility
The API response message type can be enhanced with additional elements and attributes. Additional elements
and attributes can be supplied by SAP SuccessFactors by using custom fields. The external application must
be able to process the extended response successfully. The API request message type can be enhanced by
query string parameters (for example, an additional parameter for selecting or filtering data). Enhancements of
request message types and parameters are always optional. The system does not require the external
application to provide optional values and parameter in the request.
3.1.2 Preparations Required at Third-Party Provider's End
Once a customer opts for a particular third-party payroll provider, the customer should sync on the following points
for initial setup preparations to be done at the third-party provider's end:
• Functional preparation, for example, availability of a document such as Discovery and Requirements Gathering
• Payroll setup
• Technical setup of employee file
• SFTP server configuration

8 PUBLIC Employee Data Replication
3.2 Integration Specification
The following tables list the Employee Central fields that are required to replicate data using the Boomi middleware
to any payroll provider. They also show which fields you need to map manually (in the case of country-specific
fields) and the corresponding picklist IDs. You will also find descriptions of the mapping activities that are required
for different fields.
3.2.1 Person Information [Employee Central hris-element-id:

personInfo]
Employee Central Obligatory for Code Mapping Re Payroll Provider

hris Field Description Replication quired? Picklist ID Attribute
date_of_birth Date of Birth Employee Date of

Birth
person_id_external Employee Identifi- Person ID External

cation Number –
External
person_id Employee Identifi- Person ID

cation Number –
Internal
country_of_birth Country of Birth Employee Country

Of Birth
birth_name Birth Name Employee Birth

Name
place_of_birth Place Of Birth Employee Place Of

Birth

3.2.2 Personal Information [Employee Central hris-element-id:
personalInfo]
Picklist ID/
Employee Cen Obligatory for Code Mapping Constraint/ Cross-Refer Payroll Provider
tral hris Field Description Replication? Required? Constant Value ence ID Attribute
start_date Personal Infor Personal Infor

mation Start mation Start
Date Date
marital_status Marital Status Marital Status Marital Status
first_name First Name Employee First

Name
last_name Last Name Employee Last

Name
middle_name Middle Name Employee Mid

dle Name
suffix Suffix Suffix Employee Name

Suffix
salutation Salutation Salutation Employee Salu

tation
gender Gender Gender Employee Gen

der
Marital Status
These values are mapped in Boomi via the cross-reference table Marital Status. This table must be filled by the
consumer based on the Employee Central picklist and the provider’s values. Default mapping values are available.
Gender
These values are mapped in Boomi via the cross-reference table Gender. This table must be filled by the consumer
based on the Employee Central picklist and the provider’s values. Default mapping values are available.
Suffix
These values are mapped in Boomi via the cross-reference table Suffix. This table must be filled by the consumer
based on the Employee Central picklist and the provider’s values. Default mapping values are available.
Salutation
These values are mapped in Boomi via the cross-reference table Salutation. This table must be filled by the
consumer based on the Employee Central picklist and the provider’s values. Default mapping values are available.

3.2.2.1 Personal Information USA [Employee Central hris-
element-id: personalInfo]
Employee Central Obligatory for Code Mapping Re Picklist ID/ Cross- Payroll Provider
hris Field Description Replication quired? Reference ID Attribute
genericString1 Ethnic Origin Ethnicity Ethnicity Code
Ethnic Origin
These values are mapped in Boomi via the cross-reference table Ethnicity. This table must be filled by the
consumer based on the picklist and the provider’s values. Default mapping values are available.
3.2.3 Address Information
Picklist ID/
Employee Cen Obligatory for Code Mapping Constraint Cross-Refer Payroll Provider
tral hris Field Description Replication Required? Value ence ID Attribute
address-type Address Type 'home'
start_date Address Start Home Address

Date Start Date
state State Home Address

Postal Region/
State/Province
zip_code ZIP Code Home Address

Postal Code
country Country Home Address

Country
Address Fields
The mapping of the Employee Central fields address1-20 is country-dependent. Based on the country, these fields
are mapped to the appropriate payroll provider attributes. See also Country-Specific Mapping of Address Fields.
3.2.4 Phone Information [Employee Central hris-element-id:

phoneInfo]
For phone Information, a constraint is specified in the Boomi mapping, which transfers the phone information
depending on phone_type.

A script is defined in the Boomi mapping, which maps a phone number with type H (home) to Employee Home
Phone, a phone number with type C (cell) to Employee Personal Mobile Phone, and a phone number with type B
(business) to Employee Business Phone.
Picklist ID/
tral hris Field Description Replication? Required? Value ence ID Attribute
phone_type Phone Type X H = Home, B =

Business, C =
Cell
phone_number Phone Number X Employee Home

Phone/ Em
ployee Business
Phone/ Em
ployee Personal
Mobile Phone
area_code Area Code
Phone Number
The Employee Central fields area_code and phone_number are mapped to the fields Employee Home Phone,
Employee Personal Mobile Phone, or Employee Business Phone, depending on phone_type, via a build 10-digit
phone number function. This user-defined function builds a 10-digit phone number by using both the area code and
phone number. It does this in the following steps:
1. String Append
Appends the phone number to the area code.
2. String Remove
Removes any unwanted characters.
3. Right Character Trim
Trims the phone number from the right while keeping the length fixed to 10.
3.2.5 Email Information [Employee Central hris-element-id:

emailInfo]
For email information, a constraint is specified in Boomi, which transfers the email information depending on
email_type.
A script in the Boomi mapping maps an email address with type P (personal) to Employee Personal Email, and an
email address with type B (business) to Employee Business Email.

Picklist ID/
tral hris Field Description Replication? Required? Value ence ID Attribute
email-address Email Address Employee Per

sonal Email/
Employee Busi
ness Email
email-type Email Address P = Personal

Type
B = Business
Email Address Type
The Employee Central field email-address is mapped to the field Employee Personal Email or Employee Business
Email in the provider file, depending on the email address type. The field email-type can have the following values:
• P = personal
• B = business
3.2.6 Employment Information [Employee Central hris-

element-id: employmentInfo]

hris Field Description Replication? quired? Picklist ID Attribute
user_id User ID User ID
start_date Start Date Employment Start

Date
end_date End Date Employment End

Date
originalStartDate Original Start Date Original Hire Date
salary_end_date Salary End Date Salary End Date
payrollEndDate Payroll End Date Payroll End Date
lastDateWorked Last Date Worked X Last Date Worked
firstDateWorked First Date Worked First Date Worked
Last Date Worked
The Employee Central field lastDateWorked is mapped to the field Last Date Worked in the provider file via a script.
The script populates this value only if the employee is active in the Employee Central system.

3.2.6.1 Job Information [Employee Central hris-element-id:
jobInformation]
Picklist ID/
Employee Cen Obligatory for Code Mapping Constraint/ Cross-Refer Payroll Provider
tral hris Field Description Replication? Required? Constant Value ence ID Attribute
location Location
department Department
division Division
start_date X Position Start

Date/Job Start
Date
end_date Employee’s Ter X Termination

mination Date Date
created_on X
company Company
business_unit Business Unit
cost_center Cost Center
employee_type Employee Type
employ Employment
ment_type Type
event_reason Employee’s X Event Reason/

Hire/ Termina Termination
tion Reason Reason
timezone Timezone Timezones Timezone
flsa_status FLSA Status
shift_code Shift Code
shift_rate Shift Rate
emplStatus X
event X
payroll_event Payroll Event Payroll Event
Termination Date and Termination Reason

The following Employee Central fields are mapped to the fields Termination Date and Termination Reason in the
provider file via a scripting function:
• eventReason
• enddate
• emplStatus
This function maps eventReason and endDate directly to Termination Reason and Termination Date if EmplStatus
is T (terminated).
Event and Event Reason
The following Employee Central fields are mapped to the field Event and Event Reason in the provider file via a
scripting function:
• eventReason
• event
• start_date
• created_on
If the created_on timestamp is greater than the last_execution_timestamp, and if the event is H, this function maps
the event directly to Event, and maps eventReason to Event Reason in the provider file.
3.2.7 Compensation Information [Employee Central hris-

element-id: compensationInfo]

start_date Effective Date of Compensation

Employee’s Salary Start Date
Payroll_id Payroll Number Payroll Number

That Employee Be
longs To
pay_group Employee’s Pay Pay Group Pay Group

Group
pay_type Pay Type Pay Type Pay Type

3.2.8 Pay Compensation Recurring Information [Employee
Central hris-element-id: payCompensationRecurring]

pay_component Pay Component
currency_code Recurring Pay Cur

rency
paycompvalue Recurring Pay

Amount
frequency Recurring Pay Fre

quency
start_date Recurring Pay Start

Date
end_date Recurring Pay End

Date
The mapping accommodates 15 recurring pay components.
3.2.9 Pay Compensation Non-Recurring Information [Employee

Central hris-element-id:
payCompensationNonRecurring]

pay_compo Non-Recurring Pay

nent_code Component
currency_code Non-Recurring Pay

Currency
value Non-Recurring Pay

Amount
pay_date Non-Recurring Pay

Date

alterna Alternate Cost Cen

tive_cost_center ter
The mapping accommodates 15 non-recurring pay components.
3.2.10 Pay Compensation Deduction Recurring Information

[Employee Central hris-element-id:
deduction_Recurring]

effec- Deduction Recur

tive_start_date ring Start Date
effective_end_date Deduction Recur

ring End Date
paycomponentType Deduction Recur

ring Pay Compo
nent
frequency Deduction Recur

ring Frequency
amount Deduction Recur

ring Amount
currency Deduction Recur

ring Currency
advanceId Deduction Recur

ring Advance ID
The mapping accommodates 15 deduction recurring pay components.

3.2.11 Pay Compensation Deduction Non-Recurring Information
[Employee Central hris-element-id:
deduction_non_Recurring]

payComponent Deduction Non-Re

Type curring Pay Com
ponent
amount Deduction Non-Re

curring Amount
currency Deduction Non-Re

curring Currency
deductionDate Deduction Non-Re

curring Issue Date
advanceId Deduction Non-Re

curring Advance ID
The mapping accommodates 15 deduction non-recurring pay components.
3.2.12 Alternative Cost Distribution [Employee Central hris-

element-id: alternative_cost_distribution]

effectiveStartDate Cost Center Start

Date
EffectiveEndDate Cost Center End

Date
costCenter Cost Center
percentage Percentage
The mapping accommodates 4 alternative cost centers.

3.2.13 National ID Card
Employee Cen
tral hris Ele Employee Cen Obligatory for Code Mapping Payroll Provider
ment tral hris Field Description Replication? Required? Picklist ID Attribute
nationalIdCard Employee’s Na X X NiNumber

tional Insurance
Number
Filter National ID Based On Country
The Employee Central field nationalIdCard is mapped to the field Employee Issued Government ID in the provider
file via a filter national ID based on country function. This function maps the national ID card value to the output if
the country of the national ID information is the same as the country specified in the process property extension.
3.2.14 Dependents Information [Employee Central hris-

element-id: PerPersonRelationship]

firstName X Dependent Name
lastName X
isAccompanying Is a Dependent
Dependent
relationshipType Dependent Rela

tionship
3.2.15 Direct Deposit
Employee Cen Obligatory for Code Mapping Constraint / Payroll Provider

tral hris Field Description Replication? Required? Constant Value Picklist ID Attribute
account_num Bank Account

ber Number

Employee Cen Obligatory for Code Mapping Constraint / Payroll Provider
tral hris Field Description Replication? Required? Constant Value Picklist ID Attribute
account_type Bank Account

Type
amount Amount/
Percent
country_code Bank Account

Country Code
currency_code Bank Account

Currency Code
deposit_type “balance” Deposit Type
process_type Processing Type
routing_number Bank Routing

Number
3.3 Integration Process Overview
The mapping of the Employee Central fields to the third-party provider’s field requirements is done via a Boomi
process. The following section explains how information is mapped from Employee Central to the third-party
payroll provider using Boomi as the middleware.
To achieve this, several modules are provided as subprocesses in Boomi, which can be used in combination to
realize a fully developed Boomi process that addresses the actual use case of sending the Employee Central data to
the provider in an appropriate format.
Main Process: Packaged Integration – Standard Payroll Integration Template
This serves as a basic/standard template for integrating Employee Central with payroll providers.
This process is to be treated as a template that shows the collection of modules (standardized) that can be used
for integration purposes with little or no modification. It calls the following subprocesses:
Subprocess Description
Sub: Extract Employee Central Data Collection of modules that aids in extracting the data from Em
ployee Central
Sub: Transform Employee Central Data Collection of modules that aids in transforming the Employee
Central data and generates different output files

Subprocess Description
Sub: Send E-Mail Send email notifications
Sub: Write to SFTP Encrypt the data and send the data via SFTP, encryption being
optional
 Note
This process shows the logical connection of different modules and should not be executed directly.
 Note
The step Retrieve Last Execution Timestamp is very important for the process to run in delta mode. This step
extracts the persisted last execution timestamp and sets it again to the same process property from which it is
retrieved. This is a workaround because any property is persisted at “per process level” according to Boomi.
Therefore, it has to be retrieved in the same process in which it is persisted. Hence, this step allows you to
access the timestamp anywhere across the subprocesses.
 Note
As a last step of the main process, the LOCAL_LAST_EXECUTION_TIMESTAMP dynamic process property value
is persisted for use during the next process execution. The timestamp is not persisted if the process is executed
for a particular employee using the employee filter criteria person_id_external. This mode of execution where
the timestamp is not persisted is known as debug mode.
Sub: Extract Employee Central Data

This subprocess serves as a display canvas of all modules that aid in extracting the Employee Central data. The
modules are as follows:
1. Build a dynamic query filter.

There are three variations of this, each in a separate module/subprocess:
• Sub: CompoundEmployee Query Filter - Past+Current+Future Records
• Sub: CompoundEmployee Query Filter - Current Record
• Sub: CompoundEmployee Query Filter - Current+Future Records
• Sub: CompoundEmployee Query Filter - Based
2. Sub: Query Compound Employee
Query Employee Central data via compound employee API.
3. Sub: Denormalize Compound Employee Response
Convert the compound employee data into a denormalized snapshot format.
4. Sub: Compound Employee Fetch Last Execution Timestamp
Extract the last execution timestamp for subsequent runs of the process.
5. Sub: Cache for Compound Employee Fixup - Query Foundation Object FO_PayCalendarQuery
6. Sub: Cache for Compound Employee Fixup - Query Employee Entity PerPersonRelationship
Transform Employee Central Data
This subprocess shows a collection of modules that aid in transforming the Employee Central data that was
extracted using the subprocess Sub: Extract Employee Central Data. The modules are as follows:
Module Description
Sub: Log Compound Employee API Error Messages Log the compound employee API log messages (if any) for
each employee
Sub: Handling Global Assignments In the case of multiple assignments, split the employee re
sponse based on the assignment and handle each assignment
individually
Sub: Exclude Terminations Exclude only current terminations and allow only future termi
nations
Sub: Generate Flat File Output Use either the normalized data/denormalized data and map
this data to the output flat file profile and also obtain the count
of records generated

Module Description
Sub: Generate XML Output Use either the normalized data/denormalized data and map
this data to the standard HR XML profile
Sub: Cache for Compound Employee Fixup – Query PerPersonRelationship
For the employees extracted from Employee Central, this subprocess obtains their dependents’ information from
the PerPersonRelationship entity. The information obtained is cached for later use in the actual mapping of
employee data.
Sub: Cache for Compound Employee Fixup – Query Foundation Object FO_PayCalendar
This subprocess extracts data from foundation object FO_PayCalendar. Since this information is common across
all employees and specific to any particular employee, it is queried directly. This data is cached for later use in the
actual mapping of employee data.
Sub: Last Execution Timestamp – Initialize
Initialize the dynamic process property LOCAL_LAST_EXECUTION_TIMESTAMP.
If the persisted value is not null, set this value to the dynamic process property
LOCAL_LAST_EXECUTION_TIMESTAMP.

If the persisted value is null, the process is considered as being executed for the first time. Therefore, a timestamp
value is expected from the administrator in process property EC_STANDARD_LAST_EXECUTION_TIMESTAMP.
If the administrator does not provide this value, then in the worst case, the dynamic process property
LOCAL_LAST_EXECUTION_TIMESTAMP is set to the current timestamp.
Sub: Compound Employee Fetch Last Execution Timestamp
Store the execution timestamp returned in the first document of the compound employee response. The logic to
fetch the timestamp from the first document is as follows:
1. Set a flow control to run each document individually

2. Check the value of dynamic process property EXECUTION_TIMESTAMP. If null, only then set the execution
timestamp to dynamic process property LOCAL_LAST_EXECUTION_TIMESTAMP and also to dynamic process
property EXECUTION_TIMESTAMP.
As a result, the above step is executed for the first document and then for the subsequent documents. The
check for the value of dynamic process property EXECUTION_TIMESTAMP will fail and therefore the set
properties step will be executed only for the first document.
Sub: Query Compound Employee
Query compound employee using the dynamic WHERE clause (refer Build Query Filter subprocess) and return the
response as is (in normalized format).

 Note
Each compound employee response document is treated by the Groovy script Fix Address, Email & Phone
Types that does the following:
• Checks whether address type home is lower- or uppercase and sets it to lowercase, home .
• Checks whether email types B and P are lower- or uppercase and sets them to uppercase, B and P .
• Checks whether phone types H , B , and C are lower- or uppercase and sets them to uppercase, H , B , and
C.
Sub: De-Normalize Compound Employee Response
Each compound employee response document passed into this subprocess is treated by the Groovy script De-
Normalized Dates that converts the compound employee data into a de-normalized snapshot format. Each of these
snapshot documents is then treated by the Groovy script Sanitize Snapshot Data – Remove Unwanted Snapshots
that removes any malformed snapshots that have been created.
In a normalized compound employee response, all data is spread across effective dated entities. In a de-normalized
snapshot response, all effective data is collected and housed under a tag <snapshot>. This tag is created based on
the start_date of each effective dated entity. Its validity is described by a child element <asOfDate>.
 Note
Example:

Normalized

De-Normalized

Sub: Compound Employee Query Filter – Current Record
This subprocess builds the WHERE clause that aids in fetching only the current active records of employees in
Employee Central. This is achieved by using the condition effective_end_date = current date in the WHERE clause.
First, it calls the subprocess Sub: Last Execution Timestamp – Initialize to initialize the last execution timestamp.
Next, it checks whether the process property person_id_external is populated. If it is populated, it is appended to
the dynamic process property WHERE along with the condition effective_end_date = current date. It also sets the
dynamic process property DEBUG to True, so that the timestamp in this execution is not persisted.
If the Person ID property is not populated, the following two conditions are appended to the dynamic process
property WHERE:
• effective_end_date=current date
• last_modified_on>last execution timestamp
It also checks for other filter properties. If they are populated, they are appended to the property WHERE.
Sub: CompoundEmployee Query Filter – Past+Current+Future Records
This subprocess builds the WHERE clause that aids in fetching only the past, current, and futurerecords of
employees in Employee Central. This is achieved by NOT using the condition effective_end_date = current date in
the WHERE clause.
First, it calls the subprocess Sub: Last Execution Timestamp – Initialize to initialize the last execution timestamp.
the dynamic process property WHERE. It also sets the dynamic process property DEBUG to True, so that the
timestamp in this execution is not persisted.
If the Person ID property is not populated, the following condition is appended to the dynamic process property
WHERE:
• last_modified_on>last execution timestamp

Sub: CompoundEmployee Query Filter – Current+Future Records
This subprocess builds the WHERE clause that aids in fetching the current and futurereords of employees in
Employee Central. This is achieved by using the condition effective_end_date = current date in the WHERE
clause.
First, it calls the subprocess Sub: Last Execution Timestamp – Initialize to initialize the last execution
timestamp.
the dynamic process property WHERE along with the condition effective_end_date = current date . It also sets
the dynamic process property DEBUG to True, so that the timestamp in this execution is not persisted.
property WHERE:
• effective_end_date =current date

• last_modified_on last execution timestamp
Sub: CompoundEmployee Query Filter – Based on Pay Calendar
This subprocess queries the foundation object Pay Calendar and fetches the current valid calendar for the pay
group specified in the process extensions, and then makes a note of the pay period end date in the dynamic
process property PAYPERIODENDDATE.
Next, it checks whether the property PAYPERIODENDDATE is null or not. If it is null, then in the worst case, the
property value is set to the current date.
Then, it checks whether the process property person_id_external is populated. If it is populated, it is appended to
the dynamic process property WHERE along with the condition effective_end_date = PAYPERIODENDDATE. It also
sets the dynamic process property DEBUG to True, so that the timestamp in this execution is not persisted.

property WHERE:
• effective_end_date=PAYPERIODENDDATE
• last_modified_on last execution timestamp
Sub: Log Compound Employee API Error Messages
This subprocess logs the compound employee API log messages (if any) for each employee.
Sub: Handling Global Assignment
This subprocess uses the standard library subprocess Sub: XSL/XPATH Processing v1.1 to filter out the inactive
global assignments based on the condition that is specified using the set properties step. If the document has
multiple employment information, the document is split and all the documents are filtered by the filters set under
the process extension Employee Filter Criteria.

Sub: Exclude Terminations
There are two flavors of execution of this subprocess:
• If it is the first execution of the process, and if the exclude terminations process property is checked, the
terminated employees are removed based on the condition job_info/start_date < current_date .
• If it is not the first execution of the process, or the exclude terminations process property is not checked, the
terminated employee’s record is checked if it is sent at least once to the provider by the condition job_info/
created_on last_execution . If it is not sent at least once, it is sent to the provider; otherwise, it is checked
whether it is a valid termination. For this check there are two conditions: emp_info/payrollEndDate <=
PAYPERIODENDDATE and emp_info/payrollEndDate <= CurrentDate . If the PAYPERIODENDDATE is null, the
latter condition is used; otherwise the former condition is used.
Sub: Send E-Mail
This subprocess sends email notifications to users.
 Note
Set the sender and receiver email IDs before attempting to send email notifications.

Sub: Write to SFTP
This subprocess checks for the PGP encryption process property. If it is enabled, the file is encrypted using the
certificate provided in the extension and then written to the remote SFTP location. If the PGP property is not
enabled, the file is written directly to the remote SFTP location without encryption.
Sub: Generate Flat File Output
This subprocess is used to map the Employee Central data to a pipe-delimited flat file profile and to obtain the
record count.
 Note
There are two versions of the mapping:
• Generate FF Output using Normalized CE Data

Use this mapping if the employee data has only current active records.
• Generate FF Output Using Denormalized CE Data
Use this mapping if the employee data has past/future records along with the active records. Before using
this map, the employee data must be denormalized into snapshot format. This is done using the
subprocess Sub: Denormalize Compound Employee Response.
If any exceptions are caught while mapping the employee data, they are emailed to the administrator.

Sub: Generate XML Output
This subprocess is used to map the Employee Central data to an HR-XML profile.
If any exceptions are caught while mapping the employee data, they are emailed to the administrator.
 Note
This mapping is currently supported only for normalized data.
3.4 Getting Access to the Process Library
The current solution can be used as a process library only.
A process library is a collection of processes published for the purpose of sharing with managed accounts on a per
account group basis. Users of managed accounts install copies of library processes in their accounts and typically
use the installed processes as templates for new processes. These activities take place on the Process Library page
( Manage Process Library ).
This solution, when consumed as a process library, makes the current integration process for standard payroll
available as a process in the process library. This process can then be enhanced further as per the customer's
requirements.
 Note
Example

3.5 Setting Up the Standard Data Integration
Maintain the connection endpoint details for the system involved in the integration. This helps to send/retrieve data
to/from the appropriate systems.

3.5.1 Connection Settings
SF API/OData Connection
To configure the SAP SuccessFactors connection, make the following entries:
Field Entry
Endpoint Datacenter
Company ID Customer Employee Central company ID
Username/Password API user and password that have permission to retrieve data
from the API

Provider SFTP Server Connections
To configure the process to connect to the provider’s SFTP server, make the following entries:
Field Entry
Host Hostname of provider SFTP server
Port Port of provider SFTP server
User/Password User and password for provider SFTP server

Provider Mail/SMTP Server Connections
To configure the process to connect to the provider’s mail/SMTP server, make the following entries:
Field Entry
Host Hostname of provider mail/SMTP server
Port Port of provider mail/SMTP server
User/Password User and password for provider mail/SMTP server
3.5.2 Process Properties
The process properties contain customizing options. To configure the process properties, you can override the
default values.
General Settings
You can set the following general properties:
Property Description
SFTP Remote Directory Directory on the provider server where the file is saved

Property Description
EC_Standard_Last_Execution_Timestamp Enter the execution timestamp to be used for the first ever exe
cution of the process
Email ID of Sender Sender’s email ID if Send Email module is used
Email ID of Receiver Receiver’s email ID if Send Email module is used
Employee Filter Criteria
To fetch data based on a particular filter, you can change the same under the process properties of the Boomi
process. The following filters are available for the current integration process.
Filter Description
pay_group Include the foundation object externalCode if you want to in

clude only employees associated with that foundation object
employee_class Comma-delimited list filter for specifying the employee classes

to include in the extract. Make sure there are no blank spaces
before/after the comma.
employment_type Include employees with a particular employment type
location Include the foundation object externalCode if you want to in


Filter Description
company Comma-delimited list filter for specifying the companies to in

clude in the extract. Make sure there are no blank spaces be
fore/after the comma.
company_territory_code(Country) Provide a single value for the country (ISO-3 code). This field is
mandatory because this process generates an output file spe
cific to a country and also includes this country code in the file
name. If this field is left blank, an email is sent to the adminis
trator and the process is aborted.
business_unit Include the foundation object externalCode if you want to in

person_id_external Comma-delimited list filter for specifying the person_id_exter

nals to include in the extract. Make sure there are no blank
spaces before/after the comma.
Exclude Termination for First Execution of the Process Excludes terminated employees from being entered in the out
bound file during the first execution. Current termination is de
termined based on job_information/start_date.

3.5.3 Cross-Reference Tables
The cross-reference tables are translation tables between the Employee Central picklist entries and the provider
values. Fill out the cross-reference tables to add or override the existing values.
1. Navigate to Manage Atom Management .

2. Click Environment on the left hand side.
3. Click Environment Extensions on the right hand side. The Extensions pop-up appears.
4. Click Cross Reference .
5. In the dropdown, select the cross-reference to be changed.
Below is an example of how a gender code mapping can be customized.

The following cross-reference tables are available:
• Ethnicity
In the first column enter the Employee Central ethnicity code, and in the second column the provider ethnicity.
These values are for the USA and need to be changed according to the country.
• Marital status
In the first column enter the Employee Central marital status code, and in the second column the provider
marital status code.
• Gender
In the first column enter the Employee Central gender code, and in the second column the provider gender
code.
• Suffix
In the first column enter the Employee Central suffix code, and in the second column the provider suffix code.

• Salutation
In the first column enter the Employee Central salutation code, and in the second column the provider
salutation code.
• Job event
In the first column enter the Employee Central event code, and in the second column the provider event code.
• Timezones
In the first column enter the Employee Central timezone code, and in the second column the provider timezone
code.
• Payment method
In the first column enter the Employee Central payment method code, and in the second column the provider
payment method code.

• Pay group
In the first column enter the Employee Central pay group code, and in the second column the provider pay
group code.
• Cost center
In the first column enter the Employee Central cost center code, and in the second column the provider cost
center code.
3.6 Output File Layout
The standard payroll integration template generates a pipe-delimited flat file with a .csv extension. The layout of the
file to be generated can be seen in the sample layout below.
SL. No Fields
1 Person ID
2 Person ID External
3 Payroll Group
4 Payroll Status
5 Personal Information Start Date

SL. No Fields
6 Employee Date of Birth
7 Employee Country Of Birth
8 Employee Place of Birth
9 Employee Salutation
10 Employee First Name
11 Employee Last Name
12 Employee Middle Name
13 Employee Name Suffix
14 Employee Birth Name
15 Employee Gender
16 Employee Preferred Language
17 Employee Marital Status
18 Ethnicity Code
19 Home Address Start Date
20 Home Address Care Of Name
21 Home Address Room ID
22 Home Address Floor ID
23 Home Address House ID
24 Home Address Additional House ID
25 Home Address Building ID
26 Home Address Street Suffix Name
27 Home Address Street Prefix Name
28 Home Address Street Name
29 Home Address Municipality Code
30 Home Address Municipality Name
31 Home Address Description

SL. No Fields
32 Home Address City
33 Home Address Additional City Name
34 Home Address P.O. Box Number
35 Home Address District Name
36 Home Address Postal Region/State/Province
37 Home Address Postal Code
38 Home Address Country
39 Employee Personal Email
40 Employee Business Email
41 Employee Home Phone
42 Employee Business Phone
43 Employee Personal Mobile Phone
44 Employee Issued Government ID
45 Dependent Name
46 Dependent Relationship
47 Is a Dependent
48 Payment Method
49 Bank Routing Number
50 Bank Account Number
51 Bank Account Type
52 Deposit Type
53 Processing Type
54 Amount/Percent
55 Bank Account Country Code
56 Bank Account Currency
57 Job Start Date

SL. No Fields
58 Company
59 Business Unit
60 Division
61 Department
62 Location
63 Timezone
64 Cost Center
65 Employee Status
66 Employee Type
67 FLSA Status
68 Employment Type
69 Employment Status
70 Administrative Category
71 Position Start Date
72 Event
73 Event Reason
74 Payroll Event
75 Shift Code
76 Shift Rate
77 Compensation Start Date
78 Pay Type
79 Pay Group
80 Payroll ID
81 Recurring Pay Start Date 1
82 Recurring Pay End Date 1
83 Pay Component 1

SL. No Fields
84 Recurring Pay Amount 1
85 Recurring Pay Currency 1
86 Recurring Pay Frequency 1
89 Pay Component 2
95 Pay Component 3
101 Pay Component 4
107 Pay Component 5

SL. No Fields
113 Pay Component 6
119 Pay Component 7
125 Pay Component 8
131 Pay Component 9

SL. No Fields
137 Pay Component 10

SL. No Fields
171 Deduction Recurring Start Date
172 Deduction Recurring End Date
173 Deduction Recurring Pay Component 1
174 Deduction Recurring Amount 1
175 Deduction Recurring Currency 1
176 Deduction Recurring Frequency 1
177 Deduction Recurring Advance ID 1

SL. No Fields

SL. No Fields

SL. No Fields
247 Cost Center Start Date
248 Cost Center End Date
249 Cost Center 1
250 Percentage 1
251 Cost Center 2
252 Percentage 2
253 Cost Center 3
254 Percentage 3
255 Cost Center 4
256 Percentage 4
257 Employment Start Date
258 Employment End Date
259 First Date Worked
260 Original Hire Date
261 Last Date Worked
262 Salary End Date
263 Payroll End Date
264 Employment ID
265 User ID

SL. No Fields
266 Leave of Absence Start Date
267 Leave of Absence Return Date
268 Termination Date
269 Termination Reason

4 Example Process
The standard payroll integration template is a collection of standalone generic functionalities that can be used by
consultants to build Employee Central integrations with any third-party payroll provider. The example process
shows how a provider-specific payroll process can be built using the standard payroll integration template.
4.1 Specification of an Example Process
• The process should fetch the current and future records for an employee who has been modified after the
previous execution of this process, that is, only modified employees are reported.
• The process should generate one flat file as an output with all information for an employee. For the layout of the
output file, see Output File Layout .
• The process should be able to handle global assignments, that is, the employee information has to be spilt
based on the employment information using country filter and reported for the country specified in the process
property.
• The process should exclude terminated employees in the output file generated.
• The process should send a mail to the recipient (admin) on the status of the process.
• The process should encrypt the output file via PGP and place it in the SFTP location specified in the process
properties.
4.2 Implementation
• Obtain the standard payroll integration template from the process library to your Boomi account. See Getting
Access to the .
• Navigate to the main process and remove the subprocesses that are not required (as per the above
requirements). For information about the collection of subprocesses available in the main canvas, see
Integration Process Overview .
• Based on the above requirements, the following modules are relevant and are kept in the final process.
• Subprocess Extract:

Example Process PUBLIC 55
• Subprocess Transform:
• Subprocess Generate Flat File Output:
• Main Process

56 PUBLIC Example Process
• Once the process is built in accordance with the requirements, rename all the processes and its components as
per your customer requirements. (If the standard payroll integration template is used in more than one Boomi
process, rename the process properties.)
• Navigate to extensions in the main process and select only the relevant process properties that need to be
extended.
• Maintain all the connection settings and execute the process.
• For an example output file, see the following screenshot:

Example Process PUBLIC 57
5 Appendix
5.1 Country-Specific Mapping of Address Fields
For address information, the mapping between Employee Central hris fields and payroll provider attributes is highly
dependent on the address country. Based on the address country, the Employee Central fields are mapped to the
appropriate payroll provider attributes.
The following tables show the mapping between the Employee Central hris fields and the payroll provider attributes
based on country.
Payroll Provider
Attribute Argentina Australia Austria Belgium Brazil
Home Address - - - - -
Care Of Name
Room ID
Home Address address3 - - - -

Floor ID
Home Address address2 address2 - address2 address2

House ID
Home Address Ad address4 address3 - address3 address3

ditional House ID
Building ID
Home Address address5 address4 - address4 -

Street Suffix Name
Street Prefix Name
Home Address address1 address1 address1 address1 address1

Street Name

58 PUBLIC Appendix
Payroll Provider
Attribute Argentina Australia Austria Belgium Brazil
Home Address Mu - - - - -

nicipality Code

nicipality Name
Home Address De - - - - -

scription
Home Address City city city city - city
Home Address Ad - - - - -

ditional City Name
Home Address P.O. - - - - -

Box Number
Home Address Dis county county county - address4

trict Name
Home Address state state state - state

Postal Region/
State/Province
Home Address zip_code zip_code zip_code zip_code zip_code

Postal Code
Home Address country country country country country

Country
Payroll Provider
Attribute Bulgaria Canada Chile China Colombia
Home Address address1 - address1 - -

Care Of Name
Room ID
Floor ID
Home Address address3 - address3 - -

House ID

Appendix PUBLIC 59
Payroll Provider
Attribute Bulgaria Canada Chile China Colombia
Home Address Ad address4 - address4 - -

ditional House ID
Building ID

Street Suffix Name
Street Prefix Name

Street Name

nicipality Code

nicipality Name

scription
Home Address City city city city city -

ditional City Name

Box Number
Home Address Dis - - county address3 -

trict Name
Home Address state state state state state

Postal Region/
State/Province
Home Address zip_code zip_code zip_code zip_code -

Postal Code

Country

60 PUBLIC Appendix
Payroll Provider Dominican Repub
Attribute Costa Rica Croatia Czech Republic Denmark lic

Care Of Name
Room ID
Floor ID
Home Address - address3 address3 address3 -

House ID
Home Address Ad - address4 address4 address4 -

ditional House ID
Building ID

Street Suffix Name
Street Prefix Name

Street Name

nicipality Code

nicipality Name

scription
Home Address City - city city city -
Home Address Ad address4 - - address6 address3

ditional City Name

Box Number
Home Address Dis address5 county county county county

trict Name

Appendix PUBLIC 61
Payroll Provider Dominican Repub
Attribute Costa Rica Croatia Czech Republic Denmark lic
Home Address province state state state -

Postal Region/
State/Province

Postal Code

Country
Payroll Provider Attrib

ute Ecuador Egypt Finland France
Home Address Care Of - address1 - -

Name
Home Address Room ID - - - -
Home Address Floor ID - - - -
Home Address House - - address2 address1

ID
Home Address Addi - - address3 -

tional House ID
Home Address Building - address2 - -

ID
Home Address Street - - address4 address3

Suffix Name
Home Address Street - - - -

Prefix Name
Home Address Street address2 address3 address1 address2

Name
Home Address Munici - - - address4

pality Code

pality Name
Home Address Descrip - - - -

tion

62 PUBLIC Appendix
ute Ecuador Egypt Finland France
Home Address City city city city city
Home Address Addi - - - -

tional City Name
Home Address P.O. Box - - - -

Number
Home Address District - address4 county county

Name
Home Address Postal - province state state

Region/State/Province
Home Address Postal zip_code zip_code zip_code zip_code

Code
Home Address Country country country country country
Payroll Provider
Attribute Germany Greece Guatemala Honduras Hong Kong

Care Of Name
Room ID
Floor ID
Home Address address2 address3 - - -

House ID
Home Address Ad - address4 - - -

ditional House ID
Building ID
Home Address - address5 - - address1

Street Suffix Name
Home Address - - - - address3

Street Prefix Name

Appendix PUBLIC 63
Payroll Provider
Attribute Germany Greece Guatemala Honduras Hong Kong
Home Address address1 address2 address2 - address2

Street Name

nicipality Code

nicipality Name

scription
Home Address City city city - - -
Home Address Ad - - address3 address2 -

ditional City Name

Box Number
Home Address Dis address3 county - - city

trict Name
Home Address - state - - state

Postal Region/
State/Province
Home Address zip_code zip_code zip_code zip_code -

Postal Code

Country
Payroll Provider
Attribute Hungary India Indonesia Ireland Israel
Home Address address1 - address1 - address1

Care Of Name
Room ID

Floor ID

64 PUBLIC Appendix
Payroll Provider
Attribute Hungary India Indonesia Ireland Israel
Home Address address2 address2 - - address3

House ID
Home Address Ad address6 - - - -

ditional House ID

Building ID
Home Address address7 address3 address3 address2 -

Street Suffix Name

Street Prefix Name
Home Address - address1 address2 address1 address2

Street Name

nicipality Code

nicipality Name

scription
Home Address City city city city city city

ditional City Name

Box Number
Home Address Dis county county county address3 -

trict Name
Home Address - state state - -

Postal Region/
State/Province
Home Address zip_code zip_code zip_code - zip_code

Postal Code

Country

Appendix PUBLIC 65
Payroll Provider
Attribute Italy Japan Jordan Kazakhstan Korea
Home Address - - address1 address1 -

Care Of Name
Room ID
Floor ID
Home Address - address3 - - -

House ID
Home Address Ad - address6 - - -

ditional House ID
Home Address - - - address3 -

Building ID
Home Address address2 address5 - - address4

Street Suffix Name
Street Prefix Name
Home Address address1 - address2 address2 address3

Street Name
Home Address Mu - county - - -

nicipality Code

nicipality Name

scription
Home Address City city address1 city - address1

ditional City Name
Home Address P.O. - - address4 - -

Box Number
Home Address Dis - address2 county county address2

trict Name

66 PUBLIC Appendix
Payroll Provider
Attribute Italy Japan Jordan Kazakhstan Korea
Home Address state state province province state

Postal Region/
State/Province

Postal Code

Country

ute Kosovo Lebanon Malaysia Mexico
Home Address Care Of - address1 address4 -

Name
Home Address House address2 - - -

ID

tional House ID
Home Address Building address3 - - -

ID

Suffix Name

Prefix Name

Name

pality Code
Home Address Munici - - - -

pality Name

tion

Appendix PUBLIC 67
ute Kosovo Lebanon Malaysia Mexico
Home Address City - address3 city city
Home Address Addi address4 address2 - -

tional City Name
Home Address P.O. Box - address5 - -

Number
Home Address District county county address3 address3

Name
Home Address Postal - - state state

Home Address Postal zip_code - zip_code zip_code

Code
Payroll Provider
Attribute Netherlands New Zealand Norway Pakistan Panama
Home Address - address1 address1 address1 address1

Care Of Name
Room ID
Floor ID
Home Address address4 - address3 address2 address2

House ID
Home Address Ad address5 - - - -

ditional House ID
Building ID
Home Address address1 address4 address4 - -

Street Suffix Name
Street Prefix Name

68 PUBLIC Appendix
Payroll Provider
Attribute Netherlands New Zealand Norway Pakistan Panama

Street Name

nicipality Code

nicipality Name

scription
Home Address City city+address2 city city city -
Home Address Ad - - - - address4

ditional City Name

Box Number
Home Address Dis - county - - -

trict Name
Home Address - - state province province

Postal Region/
State/Province

Postal Code

Country

ute Peru Philippines Poland Portugal
Home Address Care Of address1 address1 - address1

Name
Home Address House address3 address3 address2 -

ID

Appendix PUBLIC 69
ute Peru Philippines Poland Portugal
Home Address Addi - address4 address3 -

tional House ID
Home Address Building - - - -

ID
Home Address Street - address5 address4 address3

Suffix Name

Prefix Name

Name

pality Code

pality Name

tion
Home Address City city city city city

tional City Name
Home Address P.O. Box - - address5 -

Number
Home Address District county county county -

Name
Home Address Postal province - state -

Home Address Postal zip-code zip_code zip_code zip_code

Code

70 PUBLIC Appendix
ute Puerto Rico Qatar Romania Russia
Home Address Care Of address1 address1 address1 -

Name
Home Address Floor ID - - address6 -
Home Address House - address6 address4 address2

ID
Home Address Addi - address10 address7 address5

tional House ID
Home Address Building - address8 address5 address3

ID

Suffix Name

Prefix Name

Name

pality Code

pality Name

tion
Home Address City city address12 address10 city
Home Address Addi - - - address6

tional City Name

Number
Home Address District county county county address7

Name
Home Address Postal - state state state


Appendix PUBLIC 71
ute Puerto Rico Qatar Romania Russia
Home Address Postal zip-code zip_code zip_code zip_code

Code

ute Saudi Arabia Serbia Singapore Slovakia
Home Address Care Of address1 address1 - address1

Name
Home Address House address4 - - address4

ID
Home Address Addi address5 - - address5

tional House ID

ID
Home Address Street address3 - address2 address3

Suffix Name
Home Address Street - - address3 -

Prefix Name

Name

pality Code

pality Name

tion
Home Address City address6 - city address6
Home Address Addi - address3 - -

tional City Name

72 PUBLIC Appendix
ute Saudi Arabia Serbia Singapore Slovakia

Number
Home Address District county - country+county county

Name
Home Address Postal state - - -

Home Address Postal zip_code zip-code zip_code zip_code

Code
Payroll Provider
Attribute Slovenia South Africa South Sudan Spain Sweden
Home Address address1 address1 - - -

Care Of Name
Room ID
Floor ID

House ID
Home Address Ad address5 address2 address2 address3 address3

ditional House ID
Home Address - - address1 - -

Building ID

Street Suffix Name
Home Address - - - address4 -

Street Prefix Name

Street Name

nicipality Code

Appendix PUBLIC 73
Payroll Provider
Attribute Slovenia South Africa South Sudan Spain Sweden

nicipality Name

scription
Home Address City - city - city city
Home Address Ad - - address4 - -

ditional City Name

Box Number
Home Address Dis county county - address6 county

trict Name
Home Address state state - state state

Postal Region/
State/Province
Home Address zip_code zip_code - zip_code zip_code

Postal Code

Country
Payroll Provider
Attribute Switzerland Taiwan Thailand Turkey Ukraine
Home Address - - address9 address1 address1

Care Of Name
Room ID
Home Address - - address2 - -

Floor ID
Home Address address4 - address5 - address4

House ID
Home Address Ad - - address3 - -

ditional House ID

74 PUBLIC Appendix
Payroll Provider
Attribute Switzerland Taiwan Thailand Turkey Ukraine
Home Address - - address6 address4 -

Building ID
Home Address address2 address5 address8 - address3

Street Suffix Name
Home Address - address2 address1 - -

Street Prefix Name

Street Name

nicipality Code
Home Address Mu - state - - -

nicipality Name

scription
Home Address City city address1 city - city

ditional City Name

Box Number
Home Address Dis county county county - county

trict Name
Home Address - - state province state

Postal Region/
State/Province
Home Address zip_code zip_code zip_code zip_code zip-code

Postal Code

Country

Appendix PUBLIC 75
ute United Arab Emirates United Kingdom United States Uruguay
Home Address Care Of address1 - - address1

Name
Home Address House address3 - - -

ID
Home Address Addi address4 - - -

tional House ID

ID
Home Address Street address5 address2 address2 -

Suffix Name

Prefix Name

Name

pality Code

pality Name

tion
Home Address City city city city address3

tional City Name
Home Address P.O. Box - - - -

Number
Home Address District county address3 county -

Name
Home Address Postal state - state -


76 PUBLIC Appendix
ute United Arab Emirates United Kingdom United States Uruguay
Home Address Postal zip_code zip_code zip_code zip_code

Code
Payroll Provider Attribute Venezuela Vietnam DEFAULT**
Home Address Care Of Name - address1 -
Home Address Room ID - - -
Home Address Floor ID - - -
Home Address House ID address3 address2 -
Home Address Additional address4 - -

House ID
Home Address Building ID - - -
Home Address Street Suffix address2 - address2

Name
Home Address Street Prefix address5 - -

Name
Home Address Street Name address1 - address1
Home Address Municipality - - -

Code
Home Address Municipality - - -

Name
Home Address Description - - -
Home Address City city - city
Home Address Additional City - address3 -

Name
Home Address P.O. Box Num - - -

ber
Home Address District Name - county county

Appendix PUBLIC 77
Payroll Provider Attribute Venezuela Vietnam DEFAULT**
Home Address Postal Region/ state province state

State/Province
Home Address Postal Code zip_code zip_code zip_code
Home Address Country country country country
** The standard implementation provides country-dependent address mapping for the countries listed in the above
tables. For all other countries, the DEFAULT mapping is used.

78 PUBLIC Appendix
Important Disclaimers and Legal Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements
with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you
agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.
Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the
control or responsibility of SAP.
Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at
any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the
experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback
(e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and
phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example
code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities, genders,
and abilities.

Important Disclaimers and Legal Information PUBLIC 79
www.sap.com/contactsap
© 2022 SAP SE or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.
Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.
National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for

informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.
Please see https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.
THE BEST RUN

Standard Integration SF SAP

Uploaded by

Document Information

Original Description:

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

Standard Integration SF SAP

Uploaded by

Copyright:

Available Formats

Integration Guide | PUBLIC

Document Version: 1H 2022 – 2022-10-14

Standard Payroll Integration Template for SAP

THE BEST RUN

3 Employee Data Replication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

Type of Change Description More Info

New / Added / Changed

New / Added / Changed

What's new Description More Info

What's new Description More Info

No changes There are no updates to this document.

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

2.1 Standard Payroll Integration Template

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

Using the Integration Solution as a Process Library

1. Set up Employee Central.

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

For Information on Compound Employee Element Structure

Person Information Person Information [Employee Central hris-element-id: per­

Personal Information Personal Information [Employee Central hris-element-id: per­

Address Information Address Information [Employee Central hris-element-id: ad­

Phone Information Phone Information [Employee Central hris-element-id: pho­

Email Address Information E-Mail Information [Employee Central hris-element-id: emai­

Employment Information Employment Information [Employee Central hris-element-id:

National ID Card National ID Card [page 16]

3.1.1 Configurations for Compound Employee API

Choose your regional API endpoint from the following table:

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

USA, New Jersey https://api.successfactors.com/sfapi/v1/soap

USA, Arizona https://api4.successfactors.com/sfapi/v1/soap

You may have to make more settings for the following:

• Web service setup.

3.1.2 Preparations Required at Third-Party Provider's End

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

3.2.1 Person Information [Employee Central hris-element-id:

Employee Central Obligatory for Code Mapping Re­ Payroll Provider

date_of_birth Date of Birth Employee Date of

person_id_external Employee Identifi- Person ID External

person_id Employee Identifi- Person ID

country_of_birth Country of Birth Employee Country

birth_name Birth Name Employee Birth

place_of_birth Place Of Birth Employee Place Of

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

start_date Personal Infor­ Personal Infor­

marital_status Marital Status Marital Status Marital Status

first_name First Name Employee First

last_name Last Name Employee Last

middle_name Middle Name Employee Mid­

suffix Suffix Suffix Employee Name

salutation Salutation Salutation Employee Salu­

gender Gender Gender Employee Gen­

Standard Payroll Integration Template for SAP SuccessFactors Employee Central

genericString1 Ethnic Origin Ethnicity Ethnicity Code

3.2.3 Address Information

address-type Address Type 'home'

start_date Address Start Home Address

state State Home Address

zip_code ZIP Code Home Address

country Country Home Address

3.2.4 Phone Information [Employee Central hris-element-id:

Person Information Person Information [Employee Central hris-element-id: per

Personal Information Personal Information [Employee Central hris-element-id: per

Address Information Address Information [Employee Central hris-element-id: ad

Phone Information Phone Information [Employee Central hris-element-id: pho

Email Address Information E-Mail Information [Employee Central hris-element-id: emai

Employee Central Obligatory for Code Mapping Re Payroll Provider

start_date Personal Infor Personal Infor

middle_name Middle Name Employee Mid

salutation Salutation Salutation Employee Salu

gender Gender Gender Employee Gen

email-address Email Address Employee Per

Employee Central Obligatory for Code Mapping Re Payroll Provider

end_date Employee’s Ter X Termination

Employee Central Obligatory for Code Mapping Re Payroll Provider

Employee Central Obligatory for Code Mapping Re Payroll Provider

currency_code Recurring Pay Cur

frequency Recurring Pay Fre

Employee Central Obligatory for Code Mapping Re Payroll Provider

pay_compo Non-Recurring Pay

alterna Alternate Cost Cen

Employee Central Obligatory for Code Mapping Re Payroll Provider

effec- Deduction Recur

effective_end_date Deduction Recur

paycomponentType Deduction Recur

frequency Deduction Recur

amount Deduction Recur

currency Deduction Recur

advanceId Deduction Recur