Welcome to Zuora Product Documentation

Explore our rich library of product information

Self-service request for Zuora Revenue sandbox refresh

Learn how to refresh your Zuora Revenue sandbox instances as your business requires.

  • The refresh sandbox request must be submitted from the production instance of Zuora Revenue.

  • Your user role must have appropriate access to the Refresh Sandbox UI based on the user role assignment.

  • Review the Last Refresh Date of the target sandbox to determine whether a refresh request is necessary.

From the Refresh Sandbox user interface in Zuora Revenue, you can:
  • Submit an instant or scheduled sandbox refresh request

  • Monitor the status and progress of the refresh request

  • Review the history of previous refresh request jobs

  • View the snapshot of sandbox instances with the date of the last refresh from the production instances

Note:

Self-serve sandbox refresh does not change the user roles in the sandbox instance. The user roles in the sandbox instance are not overwritten by the roles from the production instance for the same user.

  1. Navigate to Setups > Refresh Sandbox .
  2. Select the target sandbox from the drop-down list.
  3. For Refresh Type, select Now to start an instant refresh or select Schedule to schedule a refresh at a later time.
  4. (Optional): If you selected Refresh Type Now, you can refresh the sandbox from the stored production backups. To do this, use the Select the backup list and select from the last 30 stored backups.
    The date and time on the Refresh Sandbox page are based on the EST time zone. The file naming convention for the backups is "DDMonYYYY HH:MM:SS EST(Close)" for a closed period backup, and "DDMonYYYY HH:MM:SS EST" for the other backup type.
  5. If you selected Refresh Type Schedule, enter the date and time for the refresh.
  6. Click Request Refresh and then confirm your selection.
    If you submit a refresh request for a release sandbox, a warning message is displayed. Confirm your selection to proceed.

After you submit a sandbox refresh request, the refresh job progress and status are displayed in the table. Refer to the following status explanations:

Status

Description

Pending

This is the initial status after the refresh request has been submitted.

Queued

The refresh request is currently queued for execution. This happens when multiple customers submit the sandbox refresh requests in parallel. No action is required you. To plan your critical work, check the time required for a refresh as estimated in refresh timelines below. You can cancel if needed from the Actions column.

Refreshing

The target sandbox refresh is in progress. The percentage shows refresh progress.

Completed

The target sandbox refresh has been completed. The progress percentage is displayed as 100%.

Error

The refresh job ended in error. Contact Zuora Global Support for assistance.

Scheduled

The refresh is scheduled for the selected sandbox. You can cancel if needed from the Actions column.

Cancelled

The refresh was canceled from the UI.

Refresh request timelines are based on customer data volume and operational time required to fulfill the request.

Size

Estimated time

Low to Moderate volume

Up to 48 hours

Large volume

Up to 72 hours (3 days)

Above Large volume

Up to 96 hours (4 days)