SAP Knowledge Base Article - Public

2791468 - BizX Instance Refresh Tool & FAQ


  • How to enable the Instance Refresh Tool for my Instance 
  • Setting Permissions for Instance Refresh Tool
  • Accessing the Instance Refresh Tool
  • Pairing the Instances
  • Creating an Instance Refresh Request
  • Monitoring instance refresh Tool 
  • How to handle various refresh status 

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


SAP SuccessFactors HCM Suite


SuccessFactors team will execute pre-qualification criteria check on your pair of instances for enablement of the Instance Refresh self-service tool. If all pre-qualification criteria are met, tool will be enabled, and you will be notified. If your instances do not qualify to enabling the tool, we will proceed with manual refresh process and notify you of the schedule.


How to enable the Instance Refresh Tool for my instance?

Note: The instance refresh tool will be available to all customers on DC4 after a instance refresh upgrade on the 19 of August 2019 an incident will no longer be required to enable the tool. The tool will be made available to instances located in other datacenters through a phased approach - next phase is the 16th of September customers on DC8, DC10, DC15, DC17, DC18, DC19, DC22 will also be enabled for the Tool. We will announce details regarding additional availability as soon as they become available. 

To enable this tool please create a BCP support ticket for refresh under the component LOD-SF-SER-REF. Just like manual refresh requests, you need to specify the source and target instances that you want to refresh and complete the Instance Refresh Form.

The instance refresh Tool does not support cross DC refreshes at this time for example DC2 to DC4 etc.

For more information on requesting instance refresh, see KBA 2088117 - Instance: New Instance Creation, Test Instance, Instance Refresh, Clone - Platform.

If your instances qualify to use the refresh self-service tool, going forward you should be using this tool to refresh your target instances. BCP ticket will guide you through the next steps. If your instances do not qualify to use the tool, we will proceed with the older refresh offering.

How to use the Instance Refresh tool?

Successfactors Application now allows you to create, monitor and cancel the schedule of your refresh requests directly from the admin center in a few easy steps.

Here is a quick video showing how to set up Role base permissions & to schedule the refresh: 

Note: Prerequisite Role Based Permission which must be enabled prior to using the Instance Refresh Tool.

From Role Based Permission navigate to Manage Integration Tools -> Access to OData API Metadata Refresh and Export 
From Role Based Permissions navigate to Metadata Framework -> Admin access to MDF OData API
From Role Based Permissions naviagate to Manage Instance Refresh -> Select All

Warning: Ensure the username/userid you are using to schedule the refresh has less than twenty (20) characters

Media not computed.

NOTE: You can find the overall status of the instance refresh request, under the Refresh Status column reference Monitoring Instance Refresh Monitor Instance Refresh Tool

For more details on the Instance Refresh Tool please refer to the SAP help Document - Instance Refresh Guide

Considerations Pre-Refresh:

  • Make sure to have enough lead time for activities that you wish to perform after refreshing the target instance. We recommend to schedule the request at least 7 days in advance.
  • If you have Onboarding enabled in the TARGET instance, please ensure that the ReportID set for Ad Hoc Reports Export jobs are existing in both the source and target instances. The report ids required are:
    • Onboarding User Sync
    • Onboarding Permission Sync

These report Ids are required as a part of job configuration in Provisioning. For more information on scheduling an Ad Hoc Reports Export job, see KBA 2193439. Ad Hoc reports are included for the HCM Suite product refreshes, hence if the report is only existing in the target instance and not in source, the reports are deleted after refresh.

  • Except for Employee Central and Onboarding, all other audit logs are not copied from the source to target instance post refresh.
  • During blackout period for Preview upgrade - Instance Refresh is unsupported from Higher code release (Preview) to lower code release (Production). The blackout period is the time during post Preview release until Production release - check release schedule on KBA 2521176 - 2019 Release Schedule - SuccessFactors - Product Update
  • If the source instance has (Single Sign-on) SSO setup and target has Non-SSO setup, make sure that a Non-SSO admin account is maintained in the source instance, before refreshing your target instance. This admin account allows you to access the target instance post refresh, by customer or partner.
  • The Destination Settings and Security Center configurations of Integration Center are not copied to the target instance after refresh.

Considerations Post Refresh:

  • As part of the Instance refresh process scheduled jobs will get restored Automatically in the Target Instance eg. Username, Filename, Password.
  • The job owner will also get restored post refresh which means if the job owner no longer exists in the Newly refreshed instance the job will fail with "Invalid job owner".


Instance Refresh Tool Statuses:

For the full list of status for Instance refresh tool and required actions (if any) for each status, please refer to the Admin Guide.

[BETA FEATURE] Data Anonymization for Recruiting Management

You can now mask personally identifiable fields of Recruiting Management in the Source Instance that are copied to Target via the instance refresh Tool. This Feature is only available using the Instance refresh Tool and is an Opt-in which is part of BETA Testing. We do not recommend to use the Feature if under strict timelines see KBA for more details 2827300 - [BETA FEATURE] Data Anonymization for Recruiting Management [Instance Refresh Tool]


Frequently asked questions (FAQs)

Question: What if the refresh status fails or is showing a reverted status?
Answer: If the status of your refresh is showing Failed or Reverted please Please contact SAP Cloud Support with the error log file. To download the log file, click the ellipses button under the Action column for the corresponding refresh request and then click "Download Log". For more details on status of your refresh please review SAP help Link here.

Question: What if the refresh completes with warnings?
Answer: If the status of your refresh shows completed with warning you can still log in to the updated target instance and continue with other scheduled activities and testing. There may be some actions from SAP Cloud Support or customer side. See full list of warning messages and actions on KBA 2812823 - Refresh Status Information - Completed with warning - Full List

Question: You receive the following error: "The application encountered an unknown error". How do i fix the error?
Answer: If you encounter an unknown error when pairing the tool KBA 2789795 - "Instance Refresh / Instance Sync Tool: The Application Encountered an Unknown Error" to resolve the error.

Question: You receive the following error: "Unable to fetch existing requests. Please contact SAP Cloud to run Company Schema Upgrade Job and Company Data Migrate Job from Provisioning, and then refresh the metadata cache. To refresh cache, go to "Admin Center" > "OData API Metadata Refresh And Export" and then click "Refresh".". How do i fix the error?
Answer: If you encounter an this error it is due to missing Role based permission - follow steps in KBA 2819650 - Unable to fetch existing request - Instance Refresh Tool

Question: I receive the Error codes : TENANTREFRESH_MAX_SCHEMA_SIZE_EXCEEDED , Validation failed. How should i proceed?
Answer: If you encounter this error code please submit a Support ticket with LOD-SF-SER-REF and complete attached refresh form to proceed with the manual refresh.

Question: Is this tool available now?
Answer: Yes, if you want to have this enabled please open Support ticket with LOD-SF-SER-REF so they can validate and enable it if all criteria is met.

Question: Not able to view 'Instance Refresh Center'. Is this new functionality available in Q1 release (could see Instance synchronization wizard).
Answer: As it is not GA till now, so To enable instance refresh tool, you need to raise a support ticket see KBA Instance Management

Question: If you schedule a refresh a month ahead, can it be canceled UP To the start of the refresh procedure?
Answer: Yes. it can be canceled before the start of refresh.

Question: Can we make certain sensitive data field scrambled?
Answer: Currently this is not supported by the refresh however Data Scrambling will be introduced in a future release.

Question: Is this tool handling also the Provisioning post-refresh configurations and integrations re-establishment?
Answer: Yes

Question: Can the refresh start on working business hours?
Answer: The refresh will be scheduled at non-working hours. The same time should be displayed there.

Question: Onboarding module is included on the Refresh?
Answer: No, Please submit an incident to the module onboarding to request this type of refresh.

Question: Is LMS available in the Refresh tool?
Answer: LMS will become avaiable as a BETA feature during 1908 (dates TBC). To schedule an LMS Refresh now, please open an incident with LOD-SF-SER and refer to KBA 2165346 - Learning Management System Refresh Process.

Question: Schedule dates will need to take into consideration local time or DC time?
Answer: The date shown in the tool will be converted and shown according to the browser time zone.

Question: Is the refresh scheduled time also shown in the interface besides the selected Refresh scheduled date? So we can see for how late the refresh is scheduled. Especially if there is a down-time of the target instance.
Answer: Yes, the scheduled date will be shown in the Overview page in the tool.

Question:  Can we cancel the refresh.
Answer: Once a refresh is in progress, it can't be canceled.

Question: Can we do e-mail masking?
Answer: The Recruiting Candidate e-mail Addresses and the Employee Profile e-mail Addresses can be masked.

Question: In the validation failed status was the refresh actually done? was it useful? in what kind of scenario system shows this kind of status?
Answer: The refresh is not done, if it is in 'Validation Failed' status. This status might pop up, if the desired space is not available in the system, or if Instance Refresh was disabled in the target instance for some reason.

Question: Are Custom Themes copied from the Source to the Target instance after a refresh?
Answer: Yes. Custom Themes are copied as part of the refresh.

Question: Is it possible to use the Instance Refresh tool for cross-datacenter instances?
Answer: The tool currently does not allow to select a different data center for the target environment.

See Also



Instance Refresh Tool , IRT , Refresh , refresh , clone , Instance refresh, How to enable the instance refresh tool , Instance refresh form , form , Instance Refresh , instance refresh , refresh , Failed , failed refresh , Reverted , reverted refresh , reverted , The application encountered an unknown error , The Application Encountered an Unknown Error , Unable to fetch existing requests , Unable to fetch existing request , Company Schema Upgrade Job . validation failed ,  TENANTREFRESH_MAX_SCHEMA_SIZE_EXCEEDED   , KBA , LOD-SF-SER-REF , Instance Refresh , Problem


SAP SuccessFactors HCM Suite all versions


IRT_BizX_Instance_Refresh Request Form__b1905.docx