DataObjectBuildOrgTemplate

Represents the derived object template used to define the structure and configuration of data objects in a build organization. The object templates are added inside the data kit to deploy metadata.

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 

DataObjectBuildOrgTemplate components have the suffix .DataObjectBuildOrgTemplate and are stored in the DataObjectBuildOrgTemplate 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 object build org template. This name can contain only underscores and alphanumeric characters and must be unique in your org.

masterLabel 

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

objectDevName 

  • Type: string
  • Required: Yes
  • Description: Required. The developer name of the object created from the objectPayload entity in the build org.

objectPayload 

  • Type: string
  • Required: Yes
  • Description: Required. The serialized metadata for the entity. The build organization deserializes this payload to create the underlying metadata components.

objectType 

  • Type: string
  • Required: Yes
  • Description: Required. The type of metadata entity associated with the template. Valid values are:

templateObject 

  • Type: string
  • Required: Yes
  • Description: Required. The name of the template associated with the data object build org template.

templateVersion 

  • Type: int
  • Required: No

Declarative Metadata Sample Definition 

The following is an example of a DataObjectBuildOrgTemplate 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.