How to Connect Your Org to Snowfakery
Snowfakery is a free and open source tool used to generate and insert fake data into Salesforce (and more!).
In this post I’m going to show you how to get started as quickly as possible using existing “recipes” or instructions for what data you want to create. Something like… I want a pinch of Accounts in Michigan, a heaping tablespoon of Contacts with ages ranging from 18 to 24, and 2 cups of Opportunities closed won.
Snowfakery?
We aren’t going to write our own recipes to get started today. The documentation on how to create Snowfakery recipes (and this excellent training video from 2021) will help you with recipe creation, but there are plenty of existing recipes to utilize. Let’s go!
Pre-requisites:
- Install Visual Studio Code (VS Code). Here you’ll do most of your work.
- Install Cumulus CI. This tool helps connect Salesfore with VS Code.
- Sign up for GitHub. You’ll need an account to access the sample recipes.
- Install GitHub Desktop. I use this to get GitHub repositories from GitHub to VSCode.
Yeah, that’s a lot. I don’t think you need to know much about these tools to follow this tutorial, but please let me know if I’m assuming some knowledge.
Watch the video and/or read the instructions below.
Open the Repository in VS Code
The first thing you want to do is clone this repo and open it in VS Code. There is probably a better way to do this, but here’s what I did:
- Go here to the Snowfakery repository.
- Click the green Code button then select Open with Github Desktop.
- Click on the Repository menu across the top and select Open in Visual Studio Code.
Next Steps
- Click on the Terminal menu across the stop and select New Terminal.
- Connect to the org in which you want to insert data by typing in
cci org connect <org name>so if you want your org to be “246testData” then you typecci org connect 246testData - Then a screen will pop up where you log into your org.
- Next paste in
cci task run snowfakery --recipe examples/salesforce/Account.recipe.yml --org246testData(replace that with your own org name) - And hit enter. This will run the sample code for inserting accounts!
Use Your Own Recipe
After you learn to create your own recipe, replace one of the sample recipes with your own:
In VS Code, open the Explorer which looks like two pieces of paper. Expand items in the list until you find Examples, then Salesforce and in there are all the sample .yml files! You can use any of these, change them or manipulate them. You could save your own file in here too.
Celebrate
Generating fake data for your sandboxes or customers can really help your users understand what they are seeing. That’s a huge win.
And personally, maybe you don’t consider yourself a developer yet, but if you’ve gotten this far, you are well on your way!
Keep growing with Visual Studio Code and CumulusCI. Try this post.
Snowfakery is Community Driven
Community members are involved in:
- creating/updating sample Snowfakery recipes
- spreading the word about Snowfakery through presentations, blog posts, podcasts, SF community events
- reporting/fixing bugs, suggestiong/contributing enhancements to the Snowfakery tool itself
For anyone interested in getting involved in the Data Generation Toolikit project:
- Get started by following the project Onboarding Page.
- The project team meets monthly to maintain momentum between sprints (learn about sprints here). You can contact us through the Trailblazer Community to get details for joining the next meeting.