RelativityOne Sandbox

Note: This functionality is not currently available for FedRAMP customers / government entities.

RelativityOne Sandbox refers to reusable RelativityOne environments that allow you to test SQL scripts, event handlers, API based applications, custom pages, and custom agents for both the current and Early Access (EA) release of Relativity.

Note: Sandbox is a service that you must subscribe to. Please contact your Account Manager for more details.

Both sandbox instances (e.g., current and EA) will be upgraded month-to-month. Your users will have a unified login between their production instance and their Sandbox instance and be able to switch between instances easily.

This page contains the following information:

Accessing Sandbox environments

Considerations for access to RelativityOne Sandbox includes the following:

RelativityOne Sandbox contains the following two environments:

  • Early Access (EA) - this environment contains the fully tested version of RelativityOne that is one release ahead of the current RelativityOne production release. This early access version of Relativity is accessible in both your Sandbox environment and Preview environments. You will have access to your EA sandbox 21 to 30 days prior to the actual RelativityOne release.
  • Current Release - this environment contains the version of RelativityOne that is currently deployed to your RelativityOne production instance for the given month.

Instance URL for the new environments will be formatted as follows:

  • <customer name>
  • <customer name>
  • <customer name>
  • <customer name>

Granting users access to your Sandbox

To grant users access to Sandbox instances:

  1. In your production instance, associate the "Sandbox Auth Provider" OpenID Connect login method to each relevant user account (with the email as the OpenID Connect Subject).
    1. Navigate to the User and Group Management > Users tab.
    2. Search for a relevant user, and then click on their name.
    3. Copy the user's email address.
    4. Under the Login Method (User) section for the user, click New.
    5. Under the Provider dropdown, choose Sandbox.
    6. In the OpenID Connect Subject field, paste the email address for the user.
    7. Save your changes and repeat the process for each user to whom you need to grant access.
  2. Associate each user from the previous step to the Sandbox system group in your production Relativity instance to grant them access to your Sandbox environments.
  3. The group of users that is synced to your Sandbox instance will be named User Sync from <DNS> (e.g., User Sync from Acme). Any new users that are synced over will have email addresses set to a random generated number format (e.g., Existing users in Sandbox will not be modified.

  4. Once you have done this for all the users you want to provide Sandbox access to, navigate to the User and Group Management > User Sync Preview Information (Master) tab and review what's shown.
  5. After about 5 minutes or so, the users being synced over should have a status of "Created" in the Created column of the Users drop-down table.

  6. Navigate to each of the sandboxes (EA and Current), and perform the following steps to assign the proper security permissions in each of the sandboxes.
    1. Navigate to the User and Group Management > Users tab.
    2. Add each new user to the System Admin group or other security group you’d like them to have access to (similar to your main instance).
  • Do not change the email addresses associated with the new users in your sandboxes. The email addresses will seem odd, but this is what links the users together.
  • After the user is synced over to the Sandbox, you must add the user to another group in your Sandbox to assign any relevant security permissions. The initial Sandbox user (set up by Relativity) can add users to any group in your Sandbox as well as create new groups with customized permissions.
  • Any users added to your Sandbox group will be able to access both Sandbox environments (EA and current).
  • To create test users, you may add them directly to Sandbox, but these users will not sync back to production.

Removing a user from your Sandbox

To remove a user from your Sandbox:

  1. Remove the user from the Sandbox group on your primary instance(s) to ensure that it wont be synchronized again.
  2. Delete or inactivate the user in your Sandbox environment.

Upgrades of your Sandbox environments

Refer to the following considerations for Sandbox upgrades

  • Upgrade timeline - see Sandbox extended downtime windows and the Sandbox upgrade cadence calendar. Sandbox environments (current and EA are updated on a regular basis. Upgrades will take place during business hours.
  • Sandbox gap period - there will be a period of several days (indicated with the red background in the calendar below) after your Current Sandbox is updated with the upcoming Relativity fix version. During this time your current Sandbox is a version ahead of your production instance.
    • If you need to test an application on the same version that's in production today, you must do so before this gap period.
    • If you need to test an application on the next minor release, you must do so within this gap period.
  • Notification window - you will be notified prior to the upgrade with proactive steps on how to ensure a successful upgrade.
  • Application errors - if an error occurs during the upgrade of applications, reach out to If you cannot troubleshoot your application or detect a problem with the Relativity APIs after the upgrade, reach out to the Relativity Developer Experience team.
  • Workspace errors - if a Workspace cannot be upgraded due to custom application errors, you are given options on how to proceed:
    • Troubleshooting the issue independently using DevHelp forums
    • Open a ticket with (reference the workspace error and that it happened during a Sandbox upgrade)
    • Deleting or disabling the workspace for future upgrades.

Note: If there is a new Windows update available to apply, your system will automatically reboot and apply the updates outside of local business hours (2 am).

Sandbox upgrade cadence calendar

The following calendar shows the planned Sandbox upgrade cadence. The exact dates of upgrades may vary. The start date of an upgrade event in the calendar is the first possible date that the upgrade may occur. Please refer to Sandbox extended downtime windows for more information on these upgrade dates where system downtime may occur.

Production environment events
Current Sandbox events
EA Sandbox events
Date ranges where the current Sandbox will not match your production environment are shown with a red background.

Sandbox extended downtime windows

Using Sandboxes to troubleshoot custom applications

Sandboxes can be very useful for performing tests and reproducing issues with custom applications. If you encounter issues with your custom development, first reproduce the error in a Sandbox and use the available EDDS logging (described below) to understand its root cause. The topic Debugging custom applications and support for custom applications provides guidance for how to troubleshoot and verify your custom code.

Troubleshooting considerations for Sandbox

For Sandbox, the application logs are written to the EDDSLogging database and the Tenant Reporting account has read-only access. In RelativityOne production, read access to this database is not available and you must work with Relativity Support if help with troubleshooting is required.

Differences between production and Sandbox environments


Sandbox environments do not contain the same infrastructure as your RelativityOne production instance; each instance is a very scaled down version of a Relativity instance.

  • RelativityOne Sandbox is a functional test environment and not intended for performance testing.
  • Customer managed keys (CMK) and SIEM log integration is not supported for Sandbox.
  • Sandbox environments do not support client domains functionality.
  • The region your Sandbox instance is deployed in may not match your RelativityOne deployment region. Please out to Support if you have questions.
  • Sandbox environments are monitored for uptime by Relativity.

Relativity components

The following Relativity components will be untestable in your Sandbox:

  • Load balancers
  • Production certificates
  • Active Directory
  • Secondary agent servers
  • Invariant worker scale sets
  • Utility Server

Note: Visual Studio Remote Debugging is not currently allowed in Sandbox environments.

Sandbox Support policies

Sandbox environments do not have the same service level agreements as RelativityOne production instances.

Sandbox environments are considered 2nd tier environments. Issues with your primary RelativityOne production instances will always take precedence over a similar issue in a Sandbox environment. Furthermore, there is no such thing as a catastrophic or NIA incident for these environments. Response speed will be based on the relevant Relativity team handling the issue and their availability. Additionally, Relativity does not offer performance support for Sandbox environments (as noted in the Infrastructure section).

Data in Sandbox environments

Consider the following:

  • Sandbox environments provide you 32 GB for distributed data (workspaces) and 128 GB for file storage.
  • Data that you add to the Sandbox environment will persist during monthly upgrades. However, you are responsible for the data in your own Sandbox environment. We are not responsible for the safety of your data and it is not backed up or replicated by Relativity.
  • Small amounts of test data should be used in your Sandbox environment. Each workspace is limited to 10,000 documents.
  • We recommend that you do not put any production info into the Sandbox environments. You should use test data to test your applications.