2507071 - Employee Central - Email Info HRIS Sync

Symptom

This article explains how HRIS Sync works for emailInfo in EC.

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Environment

SAP SuccessFactors HXM Suite
SAP SuccessFactors Employee Central

Resolution

Hard-Coded Sync FAQ

The synchronization of emailInfo data to EP works as such
Currently there are 2 main fields delivered with the emailInfo element
email-type is used to define the type of e-mail address being stored
The "email-address" field is used to capture the actual e-mail address of that type:

HRIS Element	EC Fields
emailInfo	email-type email-address

How does the system know what e-mail Type to map to the "e-mail" field in EP?

The synchronization is hard-coded based on the pre-delivered picklist "ecEmailType" assigned to the "email-type" field in the emaileInfo elements configuration
What are the hard-coded/standard sync mappings?

The system (by default) will map the data using the e-mail type - as per the below pre-delivered ecEmailType picklist - we map using the external_code of the picklist value:

Hard-Coded Sync Mappings between EC (based on external_code of ecEmailType picklist) and EP fields

By default the system will always synchronize the "Business" (B) Email Type
See "Special Handling for emailInfo Sync - Hard-coded Vs Custom" below for more information

ecEmailType Picklist External Code	EP Field
B	email

Custom Sync Mappings for emailInfo (overriding the hard-coded mappings)

It is possible to override the Hard-Coded Sync Mappings with custom mappings
If you are happy to use the Hard-Coded mappings, do not define any hris-sync-mappings for emailInfo in the Succession Data Model
If you'd like to customize, make sure each of the email-types is mapped (see example below) where we sync the "email-address" field from EC to EP.
Please note if this is not done, the hard coded mappings will not be respected and you may see data not synced or unexpected data synced which may expose personal information you do not wish to be mapped.
The system knows which field to map to based on the external_code of the picklist.
As per the example below, use the external_code from the picklist to identify the "entity-type":

<hris-sync-mappings>
    <hris-element-ref refid="emailInfo">
      <hris-mapping entity-type="B" >
        <hris-field-ref refid="email-address"/>
        <standard-element-ref refid="email"/>
      </hris-mapping>
      <hris-mapping entity-type="P" >
        <hris-field-ref refid="email-address"/>
        <standard-element-ref refid="custom15"/>
      </hris-mapping>
      <hris-mapping entity-type="O" >
        <hris-field-ref refid="email-address"/>
        <userinfo-element-ref refid="cust_EmailAddress"/>
      </hris-mapping>
    </hris-element-ref>

Special Handling for emailInfo Sync. Hard-coded Vs Custom

A validation is used when importing Succession Data Model: For hris-mapping configuration of nationalIdCard/emailInfo/phoneInfo, "entity-type" is a mandatory attribute.

Sync Logic:

"Is Primary" is not considered by Email Address Sync Logic anymore.
Only the "Business" (external_code "B") Email Type will be synchronized by the Hard-Coded sync-mapping.
If you need to over-ride this, you must specify a custom sync mapping (for example add a sync mapping for entity-type = "P").
When adding custom sync logic where the destination is the standard-element "email" the "last modified" email-address will be synchronized.

Special Note:

If both Personal (P) and Business (B) emails are configured in the hris-sync-mapping section of the Succession Data Model to synchronize to the "email" standard-element, the sync logic will behave as follows:

Behaviour:

If the user only has one of the two email types created in emailInfo, that email-address will be synchronized
If the user has both email types created in emailInfo, then the "Last Modified" email-address will be synchronized, but the daily HRIS Sync may revert the email back to the previous value.

Recommendation:

It is not recommended to configure both Personal (P) and Business (B) email-types to synchonize to the standard-element "email"
Instead define a hris-sync-mapping for Personal email-type to synchronize to a different field
Ideally you do not want to allow System Email Notifications to be sent to a Personal E-mail account
This would mean all system emails are sent there, including any Password Reset emails
You should synchronize other non-business email addresses to a custom field or userinfo-element

Best Practice Recommendations:

It's recommended you do not configure/map the email-address of any type to the "username" field in Employee Profile

Do NOT configure username as a standard-element-ref. View Guide: Fields Hard-Coded for Syncing
As there is no "uniqueness" check available on EC side, the system can try to pass non-unique values to "username" which would result in UI/Import errors when attempting to do so
2336779 - Invalid HRIS Sync Mapping Configuration " HRIS Sync Job Failure"

Example:

<hris-sync-mappings>
    <hris-element-ref refid="emailInfo">
      <hris-mapping entity-type="B" >
        <hris-field-ref refid="email-address"/>
        <standard-element-ref refid="username"/>
    </hris-element-ref>

FAQ - Additional Information

Q) Where can I get information on this from the Guide?

A) Guide:Implementing Employee Central Core

Chapter: Human Resource Information System (HRIS) Synchronization

Keywords

synchronization, mappings, succession data model, xml, sdm, ec, e-mail, email address, sm-mapping, recruiting, candidate mail, SF, success factors, RCM, email info, Human Resource Information System (HRIS) Synchronization, username, Hris sync, FAQ , KBA , LOD-SF-EC-HRS , HRIS Sync , How To

Product

SAP SuccessFactors Employee Central all versions ; SAP SuccessFactors HCM Suite all versions