DataPackageKitDefinition in SFDX

Architectural Overview#

The DataPackageKitDefinition metadata type represents the root definition for Data Kits within Salesforce Data Cloud. Data Kits are the primary modular distribution mechanism for Data Cloud solutions, allowing Independent Software Vendors (ISVs) and enterprise architects to encapsulate complete analytical applications into Second-Generation Managed Packages (2GP) or unlocked packages.

A DataPackageKitDefinition functions as the master manifest container. It links together constituent Data Streams, custom Data Model Objects (DMOs), Data Lake Objects (DLOs), relationship schemas, field mappings, and Calculated Insights. When installed in a subscriber organization, the Data Kit facilitates rapid, guided activation via Data Cloud Setup without requiring error-prone manual schema recreation.

Directory and File Suffix Conventions#

In SFDX source format, DataPackageKitDefinition files are located in the dataPackageKitDefinitions directory:

Key Metadata Fields#

Declarative XML and Manifest Examples#

Source Format XML (FinancialServices_Analytics_Kit.dataPackageKitDefinition-meta.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<DataPackageKitDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName>FinancialServices_Analytics_Kit</developerName>
    <masterLabel>Financial Services Analytics Data Kit</masterLabel>
    <description>Bundles wealth management DMOs, transaction streams, and risk score Calculated Insights.</description>
    <packageCategory>Industry</packageCategory>
    <version>1.2</version>
    <isPublished>true</isPublished>
</DataPackageKitDefinition>

Manifest (package.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>FinancialServices_Analytics_Kit</members>
        <name>DataPackageKitDefinition</name>
    </types>
    <version>68.0</version>
</Package>

Retrieval and Deployment Commands#

Use the Salesforce CLI to retrieve and deploy DataPackageKitDefinition metadata:

# Retrieve all Data Kit definitions from the org
sf project retrieve start --metadata DataPackageKitDefinition

# Retrieve a specific Data Kit by developer name
sf project retrieve start --metadata DataPackageKitDefinition:FinancialServices_Analytics_Kit

# Deploy Data Kit definition metadata to target environment
sf project deploy start --metadata DataPackageKitDefinition:FinancialServices_Analytics_Kit

Senior Architect Best Practices and Gotchas#

• Encapsulate Related Assets: Treat the DataPackageKitDefinition as the single source of truth for your Data Cloud packaging boundaries. Bundle child DataPackageKitObject and DataKitObjectDependency components in the same deployment commit.
• ISV Namespacing: When building AppExchange packages, ensure all constituent objects inside the kit conform to your managed package namespace. Namespaced kits install cleanly into subscriber orgs without conflicting with existing custom DMOs.
• Subscriber Activation Handshake: Installing a package containing a Data Kit deploys the schema blueprint, but an administrator in the subscriber org must click “Activate” in Data Cloud to connect local data connectors and begin streaming data.

Frequently asked questions

What is the role of DataPackageKitDefinition in Data Cloud?

It serves as the master container for a Data Kit, bundling Data Streams, DMOs, Calculated Insights, and mappings into a distributable package.

Where are DataPackageKitDefinition files stored in SFDX?

They are stored in force-app/main/default/dataPackageKitDefinitions/ with the file suffix .dataPackageKitDefinition-meta.xml.

Can DataPackageKitDefinition be packaged into 2GP packages?

Yes. Data Kits are fully supported in second-generation managed packages (2GP) and unlocked packages for commercial and enterprise delivery.

How do you retrieve DataPackageKitDefinition metadata?

Execute sf project retrieve start with the metadata flag DataPackageKitDefinition.