As an admin, making changes to automation rules and configurations in your production account can be tricky. However, you don’t want to be restricted from trying out new ways or improve existing configurations set up in your service desk. This is why we’re bringing Sandbox to Freshservice.
With Sandbox, you can create an out-of-the-box environment to test out workflows and configurations before syncing them to your Freshservice account (a.k.a your production account) while keeping away from ramifications. Though Sandbox is a mirror of your Freshservice account, tickets, customer data or contact will not be copied.
What are the modules that get copied to your Sandbox account?
- Business Hours
Departments & department fields
Requesters - (Reporting managers/Department head/Approvers/members of the CAB)
Roles & Permissions
Workflow Automator(All Modules)
Asset Automations (Deletion of asset types and fields, product, vendor, and domain is not possible)
What are the modules that do not get copied to your Sandbox account?
Ticket list views
Portals - logo, favicon, customization
Apps and integrations
SSO and SSL settings
How to setup your Sandbox account?
Navigate to Admin -> Sandbox in Helpdesk Productivity.
In the Sandbox Details tab, click on Create Sandbox and once the Sandbox account is created, admins will be notified via email. This will take some time based on your service desk configuration.
Click on Open Sandbox to log in to your Sandbox account in a new tab. Here, you can test out configurations before syncing them your Freshservice account.
Note: The banner on top of the screen will indicate if you’re in your Sandbox account. Also, the URL of your sandbox account would look like this https://companyname-fs-sandbox.com.
How to sync changes from Sandbox to my Freshservice account?
Once you test out the configurations in Sandbox, go to your Sandbox account, navigate to Admin -> Sandbox in Helpdesk Productivity
Click on View Changes to fetch all the changes made in your Sandbox account.
You can then click on Regenerate Change List -> Regenerate to ensure all the changes created are included in the change list before syncing them.
If there aren’t any conflict or sync errors shown in the change list, you can go ahead and click on Sync Now to have these changes synced to your Freshservice Account. Once the sync is successful, your sandbox account will automatically get destroyed.
Note: The sandbox account created will automatically be destroyed in 180 days.
1. Ensure you, or other admins do not make any changes in the production environment when the sandbox is active.
2. Always regenerate changes: with the latest data in the sandbox account once you fix the conflict errors.
3. Make sure other admins have finished making all changes before you sync your changes to your production account so that all admin changes are copied.
4. Keep your sandbox account live for short periods of time. This prevents differences from adding up between your two accounts.
5. Plan your sync from sandbox to the production account during off-peak hours.
What is Conflict?
When there are modifications to values, description or properties in both your Freshservice account and your Sandbox account.
For eg: When the group name is changed from Information Technology team to Capacity Management in your Sandbox account and the same group is changed from Information Technology team to IT Team in your Freshservice account as well. This will lead to Conflict.
Note: Conflict errors are not applicable for Workflow Automator and Change Lifecycle.
What is Sync Error?
This includes activities such as creation or deletion of new or existing status, transitions, node, event or action in both your Freshservice account and Sandbox account. Sync errors cannot be fixed easily like conflict errors.
For eg: When a transition is added to the status (Pending Review -> Closed) in your Sandbox account and a transition has been added to the same status (Pending Review -> Open) in your Freshservice account as well. This will lead to a Sync Error.
Note: Sync errors can happen only in Workflow Automator and Change Lifecycle.
How to sync changes in case of a conflict or sync error?
In case of a conflict, admins can fix the errors, click on Regenerate Change List and then click on Sync Now to have the changes copied to your Freshservice Account.
In case of a sync error, admins will have to clone that workflow/lifecycle in the sandbox account, click on Regenerate Change List and then click Sync Now to have the changes copied to your Freshservice Account.
Where can I view all the sync history?
- You can navigate to Admin -> Sandbox -> Sync History tab in your Freshservice account and check the sync history for any particular date.
How to deactivate my Sandbox account without syncing changes?
As admins, you might not always want to sync the changes to your Freshservice account. In that case, you could also directly destroy the Sandbox created by navigating to Admin -> Sandbox -> Destroy Sandbox from your Freshservice account.
What are the changes skipped in Sandbox?
Few cases such as deletion of an Agent/ CAB/User/Group/Location/Department/Service item/ Service category are not captured in the change list and will not be synced to your Freshservice account as deleting such key entities would have a huge impact on existing tickets in your Freshservice account.