ExternalDataTranObject

Represents a definition of a schema object.

This type extends Metadata and inherits its fields.

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

Introduced in API version 55.0.

ExternalDataTranObject is available only if is provisioned.

• Type: AvailabilityStatus (enumeration of type string)

• Required: Yes

• Description: Required.

  Represents the availability of the object.

• Possible values:

  • Available
  • In_Use

• Type: DefinitionCreationType (enumeration of type string)

• Required: Yes

• Description: Required.

  Describes whether this object was added by the Customer or as part of a Standard Taxonomy or by the System.

  Valid values available in API version 62.0 and later are:

• Possible values:

  • Segment_Membership
  • Activation_Audience — (Reserved for internal use only)
  • Custom
  • Standard
  • System
  • Derived
  • Bridge
  • Curated
  • ADG
  • Calculated_Insight
  • CG_Audience
  • Chunk
  • Directory_Table
  • External
  • Semantic
  • Transform
  • Vector_Embedding

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

• Type: ExternalDataTranField[]

• Required: No

• Description: Optional.

  Stores the fields related to that schema object.

• Type: string

• Required: Yes

• Description: Required.

  The UI name for the object.

• Type: string

• Required: No

• Description: Optional.

  An entity that is used to transport information from the source to a target.

• Type: string

• Required: Yes

• Description: Required.

  Reference to the Object Category. For Transport, they’re Profile, Engagement, or Other.

Stores the fields related to ExternalDataTranObject schema.

This type extends Metadata and inherits its fields.

• Type: DefinitionCreationType (enumeration of type string)

• Required: No

• Description: Required.

  Describes whether this object was added by the Customer or as part of a Standard Taxonomy or by the System.

• Possible values:

  • Segment_Membership
  • Custom
  • Standard
  • System
  • Derived
  • Bridge
  • Curated

• Type: string

• Required: Yes

• Description: Required.

  Phone, currency, number, or other assigned type.

• Type: string

• Required: No

• Description: Optional.

  The Date format of date, time, date/time fields in this Transport field.

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

• Type: string

• Required: No

• Description: Optional.

  Name of the object in the external system (different from Developer Name).

• Type: boolean

• Required: No

• Description: Optional.

  If true, this field is a currency ISO code.

• Type: boolean

• Required: No

• Description: Optional.

  If true, data is required for this field.

• Type: int

• Required: No

• Description: Optional.

  Length of a string column.

• Type: string
• Required: Yes
• Description: Optional. Field label.

• Type: string
• Required: No
• Description: Optional.

• Type: int

• Required: No

• Description: Optional.

  Used for currency and numeric accuracy.

• Type: int

• Required: No

• 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.

• Type: int

• Required: No

• Description: Optional.

  Used for currency and numbers.

• Type: int

• Required: No

• Description: Optional.

  The sequence of this source schema.

Stores fields related to MktDataTranObject.

This type extends Metadata and inherits its fields.

• Type: DefinitionCreationType (enumeration of type string)

• Required: Yes

• Description: Required.

  Describes whether this object was added by the Customer or as part of a Standard Taxonomy or by the System.

  • Segment_Membership
  • Custom
  • Standard
  • System
  • Derived
  • Bridge
  • Curated
  • Valid values available in API version 62.0 and later are:

• Possible values:

  • Standard
  • Custom
  • System
  • Derived
  • Bridge
  • Curated
  • Segment_Membership
  • Calculated_Insight
  • Ml_Prediction
  • Activation_Audience
  • CG_Audience
  • Ad_Audience_Insights
  • Transform
  • ADG
  • External
  • Vector_Embedding
  • Chunk
  • Directory_Table
  • Semantic
  • Problem_Records
  • Clean_Room
  • Deletion_Records
  • Auxiliary

• Type: string

• Required: Yes

• Description: Required.

  Phone, currency, number, or other assigned type.

• Type: string

• Required: No

• Description: Optional.

  The Date format of date, time, date/time fields in this Transport field.

• Type: string

• Required: No

• Description: Optional.

  Name of the object in the external system (different from Developer Name).

• Type: boolean

• Required: No

• Description: Optional.

  If true, data is required for this field.

• Type: int

• Required: No

• Description: Optional.

  Length of a string column.

• Type: int

• Required: No

• Description: Optional.

  Used for currency and numeric accuracy.

• Type: int

• Required: No

• 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.

• Type: int

• Required: No

• Description: Optional.

  Used for currency and numbers.

• Type: int

• Required: No

• Description: Optional.

  The sequence of this source schema.

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        <fullName>PlatformTraces</fullName>
4        <availabilityStatus>Available</availabilityStatus>
5        <creationType>Custom</creationType>
6        <masterLabel>PlatformTraces</masterLabel>
7        <objectCategory>Salesforce_SFDCReferenceModel_0_93.Engagement</objectCategory>
8</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>

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.