ExternalDataTranObject | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

ExternalDataTranObject components have the suffix .externalDataTranObject and are stored in the externalDataTranObjects folder.

Version

ExternalDataTranObject components are available in API version 55.0 and later.

Special Access Rules

ExternalDataTranObject is available only if Data Cloud is provisioned.

Fields

Field Name	Description
availabilityStatus	Field Type AvailabilityStatus (enumeration of type string) Description Required. Represents the availability of the object. Valid values are: `Available` `In_Use`
creationType	Field Type DefinitionCreationType (enumeration of type string) Description Required. Describes whether this object was added by the Customer or as part of a Standard Taxonomy or by the System. Valid values are: `Segment_Membership` `Activation_Audience` (Reserved for internal use only) `Custom` `Standard` `System` `Derived` `Bridge` `Curated` `Standard` Valid values available in API version 62.0 and later are: `ADG` `Calculated_Insight` `CG_Audience` `Chunk` `Directory_Table` `External` `Semantic` `Transform` `Vector_Embedding`
extDataTranObjectTemplate	Field Type string Description Reserved for internal use and read-only. Reference to the associated ExtDataTranObjectTemplate data kit object. The system populates this field when a data kit that contains a data stream is deployed.
externalDataTranFields	Field Type ExternalDataTranField Description Optional. Stores the fields related to that schema object.
masterLabel	Field Type string Description Required. The UI name for the object.
mktDataTranObject	Field Type MktDataTranObject Description Optional. An entity that is used to transport information from the source to a target.
objectCategory	Field Type string Description Required. Reference to the Object Category. For Transport, they're Profile, Engagement, or Other.

ExternalDataTranField

Stores the fields related to ExternalDataTranObject schema.

Field Name	Description
creationType	Field Type DefinitionCreationType (enumeration of type string). Description Required. Describes whether this object was added by the Customer or as part of a Standard Taxonomy or by the System. Valid values are: `Segment_Membership` `Custom` `Standard` `System` `Derived` `Bridge` `Curated`
datatype	Field Type string Description Required. Phone, currency, number, or other assigned type.
dateFormat	Field Type string Description Optional. The Date format of date, time, date/time fields in this Transport field.
extDataTranFieldTemplate	Field Type string Description Reserved for internal use and read-only. Reference to the associated ExtDataTranFieldTemplate data kit object. The system populates this field when a data kit that contains a data stream is deployed.
externalName	Field Type string Description Optional. Name of the object in the external system (different from Developer Name).
isCurrencyIsoCode	Field Type boolean Description Optional. If true, this field is a currency ISO code.
isDataRequired	Field Type boolean Description Optional. If true, data is required for this field.
length	Field Type int Description Optional. Length of a string column.
masterLabel	Optional. Field label.
mktDataTranField	Field Type mktDataTranFieldType Description Optional.
precision	Field Type int Description Optional. Used for currency and numeric accuracy.
primaryIndexOrder	Field Type int Description Optional. If supplied, indicates this field is part of the primary key where the number value (starting at 1) indicates the order of attributes if it's a compound primary key. Missing value means this field isn’t part of the primary key.
scale	Field Type int Description Optional. Used for currency and numbers.
sequence	Field Type int Description Optional. The sequence of this source schema.

MktDataTranField

Stores fields related to MktDataTranObject.

Field Name	Description
creationType	Field Type DefinitionCreationType (enumeration of type string). Description Required. Describes whether this object was added by the Customer or as part of a Standard Taxonomy or by the System. Valid values are: `Segment_Membership` `Custom` `Standard` `System` `Derived` `Bridge` `Curated` Valid values available in API version 62.0 and later are: `ADG` `Calculated_Insight` `CG_Audience` `Chunk` `Directory_Table` `External` `Semantic` `Transform` `Vector_Embedding`
datatype	Field Type string Description Required. Phone, currency, number, or other assigned type.
dateFormat	Field Type string Description Optional. The Date format of date, time, date/time fields in this Transport field.
externalName	Field Type string Description Optional. Name of the object in the external system (different from Developer Name).
isDataRequired	Field Type boolean Description Optional. If true, data is required for this field.
length	Field Type int Description Optional. Length of a string column.
masterLabel	Optional. Field label.
precision	Field Type int Description Optional. Used for currency and numeric accuracy.
primaryIndexOrder	Field Type int Description Optional. If supplied, indicates this field is part of the primary key where the number value (starting at 1) indicates the order of attributes if it's a compound primary key. Missing value means this field isn’t part of the primary key.
scale	Field Type int Description Optional. Used for currency and numbers.
sequence	Field Type int Description Optional. The sequence of this source schema.

Declarative Metadata Sample Definition

The following is an example of a ExternalDataTranObject component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalDataTranObject xmlns="http://soap.sforce.com/2006/04/metadata">
3    <CreationType>Custom</CreationType>
4    <DataConnectorId>1WMxx00000000mPGAQ</DataConnectorId>
5    <DeveloperName>Third_Identity_Create</DeveloperName>
6    <Language>en_US</Language>
7    <MasterLabel>Identity Create</MasterLabel>
8    <ObjectCategoryId>0hqxx000000009hAAA</ObjectCategoryId>
9    <Status>Available</Status>
10</ExternalDataTranObject>

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

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2    <types>
3        <members>*</members>
4        <name>ExternalDataTranObject</name>
5    </types>
6    <version>55.0</version>
7</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.