Date post: | 25-Feb-2018 |
Category: |
Documents |
Upload: | anonymous-7snlidd |
View: | 227 times |
Download: | 0 times |
of 64
7/25/2019 Benefitfocus_Boomi_1602
1/64
IntegrationGuide
SAP SuccessFactors Employee CentralDocument Version: Q1 2016 2016-01-15
CUSTOMER
SuccessFactors Employee Central and BenefitfocusDell Boomi
http://dwdf212/Info_Dev/KM_Layouts/LayoutSpecs/PDF_Documents/Final/DocuTemplateDOCX_instructions.pptx7/25/2019 Benefitfocus_Boomi_1602
2/64
2
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Typographic Conventions
Typographic Conventions
Type Style Description
Example Words or characters quoted from the screen. These include field names, screen titles,
pushbuttons labels, menu names, menu paths, and menu options.
Textual cross-references to other documents.
Example Emphasized words or expressions.
EXAMPLE Technical names of system objects. These include report names, program names,
transaction codes, table names, and key concepts of a programming language when theyare surrounded by body text, for example, SELECT and INCLUDE.
Exampl e Output on the screen. This includes file and directory names and their paths, messages,
names of variables and parameters, source text, and names of installation, upgrade and
database tools.
Example Exact user entry. These are words or characters that you enter in the system exactly as
they appear in the documentation.
Variable user entry. Angle brackets indicate that you replace these words and characters
with appropriate entries to make entries in the system.
EXAMPLE Keys on the keyboard, for example, F2 or ENTER.
7/25/2019 Benefitfocus_Boomi_1602
3/64
SuccessFactors Employee Central and Benefitfocus
Document History
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 3
Document History
What's new Description More info
J anuary 15 2016
Added new features enhancements
section
Three new features are added,
Custom Category Effective Date
mapping, Pay Frequency and
Termination reason
Custom Category Effective Date
mapping
Pay frequency
Termination Reason
August 21 2015
Updated the Prerequisites forSingle
Sign-On (SSO)
Employee Central must be
implemented to enable SSO
connections in Benefitfocus.
Single Sign-On (SSO)
7/25/2019 Benefitfocus_Boomi_1602
4/64
4
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Contents
Contents
1 Benefitfocus Integration Overview ........................................................................................ 6
1.1 Integration Options................................................................................................................................6
1.2 Benefits Business Process with Benefitfocus .....................................................................................7
1.3 Overview of Payroll Export Process .....................................................................................................8
2 Employee Data Replication..................................................................................................... 9
2.1 Prerequisites ..........................................................................................................................................9
2.1.1 Configurations for Employee Central API Compound Employee .....................................9
2.1.2 Configurations for Employee Central OData API .............................................................10
2.1.3 Preparations Required at Third-Party Provider's End ..................................................... 10
2.2 Integration Specification ......................................................................................................................11
2.2.1 Person Information [EC hris-element-id: personInfo] ......................................................11
2.2.2 Personal Information [EC hris-element-id: personInfo] ...................................................12
2.2.3 Address Information ............................................................................................................13
2.2.4 Phone Information [EC hris-element-id: phoneInfo] ........................................................14
2.2.5 Email Information [EC hris-element-id: emailInfo] ...........................................................15
2.2.6 Employment Information [EC hris-element-id: employmentInfo] ..................................16
2.2.7 Compensation Information [EC hris-element-id: compensationInfo ] ...........................16
2.2.8 National ID Card ...................................................................................................................17
2.2.9 Emergency Contact Information ........................................................................................18
2.3 Integration Process Overview .............................................................................................................192.4 Getting Access to the Integration Pack .............................................................................................22
2.5 Setting Up the Standard Data Integration .........................................................................................24
2.5.1 Extensions for Connection Settings ..................................................................................24
2.5.2 Process Properties..............................................................................................................25
2.5.3 Cross-Reference Tables .....................................................................................................29
2.5.4 PGP Encryption ...................................................................................................................32
2.5.5 Data Maps ............................................................................................................................32
2.6 Extending the Standard Data Integration ..........................................................................................33
3 Integrating the Benefitfocus UI ............................................................................................35
3.1 Single Sign-On (SSO) ..........................................................................................................................35
3.1.1 Employee Central Certification for Benefitfocus .............................................................35
3.1.2 Configuration of Employee Central Identity Provider for Benefitfocus .........................35
3.1.3 Configure My Benefits Link for Benefitfocus ....................................................................36
4 Benefits Data Replication .....................................................................................................39
4.1 Business Add-In HR_ECPINTEP_BEN_DATE_OR ............................................................................39
4.1.1 Processing Custom Fields Using Business Add-Ins.........................................................39
4.2 Benefits Data Mapping ........................................................................................................................42
4.3 Integration Process Overview ............................................................................................................48
4.4 Getting Access to the Integration Pack .............................................................................................49
4.5 Configuring and Using the Integration Pack .....................................................................................49
4.6 Setting Up the Standard Data Integration .........................................................................................50
7/25/2019 Benefitfocus_Boomi_1602
5/64
SuccessFactors Employee Central and Benefitfocus
Contents
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 5
4.6.1 Extensions for Connection Settings ..................................................................................50
4.6.2 Process Properties ..............................................................................................................52
4.6.3 Cross-Reference Tables .....................................................................................................53
4.7 Data Replication Details ......................................................................................................................544.7.1 Health/ Insurance/ Credit/Disability/FSA Plan Processing ............................................54
4.7.2 401(k) Saving Plan Processing........................................................................................... 55
4.7.3 Pay Code Wage Type Mapping...........................................................................................56
4.8 Configuring the Wage Types ...............................................................................................................58
5 New Features and enhancements ........................................................................................60
5.1 Custom Category Effective Date mapping ....................................................................................... 60
5.2 Pay frequency.......................................................................................................................................61
5.3 Termination Reason ............................................................................................................................62
7/25/2019 Benefitfocus_Boomi_1602
6/64
6
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefitfocus Integration Overview
1 Benefitfocus Integration Overview
This guide is for Professional Services and SAP or partner consultants to integrate SuccessFactors Employee
Central (EC) with Benefitfocus. Integration is through a standard integration pack for validated third-party
benefits providers. This is an out-of-box integration that requires no manual data mapping.
For more information about EC, see theEmployee Central Implementation Guide.
1.1 Integration Options
Use the following steps as a guideline to successfully integrate EC with the benefits providers. This is a simplified
approach to a possible integration process. Depending on your customer's business requirements, you will need
to adjust these processes.
Using the Integration Solution As an Integration Pack
1. Set up EC.
For more information about EC, see theEmployee Central Implementation Guide.
2. Make third-party provider-specific settings, for example, single sign-on (SSO).
3. Get access to the integration pack.
4. Set up the standard data integration.
Benefitfocus provides employers, consumers, insurance carriers and government entities cloud-based
technology to shop, enroll, manage, and exchange benefits information. Employees can choose their benefits
plans in an online portal with integration to EC. Benefitfocus then sends updates to EC Payroll as required for legal
reporting. Formore information about ECPayroll, see theEmployee Central Payroll Implementation Guideon SAP
Help Portal athttp:/ / help.sap.com/ hr_ec.
EC sends Benefitfocus the complete data about an employee. Benefitfocus then updates the benefits providers
daily about any changes that may have occurred.
Benefitfocus has the following user roles:
Employees: Access Enrollment System
Benefits Administrator: Access Manager Tools
System Administrator: Access Data Exchange
Finance Administrator: Access Billing
Note
If the integration does not meet the customer's integration requirements, contact SuccessFactors
Integration Customer Support and provide a description of the requirements not met by the integration
pack. If a customization can satisfy the specific non-standard requirements, a copy of the process will be
made available through the process library. However, please note that ongoing updates to the integration
pack will not flow into your custom copy.
http://service.sap.com/~sapidb/012002523100008617742014Ehttp://service.sap.com/~sapidb/012002523100008617742014Ehttp://help.sap.com/hr_echttp://help.sap.com/hr_echttp://help.sap.com/hr_echttp://service.sap.com/~sapidb/012002523100008617742014Ehttp://service.sap.com/~sapidb/012002523100008617742014E7/25/2019 Benefitfocus_Boomi_1602
7/64
SuccessFactors Employee Central and Benefitfocus
Benefitfocus Integration Overview
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 7
1.2 Benefits Business Process with Benefitfocus
The Benefitfocus process template is available in the master Boomi account. You can copy the process template
from this master account and adapt it to individual client requirements.
The integration is done via a CSV file on the SFTP Benefitfocus Server which is called inbound payMax file.
Inbound payMax files are always Full Files. A Full File contains the employers entire employee population and
includes all data for each employee in the payroll/ HRIS system. Employers are typically able to provide full files
much more easily than changes only files. In the provided Boomi process template only the required (subset) of
the paymax file fields are mapped.
The Benefitfocus process was designed to detect differences and compare full files to the population stored in
Online Enrollment.
Note
If, for technical or business reasons, there is a need on a single day to send files multiple times to
Benefitfocus that need to be processed separately or differently, the customers account manager must
notify the production support team at Benefitfocus before generating the additional files. This is to ensure
that existing files are not overwritten.
The inbound payMax file contains two record types that include both file and member identifying information. The
specific record types are included in the following list:
payMax Header
Employee Detail Record
The payMax Header record is followed by one or many Employee Detail records. The file must adhere to the
record type sequencing rules to ensure the file loads properly.
Note
This integration only works for country US since Benefitfocus does not support other countries yet.
If EC is the system of record, then it is required for all the Benefitfocus fields to be read-only. In case one
of the mapped fields is not required, it should not be made visible on the Benefitfocus system
7/25/2019 Benefitfocus_Boomi_1602
8/64
8
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefitfocus Integration Overview
1.3 Overview of Payroll Export Process
This section details the integration between Benefitfocus and EC Payroll. EC is the system of records for an
employee and the required details / eligibility data will flow from EC to the third-party provider (outbound
integration). Based on the eligibility information/ personal data of an employee, benefits plans are offered to an
employee by the benefits provider. An employee elects into a benefits plan by logging into the provider's
application through SSO and the provider will completely process the benefits plans based on the election
information of an employee and sends the deduction information to the payroll system to be accounted in
calculation of remuneration.
The deduction coming from the provider for an employee can be a pre-tax contribution or a post-tax contribution
and payroll will accordingly process the information as per the legal rules defined for these plans.
Some benefits plans, for example, 401(k), need special processing as per the legal rules defined by the federal
government, for example, how the pre-tax and post-tax contribution for 401(k) should be handled and how the
contribution should be processed for the 401(k) plan once the pre-tax limit is reached. Most of the special
processing is to be handled during actual payroll execution, that is, during processing remuneration and tax
calculation.
So to be compliant with legal rules on processing such plans, we are using benefits engine on EC Payroll to
process the plan as per the legal rules and also EC Payroll is already designed to handle such plans.
So keeping legal rules and processing in mind, only the following plans will be processed using benefits engine:
401(k) plan (savings plan).
For the rest of the plans, that is, health, credit, disability, FSA, and insurance plans, infotype 14 and infotype 15 are
used to process benefits plans based on whether it is a periodic deduction or a one-time deduction. Infotype 14 is
recurring payments/ deductions and infotype 15 is for additional one-time payments/ deductions.
7/25/2019 Benefitfocus_Boomi_1602
9/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 9
2 Employee Data Replication
The replication of employee master data from EC to Benefitfocus uses the Compound Employeeservice from EC
and the Benefitfocus payMax file which contains the required Benefitfocus elements.
For information on Compound Employee
Element structure
See EC HRIS-element
Person Information Person Information [EC hris-element-id: personInfo]
Personal Information Personal Information [EC hris-element-id: personInfo]
Address Information Address Information
Phone Information Phone Information [EC hris-element-id: phoneInfo]
Email Address Information E-mail Information [EC hris-element-id: emailInfo]
Employment Information Employment information [EC hris-element-id: employmentInfo]
Pay Component Recurring Pay Component Recurring Information [EC hris-element-id:
paycomponentRecurring]
National ID Card National ID Card
2.1 Prerequisites
2.1.1 Configurations for Employee Central API CompoundEmployee
The Employee Compound Application Programming Interface (API) for EC pulls employee data out of EC. It
returns employee data in a hierarchically structured response XML (root node: employee person data).
Choose your regional API endpoint from the table below:
Location End Point
Europe https:/ / api.successfactors.eu/ sfapi/ v1/ soap
USA, New J ersey https:/ /api.successfactors.com/ sfapi/ v1/ soap
USA, Arizona https:/ / api4.successfactors.com/ sfapi/ v1/ soap
Get the generic WSDL by adding ?wsdlto the above addresses. For example,
htt ps:/ / api.successfactors.eu/ sfapi/ v1/ soap?wsdl
7/25/2019 Benefitfocus_Boomi_1602
10/64
10
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
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. It needs to be
maintained manually as part of the development process. The new API will only provide 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:
Webservice setup
Follow the standard process for SF APIs to set up SFAPI operations login and logout and to enable the API.
Thresholds and limits
The API compound Employee has similar thresholds and limitations as the other SFAPIs. 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 or SuccessFactors and by using custom fields. The external
application must be able to process the extended response successfully. The API request message type canbe enhanced by new processing and 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.
2.1.2 Configurations for Employee Central OData API
Some EC data is fetched using the Employee Central OData API. To extract this data, you must enable the OData
API.
Prerequisites
You have enabled the OData API via Provisioning.
The API user has admin access for the OData API.
This permission can be granted in Admin Tools.
For more information about OData API configurations, see theSuccessFactors HCM Suite OData API User
Guide.
Note
Currently, location data is fetched via OData API. If you want to use location data, it is mandatory to
configure the OData API.
2.1.3 Preparations Required at Third-Party Provider's End
Once a customer opts for particular third-party provider integration, he should sync on the following points for
initial setup preparations to be done at a third-party provider's end:
Functional Preparation
For example, availability of a document like 'Discovery and Requirements Gathering'
Group and Benefits Plan Setup
http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdfhttp://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdfhttp://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdfhttp://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf7/25/2019 Benefitfocus_Boomi_1602
11/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 11
o Technical Setup of Employee File
For example, availability of documents like 'Integration and Data Migration Discovery'
o SFTP Server configuration
2.2 Integration Specification
The following tables list the EC fields required to replicate EC data using middleware to Benefitfocus. They also
show which fields you need to map manually and the corresponding picklist IDs. Also provided are descriptions of
the mapping activities that are required for different fields.
Note
Categories are used by Benefitfocus to identify different classes or subgroups of employees at the carrieror employer. Examples of categories can be location, department, division, etc. Categories can be used to
configure rates, enable benefits, or configure administrator permissions.
Note
The length constraints of Benefitfocus specified in the following tables (Max Lengthcolumn) must be
considered on the EC side when maintaining employee data for the respective fields. If the data for an
employee does not satisfy the length constraint, the employee is not sent to Benefitfocus.
Note
The data types used in this document (column Typein the following tables) are as follows:
A = Alphanumeric
N = Numeric
D = Date
T = Time
M = Monetary
2.2.1 Person Information [EC hris-element-id: personInfo]
EC hris Field Description Obligatory
for
Replication
Code
Mapping
Required
Picklist ID Benefitfocus
Attribute Max
Type
Length
date-of-birth Date of birth X Dateof Birth 8 D
person_id_external
External
Person ID
X Employee ID 19 A
No further mapping activities are required for these fields.
7/25/2019 Benefitfocus_Boomi_1602
12/64
12
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
2.2.2 Personal Information [EC hris-element-id: personInfo]
EC hris Field Description Ob ligatory
for
Replication
Code
Mapping
Required
Constraint
/ Constant
Value
Picklist ID/
Cross-
Reference
ID
Benefitfocus
Attribute Max Type
Length
gender Gender X Gender 1 A
firstName
Given
name
X First Name 50 A
lastName
Family
name
X Last Name 50 A
middleNameMiddlename
X MiddleName
50 A
marital-status
Marital
status
X ECBF-
Benefit-
focus
Marital
Status
Marital
Status
10 A
suffix
Suffix X X ECBF-
Benefit-
focus
Name
Suffix
Suffix 10 A
X ECBF-
Benefit-
focus EEO
Categories
EEOC 50 A
X Current
Date
Name
Change
Date
8 D
gender
The outbound service sends the values M = male and F=female. Don't associate this field with a picklist. The
values are automatically mapped to the Benefitfocus CSV File via the XML Profile.
In this case, no additional mapping in the middleware or the inbound service is required.
Marital-status
These values are mapped in Boomi via the cross-reference tableECBF ECtoBenefitfocus Marital Status. This table
is defined as an extension table in Boomi and must be filled by the consumer based on the picklist and the
Benefitfocus values. Default mapping values are available.
suffix
The field suffixis mapped to the Benefitfocus field Suffixvia a cross-reference look-up.
7/25/2019 Benefitfocus_Boomi_1602
13/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 13
These values are mapped in Boomi via the cross-reference tableECBF-Benefitfoc us Name Suffix.This table is
defined as an extension table in Boomi and must be filled by the consumer based on the picklist and the
Benefitfocus values. See also Benefitfocus Payroll Integration Inbound Specifications - Employee suffix valid
values.
EEOC
These values are mapped in Boomi via the cross-reference tableECBF-Benefit focus EEO Categories. This table is
defined as an extension table in Boomi and must be filled by the consumer based on the picklist and the
Benefitfocus values.
Name Change Date
The fieldName Change Dateof Benefitfocus is currently mapped to be set to the current Date.
2.2.2.1 Personal Information USA [EC hris-element-id:personInfo]
EC hris Field Description Obligatory
for
Replication
Code
Mapping
Required
Picklist ID/
Cross-
Reference ID
Benefitfocus
Attribute Max Type
Length
genericString1
ECBF-
Benefitfocus
Ethnicity
Ethnicity 20 A
Ethnicity
The field genericString1is mapped to the Benefitfocus field Ethnicityvia a cross-reference look-up.
These values are mapped in Boomi via the cross-reference tableECBF-Benefitfoc us Ethnicit y. This table is defined
as an extension table in Boomi and must be filled by the consumer based on the picklist and the Benefitfocus
values.
2.2.3 Address Information
EC hris Field Description Ob liga-
tory for
Replicat-
ion
Code
Mapping
Required
Constraint
Value
Picklist ID/
Cross-
Reference ID
Benefitfocus
---------------------------------
Attribute Max Type
Length
address-
type
Address
type
'HOME' addressType
address1
Address
field 1
X Address
Line 1
50 A
7/25/2019 Benefitfocus_Boomi_1602
14/64
14
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
EC hris Field Description Ob liga-
tory for
Replicat-
ion
Code
Mapping
Required
Constraint
Value
Picklist ID/
Cross-
Reference ID
Benefitfocus
---------------------------------
Attribute Max Type
Length
address2
Address
field 2
optional Address
Line 2
50 A
city City X City 50 A
state State X X State 2 A
zip-code ZIP code X ZIP Code 10 A
country
Country X Country
Code
3 A
Address Type
In the case of address information, a constraint in Boomi only transfers the address typehometo Benefitfocus.
City
The EC fieldCityis mapped directly to the corresponding field Cityin the payMax file. No further mapping is
required.
ZIP Code
There is direct mapping to the corresponding field ZIP Code. No further mapping is required.
Country
There is direct mapping to the corresponding Country Code. No further mapping is required.
State
The EC fields stateandprovinceare mapped to the field Statein the payMax file via a choose non-null field
function. This user-defined function uses Groovy script to identify null values and return only the non-null values.
2.2.4 Phone Information [EC hris-element-id: phoneInfo]In the case of phone information, a constraint in Boomi transfers the phone information according to phone_type.
In the Boomi mapping, a script maps a phone number with typeH(home) to HomePhone, a phone number with
typeC(cellphone) to CellPhone, and a phone number with typeB(business) to WorkPhone.
7/25/2019 Benefitfocus_Boomi_1602
15/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 15
EC hris Field Description Obligatory
for
Replication
Code
Mapping
Required
Constraint
Value
Picklist
ID/ Cross-
Reference
ID
Benefitfocus
------------------------------------
Attribute Max Type
Length
phone_type Phone type X C, H, B
phone_number
Phone
number
X HomePhone
/ CellPhone/
WorkPhone
10 N
Phone Number
The EC fields area_codeand phone_numberare mapped to the fields HomePhone/ CellPhone/WorkPhone
(depending on phone_type) in the payMax file 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. This is achieved in 3
steps:
1. String Append
The phone number is appended to the area code.
2. String Remove
Any unwanted characters are removed.
3. Right Character Trim
The phone number is trimmed from the right while keeping the length fixed to 10.
2.2.5 Email Information [EC hris-element-id: emailInfo]
In the case of email information, a constraint in Boomi transfers the email information according to email_type.
In the Boomi mapping, a script maps an email-address with type P(personal) to Personal Email, and an email
address with typeB(business) to Work Email.
EC hris
Field
Description Obligatory
for
Replication
Code
Mapping
Required
Constraint
Value
Picklist
ID/ Cross-
Reference
ID
Benefitfocus
Attribute Max
Type
Length
email-
address
address
X Personal
/ Work Email
50 A
email-
type
address
type
P =
Personal
B = Business
email-type
The EC fieldemail-addressis mapped to the fieldPersonal Email/ Work Emailin the payMax file according to
email-type. email-type can have the following values:
7/25/2019 Benefitfocus_Boomi_1602
16/64
16
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
P = Personal
B = Business
2.2.6 Employment Information [EC hris-element-id:employmentInfo]
EC hris Field Description Obligatory
for
Replication
Code
Mapping
Required
Picklist
ID
Benefitfocus
Attribute Max Type
Length
Start Date Start Date X Date of Hire 8 D
End_date End Date X X Termination Date 8 D
X Termination Reason 1 A
Benefitfocus Termination Reason and Termination Date
Only in cases where end_dateis maintained and the EC field emplStatusis not active (A), is the fieldTermination
Dateof Benefitfocus directly mapped to EC field end_date, and the field Term ination Reasonof Benefitfocus set to
valueV(Voluntary).
2.2.7 Compensation Information [EC hris-element-id:compensationInfo ]
EC hr is F ield Descript ion Obligatory
for
Replication
Code
Mapping
Required
Picklist
ID
Benefitfocus
Attribute Max Type
Length
start_date
Start Date Earning
Amount
Effective Date
8 D
7/25/2019 Benefitfocus_Boomi_1602
17/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 17
2.2.7.1 Pay Component Recurring Information [EC hris-element-id: paycomponentRecurring]
EC
hris
Field
Description Obligatory
for
Replication
Code
Mapping
Required
Constraint/
Constant
Value
Picklist
ID/ Cross-
Reference
ID
Benefitfocus
Attribute Max Type
Length
X X Salary 11 M
X Pay
Frequency
15 A
ANNUAL Earning Unit
of Measure
20 A
Salary
The following EC fields are mapped to the fieldSalaryin the payMax file via a calculate annual salary function:
Pay_component_type
Pay_component
paycompValue
frequency
annualizationFactor
Pay FrequencyThis field is mapped to the process propertyPay Frequencythat can be set under the ECBF-General Sett ings
extension. It has to be set before running the replication process.
2.2.8 National ID Card
EC hris
Element
EC hris
Field
Description Obligatory
for
Replication
Code
Mapping
Required
Picklist
ID
Benefitfocus
Attribute Max Type
Length
nationalIdCard national-
id
National
identification
X X Social
Security
Number
(SSN)
9 N
Nat ional ID Card
The EC fieldnationalIdCard ismapped to the field Social Security Num ber(SSN)in the payMax file via a string
remove function. This function removes the hyphens '-' from national-id.
7/25/2019 Benefitfocus_Boomi_1602
18/64
18
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
Note
national-idis obligatory for replication. No further mapping is required.
2.2.9 Emergency Contact Information
EC hris
Element
EC
hris
Field
Description Obligatory for
Replication
Code
Mapping
Required
Picklist
ID
Benefitfocus
Attribute Max Type
Length
name X X Emergency
Contact
Name
50 A
relationship Emergency
Contact
Relationship
20 A
Phone Emergency
Contact
Phone
10 N
Second_phone Emergency
Contact
AlternatePhone
10 N
address1 Emergency
Contact
Address
Line 1
50 A
address2 Emergency
Contact
Address
Line 2
50 A
city EmergencyContact
City
50 A
state Emergency
Contact
State
2 A
zip_code Emergency
Contact Zip
Code
10 A
7/25/2019 Benefitfocus_Boomi_1602
19/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 19
EC hris
Element
EC
hris
Field
Description Obligatory for
Replication
Code
Mapping
Required
Picklist
ID
Benefitfocus
Attribute Max Type
Length
country Emergency
Contact
Country
3 A
Emergency Contact State
The EC emergency_contact_informationfields state and provinceare mapped to the fieldEmergency Contact
Statein the payMax file via a choose non-null field function. This user-defined function uses Groovy script to
identify null values and return only the non-null values.
2.3 Integration Process Overview
The mapping of the EC fields to the third-party providers field requirements is done via the Boomi process. The
following section explains how information is mapped from EC to the third-party provider using Boomi as the
middleware.
The following graphic depicts the overall process to send employee data from EC into the Benefitfocus SFTP
Server in Boomi.
Broadly, the steps in the main process ofBenefitfocus payMaxare:
1. Sets the Custom Filter process property to the process. This process property can be used to filter the EC
Compound Employee data set (comma-delimited custom filters for the CompoundEmployee document can
be supplied in the format "person/ national_id_card/ country=USA,GRE;person/person_id=117", etc.)
2. Calls the following subprocesses.
o Sub: ECBF Build Query Filter: - This process builds the WHERE clause that can be used with any query
which is a part of this process.
o Sub: ECBF payMax Header and Details: - As the name indicates, this process creates the Header and
Detail records.
3. Combines the header and detail records into a single document (Combine Docs step). The file name is set
using the set properties component.
7/25/2019 Benefitfocus_Boomi_1602
20/64
20
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
4. The process is then routed based on the Process PropertyFile Encrypt ion Mode. If the valueTESTis passed,
the PGP Encryption of the file is skipped. This is done for testing purpose. If no value is passed, then PGP
Encryption takes place, which is the default behavior. Finally, the file is written to a SFTP location.
ECBF payMax Header and Details
1. This process makes a call to the subprocessSub:ECBF Compound employee to Benefitfocus payMax Details
to generate the detail records.2. All employee detail records are combined into a single document.
3. The header file is also generated and then both these files are returned to its immediate parent process ECBF
130 8-Benefitfoc us payMax File.
ECBF Compound Employee to Benefitfocus payMax Details
1. This process calls the subprocess Sub: Cache for CompoundEmp loyee Fixupthat queries the required data
and caches it in case it is needed further down the process.
2. It queries EC based on the aforementioned WHERE.
3. It makes the subprocess call Sub:Handling Global Assignmentto handle global assignment information.
1. It filters out future global assignments.
2. It splits the document based on employment information. So if an employee has global assignments,
separate documents are generated for each assignment. In these documents, only the employment
information is different; all other details of the employee remain the same.
3. After separating the home and host assignments, only the assignments with legal entity country USA are
accepted and sent for further processing. Thus, only employees with either home or host assignment in
USA are accepted.
7/25/2019 Benefitfocus_Boomi_1602
21/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 21
4. It makes the subprocess call Sub:CompoundEmployee Filter M atcher. The records are filtered based on all the
filter condition values supplied and the document property FILTERMATCH. Only the records that pass the
specified criteria are processed and the rest are rejected.
Here, the process branches two ways:
o For every record, the document properties EMP_STATUS and END_DATE are set to default values asexpected from the query. Then the record is sent for mapping.
o The current logic at this step is to detect the employee missing from the payMax file compared with the
prior file (the last file is cached each execution). The accepted records are checked with the history using
theFind Changescomponent. If the record is not found, it is added to the find changes cache and that
record is notified to the user as a deleted record. For such records, the document property EMP_STATUS
is set to T, with a termination date of today, and the termination reason is picked from the lookup
reference table of Employee Central.
Note
On the next execution of the process, this employee is not included with a termination status. So it is
important that each consecutive file runs against Benefitfocus, or the terminations are lost.If no value in the lookup reference table is maintained then a blank value is picked from the table.
5. After the mapping, the records are combined and returned to the immediate parent process Sub:ECBF
payMax Header and Details.
Note
If the mapping fails for a particular employee record, the person_id_externalis logged.
For each record returned by the query, it is checked if the log_itemis not null. If true, the log item along
with its message text is logged. The person_id_externalis also logged.
You can check these logs by choosingManageProcess Report ing. Select the executed process and
chooseView Process Logs.
7/25/2019 Benefitfocus_Boomi_1602
22/64
22
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
You can then filter the logs by type.
2.4 Getting Access to the Integration Pack
Integration packs are packaged integration solutions, each consisting of one or more published Boomi processes.
For the current solution, SAP delivers an integration pack for the Boomi middleware, which handles the mapping
for all standard employee data fields. This integration pack contains the required mapping between the EC datafields and the corresponding fields in the inbound structure of the Benefitfocus system. Data only travels in one
direction. Only the EC data is sent to Benefitfocus.
The Browse Integration Packs dialog, which is accessible from the Deploy page in Boomi, lets you install
integration packs in your account. Once you install an integration pack, you can attach Atoms or environments to
it and then run any of its processes from the Deployed Processes tab in Atom Management.
You can monitor the release status of installed integration packs and apply pending updates from the Integration
Pack Versions tab in Atom Management. Integration pack building and release is performed in a master account.
Once an integration pack is released, the user administering the integration pack shares it with selected account
groups they manage.
Prerequisites
The user account must have the appropriate permissions to deploy, configure and monitor an integration
pack.
The customer Boomi account must be provisioned for access to both the integration pack and the Atom
Cloud where it will be deployed. It assumes that an environment has been created in the customer account
and attached to the Boomi Cloud.
Deploying the Integration Pack
1. Log into the customer Boomi account at http:/ / platform.boomi.comusing the user name and password.
2. In theDeploytab, click the+on the Integration Packsection on the lower left size.
3. Click the view and navigate through to install the integration pack.4. Click the Integration Packpreviously added to the account.
5. Choose the environment on the right-hand side and click
7/25/2019 Benefitfocus_Boomi_1602
23/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 23
To configure the SuccessFactors connection to Benefitfocus you can fill the following entries:
Endpoint:Datacenter
Company ID:Customer EC Company ID
Username and Password:API User and Password that have the permission to retrieve the data from API
Configuring Web Service Connectivity
10. Select the Benefitfocus connection from the Connection List.11. If accessing a server other than the default, enter the WSDL and endpoint URLs.
7/25/2019 Benefitfocus_Boomi_1602
24/64
24
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
2.5 Setting Up the Standard Data Integration
2.5.1 Extensions for Connection Settings
Benefitfocus SF-API Connection
To configure the SuccessFactors connection to benefits provider, fill out the following entries:
Endpoint: Datacenter
Company ID: Customer EC Company ID
Username and Password: API User and Password that have the permission to retrieve the data from API
Benefitfocus SFTP Server Connections
To configure the process to connect to the Benefitfocus SFTP server, make the following entries:
7/25/2019 Benefitfocus_Boomi_1602
25/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 25
Field Description
Host Hostname of Benefitfocus SFTP server
Port Port of Benefitfocus SFTP server
User/ Password User and password for Benefitfocus SFTP server
2.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
Pay Frequency Pay Frequency field of Benefitfocus file
Benefitfocus Client ID Client ID for the Benefitfocus account/ tenant
SFTP Directory Directory on Benefitfocus server where the file is
saved
SFTP File Name Name of the target Benefitfocus file. The date is
automatically appended to the file name along withthe .csv extension.
File Encryption Mode Specifies the type of deployment. DEMO sends to a
Disk Connector on a local atom. Other modes send to
Benefitfocus SFTP server either encrypted or
unencrypted. Demonstration mode writes to a local
Atom's work file folder.
7/25/2019 Benefitfocus_Boomi_1602
26/64
26
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
Filter Opt ions
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
is_fulltime_employee Include only full-time employees
pay_group Include the foundation object externalCode if you want to include onlyemployees associated with that foundation object. (This is a
pay_group in job information and not in compensation information.)
employee_class Comma-delimited list (no blank spaces before/ after comma) for
specifying the employee classes to include in the extract
regular_temp Include regular or temporary employees
employment_type Include employees with a particular employment type
location Include the foundation object externalCode if you want to include only
employees associated with that foundation object
company Comma-delimited list (no blank spaces before/ after comma) for
specifying the companies to include in the extract
company_territory_code Comma-delimited list (no blank spaces before/ after comma) for
specifying the single company_territory_codes to include in the
extract
business_unit Include the foundation object externalCode if you want to include only
employees associated with that foundation object
Custom Filters Comma-delimited custom filters (no blank spaces before/ after
comma) for the CompoundEmployee document in format
7/25/2019 Benefitfocus_Boomi_1602
27/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 27
Filter Description
"person/ national_id_card/ country=USA,GRE;person/ person_id=117"
, etc.
person_id_external Comma-delimited list (no blank spaces before/ after comma) for
specifying the person_id_externals to include in the extract
Terminate Filtered Employees Include newly filtered employees as terminated, one time
Pay Components Comma-delimited list (no blank spaces before/ after comma) of pay
component IDs to include in calculating annual salary. If blank, all
(max 6) are included.
Include Terminations Determines how long terminated employees should be included in the
payMax file before they are excluded
7/25/2019 Benefitfocus_Boomi_1602
28/64
28
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
7/25/2019 Benefitfocus_Boomi_1602
29/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 29
Custom Category Types
You can use this extension to map a particular custom category type to a particular EC field.
For example:
Field: Custom Category Type 1
Value: Location
2.5.3 Cross-Reference Tables
The cross-reference tables are translation tables between the EC picklist entries and the Benefitfocus values.
Fill out the cross-reference tables to add or override the existing values.
1. Navigate toManage Atom Management.
2. ClickEnvironmenton the left-hand side.
3. ClickEnvironment Extensionson the right-hand side.
TheExtensionspop-up appears.
4. ClickCross Reference.
5. Select the cross-reference to be changed from the dropdown. Below is an example of how you can customize
a gender code mapping.
The following cross-reference tables are available:
o Suffix:In the first column, enter the EC suffix code, and in the second column the Benefitfocus suffix.
7/25/2019 Benefitfocus_Boomi_1602
30/64
30
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
o Ethnicity:In the first column, enter the EC ethnicity code, and in the second column the Benefitfocus
ethnicity.
o EEOC categories:In the first column, enter the EC EEOC code, and in the second column the
Benefitfocus EEOC.
7/25/2019 Benefitfocus_Boomi_1602
31/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 31
o Marital Status:In the first two columns, enter the EC marital status and description, and in the next two
columns the Benefitfocus marital status and description.
o Pay Frequency:In the first column, enter the Benefitfocus pay frequency, and in the second column the
EC pay frequency.
7/25/2019 Benefitfocus_Boomi_1602
32/64
32
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
2.5.4 PGP Encryption
You can change the following settings to use a certificate for the PGP encryption of the output file of theintegration process.
2.5.5 Data Maps
The earlier type of data maps allows field-to-field mapping defined by map components within a process to be
augmented, replaced, or overridden when the process is deployed. You can map to destinations that have already
been mapped in the original maps. However, you cannot map to a destination that has already been mapped by an
override mapping. You can add functions to data map extensions. All function types except user-defined functions
are available. The Simple Lookup function type can be used to return a single value.
The mapping controls are similar to those in the map component creation interface, which is drag-and-drop.
Mapping overrides are displayed as black lines.
These field mapping extensions are subject to the following limitations:
You cannot select different source or destination profiles.
Mappings cannot be unmapped. You can see all of the mappings defined in the original map(s), but youcannot change the mappings. These mapping lines are displayed in a light orange color.
Only simple field-to-field mappings are supported. In other words, advanced mapping logic including
transformations, conditional scripting, and other function-type actions are not supported. For example,
destination fields mapped from map functions in the underlying map cannot be customized.
Only mappings using XML or flat file profiles are supported and, in the case of flat file profiles, only those with
single-record formats.
If the original maps contain map functions, they will be displayed in gray indicating they are disabled, that is,
you can view but not change the configuration and default values of the map functions.
For function types that require a separate component, such as connection and operation components in
connector calls, you can select only components that are defined in the original process.
You cannot add cached data to the source profile.
7/25/2019 Benefitfocus_Boomi_1602
33/64
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 33
You cannot add default values to the destination profile.
The Map Function Ordering dialog is not available. Functions in the original maps are processed first, followed
by functions in the Extensions dialog.
The second type of data map extension allows the addition of fields to flat file profiles used in map components
within a process when the process is deployed. The profiles must have single-record formats, as opposed to
multiple or nested-record formats. This type of extension applies only to the map component for which the
extension is defined; other maps that use the same profile are not automatically extended.
2.6 Extending the Standard Data Integration
This section describes the cases where a customer wants to enhance the current solution and to add some
custom fields.
To make changes, you must be familiar with the following topics:
Boomi process development
EC compound APIs
Example
Consider an example where a customer wants to enhance the current process to adjust 10 custom fields
in the destination file. In this case, the Map Step of the Boomi process needs to be changed to adjust the
10 User Defined fields.
Once the fields are introduced, the customer may choose to map the required field from EC to the
destination fields.
7/25/2019 Benefitfocus_Boomi_1602
34/64
34
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Employee Data Replication
7/25/2019 Benefitfocus_Boomi_1602
35/64
SuccessFactors Employee Central and Benefitfocus
Integrating the Benefitfocus UI
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 35
3 Integrating the Benefitfocus UI
You can enable single sign-on from the EC UI, as a part of the integration to Benefitfocus.
3.1 Single Sign-On (SSO)
This section describes how you can configure an SSO connection to Benefitfocus.
Prerequisites
A provisioning user for a respective SuccessFactors tenant is needed to maintain the SSO configuration.
Employee Central must be implemented to enable SSO connections to Benefitfocus.
3.1.1 Employee Central Certification for Benefitfocus
The following information is used by, and already in place with Benefitfocus for SSO configuration:
Issuer ID
www.successfactors.com
SAML metadata and signing certificate
This is the signing X509 certificate for SSO communication and can be taken from the X509Certificate tag of
the SAML metadata file.
3.1.2 Configuration of Employee Central Identity Provider forBenefitfocus
To set up an SSO connection, the following steps must be completed in Employee Central.
Prerequisites
Access to Provisioning is required for the EC company.
Procedure
6. In Provisioning, select the company and chooseAuthorized SP Assertion Consumer Service Settings.
http://www.successfactors.com/http://www.successfactors.com/7/25/2019 Benefitfocus_Boomi_1602
36/64
36
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Integrating the Benefitfocus UI
7. Enter the following values:
Field Value
Assertion Consumer Service https:/ / sp.benefitfocus.com/sp/ACS.saml2
Audience URL benefitfocus.com:sp
SP Mapping Key bf
3.1.3 Configure My Benefits Link for Benefitfocus
To configure theMy Benefitslink for Benefitfocus, carry out the following steps in EC. This also requires access to
Provisioning for the EC company.
https://sp.benefitfocus.com/sp/ACS.saml2https://sp.benefitfocus.com/sp/ACS.saml27/25/2019 Benefitfocus_Boomi_1602
37/64
SuccessFactors Employee Central and Benefitfocus
Integrating the Benefitfocus UI
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 37
1. To activate and configure the link to Benefitfocus via jump-to, include the authentication via IdP withBFas
the mapping key.
2. For activation, chooseCompany Company Settings Enable Employ ee Centra l V2 My Benefit Link.
3. Enter the target URL:
Error Hyperlink reference not valid.
4. In Provisioning,select the company and choose Import/ Export Data Modelunder Succession Management.
5. Download the data model and add the following (if it is not already there):
My Benef i t s My Benef i t s
Mei ne Vort ei l e
7/25/2019 Benefitfocus_Boomi_1602
38/64
38
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Integrating the Benefitfocus UI
6. In EC Admin Tools, chooseConfigure Employee FilesunderEmployee Files.
7. Check that theMy Benefitsentry is visible.
8. In Admin Tools, chooseManage Perm ission RolesunderManage Security.
9. Choose the relevant permission role.
10. Under Permission sett ings, clickPermission
11. Under Employee Views, check that theMy Benefitsentry is visible. Make sure the permission role is assigned
to the relevant users.
7/25/2019 Benefitfocus_Boomi_1602
39/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 39
4 Benefits Data Replication
This chapter describes how to export benefits data from Benefitfocus to EC Payroll. It includes the following major
steps:
In Benefit focus:
Benefits data is extracted from Benefitfocus to a CSV file and saved in an SFTP location.
In Boomi:
Boomi accesses this SFTP location and transfers the benefits data to EC Payroll using a web service call.
In EC Payrol l:
Web service call to EC Payroll automatically updates the benefits information in EC Payroll.
Note
These specifications apply to the US country version. If a customer implements any other country
version, some adjustments might be necessary.
SAP Note 1935616describes in detail the custom implementation of a web service in EC Payroll. Please
implement this note in the customer's EC Payroll system, following the instructions carefully to execute the web
service correctly.
From the May 2014 release onwards, we recommend using the standard web service that is available to update
benefits information in EC Payroll. This web service is delivered as standard in the following add-on. The add-on is
a prerequisite for using the standard web service.
SFIECPEP 100 - SuccessFactors Employee Central Payroll, third-party data integration tool
4.1 Business Add-In HR_ECPINTEP_BEN_DATE_OR
You can use Business Add-In (BAdI) HR_ECPINTEP_BEN_DATE_OR to override the date information from the
provider and to process customer-specific custom fields from the provider in the EC Payroll system.
You can implement this BAdI in Customizing for Personnel Managementunder Personnel Adm inistrat ion
Interfaces and Integration Integration of SuccessFactors Employee Central with External Providers BAdI:
Override Benefits Provider Data. No default implementation of this BAdI is provided because the implementationdiffers from customer to customer based on their requirements. For more information, see the BAdI
documentation.
4.1.1 Processing Custom Fields Using Business Add-Ins
If Benefitfocus enhances the file layout with customer-specific fields requiring processing, or if additional fields
that are part of the file layout, but not part of the standard BAdI parameters, need to be passed to the BAdI for
processing, you can achieve this as follows:
http://service.sap.com/sap/support/notes/19356167/25/2019 Benefitfocus_Boomi_1602
40/64
40
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
1. Add the new fields in the Boomi maps and map them to custom fields in the profile, or map the existing fields
required for processing inside the BAdI using data map extensions.
2. Implement the BAdI to process the fields according to the customer's requirements.
Example
The following example shows how additional fields that are part of the file layout can be passed to BAdIs
for processing.
1. After the process is deployed in Boomi, go to Connect ion Settingsand select the process.
2. Go toProcess Propertiesand maintain the name for the value to be passed in each custom field.
The names in the process properties will be available inside the BAdI with the value.
7/25/2019 Benefitfocus_Boomi_1602
41/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 41
3. Go toData Mapsand select the map shown in the screenshot below.
4. Map the required values to the CUST_VALUE fields on the right-hand side. Make sure the respective
values are mapped in the order of the names specified in step 2 above.
5. After the additional fields are configured using the data maps extension in Boomi, the fields are
available in the BAdI for processing.
7/25/2019 Benefitfocus_Boomi_1602
42/64
42
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
4.2 Benefits Data Mapping
The following fields are considered during the replication.
Position
(Delimited)
Field Name Size Type Trigger Description Function/ Cross-
Reference
EC Payroll
Field Mapping
1
(A)
Social
Security
Number
(SSN)
9 A N Employee Social
Security Number
Format: No
punctuation
2
(B)
Employee ID 19 A N Employer-specific
number to identify
the employee
PERSNO
3
(C)
First Name 50 A N Employee First
Name
4
(D)
Middle Name 50 A N Employee Middle
Name
5
(E)
Last Name 50 A N Employee Last
Name
6
(F)
Suffix 10 A N Employee suffix
7
(G)
Benefit Type 30 A N Employees
Benefit Type
Example: If the
benefit type is a
medical plan
Medical will be
populated. If the
benefit type is a
dental plan
Dental will be
populated.
Function:
Derive pre/post
Tax Wage Type
Cross ref:
CR Benefitfocus
to EC Payroll -
Plan type to
wage type
WAGETYPE
8
(H)
Plan Name 50 A Y Benefit Plan Name.
This shows exactly
what the
application has
stored.
9
(I)
Coverage
Level
30 A Y Benefit Coverage
Levels
Example: If the
coverage level is a
Employee and
Spouse then
7/25/2019 Benefitfocus_Boomi_1602
43/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 43
Position
(Delimited)
Field Name Size Type Trigger Description Function/ Cross-
Reference
EC Payroll
Field Mapping
Employee andSpouse will be
populated. If the
coverage level is a
Employee + 1 then
Employee + 1 will
be populated.
10
(J )
Coverage
Amount
50 M Y Benefit Coverage
Amount
Corresponds to
total coverage
amount.Format:
DDDDD.CC
Note: Primarily
used to report
coverage amounts
for life and
disability benefits.
11
(K)
Pre-Tax
Premium
1 N Y 0 = Post-Tax; 1 =
Pre-Tax
Note: Setting mustbe enabled for
each health plan in
order for the
indicator to be
included.
Function:
Derive pre/post
Tax Wage TypeCross ref:
CR Benefitfocus
to EC Payroll -
Plan type to
wage type
WAGETYPE
12
(L)
Employer
Annual Cost
8 M Y Total Annual Cost
to the employer for
the year.
Formatted to
include two
decimal places.
Format:
DDDDD.CC
No Symbols
13
(M)
Employee
Annual Cost
8 M Y Total Annual Cost
to the employee
for the year.
Formatted to
include two
decimal places.
7/25/2019 Benefitfocus_Boomi_1602
44/64
44
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
Position
(Delimited)
Field Name Size Type Trigger Description Function/ Cross-
Reference
EC Payroll
Field Mapping
Format:DDDDD.CC
No Symbols
14
(N)
Pay
Frequency
2 N Y Number of pay
periods per year.
This number will
remain consistent.
Cross Ref:
CR Benefitfocus
payMax to EC
Payroll
Frequency Code
FREQUENCY
15
(O)
Employee
Cost Per pay
Period
8 M Y Employee Cost per
pay period
Format:DDDDD.CC
No Symbols
Note: Default
formula used is
Annual Cost/ Pay
Frequency. For
Flex plans the
formula is Annual
Cost/ Remaining
Pay Periods. In the
event thatRemaining Pay
Period is not
active, the default
formula will be
applied.
AMOUNT
16
(P)
Imputed Cost 8 N Y Total Annual
Imputed Income
Amount
Format:
DDDDD.CC
No Symbols
AMOUNT
17
(Q)
Employee
Pre Tax Cost
8 N Y Total Annual
Employee Pre Tax
Cost
Format:
DDDDD.CC
No Symbols
GOAL_AMOU
NT
18
(R)
Employee
Post Tax
Cost
8 N Y Total Annual
Employee Post Tax
Cost
7/25/2019 Benefitfocus_Boomi_1602
45/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 45
Position
(Delimited)
Field Name Size Type Trigger Description Function/ Cross-
Reference
EC Payroll
Field Mapping
Format:DDDDD.CC
No Symbols
GOAL_AMOUNT
19
(S)
Employer Pre
Tax Cost
8 N Y Total Annual
Employer Pre Tax
Cost
Format:
DDDDD.CC
No Symbols
AMOUNT
20
(T)
Employer
Post TaxCost
8 N Y Total Annual
Employer Post TaxCost
Format:
DDDDD.CC
No Symbols
AMOUNT
21
(U)
Effective
Start Date
8 D Y Benefit Start Date.
Date benefit is
effective.
Format:
CCYYMMDD
FROM_DATE
22
(V)
Effective End
Date
8 D Y Benefit End Date.
Date benefit ends
Format:
CCYYMMDD
TO_DATE
23
(W)
Election
Status
1 A Y A = Employee is
active and benefit
is active.
Enrollment
records will include
a benefit effective
start date only for
active employmentrecords.
C = Employee is
active but benefit
is cancelled.
Enrollment
records will include
a benefit effective
start date and a
benefit effective
end date, as a
result of the
Cross Ref:
CR Benefitfocus
payMax to EC
Payroll Negated
Election Code
NEG_ELECTI
ON
7/25/2019 Benefitfocus_Boomi_1602
46/64
46
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
Position
(Delimited)
Field Name Size Type Trigger Description Function/ Cross-
Reference
EC Payroll
Field Mapping
cancellationtransaction
processed by an
online enrollment
user for active
employment
records.
W = Employment
is active but
benefit was
waived/ refused.
Enrollmentrecords will include
a benefit effective
end date only for
active employment
records.
T = Employment is
terminated and
benefit is cancelled
as a result.
Enrollment
records will includea benefit effective
start date and a
benefit effective
end date due to a
result of the
Termination of
employment
transaction
processed either
by payroll import
or by an online
enrollment user.
24
(X)
Remaining
Pay Periods
4 N Y Remaining Pay
Periods
Note: Primarily
used in
conjunction with
the Flex benefit
when changes
occur mid-year.
7/25/2019 Benefitfocus_Boomi_1602
47/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 47
Position
(Delimited)
Field Name Size Type Trigger Description Function/ Cross-
Reference
EC Payroll
Field Mapping
25
(Y)
PayrollAttribute
Code 1
25 A Y Please provide alogic table for
determining
unique Plan Codes,
Coverage Codes or
Deduction Codes if
needed.
26
(Z)
Payroll
Attribute
Code 2
25 A Y Please provide a
logic table for
determining
unique Plan Codes,
Coverage Codes orDeduction Codes if
needed.
27
(AA)
Payroll
Attribute
Code 3
25 A Y Please provide a
logic table for
determining
unique Plan Codes,
Coverage Codes or
Deduction Codes if
needed.
28(AB)
PayrollAttribute
Code 4
25 A Y Please provide alogic table for
determining
unique Plan Codes,
Coverage Codes or
Deduction Codes if
needed.
29
(AC)
Payroll
Attribute
Code 5
25 A Y Please provide a
logic table for
determining
unique Plan Codes,
Coverage Codes orDeduction Codes if
needed.
30
(AD)
Deferral Pct 8 N N Percent per pay
period for 401(k)
deduction
Format: 0.00
Example: 5% = .5
31
(AE)
Deferral Flat
Amount
8 N N Per pay period flat
amount for 401(k)
deduction
7/25/2019 Benefitfocus_Boomi_1602
48/64
48
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
4.3 Integration Process Overview
The mapping of the Benefitfocus inbound file fields to the EC Payroll field requirements is done via the Boomi
process. The following information gives you a better understanding of how information gets mapped from third-
party provider to EC Payroll using Boomi as the middleware.
The following graphic depicts the overall process.
Main Process: iFlow: Benefitfocus payMax to EC Payroll - Benefits
This process reads the Inbound flat file and then makes a call to the subprocess, Benefitfocus payMax to ECPayroll Processing. This process in-turn makes a call to the subprocess," Benefitfocus payMax to EC Payroll
Generate Request"
The subprocess generates the request based on the business logic which is derived from the requirements.
Next, all the requests are combined into a single request and then the subprocess,Sub: Upsert Payroll
Request, is called. This process posts valid records to the to a soap request which then updates the payroll
system.
Different reports are generated and sent via an email as a notification to the administrator (only if this feature
is activated).
Subprocess: Sub: Benefitfocus payMax to EC Payroll Generate Request
This process splits a record for an employee into multiple requests and then maps this data to EC Payroll
request.
This process also reports negated elected records and the records where mandatory fields are missing.
7/25/2019 Benefitfocus_Boomi_1602
49/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 49
Subprocess: Sub: Upsert Payroll Request
4.4 Getting Access to the Integration Pack
Integration packs are packaged integration solutions, each consisting of one or more published Boomi processes.
For the current solution, the integration pack contains the required mapping between the Benefitfocus data fields
and the corresponding fields in the inbound structure of EC Payroll. Data only travels in one direction, that is, from
Benefitfocus to EC Payroll.
4.5 Configuring and Using the Integration Pack
From the Deploy page in Boomi, you can install integration packs in your account. Once you have installed an
integration pack, you can attach Atoms or environments to it and then run any of its processes from theDeployed
Processestab in Atom Management.
Prerequisites
To deploy an integration pack, the Boomi user must have the appropriate permissions to deploy, configure, and
monitor an integration pack. It must be authorized for accessing both the integration pack and the Atom Cloud
where the integration pack will be deployed. Follow the below procedure to ensure that an environment has been
created in the customer account and attached to the Boomi Cloud.
Procedure
1. Log on to the customer Boomi account athttp:/ / platform.boomi.com.
Note
To verify that you are in the correct account, see the title in upper right. To switch accounts, choose
Select Accountand search for the required account.
2. In theDeploytab, click "+"on the integration pack section at the lower left side.
7/25/2019 Benefitfocus_Boomi_1602
50/64
50
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
3. Click Viewand navigate through to install the integration pack.
4. Click the integration pack previously added to the account.
5. Choose the environment on the right-hand side and click
7/25/2019 Benefitfocus_Boomi_1602
51/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 51
Mail Connections (Maintain Mail Server Details)
Maintain the mail server connection details to receive an email on the status of the Boomi process execution. On
this configuration, Boomi send the following emails to the configured receiver email in the process properties: Benefitfocus paymax to EC Payroll Successful Records
This is an optional feature to get emails on successful records. You can enable it from the process properties.
Benefitfocus paymax to EC Payroll Errors Records
Benefitfocus paymax to EC Payroll Ignored Records
Benefitfocus paymax to EC Payroll Negated Election Records
Benefitfocus paymax to EC Payroll Mandatory Fields Missing
Note
After the mail server connections are maintained, the sender and the receiver email ID has to be
configured in the Boomi process to enable the Boomi process to send emails.
Web Service Connections
From the May 2014 release onwards, the following web service is delivered as standard, and no custom solution is
required:
EmployeeBenefitsVendorDataUpdateRequestConfirmation_In
For information about the web service that is delivered to update the EC Payroll system, seeWeb Servicefo r
Updat ing SuccessFactor s Employee Cent ral Payrollon SAP Help Portal athttp:/ / help.sap.com/ cloud4hr.
http://help.sap.com/cloud4hrhttp://help.sap.com/cloud4hrhttp://help.sap.com/cloud4hrhttp://help.sap.com/cloud4hr7/25/2019 Benefitfocus_Boomi_1602
52/64
52
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
The WSDL URL and endpoint/binding URL are required to maintain the web service connections. For information
about configuring the web service using transaction SOAMANAGER (that is, creating end points and accessing
the WSDL URL), seeConfiguring a Web Serviceon SAP Help Portal athttp:/ / help.sap.com.
Note
To allow access to the web service from the middleware, the web service must be whitelisted. Kindly
create a ticket to your EC payroll cloud operation team to whitelist the web service.
4.6.2 Process Properties
To fetch data based on a particular filter, modify the process properties of the Boomi process. The following filters
are available for the current integration process.
You can set the following general properties:
o FILE_NAME: Name of the file from Benefitfocus to be read.
o FILE_DIR: Path to the SFTP remote directory.
o APPLOG_OBJ ECT: Name of the application log object created in EC Payroll for logging error messages
o APPLOG_SUBOBJ ECT: Name of the application log sub-object created in EC Payroll for logging error
messages
o CURRENCY: Currency in which the amount is processed
o SENDER_MAIL_ID: Sender email ID for sending emails from Boomi processes
o RECEIVER_MAIL_ID: Recipient's email ID
The linked image cannot be display ed. Th e file may have been moved, renamed, or deleted. Verify that the link po ints to the correct file and location.
http://help.sap.com/saphelp_erp60_sp/helpdata/en/47/3971ff39591a53e10000000a1553f7/frameset.htmhttp://help.sap.com/http://help.sap.com/saphelp_erp60_sp/helpdata/en/47/3971ff39591a53e10000000a1553f7/frameset.htmhttp://help.sap.com/http://help.sap.com/http://help.sap.com/saphelp_erp60_sp/helpdata/en/47/3971ff39591a53e10000000a1553f7/frameset.htm7/25/2019 Benefitfocus_Boomi_1602
53/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 53
4.6.3 Cross-Reference Tables
The cross-reference tables are translation tables between the Benefitfocus values and EC Payroll values.
Fill out the cross-reference tables to add or override the existing values.
1. Navigate toManage Atom Management.
2. ClickEnvironmenton the left-hand side.
3. ClickEnvironment Extensionson the right-hand side.
TheExtensionspop-up appears.
4. ClickCross Reference.
5. Select the cross-reference to be changed from the dropdown. Below is an example of how you can customize
a gender code mapping
The following cross-reference tables are available:
o Employer Contribution Benefit Type Lookup:Maintain benefit plans in this table where employer
contribution needs to be processed once. By default for all the plans employer contribution is processed
per pay period, in the first column you have to fill the benefit plans for which employer contribution should
be processed once, that is, one-time contribution.
The linked image cannot be d isplayed. Th e file may have been moved, renamed, or deleted. Verify that the link po ints to the correct file and location.
7/25/2019 Benefitfocus_Boomi_1602
54/64
54
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved.
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
o CR Benefit focus payMax to EC Payroll Negated Elect ion Code:This cross-reference table is to map the
negated election Benefitfocus code with EC Payroll.
o CR Benefitfocus payMax to EC Payroll Frequency Code: This cross-reference table is to map provider pay
frequency code with EC Payroll frequency code.
4.7 Data Replication Details
Employee benefit deduction data will be sent from Benefitfocus to EC Payroll in CSV format, then converted into
infotypes depending on the plan type category and processed into EC Payroll as an XML file upload.
Here are some assumptions for this solution
Customers will provide mapping of their benefit deductions (wage types) set up in EC Payroll to benefit codes
in Benefitfocus.
4.7.1 Health/ Insurance/ Credit/ Disability/ FSA PlanProcessing
For Health, insurance, Disability, Credit plans, FSA and HSA plans, the EC Payroll benefits engine is not used. The
complete processing, that is, pre-tax contribution, post-tax contribution, employee contribution, and employer
contribution happens at the third-party provider side and only the deduction amounts are passed to the payroll
system.
EC is the system of master data for all employees.
7/25/2019 Benefitfocus_Boomi_1602
55/64
SuccessFactors Employee Central and Benefitfocus
Benefits Data Replication
CUSTOMER
2016 SAP SE or an SAP affiliate company. All rights reserved. 55
Benefitfocus requires employees master data and eligibility data is sent from EC to Benefitfocus.
Benefits elections and enrollment are done by the provider, that is, employees need to log in to the provider's
application/ Web site and elect/ enroll in benefit plans. (SSO Enabled)
Benefitfocus does all the benefits processing and sends the employee and employer deduction/ contributions
to EC Payroll, which is stored in infotype 14 (Recurring payments/deduction) and infotype 15 (Additional
Payments) based on whether it is a periodic payment or a one-time payment respectively.
The pay code information from the provider (that is, pre-tax contribution, post-tax contribution, employee
contribution, employer contribution) is mapped to the wage type on the EC Payroll side. The details of the
wage types for each plan processing is passed over to the provider in advance during implementation, so that
we get the right wage type information in the file from the provider for the respective plans.
The payroll processes the information stored in infotype 14 & infotype 15 based on the wage type
configuration and the results are stored in payroll cluster PLC2 for all employee.
The payroll results stored in the payroll cluster can be used for reporting to the third-party provider.
4.7.2 401(k) Saving Plan Processing
For 401(k) saving plans, the EC Payroll benefit engine is used to process the plans because of the legal rules
involved in processing of these plans. For example, if an employee didnt pay the premium, the system knows
exactly what to do when they come back because they have already committed to the contribution and the benefit
administrator will figure out how the payment has to be done, for example, by check or some other means.
For benefit plans where the benefits engine