Newer Version Available

This content describes an older version of this product. View Latest

DataPackageKitDefinition

Represents the top-level Data Kit container definition. Content objects can be added after the Data Kit is defined.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DataPackageKitDefinition components have the suffix .dataPackageKitDefinition and are stored in the dataPackageKitDefinitions folder.

Version

DataPackageKitDefinition components are available in API version 53.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name Description
description
Field Type
string
Description
The description of the data kit.
developerName
Field Type
string
Description
Required. Represents the name of the application. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
isDeployed
Field Type
boolean
Description
Indicates whether Data Kit content is deployed.
isEnabled
Field Type
boolean
Description
Indicates whether the Data Kit is enabled.
masterLabel
Field Type
string
Description
Required. Label that identifies the AI application throughout the Salesforce user interface.
versionNumber
Field Type
double
Description
Auto incremented version number.

Declarative Metadata Sample Definition

The following is an example of a DataPackageKitDefinition component.

1<DataPackageKitDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
2    <developerName>SalesforceCRM</developerName>
3    <isDeployed>false</isDeployed>
4    <isEnabled>false</isEnabled>
5    <masterLabel>SalesforceCRM</masterLabel>
6    <versionNumber>1.0</versionNumber>
7</DataPackageKitDefinition>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>SalesforceDataKit</fullName>
4    <types>
5        <members>SalesforceCRM</members>
6        <name>DataPackageKitDefinition</name>
7    </types>
8    <types>
9        <members>Admin</members>
10        <name>Profile</name>
11    </types>
12    <version>53.0</version>
13</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.