PUBLIC
Document Version: 2H 2020 – 2020-10-09
© 2020 SAP SE or an SAP affiliate company. All rights reserved.
Instance Sync: Implementation and Administration
THE BEST RUN
Content
1
Instance Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2
Getting Started with Instance Synchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3
Instance Sync Artifacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.1
Sync Artifact for Career Development Plan Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.2
Sync Artifact for Compensation Lookup Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.3
Sync Artifact for Competencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.4
Sync Artifact for Dashboard Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.5
Sync Artifact for Data Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Comparing Data Models Between Source and Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.6
Sync Artifact for Families and Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.7
Sync Artifact for Form Label Translations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.8
Sync Artifact for Foundation Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
3.9
Sync Artifact for Goal Management Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.10
Sync Artifact for Homepage Tile Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
3.11
Sync Artifact for Homepage Tile Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.12
Sync Artifact for MDF Configuration UI Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.13
Sync Artifact for MDF Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.14
Sync Artifact for MDF Object Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Comparing MDF Object Definitions Between Source and Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.15
Sync Artifact for MDF Picklists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Comparing MDF Picklists Between Source and Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.16
Sync Artifact for MDF Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Examples of Syncing MDF Objects and Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.17
Sync Artifact for Performance Management Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3.18
Sync Artifact for Picklists (Legacy). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.19
Sync Artifact for Rating Scales. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.20
Sync Artifact for Role-Based Permission Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
3.21
Sync Artifact for Role-Based Permission Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.22
Sync Artifact for System Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.23
Sync Artifact for Workflows (Route Maps). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.24
Sync Artifact for Workflow Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4
Enabling Instance Synchronization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
5
Instance Sync Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
5.1
Enabling Role-Based Instance Sync Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2
PUBLIC
Instance Sync: Implementation and Administration
Content
5.2
Enabling Legacy Instance Sync Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
6
Consideration for Pairing the Source and Target Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6.1
Defining the Source and Target Instance Pairing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7
Pairing the Source and Target Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
7.1
Generating an Authentication Token from the Source Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.2
Copying the Generated Authentication Token from the Target Instance. . . . . . . . . . . . . . . . . . . . . . . . . 57
7.3
Adding the Authentication Token in the Source Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
8
Deleting the Pair Between Source and Target Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
9
Setting Up and Running Instance Sync Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
9.1
Instance Synchronization Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
9.2
Sync Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
9.3
Setting Up a Configuration Sync Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
9.4
Setting Up a Data Sync Job in Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
9.5
Sync Permission and Feature Setting Validation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
10
Monitoring Instance Sync Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
10.1
Instance Synchronization Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Searching the Status of a Sync Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Viewing Detailed Results of a Sync Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Downloading a Sync Report Result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Viewing a List of Response Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Understanding Sync Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
11
Managing and Reusing Instance Sync Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
11.1
Rerunning a Sync Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Rerunning a Test Sync. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Enabling True Sync After a Successful Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
11.2
Using Instance Sync Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Instance Sync Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
12
Appendix: Instance Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Instance Sync: Implementation and Administration
Content
PUBLIC
3
What's New in the Configuring and Managing
Instance Synchronization Guide
Provides an overview of the most important updates made to this document in recent releases.
2H 2020
What's New
Description
More Info
If there are any discrepancies between the source
and the target instance, the role sync is success­
ful. However, the instance sync is completed with
warnings. You must manually update the discrep­
ancies in the target tenant.
Sync Artifact for Role-Based
Permission Roles [page 44]
October 09
Added a note to include information on
instance sync enhancements while sync­
ing role-based permissions artifact
Added a note to include information on
You can sync MDF Data artifacts from one tenant
guardrail for MDF objects of MDF Data ar­ to another only if the MDF object has less than
tifact.
50,000 records. You must refine the search filters
to get to specific records.
Setting Up a Configuration Sync
Job [page 62]
Added information on UTC timezone.
The Last Modified Date is displayed in UTC time­
zone.
Instance Sync Artifacts [page
11]
Description
More Info
1H 2020
What's New
April 3
No change
There is no update to this guide in 1H 2020.
Q4 2019
What's New
Description
More Info
November 8
4
PUBLIC
Instance Sync: Implementation and Administration
What's New in the Configuring and Managing Instance Synchronization Guide
What's New
Description
More Info
Option to select synchronization type by
choosing either Configuration or Data ar­
tifacts.
You can now choose between Configuration or
Data artifacts to sync using the Select
Synchronization Type option.
Setting Up a Configuration Sync
Job [page 62]
User name is used instead of user ID to
run a sync after test sync in Instance
Synchronization Monitor Tool.
User name is used instead of user ID to have a
consistent user experience in Instance Synchroni­
zation tool.
Rerunning a Test Sync [page
74]
Enabling True Sync After a Suc­
cessful Test [page 75]
Note added for the system properties
that can’t be synced by Instance Syn­
chronization.
As an expected behavior, Process and Forms from Sync Artifact for System Prop­
Company Process, Manage Security Questions and erties [page 45]
Settings from Password & Login Policy Settings,
and Form Templates from Nominations Setup
can’t be synced to target instance using the tool.
Note added for the unsupported version
Performance Management
Performance Management v12 Acceleration is not
supported for Instance Synchronization.
Sync Artifact for Performance
Management Templates [page
39]
Description
More Info
Q3 2019
What's New
August 9
Added information deleting the pair be­
tween the source and target instances.
You can now delete the pairing between the source Deleting the Pair Between
Source and Target Instances
and target instances so that you can remove un­
[page 59]
wanted target instances that are paired to your
source instance.
Updated the Prerequisite for syncing the
Competencies artifact based on its ver­
sion.
You can now only sync the Competencies artifact if Sync Artifact for Competencies
its version in the source and target instances is
[page 13]
Job Description Manager (JDM V1.0).
Updated the User Name instead of user
ID for validating the sync job.
To set up a configuration sync job, syncing and
copying an Instance Sync package, use the User
Name of the target instance instead of the user ID.
Setting Up a Configuration Sync
Job [page 62]
Syncing an Instance Package
[page 77]
Copying an Instance Sync Pack­
age From Source Instance to
Target Instance [page 78]
Instance Sync: Implementation and Administration
What's New in the Configuring and Managing Instance Synchronization Guide
PUBLIC
5
Q2 2019
What's New
Description
More Info
Updated the navigation path to Instance
Synchronization Wizard.
The navigation path is updated as an enhance­
ment for the admins to view and select either In­
stance Synchronization Wizard or Instance Re­
fresh from the same page
Generating an Authentication
Token from the Source Instance
[page 55]
Copying the Generated Authen­
tication Token from the Target
Instance [page 57]
Adding the Authentication To­
ken in the Source Instance
[page 58]
Setting Up a Configuration Sync
Job [page 62]
Added an appendix topic.
The appendix topic describes the difference be­
tween Instance Synchronization Instance Refresh.
This topic helps you to choose the right tool for
copying configuration and data.
Appendix: Instance Manage­
Added a prerequisite to sync Data Mod­
els
As you can now sync Succession Data Model and
Country Specific Succession Data Model without
the Employee Central feature enablement in the
target instance, a pre-requisite stating that the
feature must be enabled in target instance to sync
only Corporate Data Model and Country Specific
Corporate Data Model is added.
Sync Artifact for Data Models
Added a prerequisite to sync MDF Pick­
lists and Legacy Picklists.
You can now sync picklists (MDF and Legacy) only
when both the source and target instances are ei­
ther migrated to MDF Picklists or have Legacy
Picklists. A pre-requisite is added to convey this
condition.
Sync Artifact for MDF Picklists
Removed the section that has procedure
to pair instances from Provisioning.
As you can now pair instances from Admin Center
and the pairing option from Provisioning is re­
moved for Instance Synchronization, the pairing
from Provisioning section is removed. Only the
pairing of Instance from Admin Center is retained.
Pairing the Source and Target
Added pre-requisite for downloading the
sync job report.
The prerequisite is added as you can now down­
load the sync job report if you have any one of the
permissions from Manage Instance
Synchronization.
Downloading a Sync Report Re­
Updated the Caution for Authentication
token expiry time during pairing process.
The expiry time for authentication token during
Generating an Authentication
pairing process is reduced to 1 hour from 24 hours. Token from the Source Instance
[page 55]
6
PUBLIC
ment [page 80]
[page 15]
[page 33]
Sync Artifact for Picklists (Leg­
acy) [page 40]
Instances [page 55]
sult [page 71]
Instance Sync: Implementation and Administration
What's New in the Configuring and Managing Instance Synchronization Guide
Q1 2019
What's New
Description
More Info
Added information about pairing the tar­
get instance with the source instance us­
ing the Instance Synchronization tool.
You can now pair the target instance with the
source instance from Instance Synchronization
Wizard or &Manage Sync Production). Packages.
The pairing is a one-time task with a
Pairing the Source and Target
Instances [page 55]
Generating an Authentication
Token from the Source Instance
[page 55]
Copying the Generated Authen­
tication Token from the Target
Instance [page 57]
Adding the Authentication To­
ken in the Source Instance
[page 58]
Added a note for pairing permission
Added a note for assigning the Admin access to
MDF OData API permission that is required for
pairing instances.
Enabling Role-Based Instance
Sync Permissions [page 50]
What's New
Description
More Info
Added a caution message to alert you to
take a backup of the target instance data
model.
To prevent unintended data loss and data corrup­ Setting Up a Configuration Sync
tion in the target instance while syncing Data Mod­ Job [page 62]
els, an informational message is displayed in the
Data Model selection page of the Instance Syn­
chronization Wizard. The information message re­
quests you to take a backup of the target instance
data model, before submitting your sync job.
Q4 2018
Setting Up a Configuration Sync
Added a note with information on the val­ To have a successful sync job certain target com­
idation message appearing of the Name
pany permissions and target user role-based per­ Job [page 62]
and Description page
mission must be enabled based on the selected
artifacts in the source instance. If these permis­
sions are not enabled during sync job, they appear
as a list in the validation message of the Name and
Description page.
Updated the list of MDF data objects.
Sync Artifact for MDF Data
Removed LSPD (Legislative Sensitive Personal
[page 24]
Data) configured MDF data objects as these ob­
jects are not supported for syncing in the target in­
stance.
Instance Sync: Implementation and Administration
What's New in the Configuring and Managing Instance Synchronization Guide
PUBLIC
7
1
Instance Synchronization
Instance synchronization is a means of copying the configuration of your multiple SAP SuccessFactors instances.
This enables you to "push" new configurations from one instance to another, such as from your Test instance to
your Production instance.
Instance Synchronization Tools
SAP SuccessFactors provides several Instance Synchronization ("Instance Sync") tools to enable you to copy
configuration settings from one instance to another.
● Use the Instance Synchronization Wizard to set up and run new sync jobs.
● Use the Manage Sync Packages page to view, edit, and run your previously saved sync jobs.
● Use the Instance Synchronization Monitor Tool to monitor sync job status and view sync reports.
Instance sync uses a "push" model, meaning that configuration settings are selectively "pushed" from a designated
source instance into another designated target instances. Configurations cannot be "pulled" into the target from
the source. Instance Sync tools support artifact-level permission control and synchronization across different
datacenters.
You can set up your system to support either one-way and two-way synchronization. In a one-way sync, you choose
one instance as the source and one as the target and only the source can initiate a sync. In a two-way sync, both
instances can be a source as well as a target, allowing them to copy configurations back and forth.
For example, if you have three instances for Development, Test, and Production, your Test instance might be both
the target of sync jobs initiated in Development and the source of sync jobs targeting Production.
To setup Instance Sync tool in your system, enable the tool from Upgrade Center. Once enabled, you will need to
pair the source and target instances. This is a one-time task for initial setup.
You can pair the source and target instances using the Instance Sync tool.
After instance sync setup in your system, you can use the Instance Sync tools to create, run, manage, and monitor
synchronization jobs.
Additional Information
Product Versions
Available in both Enterprise and Professional Edition.
Permission Model
Available with both role-based permissions (RBP) and legacy
permissions
User Interface Version
Available in all supported UI versions.
Configuration Type
Universal
8
PUBLIC
Instance Sync: Implementation and Administration
Instance Synchronization
Related Information
Instance Sync Artifacts [page 11]
Instance Sync: Implementation and Administration
Instance Synchronization
PUBLIC
9
2
Getting Started with Instance
Synchronization
Certain consideration to know before you enable Instance Synchronization tools and set up Instance Sync job.
1. Learn about instance sync features and think about how you want to use them. Some questions to consider
are:
○ Which instance will be a source instance from which you want to copy configurations?
○ Which instance will be a target instance to which configurations can be copied from the source?
○ Which configuration artifacts should be enabled for each source instance? You can selectively enable
instance sync for any or all of the available configuration artifacts.
○ Which users should have sync permission for each type of configuration artifact? You can grant sync
permission separately, to different users or roles, for each type of configuration artifact.
2. Enable Instance Synchronization tool from Upgrade Center.
3. Get the pairing done for the source and target instances in your system.
4. Grant sync permissions to the appropriate users or roles in each source instance. Sync permissions allow
users to set up and run sync jobs for each type of configuration artifact. Again, you can grant sync permission
separately for each type of configuration artifact. For example, one user might have permission to sync Goal
Management Templates, while another person might have permission to sync MDF Picklists and MDF Object
Definitions.
10
PUBLIC
Instance Sync: Implementation and Administration
Getting Started with Instance Synchronization
3
Instance Sync Artifacts
An instance sync artifact represents one type of configuration that you can sync with instance sync tools.
Every sync job or sync package includes one or more sync artifacts. During the set-up of a sync job, you select the
sync artifacts you want to include in the Instance Synchronization Wizard. Each artifact contains a collection of
related configuration settings and has its own separate set-up steps and sync behavior.
Details about each sync artifact may include:
● Prerequisites - Prerequisite features that must be enabled in your system to use the artifact
● Permissions - Permission required to sync the artifact in Instance Synchronization Wizard.
● Selection Options - What you can choose to include in the sync during set-up.
● Overwrite Options - What you want instance sync to do when a selection already exists in the target instance,
overwrite it or ignore it
● Dependencies - Dependencies of the artifact, which should be synced before or at the same time as that
artifact
● Copy Logic - Artifact-specific copy logic to determine exactly what is synced from source to target
● Filter by Last Modified - Filter options available during set-up. Last modified date is displayed in UTC
timezone.
● Exists At Target - Ability to see during set-up if your selections already exist in the target
As a best practice it is recommended to sync the artifacts in the following order:
1. MDF Picklist
2. Data Model
3. Foundation Objects
4. Workflow(Route Maps), Workflow Groups
5. MDF Object Definition
6. MDF Configuration UI
7. MDF rules
8. MDF Data
9. RBP groups
10. RBP roles
11. Rating Scale, System Properties, OBjective template, Form Lable Transaltion, Families and Roles, Goal
Management Templates, Career Development Plan Templates, Compensation Lookup Table, Competencies
Form Templates, Dashboard Settings
12. Homepage Tile Configurations, Homepage Tile Groups
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
11
3.1
Sync Artifact for Career Development Plan Templates
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Career Development
Plan Templates artifact from the source to target instance.
Details about the Career Development Plan Templates Instance Sync Artifact
Prerequisites
Permissions
This artifact requires SAP SuccessFactors Succession and Development, with Career Develpment and
Planning enabled.
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync CareerDevelopment-Plan Templates permission.
Selection Options
You can select one or more Career Development Plan Templates to include in the sync.

Note
The method for selecting Goal Management and Career Development Plan Templates in the
Instance Synchronization Wizard is different from most artifacts. At the start of the wizard, select
Goal Templates, which includes both of these template types. If you have permission to sync both
of these template types, you can select one or more templates from a list. You can use the Select
Template Type menu to filter the list by type.
Overwrite Options
You can specify what to do when the selected Career Development Plan Templates already exist in the
target instance:
●
Overwrite - If selected, existing Career Development Plan Templates in the target instance are re­
placed by ones in the source.
●
Ignore - If selected, existing Career Development Plan Templates in the target instance are re­
tained and are NOT replaced by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
Rating Scales, Data Model, Picklists.
Copy Logic
The tool will copy all settings within the template (xml). The template ID will be sustained.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Career Development
Plan Templates, if any, already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
12
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.2
Sync Artifact for Compensation Lookup Table
Certain prerequisites, guidelines, considerations, and dependencies apply when syncing the Compensation Lookup
Table artifact from the source to target instance.
Details about the Compensation Lookup Table Instance Sync Artifact
Prerequisites
This artifact requires SAP SuccessFactors Compensation.
Selection Options
You can select the Compensation Lookup Table to include in the sync.
Overwrite Options
You can specify what to do when the Compensation Lookup Table already exists in the target instance:
●
Overwrite - If selected, the existing Compensation Lookup Table in the target instance is replaced
by the one in the source.
●
Ignore - If selected, the existing Compensation Lookup Table in the target instance is retained and
is NOT replaced by the one in from the source.
Dependencies
This artifact does not have any dependencies.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates if the Compensation Lookup Table already
exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.3
Sync Artifact for Competencies
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Competencies artifact
from the source to target instance.
Details about the Competencies Instance Sync Artifact
Prerequisites
Permissions
●
This artifact requires that the Competency Library Management Suite is enabled.
●
Both the source and target instances must have Job Description Manager (JDM V1.0) as their
Competency version.
In order to sync this artifact in the Instance Synchronization Wizard, you must have Sync
Competencies permission.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
13
Selection Options
You can select one or more Competencies to include in the sync, based on library, locale, and compe­
tency name.
Overwrite Options
You can specify what to do when the selected Competencies already exist in the target instance:
●
Overwrite - If selected, existing Competencies in the target instance are replaced by ones in the
source.
●
Ignore - If selected, existing Competencies in the target instance are retained and are NOT re­
placed by ones in from the source.
Dependencies
This artifact doesn’t have any dependencies.
Copy Logic
The tool copies all content within a competency, however, the ID is changed.
Filter by Last Modified
Not supported. You can’t filter this artifact by Last Modified date in the Instance Synchronization
Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Competencies, if any,
already exists in the target instance.
Other Information

Note
Existing competency definition: comparison is done by comparing the GUID + Locale + Library.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.4
Sync Artifact for Dashboard Settings
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Dashboard Settings
artifact from the source to target instance.
Details about the Dashboard Settings Instance Sync Artifact
Prerequisites
This artifact has no prerequisites.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Dashboard
Settings permission.
14
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Selection Options
You can select one or more of the following Dashboard Settings to include in the sync.
●
Report Configuration
●
Portlet Permissions

Note
Support for Dashboards 1.0 was removed in Q4 2017. Instance sync tools do not support Dash­
boards 2.0 at this time.
Overwrite Options
This sync will always be an overwrite. Any existing Dashboard Settings in the target instance are re­
placed by ones in the source.
Dependencies
This artifact does not have any dependencies.
Copy Logic
The tool will copy all content within the selected dashboard settings.
Filter by Last Modified
Not applicable.
Exists At Target
Not applicable.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.5
Sync Artifact for Data Models
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Data Model artifact from
the source to target instance.
Details about the Data Models Instance Sync Artifact
Prerequisites
To sync Corporate Data Model and Country Specific Corporate Data Model, Employee Central
Foundation Object must be enabled from Provisioning in your target instance.

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
SAP Cloud Support.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
15
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Data Model
permission.
Selection Options
Overwrite Options
You can select one or more of the following Data Models to include in the sync:
●
Succession Data Model (all customers)
●
Corporate Data Model (only for SAP SuccessFactors Employee Central)
●
Country Specific Corporate Data Model (only for SAP SuccessFactors Employee Central)
●
Country Specific Succession Data Model (all customers)
This sync will always be an overwrite. Any existing Data Models in the target instance are replaced by
ones in the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
Filter by Last Modified
●
Picklists
●
MDF Picklists
Not supported. You cannot filter this artifact by Last Modified date in the Instance Synchronization
Wizard.
Exists At Target
Not supported.You cannot view which of the selected Data Models, if any, already exists in the target
instance in the Instance Synchronization Wizard.
Other Information
You can compare the selected Data Models present in the target and source instances using a built-in
comparison tool in the Instance Synchronization Wizard. You can use this tool to identify differences
before running your sync job.
The Succession Data Model is an essential part of all SAP SuccessFactors instances and does not
require SAP SuccessFactors Succession and Development.
The Country Specific Succession Data Model is mostly used with SAP SuccessFactors Employee Cen­
tral, but can be used in anyone.
The Corporate Data Model and Country Specific Corporate Data Model are only used with SAP Suc­
cessFactors Employee Central.

Note
If your not using SAP SuccessFactors Employee Central and you want to sync the Country Spe­
cific Succession Data Model, you may encounter errors. For the sync to be successful, you must
have one of the following settings enabled: (1) External Learning User or (2) Manager Transfer for
Employee Profile.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
16
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Comparing Data Models Between Source and Target [page 17]
3.5.1 Comparing Data Models Between Source and Target
Compare data models between source and target instances and downloading the data model XML file for the
source and target instances in the Instance Synchronization Wizard, prior to running your sync, so that you can
identify discrepancies that might cause an error.
Procedure
1. In the Instance Synchronization Wizard, open a sync job that includes the Data Model artifact and proceed
through the wizard to the Data Model screen.
2. Click the Compare button for the data model you want to compare between source and target.
You may only have one data model available to select. Every SAP SuccessFactors instance has at least one data
model, commonly known as the "Succession Data Model" (although it does not require use of SAP
SuccessFactors Succession and Development). If you are using SAP SuccessFactors Employee Central, you
may also have up to three other data models.
 Note
It can take up to two minutes to open the comparison. The time required to generate the data model
comparison varies based on the size of the data models and the number of differences.
3. In the resulting comparison window, you can:
a. Use arrows to scroll up and down the data model.
b. Set the View Type.
○ Aligned view keeps rows with differences aligned
○ Connected view shows a connecting line between rows with differences
c. Set the Collapse Identical toggle switch to On to collapse identical rows and highlight differences.
4. Take note of any differences you identify so that you can decide how to proceed.
5. Optional: Download the source and target data model XML from the link at the bottom of the comparison
window.
You can use the downloaded data models to review legacy permissions and build equivalent role-based
permissions. You can also use the downloaded target XML as a backup in case you wish to revert data model
sync once done.
6. Close the comparison window to return to the wizard.
Next Steps
If you identify any differences, you need to decide how to proceed.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
17
If there is any XML in the target that you wish to retain and that is not present in the source, you should update the
data model in the source before proceeding. If you continue with the sync, the data model in the target will be
overwritten with the data model in the source.
3.6
Sync Artifact for Families and Roles
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Families and Roles
artifact from the source to target instance.
Details about the Families and Roles Instance Sync Artifact
Prerequisites
This artifact has no prerequisites.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Families
and Roles permission.
Selection Options
You can select one or more Families and Roles to include in the sync.
Overwrite Options
You can specify what to do when the selected Families and Roles already exist in the target instance:
●
Overwrite - If selected, existing Families and Roles in the target instance are replaced by ones in
the source.
●
Ignore - If selected, existing Families and Roles in the target instance are retained and are NOT
replaced by ones in from the source.
Dependencies
This artifact does not have any dependencies.
Copy Logic
The tool will copy all content within a family and role.
Filter by Last Modified
Not supported. You cannot filter this artifact by Last Modified date in the Instance Synchronization
Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Families and Roles, if
any, already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
18
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.7
Sync Artifact for Form Label Translations
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Form Label Translations
artifact from the source to target instance.
Details about the Form Label Translations Instance Sync Artifact
Prerequisites
This artifact has no prerequisites.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Form Label
Translation permission.
Selection Options
There is no granular selection for this artifact. All Form Label Translations are included in the sync..
Overwrite Options
You can specify what to do when the selected Form Label Translations already exist in the target in­
stance:
●
Overwrite - If selected, existing Form Label Translations in the target instance are replaced by
ones in the source.
●
Ignore - If selected, existing Form Label Translations in the target instance are retained and are
NOT replaced by ones in from the source.
Dependencies
This artifact does not have any dependencies.
Copy Logic
The tool will copy all Form Label Translations.
Filter by Last Modified
Not applicable.
Exists At Target
Not applicable.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.8
Sync Artifact for Foundation Objects
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Foundation Objects
artifact from the source to target instance.
Details about the Employee Central Foundation Objects in Instance Sync
Prerequisites
This artifact requires SAP SuccessFactors Employee Central.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
19
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Foundation
Objects permission.
Selection Options
You can select one or more Foundation Objects to include in the sync.
Overwrite Options
You can specify what to do when the selected Foundation Objects already exist in the target instance:
●
Overwrite - If selected, existing Foundation Objects in the target instance are replaced by ones in
the source.
●
Ignore - If selected, existing Foundation Objects in the target instance are retained and are NOT
replaced by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
MDF Object Definition, MDF Rules, MDF Picklists, Data Model, Picklists
In addition, each of your selected Foundation Objects may or may not have its own associated de­
pendencies. Please refer to the dependencies shown in the Instance Synchronization Wizard.
Copy Logic
The tool will copy all data within the selected Foundation Object.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Foundation Objects,
if any, already exists in the target instance.
Other Information

Caution
Before synching Foundation Objects, you need to ensure that the data models of the source and
target instances are in sync. Both data models must have the same modules enabled and share
the same data element and dynamic group definitions, or the sync will fail and return the relevant
error code.

Caution
Admin users in the source and target instances should use the same locale. In other words, the
source instance user who performs the sync and the target instance user whose user name is
identified in the Instance Synchronization Wizard should both be using the same locale, or lan­
guage preference setting (such as US English). If these users have a different locale, it can result
in a corruption of Foundation Object Data.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
20
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.9
Sync Artifact for Goal Management Templates
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Goal Management
Templates artifact from the source to target instance.
Details about the Goal Management Templates Instance Sync Artifact
Prerequisites
This artifact requires SAP SuccessFactors Performance and Goals.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Goal
Templates permission.
Selection Options
You can select one or more Goal Management Templates to include in the sync.

Note
The method for selecting Goal Management and Career Development Plan Templates in the
Instance Synchronization Wizard is different from most artifacts. At the start of the wizard, select
Goal Templates, which includes both of these template types. If you have permission to sync both
of these template types, you can select one or more templates from a list. You can use the Select
Template Type menu to filter the list by type.
Overwrite Options
You can specify what to do when the selected Goal Management Templates already exist in the target
instance:
●
Overwrite - If selected, existing Goal Management Templates in the target instance are replaced
●
Ignore - If selected, existing Goal Management Templates in the target instance are retained and
by ones in the source.
are NOT replaced by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
Rating Scales, Data Model, Picklists
Copy Logic
The tool will copy all settings within the template (xml). The template ID will be sustained.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Goal Management
Templates, if any, already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
21
3.10 Sync Artifact for Homepage Tile Configurations
Certain prerequisites and permissions apply when syncing the Homepage Tile Configurations artifact from the
source to target instance.
Details about the Homepage Tile Configurations Instance Sync Artifact
Prerequisites
This artifact is only for the new SAP Fiori-based Home Page.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Homepage
Tile Configurations permission.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.11
Sync Artifact for Homepage Tile Groups
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Homepage Tile Groups
artifact from the source to target instance.
Details about the Homepage Tile Groups Instance Sync Artifact
Prerequisites
This artifact is only for the new SAP Fiori-based Home Page.

Note
Syncing the Homepage Tile Groups artifact is not supported from Production to Preview environ­
ment due to blackout period for Preview upgrade. The blackout period is the time during post Pre­
view release until Production release. For successful syncing of this artifact, please wait until the
Production version is migrated to a version similar to the Preview version.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync RBP
Permission Groups permission.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
22
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.12 Sync Artifact for MDF Configuration UI Settings
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the MDF Configuration UI
artifact from the source to target instance.
Details about the MDF Configurable UI Settings Instance Sync Artifact
Prerequisites
This artifact requires that the Metadata Framework (also known as "MDF" or "Generic Objects") is en­
abled.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync MDF
Configuration UI permission.
Selection Options
You can select one or more MDF Configurable UI Settings to include in the sync.
Overwrite Options
You can specify what to do when the selected MDF Configurable UI Settings already exist in the target
instance:
●
Overwrite - If selected, existing MDF Configurable UI Settings in the target instance are replaced
●
Ignore - If selected, existing MDF Configurable UI Settings in the target instance are retained and
by ones in the source.
are NOT replaced by ones in from the source.
Dependencies
This artifact does not have any dependencies.
Copy Logic
The tool will copy all content within the selected MDF Configurable UI's.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected MDF Configurable UI
Settings, if any, already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
23
3.13 Sync Artifact for MDF Data
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the MDF Data artifact from
the source to target instance.
Details about the MDF Data Instance Sync Artifact
Prerequisites
This artifact requires that the Metadata Framework (also known as "MDF" or "Generic Objects") is en­
abled.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync MDF Data
permission.
24
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Selection Options
You can select one or more MDF Data to include in the sync.

Note
Due to ongoing technical changes, the sync of data in certain MDF objects is temporarily unavaila­
ble in instance sync tools.
●
Absence Counting Method
●
Accrual Calculation Base Parameters
●
Accrual Lookup By Seniority
●
Accrual Rule Parameters
●
Accrual Rule Variables
●
Accrual Transfer Rule Parameters
●
ActionSearchEntity
●
ActivityListObject
●
Alert Message
●
Auto Delegate Config
●
Background
●
Background Element
●
BackgroundV2
●
Bank
●
BEMigrationPhase
●
BestPracticesConfigurationScopeStatus
●
BestPracticesUpgradeItemStatus
●
BudgetGroup
●
Business Unit
●
Check Result
●
CloudExtension
●
CloudExtensionEnvironment
●
Compound Employee API Object Types
●
Contingent Workers Email Notification Configuration
●
Cost Center
●
Country
●
Country Specific Validation Configuration
●
CreateDefinition
●
Currency
●
Currency Conversion(Deprecated. Replaced by Currency Exchange Rate")
●
Currency Exchange Rate
●
Custom Filter
●
Customized Pay Type
●
Data Replication Configuration
●
Data Replication Proxy
●
Data Retention Time Management Group
●
DataDictionary
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
25
26
PUBLIC
●
DataRetentionGroup
●
Default Portlets
●
Department
●
Division
●
Document Generation Group
●
Document Generation Screen Look Up
●
Document Generation Template
●
Document Mapping Rule Result
●
DRTM 360 Reviews
●
DRTM Audit Data Purge
●
DRTM Benefits Purge Objects
●
DRTM Candidate Profile
●
DRTM Employee Profile
●
DRTM Employment Info Purge Objects
●
DRTM Job Application
●
DRTM Learning Data Purge
●
DRTM Master Data
●
DRTM MDF Custom Purge Objects
●
DRTM Objective Management
●
DRTM Onboarding Candidate Info
●
DRTM Payroll Results
●
DRTM Performance Reviews
●
DRTM Person Info Purge Objects
●
DRTM Time Info Purge Object
●
DRTM Workflow Purge Objects
●
DRTMPurgeStatus
●
Dynamic Group Filters
●
ECDataRetentionConfig
●
ECHelp
●
Element Type Map for EC Migration
●
Email Settings for Document Generation Template
●
Employee Data Replication Confirmation
●
Employee Data Replication Notification
●
Employee Data Replication Status
●
Employee Payroll Run Results
●
Employee Profile Standard
●
Employee Profile User Info
●
EmployeeProfilePageConfig
●
Escalation
●
EscalationConfig
●
Field Display Format
●
Format Group
Instance Sync: Implementation and Administration
Instance Sync Artifacts
●
FoTranslation
●
Function
●
Global Assignment Configuration
●
GOParentObject
●
Hire Date Correction
●
Hire/Rehire Configuration
●
Holiday
●
Holiday Calendar
●
Hris Action
●
HRIS Element
●
HrisServiceLayer Logger Configuration
●
InformationDataSubjectConfigurationTemplate
●
InformationDataSubjectPurposeConfiguration
●
InformationDataSubjectRequest
●
InformationDataSubjectResult
●
Initial Accrual Transfer Date Rule Parameters
●
Initiative Group
●
InitiativeAlignmentBean
●
InitiativeGroupAlignmentBean
●
InitiativeGroupAssignmentBean
●
InitiativeGroupShareBean
●
IntegrationProcessConnection
●
IntegrationProcessCustomFields
●
IntegrationProcessDefinition
●
IntegrationProcessFilterCriteria
●
IntegrationProcessKeypairs
●
IntegrationProcessKnownHostKeys
●
IntegrationProcessOAuthSettings
●
IntegrationProcessOutputFields
●
IntegrationProcessX509Keypairs
●
Interim Account Update Rule Parameters
●
Job Classification
●
Job Function
●
JobAnalyzerReportingData
●
JSONMeta
●
Leave of absence event parameter
●
Legal Entity
●
Legislatively Sensitive Data Configuration
●
LightRule
●
LinkedInMappingConfig
●
Localized HRIS Element
●
Localized Person Configuration
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
27
28
PUBLIC
●
Log Appender Configuration
●
Log Filter
●
Logger Configuration
●
Lookup
●
MappingField
●
Mass Change Run
●
MassChangeDefinition
●
MDF Picklist to Legacy Picklist Map
●
MDFAccessPeriodCriteriaMap
●
MDFAlertType
●
MDFAPISubVersionMigrateResult
●
MDFBadgeTemplate
●
MDFBlockConfig
●
MDFCustomEntitiesWithMultipleParentsRegistry
●
Message Definition
●
Name Format
●
NotificationRegistryGO
●
NotificationRegistryV2GO
●
NotificationTemplateMapGO
●
Number Format
●
OBITenantConfig
●
ObjDefDependencyIndex
●
Object Configuration
●
Object Permission Map
●
ObjectDefinitionStatus
●
Off Cycle Event Batch
●
Onboarding Equipment Type
●
OnboardingCandidateInfo
●
OnboardingImportPath
●
Optimistic Locking Configuration
●
Pay Calendar
●
Pay Group
●
Pay Scale Area
●
Pay Scale Group
●
Pay Scale Level
●
Pay Scale Pay Increase Run
●
Pay Scale Type
●
Payment Method
●
Payroll System Configuration
●
Period-End Processing Rule Parameters
●
Person
●
Person Element Configuration
Instance Sync: Implementation and Administration
Instance Sync Artifacts
●
Personal Information Screen Lookup
●
PersonBackground
●
PersonType
●
PersonTypeUsage
●
Planned Working Time Parameters
●
Position Type
●
Recruiting External Vendor
●
Recruiting Rules Assignment Configuration
●
Recruiting Vendor Integration Mapping
●
Replication Target System
●
Report Object Configuration Entity
●
Report Schema Configuration Entity
●
RequisitionAssignmentConfiguration
●
Rule Trace
●
RuleScenario
●
RuleTracePersistence
●
SAP System Configuration
●
Script
●
Section
●
SEFEntityEventsMap
●
SEFEvent
●
SEFSubscriberConfiguration
●
Sequence
●
Shift Classification
●
SimpleAddressFormat
●
Tab Element
●
Take Rule Parameters
●
TalentPool
●
Target Criteria Map
●
TenantRefresh
●
Time Account Change Calendar
●
Time Account Summary
●
Time Account Type
●
Time Management Collision Resolution
●
Time Management Configuration
●
Time Management Job Summary
●
Time Management Recalculation Event
●
Time Management Retention Group
●
Time Off Configuration
●
Time Off Rule Constants
●
Time Off Rule Variables
●
Time Profile
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
29
●
Time Type
●
Time Type Collision Grouping
●
Time Zone
●
TimeAccountTypeTransfer
●
TourPath
●
Unit of Measure according to UN/CEFACT Recommendation 20/21
●
Value for Onboarding Equipment Type
●
ValueExpression
●
VendorInfo
●
View Template
●
WageTypeAccumulationConfig
●
Work Schedule Day Model
●
WorkflowEmailConfiguration

Note
Some MDF objects are hidden in instance sync tools to help prevent errors. Non-editable objects
and objects that do not conform to certain technical standards are hidden in the UI. The limita­
tions of these MDF objects result in sync errors so we hide them to prevent you from including
them in your sync job.

Note
You can identify the MDF objects to sync based on the business key in addition to the external
code. The business key appears in the Key1 column for the corresponding MDF object in Instance
Synchronization Wizard only if the business key is defined to the MDF object and has the
externalCode field as Auto Number.
Overwrite Options
This sync will always be an overwrite. Any existing MDF Data in the target instance is replaced by ones
in the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
MDF Object Definition, MDF Rules, MDF Picklist.
In addition, each of your MDF Data object selections may or may not have its own associated depend­
encies. Please refer to the dependencies shown in the Instance Synchronization Wizard.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected MDF Data, if any, al­
ready exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
30
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Instance Sync Artifacts [page 11]
3.14 Sync Artifact for MDF Object Definitions
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the MDF Object Definitions
artifact from the source to target instance.
Details about the MDF Object Instance Sync Artifact
Prerequisites
This artifact requires that the Metadata Framework (also known as "MDF" or "Generic Objects") is en­
abled.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync MDF
Object Definitions permission.
Selection Options
You can select one or more MDF Object Definitions to include in the sync.

Note
Some MDF objects are hidden in instance sync tools to help prevent errors. Non-editable objects
and objects that do not conform to certain technical standards are hidden in the UI. The limita­
tions of these MDF objects result in sync errors so we hide them to prevent you from including
them in your sync job.

Note
You can identify the MDF objects to sync based on the business key in addition to the external
code. The business key appears in the Key1 column for the corresponding MDF object in Instance
Synchronization Wizard only if the business key is defined to the MDF object and has the
externalCode field as Auto Number.
Overwrite Options
You can specify what to do when the selected MDF Object Definitions already exist in the target in­
stance:
●
Overwrite - If selected, existing MDF Object Definitions in the target instance are replaced by
ones in the source.
●
Ignore - If selected, existing MDF Object Definitions in the target instance are retained and are
NOT replaced by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children.
MDF Object Definitions are dependent on the following other artifacts:
●
Copy Logic
MDF Rules, MDF Picklists
The tool will copy all content within the selected MDF Object Definitions.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
31
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected MDF Object Definitions, if any, already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.14.1 Comparing MDF Object Definitions Between Source and
Target
Compare MDF Object Definitions between source and target instances in the Instance Synchronization Wizard, prior
to running your sync, so that you can identify discrepancies that might cause an error.
Procedure
1. In the Instance Synchronization Wizard, open a sync job that includes the configuration artifact MDF Object
Definition and proceed through the wizard to the MDF Object Definition screen.
2. Select each MDF object definition you want to compare by clicking the icon in the Compare column.
Selected object definitions are indicated above the search results, below the Compare button, as shown here.
In this example, the BenefitCompanyCar object definition has been selected to compare.
3. Click the Compare button to open the comparison tool in a new window.
4. In the comparison window, you can:
32
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
a. Use expand and collapse icons to view a comparison of each selected object definition.
b. Use the "equal" and "not equal" signs to identify metadata values that are different (indicated with "not
equal" sign) between source and target.
 Note
Due to a known UI issue, the comparison tool currently does not easily identify the exact metadata value
that differs. For each row where a difference is indicated (with the "not equal" sign), you need to scroll
through the columns and visually scan for the differing value. Longer values are truncated, so you may need
to compare them one-by-one in the Detailed View.
5. When you have verified that an object definition is the same in the source and the target instance, select the
checkbox next to the name of the object, in the first column of the comparison tool, so that you can add it to
your sync.
6. To add the MDF object definitions you've selected in the comparison tool to your sync, click Add to Sync.
 Note
This action is only enabled if at least one object definition is selected in the comparison tool.
This closes the comparison tool and returns you to the Instance Synchronization Wizard.
Results
The selected MDF object definitions, which you have confirmed as identical in the comparison tool, are now added
to your sync job.
Next Steps
Proceed with sync job configuration in the Instance Synchronization Wizard.
3.15 Sync Artifact for MDF Picklists
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the MDF Picklists artifact
from the source to target instance.
Details about the MDF Picklists Instance Sync Artifact
Prerequisites
●
This artifact requires that the Metadata Framework (also known as "MDF" or "Generic Objects")
is enabled.
●
Both the source and target instances should have already been migrated to MDF Picklists or
should be having Legacy Picklists.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
33
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync MDF
Picklists permission.
Selection Options
You can select one or more MDF Picklists to include in the sync.

Note
If you use parent-child picklists (also known as cascading picklists), you can view the parent-child
hierarchy in the Instance Synchronization Wizard wizard. With MDF picklists, you can select and
sync any picklist separately, regardless of whether it is a parent or child.

Note
Some MDF objects are hidden in instance sync tools to help prevent errors. Non-editable objects
and objects that do not conform to certain technical standards are hidden in the UI. The limita­
tions of these MDF objects result in sync errors so we hide them to prevent you from including
them in your sync job.

Note
You can identify the MDF objects to sync based on the business key in addition to the external
code. The business key appears in the Key1 column for the corresponding MDF object in Instance
Synchronization Wizard only if the business key is defined to the MDF object and has the
externalCode field as Auto Number.
Overwrite Options
You can specify what to do when the selected MDF Picklists already exist in the target instance:
●
Overwrite - If selected, existing MDF Picklists in the target instance are replaced by ones in the
source.
●
Ignore - If selected, existing MDF Picklists in the target instance are retained and are NOT re­
placed by ones in from the source.
Dependencies
This configuration artifact is not dependent on any other artifacts.
Copy Logic
The tool will copy all content within the selected MDF picklists.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected MDF Picklists, if any,
already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
34
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.15.1 Comparing MDF Picklists Between Source and Target
Compare MDF Picklists between source and target instances in the Instance Synchronization Wizard, prior to
running your sync, so that you can identify discrepancies that might cause an error.
Procedure
1. In the Instance Synchronization Wizard, open a sync job that includes the MDF Picklists artifact and proceed
through the wizard to the MDF Picklists screen.
2. Select each picklist you want to compare by clicking the icon in the Compare column.
Selected picklists are indicated above the search results, below the Compare button, as shown here. In this
example, the JOB-FUNXTION-TYPE picklist has been selected to compare.
3. Click the Compare button to open the comparison tool in a new window.
4. In the comparison window, you can:
a. Use expand and collapse icons to view a comparison of each selected picklist.
b. Use the "equal" and "not equal" signs to identify metadata values that are different (indicated with "not
equal" sign) between source and target.
c. Use the Show Only Diff toggle switch to filter comparison results. Select On to view only rows where there is
a difference between source and target. Select Off to show all rows.
d. Click on any cell in the comparison table to open a Detailed View comparing just that metadata value in the
source and target.
In the following example, the TransportAllowance_US picklist is expanded and you can see that all
metadata values are equal in source and target.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
35
 Note
Due to a known UI issue, the comparison tool currently does not easily identify the exact metadata value
that differs. For each row where a difference is indicated (with the "not equal" sign), you need to scroll
through the columns and visually scan for the differing value. Longer values are truncated, so you may need
to compare them one-by-one in the Detailed View.
5. When you have verified that a picklist is the same in the source and the target instance, select the checkbox in
the comparison tool so that you can add it to your sync..
In the following example, the TransportAllowance_US picklist is selected.
6. To add the picklists you've selected in the comparison tool to your sync, click Add to Sync.
 Note
This action is only enabled if at least one picklist is selected in the comparison tool.
This closes the comparison tool and returns you to the Instance Synchronization Wizard.
Results
The selected picklists, which you have confirmed as identical in the comparison tool, are now added to your sync
job.
Next Steps
Proceed with sync job configuration in the Instance Synchronization Wizard.
36
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.16 Sync Artifact for MDF Rules
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the MDF Rules artifact from
the source to target instance.
Details about the MDF Rules Instance Sync Artifact
Prerequisites
This artifact requires that the Metadata Framework (also known as "MDF" or "Generic Objects") is en­
abled.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync MDF Rule
permission.
Selection Options
You can select one or more MDF Rules to include in the sync.

Note
You can identify the MDF objects to sync based on the business key in addition to the external
code. The business key appears in the Key1 column for the corresponding MDF object in Instance
Synchronization Wizard only if the business key is defined to the MDF object and has the
externalCode field as Auto Number.
Overwrite Options
You can specify what to do when the selected MDF Rules already exist in the target instance:
●
Overwrite - If selected, existing MDF Rules in the target instance are replaced by ones in the
source.
●
Ignore - If selected, existing MDF Rules in the target instance are retained and are NOT replaced
by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children.
MDF Rules are dependent on the following other artifacts:
●
MDF Object Definition, MDF Picklists
Copy Logic
The tool will copy all content within the selected MDF Rules.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected MDF Rules, if any, al­
ready exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
37
3.16.1 Examples of Syncing MDF Objects and Rules
Following are two example use cases showing how to sync MDF Objects and Rules across instances with instance
sync.
User Case 1
Source: an Object definition A with rule 1 & rule 2
Target: No Object definition A, No Rule 1 & Rule 2
Step 1: User performs instance sync by selecting Object Definition A
Rule 1
Rule 2
System behavior in target: Object Definition A associated with Rule 1 and Rule 2 get synced.
Step 2: Modify Rule 1 and perform instance sync by selecting
Rule 1
System behavior in target: Rule 1 gets synced; Object Definition A is also synced because the underlying Rule 1 is
synced.
Step 3: Add new Rule 3 and associate it to Object Definition A in source instance, then perform instance sync by
selecting
Rule 3 (Only)
System behavior in target: Rule 3 gets synced; Object Definition A is also synced and associated with Rule 3
(Because its underlying Rule is synced.)
User Case 2
Source: an Object definition A with rule 1 & rule 2
Target: an Object definition A with Rule 1, No Rule 2
Case 1: If the user performs instance sync by selecting
Object Definition A
Rule 2
System behavior in target: Object Definition A associated with Rule 1 and Rule 2 get synced.
Case 2: If the user performs instance sync by selecting
Object Definition A
System behavior in target: Object Definition A sync will fail (Since can't sync all the rules association. The
information will be indicated in Instance Sync Monitor report.)
38
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Case 3: If the user performs instance sync by selecting
Rule 2
System behavior in target: Rule 2 gets synced; Object Definition A is also synced and associated with Rule 2
(Because its underlying Rule is synced.)
 Note
Important
Before synching MDF artifacts, you need to ensure that the data models of the source and target instances are
in sync. Both data models must have the same modules enabled and share the same data element and
dynamic group definitions, or the sync will fail and return the relevant error code.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.17 Sync Artifact for Performance Management Templates
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Performance
Management Templates artifact from the source to target instance.
Details about the Performance Management Templates Instance Sync Artifact
Prerequisites
This artifact requires SAP SuccessFactors Performance and Goals.

Note
Instance Synchronization is not supported for Performance Management v12 Acceleration.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync
Performance-Management Templates permission.
Selection Options
You can select one or more Performance Management Templates to include in the sync.
Overwrite Options
You can specify what to do when the selected Performance Management Templates already exist in
the target instance:
●
Overwrite - If selected, existing Performance Management Templates in the target instance are
replaced by ones from the source.
●
Ignore - If selected, Performance Management Templates in the target instance are retained and
are NOT replaced by ones from the source.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
39
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This configuration artifact is dependent on the following other artifacts:
●
Copy Logic
Rating Scales, Competencies, Goal Templates, Workflows, Data Model, Picklists
The tool will copy all settings within the template (xml) and settings that have been setup in
Center
Manage Templates
Admin
. Any hard-coded goals or competencies are updated with the corre­
sponding ID’s.
Filter by Last Modified
Not supported. You cannot filter this artifact by Last Modified date in the Instance Synchronization
Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Performance Man­
agement Templates, if any, already exists in the target instance.
Other Information
When making your selection in the Instance Synchronization Wizard, you can see the form template ID,
in both the source and target instance, of each of the available Performance Management Templates.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.18 Sync Artifact for Picklists (Legacy)
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Picklist (not MDF
picklist) artifact from the source to target instance.
Details about the Picklists Instance Sync Artifact
Prerequisites
Both the source and target instances should have already been migrated to MDF Picklists or should be
having Legacy Picklists.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Picklists
permission.
40
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Selection Options
You can select one or more Picklists to include in the sync.

Note
If you use parent-child picklists (also known as cascading picklists), you cannot view or select any
child picklists in the Instance Synchronization Wizard. You can only select parent picklists to and
all associated children will be automatically synced along with the parent.
When making your selection in the Instance Synchronization Wizard, you can see, for each Picklist, the
number of Picklist options in the source and target instance.
Overwrite Options
You can specify what to do when the selected Picklists already exist in the target instance:
●
Overwrite - If selected, existing Picklists in the target instance are replaced by ones in the source.
●
Ignore - If selected, existing Picklists in the target instance are retained and are NOT replaced by
ones in from the source.
Dependencies
Copy Logic
This artifact does not have any dependencies.
The tool will copy all content within a picklist including all translations, however, the OptionID will be
new. The parentOptionId column will be updated to reflect the new OptionID so that cascading pick­
lists will remain intact.
Filter by Last Modified
Not supported. You cannot filter this artifact by Last Modified date in the Instance Synchronization
Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Picklists, if any, al­
ready exists in the target instance.
Other Information

Note
1.
Synching picklists now requires an immutable ID called the "external code". Every option in a
picklist must be assigned a unique external code in order to be successfully synched. Op­
tions which exist in both the source and the target will be updated, not deleted and inserted.
Options which exist in the target but not in the source will not be deleted.
2. Instance sync for the legacy picklist will be deprecated in the upcoming releases. For more
information, refer to the Related Information section.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
Replacement of Legacy Picklists Management Tool
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
41
3.19 Sync Artifact for Rating Scales
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Rating Scales artifact
from the source to target instance.
Details about the Rating Scales Instance Sync Artifact
Prerequisites
This artifact has no prerequisites.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Rating
Scales permission.
Selection Options
You can select one or more Rating Scales to include in the sync.
Overwrite Options
You can specify what to do when the selected Rating Scales already exist in the target instance:
●
Overwrite - If selected, existing Rating Scales in the target instance are replaced by ones in the
source.
●
Ignore - If selected, existing Rating Scales in the target instance are retained and are NOT re­
placed by ones in from the source.
Dependencies
This artifact does not have any dependencies.
Copy Logic
The tool will copy all content within a rating scale including all translations.
Filter by Last Modified
Not supported. You cannot filter this artifact by Last Modified date in the Instance Synchronization
Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Rating Scales, if any,
already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
42
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
3.20 Sync Artifact for Role-Based Permission Groups
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Role-Based Permission
Groups artifact from the source to target instance.
Details about the Role-Based Permission Groups Instance Sync Artifact
Prerequisites
This artifact requires that Role-Based Permissions (RBP) is enabled.

Note
Syncing the RBP Groups artifact is not supported from Production to Preview environment due to
blackout period for Preview upgrade. The blackout period is the time during post Preview release
until Production release. For successful syncing of this artifact, please wait until the Production
version is migrated to a version similar to the Preview version.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync RBP
Permission Groups permission.
Selection Options
You can select one or more Role-Based Permission Groups to include in the sync.
Overwrite Options
You can specify what to do when the selected Role-Based Permission Groups already exist in the tar­
get instance:
●
Overwrite - If selected, existing Role-Based Permission Groups in the target instance are replaced
by ones in the source.
●
Ignore - If selected, existing Role-Based Permission Groups in the target instance are retained
and are NOT replaced by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
MDF Object Definition, MDF Rules, Data Model, Picklists
Copy Logic
The tool will copy all of the groups selected.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Role-Based Permis­
sion Groups, if any, already exists in the target instance.
Other Information

Note
Instance sync does not support static permission groups at this time. Static permission groups
not listed among the available options in the Instance Synchronization Wizard.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
43
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
3.21 Sync Artifact for Role-Based Permission Roles
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Role-Based Permission
Roles artifact from the source to target instance.
Details about the Role-Based Permission Roles Instance Sync Artifact
Prerequisites
This artifact requires that Role-Based Permissions (RBP) is enabled.

Note
Syncing the RBP Roles artifact is not supported from Production to Preview environment due to
blackout period for Preview upgrade. The blackout period is the time during post Preview release
until Production release. For successful syncing of this artifact, please wait until the Production
version is migrated to a version similar to the Preview version.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync RBP
Permission Roles permission.
Selection Options
You can select one or more Role-Based Permission Roles to include in the sync.
Overwrite Options
You can specify what to do when the selected Role-Based Permission Roles already exist in the target
instance:
●
Overwrite - If selected, existing Role-Based Permission Roles in the target instance are replaced
by ones in the source.
●
Ignore - If selected, existing Role-Based Permission Roles in the target instance are retained and
are NOT replaced by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
RBP Permission Groups, MDF Object Definition, MDF Rules, Data Model, Picklists
Copy Logic
The tool will copy all of the roles selected.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Role-Based Permis­
sion Roles, if any, already exists in the target instance.
44
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Other Information

Note
●
Before synching RBP Roles, you need to ensure that the data models of the source and target
instances are in sync. Both data models must have the same modules enabled and share the
same data element and dynamic group definitions, or the sync will fail and return the relevant
error code.
●
If there are any discrepancies between the source and the target instance, the role sync is
successful. However, the instance sync is completed with warnings. You must manually up­
date the discrepancies in the target tenant. See Related Information to know more details on
each case.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
Scenarios while Syncing Role-Based Permissions Artifact
3.22 Sync Artifact for System Properties
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the System Properties
artifact from the source to target instance.
Details about the System Properties Instance Sync Artifact
Prerequisites
This artifact has no prerequisites.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync System
Properties permission.
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
45
Selection Options
You can select one or more of the following System Properties to include in the sync.
●
Company Process

Note
You will not be able to sync Process and Forms from this system property.
●
Bulletin Board Message Settings
●
Password & Login Policy Settings

Note
You will not be able to sync Manage Security Questions and Settings from this system prop­
erty.
●
Company System and Logo Settings
●
E-Mail Notification Templates Settings
●
Process Guide Setting
●
Text replacement and links
●
Matrix Grid Rating Scales
●
Help Link Settings
●
Retirement Eligibility Settings
●
Company Dictionary
●
Change Engine Configuration
●
Picklist Mappings
●
Succession Settings
●
Nominations Setup

Note
You will not be able to sync Form Templates from this system property.
Overwrite Options
●
Data Privacy Consent Statement Settings
●
Test Company Process
●
Matrix Grid Report
●
Mobile Settings
This sync will always be an overwrite. Any existing System Properties in the target instance are re­
placed by ones in the source.
Dependencies
This artifact does not have any dependencies.
Copy Logic
The tool will copy all content within the selected system property settings.
Filter by Last Modified
Not applicable.
Exists At Target
Not applicable.
Related Information
Setting Up a Configuration Sync Job [page 62]
46
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
Instance Sync Artifacts [page 11]
3.23 Sync Artifact for Workflows (Route Maps)
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Workflows (Route Maps)
artifact from the source to target instance.
Details about the Workflows Instance Sync Artifact
Prerequisites
This artifact has no prerequisites.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Workflows
permission.
Selection Options
You can select one or more Workflows to include in the sync.
Overwrite Options
You can specify what to do when the selected Workflows already exist in the target instance:
●
Overwrite - If selected, existing Workflows in the target instance are replaced by ones in the
source.
●
Ignore - If selected, existing Workflows in the target instance are retained and are NOT replaced
by ones in from the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
Data Model, Picklists
Copy Logic
The tool will copy all content within a route map including all translations.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Workflows, if any, al­
ready exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
Instance Sync: Implementation and Administration
Instance Sync Artifacts
PUBLIC
47
3.24 Sync Artifact for Workflow Groups
Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Workflow Groups
artifact from the source to target instance.
Details about the Workflow Groups Instance Sync Artifact
Prerequisites
This artifact requires SAP SuccessFactors Employee Central.

Note
Syncing the Workflow Groups artifact is not supported from Production to Preview environment
due to blackout period for Preview upgrade. The blackout period is the time during post Preview
release until Production release. For successful syncing of this artifact, please wait until the Pro­
duction version is migrated to a version similar to the Preview version.
Permissions
In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync RBP
Permission Groups permission.
Selection Options
You can select one or more Workflow Groups to include in the sync.
Overwrite Options
You can indicate if you want to overwrite Workflow Groups that already exist in the target instance.
●
Yes - If selected, existing Workflow Groups in the target instance are replaced by ones in the
source.
●
No - If selected, existing Workflow Groups in the target instance are retained and are NOT re­
placed by ones in the source.
Dependencies
To avoid errors, you should always sync dependent artifacts at the same time, or sync parent depend­
encies before their children. This artifact is dependent on the following other artifacts:
●
MDF Picklist
●
Picklists
Copy Logic
The tool will copy all content within dynamic workflow groups.
Filter by Last Modified
Supported. You can filter this artifact by Last Modified date in the Instance Synchronization Wizard.
Exists At Target
Supported. The Instance Synchronization Wizard indicates which of the selected Workflow Groups, if
any, already exists in the target instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync Artifacts [page 11]
48
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Artifacts
4
Enabling Instance Synchronization
You can now enable Instance Synchronization from the Upgrade Center.
Context
The different synchronization tools allow you to sync artifacts between instances as well as manage your instances.
It is important that you enable Instance Synchronization for all the source and the target instances that you want to
manage.
 Caution
Once Instance Sync is enabled, you will not be able to disable it.
Procedure
1. Go to
Admin Center
Upgrade Center .
2. In the Recommended Upgrades panel, look for Instance Synchronization Tool Expert Self Service.
3. Click Learn More & Upgrade Now.
A dialog box appears providing more information about Instance Synchronization. Review the information
before proceeding.
4. Click Upgrade Now to enable Instance Synchronization Wizard.
A dialog box appears requesting confirmation to enable Instance Sync.
5. Click Yes and then click OK.
Results
Once the upgrade is complete, you will see Instance Synchronization Tool Expert Self Service under Completed
Upgrades.
Instance Sync: Implementation and Administration
Enabling Instance Synchronization
PUBLIC
49
5
Instance Sync Permissions
Instance Sync administrator permissions are required to access the Instance Sync tools in the source instance and
to sync artifacts to the target instance. These permissions are set up in Admin Center, using the system permission
tools (either role-based or legacy permissions).
After instance sync has been successfully enabled, three Admin Tools become available in Admin Center of the
source instance:
● Instance Synchronization Wizard
● Instance Synchronization Monitor Tool
● Manage Sync Packages
However, in order to access these tools, you must be granted permission to sync at least one type of artifact
between instances. Any user with permission to sync at least one artifact can access and use all of the Instance
Sync Admin Tools in the source instance.
 Note
Instance Sync permissions are granted on a by-artifact basis. That is, you can grant permission separately for
each type of instance sync artifact enabled in your system. For example, one user might be allowed to sync
Performance and Goals form templates, while another is allowed to sync permission roles and permission
groups. Administrators can only sync artifacts for which they have been granted the appropriate permission.
5.1
Enabling Role-Based Instance Sync Permissions
To access the Instance Sync tools and sync artifacts from the source instance to the target instance, you must have
certain permissions.
Prerequisites
You should be able to manage system permissions in the source instance.
Procedure
1. Go to
Admin Center
Manage Permission Roles
2. Go to
Administrative Permissions
and edit the appropriate administrative role.
Manage Instance Synchronization .
3. Select one or more of the available permissions. (There is one permission for each of the instance sync
configuration artifacts enabled in your instance.)
50
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Permissions
 Note
To pair the target instance with the source instance, you require Admin access to MDF OData API
permission. Go to
Permissions
Administrative Permissions
Metadata Framework
and select
Administrative
Manage Instance Synchronization .
4. Select Done and then Save Changes.
Results
Permission to sync to the selected artifact is granted.
 Note
You can sync only those artifacts to which sync permission is granted.
Instance Sync: Implementation and Administration
Instance Sync Permissions
PUBLIC
51
5.2
Enabling Legacy Instance Sync Permissions
If you are using legacy permissions, you can grant instance sync permissions by completing the following steps.
Prerequisites
Only users with the ability to manage system permission roles can grant instance sync access. If you are able to
manage system permissions in the source instance, you can grant access to the instance sync tools.
Procedure
1. Go to
Admin Center
Administrative Privileges
Manage Instance Synchronization .
2. Select one or more of the available permissions. (There is one permission for each of the instance sync
configuration artifacts enabled in your instance.)
3. Save your changes.
52
PUBLIC
Instance Sync: Implementation and Administration
Instance Sync Permissions
6
Consideration for Pairing the Source and
Target Instances
To pair the source and target instances, you need to complete the following steps.
Procedure
1. Work with your customer to define requirements, including the following:
○ How many source-target sync relationships do you need to set up?
○ Which instances should be the source and the target in each sync relationship?
○ Determine whether the source and target instances are in the same datacenter or different datacenters.
○ Which configuration artifacts should be enabled for each source?
2. Pair the source and target information. For details, see Pairing the Source and Target Instances in Related
Information.
3. Repeat Pairing steps for each sync relationship.
4. Grant sync permission in the source instance to at least one user for at least one configuration artifact type.
This is the bare minimum implementation, enabling at least one customer administrator to access and use
Instance Sync tools. You may also continue working with your customer to set up all of the necessary sync
permissions for every enabled configuration artifact and/or help verify the implementation through testing.
1. Defining the Source and Target Instance Pairing [page 54]
You need to define each target-source relationship separately. That is, you need to set up instance sync
company permissions separately for each target instance, for a specified source.
Related Information
Pairing the Source and Target Instances [page 55]
Instance Sync: Implementation and Administration
Consideration for Pairing the Source and Target Instances
PUBLIC
53
6.1
Defining the Source and Target Instance Pairing
You need to define each target-source relationship separately. That is, you need to set up instance sync company
permissions separately for each target instance, for a specified source.
For example, if the customer has two instances for Test and Production and you want to enable a two-way sync
between them , you need to go through the set up process two separate times, in order to:
1. Set up Test as a source instance that can push configurations to Production
2. Set up Production as a source instance that can push configurations to Test
Or, for example, if the customer has three instances for Development, Test, and Production and you want to set up
a one-way sync between them, you need to go through the set up process two separate times, in order to:
1. Set up Development as a source instance that can push configurations to Test.
2. Set up Test as a source instance that can push configurations to Production.
After you have completed setting up instance sync company permissions, you can proceed to setting up
administrator permissions in each source instance.
Parent topic: Consideration for Pairing the Source and Target Instances [page 53]
54
PUBLIC
Instance Sync: Implementation and Administration
Consideration for Pairing the Source and Target Instances
7
Pairing the Source and Target Instances
Before admins can sync artifacts between source and target instances, instances must be paired. Pairing of the
instances is a one-time task.
1. Generating an Authentication Token from the Source Instance [page 55]
The first step to pair the target instance with the source instance is to initiate an authentication token
generation from the source instance.
2. Copying the Generated Authentication Token from the Target Instance [page 57]
Before complete the pairing process, you must copy the authentication token that you initiated for
generation from the source instance, back to the source instance from the target instance.
3. Adding the Authentication Token in the Source Instance [page 58]
Entering the copied authentication token from the target instance to the source instance, completes the
pairing of target instance with the source instance.
7.1
Generating an Authentication Token from the Source
Instance
The first step to pair the target instance with the source instance is to initiate an authentication token generation
from the source instance.
Prerequisites
● Admin access to MDF OData API permission must be enabled in the source instance.
● Instance Synchronization must be enabled in both the source and target instances.
Context
To copy any artifact using the Instance Synchronization wizard, you must select the target instance details like,
target environment, target data center from the source instance. The target instance details are available for
selection in Instance Synchronization Wizard of the source only when target instance is paired to the source
instance.
Instance Sync: Implementation and Administration
Pairing the Source and Target Instances
PUBLIC
55
Procedure
1. Log in to the source instance.
2. Go to Admin Center.
3. In the Tools Search field, enter Instance Synchronization Wizard. Access the tool by clicking on the
search result.
The Instance Management page appears with the Configuration Copy (Instance Synchronization) option
selected.
4. Click Next.
The Instance Synchronization page appears.
5. Click Launch Instance Synchronization Wizard or go through the Instance Synchronization Wizard tool from the
beginning.
Instance Synchronization Wizard opens.
6. Click Add New Pair.
Instance Pair Wizard opens with the Select Target Details step active on it.
 Note
You can also open the Instance Pair Wizard by navigating to
Packages
Admin Center
Tools
Manage Sync
and clicking Add New Pair.
7. Select the target data center and target environment.
8. Enter the target Company Id.
9. Click Generate Token.
Generate Authentication Token step is active on the Instance Pair Wizard that displays a message on the
procedure to get the authentication token when the token generation is successful.
Results
An authentication token is sent to the target company ID.
 Caution
The generated token is valid only for one hour from the time it has been generated. If the token expires, you
must regenerate the authentication token again.
Task overview: Pairing the Source and Target Instances [page 55]
Next task: Copying the Generated Authentication Token from the Target Instance [page 57]
56
PUBLIC
Instance Sync: Implementation and Administration
Pairing the Source and Target Instances
7.2
Copying the Generated Authentication Token from the
Target Instance
Before complete the pairing process, you must copy the authentication token that you initiated for generation from
the source instance, back to the source instance from the target instance.
Procedure
1. Log in to your target instance.
2. Go to Admin Center.
3. In the Tools Search field, enter Instance Synchronization Wizard. Access the tool by clicking on the
search result.
The Instance Management page appears with the Configuration Copy (Instance Synchronization) option
selected.
4. Click Next.
The Instance Synchronization page appears.
5. Click the radio button that has the name of your source instance company Id, from which authentication token
was generated.
You can also fine the expiry time of the authentication token next the source instance company ID.
6. Click Copy Token.
Results
The authentication token is successfully copied to clipboard.
Task overview: Pairing the Source and Target Instances [page 55]
Previous task: Generating an Authentication Token from the Source Instance [page 55]
Next task: Adding the Authentication Token in the Source Instance [page 58]
Instance Sync: Implementation and Administration
Pairing the Source and Target Instances
PUBLIC
57
7.3
Adding the Authentication Token in the Source Instance
Entering the copied authentication token from the target instance to the source instance, completes the pairing of
target instance with the source instance.
Procedure
1. Log in to the source instance.
2. Go to Admin Center.
3. In the Tools Search field, enter Instance Synchronization Wizard. Access the tool by clicking on the
search result.
The Instance Management page appears with the Configuration Copy (Instance Synchronization) option
selected.
4. Click Next.
The Instance Synchronization page appears.
5. Click Launch Instance Synchronization Wizard or go through the Instance Synchronization Wizard tool from the
beginning.
Instance Synchronization Wizard opens.
6. Click Add New Pair.
Instance Pair Wizard opens with the Select Target Details step active on it.
7. Click the radio button that has the name of your target instance company Id, from which authentication token
was copied.
Get Authentication Token step is active on Instance Pair Wizard.
8. Click the link at the bottom of the Get Authentication Token step.
Enter Authentication Token step is active.
9. Paste the token in the Authentication Token text box.
10. Click Validate and then click Close.
Results
Pairing the target instance with the source instance is successful. You can now find the target instance details in
Instance Synchronization Wizard welcome page to sync the artifacts from your source instance.
Task overview: Pairing the Source and Target Instances [page 55]
Previous task: Copying the Generated Authentication Token from the Target Instance [page 57]
58
PUBLIC
Instance Sync: Implementation and Administration
Pairing the Source and Target Instances
8
Deleting the Pair Between Source and
Target Instances
You can delete the pairing between source and target instances to remove unwanted target instances that are
paired with your source instance.
Prerequisites
You must have any one of the sync permissions.
Procedure
1. Log in to the source instance.
2. Go to Admin Center.
3. Enter Instance Synchronization Wizard in the Tools Search field. Access the tool by clicking on the
search result.
 Note
You can also delete the pairing between source and target instances from the Manage Sync Packages page.
The Instance Management page appears with the Configuration Copy (Instance Synchronization) option
selected.
4. Click Next.
The Instance Synchronization page appears.
5. Click Launch Instance Synchronization Wizard or go through the Instance Synchronization Wizard tool from the
beginning.
Welcome to the Instance Synchronization Wizard opens.
6. Click Delete Existing Instance Pair.
Instance Pair Wizard opens.
7. Click  for the desired instance from the Action column.
8. Click Yes to confirm the deletion of instance pair.
A message confirming the deletion appears.
Instance Sync: Implementation and Administration
Deleting the Pair Between Source and Target Instances
PUBLIC
59
Results
You can't find the target instance in the Instance Synchronization Wizard of the source instance for syncing
artifacts.
60
PUBLIC
Instance Sync: Implementation and Administration
Deleting the Pair Between Source and Target Instances
9
Setting Up and Running Instance Sync
Jobs
9.1
Instance Synchronization Wizard
The Instance Synchronization Wizard enables you to set up, test, and run "sync jobs" that will transfer the selected
configuration artifacts and settings from the source instance to the target instance.
If you have been granted at least one Manage Instance Synchronization permission for at least one configuration
artifact, you can access the Instance Synchronization Wizard in the source instance. To access the wizard, see
Setting Up a Configuration Sync Job in the Related Information section.
 Note
The text of the link you see will vary, depending on which stage of the set-up process you are in. To prevent you
or other administrators from running conflicting sync jobs, only one sync set-up can be in progress at a time. If
there is an incomplete set-up in progress, you are given a choice on the Synchronize Instance Configurations
page to either resume the incomplete set-up or restart the Instance Synchronization Wizard from the beginning.
 Note
Because instance sync uses a "push" model, all configuration sync jobs are set up and run within the source
instance. For this reason, the Instance Synchronization Wizard is only accessible in the source instance.
Related Information
Setting Up a Configuration Sync Job [page 62]
9.2
Sync Jobs
A sync job is a backend process triggered by the Instance Synchronization Wizard.
Sync jobs take time to complete. The Instance Synchronization Wizard does not actually complete the configuration
sync itself, but enables you to set up and initiate a sync job request. The sync job then runs in the background until
it is either completed successfully or results in an error that requires attention.
A sync job can be a true sync, in which configuration settings are transferred from one instance to another, or it can
be a test sync, which simulates the transfer and checks for potential errors. A test sync enables you to troubleshoot
potential errors before any configuration settings are actually transferred from one instance to another. If your test
is successful, you can then run a true sync to copy the selected configuration settings from the source to the
target. As a best practice, you should always run a test sync before running the true sync.
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
PUBLIC
61
You can check the status of submitted sync jobs and view details about each job, using the Instance
Synchronization Monitor Tool.
9.3
Setting Up a Configuration Sync Job
Set up configuration sync job to push the configurations from the source to target instance.
Prerequisites
● To set up a configuration sync job, the source and target instances must be paired.
● The permission to sync the required artifact must be enabled.
● The sync permission for the artifact must be enabled.
Context
An instance sync job can be a test sync or a true sync. A test sync is a simulation that shows you what would
happen when the sync would actually run, but no configurations are transferred to the target instance. A true sync
actually transfers the selected configuration artifacts and settings from the source to the target instance.
You can use the Instance Synchronization Wizard to set up and initiate either a test sync or a true sync. The setup is
the same for either type of sync. At the end of the wizard, you can choose whether you want it to be a test or true
sync. As a best practice, you should always run a test sync first, to check for potential errors.
 Caution
If the sync job has Data Model as an artifact, the Data Model cannot be reverted once it has been synced to the
target instance. Download the target Data Model from the comparing data model page to have a backup of the
artifact and prevent data loss or corruption in the target instance. To download the target Data Model, refer
Comparing Data Models Between Source and Target in related links.
Procedure
1. Login to source instance.
2. Go to Admin Center.
3. In the Tools Search field, enter Instance Synchronization Wizard. Access the tool by clicking on the
search result.
The Instance Management page appears with the Configuration Copy (Instance Synchronization) option
selected.
62
PUBLIC
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
4. Click Next.
The Instance Synchronization page appears.
5. Click Launch Instance Synchronization Wizardgo through the Instance Synchronization Wizard tool from the
beginning or .
Instance Synchronization Wizard opens.
6. Select the target instance datacenter.
 Note
If you do not find any of your target information like Target Datacenter, Target Environment, or Target
Company ID for selection you must pair your target instance with the logged in source instance. Once you
have paired, you can create a sync job. For information on instance pairing, refer the link in the related
information section.
7. Select the target instance environment.
8. orSelect the target instance ID to which you want to push configurations from the source instance. The target
instance ID is the same as your Company ID and must exist in the selected target data center and
environment.
 Remember
Note that this field is case-sensitive.
 Tip
If you have multiple target instances to sync with the source, you can create a reusable "instance sync
package" to save time. The instance sync package allows you to run the same sync job for different
instances without specifying configuration artifacts again.
9. Choose Configuration or Data from Select Synchronization Type.
 Note
Select Sychronization Type is only available when your instance is enabled with data artifacts. This option
helps you to select either data or configuration artifacts separately without creating a dependency with
each other during artifact sync process.
To enable the data artifacts, create a support ticket with the source and target instance information for
Company ID, Data Center, Environment, and a written approval to enable the artifacts in the support ticket.
10. Select the configuration artifacts that you wish to sync, then click Start to proceed with the wizard.
 Note
You can select any number of artifacts. If you select an artifact with dependencies, the dependent artifacts
are indicated. As a best practice, dependent artifacts should be synced together. If you do not have
permission to sync the dependency of a selected artifact, the dependency is indicated in red.
For example, if you select the Data Model artifact, it is indicated that the data model artifact depends on the
Picklists artifact. Therefore, as a best practice, you should sync both data models and picklists together. If
you have permission to sync data models but not picklists, then the dependency on picklists is highlighted
in red.
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
PUBLIC
63
11. If none of the selected artifacts have a dependency on unselected artifacts, you can proceed to the next step. If
a dependency is detected, you are presented with a confirmation dialog and must choose how you want to deal
with the detected dependency.
a. You can choose one of the following options:
○ Select Auto-Select Dependencies to close the dialog and auto-select all dependencies.
○ Select Revise Selections to close the dialog and manually revise your selections.
○ Select Continue As-Is to confirm that you want to proceed without selecting the dependent artifacts.
12. Enter a name and description of the target instance for your sync job. Always remember to provide a name and
description that you can easily identify as this name is used in Instance Synchronization Monitor Tool, Manage
Sync Packages tool, and in status reports. Click Next to proceed.
 Note
If there are any missing features or permissions in the target instance based on the selected artifacts, the
Validation of the Sync Configuration dialog box appears when you click Next. Please enable the features and
permissions for the target instance listed in the Validation of the Sync Configuration dialog box for the sync
job to be successful.
13. Enter the admin user name of the target instance for your sync job in User Name (target instance).
 Note
The user name is only requested the first time you attempt to sync an artifact using the wizard. This name
is provided only once for each artifact.
14. Click Next.
15. Select the configuration settings that you want to include in the job. Each configuration artifact can contain
multiple configuration settings.
For example, for the RBP Permission Groups artifact, you can select which groups you want to sync. Or, for the
System Properties artifact, you can choose to sync only the password and login policy settings. You can select
any number of configuration settings.
 Note
○ For some artifacts, you can sort and filter the available by Last Modified date. This filter helps you
identify settings that have been changed since your last sync.
○ Instance sync tool restricts the retrieval of MDF object records to 50,000. Please refine search filters to
get to specific records.
16. Finally on the Summary page of the wizard, do the following:
a. Review the information on the summary page for accuracy. To make corrections, use the Back button to
return to previous screens.
b. Decide if you want to save your sync job as a "package," for later reuse. If desired, you can save your sync
job by selecting the Save sync bundle as package option on the Summary page of the wizard.
17. To complete the wizard and submit your sync job request, click either Test Sync or Run Sync Now
 Note
○ Test Sync
○ Run Sync Now runs a true instance sync. The selected artifacts and settings are copied to the target
instance. The true sync job request is submitted and sent to the monitoring tool. runs a simulation and
64
PUBLIC
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
shows you what would happen when the sync would actually run. No configurations are transferred to
the target instance. The test sync job request is submitted and sent to the monitoring tool.
Results
If no errors are detected that block the sync, after completing the wizard you are navigated to the Instance
Synchronization Monitor Tool. In the monitoring tool, you can check the status of your sync job request, to confirm
that it was successful or to identify potential errors.
Initially, the status shows as Ready in the monitoring tool, pending completion of the request. Most sync jobs,
including test syncs, take at least a few minutes to complete. The status of these sync jobs is not updated in the
Instance Synchronization Monitor Tool unless the browser is refreshed. Please navigate away from the Instance
Synchronization Monitoring Tool page and check your results later.
If you ran a test sync, no settings are actually transferred. When the test sync job is complete, the status shows as
Test Run Completed and you can view test results.
If you ran a true sync, the status shows as Completed when then sync job is complete. If the sync is successful, the
selected artifacts and settings are now transferred to the target instance.
Related Information
Instance Sync Packages [page 76]
Comparing Data Models Between Source and Target [page 17]
Enabling Role-Based Instance Sync Permissions [page 50]
Enabling Legacy Instance Sync Permissions [page 52]
Pairing the Source and Target Instances [page 55]
9.4
Setting Up a Data Sync Job in Provisioning
Set up data sync job in provisioning, as creating data sync job in Instance Synchronization Wizard is stuck at Ready
status. Contact SAP SuccessFactors or your SAP partner with the Sync ID to complete this procedure.
Prerequisites
To set up data sync job, you need the Sync ID number and the access to Provisioning.
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
PUBLIC
65
 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 SAP Cloud
Support.
Context
To sync data artifacts from the source instance to target instance, the sync job must be set in the provisioning.
Procedure
1. Login to Provisioning for the source instance.
2. In the Managing Job Scheduler section, click Manage Scheduled Jobs.
Manage Scheduled Jobs page appears.
3. Click Create New Job.
Create New Job page appears.
4. Enter a sync job name in the Job Name field.
5. Enter the admin name for the source instance in the Job Owner field.
6. Select Instance Synchronization from the Job Type drop-down list.
The list of available sync jobs appears.
7. Click the Sync ID that you want to sync.
8. Click Create Job.
The new job created appears in Manage Scheduled Jobs page.
9. In the Action column, click
Select
Run It Now , for the corresponding job created.
10. Click Monitor Jobs, to navigate and view the status of the created job.
Results
The status of the sync job changes to In Progress.
66
PUBLIC
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
9.5
Sync Permission and Feature Setting Validation
Instance Sync tools, such as the Instance Synchronization Wizard and Manage Sync Packages tool, will validate
permission and feature settings in the source and target instances before performing a sync. If there are
discrepancies between the instances that need to be resolved, you are alerted before the sync is run.
For each artifact, Instance Sync tools perform three kinds of permission checks:
● Source User Permissions (granted to the logged-in user in the source instance)
● Target User Permissions (granted to the specified admin user in the target instance)
For those artifacts that require certain feature settings, Instance Sync tools check whether these settings are
enabled in Provisioning for both the source and target instances.
For example, imagine that you are setting up a sync containing Data Models and PM Templates. When you try to
run a test sync, you are presented with the following Sync Configuration Validation dialog:
In the dialog, you can see :
● that PM Templates can not be synced between this source instance and its target;
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
PUBLIC
67
● that the feature settings required for syncing Employee Central data models ("Corporate Data Model" and
country-specific data models) are not present in either the source or the target;
● that the feature setting required for syncing PM Templates ("Performance Appraisal Smart Form") IS enabled
in the source (and therefore not listed in the dialgo as an issue to address) but is NOT enabled in the target;
● that the logged-in admin user in the source instance does not have permission to sync Data Models;
● that the specified target admin user in the target instance does not have permission to sync either Data Models
or PM Templates.
All of these issues need to be resolved so that the source and target are aligned before you can proceed with the
sync. Before, in these scenarios, the sync would run and fail. Now, the Instance Sync tools warn you in advance and
do not permit you to run the sync until the required permission and feature settings are in place, in both the source
and target instance.
68
PUBLIC
Instance Sync: Implementation and Administration
Setting Up and Running Instance Sync Jobs
10 Monitoring Instance Sync Jobs
10.1 Instance Synchronization Monitor
You can use the Instance Synchronization Monitor Tool to check the status of submitted sync jobs and to view
details about the job. Job details enable you to track changes to your system and to troubleshoot errors you
encounter.
If you have been granted at least one Manage Instance Synchronization permission for at least one configuration
artifact, you can access the Instance Synchronization Monitor Tool in the source instance. To access the monitoring
tool, go to
Admin Center
Instance Synchronization Monitor Tool .
 Note
Because instance sync uses a "push" model, all configuration sync jobs are set up and run within the source
instance. For this reason, the Instance Synchronization Monitor Tool is only accessible in the source instance.
10.1.1 Searching the Status of a Sync Job
You can use a variety of search filters to find and view the status of your submitted sync jobs. You can view the
status of both test syncs and true syncs. To find a specific sync job, complete the following steps.
Procedure
1. Go to
Admin Center
Instance Synchronization Monitor Tool .
2. Set up search filters. You can search for jobs by submitter ("created by"), submission date, target instance,
sync type (test or actual), sync name, or status.
3. Click Search to apply your filters and view search results.
Instance Sync: Implementation and Administration
Monitoring Instance Sync Jobs
PUBLIC
69
Results
Search results are displayed in the Instance Synchronization Monitor Tool. You can view the current status of each
listed job, along with other basic information, such as the submission date and the user who submitted the job. You
can also link to more detailed results. An example of search results is shown below.
Related Information
Basic Information About Sync Jobs in the Instance Sync Monitor [page 72]
10.1.2 Viewing Detailed Results of a Sync Job
To view detailed results of a specific sync job in the Instance Synchronization Monitor Tool, complete the following
steps.
Procedure
1. Find the sync in search results of the Instance Synchronization Monitor Tool.
2. In the Actions column of search results, click the Details link.
Results
The Sync Details dialog window opens, telling you how many settings were successfully transferred to the target
instance (Add and Update Count) and how many settings failed to sync (Failed Count).
70
PUBLIC
Instance Sync: Implementation and Administration
Monitoring Instance Sync Jobs
10.1.3 Downloading a Sync Report Result
To download a report in CSV format with details about a specific sync job, complete the following steps.
Prerequisites
Alteast one of the artifact sync permission must be enabled.
Procedure
1. Open the Sync Details dialog window in the Instance Synchronization Monitor Tool.
2. Click the Download Report button.
3. A zip file opens, containing the report. You can now save the file to your local machine or network.
Results
The sync report contains the following information:
● User Name (Target Instance)
● Source Company ID
● Target Company ID
● Source Datacenter
● Target Datacenter
● Included sync artifact types and subtypes
● Operations performed
● Response details, such as status, result, and response code for each artifact type and subtype
To help you understand response details, a list of possible response codes is visible in the Instance Synchronization
Monitor Tool.
Related Information
Enabling Role-Based Instance Sync Permissions [page 50]
Enabling Legacy Instance Sync Permissions [page 52]
Instance Sync: Implementation and Administration
Monitoring Instance Sync Jobs
PUBLIC
71
10.1.4 Viewing a List of Response Codes
You can access a complete list of all the response codes used in Sync Reports. You can view the list
Procedure
1. Go to the Instance Synchronization Monitor Tool and click Instance Synchronization Response Codes.
2. View response codes in the dialog window.
 Note
Response codes are listed in two formats, by the newer "message key" format and the legacy format.
Message keys are translatable UI text strings and allow you to view response codes in the same language
that you use the rest of the application. Legacy codes are still listed, for your reference.
3. To download the list in CSV format for future reference, click Download Response Codes. The downloaded file
also contains both response code formats.
10.1.5 Understanding Sync Results
The following information explains how to understand and use the information you find in the Instance
Synchronization Monitor Tool.
This information includes:
● Basic information about of a sync job and its current status
● Detailed information about each sync job, for each artifact included in the sync
● Downloadable instance sync report
● Response codes to help troubleshoot errors
10.1.5.1 Basic Information About Sync Jobs in the Instance
Sync Monitor
Understand each data points shown in the search results of the Instance Synchronization Monitor Tool.
Data Point
Description
Sync ID
ID of the sync job that was run
Name
Name of the sync job, as defined in the Instance
Synchronization Wizard
72
PUBLIC
Instance Sync: Implementation and Administration
Monitoring Instance Sync Jobs
Data Point
Description
Status
Status of the sync request can be one of the following:
●
Queued
●
In Progress
●
Completed (true sync)
●
Test Run Complete (test sync)
Submission Date
Date on which the sync request was submitted by the Instance
Synchronization Wizard
Run Date
Date on which the job was actually run
Actions
You can use the Details link to open detailed results of the sync
job in a dialog window.
Created by
User name of the person who created the request
Target Instance
Company ID of the target instance
Sync Type
Can be one of the following:
Description
Instance Sync: Implementation and Administration
Monitoring Instance Sync Jobs
●
Test Sync
●
Actual Sync
Description of the sync job, as defined in the Instance
Synchronization Wizard
PUBLIC
73
11
Managing and Reusing Instance Sync Jobs
11.1
Rerunning a Sync Job
11.1.1 Rerunning a Test Sync
After viewing details of a test sync, you correct certain errors in your sync job to double check that test results by
rerunning it again. This test sync helps you to run the test again without setting up a new sync job from scratch.
Prerequisites
Submit a test sync while setting up a configuration sync job. For details on Submitting test sync, see Setting Up a
Configuration Sync Job in the Related Information link.
Procedure
1. Log in to the source instance.
2. Go to
Admin Center
Instance Synchronization Monitor Tool .
The Instance Synchronization Monitor Tool page opens.
3. Search the sync job for which you have submitted a test sync.
4. Click Details under the Actions column for required test sync job.
The Sync Details dialog opens with the information on the artifacts that are synced.
5. Click Test Sync.
The Test Mode dialog opens.
6. Enter the user name of the target instance and then click Confirm Test Mode.
Results
A test job is created successfully and you can check the status and download the sync report in Instance
Synchronization Monitor Tool page.
74
PUBLIC
Instance Sync: Implementation and Administration
Managing and Reusing Instance Sync Jobs
Related Information
Setting Up a Configuration Sync Job [page 62]
Downloading a Sync Report Result [page 71]
11.1.2 Enabling True Sync After a Successful Test
After you identify and correct the errors by viewing details of a test sync, you can run a true sync of the same sync
job without creating it from scratch.
Prerequisites
Submit a test sync while setting up a configuration sync job. For details on Submitting test sync, see Setting Up a
Configuration Sync Job in the Related Information link.
Procedure
1. Log in to the source instance.
2. Go to
Admin Center
Instance Synchronization Monitor Tool .
The Instance Synchronization Monitor Tool page opens.
3. Search the sync job for which you have submitted a test sync.
4. Click Details under the Actions column for required test sync job.
The Sync Details dialog opens with the information on the artifacts that are synced.
5. Click Run Sync Now.
The Sync Now dialog opens.
6. Enter the user name of the target instance and then click Confirm Synchronization.
Results
A sync job is created successfully and you can check the status in Instance Synchronization Monitor Tool page.
Related Information
Setting Up a Configuration Sync Job [page 62]
Instance Sync: Implementation and Administration
Managing and Reusing Instance Sync Jobs
PUBLIC
75
11.2
Using Instance Sync Packages
11.2.1 Instance Sync Packages
Instance sync packages are sync jobs that you have set up and saved for easier set up and reuse in the future..
If you have more than two instances, you may often need to perform the same configuration sync multiple times.
You can save a sync job that you have set up in the Configuration Sync Wizard as a reusable "sync package." Sync
packages enable you to replicate identical syncs from your Staging instance to your Test instance, and then from
Test to Production.
For example, imagine that you have three SuccessFactors instances for Staging, Test, and Production. You might
create a new MDF object in your Staging instance that you want to transfer to Test. To do this, you migh need to
sync the configuration settings for MDF Object Definition A, Rule B, and Picklist C into your Test instance for
validation. When the new object has been tested and validated, you would then need to sync the same settings into
your Production instance. To do this, you would create an instance sync package containing all of these settings
(MDF Object Definition A, Rule B, and Picklist C) and use the same package to sync these settings between any of
your instances.
11.2.1.1 Creating an Instance Sync Package
To create an instance sync package in the source instance, complete the following steps.
Procedure
1. Use the Instance Synchronization Wizard to set up your sync job in the source instance.
2. On the summary page, at the end of the wizard, you can use the Save sync bundle as package option to create a
sync package. For convenience, this option is selected by default, but you can de-select it if you do not want to
save the sync as a package.
76
PUBLIC
Instance Sync: Implementation and Administration
Managing and Reusing Instance Sync Jobs
3. Click Run Sync Now or Test Sync to complete the wizard, submit the job, and save package.
Results
The saved package is now accessible on the Manage Sync Packages page.
11.2.1.2 Syncing an Instance Package
You can sync an instance package that has already been created with the required artifacts to sync in your target
instance. You can re-use this package whenever you want a set of pre-defined artifacts to be synced in you target
instace .
Procedure
1. Open the Manage Sync Packages page.
2. Find the package you want to use in the Available Packages list and select it.
 Note
Due to a known theming issue, in some cases the checkbox to select a package may not be visible in the
first column of the Available Packages list. However, you can select the package by clicking in the first
column.
3. In the Available target data centers dropdown list, select the target instance data center.
4. In the Available target environments dropdown list, select the target instance environment.
5. In the Available target instances dropdown list, select the target instance that you want to sync.
6. In the User Name (target instance) field, enter the administrative user name of the target instance.
7. Select the option Sync Package Contents.
8. Click Sync to submit the job.
 Note
If you want to run a test sync, click Test Sync. To clear the settings done above, click Clear.
Results
Settings in the package are synced to the selected target without the need for you to go through the Instance
Synchronization Wizard again from scratch.
Instance Sync: Implementation and Administration
Managing and Reusing Instance Sync Jobs
PUBLIC
77
11.2.1.3 Copying an Instance Sync Package From Source
Instance to Target Instance
You can copy a instance sync package saved in source instance to another target instance.
Procedure
1. Open the Manage Sync Packages page by clicking the link on the first page of the Instance Synchronization
Wizard, or by going to
Admin Center
Company Settings
Manage Sync Packages .
2. Find the package you want to use in the Available Packages list and select it.
 Note
Due to a known theming issue, in some cases the checkbox to select a package may not be visible in the
first column of the Available Packages list. However, you can select the package by clicking in the first
column.
3. In the Available target data centers dropdown list, select the target instance data center.
4. In the Available target environments dropdown list, select the target instance environment.
5. In the Available target instances dropdown list, select the target instance that you want to sync.
6. In the User Name (Target Instance) field, enter the administrative user name of the target instance.
7. Select the option Copy Package.
8. Click Sync to submit the job.
Results
The selected package is now available on the Manage Sync Packages page of the selected target.
11.2.1.4 Editing or Deleting an Instance Sync Package
To edit or delete an existing instance sync package, complete the following steps.
Procedure
1. Open the Manage Sync Packages page.
2. Find the package you want to use in the Available Packages list and select it.
78
PUBLIC
Instance Sync: Implementation and Administration
Managing and Reusing Instance Sync Jobs
 Note
Due to a known theming issue, in some cases the checkbox to select a package may not be visible in the
first column of the Available Packages list. However, you can select the package by clicking in the first
column.
3. Select the Edit icon (pencil) to edit the package using the Instance Synchronization Wizard. Select the Delete
icon (trash can) to delete the package.
Instance Sync: Implementation and Administration
Managing and Reusing Instance Sync Jobs
PUBLIC
79
12
Appendix: Instance Management
To manage your instances correctly, you must identify the right tool for migrating your configurations and data.
There are certain points that help you to identify the difference between the Instance Synchronization and Instance
Refresh tools.
Instance Refresh
Instance Synchronization
Use Instance Refresh when you want to copy all the configurations and data of the source instance in to your target instance
without impacting the integrations in your target.
Use Instance Synchronization when you sync/copy the se­
lected configuration from the source instance to the target in­
stance without changing its data.
When you want to have a periodic copy of the configuration
and data into your test instance
When you want to adopt incremental implementation of con­
figuration or feature.
When you want to refresh configuration and data from produc­
tion (Productive/Live) instance to Preview(Test) instance.
When you want to sync the required configurations from pre­
view to any other instance:
80
PUBLIC
●
Preview (Test1) instance to Preview (Test2) instance
●
Preview (Test) instance to Production (Dev) instance
●
Preview(Test) instance to Production(Productive/Live) in­
stance
Instance Sync: Implementation and Administration
Appendix: Instance Management
Important Disclaimers and Legal Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
●
●
Links with the icon
with SAP) to this:
: 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
●
The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
●
SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
Links with the icon
: You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you
agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.
Videos Hosted on External Platforms
Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the
control or responsibility of SAP.
Beta and Other Experimental Features
Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at
any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the
experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback
(e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and
phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example
code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
Instance Sync: Implementation and Administration
Important Disclaimers and Legal Information
PUBLIC
81
www.sap.com/contactsap
© 2020 SAP SE or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form
or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.
Some software products marketed by SAP SE and its distributors
contain proprietary software components of other software vendors.
National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for
informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.
Please see https://www.sap.com/about/legal/trademark.html for
additional trademark information and notices.
THE BEST RUN