Sandbox Environments

Overview

A sandbox environment is a point in time snapshot of your instance of Unifyr One Admin. You can use it to carry out your own testing, such as UAT or integration testing, pass it to your 3rd party IT or integration partners for use, or set it up for training purposes.

Permitted users can work in the sandbox environment without worrying that they’re affecting your production or business environment.

Note

Configuration or data changes made in a sandbox environment are isolated to that area and can't be automatically migrated to or from the production environment. Any changes you make here must be recreated manually on your production system.

Creating a sandbox environment takes a snapshot of your environment. The action copies these items to the sandbox: 

• Navigation
• Client Settings
• Partner Fields
• Custom Forms and Fields
• Partner Groups
• Tags
• Portal Configuration
• Emails & Popups
• Data Pipelines (if enabled on your system)
• App Modules (if enabled)

Notes

• Changes to your production environment will not be reflected on any existing sandbox environments. You must create a new sandbox copy to reflect any updates made.
• For security and service continuation purposes, these items are not copied into a sandbox:
  • Partner Account/Partner User data
  • Content (Marketing Activities, Library Content, LMS)
  • Custom Objects
  • System Messaging
  • SOQL reports and credentials
  • Partner Funnels
  • IPaaS/Workato integrations
• Data Pipelines and their Service Authorization modules are copied into a sandbox, but they are marked as Inactive. Credentials such as passwords and tokens are not copied to the new environment.
• Partner Groups are copied over, but will not reflect true membership as partner/user data isn't included.
• As a default, you can manage up to 5 active copies of your environment. They remain active for 90 days. You can choose to have one that will never expire.

Caution

We recommend that you do not connect a sandbox environment to a production instance of your CRM.

Before You Begin

Users must have the required permissions to access or work with a sandbox environment.

Contents

Click on the + to expand the instructions for the desired task.

Permissions for Working with Sandbox Environments

Assign these System Management permissions to control which user roles can work with sandbox environments:

• Sandbox Access - use sandbox environments
• Sandbox Management - create, manage, delete sandbox environments

These permissions are assigned to the Administrator and IT Administrator roles in Unifyr One Admin as a default.

For more information about managing roles and permissions, see Manage Role Permissions.

Create a Sandbox Environment

Permission Required

You need the permissions Sandbox Access and Sandbox Management to complete this action.

To create a snapshot of a Unifyr One instance to use as a sandbox, follow these steps:

1. In Unifyr One Admin, click the sandbox icon in the toolbar: 

   

2. In Environments, click Create Sandbox Environment.

   

   The spinner indicates that Unifyr One is working on the new environment. A label indicates when the environment has been created, and is being configured:

   

3. When the new environment is ready, the Setup in Progress label is replaced with Delete and Access buttons.

4. [Optional] Use the edit pencil to add a description for the environment. Click the icon to confirm it, or the icon to delete it. The description can be up to 255 characters long.

   

5. [Optional] Enable the Do not expire option if you don't want the environment to expire after 90 days. you can set this option for one of your environments.

   

6. [Optional] Use the Copy icon to pick up the name of the new environment.

   

Access a Sandbox Environment

Permission Required

You need the permission Sandbox Access to complete this action.

To access an existing Unifyr One sandbox environment, follow these steps:

1. In Unifyr One Admin, click the sandbox icon in the toolbar:

   

2. In Environments, find the environment you want to use.

3. Click Access.

   

   You’re taken to the sandbox environment. You can identify which environment you’re in with the label in the top left of the window:

   

To revert to the original production Unifyr One Admin instance:

1. When in a sandbox environment, click the sandbox icon in the toolbar.

   

2. In Environments, click Back to Parent Account.

   

3. You’re taken back to the Unifyr One Admin instance of which the sandbox is a copy.

Delete a Sandbox Environment

Permission Required

You need the permissions Sandbox Access and Sandbox Management to complete this action.

To delete an existing Unifyr One sandbox environment, follow these steps:

1. In Unifyr One Admin, click the sandbox icon in the toolbar:

   

2. In Environments, find the environment you want to delete.

3. Click Delete.

   

4. Click Yes to confirm that you want to proceed with the deletion.

Authorize an API connection to a Sandbox Environment

If you're connecting to a sandbox environment via API, ensure that the clientKey for the Authorization Request is set to the name of the sandbox environment.

You can find the name here:

Training