# DataKitObjectTemplate in SFDX

> DataKitObjectTemplate defines reusable schema templates and object blueprints packaged within Data Cloud Data Kits for multi-org deployment.

- Source: https://sfdxtalk.com/docs/metadata/data-kit-object-template-metadata-type/
- Category: Metadata
- Applies to: Salesforce Winter '27 (API version 68.0)
- Level: advanced
- Published: 2026-11-12
- Last updated: 2026-11-12
- Publisher: SFDX Talk Editorial (unofficial; not affiliated with or endorsed by Salesforce)
- License: CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

## Architectural Overview

The `DataKitObjectTemplate` metadata type represents an object blueprint or schema template bundled inside a **Salesforce Data Cloud Data Kit** (`DataPackageKitDefinition`). Data Kits function as modular packaging units for Data Cloud, enabling Independent Software Vendors (ISVs) and enterprise architects to encapsulate complex data architectures—including custom Data Model Objects (DMOs), Data Lake Objects (DLOs), data stream mappings, and Calculated Insights—into 2GP managed or unlocked packages.

Rather than hardcoding rigid physical tables, `DataKitObjectTemplate` provides an abstract object template. When installed in a subscriber organization, the Data Cloud installation runtime consumes the template to generate or extend the target data model while adapting to subscriber namespace configurations.

```mermaid
flowchart TD
    A["Developer Packaging Org"] --> B["DataPackageKitDefinition"]
    B --> C["DataKitObjectTemplate (Blueprint)"]
    C --> D["2GP Managed Package Artifact"]
    D -->|"Subscriber Org Installation"| E["Data Cloud Setup Wizard"]
    E --> F["Instantiated Data Model Object (DMO)"]
```

## Directory and File Suffix Conventions

In SFDX source format, `DataKitObjectTemplate` metadata files reside in the `dataKitObjectTemplates` directory:

| Property | Value |
| :--- | :--- |
| **Metadata Type Name** | `DataKitObjectTemplate` |
| **SFDX Source Directory** | `force-app/main/default/dataKitObjectTemplates/` |
| **SFDX File Suffix** | `.dataKitObjectTemplate-meta.xml` |
| **Manifest Member Name** | `<name>DataKitObjectTemplate</name>` |

## Key Metadata Fields

| Field Name | Type | Required | Architectural Guidance |
| :--- | :--- | :--- | :--- |
| `masterLabel` | `string` | Yes | Human-readable title of the object blueprint displayed in the Data Kit builder. |
| `developerName` | `string` | Yes | Unique programmatic identifier for the template definition. |
| `dataPackageKitDefinition` | `string` | Yes | API name of the enclosing `DataPackageKitDefinition` container. |
| `templateType` | `string` | Yes | Categorizes the asset structure (`DataModelObject`, `DataLakeObject`, `CalculatedInsight`, etc.). |
| `targetObjectType` | `string` | No | Schema classification or standard entity reference targeted by this template. |
| `templateDefinition` | `string` | No | Serialized schema definition specifying field configurations and relationships. |

## Declarative XML and Manifest Examples

### Source Format XML (`Loyalty_Transaction_Template.dataKitObjectTemplate-meta.xml`)

```xml title="force-app/main/default/dataKitObjectTemplates/Loyalty_Transaction_Template.dataKitObjectTemplate-meta.xml"
<?xml version="1.0" encoding="UTF-8"?>
<DataKitObjectTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <developerName>Loyalty_Transaction_Template</developerName>
    <masterLabel>Loyalty Transaction DMO Blueprint</masterLabel>
    <dataPackageKitDefinition>Retail_Loyalty_DataKit</dataPackageKitDefinition>
    <templateType>DataModelObject</templateType>
    <targetObjectType>Custom</targetObjectType>
</DataKitObjectTemplate>
```

### Manifest (`package.xml`)

```xml title="manifest/package.xml"
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Loyalty_Transaction_Template</members>
        <name>DataKitObjectTemplate</name>
    </types>
    <version>68.0</version>
</Package>
```

## Retrieval and Deployment Commands

Use the Salesforce CLI to retrieve and deploy `DataKitObjectTemplate` metadata:

```bash
# Retrieve all Data Kit object templates
sf project retrieve start --metadata DataKitObjectTemplate

# Retrieve a specific object template by name
sf project retrieve start --metadata DataKitObjectTemplate:Loyalty_Transaction_Template

# Deploy object template metadata to the target environment
sf project deploy start --metadata DataKitObjectTemplate:Loyalty_Transaction_Template
```

## Senior Architect Best Practices and Gotchas

- **Schema Reusability and Modularity:** Design object templates to be modular and generalized. Avoid baking org-specific custom field IDs or rigid external database keys into the blueprint.
- **Support for Standard DMO Extensions:** When templating extensions to standard Data Cloud entities (such as Individual or ContactPointAddress), ensure your template adheres to canonical standard schema conventions to avoid collision with Salesforce updates.
- **Version Compatibility:** Verify that subscriber orgs are running a compatible Data Cloud release (Winter '27 / API 68.0) that supports all templated data types and calculation engines.

> [!NOTE]
> Installing a package containing `DataKitObjectTemplate` provisions the template definitions; administrators must activate the Data Kit in Data Cloud Setup to instantiate live objects.

## Frequently Asked Questions

### What is the function of DataKitObjectTemplate in Data Cloud?

It acts as an object blueprint within a Data Kit that defines how target Data Model Objects or Lake Objects are instantiated upon installation.

### Where are DataKitObjectTemplate files saved in an SFDX project?

They are saved in force-app/main/default/dataKitObjectTemplates/ with the file suffix .dataKitObjectTemplate-meta.xml.

### Can DataKitObjectTemplate package custom Data Model Objects?

Yes. It packages blueprints for custom DMOs, standard DMO extensions, Data Streams, and Calculated Insights for portable distribution.

### How do you retrieve DataKitObjectTemplate metadata?

Execute sf project retrieve start with the metadata flag DataKitObjectTemplate.

## Official References

- https://developer.salesforce.com/docs/platform/api-metadata/references/meta-types/metadata-datakitobjecttemplate.md