Hutte Recipe - Snowfakery

This recipe uses Snowfakery and CumulusCI to generate data on-the-fly and import it into a Salesforce Org, all by using a Custom Button in Hutte. Check out the Hutte Demo to see more about this recipe.

Prerequisites

• a valid sfdx project
• a hutte.yml file (e.g. the default one shown in the Project Settings -> Setup -> Scripts (Hutte.yml) section of the Hutte project).

Step 1: Create a Snowfakery recipe

As an example, the next recipe generates Accounts, Contacts, Opportunity and OpportunityContactRole, with the required relationships. Source: Generate Realistic Datasets with Snowfakery.

.data/account-contact-opportunity.recipe.yml

- object: Account
  fields:
    name:
      fake: company
  friends:
    - object: Contact
      count: 2
      fields:
        FirstName:
          fake: FirstName
        LastName:
          fake: LastName
      friends:
        - object: Opportunity
          count:
            random_number:
              min: 1
              max: 3
          fields:
            StageName:
              random_choice:
                Prospecting: 50%
                Qualification: 50%
            CloseDate: 2022-01-01
            ContactId:
              reference: Contact
            AccountId:
              reference: Account
            Name: The ${{Contact.LastName}} Opportunity
          friends:
            - object: OpportunityContactRole
              fields:
                OpportunityId:
                  reference: Opportunity
                ContactId:
                  reference: Contact
                Role:
                  random_choice:
                    Business User: 20%
                    Decision Maker: 20%
                    Economic Buyer: 20%
                    Economic Decision Maker: 20%
                    Evaluator: 20%

For more information on the creation of Snowfakery recipes, check the next documentation:

• Snowfakery Documentation
• Snowfakery for Salesforce
• Fake Data Generation

Step 2: Create a CumulusCI definition file

Create a baseline cumulusci.yml definition file in the root folder:

cumulusci.yml

minimum_cumulusci_version: "3.16.0"
project:
  name: Snowfakery
  package:
    api_version: "50.0"
sources:
  hutte-recipes:
    github: https://github.com/hutte-recipes/hutte-snowfakery

More information on CumulusCI configuration.

Step 3: Add Custom Script to hutte.yml

• Edit the hutte.yml file in your default branch
• Add the following button in custom_scripts > scratch_org

custom_scripts:
  scratch_org:
    "Import Data":
      description: "Import data using Snowfakery"
      run: |
        apt-get -qq update
        apt-get -qq -y install pipx > /dev/null
        pipx install cumulusci
        export PATH="/root/.local/bin:$PATH"
        cci version
        cci org import ${SF_TARGET_ORG} ${SF_TARGET_ORG}
        cci task run generate_and_load_from_yaml \
          --num_records_tablename Opportunity \
          --generator_yaml data/account-contact-opportunity.recipe.yml \
          --org ${SF_TARGET_ORG}

Note 1: CumulusCI is installed in the Docker Image provided by Hutte, hence no need to worry about its installation in the above script.

Note 2: If you use a Sandbox instead of a Scratch Org, replace scratch_org by sandbox. If you want the button to be available for both, duplicate the section using both of the keys.

Step 4: Validate

• Create a Scratch Org or open an existing Scratch Org / Sandbox
• Verify that the button is displayed
• Have fun!