Instance Sync: Implementation and Administration

(1)

PUBLIC

Document Version: 2H 2021 – 2022-01-21

Instance Sync: Implementation and Administration

(2)

Content

1 Instance Synchronization . . . . 5

2 Getting Started with Instance Synchronization. . . . 7

3 Instance Sync Artifacts. . . . 8

3.1 Sync Artifact for Career Development Plan Templates. . . .9

3.2 Sync Artifact for Compensation Lookup Table. . . .10

3.3 Sync Artifact for Competencies. . . 10

3.4 Sync Artifact for Data Models. . . .12

Comparing Data Models Between Source and Target. . . .13

3.5 Sync Artifact for Families and Roles. . . 14

3.6 Sync Artifact for Form Label Translations. . . .15

3.7 Sync Artifact for Foundation Objects. . . .16

3.8 Sync Artifact for Goal Management Templates. . . .17

3.9 Sync Artifact for Homepage Tile Configurations. . . .19

3.10 Sync Artifact for Homepage Tile Groups. . . 19

3.11 Sync Artifact for MDF Configuration UI Settings. . . 20

3.12 Sync Artifact for MDF Data. . . .21

3.13 Sync Artifact for MDF Object Definitions. . . .28

Comparing MDF Object Definitions Between Source and Target. . . .29

3.14 Sync Artifact for MDF Rules. . . .30

Examples of Syncing MDF Objects and Rules. . . .32

3.15 Sync Artifact for Performance Management Templates. . . 33

3.16 Sync Artifact for Picklists (Legacy). . . .34

3.17 Sync Artifact for Rating Scales. . . .36

3.18 Sync Artifact for Role-Based Permission Groups. . . 37

3.19 Sync Artifact for Role-Based Permission Roles. . . 38

3.20 Sync Artifact for System Properties. . . .39

3.21 Sync Artifact for Workflows (Route Maps). . . .41

3.22 Sync Artifact for Workflow Groups. . . 42

4 Enabling Instance Synchronization. . . . 43

5 Instance Sync Permissions. . . . 44

5.1 Enabling Role-Based Instance Sync Permissions. . . .44

5.2 Enabling Legacy Instance Sync Permissions. . . .46

6 Consideration for Pairing the Source and Target Instances. . . . 47

(3)

6.1 Defining the Source and Target Instance Pairing. . . 48

7 Pairing the Source and Target Instances. . . . 49

7.1 Generating an Authentication Token from the Source Instance. . . .49

7.2 Copying the Generated Authentication Token from the Target Instance. . . 51

7.3 Adding the Authentication Token in the Source Instance. . . .52

8 Deleting the Pair Between Source and Target Instances. . . .53

9 Setting Up and Running Instance Sync Jobs. . . .55

9.1 Instance Synchronization Wizard. . . .55

9.2 Sync Jobs. . . 55

9.3 Setting Up a Configuration Sync Job. . . 56

9.4 Setting Up a Data Sync Job in Provisioning. . . 59

9.5 Sync Permission and Feature Setting Validation. . . 60

10 Monitoring Instance Sync Jobs. . . . 62

10.1 Instance Synchronization Monitor. . . 62

Searching the Status of a Sync Job. . . .62

Viewing Detailed Results of a Sync Job. . . 63

Downloading a Sync Report Result. . . 64

Viewing a List of Response Codes. . . .65

Understanding Sync Results. . . .65

11 Managing and Reusing Instance Sync Jobs. . . .67

11.1 Rerunning a Sync Job. . . .67

Rerunning a Test Sync. . . 67

Enabling True Sync After a Successful Test. . . .68

11.2 Using Instance Sync Packages. . . .69

Instance Sync Packages. . . .69

12 Appendix: Instance Management. . . . 73

(4)

Change History

Learn about changes to the documentation for configuring and managing Instance Synchronization in recent releases.

2H 2021

Type of Change Description More Info

Changed Configuration sync of the following arti

facts from the source instance to the tar

get instance will be deprecated as of 1H 2022:

1. Rating Scale 2. Route Maps

3. Performance Management Templates 4. Goal Management Templates

Deleted You can no longer sync Dashboard

Settings configurations from one instance to another.

1H 2021

Type of Change Description More Info

Changed We're no longer supporting the syncing of

MDF Picklist artifact from the source in

stance to the target instance.

(5)

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

(6)

Related Information

Instance Sync Artifacts [page 8]

(7)

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.

(8)

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

12. Homepage Tile Configurations, Homepage Tile Groups

(9)

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 This artifact requires SAP SuccessFactors Succession and Development, with Career Develpment and Planning enabled.

Permissions In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Career- Development-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 56]

(10)

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.

Exists At Target Supported. The Instance Synchronization Wizard indicates if the Compensation Lookup Table already exists in the target instance.

Related Information

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 ● 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.

Permissions In order to sync this artifact in the Instance Synchronization Wizard, you must have Sync Competencies permission.

(11)

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

(12)

3.4 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 Product Support.

Permissions In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Data Model permission.

Selection 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)

Overwrite Options This sync will always be an overwrite. Any existing Data Models in the target instance are replaced by ones in the source.

● Picklists

● MDF Picklists

Filter by Last Modified 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.

(13)

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 & 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

Comparing Data Models Between Source and Target [page 13]

3.4.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.

(14)



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.

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.5 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.

(15)

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.

Copy Logic The tool will copy all content within a family and role.

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

3.6 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

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.

(16)

Copy Logic The tool will copy all Form Label Translations.

Filter by Last Modified Not applicable.

Exists At Target Not applicable.

Related Information

3.7 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.



Note

Syncing the Dynamic Role and Position Dynamic Role Foundation Object artifacts is not supported during the blackout period, that is, from Preview to Production environment, or from Production to Preview environment. The blackout period is the time during post Preview release until Produc

tion release. For successful syncing of this artifact, please wait until the Production version is mi

grated 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 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.

(17)

● 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.

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

3.8 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.



Note

Syncing of Goal Management Templates from the source instance to the target instance will be deprecated as of 1H 2022.

(18)

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 by ones in the source.

● Ignore - If selected, existing Goal Management Templates in the target instance are retained and are NOT replaced by ones in from the source.

● Rating Scales, Data Model, Picklists

Copy Logic The tool will copy all settings within the template (xml). The template ID will be sustained.

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

(19)

3.9 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

3.10 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

(20)

3.11 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 by ones in the source.

● Ignore - If selected, existing MDF Configurable UI Settings in the target instance are retained and are NOT replaced by ones in from the source.

Copy Logic The tool will copy all content within the selected MDF Configurable UI's.

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

(21)

3.12 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

abled.

Permissions In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync MDF Data permission.

(22)

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

(23)

● 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

(24)

● 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

(25)

● 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

(26)

● 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

(27)

● 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.

● 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.

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

(28)

3.13 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

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

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.

encies before their children.

MDF Object Definitions are dependent on the following other artifacts:

● MDF Rules, MDF Picklists

Copy Logic The tool will copy all content within the selected MDF Object Definitions.

(29)

Exists At Target Supported. The Instance Synchronization Wizard indicates which of the selected MDF Object Defini- tions, if any, already exists in the target instance.

Related Information

3.13.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:

(30)

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.14 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

abled.

(31)

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

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.

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.

Exists At Target Supported. The Instance Synchronization Wizard indicates which of the selected MDF Rules, if any, al

Related Information

(32)

3.14.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.)

(33)

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

3.15 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.



Note

Syncing of Performance Management Templates from the source instance to the target instance will be deprecated as of 1H 2022.

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.

(34)

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.

encies before their children. This configuration artifact is dependent on the following other artifacts:

● Rating Scales, Competencies, Goal Templates, Workflows, Data Model, Picklists

Copy Logic The tool will copy all settings within the template (xml) and settings that have been setup in Admin Center Manage Templates . Any hard-coded goals or competencies are updated with the corre

sponding ID’s.

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

3.16 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.

(35)

Permissions In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync Picklists permission.

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.

Copy Logic 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.

Exists At Target Supported. The Instance Synchronization Wizard indicates which of the selected Picklists, if any, al

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

Replacement of Legacy Picklists Management Tool

(36)

3.17 Sync Artifact for Rating Scales

Certain prerequisites, guidelines, considerations, and permissions apply when syncing the Rating Scales artifact from the source to target instance.



Note

Syncing of Rating Scale configurations from the source instance to the target instance will be deprecated as of 1H 2022.

Details about the Rating Scales Instance Sync Artifact

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.

Copy Logic The tool will copy all content within a rating scale including all translations.

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

(37)

3.18 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.

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.

● MDF Object Definition, MDF Rules, Data Model, Picklists

Copy Logic The tool will copy all of the groups selected.

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.

Related Information

(38)

3.19 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 during the blackout period, that is, from Preview to Production environment, or from Production to Preview environment. The blackout period is the time during post Preview release until Production release. For successful syncing of this arti

fact, please wait until the Production version is migrated to a version similar to the Preview ver

sion.

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.

● RBP Permission Groups, MDF Object Definition, MDF Rules, Data Model, Picklists

Copy Logic The tool will copy all of the roles selected.

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.

(39)

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

Scenarios while Syncing Role-Based Permissions Artifact

3.20 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

Permissions In order to sync this artifact in the Instance Synchronization Wizard, you need to have Sync System Properties permission.

(40)

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.

● Data Privacy Consent Statement Settings

● Test Company Process

● Matrix Grid Report

● Mobile Settings

Overwrite Options This sync will always be an overwrite. Any existing System Properties in the target instance are re

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

(41)

3.21 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.



Note

Syncing of Route Maps from the source instance to the target instance will be deprecated as of 1H 2022.

Details about the Workflows Instance Sync Artifact

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.

● Data Model, Picklists

Copy Logic The tool will copy all content within a route map including all translations.

Exists At Target Supported. The Instance Synchronization Wizard indicates which of the selected Workflows, if any, al

Related Information

(42)

3.22 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.

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

● MDF Picklist

● Picklists

Copy Logic The tool will copy all content within dynamic workflow groups.

Exists At Target Supported. The Instance Synchronization Wizard indicates which of the selected Workflow Groups, if any, already exists in the target instance.