This repo compliments my Dreamforce 2024 session, Three Things About Extending Data Cloud with Data Kits and aims to provide a hands on example for folks looking to see deployed Data Kits in action or to build their first second generation managed package with Data Kits.
- Dreamforce '24 - Three Things About Extending Data Cloud with Data Kits
The repo is comprised of three parts:
- Base Salesforce Platform app (
force-app) - Data Cloud Data Kit to consume platform app data (
data-app) - Data Cloud Extension package containing LWC's that consume Data Cloud data (
data-app-ext)
- Demo - Deploy the packages in sequence into a Data Cloud-enabled org and observe functionality.
- Create Your own Second Generation Managed Package with Data Cloud - Build your first 2GP managed package with Data Cloud using this repo as a starting point
- Org containing Data Cloud
- Salesforce CLI
git clone [email protected]:forcedotcom/e11y-df24-dc-three-things.git
cd e11y-df24-dc-three-things
npm i
Set your install org as the default target org in config.
sf config set target-org={ALIAS}
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tHs000000n9w4IAA
or
sf package install -p 04tHs000000n9w4IAA -w 10
Before installing, update the Data Cloud Salesforce Connector permission set. Grant View All at the object level and Read access to all fields.
sf apex run -f scripts/apex/updateDCConnectorPerms.apex
Install package
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tHs000000n9w9IAA
or
sf package install -p 04tHs000000n9w9IAA -w 10
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tHs000000n9xqIAA
or
sf package install -p 04tHs000000n9xqIAA -w 10
sf project deploy start -d unmanaged
The next steps use the Salesforce CLI to import data.
Grant user access to Voluneer Event objects
sf org assign permset -n Volunteer_Event_Admin
Import Contacts and Volunteer Event records into the org.
sf data import tree -p data/Contact-Volunteer_Event__c-plan.json
Create many to many association between Contact and Event Volunteer objects.
npm run addParticipants
If you ever need to start from scratch with the data, run npm run deleteVolunteerData. This will delete all Contact, Volunteer Event, and Volunteer Event Participant records.
The contents of the Data Kit will now be deployed into Data Streams, Data Lake Objects, and Data Model Objects.
- Data Cloud Setup > Data Kits > VolunteerEventDK
- Click "Data Kit Deploy"
- Enter the 15 character Org Id of your current org
Once the Data Streams are deployed, trigger a refresh of the data to consume the rows you inserted into CRM in the prior step.
- From Data Streams tab, click
mvpbo3__Volunteer_Event_Participant_Home - Click "Refresh Now" button
- Go back to Data Streams tab, click
mvpbo3__Volunteer_Event_Home - Click "Refresh Now" button
While the data gets ingested, go to Data Model and see the two new Data Model objects that have been deployed.
The last step is to place the LWC from the df24ThreeThingsDCExt package onto the Volunteer Event Participant flexipage.
- Go to App Picker > Volunteer Events
- Click Volunteer Event tab > click on any Volunteer Event record
- Click Setup > Edit Page
- Pick the veNewRegistrants component from the Components tab and drag it onto the flexipage.
- Save, Activate the page and assign as org default for desktop and phone. Click Next then Save
- The component pulls in data from the Volunteer Event Participant DMO and displays it via LWC on your record page.
Before getting into packaging, we will first install the app into a scratch org to observe the app. Afterwards, we will step through the packaging process for each of the three packages.
- Salesforce CLI
- Data Cloud for Scratch Orgs enabed DevHub. Instructions to request this feature are at Requesting Data Cloud Scratch Org Access.
- A namespace org associated to your DevHub
Clone, install dependencies, and set config
git clone [email protected]:forcedotcom/e11y-df24-dc-three-things.git
cd e11y-df24-dc-three-things
npm i
sf config set target-dev-hub={YOUR DEV HUB}
To use this locally with your own namespace, you must renamespace the entire project! Running the following command will prompt you for the old namespace mvpbo3 and you can replace it with one of your choosing. A dry run mode is available if you want to preview the list of files which will have contents or filenames changed. Just remember, you can always revert with git.
npm run renamespace
Now that we have updated filenames and file content with your namespace, we can create two scratch orgs. The first will be used to install the code while the second will act as a customer org.
Create the scratch org and set it to be the default for this project.
sf org create scratch -d -a df24ThreeThings -f config/dc-project-scratch-def.json -w 10 -y 30
Create the customer org (no namespace).
sf org create scratch -a df24ThreeThingsCustomer --no-namespace -f config/dc-project-scratch-def.json -w 10 -y 30
Deploy the base app into your df24ThreeThings scratch org. Data Cloud is actively being provisioned on the org which may delay the install of force-app files.
sf project deploy start -w 10 -d force-app
sf project deploy start -w 10 -d unmanaged
sf org assign permset -n Volunteer_Event_Admin
Before installing the Data Kit, update the Data Cloud Salesforce Connector permission set. Grant View All at the object level and Read access to all fields.
sf apex run -f scripts/apex/updateDCConnectorPerms.apex
sf project deploy start -w 10 -d data-app
- Data Cloud Setup > Data Kits > VolunteerEventDK
- Click "Data Kit Deploy"
- Enter the 15 character Org Id of your current org
sf project deploy start -w 10 -d data-app-ext
With the app deployed, you can optionally import and ingest data by following the steps listed in Import Data and the subsequent Deploy Data Kit & Ingest Data section. Once complete, continue by creating the packages.
The repo contains packageAliases within sfdx-project.json which may interfere with the creation of your packages. Delete all entries in packageAliases before creating packages from scratch.
sf package create -n df24ThreeThings -t Managed -r force-app
Create the package version. Note for this package version, we are using a different scratch definition that does not include Data Cloud. This is done to speed up the package version creation process.
sf package version create -c -f config/platform-project-scratch-def.json --installation-key-bypass -d force-app -w 10 -p df24ThreeThings
Take the 04t Id output from the previous step and use it to promote the package version.
sf package version promote -p {04t ID}
sf package create -n df24ThreeThingsDC -t Managed -r data-app
sf package version create -c -f config/dc-project-scratch-def.json --installation-key-bypass -w 100 -p df24ThreeThingsDC
Take the 04t Id output from the previous step and use it to promote the package version.
sf package version promote -p {04t ID}
sf package create -n df24ThreeThingsDCExt -t Managed -r data-app-ext
sf package version create -c -f config/dc-project-scratch-def.json --installation-key-bypass -w 100 -p df24ThreeThingsDCExt
Take the 04t Id output from the previous step and use it to promote the package version.
sf package version promote -p {04t ID}
Use CLI-based instructions in Deploy Volunteer Events App
- Workflow for Data Cloud Second-Generation Managed Packages
- Data Cloud Extensibility Readiness Matrix
- Create Dependencies Between Second-Generation Managed Packages
- Partner Community - Data Cloud for ISVs
Note: This is a partner-only feature.
To have Scratch orgs enabled with Data Cloud, please submit a case to have the feature enabled in your DevHub org (Typically your Partner Business Org). Please note, Data Cloud licenses will not appear in your PBO, instead, you will be able to create scratch orgs with Data Cloud enabled.
Case Details
Product: Partner Programs & Benefits
Topic: License Request - Prod Org
Subject: “Enable Data Cloud for Scratch orgs in dev hub”
Body: “Please enable Data Cloud Scratch Org permissions on my Partner Business Org, OrgId: XXX.”
Once submitted, permissions will be granted to your org within 3-5 business days.
I tried creating a scratch org but I got error code VR-0003.
- Your devHub org is already on the release preview and you can remove
"release": "preview"fromconfig/project-scratch-def.json. Reference forcedotcom/cli/#1022
When deploying my renamespaced data-app folder, it failed and reported the following error Error Volunteer_Event_Participant_Home__dlm.rel_1725930000724_end__c Value too long for field: MasterLabel maximum length is:40
- Open
data-app/objects/Volunteer_Event_Participaant__c/fields/rel_1725930000724_end__c.field-meta.xml. Shorten the<label>and<relationshipLabel>to 40 character or less.
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>rel_1725930000724_end__c</fullName>
<deleteConstraint>SetNull</deleteConstraint>
- <label>mvpbo3_Volunteer_Event_Participant_H_rel</label>
+ <label>mvoriginalNS_Vol_Event_Participant_H_rel</label>
<referenceTo>Volunteer_Event_c_Home__dlm</referenceTo>
- <relationshipLabel>mvpbo3_Volunteer_Event_Participant_H_rel</relationshipLabel>
+ <relationshipLabel>mvoriginalNS_Vol_Event_Participant_H_rel</relationshipLabel>
<relationshipName>rel_1725930000724_end</relationshipName>
<required>false</required>
<type>Lookup</type>