DataKitObjectTemplate

Represents the object in Data Kit Object Template. These object templates are added inside the data kit.

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 

DataKitObjectTemplate components have the suffix .DataKitObjectTemplate and are stored in the DataKitObjectTemplate folder.

Version 

Introduced in API version 63.0.

Special Access Rules 

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

Fields 

developerName 

  • Type: string
  • Required: Yes
  • Description: Required. Name of the data kit object template. This 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.

entityPayload 

  • Type: string
  • Required: No
  • Description: A string-based JSON payload containing the metadata of a data kit component. The payload is templatized to enable variable substitution during the deployment process. Keep the compressed JSON payload under 100 KB. Data 360 automatically compresses the payload before storage. but, compression results vary depending on the structure of the data. A payload that’s under 100 KB before compression can exceed the limit after compression. If the compressed payload exceeds 100 KB, reduce the payload size or split the component.

entityPayloadTokenMap 

  • Type: string
  • Required: No

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. The label of the data kit object template.

parentDataPackageKitDefinitionName 

  • Type: string
  • Required: Yes
  • Description: Required. The linked data kit package definition in the data kit.

sourceObject 

  • Type: string
  • Required: No
  • Description: The developer name of the source object for the data kit object template.

sourceObjectType 

  • Type: string
  • Required: Yes
  • Description: Required. The object type of the metadata component in the data kit. Valid values are:

templateVersion 

  • Type: int
  • Required: No

Declarative Metadata Sample Definition 

The following is an example of a DataKitObjectTemplate component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DataKitObjectTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3   <developerName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
4   <entityPayload>
5      {
6         "dataSpaceName": "default",
7         "type": "DLO",
8         "developerName": "DLO_StaticCurrencyRates_Home"
9      }
10   </entityPayload>
11   <masterLabel>StaticCurrencyRates_Home__dll</masterLabel>
12   <parentDataPackageKitDefinitionName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
13   <sourceObject>0viSB00000JzG05YAF</sourceObject>
14   <sourceObjectType>DataSpaceMember</sourceObjectType>
15   <templateVersion>1</templateVersion>
16</DataKitObjectTemplate>

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    <types>
4        <members>StaticCurrencyRates_Home</members>
5        <members>StaticCurrencyRates_Home1</members>
6        <name>DataKitObjectTemplate</name>
7    </types>
8    <version>64.0</version>
9</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.