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 Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 53.0.

Special Access Rules 

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

Fields 

dataKitSource 

  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: The data source in the updated data kit.

dataKitType 

  • Type: string

  • Required: No

  • Introduced: API version 63.0

  • Description: The type of data kit created. Valid values are:

    • Default
    • Sandbox

dataSpaceDefinitionDevName 

  • Type: string
  • Required: No
  • Introduced: API version 61.0
  • Description: Data space name used to create the data kit.

deploymentOrder 

  • Type: string
  • Required: No
  • Introduced: API version 61.0
  • Description: Deployment order of components that are added to the data kit.

description 

  • Type: string
  • Required: No
  • Description: The description of the data kit.

developerName 

  • Type: string
  • Required: Yes
  • Description: Required. The name of the application. This name 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 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the data kit content is deployed.

isEnabled 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the data kit is enabled.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. Label that identifies the AI application throughout the Salesforce user interface.

useDeterministicNaming 

  • Type: boolean
  • Required: No

versionNumber 

  • Type: double
  • Required: No
  • 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.