Set up Central and Developer Sandbox
All data in your central will be deleted during the refresh process and the data from your production environment will be brought over to the sandbox. For central sandbox, it is the full configuration and transactional data whereas for Developer sandbox, it is only the metadata from production that is brought over. Your sandbox will be unavailable until the refresh is complete.
After the refresh of a Zuora Central Sandbox tenant, a new snapshot of your scrubbed production data is copied over to your Central Sandbox. Refreshing a Developer Sandbox will copy over all the settings and configuration of your Production environment. Therefore, you must complete a set of tasks to set up the Developer and Central Sandbox tenants to ensure that they work as intended.
These tasks can be grouped into two types:
- Tasks completed in your Zuora tenant.
- Tasks in external systems with inbound Zuora integrations.
Zuora will no longer refresh or reset the previously configured settings in Central Sandbox to prevent overwriting any testing configurations you have enabled. After the initial Central Sandbox refreshes, you will have to configure the following settings once, which will be retained in your Central Sandbox after every refresh.
- Tax Engine Configurations (credentials and endpoints)
- Notifications (callout base URLs, callout credentials and callout definitions)
- Payment Gateway Configurations (credentials and endpoints)
- HPM keys
- SSO configuration preserved for all existing users in Central Sandbox
- Zuora 360 Configurations. For more information, see Zuora 360 and 360+.
Tasks needed in Zuora
The following checklist provides all tasks within Zuora you need to go through one by one to set up your Developer and Central Sandbox tenant:
| Category | Task | Needed for initial copy or refresh? |
|---|---|---|
|
SSO integration |
Reconfigure SSO through submitting a request at Zuora Global Support. See Configure Single Sign-On for Zuora for more information. |
Yes |
|
User management |
Update Zuora user emails, or add QA or Developer users as needed. Note: Upon each refresh, the admin must submit a request at Zuora Global Support to reset the password for admin users. If you are a OneID user, please follow the instructions on the Zuora One ID Central Sndbox and Developer Sandbox refresh page. |
Yes |
| Integrations to external systems |
Update integration endpoints and Zuora API usernames in Zuora: |
Yes |
| Collections | Update API usernames and tokens, and settings for Zuora Collections. | Yes |
| Hosted Payment Pages | Update keys for hosted payment pages. | Yes |
| Notifications and Callouts | Update SMTP Settings. | Yes |
| Billing - Revenue Integration |
If you have the Billing - Revenue Integration enabled, reconfigure the integration through submitting a request at Zuora Global Support:
|
Yes |
| Zuora Workflow |
Review hard-coded callout URLs (not pointed to Production) and reconfigure if necessary, and reconfigure authentication tokens. See Configure the settings of a workflow for more information. The best practice is to use global constants to maintain desired URLS since they are wiped upon refresh from Production. If global constants are configured in the sandbox environment, they persist through subsequent refreshes. |
Yes |
| Reconfigure Liquid templates. | Yes | |
| Custom Object | If you store PII data or external links on custom objects or custom fields, ensure that such data or link is removed or scrubbed. | Yes |
| Bill Run and Payment Run Schedules |
Developer and Central Sandbox refresh will not copy the scheduled Bill Run and Payment Run, so the Bill Run and Payment Run will not work as scheduled after the refresh. |
Yes |
Custom Scrubbing for fields in CSBX
You can manage PIIs and field-level data protection easily with customized scrubbing on custom fields and select standard fields. It helps you protect your PII and other sensitive data from unauthorized access in the sandbox environment. While initiating a Central Sandbox refresh, you can specify the fields that should be considered PII and hidden in a sandbox environment.
By default, there are a set of fields that are considered to hold PII data which are scrubbed. In addition to these fields, custom scrubbing allows you to choose custom fields and select standard fields to be scrubbed.
Custom scrubbing helps you with the following:
- Enhanced field-level data protection
- Better control for you to choose the fields to be scrubbed
- Faster testing cycles with time saved from manual scrubbing of sensitive data from custom fields after CSBX refresh
To configure fields for custom scrubbing:
- Navigate to Platform > Object Manager
- Click to select an existing Custom Object and choose Custom Field
- Click Edit to view the details and toggle on Mark for Scrubbing to enable scrubbing
Any custom field can be marked for scrubbing. Only Account Name, Contact First Name and Last Name can be additionally scrubbed within standard fields - When Mark for Scrubbing is toggled on, you can choose to clear the field or substitute it with a value
- If a new custom field is being created:
- Navigate to the details page > click the
icon to Add New Custom Field. - Add the relevant information
- Turn on the Mark for Scrubbing
- Click Save.
- Navigate to the details page > click the
Scrubbing settings on all custom fields of all data types and the standard fields mentioned (Account Name, Contact First Name, Last Name) will remove or replace field values during the CSBX refresh process when enabled.
Tasks in external systems with inbound Zuora integrations
If you are using any external systems or integrations that call Zuora or receive requests from Zuora, you must reconfigure Zuora credentials or Zuora API endpoints in these external systems or integrations to ensure valid connection.
For example, if you are using Zuora CPQ, you also need to update Zuora endpoints, and API usernames and passwords for Zuora Quotes and Zuora 360 in your Salesforce organization.
Related articles
For more information about Zuora Developer and Central Sandbox, see the following articles: