Skip to main content

Getting started with Zuora Central Sandbox

Zuora

Getting started with Zuora Central Sandbox

Overview

Zuora Central Sandbox combines the capability to copy production data along with production-like performance into a single test environment tenant.  While Zuora Central Sandbox always comes with a snapshot of scrubbed production data, it can also be utilized for a brand new implementation in case the production tenant has no data at that time.  The use cases of Zuora Central Sandbox includes all that of API Sandbox and more. See the following use cases supported by Zuora Central Sandbox.

  • Basic implementation configuration and integration

  • Training

  • Integration testing

  • Regression testing

  • Performance testing (with guidelines)

  • Pre-production testing

  • User acceptance testing 

Zuora Central Sandbox is hosted on a production-like AWS infrastructure, allowing you to test the API response time, the bill runs and payment runs with production-level data loading. It provides a more realistic view of performance than API Sandbox. While the Zuora Central Sandbox is designed for production-level performance, Zuora recommends you to contact Zuora Global Support if you plan to test over a certain amount of volume in a 24 hour period in the Zuora Central Sandbox. See Performance guidelines for the details.

Zuora Central Sandbox vs API Sandbox

  API Sandbox Zuora Central Sandbox
Regression testing Yes Yes
Performance testing (with guidelines) No Yes
Pre-production testing Yes Yes
User acceptance testing  No Yes
Basic implementation configuration and integration Yes Yes
Training Yes Yes
Integration testing Yes Yes

Guidelines on Zuora Central Sandbox environments

General Implementation Guidelines 

See the following general guidelines when working with Zuora Central Sandbox:

  • Limit testing to end-to-end feature testing and start with smaller data sets.

  • Follow the performance guideline. Contact Zuora Global Support if you plan on any activity that exceeds the guidelines in a 24 hour period.

  • Reduce or turn off notifications and callouts. 

Data copy guidelines

You can request for a data copy once every 30 days through the following ways:

  • Request through the Zuora Central Sandbox homepage
  • Submit a request at Zuora Global Support. You must provide the endpoint of your environment when submitting the request.

It takes up to 7 business days to complete the data copy of your environment.

Zuora recommends that you plan ahead for your testing and data copy request. While the data copy for most tenants can be completed in less than 3 business days, it can take a longer time to complete the data copy for large tenants.

Performance guidelines

While the Zuora Central Sandbox is designed for production-level performance, Zuora provides the following guidelines and recommends you to contact Zuora Global Support if you plan to test over the guideline volumes within a 24 hour period.  Note that these guidelines are not the System's limits. Zuora draws up these guidelines to anticipate the increased load of the testing environments.

 

API Sandbox

Production Copy (No longer offered, refer to Zuora Central Sandbox)

Performance Test (No longer offered, refer to Zuora Central Sandbox)

Zuora Central Sandbox **

Bill Runs and Payment Runs

Yes

No more than 1,000 records in 24 hours

Yes

Yes

 

> 10,000 records

> 1,000 records

> 10,000 records

> 25,000 records

Contact Zuora Global Support if you plan to execute bill runs or payment runs that exceed the guidelines within a 24 hour period.

 

API Testing

Yes

No more than 1,000 records in 24 hours

Yes

Yes

 

> 10,000 API calls

> 1,000 API calls

> 1,000 API calls

> 25,000 API calls

Contact Zuora Global Support if you plan to test API calls that exceed the guidelines within a 24 hour period.

 

Data Load Testing

Yes

No more than 1,000 records in 24 hours

Yes

Yes

 

> 250,000 records

> 1,000 records*

> 250,000 records

> 500,000 records**

Contact Zuora Global Support if you plan to load data volumes that exceed these guidelines within a 24 hour period.

 

*Production Copy and enhanced Production Copy Environments are not suitable for any data load testing, and Zuora does not support any data loads over 1,000 records within 24 hours in PCE and ePCE.

**The guidelines for Zuora Central Sandbox should be followed for your Production environment.

Concurrent request limits

Zuora system's concurrent request limits are applicable to all sandboxes and production environments.

Data limitations

The data limitations of every Zuora application or service in the production environment are also applicable to the Zuora Central Sandbox environment. 

Access Zuora Central Sandbox environments

You can access Zuora Central Sandbox environments through the Zuora UI and API. See the base URLs for the application and API.

Username and password

The naming convention of your Zuora Central Sandbox login username is:

<username>_<tenant id>

where <username> is your username of Zuora production environment and the <tenant id> is your Zuora Central Sandbox tenant Id that is sent to you when your Zuora Central Sandbox environment is provisioned. For example, john.doe@zuora.com_10000001.

The tenant id is appended in the username to help identify which Zuora Central Sandbox tenant you are logging into.

Your login password of the Zuora Central Sandbox environment is the same as that of the corresponding production environment.

Initial setup

Make the following configurations upon the first-time login:

  • Refer to Zuora Testing Environments to confirm key attributes that are scrubbed as part of the copy process.

  • Re-configure the integration with external applications (for example, Salesforce, Avalara, Payment Gateways, and so on) as credentials for the external applications are scrubbed for security purposes when your Zuora Central Sandbox environment is provisioned.

  • If you have a Salesforce integration, Zuora 360 Sync in Salesforce must be updated with a new Entity Key and Id representing the new Zuora Central Sandbox tenant.

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

  • 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 will not be inherited to Central Sandbox automatically.

  • Reconfigure tokens that relate Commerce Portal to other apps (for example, Customer Catalog).  Tokens from each source app will be re-generated and must be obtained from that app within the Central Sandbox environment.

  • Within the Collect application, tokens that relate various applications (for example, Workflow, Payment Plans, Notes) must be re-configured.
     
     

Other characteristics

Once the Zuora Central Sandbox is provisioned or when the production data is copied, a full set of the latest production data will be in the Zuora Central Sandbox environment. See the following characteristics of Zuora Central Sandbox environment:

  • The snapshot of the production data is complete up to 1 day prior to the data copy request.  Any data created after the request may not appear in the Zuora Central Sandbox upon data copy completion. The data copy job begins up to 24 hours after you submit the request. 

  • While most production copy processes take 2 - 3 days, your process may take longer if you have a large amount of data. Contact Zuora Global Support if you have questions regarding the data copy process.

  • If your users try to reset their passwords in the Zuora Central Sandbox Environment, they cannot receive the password reset emails automatically because their email addresses are scrubbed. Your administrators must fill in the users' email addresses before they can receive the password reset emails.

  • The Single Sign-On, OAuth credentials, and IP address enforcement must be reconfigured as this information is scrubbed for security.

  • Your customers will not receive notifications from Zuora Central Sandbox as the customers' email addresses are intentionally scrubbed for a test environment.

  • The integration with Salesforce, payment gateways, tax engines, and other external services must be re-configured as the credentials for the external services are scrubbed for security.

  • The values of external keys, Id, or time-stamps in the Zuora Central Sandbox might change from that of the production environment. See the following table for details. Submit a request at Zuora Global Support to check the value changes of keys or Ids that are not listed in the table.

    Table Field Expected Behavior
    All CreatedBy User Id will change in every tenant
    All CreatedDate Persist
    All UpdatedBy User Id will change in every tenant
    All UpdatedDate Persist
    Entity Key Entity number will change for every distinct tenant
    Entity Id Entity Id will change for every distinct tenant
    Account Number Persist
    Account Id Persist
    Product SKU Persist
    Product Id Persist
    ProductRatePlan Id Persist
    ProductRatePlanCharge Id Persist
    Invoice Number Persist
    Invoice Id Persist
    InvoiceItem Id Persist
    InvoiceItemAdjustment Number Persist
    InvoiceItemAdjustment Id Persist
    Payment Number Persist
    Payment Id Persist
    Refund Number Persist
    Refund Id Persist

Support for Zuora Market Place Applications

Zuora Central Sandbox supports the availability and data copy of many features to help you achieve your testing and deployment needs. In addition to the supported Zuora features, Zuora Central Sandbox supports Workflow, Collect, and other Marketplace applications in different levels in terms of feature availability and data copy.

Feature Availability

Feature availability is defined as whether features can be used to create new configurations and data.  For example, if you have Workflow entitled, you can use Zuora Central Sandbox to create and test new Workflows against your production data.  If you have Collect entitled, you can create new Collect configurations and test how it works with your production data.

Data Copy

Data copy is defined as taking a snapshot of your production data, with personally identifiable information (PII or P2I) and sensitive data scrubbed. This means that in addition to being able to test new configurations and new data with the features, you can copy data or configurations from production to the Zuora Central Sandbox, make updates, and test the impact of those changes.

Data copy is supported for your core Zuora production data, such as your Product Catalog, Accounts, Subscriptions, other transactional data, Custom Objects, and Settings.

Feature

Feature Availability

Data Copy

Zuora Billing features

Available

Available

Workflow

Available

Available

Collect

Available

Available

Advanced Payment Manager

Available

Available

Promotion Codes

Available

Available

Commerce Portal

Available

Available

Lockbox

Available

Available

Tax Connectors

Available

No copy required

Developer Tools

Available

No copy required

Analytics Dashboard Configurations

Available

Not supported

All other marketplace applications and connectors

Check with Global Support

Check with Global Support

Limitations

Zuora Central Sandbox supports copying multiple entities from your production environment.  However, if you add an additional entity to your production tenant after a complete copy to your Zuora Central Sandbox, we must provision a brand new Zuora Central Sandbox tenant and make a complete copy to include the newly added entity. Consequently, your Central Sandbox environment will have a new Tenant Id and your usernames will also be changed accordingly. Contact Zuora Global Support for the first time when you want a fresh data copy after adding a new entity to your production environment.