DataConnector | 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

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DataConnector components have the suffix .dataconnector and are stored in the dataconnectors folder.

Version

DataConnector components are available in API version 64.0 and later.

Special Access Rules

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

Fields

Field Name	Description
attributes	Field Type DataConnectorAttribute[] Description A list of configurable attributes for the data connector.
description	Field Type string Description Required. The description of the data connector.
errors	Field Type DataConnectorError[] Description A list of error messages or codes related to the connector’s behavior or configuration validation.
features	Field Type DataConnectorFeature[] (enumeration of type string) Description A list of features supported by the data connector. Values are: `Override`
icon	Field Type string Description A static resource in SVG format with dimensions of 100x100 pixels and a file size not exceeding 100 KB.
licenseAgreement	Field Type string Description Text of the license agreement associated with the data connector.
masterLabel	Field Type string Description Required. The display label of the connector used in user interface (UI).
ownerLocation	Field Type string Description A description or URL that specifies where the connector is maintained or hosted.
ownerLogo	Field Type string Description A static resource in SVG format with dimensions of 100x100 pixels and a file size not exceeding 100 KB.
ownerName	Field Type string Description The name of the organization that owns the connector.
parentConnector	Field Type string Description The API name of the connector. For example, AwsS3, SNOWFLAKE, ICEBERG, and so on.
releaseLevel	Field Type DataConnectorReleaseLevel (enumeration of type string) Description Required. Indicates the connector’s lifecycle stage. Values are: `BETA` `GA` `IN_DEV` `PILOT`
supportEmail	Field Type string Description The support email address users can contact for help with the connector.
supportMessage	Field Type string Description A support-related message or instruction displayed.
supportPhone	Field Type string Description The support phone number users can call for help with the connector.
translations	Field Type LocalizedValue[] Description A list of localized labels and descriptions to support multiple languages in the UI.

DataConnectorAttribute

Field Name	Description
capabilities	Field Type DataConnectorCapability[] (enumeration of type string) Description A list of supported capabilities for the data connector. Values are: `DataIn` `DataInDelete` `DataInHeader` `DataInIncremental` `DataInSelector` `DataInStructured` `DataInUnstructured` `DataOut` `Hidden` `UniqueGroup` `ZeroCopyIn`
command	Field Type string Description The command string executed during data operations, such as import or sync.
commandAttributes	Field Type string Description A list of attributes passed with the command.
dataType	Field Type DataConnectorDataType (enumeration of type string) Description Required. Specifies the type of data input expected. Values are: `CHECKBOX` `COMBOBOX` `DATE` `DATETIME` `EMAIL` `IDP` `NAMED_CREDENTIAL` `NUMBER` `PASSWORD` `PASSWORD_FILE` `PRIVATE_NETWORK_ROUTE` `RADIO` `RADIO_BUTTONS` `TEXT` `TEXTAREA` `TIME` `TOGGLE`
defaultValue	Field Type string Description The default value assigned to the field if no user input is provided.
editable	Field Type boolean Description Indicates whether the field value can be modified by the user.
externalName	Field Type string Description Required. The unique name used to reference the connector externally, such as in API calls.
masterLabel	Field Type string Description Required. The label used for display in the UI.
max	Field Type string Description The maximum allowable value or length for the field.
min	Field Type string Description The minimum allowable value or length for the field.
options	Field Type DataConnectorAttributeOpt[] Description A list of selectable options available for the field.
order	Field Type int Description Required. The display order or evaluation order of the field.
pattern	Field Type string Description The validation pattern used to ensure input follows a defined format.
placeholder	Field Type string Description The placeholder text displayed in the input field when empty.
readonly	Field Type boolean Description Indicates whether the field is read-only.
required	Field Type boolean Description Indicates whether the field must have a value.
secure	Field Type boolean Description Indicates whether the field contains sensitive data and should be masked.
tooltip	Field Type string Description The tooltip text shown to users for additional guidance.
translations	Field Type LocalizedValue[] Description A list of localized labels and descriptions for use in different languages.
validationMessageError	Field Type string Description The error message shown when input validation fails for this field.

DataConnectorAttributeOpt

Field Name	Description
capabilities	Field Type DataConnectorCapability[] (enumeration of type string) Description A list of capabilities supported by the data connector. Values are: `DataIn` `DataInDelete` `DataInHeader` `DataInIncremental` `DataInSelector` `DataInStructured` `DataInUnstructured` `DataOut` `Hidden` `UniqueGroup` `ZeroCopyIn`
conditionAttributes	Field Type string Description A list of attributes used to define conditions in the connector configuration.
externalName	Field Type string Description Required. The unique name used to reference the connector externally, such as in API calls.
masterLabel	Field Type string Description Required. The display label for the connector used in the UI.
order	Field Type int Description Required. The order or priority of the connector in processing context.
translations	Field Type LocalizedValue[] Description A list of localized labels and descriptions for use in different languages.

DataConnectorError

Field Name	Description
externalName	Field Type string Description Required. The unique name used to reference the object externally, such as in API calls. Must be unique across the namespace.
masterLabel	Field Type string Description Required. The label displayed in the UI.
translations	Field Type LocalizedValue[] Description A list of localized labels and descriptions for use in different languages.

Declarative Metadata Sample Definition

The following is an example of a DataConnector component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DataConnector xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>Iceberg Override</masterLabel>
4    <icon>Salesforce</icon>
5    <parentConnector>ICEBERG</parentConnector>
6    <releaseLevel>BETA</releaseLevel>
7    <description>Connect to Apache Iceberg tables</description>
8    <features>Override</features>
9    <ownerName>Slack</ownerName>
10    <ownerLogo>Salesforce</ownerLogo>
11    <ownerLocation>Settle, USA</ownerLocation>
12    <supportMessage>Click download logs before reachout</supportMessage>
13    <supportPhone>+15788467513</supportPhone>
14    <licenseAgreement>https://www.salesforce.com/company/legal</licenseAgreement>
15    <attributes>
16        <fullName>IcebergOverride_storageSourceType</fullName>
17        <externalName>storageSourceType</externalName>
18        <masterLabel>Storage Type</masterLabel>
19        <dataType>COMBOBOX</dataType>
20        <defaultValue>CATALOG_PROVIDED</defaultValue>
21        <capabilities>DataIn</capabilities>
22        <capabilities>Hidden</capabilities>
23        <order>20</order>
24        <editable>true</editable>
25        <required>true</required>
26        <secure>true</secure>
27    </attributes>
28</DataConnector>

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>*</members>
5        <name>DataConnector</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>StaticResource</name>
10    </types>
11    <version>64.0</version>
12</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.