Developer Sandbox guidelines
Review the guidance for using the developer sandbox.
General information and implementation guidelines
-
Zuora Developer Sandbox uses Coordinated Universal Time (UTC) as the system time.
-
Limit testing to end-to-end feature testing and start with smaller data sets.
-
Reduce or turn off notifications and callouts.
-
Contact Zuora Global Support if you plan on any activity that exceeds the guidelines in a 24-hour period.
-
Your customers do not receive notifications from Zuora Developer Sandbox as customer email addresses are intentionally scrubbed for a test environment.
-
Developer Sandbox refresh copies newly created blocks in source environments. Existing blocks in target environments are not overwritten or deleted, ensuring data consistency and allowing you to conduct unique tests within your sandbox environment.
Data copy guidelines
You can request a data copy once every 14 days through the following ways:
-
Request through the Zuora Developer Sandbox homepage.
-
Submit a request to Zuora Global Support. You must provide the endpoint of your environment when submitting the request.
Access Zuora Developer Sandbox environments
You can access Zuora Developer Sandbox environments through the Zuora UI and API.
Username and password
The naming convention of your Zuora Developer Sandbox login username is:
<username>_<tenant id>
<username>
is your username of Zuora production environment, and <tenant id>
is your Zuora Developer Sandbox tenant ID that is sent to you when your Zuora Developer Sandbox environment is provisioned. For example, john.doe@zuora.com_10000001
.
The tenant ID appears in the username to help identify which Zuora Developer Sandbox tenant you are logging into.
Your login password for the Zuora Developer Sandbox environment is the same as that of the corresponding production environment.
Initial setup
After first login, make the following configurations. These initial configurations are retained for every subsequent refresh. To learn what key attributes are scrubbed during a refresh, see Scrubbed data.
-
Reconfigure the integration with external applications (for example, Salesforce, Avalara, any payment gateways, and so on) as credentials for the external applications are scrubbed for security purposes when your Zuora Developer Sandbox environment is provisioned.
-
If you have a Salesforce integration, Zuora 360 in Salesforce must be updated with a new entity key and ID representing the new Zuora Developer Sandbox tenant.
-
Reconfigure all required certificates, as certificates are scrubbed.
-
Reconfigure your APIs, callouts, and schedules in Workflow, as Workflow endpoints and credentials may change.
-
Reconfigure your callouts within Workflow, as callout data may be scrubbed.
-
Developer Sandbox refresh does not copy the scheduled Bill Run and Payment Run, so the Bill Run and Payment Run will not work as scheduled after the refresh.
-
Developer Sandbox refresh does not copy the OAuth 2.0 providers. You can create and manage OAuth 2.0 providers independently across production and developer sandbox environments.
-
Ensure any additional information within Workflows, such as callout endpoints, credentials, and liquid templates are updated as needed.
-
Add new users to Commerce Portal. Note that your users from production are not inherited automatically to Developer Sandbox.
-
Reconfigure tokens that relate Commerce Portal to other apps (for example, Customer Catalog). Tokens from each source app are re-generated and must be obtained from that app within the Developer Sandbox environment.
-
Within the Collections application, tokens related to various applications (for example, Workflow, Payment Plans, Notes) must be reconfigured.
-
Once the Zuora Developer Sandbox is provisioned or the production data is copied, a complete set of the latest production data configuration will be in the Zuora Developer Sandbox environment.
Additional considerations and limitations relating to refresh
-
Refresh wipes out all data, and only the configuration data is copied to the Zuora Central Sandbox developer edition.
-
The following data is scrubbed or reset and must be reconfigured after refresh:
-
The Single Sign-On and IP address enforcement must be reconfigured as this information is scrubbed for security.
-
The integration with Salesforce, payment gateways, tax engines, and other external services must be reconfigured, as the credentials for the external services are scrubbed for security.
-
After a refresh or data copy of Zuora Developer Sandbox, the SMTP server settings are reset. Tenants that use Advanced SMTP or External SMTP are reset to use the default Zuora mail server after the refresh or data copy. All email-related features will work after the reset. If you want to use Advanced SMTP or an External SMTP, you need to reconfigure the SMTP server settings.
-
-
Zuora Developer Sandbox supports copying multiple entities from your production environment, but can only be refreshed at the global level. Refreshing just a single child entity is not supported.
-
When you add an additional entity to your production tenant after a complete copy to your Zuora Developer Sandbox, Zuora must provide a brand new Zuora Developer Sandbox tenant and make a full copy to include the newly added entity. Your Developer Sandbox environment will have a unique Tenant ID, and your usernames will also be changed accordingly. Contact Zuora Global Support the first time you request a fresh data copy after adding a new entity to your production environment.
-
The refresh from Production to Developer Sandbox is limited to every 14 days.
-
Currently, Developer Sandbox only allows the copy of the entire production configuration data and does not allow a selective copy of configuration data.