COmplete SAP SF Guide
COmplete SAP SF Guide
COmplete SAP SF Guide
Learn about changes to the documentation for SAP SuccessFactors Data Model Reference Guide in recent
releases.
2H 2021
Changed We specified all file types of attachments Background Element - Data Field Defini-
you can define for the field <file-
tion [page 65]
formats> and the supported file types if
you don't define this field or set the field Background Element - Rating Field Defi-
blank. nition [page 68]
Added A new standard element, learningLicen Standard Element Field IDs in the Suc
seUserType, is now available. cession Data Model [page 53]
Changed Updated a topic about viewing all up Working with Corporate Data Model and
loaded versions of the Corporate Data Country/Region-Specific Corporate
Model and Country/Region-Specific Data Model in Admin Center [page 12]
Corporate Data Model in Admin Center.
Changed The MP4 file format is not supported for Background Element - Rating Field Defi-
the Rating Field. Updated file formats sec nition [page 68]
tion of the table.
Changed You cannot configure the same values for Background Element - Data Field Defini-
the Data Field ID and Background Ele tion [page 65]
ment ID. Added a note in the ID section of
the table.
Changed You can't use the same ID for a Back Background Element Definition [page
ground Element. While uploading the data 64]
model upper and lowercase letters are
considered as the same string values.
Added a note in the ID section of the table.
Added Added a note that for now, the setting of Initializing New Entry Date Fields in Ex
Leave of Absence Start Date and Leave of isting Job Info Records [page 151]
Absence Return date fields only works
with the "old" LOA/RLOA application, and
not with Time Off/LOA.
New Added a note about accessing previous Exporting Succession Data Model and
versions of the Country/Region-Specific Country/Region-Specific Succession
Succession Data Model in Admin Center Data Model [page 8]
and Provisioning
New Added a topic about exporting Succession Exporting Succession Data Model and
Data Model and Country/Region-Specific Country/Region-Specific Succession
Succession Data Model from Admin Cen Data Model [page 8]
ter and Provisioning
This topic is your introduction to the data models used in SAP SuccessFactors HXM Suite.
Data Models describe how data elements are structured in a database. They also define the properties these
elements possess and their relationships to each other.
SAP SuccessFactors defines its data using a number of data models. These data elements have impact on all of the
modules of the application as well as the company and employee data stored in the system. Initial set up of the
data models is done through provisioning.
The SAP SuccessFactors Data Models use XML. You can download these XML files from provisioning. You then
work with files in an XML editor of your choice and edit them offline. You upload these modified files back to the
company instance you’re working with in provisioning.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Note
Once the initial implementation is complete, you can also modify the data model files from Admin Center using
the Business Configuration UI or BCUI.
Employee Data This data is employee-related data such as name, date of birth, nationality, as well as
employment data such as job title or compensation.
Organization Data Organization-related data such as Department, Division, Legal Entities. This data also includes
Job and Pay Structure. The organization-related data objects are also described as
Foundation Objects.
SAP SuccessFactors defines this data using the following Data Models:
Corporate Data Corporate Data Model defines the organization-related data in XML, which are also the
Model Foundation Objects. Some of these Foundation Objects can also be defined as MDF Objects.
MDF Objects aren’t in scope for this document. This Data Model also has relationship
between the foundation objects configured in it.
Country/Region The foundation objects from Corporate Data Model that need to be localized based on the
Specific country/region are configured in this data model. In case the configuration for a particular
Corporate Data country/region is missing, the definition in the Corporate Data Model is used.
Model
Succession Data This Data Model is the basis for People Profile and Employee Central. Fields needed to define
Model employee's data are configured in this data model. The elements defined here are used or
referenced in People Profile, Matrix Grid reports, Succession Org Chart, Employee Directory,
and Employee Scorecard. These fields are also used in Performance Management,
Compensation, Recruiting Management, and for user management in a company instance.
Note
Employee Central is required for some of these data elements and data models.
Note
All configuration files for Employee Central, for example, master data models, master picklists, as well as
country/region-specific files, have moved from the SAP Help Portal to the Software Download Center .
Exporting Succession Data Model and Country/Region-Specific Succession Data Model [page 8]
Succession Data Model and Country/Region-Specific Succession Data Model use XML. You can download
these XML files from Admin Center and Provisioning. You then work with files in an XML editor of your
choice and edit them offline.
Working with Corporate Data Model and Country/Region-Specific Corporate Data Model in Admin Center
[page 12]
Corporate Data Model and Country/Region-Specific Corporate Data Model use XML. You can download
these XML files from Admin Center. You then work with files in an XML editor of your choice and edit them
offline. You upload these modified files back to the company instance you’re working using Admin Center.
Data Model Definitions (DTDs) for SAP SuccessFactors Data Models [page 14]
Where can you find the Data Model Definition (DTD) files used by the SAP SuccessFactors HXM Suite?
Related Information
Succession Data Model and Country/Region-Specific Succession Data Model use XML. You can download these
XML files from Admin Center and Provisioning. You then work with files in an XML editor of your choice and edit
them offline.
Prerequisites
It’s important to enable the required role-based permissions. To get started ensure, you enable Administrator
Permissions Admin Center Permissions Export Succession Data Model or Export Country- Specific
Succession Data Model .
Context
You can export Succession Data Model and Country/Region-Specific Succession Data Model in Admin Center.
Tip
Even if you’ve already downloaded a file from an instance, before beginning work on a data model XML file,
always download a new version of the file. It’s possible that there have been changes to the file since you last
worked on it.
Procedure
All previous versions of Country/Region-Specific Succession Data Model are now available in Admin Center
and Provisioning.
You now have the option to access previous versions of the Country/Region-Specific Succession Data
Model in Admin Center and Provisioning, and restore a version for your environment. Every time you import
the Country/Region-Specific Succession Data Model in Provisioning, the system automatically saves the
import file as a new version. You can restore the data model to a specific version from the list. The version
list can now store and display up to 100 previous versions. Earlier versions are deleted when the limit is
reached.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product
Support.
Results
Related Information
Prerequisites
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
All SAP SuccessFactors instances are created as a clone of a master instance and have basic data models. If the
out of the box data models don’t work for you, you can then download and modify the data model files in your
favorite XML editor.
Tip
Even if you’ve already downloaded a file from an instance, before beginning work on a data model xml file,
always download a new version of the file. It’s possible that there have been changes to the file since you last
worked on it.
Procedure
1. Log in to provisioning
2. Click on your instance in provisioning
3. Scroll down to the Succession Management Section.
4. Choose the relevant link to work with the desired data model file.
Succession Data Model (SDM) Import/Export Data Model System now does version control for
you when it comes to Succession Data
Model. When importing, you’re required
to comment on the changes made. Pre
vious versions of the data model are
stored in system.
Corporate Data Model (CDM) Import/Export Corporate Data Model The first data model you would set up if
XML starting with a new instance
Note
Corporate Data Model is the first data model you would set up in an instance.
We recommend that when uploading the country/region specific data models, you remove any countries/
regions and fields that you don’t need before uploading the XML for the first time. If you upload the
complete data model, the upload takes longer due to the number of countries in the XML file.
Remember
When uploading a data model that contains references to rules which doesn’t exist in the system, your
business rule will not sync to BCUI. To solve this issue, we recommend that once you’ve created rules in the
system that are referenced in Succession data model, either run Synchronize Business Configuration job or
re-upload the data model.
Related Information
Exporting Succession Data Model and Country/Region-Specific Succession Data Model [page 8]
Working with Corporate Data Model and Country/Region-Specific Corporate Data Model in Admin Center [page
12]
Data Model Definitions (DTDs) for SAP SuccessFactors Data Models [page 14]
Adding Picklists to Fields in the Data Model XML [page 15]
Corporate Data Model and Country/Region-Specific Corporate Data Model use XML. You can download these XML
files from Admin Center. You then work with files in an XML editor of your choice and edit them offline. You upload
these modified files back to the company instance you’re working using Admin Center.
Prerequisites
It’s important to enable the required role-based permissions. To get started ensure, you enable Manage
Foundation Objects Import/Export Corporate Data Model or Import/Export Country/Region Specific XML for
Corporate Data Model
Context
You can import or export Corporate Data Model and Country/Region-Specific Corporate Data Model in Admin
Center.
Tip
Even if you’ve already downloaded a file from an instance, before beginning work on a data model XML file,
always download a new version of the file. It’s possible that there have been changes to the file since you last
worked on it.
Procedure
We recommend that when uploading the country/region-specific data models, you remove any country/
region-specific fields that you don’t need before uploading the XML for the first time. If you upload the
complete standard data model, the upload takes longer due to the number of countries in the XML file.
Note
You can view all your uploaded versions of the Corporate Data Model and Country/Region-Specific
Corporate Data Model in Admin Center and Provisioning.
You now have the option to access previous versions of the Corporate Data Model and Country/Region-
Specific Corporate Data Model in Admin Center and Provisioning, and restore a version for your
environment. Every time you import the Corporate Data Model and Country/Region-Specific Corporate Data
Model in Provisioning, the system automatically saves the import file as a new version. You can export any
of the previous version of the data model and then re-import the data model to restore the old version. The
version list can now store and display up to 100 previous versions. Earlier versions are deleted when the
limit is reached.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product
Support.
Results
A success message displays to inform you that the import or export task is done.
Related Information
Exporting Succession Data Model and Country/Region-Specific Succession Data Model [page 8]
Working with Data Model Files in Provisioning [page 9]
Data Model Definitions (DTDs) for SAP SuccessFactors Data Models [page 14]
Where can you find the Data Model Definition (DTD) files used by the SAP SuccessFactors HXM Suite?
Note
Related Information
Exporting Succession Data Model and Country/Region-Specific Succession Data Model [page 8]
Working with Data Model Files in Provisioning [page 9]
Working with Corporate Data Model and Country/Region-Specific Corporate Data Model in Admin Center [page 12]
Adding Picklists to Fields in the Data Model XML [page 15]
Picklists are defined in the Picklist Center. The picklist ID is referred to in the data model configuration. The fields
with picklists IDs then appear as drop down lists on the UI.
Prerequisites
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product
Support.
Context
Userinfo elements, background element fields and HRIS element fields, and some standard elements, can have
picklists associated with them.
Note
The data fields can be in the Succession Data Model, Corporate Data Model, or the Country Specific Data
Models.
Procedure
Some legacy standard fields can’t have picklist IDs associated with them
Find the end tag of the element or field and add the reference to the picklist before the end tag as in the code
sample.
Sample Code
If you have configured cascading picklists, a parent child relationship is created between the data fields using
the cascading picklists. You use the parent-field-id tag to refer to the parent data field to configure this
relationship. Consider the code sample. Here picklist IDs language and variant have a cascading relationship in
the system. When configuring the background element, the parent data-field ID language is used for data-
field variant. This configuration ensures that when a Language is chosen while entering data for Language
Skills on the user interface, the Language Variant choices you see are those associated with the language
chosen from the dropdown.
Note
Sample Code
Related Information
Exporting Succession Data Model and Country/Region-Specific Succession Data Model [page 8]
Working with Data Model Files in Provisioning [page 9]
Working with Corporate Data Model and Country/Region-Specific Corporate Data Model in Admin Center [page 12]
Data Model Definitions (DTDs) for SAP SuccessFactors Data Models [page 14]
Foundation objects are used to set up data that can be shared across the entire company, such as job codes,
departments, or business units. Foundation objects are sometimes referred to as “foundation tables”.
Foundation objects are the first objects you should load because some of the lists of values proposed in
employment information come from the Foundation Objects.
You can use Foundation Objects to populate data at the employee level. For example, if you assign a job code to an
employee, that employee’s record is then populated with all information based on the attributes of the job code.
Additionally, the relationships that are configured between the Foundation Objects can be used to filter the lists of
values in Employment Information. For example, the list of pay components that are selectable on an employee’s
record can be filtered based on the country the employee is associated with as determined by the employee’s Legal
Entity.
Some Foundation Objects are predelivered for you in the Corporate Data Model. For a list of these object, refer to
Predelivered Foundation Objects in Corporate Data Model in the SAP SuccessFactors Data Model Reference Guide
on the SAP Help Portal.
You need to import the data into the system using different methods and in a specific order. The import methods
are as follows:
● You create and update MDF Foundation Objects in the Corporate Data Model. To manage Legacy Foundation
Object data, choose Admin Center Manage Organization, Pay, and Job Structures .
● You create and update MDF Foundation Objects using Admin Center Configure Object Definitions . To
manage MDF Foundation Object data, choose Admin Center Manage Data .
● Ad-hoc reports work based on both the migrated and Legacy Foundation Objects. For Advanced Reporting
(ODS), the reports will be migrated when you first invoke the reports after migration.
Related Information
Features
● Each foundation object consists of one or more fields. Some of them are required if you use the relevant object.
● Each foundation object has a technical ID, called an hris-element-id. You cannot change this.
● For each foundation object, you must enter an external code. This is a short unique identifier.
Note
Once you've entered the external code, do not change it, as this can lead to data inconsistencies.
● Each standard field within a foundation object also has a technical field ID. You cannot change this.
● However, you can change the labels of the foundation objects and the fields each object contains. The label is
the descriptor that appears on the user interface (UI).
● The order in which the fields are displayed on the UI is the same as the order in which you list them in the setup
of the foundation object.
For Legacy FOs only: The start date will always appear at the top of the screen.
● You can decide whether a field actually appears on the UI and, if so, whether:
○ It is required or optional
○ It is read-only or whether users can change or edit it
● Every foundation object contains custom fields. These are empty fields you can use to handle data not covered
by the standard fields.
Note
For example, if you configure the city field in the Corporate Data Model as a picklist for a country/region X,
you can’t use city in the search criteria for location. If you do, you won’t be able to search locations by city
for country/region X.
There are many similarities between MDF Foundation Objects and Legacy Foundation Objects. Both serve to
provide foundational data that organizations can use to structure their companies. Both provide the ability to store
attributes on the object level that can be referenced or propagated to the employee’s job and compensation
records.
However, MDF and Legacy Foundation Objects are built on two separate platforms, which result in different ways of
accessing, configuring, and managing the objects and corresponding data. Below is a table which summarizes the
key differences between the two object types.
Configuring the Object Provisioning Corporate Data Model Admin Center Configure Object
Remember
As a customer, you don't have ac
cess to Provisioning. To complete
tasks in Provisioning, contact your
implementation partner or Account
Executive. For any non-implementa
tion tasks, contact Product Support.
Managing the Object Values/Data Admin Center Manage Admin Center Manage Data
Importing Object Values/Data Admin Center Import Foundation Admin Center Import and Export
Data Data
Exporting Object Values/Data Ad Hoc Report Report Definition Admin Center Import and Export
Mass Deleting Object Values/Data Manual deletion only using Admin Admin Center Import and Export
Alternatively, you can import the founda which data should be deleted upon im
“Active” to “Inactive”
Permissions for the objects and data Manage Foundation Object Types MDF Foundation Objects
Custom Fields You are limited to 20 of each type: There is no limit to the number of custom
fields you can create for MDF objects. In
● String
addition to the data types supported for
● Date
Legacy FOs, there are additional field
● Decimal
types available.
● Long
For more information, refer to the Imple
● Number
menting the Metadata Framework guide
on the SAP Help Portal.
In addition to the differences in maintaining the tables and data, there are vast differences in the supported
functionality and capabilities of the two object types. All functionality that is supported for Legacy Foundation
Objects is supported for MDF Objects (associations, field-level configuration, picklists, and so on). However, the
opposite is not true – all functionality that is supported for MDF Objects is NOT supported for Legacy Foundation
Objects. MDF Objects contain a plethora of additional supported capabilities, including the support of business
rules, field-level permissions, and more. MDF Foundation Objects and MDF Generic Objects are created and
maintained under the overall MDF platform.
Related Information
Here are the requirements for the use of legacy foundation objects.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product
Support.
● Import the Corporate Data Model. If you've enabled Employee Central, foundation objects such as Location
are predelivered in the Corporate Data Model.
● Enable the role-based permissions for the foundation objects.
○ Admin Permissions Manage Foundation Objects
○ Admin Permissions Manage Foundation Object Types
As an administrator, you can control access of a user to managing the foundation objects, under User
Permission Settings Permissions... Manage Foundation Objects , Access Manage Organization, Pay and
Job Structures page.
Remember
To use foundation objects without Employee Central, you must configure foundation objects, for example,
Location, in the Corporate Data Model.
Related Information
To correct an error, you may need to delete a foundation object or a foundation object value at some point.
Context
If a Foundation Object value is required to be removed from the UI, it is vital to consider the following points:
● Do not delete a Foundation Object value that at some stage has been used in an employee’s data. If a value
should be removed from the UI, it is recommended to set the “Status” of the value to “Inactive” rather than
Note
SAP SuccessFactors does not support mass deletion of Legacy Foundation Objects. Legacy Foundation Objects
must be deleted individually on the User Interface or mass-inactivated through import.
Procedure
Corporate Data Model defines the organization-related data in XML, which are also Foundation Objects. Some of
these Foundation Objects can also be defined as MDF Objects. MDF Objects aren’t in scope for this document. This
data model also has relationship between the foundation objects configured in it.
When beginning work on a new instance, Corporate Data Model is the first data model you would set up.
Corporate Data Model is where you define how the organization, pay, and job structures that define the company
are reflected in the system. For example, a Job Code can be associated with multiple countries. For such cases,
allow a single job code to be assigned to multiple countries. You set up the job code by defining foundation objects
in the Corporate Data Model and define the relationships between them by creating associations in the XML file for
the data model. You also define what fields are used on the UI, what they’re called, and which fields are hidden. You
can also add customer-specific fields.
Starting with the November 2014 release, organization structures are being migrated to MDF objects in a phased
manner. MDF Foundation Objects are configured using the Configure Object Definition page and are managed using
the Manage Data page in the Admin Center.
You can maintain associations between a Foundation Object and an MDF Foundation Object by configuring the
associations using the Configure Object Definition page or the Corporate Data Model xml, depending on the
scenario.
Corporate Data Model xml file contains elements, fields, associations, and search criteria.
hris-field Foundation fields for each foundation object for the default
country
Related Information
The master Corporate Data Model that you download from the help portal includes the foundation objects listed
here.
Foundation Objects Predelivered in the SAP SuccessFactors Master Corporate Data Model
HRIS-element ID (Don’t Standard Label (Visible on Data Object Type Subtype
Change) the UI)
Note
The fields for the foundation object jobClassLocal are defined in the Country/Region-Specific Corporate
Data Model. Additionally, the country/region-specific address for the location Foundation Object is also
defined here.
You can create additional foundation objects (HRIS Elements) to fit your business needs if the predelivered objects
don’t fit them. For example, your organization has levels in your organizational hierarchy such that you need a new
foundation object “Sub-Department”.
Prerequisites
You’ve downloaded the Corporate or Succession Data Model and have the file open for editing in an XML editor.
Note
For information on how to create a generic object, see the Implementing the Metadata Framework guide on the
SAP Help Portal.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Procedure
1. Assign the Generic Object you’ve created to the relevant data model.
a. If assigning the Generic Object to a Legacy Foundation Object
1. In the Corporate Data Model, add a customer-specific field as a custom-string and add the type
attribute referencing the external code of the generic object.
<hris-element id="jobInfo">
<label>Job Information</label>
<hris-field max-length="256" id="custom-string5" visibility="both"
type="GO_Building" >
<label>Building</label>
</hris-field>
Note
Use only a custom-string as customer-specific field when you use the type attribute with generic
objects.
Here is an overview of the HRIS XML elements and attributes that are most commonly used in the data models.
Note
● XML elements can contain other XML elements nested inside them. For example, the hris-element XML
element can contain label and hris-field XML elements:
<hris-element id=”location”>
<label>Location</label>
<hris-field max-length="32" id="externalCode" visibility="both"
required="true" pii="false" showTrailingZeros="false" >
<label>Code</label>
</hris-field>
<hris-associations>
<association id=”id” multiplicity=”ONE_TO_ONE” destination-
entity=”geozone” required=”false” />
</hris-associations>
<search-criteria>
<search-field id=”corporateAddress.city” />
</search-criteria>
</hris-element>
● XML elements can contain several attributes, for example, the XML element hris-field contains the
attributes max-length and id:
<hris-field max-length=”256” id=”amount”>
● Attributes are name-value pairs; it’s predefined which values can be entered for which attributes. In the
following example, the attribute with the name max-length can have a number as a value:
max-length=”256”
You can include these XML elements or attributes: How to use this XML element or attrib
ute:
Note
Associations can only be defined in
the Corporate Data Model.
You can include these XML elements or attributes: These are possible attribute How to use this XML element
values: or attribute:
Attribute maximumFractionDigit Possible values are 0–5: With this XML attribute, you
s define how many decimal dig
● 0
its are shown after the decimal
● 1
point. Depending on the num
● 2 ber of decimal digits you indi
● 3 cate here, the numbers dis
● 4 played in the system get
rounded up or down.
● 5
You can use this property only
for HRIS fields with the data
type DOUBLE, and you can
define up to 5 decimal places.
If you don’t use this attribute
for a DOUBLE data type, the
number is rounded to three
decimal places by default. If
you define a value higher than
5, the system uses the maxi
mum value, which is 5. If you
define a negative value, for ex
ample, -1, the default value of
3 decimal places is used. Ex
ample:
maximumFractionDigit
s=”2”
4.39
Note
Make sure that the follow
ing HRIS fields use the
same
maximumFractionDi
gits value:
● payComponentVa
lue of HRIS element
payComponent
● paycompvalue of
HRIS element
payComponentRe
curring
● value of HRIS ele
ment
payComponentNo
nRecurring
If
maximumFractionDigit
s is set to 4 and
showTrailingZeros is
set to “true”, and the user
enters 1.3 on the UI, the value
is displayed as follows:
1.3000.
You can include these XML elements or attributes: These are possible attribute How to use this XML element
values: or attribute:
Attribute id The only possible value is: This is the identifier for an as
sociation between this foun
id
dation object and another ob
ject; don’t change this value.
You can include these XML elements or attributes: How to use this XML element or attrib
ute:
<label>
You can include these XML elements or attributes: These are possible attribute How to use this XML element
values: or attribute:
You can include these XML elements or attributes: These are possible attribute How to use this XML element
values: or attribute:
Attribute rule external code of the rule This is the rule that is trig
gered when the event on the
user interface takes place. You
must have defined this rule in
the Rules Engine and refer to
the external code of the rule.
You can modify your HRIS elements in the data models to fit your business needs.
Prerequisites
You’ve downloaded the data model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
HRIS elements are found in Succession Data Model and Corporate Data Model.
Caution
Don’t modify the id of the elements. The id is the key that is used to refer to the field in other parts of the
application.
Procedure
Overwrite the existing label in the element. If there are other language labels present in your HRIS element,
they also can be modified.
If the system does not find a corresponding label for the system language, it displays one of the following
(depending on the following order):
Add search criteria to a field by adding the <search-criteria> subelement to an HRIS element.
...
<search-criteria>
<search-field id="corporateAddress.city" />
<search-field id="corporateAddress.country" />
</search-criteria>
</hris-element>
Note
Search criteria can only be string fields. They can’t be picklists or generic objects.
● Change associations
To define relationships between foundation objects, or between a foundation object and a generic object, set
up new associations or change the associations included in the standard XML file. The associations are the
final subelement of the hris-element included before the HRIS element end tag. You then define whether it’s
a ONE_TO_ONE or a ONE_TO_MANY association.
<hris-element id="location"> ... <hris-associations> <association id="id" multiplicity="ONE_TO_MANY"
destination-entity="locationGroup" /> </hris-associations> </hris-element>
Related Information
You create associations in the XML file for the data model to define the relationships between foundation objects.
Note
When maintaining associations between a Foundation Object and an MDF Foundation Object, configurations
can be specified using the Configure Object Definition page or the Corporate Data Model, depending on the
scenario.
For more information, see the Working with MDF Foundation Objects section in this guide.
For Foundation Objects, you can only define a ONE_TO_MANY association and not a MANY_TO_ONE association.
In most cases, the one object typically filters the many object. However, it is recommended that associations be
modeled on the many object rather than the one object to achieve the required filtering behavior.
Note
For the destination-entity, enter the HRIS-element ID of the foundation object, or the external code of the
generic object you want to associate the foundation object with.
<hris-element id="location">
...
<hris-associations>
<association id="id" multiplicity="ONE_TO_MANY" destination-
entity="locationGroup" />
</hris-associations>
</hris-element>
The following example shows the ONE_TO_ONE associations from payRange to the foundation objects geozone
and payGrade. Do not create more ONE_TO_ONE associations than those that are predelivered in the standard
XML file.
<hris-element id="payRange">
...
<hris-associations>
<association id="id" multiplicity="ONE_TO_ONE" destination-entity="geozone" />
<association id="id" multiplicity="ONE_TO_ONE" destination-entity="payGrade" />
</hris-associations>
</hris-element>
You can customize your foundation objects by modifying the HRIS Elements in the Corporate Data Model and
Succession Data Model. This customization can include removing an element entirely.
Prerequisites
● You've downloaded the data model and have the file open for editing in an XML editor.
● You’ve removed the HRIS element from the country specific Succession Data Model or the country specific
Corporate Data Model, and uploaded the data model file.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
Procedure
Note
○ When you delete an HRIS element, the corresponding block is no longer shown on the UI.
○ You cannot delete the following mandatory HRIS Elements:
○ employmentInfo
○ jobInfo
○ personInfo
○ personalInfo
Related Information
You can customize your foundation objects by modifying the HRIS Elements in the Corporate Data Model and
Succession Data Model. This customization can include modifying the fields that belong to the foundation objects.
Prerequisites
You’ve downloaded the data model and have the file open for editing in an XML editor.
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
Multiple fields of various types together form an HRIS element. You see more attributes for a field than what you
need to change. You can modify some of the attributes of your HRIS fields to fit your business needs.
Procedure
If the system does not find a corresponding label for the system language, it displays one of the following
(depending on the following order):
○ “none”: Field is hidden. You can’t import data for this field using CSV files.
○ “view”: Field is read-only. You can’t import data for this field.
○ “both”: Field is visible on the UI and can be edited. You can also import data for this field using CSV files.
Note
To allow data import for a field with visibility=”view”, you can add the attribute allow-
import=”true” to the field. For example, for your company, the employee ID field is system-generated.
You thus prevent the user from accidentally changing the ID by setting it to read-only. However, you have
existing data for the employees, including their IDs, which you wish to upload using CSV file. Add the
allow-import=”true” to the field definition as in the example:
The person-id-external field is an exception: You can also use the allow-import attribute when this
field is hidden (that is, with visibility=”none”).
Note
The following fields are required on the UI even if required=”false” in the data model:
○ start-date
○ externalCode
○ status
○ Other mandatory fields for an element
Note
Related Information
When defining standard hris-elements, there are fields that are required to be defined for standard functionality to
work as designed. This topic lists the required fields for the Corporate Data Model
For this HRIS element in the Corporate Data Model... ...this HRIS field is always required:
corporateAddress country
dynamicRoleAssignment person
eventReason event
frequency annualizationFactor
payComponent payComponentType
payRange frequency
wfConfigCC actorRole
actorType
context
wfConfigContributor actorRole
actorType
context
wfStepApprover approverRole
approverType
context
Corporate Data Model is a core data model for organization data. The fields defined therein can have impact on
other modules.
The advantage of a system like SAP SuccessFactors is easy data flow and ease of data management across various
functional areas or modules. However, for this interphase to work smoothly, right elements have to be in place.
These elements can be data elements in the data model, fields, and their configuration in the target modules, other
features, or permissions.
● Ensure that the following declaration is available at the top of every Corporate Data Model XML document:
● Add hris-element element and id attribute. The Job Classification foundation object is the only foundation
object used in Recruiting, but other HRIS objects are supported for EC in addition to Job Classification. The
HRIS element with id="jobCode" must exist and contain the recruiting-related fields, as shown. The presence
of the jobCode hris-element produces the Job Code option on the Import Foundation Data page.
<hris-element id="jobCode">
● The hris-element can contain multiple hris-field elements. The field elements define the fields in the foundation
object import file:
You may configure the following hris-field id values. These field names must be used exactly as listed below:
custom-date1-5 Date
Other hris-field id values may be supported for use in Employee Central but there’s a mapping process that links
the hris-field ids from the Job Classification foundation object to the jobCode fields in the Requisition form, and
only these hris-field ids are supported in this mapping process. Additional fields can’t be used for Recruiting.
Tip
The Job Code Entity file can also be set up via a scheduled recurring process in Provisioning. Clients should
either extract the data from the current system of record or they can manually create the file if some of the data
is to come from the system of record and some comes from other systems. If the JCE process is via a
scheduled job from your HRIS, it is possible to do a Full Purge which replaces all existing records, or an
The visibility attribute doesn’t affect Recruiting; unless it has been adjusted for EC reasons, set it to "both".
label Element
<label>Grade Level</label>
The label element controls the appearance of the field name in the user interface for both importing the foundation
data and for the field as it appears in the requisition page, regardless of the field-definition label in the Requisition
XML.
<picklist id="gradeLevel"/>
The custom string hris-field ids can be configured to validate against a picklist upon foundation data import, and
render as picklists on the requisition page. The picklist must be defined in the hris-field in the Corporate Data
Model XML.
Example
For each Recruiting-related hris-field configured in the Corporate Data Model, configure a corresponding field-
definition in the Requisition XML.
Note
The field IDs change between the Corporate Data Model XML and the Requisition XML. Where the Corporate
Data Model states custom-string1, the requisition states customString1 — if you reference these fields in the
Offer Details XML, the field IDs change yet again. To reference this field in the Offer Details XML, you would
configure jce_customString1.
customDate1-5 Date
This data is auto-populated from the foundation data library at the point of requisition creation. There’s no dynamic
link that causes this data to be automatically updated on the requisition if the data in the foundation data library is
changed at a later date.
It’s possible to set the permission of the jobCode fields as editable to users if desired. Ensure that the client gives
careful consideration to whether these fields should be made editable or not.
You manage the data that populates into these requisition fields by uploading it via the job code CSV template in
Admin Tools Import Foundation Data .
● Download the Excel template by selecting Type: Job Code and clicking the “Download a blank CSV template”
● Populate the Excel file with data
Clients may wish to provide the user more job code related information while they’re selecting from families and
roles during the requisition creation process. Up to five fields can be displayed on the Browse Families and Roles
page under the Job Code.
Related Information
Determine which pay range an employee is associated with and how the system calculates compa-ratio and range
penetration values.
Prerequisites
● Configure the Pay Range foundation object in the Corporate Data Model
● Create associations between Legal Entity and Pay Grade from the Pay Range
Note
If the pay range should depend on the country/region of the legal entity, it is not sufficient to add the
association to the corporate data model.
Sample Code
In order to use the country/region as an association for the pay range, it is necessary to:
1. Add a custom field of type country/region (this means that it needs the tag type Country/Region) to
the jobInfo object in the data model.
2. Fill this field using a business rule based on the country/region defined in the legal entity.
Note
This is so that when the system calculates the Compa Ratio and Range Penetration values, it will look up what,
for example, Legal Entity and Pay Grade values the employee has set in their current Job Information record.
Context
The system looks for a pay range that matches all of the configured objects associated with it. If one exact match is
found, that is used. If several matches are found, the first one found is used. If nothing is found, the last selection
criterion (the last association for payRange) is removed from the search, and the search repeated, and so on.
The Compa Ratio and Range Penetration values are calculated based on Pay Component Groups. You must define
which Pay Component Group is used to calculate both Compa Ratio and Range Penetration. You can use 2 separate
Pay Component Groups for each of the calculations.
To define which Pay Component Group is used for the calculation, do the following:
Procedure
Related Information
With dynamic roles, you can flexibly assign different users, positions, or dynamic groups as workflow approvers,
contributors, and CC roles according to certain foundation data of the subject user or MDF position object. So, for
employees or positions of a particular job classification, or for a data change to a particular event reason, the
workflow approval requests or notifications are sent to the users or positions defined in the dynamic role.
Prerequisites
By default, the system uses the job information of the subject user to determine the assignment of a dynamic role.
To enable the MDF position as the other base object, go to the Corporate Data Model and change the Base Object
field settings so that it’s visible on the dynamic role creation page. For details, see the following setting:
<hris-element id="dynamicRole">
...
<hris-field max-length="128" id="baseObjectType" visibility="both">
<label>Base Object</label>
...
</hris-element>
The corporate data model can be maintained using the Import/Export Corporate Data Model tool.
Context
The dynamic role is created and assigned according to certain foundation objects, such as job classification,
department, pay grade, and event reason. By selecting a base object for the role, you specify how the system
determines the approver assignment, either by the job information or the position information of the subject users.
Recommendation
Use position-based dynamic roles only in workflows for the MDF Position objects.
Dynamic roles can be defined with positions. Make sure to update the dynamic role assignment when there are
significant changes to the positions used in the role. For example, you have moved a position from US to Canada. If
this position is still used in a dyanmic role for US workflows, the relevant approval requests regarding employees in
US are still sent to the incumbent of this position who is based in Canada.
Procedure
1. Go to Admin Center Manage Organization, Pay and Job Structures Create New and select Dynamic
Role .
2. Specify a dynamic role ID, name, and description.
3. (Optional) Select the base object for the dynamic role:
If you haven’t enabled the Base Object field, the system by default uses the job information as the base object
for the dynamic role.
4. In the Dynamic Role Assignment section, define how you want to assign approvers, contributors, or recipients
of completion notices and whom (users, positions, or dynamic groups) to include in the dynamic role:
1. Specify a foundation object as the assignment criterion. You can also specify multiple to detail the
assignment. For example, use both the legal entity and pay grade objects to define the assignment for
subject employees who belong to legal entity A and whose pay grade is 7.
2. Select an approver type: person, position, or dynamic group and specify the corresponding approvers.
Note
Although it says approvers, dynamic roles can also be used as workflow contributors and recipients of
completion notices.
You can assign a different approver for each of your legal entities, so that approvers can be determined based
on the legal entity of the workflow subject user.
5. Save the dynamic role.
Results
The dynamic role has been created, and it is available for workflow setup.
Related Information
Succession Data Model is at the core of SAP SuccessFactors. All modules that use employee-related data elements
in the application are touched by the data model in one way or the other.
Succession Data Model defines objects that are related to the person or the employee in the company. You can
then display these fields in the People Profile based on the field level and/or role-based permissions.
The data that Succession Data Model defines can be of two types:
● Person data:
Data that is employee-based and isn’t related to the job of the employee, for example, the employee's address
or the national ID.
● Employment data:
Data that is job-related, for example, compensation and hire date.
Succession Data Model xml elements and attributes are listed for your reference.
Adding Dynamic Group Filters in the Succession Data Model [page 87]
Edit or add the dg-filters section if you want to set up dynamic group filters in the Succession Data
Model. This code enables the fields to be available for dynamic groups, for example, filter fields when
setting up permission groups for role-based permissions, or employee groups.
View Templates and Edit Templates in the Succession Data Model [page 90]
view-template and its attribute edit-template are used to define the fields that can display in certain
areas of the application.
Configuring HRIS Sync Mappings (hris-sync-mappings) in the Succession Data Model [page 93]
You can modify the Succession Data Model XML to include HRIS Sync mappings.
Standard Elements (standard-element) in the Succession Data Model define the fields that are seen in the
Personal Information section of the People Profile in SAP SuccessFactors. The standard elements are single value
fields such as name, email, gender, department.
These fields are predefined in that the field-id is already set up. Their inclusion in the data model is optional. Even if
not defined in the Succession Data Model file, the fields are available to use in People Profile and Succession
modules based on permissions.
Defining the field in the xml however, allows you to modify its default behavior such as making it a picklist or
modifying its label.
Some of the standard elements are also where data can be imported/exported via the User Data File.
Caution
If using Employee Central, do not make user data changes by importing User Data File either from the UI or
through a scheduled job. Doing so can overwrite data coming from Employee Central and cause data
inconsistencies.
XML elements and attributes for standard-element are defined in this topic.
label Label of the field as seen on the UI. Can Standard labels that can be overwritten
have multiple rows for each language
supported
strings-list-id A specific picklist configured to allow leg Currently only used for jobCode.
acy field to have a picklist
Sample Code
<standard-element
id="jobCode" strings-
list-
id="sysJobCodes"></
standard-element>
required If true, force the user to input information "false" by default if not configured.
for that field
matrix-filter If true, designates a field to be used in "false" by default if not configured. Only
the matrix grid certain fields accept this designation.
pre-populate Impacts saved searches in Talent Search. "false" by default if not configured
Parent topic: Standard Elements in the Succession Data Model [page 51]
Related Information
Standard elements that have preset functionality and use within the SAP SuccessFactors HXM Suite are listed
here.
Here are the field IDs available to you to use in your Succession Data Model as standard elements. These fields
have a one to one relationship between the field and the data.
username
gender
lastName
firstName
mi
nickname
suffix
salutation
department
division
location
jobCode
hireDate
timeZone
managerId
hrId
ssn
dateOfBirth
citizenship
nationality
ethnicity
married
minority
businessSegment
serviceDate
level
photo
function
performance
potential
objective
competencyveteranDisabled
veteranSeparated
veteranProtected
veteranMedal
talentPool
empId
title
businessPhone
homePhone
cellPhone
fax
addressLine1
addressLine2
addressLine3
city
state
zipCode
country
reviewFreq
lastReviewDate
custom01
custom02
custom03
custom04
custom05
custom06
custom07
custom08
custom09
custom10
custom11
custom12
custom13
custom14
custom15
riskOfLoss
impactOfLoss
benchStrength
reasonForLeaving
newToPosition
dateOfPosition
keyPosition
futureLeader
matrixManaged
salary
salaryLocal
localCurrencyCode
jobTitle
jobLevel
jobFamily
jobRole
finalJobFamily
finalJobRole
finalJobCode
payGrade
finPayGrade
dateOfCurrentPosition
bonusTarget
salaryProrating
raiseProrating
promotionAmount
lumpsumTarget
lumpsum2Target
compensationReadOnly
meritTarget
meritEffectiveDate
compensationEligible
compensationSalaryEligible
compensationBonusEligible
compensationStockEligible
compensationSalaryRateType
compensationSalaryRateUnits
salaryBudgetTotalRaisePercentage
salaryBudgetMeritPercentage
salaryBudgetPromotionPercentage
salaryBudgetExtraPercentage
salaryBudgetExtra2Percentage
salaryBudgetLumpsumPercentage
salaryBudgetFinalSalaryPercentage
salaryBudgetTotalCompPercentage
stockBudgetStockAmount
stockBudgetUnitAmount
stockBudgetOptionAmount
stockBudgetOther1Amount
stockBudgetOther2Amount
stockBudgetOther3Amount
bonusBudgetAmount
matrixManager
proxy
customManager
secondManager
defaultLocale
status
vpIndividualView
personalCompensationStatement
userTags
time
retirementDate
seatingChart
personalVarPayStatement
personalCombinedStatement
personalCombinedStatement
varPayBonusAssignmentStatement
on-leave-status
empWorkflowRequests
matrix1Label
matrix2Label
companyExitDate
sysLearningHistory
sysCurricula
totalTeamSize
teamMembersSize
timeInCurrentPosition
timeAtCompany
previousPosition
previousEmployer
loginMethod
learningLicenseUserType
Legacy fields that were part of the User Directory can’t have picklists IDs associated with them.
While importing the Succession Data Model, if a field not allowed to have a picklist, has been modified to have a
picklist, there’s no validation error. However, you see data issues in the application if such configuration exists.
Field ID
userid
username
nickname
gender
suffix
salutation
division
department
location
jobCode
hireDate
managerId
hrId
defaultLocale
title
You can modify your standard elements in the Succession Data Model to fit your business needs.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
Defining a standard element in the Succession Data Model is optional. If permissions have been granted to the
element, they’re available in the UI. However, if you wish to modify the default behavior of a standard element, you
define the element in the Succession Data Model.
Caution
It’s possible for you to modify the label of a standard element and use the element for a different purpose.
However, doing so isn’t recommended. The length or type of the field may not suit its new purpose. Also, while
the use may seem to work now, it can have consequences downstream that may not be correctable. There are
15 custom standard elements available to you and the customxx field IDs can be used for a need not addressed
by the predefined standard elements.
Overwrite the existing label in the element. If there are other language labels for your standard element,
modify or add them as needed.
● Change field requirement
Note
You create the picklist. The picklist is then added to the standard element as in the code sample.
● Set a field to be a matrix filter
Task overview: Standard Elements in the Succession Data Model [page 51]
Related Information
User Info Elements (userinfo-element) are used to define custom fields as well as to define fields used to
integrate with SAP SuccessFactors Recruiting. Each userinfo-element can have more than one value.
XML elements and attributes for user-info-element are defined in this topic.
Type The data type of the userinfo element. Type is required. Type can be:
● varchar: text or string
● float: number field with or without
decimals
● integer: number field with no
decimals
● date: a date field
Note
You can set type to be blob or
boolean per DTD definition.
However, these types aren’t
supported.
required Force the user to input information for "false" by default if not configured.
that field.
label Label for the element. You can add labels for implemented
languages.
You can modify an existing userinfo-element or add a userinfo-element to your Succession Data Model
based on your business needs.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Procedure
Sample Code
<label>Willing to Relocate</label>
<picklist id="relo"/>
</userinfo-element>
You create the picklist. The picklist is then added to the userinfo element as in the code sample.
Overwrite the existing label in the element. If there are other language labels for your standard element,
modify or add them as needed.
Related Information
Background Elements (background-element) in the Succession Data Model are elements where a one to many
relationships exists between the field and the data it can store.
There are two kinds of background elements - data field based and rating field based. Examples of background data
elements are Education and Work Experience. Rating fields can be from the Performance Management module or
be imported. The kind of rating depends on the field used and its configuration. The element ids prefixed with "sys"
are special types that have restrictions about what can be modified.
The elements defined as background elements can be displayed on People Profile in the background and trend
information blocks.
Related Information
XML elements and attributes for background-element are defined in this topic.
These are elements where a one to many relationship exists between the element and data. There are two kinds of
background elements - background data elements, and background rating elements.
background-element Definition
Attribute Description Notes
type-id A unique ID for each background ele This has to be an integer and is required.
ment. There’s no default value.
id A unique ID for each element. The global name for this section, is a
string field. Must be unique. It has no de
fault value. You see this ID being used in
the export and import of live profile back
ground and rating files. You can’t remove
or comment out data-fields or rating-
fields from a 'sys' background element.
You can set hidden to true for data fields
and set visibility to none for rating-fields
so the field doesn’t appear in the applica
tion.
Note
You can't use the same ID for a Back
ground Element. While uploading the
data model upper and lowercase let
ters are considered as the same
string values.
max-entries Maximum number of the rows you’re al The maximum number of entries allowed
lowed from the UI via live profile self-service. This limit
doesn’t apply when importing data items.
scale-id Used for rating background elements. Only applicable for rating background el
ements. Allowed values are: Perform
ance, Potential, Objective, or Compe
tency.
feedback-type Used for rating background elements. Only applicable for rating sections.
XML elements and attributes for background-element are defined in this topic.
Sample Code
<label>Language Skills</label>
<label>Language</label>
<picklist id="language"/>
</data-field>
<label>Language Variant</label>
</data-field>
<label>Speaking Proficiency</label>
<picklist id="fluency"/>
</data-field>
<label>Reading Proficiency</label>
</data-field>
<label>Writing Proficiency</label>
<picklist id="fluency"/>
</data-field>
</background-element>
id The unique identifier for each back A unique ID. There are some IDs which
ground data field.
are standard for SAP SuccessFactors
which are used to internally for other fea
tures and functionality. This is a required
field.
Note
You cannot configure the same val
ues for the Data Field ID and
Background Element ID.
field-name Name for each background data field The field-name is the database field
name to use. This is a required field. Al
lowed names are based on type of field
needed and are unique for a background
data element. Refer to the table below for
names.
required Force the user to input information for Value is true or false. "false" by default if
that field not configured.
pii Personally Identifiable Information. It will This property is not supported currently.
display the field value as "********" for
Value is true or false.
the user.
Even if configured in the Succession Data
Model, it will not have any effect. The
value will not be masked as "*****".
"false" by default if not configured
document-type-id Attachment field attribute to identify the Each background element can have one
classification optional field of attachment type. This
field allows you to classify uploaded
documents for easy search. For example,
when you do a search on all the docu
ments of type "Classification", any docu
ment with type-id set to Classification will
be returned. The following types are sup
ported: RESUME, COVERLETTER,
HRIS_ATTACHMENT, PERFORM
ANCE_ASSESSMENTS,
360_MULTI_RATER_ASSESSMENTS ,
CERTIFICATIONS, PUBLICATIONS,
USER_DEFINED, ATTACHMENTS, APPLI
CATION_INTERVIEW_ATTACHMENTS
Note
If this field is not defined or is de
fined as empty, you can add attach
ments in all the supported formats
except XML and CSV, in People Pro
file or through Live Profile Import.
readonly Column will be NOT editable if it is used Not supported currently. Configuring it in
the data model will have no effect. "false"
by default if not configured
text-area-enabled The input area will become a text area Value will be true | false.
which supports multiple lines
Used in UI v12. "false" by default if not
configured
startDate date
endDate date
dfld1-dfld4 date
lastModified readonly
XML elements and attributes for background-element used for rating-field are defined in this topic.
Sample Code
● sysOverallPerformance
● sysOverallPotential
● sysOverallObjective
● sysOverallCompetency
● sysOverallCustom1
● sysOverallCustom2
● start-date
● end-date - the two date fields are re
quired; the visibility must be either
"edit" or "both"
● name - not meaningful for perform
ance or potential. Used to store the
name of the competency and name
of the objective for the respective
ratings. If you wish to view all overall
competency scores from all forms
for a user in Live Profile, then you
can set this element to view and the
entire section to read only.
● description - Just as name, useful
for Competency and Objective rat
ings.
● rating - You have to include this field
in a rating background element. To
hide the numeric rating, set the visi
bility to "none". However, either the
rating or the label has to be modifia-
ble.
● label - You can use this field to im
port ratings from another system
● min - Used along with max to define
a range when importing ratings.
● max
● source - set system-generated to
true
● module - set system-generated to
true
● attachment1
insert-rating Only used for rating field. A rating Value is set to false by default.
scale is available for rating when this is
set to true.
system-generated If set to true, you can’t edit the field by Value is set to false by default.
visibility Value determines what you can do with Visibility and permission rules:
the field.
If a user has "write" permission to the
field, then user can:
document-type-id Attachment field attribute to identify the Each background element can have one
classification optional field of attachment type. This
field allows you to classify uploaded
documents for easy search. For example,
when you search all the documents of
type "Classification", any document with
type-id set to Classification is returned.
The following types are supported: RE
SUME, COVERLETTER, HRIS_ATTACH
MENT, PERFORMANCE_ASSESSMENTS,
360_MULTI_RATER_ASSESSMENTS ,
CERTIFICATIONS, PUBLICATIONS,
USER_DEFINED, ATTACHMENTS, APPLI
CATION_INTERVIEW_ATTACHMENTS
Note
If this field is not defined or is de
fined as empty, you can add attach
ments in all the supported formats
except XML and CSV in People Pro
file.
Some of the background elements that have preset functionality and use within the SAP SuccessFactors HXM
Suite are listed here.
These background elements are included in the Succession Data Model and are configured at the time of
implementation based on your needs.
Background Element ID
sysOverallPerformance
sysOverallPotential
sysOverallObjective
sysOverallCompetency
talentPool
sysScoreCardBadge
calibrationHistoryPortlet
sysScoreCardCompetenciesPortlet
sysScoreCardObjRatingsPortlet
sysScoreCardOverviewPortlet
sysScoreCardPerfHistoryPortlet
sysScoreCardSuccessorPortlet
sysScoreCardPositionPortlet
matrix1placement
matrix2placement
sysScoreCardNominationPortlet
sysScoreCardDevelopmentObjectivesPortlet
sysLearningHistory
sysCurricula
sysScoreCardObjectivePortlet
sysScoreCardCustomExtensionPortlet
varPayEmpHistData
compensation
preferredNextMove
insideWorkExperience
outsideWorkExperience
education
experience
courses
certificates
promotability
specialAssign
You can modify your background elements in the Succession Data Model to fit your business needs.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
You can add a new background element or modify an existed pre-defined background element. Pre-defined
background elements have system-defined uses and functionality associated with them.
Procedure
You can insert a new data field in your background data element. The field-name is unique. Refer to element
and field definitions for specifics.
Note
Don’t modify an existing data field-name. Doing so can cause data corruption.
Overwrite the existing label in the element. If there are other language labels for your background element,
data fields or the rating fields, you can modify or add them as needed.
● Change field requirement
Remember
Some fields are required. Refer to element and fields definition for specifics.
Note
You create the picklist. The picklist is then added to the background data field as in the code sample.
Tab Elements are included in the Succession Data Model so the functionality they reference can show up in your
instance.
Related Information
Tab elements are in the Succession Data Model so certain areas of the application are available on the front end
based on permissions.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Note
tab-element is added after the definition of the background fields is complete. So, if no tab-element is in
the data model, look for the last </background-element>, and add new tab-element right after.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Procedure
Sample Code
<tab-element id="pendingapprovals">
<label>Pending Requests</label>
</tab-element>
Label translations aren’t included in this sample code. The master data models include code for additional tab
elements as well as label translations.
Task overview: Tab Elements in the Succession Data Model [page 75]
The tab-element needs to be defined in the Succession Data Model to navigate to the relevant functionality.
id is needed for the tab-element when defining the tab elements. These IDs are hardcoded in the system and are
listed here.
ectbenefitsfocus My Benefits
Parent topic: Tab Elements in the Succession Data Model [page 75]
Related Information
HRIS Elements in the Succession Data Model determine which fields appear in the application as far as data related
to the employee is concerned.
Note
You have to activate pay
roll integration to use this
feature.
Note
You have to activate global
assignments manage
ment to use this feature.
Note
You have to activate pen
sion payouts to use this
feature.
Related Information
Here is a list of required HRIS fields for the HRIS elements in the Succession Data Model.
For this HRIS element in the Succession Data Model... ...this HRIS field is always required:
compInfo currency-code
emailInfo email-address
email-type
employmentInfo end-date
start-date
globalAssignmentInfo company
end-date
assignment-type
planned-end-date
imInfo im-id
jobInfo job-code
company
business-unit
jobRelationsInfo relationship-type
rel-user-id
nationalIdCard card-type
national-id
isPrimary
country
payComponentNonRecurring pay-component-code
value
pay-date
payComponentRecurring pay-component
frequency
paycompvalue
pensionPayoutsInfo company
end-date
personalInfo first-name
last-name
personRelationshipInfo relationship-type
phoneInfo phone-type
phone-number
workPermitInfo issue-date
Custom filters can be added so as to use the standard elements as filters for search screens in the SAP
SuccessFactors HXM Suite, for example when mass creating forms.
By default the search screens in SAP SuccessFactors HXM Suite have some fields available as filters. These fields
are Department, Division, Location, and Username. Standard fields with fields Ids custom01 to custom15 can be
set up as custom filters.
Related Information
custom-filter configuration enables you to define filter criteria for certain parts of the SAP SuccessFactors
HXM Suite such as when mass creating Performance or Compensation forms.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Tip
Procedure
If the custom-filter code doesn’t exist, find the last hris-action or the first dg-filter
2. Use the code example here to update custom filters for your instance
Sample Code
<custom-filters>
<filter-module id="default">
<standard-element-ref refid="custom01"/>
<standard-element-ref refid="custom02"/>
</filter-module>
<filter-module id="calibration">
<standard-element-ref refid="custom01"/>
<standard-element-ref refid="custom02"/>
</filter-module>
</custom-filters>
Task overview: Custom Filters in the Succession Data Model [page 81]
Related Information
You include an HRIS action ID in your Succession Data Model so you can see the related action in the SAP
SuccessFactors HXM Suite.
Related Information
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
The hris-action IDs are pre-defined in the system and have functionality tied to them.
This section comes right after the last hris element end tag (</hris-element>) in your Succession Data Model
2. Add the hris-action ID as in the code sample.
Sample Code
<hris-action id="hireAction">
</hris-action>
Task overview: HRIS Action (hris-action) in the Succession Data Model [page 83]
Related Information
HRIS action IDs that are supported for inclusion in the Succession Data Model are listed here.
HRIS Action ID
addCitizenshipInfoAction
addDirectDepositAction
addEmailInfoAction
addIMInfoAction
addNationalIdCardAction
addPayCompNonRecurringAction
addPayCompRecurringAction
addPhoneInfoAction
addVisaInfoAction
addWorkPermitInfoAction
changeBusinessAddressAction
changeHomeAddressAction
changeJobAction
changePersonalInfoAction
hireAction
hrisTransferAction
planLeaveOfAbsenceAction
reHireAction
returnLeaveOfAbsenceAction
terminateAction
transferAction
updateWorkEligibilityAction
Parent topic: HRIS Action (hris-action) in the Succession Data Model [page 83]
Related Information
Element permission is deprecated functionality that was used to give read or edit permissions to Employee Profile
elements.
Context
This code still exists in the Succession Data Model but is mostly due to backward compatibility. You permission the
various elements on the data model using role-based permissions.
Related Information
Edit or add the dg-filters section if you want to set up dynamic group filters in the Succession Data Model. This
code enables the fields to be available for dynamic groups, for example, filter fields when setting up permission
groups for role-based permissions, or employee groups.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
When you create groups, you select the group members according to specific selection criteria. You can configure
which selection criteria show up on the screen where you define permission groups.
Procedure
Add dg-filter as in the code example right after all of the element-permission blocks.
Sample Code
<dg-filters>
<my-filter>
Note
Ensure to always specify at least one HRIS Field reference for a HRIS Element in the Dynamic Group Filters
section before uploading the Succession Data Model. An invalid configuration will prevent Dynamic Group Filter
configuration sync.
Here:
○ Filters for default groups, for example the filters for Manage Employee Groups and Settings Groups , are
within the my-filter tags.
○ Standard element custom01 is set up as a filter criterion when creating dynamic permission groups.
○ HRIS elements and their fields are set up as filter criteria when creating dynamic permission groups
Note
If there’s no configuration in place, in the Succession Data Model, there are standard fields that show up by
default.
Tip
Always ensure that the HRIS fields included in your dynamic group filters are enabled in their respective HRIS
elements. If you disable a field in an HRIS element, check if it's also a part of a dynamic group filter. If so, then
remove it from the filter configuration as well. This way, you can avoid validations arising out of disabled fields
present in dynamic group filters when you import changes to your Succession Data Model.
Related Information
The fields that can be used when defining permission groups are the standard fields listed below, as well as any of
the HRIS fields when Employee Central is enabled.
view-template and its attribute edit-template are used to define the fields that can display in certain areas of
the application.
There are predefined view-template ids that exist in your Succession Data Model. These can be edited to refer to
the standard and background elements in your data model. Here's an example where this view-template is defining
the fields avialable for Talent Search.
Related Information
Here is a list of standard view templates and some of the edit templates that are defined in the Succession Data
Model.
employeeProfile personalInformation
orgChartFields
promotability
sysOverallPerformance
sysOverallPotential
sysOverallObjective
sysOverallCompetency
insideWorkExperience
specialAssign
outsideWorkExperience
education
courses
certificates
awards
languages
funcExperience
leadExperience
careergoals
mobility
memberships
community
compensation
talentSearch personalInformation
orgChartFields
jobInfo
insideWorkExperience
outsideWorkExperience
specialAssign
outsideWorkExperience
education
courses
certificates
awards
languages
funcExperience
leadExperience
careergoals
mobility
memberships
community
promotability
sysOverallPerformance
sysOverallPotential
employeeScoreCard scorecardEditTemplate
Sample Code
<standard-element-ref
refid="username"/>
sysVisibleUserDirectorySetting
photoCardFields
mobileCardFields
positionOrgChart editPosition
You can modify the Succession Data Model XML to include HRIS Sync mappings.
Prerequisites
You’ve downloaded the Succession Data Model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
Using HRIS Sync mapping, you map Employee Central fields to the user data fields you wish to push data to.
Procedure
1. Find the last <view-template> tag section in your Succession Data Model.
The <hris-sync-mappings> elements begin right after the last view template end tag (</view-template>) in
your Succession Data Model.
2. Add the <hris-sync-mappings> as in the code examples.
Sample Code
...
</edit-template>
</view-template>
<hris-sync-mappings>
<hris-element-ref refid="phoneInfo">
<hris-mapping entity-type="H" >
<hris-field-ref refid="custom-long2"/>
<standard-element-ref refid="custom02"/>
</hris-mapping>
</hris-element-ref>
<hris-element-ref refid="jobInfo">
<hris-mapping >
<hris-field-ref refid="company"/>
<user-info-record-key>user-company</user-info-record-key>
</hris-mapping>
<hris-mapping >
<hris-field-ref refid="employee-class"/>
<userinfo-element-ref refid="employeeClass"/>
</hris-mapping>
Related Information
You can configure log read access for HRIS elements including country/region-specific HRIS elements, and for
Employee Profile; User Info, Standard, and Background Elements using Succession Data Model.
Prerequisites
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
By default, HRIS fields for HRIS elements aren’t configured as read audit fields. You can choose fields for HRIS
elements that you want to include in log read access.
For Employee Profile, you can configure log read access for the following fields:
● User Info
● Standard
● Background Elements (Data and Rating Fields)
Procedure
1. Log in to provisioning
2. Click on your instance in provisioning
3. Scroll down to the Succession Management section.
4. Choose the relevant link to work with the desired data model file.
Caution
We recommend that when uploading the country/region-specific data models, you remove any countries/
regions and fields that you don’t need before uploading the XML for the first time. If you upload the
complete data model, the upload takes longer due to the number of countries/regions in the XML file.
Related Information
User data imports and syncing of data across modules is impacted by how the Succession Data Model is set up.
Succession Data Model and User Data File (UDF) [page 96]
User Data File columns are dependent on the fields defined in the Succession Data Model.
Related Information
Configuring HRIS Sync Mappings (hris-sync-mappings) in the Succession Data Model [page 93]
User Data File columns are dependent on the fields defined in the Succession Data Model.
User Data File is a comma separated (csv) file that stores employee-related data defined using standard elements
in the Succession Data Model.
Caution
If using Employee Central, do not make user data changes by importing User Data File either from the UI or
through a scheduled job. Doing so can overwrite data coming from Employee Central and cause data
inconsistencies.
You can import this employee data using the User Data File. You can also export a template for the file or the file
with employee data in it from Admin Center. The format of the file and columns that are on it are determined by
how the fields are defined in the Succession Data Model.
Sample Code
<edit-template id="sysVisibleUserDirectorySetting">
<label>User Directory Setting(Visible)</label>
<standard-element-ref refid="username"/>
<standard-element-ref refid="firstName"/>
<standard-element-ref refid="nickname"/>
<standard-element-ref refid="mi"/>
<standard-element-ref refid="lastName"/>
<standard-element-ref refid="suffix"/>
<standard-element-ref refid="title"/>
<standard-element-ref refid="gender"/>
</edit-template>
If a field is set to required="true" but the value is left blank during import, you receive an error.
Parent topic: Succession Data Model and User Data [page 96]
Related Information
The extended information section contains additional user information, such as the length of time an employee has
been in the company, their role or job code, or their manager.
Procedure
1. The extended information section is collapsed by default on the talent card. Click to expand and then edit the
section.
2. Select the fields you want to display on the talent card.
By default, the extended information section displays the employee's Job Level, Function, and Country/Region.
To override those fields, select from the lists any other user information field defined for your company.
The available fields are drawn from the standard elements and userinfo elements defined in People Profile.
3. Select Show Label to display the field name label for a field.
4. Save your changes.
Task overview: Succession Data Model and User Data [page 96]
Related Information
Succession Data Model and User Data File (UDF) [page 96]
Succession Data Model is a core data model for employee data that takes input from most other modules.
The advantage of a system like SAP SuccessFactors is easy data flow and ease of data management. However, for
this interphase to work smoothly, right elements have to be in place. These elements can be data elements in the
data model, fields, and their configuration in the target modules, other features, or permissions.
For additional details regarding the configuration of the features in this section, refer to the respective module
documentation.
Succession and Development and the Succession Data Model [page 99]
Succession Management depends on the Succession Data Model to define, display, and permission fields
available for use based on your needs. Similarly, there’s functionality in Career Development Planning that
can fail if certain fields aren’t set up as needed in the Succession Data Model.
Succession Management depends on the Succession Data Model to define, display, and permission fields available
for use based on your needs. Similarly, there’s functionality in Career Development Planning that can fail if certain
fields aren’t set up as needed in the Succession Data Model.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
gender gender M, F
In the Career Worksheet you can include a checkbox on each future role, which will allow users to specify the role as
a Career Interest in their Employee Profile.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
The instance must have preferredNextMove specified in the background-element tag defined in the live
profile data model, and also include title in the data-field tag defined within that background-element.
Additional data-field tags may also be present.
For example:
The Career Worksheet template must also have the share permission enabled for one or more relative roles. For
example, with this configuration, only the employee could share their own role plans. Employees can choose to
select Make public in Live Profile in the Career Worksheet.
<permission for="share">
<description><![CDATA[Only the employee may copy roles to their live profile
page. ] ]></description>
<role-name><![CDATA[E ] ]></role-name>
</permission>
<permission for="share">
<description><![CDATA[ ] ]></description>
</permission>
Note that this function only copies the role name from the Career Worksheet to the Live Profile data model. An
advantage of this approach is that if the user enters a value directly into Live Profile that is an exact match with a
role name, and that role is in the user's career worksheet, the system will detect the match and check the
checkbox.
Caution
Do not set any fields in the background-element to required="true", except for "title". Otherwise, the
career worksheet will not be able to add records to the background-element, since it is only populating the
"title" field.
Learn how the matrix reports are impacted by configuration options in the Succession Data Model
There are other elements to get the matrix reports to work as desired. Look into the Succession: Implementation
and Administration guide for information on those elements.
Configuring the Data Model to Store Matrix Grid Placement History [page 105]
You can store the matrix grid placement history using the Succession Data Model.
Learn about the things you should consider when configuring rating trend elements in the Succession Data Model
for use with matrix grid reports.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Four standard rating trend background-element fields are available for use on matrix grid reports:
● <sysOverallPerformance>
● <sysOverallPotential>
● <sysOverallCompetency>
● <sysOverallObjective>
You can also use the following two custom rating trend elements:
● <sysOverallCustom1>
● <sysOverallCustom2>
The custom fields are similar in behavior to the four standard trend elements, but they can only be used for:
● Importing ratings into People Profile with the trend data import
Note
If you use the objective competency section in your Performance Management form, you must also use
<sysOverallCompetency> and <sysOverallObjective> on the how vs. what matrix grid report. If you
utilize these section types today, you'll need to consider whether you want to trade one functionality for the
other. If you do not use these section types, this may not be a concern now, but you will not be able to
utilize this functionality in the future as long as your matrix grid reports are configured this way.
The custom fields, <sysOverallCustom1> and <sysOverallCustom2> cannot be used for other functions such
as:
Note
They will display in the mini-matrix in the overview block, just not the overall score.
Note
The objective competency summary and performance-potential summary sections of the Performance
Management (PM) forms only support the ratings their names imply. So if you configure the how vs. what
matrix grid report to use, for example, <sysOverallCompetency> vs. <sysOverallCustom1>, then it
cannot be used for the objective competency summary section in a PM form.
Example
● sysOverallPerformance
● sysOverallPotential
● sysOverallCompetency
● sysOverallObjective
● sysOverallCustom1
● sysOverallCustom2
● Potential
● Performance
● Objective
● Competency
● Custom1
● Custom2
feedback-type Unique integer specifying the source of feedback for the sec
tion:
● 8 = Performance
● 7 = Potential
● 6 = Objective
● 5 = Competency
● 27 = Custom1
● 28 = Custom2
Parent topic: Matrix Grid Reports and Succession Data Model [page 103]
Related Information
Configuring the Data Model to Store Matrix Grid Placement History [page 105]
Enabling Fields as Matrix Filters [page 107]
Supported and Unsupported Fields for Matrix Filters [page 108]
Showing Matrix Rating Label in People Profile [page 111]
You can store the matrix grid placement history using the Succession Data Model.
Prerequisites
The Matrix Grid Report (9-Box) and Matrix Grid How Vs. What Report (9-Box) settings are enabled in Provisioning.
Context
The placement history is stored in the data model and can be viewed by adding a block to the People Profile.
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Procedure
1. Add two background elements to the Succession Data Model for the two matrix grid reports.
○ <matrix1placement>: for Performance vs. Potential
○ <matrix2placement>: for How vs. What
Sample Code
2. Make sure that appropriate role-based permissions are in place for the two background elements.
Results
Now, the data model is ready to store the matrix grid placement when a rating change occurs in a relevant
Performance Management form.
Next Steps
In order to view the history, you need to set up a block in People Profile. You can also generate an initial past history
of matrix grid placement by scheduling the job Regenerate Matrix Placement History.
Caution
Changing a rating scale that impacts matrix grid placement results in regeneration of the entire matrix grid
placement history to match the new rating scale.
Note
After you import trend data, either in Admin Center or in Provisioning, a Regenerate Matrix Placement History
job will be triggered.
Related Information
By default, the Matrix Grid Reports have the fields Department, Division, and Location available as filter options. You
can also add other fields as custom filters to allow for more granular filter options in the report. You can enable
fields to be used as filter fields for the Matrix Grid Reports via the XML.
Context
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Recommendation
Fill in matrix filter fields in user data imports. Blank or null values may result in invalid filter results in the matrix
grid reports.
Tip
If you use text replacement in your system, avoid labels that include a forward slash, “/”, including localizations,
because the export function for Matrix Grid reports cannot process that special character. Any export
attempted where a forward slash is included in a label, for example “Mitarbeiter/in”, will fail. To correct the
issue, simply remove the forward slash from your text replacement labels.
Procedure
Example
Task overview: Matrix Grid Reports and Succession Data Model [page 103]
Related Information
There are three kinds of filters that are supported in matrix grid reports: default filters, custom filters, and other
standard fields.
Supported Fields
● There are three default filters in Succession matrix grid reports: department, division, and location. These
three filters display all the time.
● Custom fields, from custom01 to custom15 are supported. Customizable fields can be associated to a picklist.
If a picklist is used as a matrix filter, the picklist labels will be displayed in customizable fields. Also,
customizable fields remember the picklist labels that you chose last time. These custom fields are put under
<view-template id="sysUserDirectorySetting" ... > / <edit-template
id="sysAllUserDirectorySetting"...> in the Succession Data Model with <matrix-filter> set to
"true".
Sample Code
Unsupported Fields
Below is the list of standard fields that are NOT supported as matrix filter fields in matrix reports. Below fields
should NOT have true attribute for matrix filter in data model xml (matrix-filter="true" is incorrect).
Note
Parent topic: Matrix Grid Reports and Succession Data Model [page 103]
Related Information
You can show the cell label for an employee's latest matrix grid report placement in People Profile.
Context
The label will respect the matrix grid report admin settings, including rating sources and processes. You can do this
for either or both matrix grid reports.
1. In the data model, define the field that will contain the rating.
○ <matrix1Label> for the Performance/Potential matrix
○ <matrix2Label> for the How vs. What matrix
Sample Code
2. Grant the appropriate permission for the field in role-based permissions (RBP).
Typically, this should match the permissions for the ratings used for the matrix grid report.
3. Add the field to the <personalInformation> edit-template in the <employeeProfile> view-template.
4. In the admin center, go to Configure People Profile to add the new field to the layout of a block in People Profile.
Like other fields, it must be defined within a Live Profile User Information block.
Note
Results
The matrix rating label for an employee's latest matrix grid report placement is displayed in People Profile.
Also, by default, the <matrix1label> and <matrix2label> fields are included in the Personal Information
export. To override this and control the fields included in the export file, use the <sysDefinedFields> view-
template.
Task overview: Matrix Grid Reports and Succession Data Model [page 103]
Related Information
Configuration needs to be included in the Succession Data Model. This configuration enables you to include the
Development blocks in People Profile.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
You must define a view-template called positionOrgChart in the Succession Data Model that lists the fields that
can be edited for positions (whether filled or vacant). Here’s an example:
The view-template can only include standard-element fields defined in the data model. However, in general, it
should only include fields that would remain unchanged regardless of who fills the position. Attributes like hire date,
gender, risk of loss, and so forth would not be appropriate.
The position code, manager position, incumbent, and key position are part of the position record, and should not
be included in the view-template—they always appear in the position edit dialog. Position Code is a unique value
that you can define, or if it's not available, the system will fill it with a unique ID number.
Title should also not be included in the view-template as it will always be included automatically.
Talent Search uses the fields defined in the Succession Data Model as search criteria.
A list of all possible basic information fields and their data types.
username User
email Text
gender Boolean
lastName Text
firstName Text
mi Text
department Text
division Text
location Text
jobCode Text
hireDate Date
managerId User
timezone Text
hrId User
defaultLocale Text
title Text
businessPhone Text
homePhone Text
cellPhone Text
fax Text
addressLine1 Text
addressLine2 Text
city Text
state Text
zipCode Text
country Text
empId Number
custom01 Text
custom02 Text
custom03 Text
custom04 Text
custom05 Text
custom06 Text
custom07 Text
custom08 Text
custom09 Text
custom10 Text
custom11 Text
custom12 Text
custom13 Text
custom14 Text
custom15 Text
ssn Text
dateOfBirth Date
citizenship Date
nationality Date
ethnicity Date
married Boolean
minority Boolean
businessSegment Text
serviceDate Date
level Text
function Text
performance Number
potential Number
objective Number
competency Number
talentPool Text
analytics Text
riskOfLoss Text
impactOfLoss Text
benchStrength Text
reasonForLeaving Text
newToPosition Boolean
dateOfPosition Date
keyPosition Boolean
futureLeader Boolean
matrixManaged Boolean
Compensation pushes data to the Employee profle based on the field definitions in the Succession Data Model.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
People Profile and the Succession Data Model [page 126]
Recruiting and Succession Data Model [page 127]
Talent Management and the Succession Data Model [page 141]
Employee Central and the Succession Data Model [page 147]
Learning and Succession Data Model [page 154]
Onboarding and the Succession Data Model [page 155]
Data Models and Other Integrations [page 162]
Context
Some customers choose to display compensation data on the SAP SuccessFactors People Profile. The setup of
People Profile is usually configured in a previous implementation. As part of the compensation implementation, you
may need to add one or more blocks to People Profile in order to store and display compensation data.
The blocks on the compensation profile can be updated in two different ways. Your configuration and customer's
preferences will determine which option will work best.
Option 1: Publish new compensation data from the compensation worksheet directly to People Profile.
With this option, the fields in the compensation worksheet are mapped to the profile. At the end of the cycle, an
administrator can publish the finalized compensation data directly to the profile. This option is best if the customer
wants to publish the results of the compensation cycle once per year after the cycle. They can't use this option to
continue to update compensation information throughout the year.
Note
This option will only work if your customer is using standard SAP SuccessFactors fields. This option will not
work for any custom field on the compensation worksheet. If your customer wants to publish custom fields to
the employee profile, they must use a custom background portlet as described in option 2.
Option 2: Create a custom portlet in the employee profile which is populated by the customer through an import.
The customer will need to create a file outside of the SAP SuccessFactors system which can be imported manually
or via the FTP site to load into People Profile. With this option, there is no connection or integration between the
compensation worksheets and People Profile.
Most large customers use this option so they can continue to update compensation data year round. The most
common scenario is that the customer will schedule a daily update of People Profile by transferring data from their
HRMS to the SAP SuccessFactors People Profile through a daily import. At the end of the compensation cycle,
there is not direct connection from the compensation worksheet to the profile. Instead, the customer will need to
export the compensation data from the SAP SuccessFactors system and load it into their external HRMS. This data
is then updated in their HRMS, and will thus flow through to the SAP SuccessFactors People Profile on the next
daily import.
You can now select and publish specific completed worksheet in Employee Central for a selected Compensation
Plan template.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
1. In Provisioning of your customer's instance, go to the Succession Management section and click Import/Export
Data Model to export the data model.
If your customer is using option 1 described above (to publish standard fields directly from the compensation
worksheet to People Profile), then copy and paste the XML code below at the end of the BACKGROUND-
ELEMENT section (usually to be found above any custom filters and/or element permissions):
Example
</data-field>
<data-field id="compRating" field-name="vfld6">
<label>Comp Rating</label>
</data-field>
<data-field id="curSalary" field-name="vfld7">
<label>Salary before review</label>
</data-field>
<data-field id="promotion" field-name="vfld8">
<label>Promotion</label>
</data-field>
<data-field id="merit" field-name="vfld9">
<label>Merit</label>
</data-field>
<data-field id="extra" field-name="vfld9">
<label>Adjustment</label>
</data-field>
<data-field id="raise" field-name="vfld10">
<label>Total Raise</label>
</data-field>
<data-field id="finSalary" field-name="vfld11">
<label>Salary after review</label>
</data-field>
<data-field id="compaRatio" field-name="ffld1">
<label>Compa-ratio</label>
</data-field>
<data-field id="lumpSum" field-name="ffld2">
<label>Lump Sum</label>
</data-field>
Note
○ The example above includes a number of standard SAP SuccessFactors fields. You should review the
XML and remove the fields that are not included in your XML template. You can also add standard fields
as long as the data-field id exactly matches the comp-field-definition id from the compensation
worksheet.
○ The field name parameter (e.g. field-name="vfld1") in this background section of Data Model must be
unique for each field.
○ As of today, we can push the following compensation form fields out to People Profile. These are the
only fields that can be published directly from the compensation worksheet to the People Profile
standard compensation block:
jobTitle
jobLevel
jobFamily
jobRole
jobCode
payGrade
finalJobFamily
finalJobRole
finalJobCode
finalPayGrade
startDate
prorating
pmRating
compRating
curSalary
promo
merit
extra
extra2
raiseProrating
raise
finalSalary
compaRatio
rangePenetration
lumpSum
lumpSum2
If your customer is creating a custom background information block (as described in option 2 above), then you
will need to create your own XML to add to the data model. The format is similar to the example above.
However, the background-element ID and the data-field ID must be custom IDs. You cannot use the standard
field names in a custom background information block.
Example
Code Syntax
<element-permission type="read/write">
<description>The roles that may write compensation</description>
<role-name>EM</role-name>
<role-name>EMM</role-name>
<role-name>EMMM</role-name>
<role-name>EMMMM</role-name>
<role-name>EH</role-name>
<background-element-ref refid="compensation"/>
</element-permission>
6. Import the adapted data model into your customer's instance in Provisioning.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product
Support.
7. Go back to the main Admin Tools page. Under Employee Files, click Configure Employee Files.
8. Go to the view that should have the new compensation portlet. If you want to create a new view, click Add New
View. Otherwise, you can add the portlet to an existing view under Actions. To do so, click the Edit link.
Results
As soon as you have successfully created the compensation portlet on the employee profile, you can publish data.
The method you use to publish data will depend on the option you choose for creating a portlet.
If you chose option 1 to create a standard portlet using standard fields from the compensation worksheet, then you
can publish data directly from the compensation worksheet to the employee profile using the following
instructions:
1. Go to Compensation Home and select the compensation plan template you are going to publish and click
Complete Compensation Cycle.
2. Click Publish Data, then Publish in Live Profile or Publish in Employee Central. Only recurring and non-recurring
pay component amounts greater than zero, on completed worksheets, will be published.
3. If you want to review the completion status of your worksheets first, click Check Forms Status. The number of
your worksheets for the selected template and their completion status is displayed.
If you configured option 2 to create a custom background portlet, then the data will need to be updated by a data
file import using the following instructions:
Example
Here are a few sample data files. The first column must be the ^Userid in order to identify which employee
the line refers to. The second column should be the same as the background-element id defined in the data
model. The other columns are the exact field-name ids defined in the data model for the portlet.
This example is the data file which would go with the XML section in the data model example for Option 2
earlier in this chapter.
Here is another sample data file for a different portlet. As you can see, the data is entirely based on the
configuration in the data model.
2. To load the data, go to Admin Tools. Click Update User Information, then Import Extended User Information.
3. Browse for your file, then select Background Element. You can select the appropriate import options.
4. Click Import Extended User File. Browse for your file, then select Background Element. You can select the
appropriate import options.
5. Click Import Extended User File.
7. Once the process is complete, you will now receive an email notification to your registered mail address.
The process could take some time, depending on the number of forms. If you do not receive any
notification regarding your process, contact our Product Support.
8. While publishing selected worksheet, if there are no compensation forms for the selected template, a warning
message is displayed:
Understand the connection between People Profile, the Succession Data Model and SAP SuccessFactors
Succession Planning.
The main purpose of People Profile as it relates to Succession Planning is to collect or store data that is displayed
with the various succession planning tools.
Employee data is gathered and displayed within People Profile based on the blocks that you design and the
permissions of the user.
Any changes to field labels or activation of fields must take place within the Succession Data Model XML before you
create any People Profile blocks. After the fields or template modifications are completed in the XML, you can
configure the blocks from Admin Center Configure People Profile .
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
Recruiting and Succession Data Model [page 127]
Talent Management and the Succession Data Model [page 141]
You can set up your SAP SuccessFactors system in a way such that data from Recruiting Management can be
synced across other SAP SuccessFactors modules.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
People Profile and the Succession Data Model [page 126]
Talent Management and the Succession Data Model [page 141]
Employee Central and the Succession Data Model [page 147]
Learning and Succession Data Model [page 154]
Onboarding and the Succession Data Model [page 155]
Data Models and Other Integrations [page 162]
Only configure background information in the Candidate Profile template if you also have background information
configured in the Succession Data Model for Employee Profile.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Background information appears as a section on the Candidate Profile where multiple entries can be captured.
The internal candidate profile shows the add and delete options on a background element, even though the
background element fields are all read only. This is because, the Role-Based Permissions are set up as read on that
background element while the Succession Data Model has write permissions for that background element.
The background-element tag must appear after the field-definitions (or after search or candidate summary
display options, if configured).
Within background-element, you must configure the label and data-field elements, and if applicable, picklists.
id The id attribute can be any alphanumeric string without spaces or special characters. The value
of the id attribute must be unique within the Candidate Profile template. If an id attribute on a
background element isn’t unique, an error is displayed.
type-id The type-id attribute must be an integer, and the same type attribute can't appear twice in the
Candidate Profile template. If a type-id is on a background element isn’t unique within the Can
didate Profile template, an error is displayed.
Ensure the id and type-id are unique even when you take the Succession Data Model into an ac
count as well. Don’t reuse any of the ids or type-ids from that XML for nonmatching background
elements on the Candidate Profile template, in case you later require to sm-map the back
ground elements together.
required The required attribute must be set to either true or false. If a background element is set to
true, at least one line of data must be added to that background-element to allow the can
didate profile to be saved. Currently, it isn’t possible to specify a minimum number of entries in
a background element. Either no entries are required or one entry is required. More entries are
optional.
label The content in the label element tags is configurable to contain the preferred text that dis
plays the background-element header such as Skills, Work Experience, and so on.
The label element isn’t conditional. This means, it isn’t possible for one field to display one
label to internal candidates and a different label to external candidates. It’s also not possible for
one background-element to display one label to candidates and a different label to internal
recruiting users.
Note
Multiple label elements can be defined on the background-element, if the client has pur
chased multiple language packs.
data-field within a Back Every background-element must contain at least one data-field element. Each
ground Element
data-field element appears as a field to the end user, and all the fields within a
background-element is displayed as a record within the background-element.
You can only configure a limited number of data-field elements for each field-name type (for ex
ample, 15 vfld fields). You must consider how much data a candidate can provide without getting
frustrated and what the user experience is with many fields on UI.
The first few data fields configured appear as the headers on the entry when the entry is col
lapsed. This isn’t configurable and depends solely on the order of the fields.
The data-field element must contain the following attributes: id, field-name, required, and
max-length.
● id: This attribute allows any alphanumeric value, without spaces or special characters, but
that value must be unique within the background-element. The alphanumeric value maybe
used as the id attribute for a data-field within a different background-element and/or can
be used as the id attribute of a field-definition. There are no standard data-field ids.
Note
The ID custom1 is reserved for technical purposes. Do not use this ID in data-
field definition.
● field-name: This attribute defines the type of data the user is allowed to enter in the
field. There’s no type attribute on background element fields. The field-name attribute
replaces the usual type attribute.
○ ifld: This field contains integer values (no decimals). Possible to have up to 8 values
(IFLD1 to IFLD8).
○ ffld: This field contains decimal or boolean values. Possible to have up to 8 values
(FFLD1 to FFLD8).
○ dfld: This field contains dates values. Possible to have up to 3 values (DFLD1 to
DFLD3).
○ vfld: This field contains alphanumeric text values. Possible to have up to 15 values
(VFLD1 to VFLD15).
○ startDate and endDate: These fields contain date values validated against each
other, where start date must precede end date. The startDate and endDate field-
name values can only be used once per background-element.
Note
1. In Manage Template, though it’s possible to use the Name and Desc fields, it’s
recommended that you don’t implement Name and Desc fields.
2. lastmodified isn’t supported in Manage Template.ppl
The ifld, ffld, dfld, and vfld must have an integer added to the end of the attribute value,
such as vfld1, ffld2, and so on. The integers need not be in an order or need not be consecu
tive, but they must be unique within the background element.
● required: Allowable values for the required field are "true" or "false". Fields can’t be
made conditionally required. The requirement attribute applies equally to any user editing a
line of data within a background element, whether they’re an internal candidate, external
candidate, or a recruiter.
● max-length: The max-length can’t be greater than 4000 or less than 1. The max-length
acts as a character limit on the field. If the max-length is 4 and you enter more than four
characters in the field. The system validates this value while you try to save the content and
displays an error.
Caution
Configure a max-length in combination with a picklist carefully, as doing so can re
sult in an error.
XML Sample
When you define a field or background-element in the Candidate Profile template, you can also correlate it to an
Employee Profile standard-element field. This is the purpose of sm-mapping.
Note
The userinfo-element fields on the Succession Data Model aren’t supported in sm-mapping.
When creating sm-mapping entries, ensure the fields that you’re mapping have the same field type. For example,
text to text and picklist to picklist. Ensure that both fields are defined with the same picklist id when sm-mapping
picklist fields. It isn’t required to match the field id between templates to map successfully, unless you’re working
with a background-element.
Background elements can be mapped. While mapping background elements, the definitions of the background
elements have to match exactly. There are some exceptions for the parts that are intrinsically different in the XML
layout. For example, display-size and max-file-size-KB attributes in the Employee Profile XML, that aren’t supported
in the Candidate Profile template.
Both Candidate Profile data-fields and background-elements can be synced to corresponding fields on the
Employee Profile. The sync is effectively real time but the synced data is subject to the regular candidate indexing
process. Updates to synced data using search isn’t available for up to an hour.
Synchronized data is set up by defining an sm-mapping element in the Candidate Profile template after the last
background-element.
Sample Code
Any Candidate Profile field-definition or background-element can be mapped in the sm-mapping element.
Candidate Profile background-elements are synched if the Candidate Profile template and Succession Data Model
background-element configuration matches. Labels can differ but all other configuration of the background-
Fields with sm-mapping reflect the permissions specified in the Succession Data Model for internal candidate
profiles, regardless of their permissions in the Candidate Profile template.
The sm-mapping element must contain a field-id attribute and a map-to attribute.
Attribute Description
Recommendation
● Ensure that you always include the sm-mapping section in the candidate profile configuration. In case you
fail to include, none of the fields between Employee Profile and Candidate Profile gets mapped. At least the
following mapping should exist in every Candidate Profile template:
● When mapping fields from the Candidate Profile to the SM data model, certain person fields only render
the userID value on the Candidate Profile, rather than a name. This is true of the Manager (M), Matrix
Manager (X), HR Rep (H), and Custom Manager (C) designators. For example, let a user define a manager
ID field in the Candidate Profile template and attempt to map it to the sm-mapping field, managerID. In
this case, only the user ID of the manager is displayed, not the first name and last name of the manager.
● For sm-mapping, field-id must have a value corresponding to either the ID attribute from a field-definition
element or the ID attribute of background element.
XML Sample
The searching of internal candidates can be disabled entirely or limited to where a date field on the Employee
Profile is X number of days from today or earlier.
For example, clients may wish to only allow internal candidates to be found in candidate search if the “ready to
develop” date on their Employee Profile was 30 days from today or earlier.
Check the desired setting. Only one setting may be selected at a time, or both settings may be de-selected.
● Disable searching of internal candidates: No internal candidates will return in the candidate search results
● Find candidates where <select> is <x> days from today or earlier: Internal candidates will only return in the
candidate search results if the specified date on their Employee Profile matches the criteria specified by the
administrator. Note that if no userinfo-element date fields are set up on the succession-data-model, this option
will be grayed out and unavailable.
To pass the new hire data from Recruiting Management to Onboarding, you must map the mandatory Employee
Central Data entity fields with the corresponding fields in Recruiting Management.
Prerequisites
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner. If you're no longer working with an implementation partner, contact Product
Support.
Note
All the three modules should be enabled for the Mandatory Onboarding HRIS Elements and Employee
Central HRIS Elements to appear on the Recruit-to-Hire Data Mapping page.
● Employee Central is configured in your system and all the fields required for data mapping are available in the
Succession Data Model. For more information about Succession Data Model, see the Related Information
section.
● Recruiting Templates are configured in your system.
Onboarding supports the following recruiting templates:
Note
In case you don’t see any data on the Recruit-to-Hire Data Mapping page, go to Admin Center OData
API Metadata Refresh and Export tool and Refresh the Cache. It’s recommended that you log out from the
application and log in back again after refreshing the cache.
Context
Before you map the mandatory Employee Central Data entity fields with the corresponding fields in Recruiting
Management, you need to understand how the data in the Succession Data Model should be made least restrictive.
Note
You should set very few fields in Succession Data Model as mandatory.
When you’re mapping the fields from Succession Data Model for Onboarding, the fields that are required by the
new hire should only be made mandatory on the New Hire Data Model. Rest of the fields should remain optional.
When you are mapping the fields from Succession Data Model for Employee, you should configure it as most
restrictive by setting most of the HRIS fields required by the employee as mandatory.
Note
For example, personalInfo entity by design needs only First Name and Last Name as mandatory fields in
Succession Data Model. Therefore, you aren’t allowed to set these fields as nonmandatory.
● Mapping is not required for the Pay Component Non-Recurring field pay-component-code and the Pay
Component Recurring field pay-component in Recruit-to-Hire Data Mapping. If the value isn’t mapped, it is
taken from context based on the variant name of Pay Component Recurring or Pay Component Non-Recurring
(Example, for the Base salary variant mapped in Recruit-to-Hire Data Mapping its Pay Component ID is taken as
the Pay Component code).
● When the Can Override value is set to Yes in the Foundation Object (FO), the values for the Pay Component
Recurring and Pay Component Non-Recurring fields are populated from the FO on the New Hire Data Review
page and the Manage Pending Hire page when the values aren’t mapped from Recruiting.
● When the Can Override value is set to No in the FO, all the values for the Pay Component Recurring and Pay
Component Non-Recurring fields are populated from FO on the New Hire Data Review page and the Manage
Pending Hire. An error is created in the Business Process Engine (BPE) flow when the values for these
mandatory fields are different from the values in the FO, when this happens you must map the Recruiting
values to similar values in the FO.
● Skip logic implemented based on your business requirements are used in the following scenarios to skip
passing the Pay Component variant from Onboarding to the New Hire Data Review page and the Manage
Pending Hire leaving the field values empty:
If you want to set Middle Name as a mandatory field for personalInfo entity for Internal users, then this field should
be set as a mandatory field in Employee Data Model. If you want to set Middle Name as a mandatory field for
personalInfo entity for an External user, you need to set this as a mandatory field in New Hire Data Model.
Note
You might notice start date as one of the mandatory fields even though it is not available in Succession Data
Model. This is because start date is one of the system mandatory fields.
In the mapping interface, the Employee Central field labels and fields are shown on the left side, whereas the
available Recruiting templates and Recruiting fields are shown on the right side.
Note
The Succession Data Model determines which fields are required and are denoted by a red asterisk.
4. To map an Employee Central field to a Recruiting field, select the Job Requisition Template, Candidate
Application Template, or Job Offer Template from the Recruiting Template dropdown menu and select the
corresponding fields under Recruiting fields.
Note
Click Clear Changes to remove the modification you've made in the current session.
5. It’s recommended that you map the following mandatory Employee Central entities:
○ personalInfo
○ employmentInfo
○ jobInfo
Note
Map all the mandatory fields under these entities correctly to avoid data mismatch.
Here’s an example of all the mandatory fields that you can map:
○ personalInfo.first-name
○ personalInfo.last-name
○ employmentInfo.start-date
○ jobInfo.company
○ jobInfo.manager-id
Note
The manger info "Job Info - Supervisor" that flows from Recruiting to Employee Central should be same
as the manager info set in Position Management.
Other than these fields, there can be other fields from the Employee Central Data Model that are mandatory. It
is recommended that you map jobInfo.event-reason and jobInfo.start-date for the process to work
seamlessly.
Note
Whether a specific field is mandatory or not in the Employee Central Data Model depend on the
configuration in the Data Model.
Time fields should not be mapped for internal hires. For details on mapping time related data, refer to the
Managing Time Related Data in Onboarding link in the Related Information section.
Note
Event Reason isn’t maintained as part of Job Requisition. Currently, the admin must add custom fields for
each Job Req or Applicant Tracking System API.
6. To map configured country/region-specific fields, click (Expand) next to the entity and select the country/
region-specific entity.
7. Click Validate all Entities to check that all mandatory fields are mapped and all data types are correct.
8. To configure variant fields, select the entity from the list, then click (Add) and choose from the available
variants, then map the available fields.
For the variant entities listed below, data from Recruiting to Employee Central is passed only for those variants
of an entity that has the Employee Central Key field value (if the field is present) to be same as the variant
name. For example, if the variant selected for Email_Info is personal then the value of the field email-type for
this variant should be personal. If business is selected as email-type for this variant, then data isn’t passed
from Recruiting to Employee Central.
Email_Info email-type
Phone_Info phone-type
IM_Info domain
Job_Relations_Info relationship-type
Home_Address address-type
Pay_Component_Non_Recurring pay-component-code
Pay_Component_Recurring pay-component
Note
○ The variant name shouldn't contain any special characters except "-".
○ For Foundation objects not supported by Recruiting, the value passed from Recruiting should be equal
to the external code of the object.
○ For applicable entities in Admin Centre Manage Business Configuration , the Enabled for
Onboarding field should be set to Yes for data of an entity to be passed from Recruiting to Employee
Central during initiate onboarding.
○ Base objects for entities must be enabled in Admin Centre Manage Permission Roles .
○ Employee Central key fields that are of picklist type should be mapped to the same picklist from
Recruitment.
Note
Currently, only the Employee Central entities listed in the table below, are supported while integrating
Onboarding with Employee Central. If you map any other entities apart from these, it is ignored and won’t
be saved in Employee Central.
Internal Hire flow is always validated against Employee Data Model, unlike Onboarding flow which is
validated against the Succession Data Model. For the Internal Hire process to work, the following 6 entities
are validated and mapped:
○ Job_Info
Rest of the entities' data is ignored even if it is passed from Recruiting. Also, it is not mandatory to map the
Termination End Date for internal hire.
If you don't map the event reason value for Comp_Info using Recruit-to-Hire Data Mapping the value is
taken from the event reason of Job_Info which is either configured by the OnSave rule or passed from
Recruiting.
Note
If you remove or disable any fields or entities in Business Configuration UI, it doesn’t remove the existing
references of the entities or fields from the "Candidate to Employee Integration" template. You need to
make sure that there are no data mismatches between Business Configuration UI and "Candidate to
Employee Integration" template.
Results
Once the mapping is complete, data collected during the Recruiting process can pass to the new hire's employee
record in Employee Central.
Note
If you want to check the values passed from Recruiting to Onboarding, you can use the Suite Tool to perform
the verification. For more information on how to perform the check, refer to the "Checking the Values Passed
from Recruiting to Onboarding" topic in Related Information section.
Related Information
Talent Management uses employee related data that is defined in the Succession Data Model. It can also be the
source for trend and background data that needs to be defined in the Succession Data Model.
Performance Management, 360 Reviews, and the Succession Data Model [page 141]
You can display certain data from your performance and 360 review forms in the Employee Profile. This
data is part of trend or background data when needing to export from the system.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
People Profile and the Succession Data Model [page 126]
Recruiting and Succession Data Model [page 127]
Employee Central and the Succession Data Model [page 147]
Learning and Succession Data Model [page 154]
Onboarding and the Succession Data Model [page 155]
Data Models and Other Integrations [page 162]
You can display certain data from your performance and 360 review forms in the Employee Profile. This data is part
of trend or background data when needing to export from the system.
You can also show ratings and other data from performance forms in blocks on the Employee Profile. For this data
to be available to Employee Profile, you need to include elements in the Succession Data Model as shown in the
code sample.
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Parent topic: Talent Management and the Succession Data Model [page 141]
Related Information
You can configure blocks in SAP SuccessFactors People Profile to display ratings from Performance Management
forms.
● Trend blocks:
○ Overall performance rating block
○ Overall potential rating block
○ Overall goal rating block
○ Overall competency rating block
These blocks display respective ratings from all forms as multiple records for employees. For more information,
refer to Configuring a Trend Information Block in People Profile.
● Scorecard blocks:
○ Performance History block
○ Competencies block
○ Behaviors block
○ Goal Ratings block
These blocks are affected by processes and display respective ratings according to configuration in a process.
For more information, refer to Configuring a Scorecard Block in People Profile.
● History block in the History section: It shows employees' completed forms in the past 12 months. The data isn't
configurable.
● Rating scale labels are displayed in their default language in the blocks.
● The Performance History block uses predefined fields to display data. You can't add fields to or hide fields
from the block.
● Forms in the Performance History block are sorted alphabetically by form title in a descending order.
● The Competencies block displays an average of the ratings from Performance Management forms, 360
Reviews forms, and competency ratings from SAP SuccessFactors Learning.
● To display Learning URL in the Competencies block, make sure both the SAP SuccessFactors Learning
integration and Transcript features are enabled. For more information, refer to Setting up and Enabling the
Transcript Feature.
● If a competency has more than one rating from different forms, the average rating is displayed in the
Competencies block. The same rule applies to behaviors in the Behaviors block.
● For Scorecard blocks, if the rating scale in a process is different from that in a form, ratings displayed in the
blocks will be normalized to the rating scale in the process. For example, the form has a 5-point rating scale,
and the rating scale selected in the process is a 3-point rating scale. Therefore, ratings will be normalized to
the 3-point scale. Item weight won't be taken into account during the normalization. For more information
about normalization, refer to Calculation Process.
For customers using Job Description Manager, you can pull job-specific competencies in a competency section by
customized data type.
Prerequisites
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product
Support.
Context
Generally, employees' competencies are auto-populated to a competency section according to their job code. You
can use the <fm-comp-filter-mapping> element to customize the mapping data type.
1. In Provisioning, configure the data types to be used for mapping competencies in the Succession Data Model.
This example specifies that Job Code, Department, Division, Custom03, and Custom04 are valid mapping data
types.
2. Create a CSV file based on one particular mapping data type that you've configured, and import the file to
Admin Center Import Job Roles .
The file should include roles, families, values defined in the mapping data type, and competencies to be
mapped.
3. In an XML form template, add the <fm-comp-filter-mapping> element.
Note
For the location where the element should be added, refer to the DTD Definition section in Competency
Section (competency-sect).
Only one mapping data type can be specified for one competency section. Employees' value for the specified
mapping data type will be used for fetching the applicable job roles and the corresponding competencies.
The default value of the enable attribute is false. To enable the feature, set it to true.
<fm-comp-filter-mapping enable="true">
<fm-comp-filter-element refid="department"/>
</fm-comp-filter-mapping>
Sample Code
<competency-sect index="3" configurable= " false " mgt-only= " false " use-
jobcode= " true " category-filter-opt= "no-filter" no-rate= " false " no-
weight= " false " summ-opt= "99" split-cmt= " false " rating-opt= "1" cmt-
opt= "2" suppress-item-comments= "0" behavior-rating-opt= "0" behavior-cmt-
opt= "1" behavior-mode-opt= "0" in-summ-display= " true " in-overall-rating=
" true " no-group= " true " use-behavior= " false " if-no-ratings-then-ignore-
section= " false " lock-item-weights= " false " in-objcomp-summ-display= "
false " in-objcomp-summ-overall-rating= " false " show-comp-expected-rating=
" false " comp-expected-rating-format= "0" show-behavior-expected-rating= "
You define custom fields as custom-filters in the Succession Data Model. These fields can then be used as
filters for goal import by Goal Management.
Parent topic: Talent Management and the Succession Data Model [page 141]
Related Information
Performance Management, 360 Reviews, and the Succession Data Model [page 141]
Calibration and the Succession Data Model [page 146]
Custom Filters in the Succession Data Model [page 81]
Adding Custom Filters in the Succession Data Model [page 82]
Calibration needs Succession Data Model to define rating elements and the Calibration History Block for the
module to display the ratings in a session and also to display the block. There are other dependencies that
Calibration has on the Succession Data Model
Parent topic: Talent Management and the Succession Data Model [page 141]
Related Information
Performance Management, 360 Reviews, and the Succession Data Model [page 141]
Goal Management and the Succession Data Model [page 145]
Calibration depends on the Succession Data Model for the rating elements to be made available in a session. Other
dependencies are described in this topic as well.
You can configure some or all of the rating elements in a data model. These elements can then be used by you in a
calibration session. Also, the labels as configured in the data model appear in the Calibration template and the
Calibration session. Following are the rating elements that can be pulled into a calibration session:
● sysOverallPerformance
● sysOverallPotential
● sysOverallCompetency
● sysOverallObjective
● sysOverallCustom01
● sysOverallCustom02
Other data can be displayed in the Calibration session bin or grid view in addition to the rating elements. These
standard background elements are:
● riskOfLoss
● impactOfLoss
● reasonForLeaving
Note
Risk of Loss, Impact of Loss, and Reason for Leaving are fields you can enable or disable on the data tab
when you configure a calibration template. If these fields are defined in your data model, regardless of
whether or not they’re enabled at the template level, they still show up as an entry under Filter Option.
To add custom fields to the Filter Option, you add the desired fields as custom filters. Example code:
Sample Code
<custom-filters>
Note
The refid here are the standard custom fields included in the data model as custom01-custom15.
Note
This filter applies to all calibration templates at your company. It can’t be configured uniquely for separate
Calibration sessions.
The Calibration History block can be configured to display in Employee Profile. This block displays up to 5 rating
types from calibration sessions. The displayed items are configured in the Calibration template.
When the following code is present in the Succession Data Model, you’re able to add the Calibration History block to
the Employee Profile view.
Employee Central is a vast module that is heavily dependent for its behavior on the data models.
Fields related to employee data are defined in the Succession Data Model. There are other configurations that are
in the Succession Data Model which impacts how the Employee Central works. This topic collates the
dependencies on the Succession Data Model that are beyond the data structure for Employee Central.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
People Profile and the Succession Data Model [page 126]
Recruiting and Succession Data Model [page 127]
Here is some information about sections within the XML for Job Information. You do not have to use sections. Use
sections only if you want to influence which fields appear in which section on the UI. If you do not define sections in
the Succession Data Model, the system defines which fields appear in which section.
The hris-section tag has to be inside the start and end tag of the jobInfo HRIS element. If you use sections in
the data model, all fields that are part of the jobInfo HRIS element have to be inside an hris-section tag. If you
use sections in the Succession Data Model, you also have to use sections in the country/region-specific Succession
Data Model.
orgFieldsList Organization Information You can use this section for fields related
to the company.
● company
● businessUnit
● location
● department
● costCenter
● division
jobFieldsList Job Information You can use this section for fields related
to the job, for example:
● Job Classification
● Job Title
● FTE
timeOffRelatedFields Time Information You can use this section for time-related
fields. For example,
● Holiday Calendar
● Work ScheduleFor
● Time Profile
eeoFieldsList EEO Information You can use this section for fields related
to equal employment opportunity (EEO).
This is only applicable to USA.
● eeo1JobCategoryUSA
● eeo4JobCategoryUSA
● eeo5JobCategoryUSA
● eeo6JobCategoryUSA
● eeoJobGroupUSA
● eeoClass
If you use sections in the country/region-specific Succession Data Model, all the countries with a jobInfo HRIS
element have to use sections. If a country has no jobInfo HRIS element defined in the data model, you do not
have to add sections to that country.
You can use different sections in each jobInfo HRIS element for each country in the country/region-specific
Succession Data Model.
You can sort the fields in a section differently for each country, meaning, the order of the fields in a section can be
different for each country defined in the country/region-specific Succession Data Model.
The following entry-date fields are filled and saved in the system when their base fields of job classification (hris-
field with id="job-code"), position (hris-field with id="position") , company (hris-field with
id="company") , location (hris-field with id="location"), department (hris-field with
id="department"), or pay scale level (hris-field with id="payScaleLevel") are changed:
In case of a change in one of the base field values, all configured entry dates in the modified record are calculated,
propagated to future job records and saved to the database. Entry dates always refer to the standard job
classification, position, company, location, department, or pay scale level fields and cannot be calculated based on
custom fields. The respective base fields in Job Information must be configured in addition to the entry date fields
and the TimeIn fields. If the base field does not contain a value, the respective entry date is cleared.
When Centralized services is activated in the system, the entry dates are always automatically calculated, which
means that values set using the UI, imports, or business rules are overwritten by the automatically calculated value.
We recommended that you set the visibility to ‘View’ for these fields in the Succession Data Model (SDM) or the
Country/Region-Specific Succession Data Model (CSFSDM). If one of the base fields changes, all entry dates in the
record are recalculated. Since permissions also control/override the visibility of a field, users should not have insert
and correct permissions for these fields.
Changes to the base fields also trigger the calculation of the TimeIn fields:
● Time in Job
● Time in Position
● Time in Company
● Time in Location
● Time in Department
● Time in Pay Scale Level
These transient fields are calculated and filled in the History UI, Employment Info page and Manager Self-Service
(MSS).
The TimeIn calculation determines the number of years/months/days an employee has worked on a job, position,
company, location, department, or pay scale level. This calculation is based on approximate values, because not all
months have the same number of days. These values are transient and not saved to the database.
To use at least one of the entry date fields in existing Job Information records, run the Initialize additional entry date
fields in job info job. You can find this in Provisioning under Manage Scheduled Jobs. Initialization of entry date fields
in existing job info records has the following impact:
If configured in the Succession Data Model (SDM) or the Country/Region-Specific Succession Data Model
(CSFSDM), the Hire Date, Termination Date, Leave of Absence Start Date, and Leave of Absence Return Date fields
are automatically filled with the effective start date in case a Job Information record is created/changed/deleted
based on their triggering events: Hire, Rehire, Termination, Leave of Absence and Return to Work. The event-based
date fields are only saved to the database if they are configured in the SDM or the country/region-specific SDM.
In case the Job Information’s effective start date is changed in a record with one of the above-mentioned events,
the hire date/termination date /leave of absence start date/leave of absence return date is newly set according to
the new effective start date.
In Job Information History, the date fields are propagated to future records until a new record with a suitable event
(Hire, Rehire, Termination, Leave of Absence, Return to Work) is created. The event-based date fields contain the
date on which the respective triggering event last occurred in this user’s Job Information History. This means that
the hire date contains a value throughout the user’s entire history, even in and after a termination record. Similarly,
the Leave of Absence Start Date is not cleared when a ‘Return to Work’ record is created. In case a Job Information
record is deleted, the event-based date fields are propagated from the previous Job Information records.
Related Information
Job Information
Scheduling Jobs
To use at least one of the new entry date fields, you must run the Manage Scheduled Jobs Initialize additional
entry date fields in job info in Provisioning.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Do not schedule these jobs to recur on any basis. The jobs must not be run more than once since they will
process all Job Information records for all users to set the related entry dates. Ideally if the job must be run
again (if you are now using more of the Entry Date fields), please plan to run the job outside of business hours if
possible.
There is also the Initialize job entry date and position entry date in job info job that initializes only the job and
position entry dates. These jobs will initialize the fields for all existing Job Information records in the database. The
job writes the entry date fields in the same way as the UI logic.
Note
If you choose to initially use a subset of the new fields, run the job and later decide to use another one of the new
entry date fields, you will have to run the job again. While the new job will overwrite the value of all entry date fields,
this will have no effect on the values if the fields were not manually modified in the UI. This is because the
calculation performed in the UI and in the job is the same. Note that if the value was changed by rules, those values
are also overwritten.
Note
Only fields configured in the Succession Data Model or the Country/Region-Specific Succession Data Model
will be written by the job.
● Hire date
● Termination date
● LOA start date
● RLOA start date
They are automatically filled with the effective start date in case a Job Information record is created/changed/
deleted depending on the event:
● Hire
● Rehire
● Termination
● Leave of Absence
● Return to Work
In case the Job Information’s effective start date is changed in a record with one of the above-mentioned events,
the hire date/termination date /leave of absence start date/leave of absence return date is newly set according to
Sample Code
<hris-element id="jobInfo">
<label>Job Information</label>
.
.
<hris-field id="jobEntryDate" visibility="view">
<label>Job Entry Date</label>
</hris-field>
<hris-field max-length="128" id="timeInJob" visibility="view">
<label>Time In Job</label>
</hris-field>
<hris-field id="positionEntryDate" visibility="view">
<label>Position Entry Date</label>
</hris-field>
<hris-field max-length="128" id="timeInPosition" visibility="view">
<label>Time In Position</label>
</hris-field>
<hris-field id="companyEntryDate" visibility="view">
<label>Company Entry Date</label>
</hris-field>
<hris-field max-length="128" id="timeInCompany" visibility="view">
<label>Time In Company</label>
</hris-field>
<hris-field id="locationEntryDate" visibility="view">
<label>Location Entry Date</label>
</hris-field>
<hris-field max-length="128" id="timeInLocation" visibility="view">
<label>Time In Location</label>
</hris-field>
<hris-field id="departmentEntryDate" visibility="view">
<label>Department Entry Date</label>
</hris-field>
<hris-field max-length="128" id="timeInDepartment" visibility="view">
<label>Time In Department</label>
</hris-field>
<hris-field id="payScaleLevelEntryDate" visibility="view">
<label>Pay Scale Level Entry Date</label>
</hris-field>
<hris-field max-length="128" id="timeInPayScaleLevel" visibility="view">
<label>Time In Pay Scale Level</label>
</hris-field>
<hris-field field max-length="128" id="hireDate" visibility="view">
<label>Hire Date</label>
</hris-field>
<hris-field field max-length="128" id="terminationDate" visibility="view">
<label>Termination Date</label>
</hris-field>
<hris-field max-length="128" id="leaveOfAbsenceStartDate" visibility="view">
<label>Leave of Absence Start Date</label>
</hris-field>
<hris-field max-length="128" id="leaveOfAbsenceReturnDate" visibility="view">
<label>Leave of Absence Return Date</label>
Integration points of Learning with the Succession Data Model are listed in this topic.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
People Profile and the Succession Data Model [page 126]
Recruiting and Succession Data Model [page 127]
Talent Management and the Succession Data Model [page 141]
Employee Central and the Succession Data Model [page 147]
Onboarding and the Succession Data Model [page 155]
Data Models and Other Integrations [page 162]
To integrate external learners with SAP SuccessFactors Platform, you must make sure that the following HRIS
elements and fields are configured in your data model.
area-code
phone-number
extension
Onboarding depends on the Succession Data Model when needing to pull or push data to other modules, especially
Employee Central.
There are Admin Center tools that you use to map Onboarding entities to elements in the Employee Central.
Configuring the Succession Data Model for Pre-Day 1 Access [page 156]
You must configure your Succession Data Model to add a custom field IsOnboardingUser, which is
required to classify Pre-Day 1 users and grant them the required access permissions to your SAP
SuccessFactors HXM Suite.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
People Profile and the Succession Data Model [page 126]
Recruiting and Succession Data Model [page 127]
Talent Management and the Succession Data Model [page 141]
Employee Central and the Succession Data Model [page 147]
Learning and Succession Data Model [page 154]
Data Models and Other Integrations [page 162]
You must configure your Succession Data Model to add a custom field IsOnboardingUser, which is required to
classify Pre-Day 1 users and grant them the required access permissions to your SAP SuccessFactors HXM Suite.
Prerequisites
You’ve downloaded the data model and have the file open for editing in an XML editor.
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Context
SAP SuccessFactors Onboarding has a feature where you can provide your new hires access to the application
before their hire date. The Succession Data Model doesn’t contain IsOnboardingUser field by default. By adding
IsOnboardingUser as a custom field to your Succession Data Model to include, you can enable the system to
initialize this parameter when Pre-Day 1 user records are created. For every Pre-Day 1 user record, the
IsOnboardingUser field value is set to YES. Based on this field's value, you can classify Pre-Day 1 users and setup
criteria for granting role-based permissions.
1. Find one of the fifteen standard elements that are set aside for customization.
Note
The id attribute of these fields is set to custom01 to custom15. Pick a field that is not used already for
another field.
2. Modify the label element of the custom field you have selected to be IsOnboardingUser.
Sample Code
Task overview: Onboarding and the Succession Data Model [page 155]
Related Information
Company jobInfo.company
Name Information
Suffix personalInfo.suffix
Person Information
Employee Info
Person ID personalInfo.person-id-external
National ID
Country/Region nationalIdCard.country/region
National Id nationalIdCard.national-id
Primary nationalIdCard.is-primary
The Contact Information object on the second page contains the new employee's e-mail and phone information.
These fields expect a variant as the field type. This is determined in the Onboarding 1.0-Employee Central mapping
tool. You can configure these as either static variants (for example, Home or Business) or as dynamic variants.
Dynamic variants substitute another Onboarding 1.0 field enclosed in $ symbols, for example $phone$.
Personal Information
Gender personalInfo.gender
Contact Information
Global Information The fields related to a country/region have the country/region code as a prefix in the second dropdown in
the mapping tool. These examples use the country/region code for India, IND.
Religion globalInfo.[IND].genericNumber1
Addresses You do not need to map the address type. The value of the variant for fields in the Address object is used to populate
the address type by Employee Central.
Country/Region homeAddress.country/region.$addresstype$
Address 1 homeAddress.address1.$addresstype$
Address 2 homeAddress.address2.$addresstype$
Address 3 homeAddress.address3.$addresstype$
City homeAddress.city.$addresstype$
State homeAddress.state.$addresstype$
Zip homeAddress.zip.$addresstype$
Emergency Contact Emergency contact fields should be designated as repeating fields in the Onboarding 1.0 data dictionary.
Name Emergencycontact.[#].first-name
Relationship Emergencycontact.[#].relationship
Email Emergencycontact.[#].email
Dependent Emergencycontact.[#].dependent
Primary Emergencycontact.[#].isPrimary
Dependent Info In order for values to populate the Dependent Info fields in Employee Central, the values must be mapped to
emergency contact, and the isDependant checkbox should be enabled.
Employment Details
Job Information
Company jobInfo.company
Department jobInfo.department
Compensation Information
Payroll Id compInfo.payroll-id
Amount payComponentRecurring.paycompvalue.$paycomponent$
Currency payComponentRecurring.currency-code.$paycomponent$
Frequency payComponentRecurring.frequency.$paycomponent$
Amount payComponentRecurring.paycompvalue.$paycomponent$
Currency payComponentRecurring.currency-code.$paycomponent$
Frequency payComponentRecurring.frequency.$paycomponent$
Type payComponentNonRecurring.pay-component-code
Amount/Percentage payComponentNonRecurring.amount
Parent topic: Onboarding and the Succession Data Model [page 155]
Related Information
Configuring the Succession Data Model for Pre-Day 1 Access [page 156]
Besides other modules, there are integration points that are configured in the data models for some of these
integrated functionalities and features to work as desired.
Parent topic: Dependencies of Succession Data Model Across Modules [page 98]
Related Information
Succession and Development and the Succession Data Model [page 99]
Compensation and Succession Data Model [page 116]
People Profile and the Succession Data Model [page 126]
Recruiting and Succession Data Model [page 127]
Talent Management and the Succession Data Model [page 141]
Employee Central and the Succession Data Model [page 147]
Learning and Succession Data Model [page 154]
Onboarding and the Succession Data Model [page 155]
Context
To configure the My Benefits link for Benefitfocus, carry out the following steps in EC. This also requires access to
Provisioning for the EC company.
Procedure
1. To activate and configure the link to Benefitfocus via jump-to, include the authentication via IdP with BF as the
mapping key.
2. For activation, choose Company Company Settings Enable Employee Central V2 My Benefit Link .
3. Enter the target URL:
5. Download the data model and add the following (if it is not already there):
Sample Code
<tab-element id="ectbenefitsfocus">
<label>My Benefits</label>
<label xml:lang="en-GB">My Benefits</label>
<label xml:lang="de-DE">Meine Vorteile</label>
</tab-element>
6. In Employee Central Admin Tools, choose Configure Employee Files under Employee Files.
11. Under Employee Views, check that the My Benefits entry is visible. Make sure the permission role is assigned to
the relevant users.
Prerequisites
Context
Adding companyExitDate to your data model with the Business Configuration UI allows you to proceed with
setting up the data purge function but it does not enable you to see this field in the employee profile or in the
If you don't have access to the Business Configuration UI, ask Product Support to add the following element to your
data model:
Sample Code
<standard-element id="companyExitDate">
<label>Company Exit Date</label>
</standard-element>
Procedure
If the companyExitDate field is not yet enabled in your system, it is marked with an X. If it is already enabled,
it is marked with a checkmark and you do not need to complete this task.
3. Add a default label in the Label field.
4. If necessary, click the localization icon to open a dialog and add labels in other languages in your system.
5. Set the Enabled setting to Yes.
6. Click Save to save your change.
Next Steps
To complete the minimum prerequisite steps so that you can proceed to set up the DRTM data purge function,
proceed to configure the required sync between your HRIS and the SAP SuccessFactors platform. If you use
Employee Central, you can do this with the Business Configuration UI. If you need to import these dates frosm an
external HRIS, please contact Product Support.
In order to have workflows work in your instance, there are elements that are needed in both Succession Data
Model and Corporate Data Model. These elements already exist in the XML files of your data model.
Check that the foundation object for workflow has been created as well as the following HRIS elements exist in your
Corporate Data Model
<hris-element id=”wfConfig”>
</hris-element>
<hris-element id=”wfConfigStep”>
</hris-element>
<hris-element id=”wfStepApprover”>
Check that the pending approvals tab has been created in your Succession Data Model:
<tab-element id=”pendingapprovals”>
<label>Pending Requests</label>
</tab-element>
Related Information
Setting Up the Succession Data Model for Master Data Replication [page 168]
In Provisioning, you must prepare the Succession Data Model for master data replication.
In Provisioning, you must prepare the Corporate Data Model for master data replication.
Prerequisites
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Caution
The choices under Succesion Management have similar names. Ensure that your selection is correct.
2. Determine the length restrictions of the foundation object ID as shown in the following table:
Cost Center 20 ≤ 10
Job Classification 10 ≤2
Pay Group 4 ≤2
Pay Component 10 ≤4
Frequency 32
Next Steps
Read Master Data Replication Information in the Employee Central Payroll using Point-to-Point Integration guide to
set up the Corporate Data Model with picklists. A picklist is a configurable set of options from which a user can
make a selection, typically in a dropdown menu or smart search list. You can define the picklists used in your
system to limit the values a user can enter, preventing them from entering an invalid value. If the picklists match the
code lists in the Implementing Employee Central Payroll guide, you can also avoid additional mapping efforts.
Task overview: Setting up the Data Models for Employee Central Payroll [page 166]
Related Information
Setting Up the Succession Data Model for Master Data Replication [page 168]
Setting Up the Country-Specific Succession Data Model [page 169]
Setting Up the HRIS Propagation Configuration XML [page 170]
In Provisioning, you must prepare the Succession Data Model for master data replication.
Prerequisites
Remember
As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.
Procedure
Caution
The choices under Succession Management have similar names. Ensure that your selection is correct.
Birth-Name Yes
Note
firstDateWorked is only needed for
legal reporting for the US. It isn’t
relevant for master data replication
or payroll processing.
employment-Type Yes
Next Steps
Read the Master Data Replication Information section to set up the Corporate Data Model with picklists. A picklist is
a configurable set of options from which a user can make a selection, typically in a dropdown menu or smart search
list. You can define the picklists used in your system to limit the values a user can enter, preventing them from
entering an invalid value. If the picklists match the code lists in the Implementing Employee Central Payroll guide,
you can also avoid additional mapping efforts.
Task overview: Setting up the Data Models for Employee Central Payroll [page 166]
Related Information
Enhance the Country-Specific Succession Data Model to correspond to fields that are needed for Employee Central
Payroll.
Procedure
1. Under Succession Management, choose Import/Export Country Specific XML for Succession Data Model.
Caution
The choices under Succesion Management have similar names. Ensure that your selection is correct.
payScaleType
payScaleArea
payScaleLevel
payScaleGroup
Task overview: Setting up the Data Models for Employee Central Payroll [page 166]
Related Information
Procedure
● To enable country-specific value help for payScaleArea, payScaleType, payScaleGroup, and payScaleLevel you
need to update the HRIS Propagation XML file.
For more information, see the Uploading Picklists for Pay Scale Area and Pay Scale Type in the Employee Central
Payroll guide and Step 4 Updating HRIS Propagation XML of the section Setting up country-specific picklists in
the Implementing Employee Central Core guide under Setting up the Succession Data Model.
Task overview: Setting up the Data Models for Employee Central Payroll [page 166]
Related Information
Setting up country/region-specific data models allows you to have fields only needed for that country/region as
well as have fields in specific formats, for example, date or monetary amounts.
Certain types of information need to be entered in a specific format depending on the country/region the company
is located in. For example, the format for national ID can vary depending on the country/region – for USA, the social
security number follows the format 999-99-9999, in Great Britain the format is AA999999A.
Context
● Change existing fields in the standard XML files You can overwrite labels, change attributes, or delete fields not
needed as with the Corporate or Succession Data Model.
● Add custom fields to contain country/region-specific information
Procedure
1. If the HRIS element the field belongs to isn’t yet included in the data model, copy it over from the Corporate
orSuccession Data Model and insert it under the corresponding country/region. Consider that you can add
country/region-specific fields only to those HRIS elements listed below:
Option Description
Country/ You can only add countr/regiony-specific fields, values, and formats for the following HRIS elements and
region-specific their fields:
Corporate ○ Corporate address (HRIS-element ID: corporateAddress)
Data Model This is the address format used in the location foundation object.
○ jobClassLocal: All fields relevant for jobClassLocal are defined in the country/region-specific
Corporate Data Model.
Country/ You can only add country/region-specific fields, values, and formats for the following HRIS elements and
region-specific their fields:
Succession ○ Job information (HRIS-element ID: jobInfo)
Data Model ○ Employment information (HRIS-element ID: employmentInfo)
○ Compensation information (HRIS-element ID: compInfo)
○ Address information (HRIS-element ID: homeAddress)
○ Global information (HRIS-element ID: globalInfo): All fields relevant for global information are de
fined in the country/region-specific Succession Data Model. This is the country/region-specific ele
ment for the Personal Information.
○ National ID (HRIS-element ID: nationalIdCard)
If you want to make a field from the Succession Data Model country/region-specific, consider the following:
○ If you want to change only the label depending on the country/region, you can copy the field over into the
country/region-specific Succession Data Model and change only the text inside the label tags.
○ If you want to change attributes of the field depending on the country/region, you have to delete the field
from the Succession Data Model as you can use the field and its attributes only once — either in the
Succession Data Model, or in the country/region-specific Succession Data Model. This doesn’t apply to
fields from the HRIS element homeAddress — these can be used in both data models with different
attributes.
6. Adjust the label and attributes according to your country/region-specific needs.
With the attribute display-order-follows you can influence the field order of the country/region-specific
field on the UI.
7. If this field is to be used in other countries, insert the corresponding HRIS element and HRIS field under the
corresponding country/region ID.
Note
For fields from the country/region-specific Succession Data Model that belong to jobInfo,
employmentInfo, compInfo or nationalIdCard, it’s important to remember that if you reuse a
country/region-specific field across several countries, you can only change the label but must keep the
same attributes for all the fields (visibility, required, and so on).
8. Repeat the steps for all fields you want to make country/region-specific.
Country/Region-specific fields are needed, for example, for address or national IDs.
In this example, you define that if the employee works for a company that is located in the United States. The field
EEO Job Group that is used to identify the equal employment opportunity (EEO) class of the employee is displayed
in the job information. The 3-letter code for the country/region is the ISO code. The ID for the HRIS element is the
<country id=”USA”>
<hris-element id=”jobInfo”>
<label>Job Information</label>
<hris-field max-length=”256” id=”eeo-class” visibility=”both”
required=”false” pii=”false”>
<label>EEO Job Group</label>
<picklist id=”EEOJOBGROUP_USA” />
</hris-field>
</hris-element>
</country>
In this example, you define that the format for the national ID for USA follows the structure XXX-XX-XXXX. You can
make this the only format allowed if the employee works for a company in the USA. The ID for the format group is
the ID defined in the Succession Data Model for this field. Display format is a hint for the user in which format to
enter the national ID if the entry is not correct. <reg-ex> is the regular expression which is used to validate the
user input.
<country id=”USA”>
<format-group id=”national-id”>
<format id=”ssn”>
<instruction>Social Security Number</instruction>
<display-format>XXX-XX-XXXX</display-format>
<reg-ex>[\d]{3}-[\d]{2}-[\d]{4}</reg-ex>
</format>
</format-group>
</country>
Your instance follows the field order for elements as defined in the Corporate or Succession Data Model. However,
this order can be changed for the fields defined in the Country/Region-Specific Succession Data Model.
Prerequisites
You’ve downloaded the relevant country/region-specific data model and have it open and ready to edit in your xml
editor.
The order, in which fields are displayed in the UI, is determined by the order they’re listed in the xml files.
The country/region-specific data model only contains fields that vary from country/region to country/region.
Standard fields common across the company instance are defined in the Succession Data Model or the Corporate
Data Model. Fields from the country/region specific data models follow the fields from the Succession Data Model
or Corporate Data Model.
Note
The field order in which you enter the data for country/region-specific elements is only relevant for the HRIS
element homeAddress. Here, the order of the fields you define in the country-specific data model is the order
the fields appear on the UI.
You can change order in which the fields display by including the display-order-follows tag in your country/
region-specific data model xml.
Note
● Start Date always appears on top of the screen as the date when the change is to be effective.
● You can’t change the order of the fields in the Country/Region-Specific Corporate Data Model.
● Change of the order only works in the View and not in the Edit Mode.
Procedure
The field FLSA Status is displayed after the field for the employee-class for USA
Picklists allow you to control what users see when selecting values from a dropdown list. Configure country/region-
specific picklists to make sure that users only see values relevant to their region.
Context
Context
Consider the following extract from the country/region-specific Succession Data Model. In this example, we’ll be
defining country/region-specific values for the fields notice-period and sick-pay-supplement . The extract provided
below is for Germany (country id=”DEU”).
<country id="DEU">
<hris-element id="jobInfo">
<label>Job Information</label>
<hris-field max-length="256" id="country-of-company" visibility="view">
<label>Country</label>
<picklist id="ISOCountryList"/>
</hris-field>
<hris-field max-length="256" id="sick-pay-supplement" visibility="both">
<label>Sick Pay Supplement</label>
<picklist id="SICKPAYSUPP" parent-field-id="country-of-company"/>
</hris-field>
<hris-field max-length="256" id="notice-period" visibility="both">
<label>Notice Period</label>
<picklist id="NOTICEPERI" parent-field-id="country-of-company"/>
</hris-field>
</hris-element>
</country>
○ For the field country-of-company, the picklist id ISOCountryList has been defined.
○ The field country-of-company must be in the same hris-element (that is, block), preferably above the fields
sick-pay-supplement and notice-period.
○ For the field sick-pay-supplement, the picklist SICKPAYSUPP has been defined, whose parent picklist is the
picklist ISOCountryList which is assigned to HRIS field country-of-company. Likewise, for the field
notice-period, the picklist NOTICEPERI has been defined, whose parent picklist is also the picklist
ISOCountryList which is assigned to HRIS field country-of-company. In both cases, the parent-
field-id has to refer to the HRIS-field ID country-of-company.
○ To prevent issues of values in the picklist not cascading correctly, make sure that the code of country-of-
company (or any parent field ID that you are configuring) is at the beginning of the custom string. Also
ensure that both fields are in the same HRIS section.
Context
Procedure
Now that you’ve downloaded the picklist file, modify the picklist file to include the country-specific entries.
Start by noting the OptionId for Germany in the picklist ISOCountryList. You will need this when defining the
entries for the picklist SICKPAYSUPP and NOTICEPERI. In this example, the OptionId is 5949.
Note
OptionId is a system generated code that gets generated when you upload the picklist. Note that the
OptionId column must be left blank, when uploading the CSV file, for the code to be generated.
Upload the modified picklist using the Admin Center Picklist Management option.
Procedure
In this example, we need to set the permission for the Germany specific fields for Sick Pay Supplement and Notice
Period. The Permission Settings page is shown below.
Procedure
Update the propagation business rule. You can also point to the MDF Foundation Objects: Cost Center, Department,
Division, Business Unit, Legal Entity and Legal Entity Local.
In the rule, set up the propagation from company, as defined in the Configure Object Definition page, to country-of-
company in the Succession Data Model.
Procedure
Verify your changes by checking that when the country is set to Germany, you see the following entries displayed
for the Sick Pay Supplement and Notice Periodfields:
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.
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.
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.