Using Sandboxes with HomeKeeper
Table of Contents
When customizing your HomeKeeper, consider using a Sandbox to plan, build, test, and train users in a secure environment that won't affect your live production instance. This article will provide a simple HomeKeeper-specific overview, best practices for sandbox usage, and a step-by-step guide to creating a Sandbox.
What is a Sandbox?
Simply put, a Sandbox is a copy of your Salesforce with the HomeKeeper application that is free to create and is easily created and refreshed. Your actual HomeKeeper instance is called ‘Production’.
NOTE: This Salesforce Help Article provides a deep dive on sandboxes, including how to create them, when to use them, and the different types available.
When to use a Sandbox?
You don't need to use Sandboxes for every change. If you're adding a single field or a picklist value, you probably won't run into any trouble making the change directly in production. Those changes are small, easily reversible, and will not affect your existing data.
Sandboxes are best used for large structural changes that can impact your existing data. That includes installing third-party applications, uninstalling existing apps, creating automations like Flow, or making large architectural changes to your data model.
How to Create a Sandbox
NOTE: This video tutorial from Easy Earl walks you through creating a Sandbox in Salesforce.
- Click on the gear icon in the upper right-hand of your screen to open Setup.
- Use the Quick Find search bar to find ‘Sandboxes’.
- In the ‘Sandboxes’ menu, you will see all currently active Sandboxes. Click ‘New Sandbox’ to create a new one.
CAUTION: Developer sandboxes (the most common kind) require a Public Group. This Group determines access to the sandbox. If you do not have any Public Groups in your Salesforce, follow the instructions in this article to create one.
- Name your sandbox and pick your sandbox type. For most situations, a Developer sandbox will be fine - this will provide a copy of your production without any data. If you require a copy of your data, you will need to use a Partial Copy sandbox. Click ‘Next’ to continue to the next page.
- If using a Developer sandbox, select the Public Group that you would like to grant access to. Leave the other fields unchanged and click ‘Create’.
- Your sandbox will now be created. It can take anywhere from 30 minutes to an hour for a sandbox to be created. You will receive an email notification once the setup is complete.
- To login, you will use your HomeKeeper credentials with the sandbox name added to the end of your username. For example, if your email is sample@sample.org and your sandbox name is test, then your login would sample@sample.org.test. Your password would be the same as usual.
Additional Information for Your Use-Case
For Testing HomeKeeper Before Installing in Production
If you are using Salesforce before adopting HomeKeeper and/or you have a highly customized instance, it can be a good idea to test HomeKeeper in a sandbox before installing in production.
CAUTION: Please note that, as part of your onboarding package, we can only configure HomeKeeper once (whether in sandbox or in production).
Avoiding Potential Conflicts w/ Installation
- The HomeKeeper app only touches three standard objects: Accounts, Contacts, and Opportunities. If those objects are customized in your instance or you have any automations running on them, then testing in sandbox would be a smart move.
To test the installation, begin by creating a sandbox by following the instructions above. To install HomeKeeper in the sandbox, you can use the link provided by the HomeKeeper Team, changing the first part of the URL from https://login.salesforce.com/ to http://test.salesforce.com. When prompted, login using your sandbox credentials.
For Existing Users Testing Customizations or Upgrades
If you are already set up with HomeKeeper, sandboxes can still be really useful! Below are some of the common uses of Sandboxes for existing HomeKeeper Users.
-
Upgrading to a new version of HomeKeeper: usually, upgrading from one version to the next doesn't require testing in a sandbox. But, if you're upgrading several versions due to missed upgrades, or if you've substantial customizations since the last update, you may want to test the upgrade in a Sandbox.
- To test an upgrade, just use the link in the version release notes, changing the first part of the URL from https://login.salesforce.com/ to http://test.salesforce.com. When prompted, login using your sandbox credentials.
- Advanced Support or working with a consultant: If you're working with the HomeKeeper Team on an Advanced Support engagement, we will build any customizations in a sandbox before deploying to your production environment. This gives you a chance to review and test before finalizing. If you're working with a consultant, they should also build any customizations in a sandbox as a best practice.
- Customizations, Automations, Integrations, etc. As mentioned above, if you're making large-scale changes that could impact your data, testing in a sandbox first can save you a big headache!
What's Next? Move Your Changes to Production using Change Sets
You may be wondering, “Well, I've just made all these updates in my sandbox, will I have to make them again in production?” The good news is that you can deploy those changes to production by using Change Sets!
See the Salesforce resources to learn more about Change Sets and how to use them:
- Change Sets Overview from Salesforce Help
- Org Development Model from Trailhead
- Everything You Need to Know about Salesforce Change Sets from SF Ben
- Change Sets Video Tutorials from Salesforce Support