DataConnector

Represents the white-labeled metadata configuration for an external connector in .

This type extends Metadata and inherits its fields.

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

Introduced in API version 64.0.

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

• Type: DataConnectorAttribute[]
• Required: No
• Description: A list of configurable attributes for the data connector.

• Type: string

• Required: Yes

• Description: Required.

  The description of the data connector.

• Type: DataConnectorError[]
• Required: No
• Description: A list of error messages or codes related to the connector’s behavior or configuration validation.

• Type: DataConnectorFeature (enumeration of type string)[]

• Required: No

• Description: A list of features supported by the data connector.

  Values are:

  Override

• Type: string
• Required: No
• Description: A static resource in SVG format with dimensions of 100x100 pixels and a file size not exceeding 100 KB.

• Type: string
• Required: No
• Description: Text of the license agreement associated with the data connector.

• Type: string

• Required: Yes

• Description: Required.

  The display label of the connector used in user interface (UI).

• Type: string
• Required: No
• Description: A description or URL that specifies where the connector is maintained or hosted.

• Type: string
• Required: No
• Description: A static resource in SVG format with dimensions of 100x100 pixels and a file size not exceeding 100 KB.

• Type: string
• Required: No
• Description: The name of the organization that owns the connector.

• Type: string
• Required: No
• Description: The API name of the connector. For example, AwsS3, SNOWFLAKE, ICEBERG, and so on.

• Type: DataConnectorReleaseLevel (enumeration of type string)

• Required: Yes

• Description: Required.

  Indicates the connector’s lifecycle stage.

  Values are:

• Possible values:

  • BETA
  • GA
  • IN_DEV
  • PILOT

• Type: string
• Required: No
• Description: The support email address users can contact for help with the connector.

• Type: string
• Required: No
• Description: A support-related message or instruction displayed.

• Type: string
• Required: No
• Description: The support phone number users can call for help with the connector.

• Type: LocalizedValue[]
• Required: No
• Description: A list of localized labels and descriptions to support multiple languages in the UI.

This type extends Metadata and inherits its fields.

• Type: DataConnectorCapability (enumeration of type string)[]

• Required: No

• Description: A list of supported capabilities for the data connector.

  Values are:

• Possible values:

  • DataIn
  • DataInDelete
  • DataInHeader
  • DataInIncremental
  • DataInSelector
  • DataInStructured
  • DataInUnstructured
  • DataOut
  • Hidden
  • UniqueGroup
  • ZeroCopyIn

• Type: string
• Required: No
• Description: The command string executed during data operations, such as import or sync.

• Type: string
• Required: No
• Description: A list of attributes passed with the command.

• Type: DataConnectorDataType (enumeration of type string)

• Required: Yes

• Description: Required.

  Specifies the type of data input expected.

  Values are:

• Possible values:

  • CHECKBOX
  • COMBOBOX
  • DATE
  • DATETIME
  • EMAIL
  • IDP
  • NAMED_CREDENTIAL
  • NUMBER
  • PASSWORD
  • PASSWORD_FILE
  • PRIVATE_NETWORK_ROUTE
  • RADIO
  • RADIO_BUTTONS
  • TEXT
  • TEXTAREA
  • TIME
  • TOGGLE

• Type: string
• Required: No
• Description: The default value assigned to the field if no user input is provided.

• Type: boolean
• Required: No
• Description: Indicates whether the field value can be modified by the user.

• Type: string

• Required: Yes

• Description: Required.

  The unique name used to reference the connector externally, such as in API calls.

• Type: string

• Required: Yes

• Description: Required.

  The label used for display in the UI.

• Type: string
• Required: No
• Description: The maximum allowable value or length for the field.

• Type: string
• Required: No
• Description: The minimum allowable value or length for the field.

• Type: DataConnectorAttributeOpt[]
• Required: No
• Description: A list of selectable options available for the field.

• Type: int

• Required: Yes

• Description: Required.

  The display order or evaluation order of the field.

• Type: string
• Required: No
• Description: The validation pattern used to ensure input follows a defined format.

• Type: string
• Required: No
• Description: The placeholder text displayed in the input field when empty.

• Type: boolean
• Required: No
• Description: Indicates whether the field is read-only.

• Type: boolean
• Required: No
• Description: Indicates whether the field must have a value.

• Type: boolean
• Required: No
• Description: Indicates whether the field contains sensitive data and should be masked.

• Type: string
• Required: No
• Description: The tooltip text shown to users for additional guidance.

• Type: LocalizedValue[]
• Required: No
• Description: A list of localized labels and descriptions for use in different languages.

• Type: string
• Required: No
• Description: The error message shown when input validation fails for this field.

This type extends Metadata and inherits its fields.

• Type: DataConnectorCapability (enumeration of type string)[]

• Required: No

• Description: A list of capabilities supported by the data connector.

  Values are:

• Possible values:

  • DataIn
  • DataInDelete
  • DataInHeader
  • DataInIncremental
  • DataInSelector
  • DataInStructured
  • DataInUnstructured
  • DataOut
  • Hidden
  • UniqueGroup
  • ZeroCopyIn

• Type: string
• Required: No
• Description: A list of attributes used to define conditions in the connector configuration.

• Type: string

• Required: Yes

• Description: Required.

  The unique name used to reference the connector externally, such as in API calls.

• Type: string

• Required: Yes

• Description: Required.

  The display label for the connector used in the UI.

• Type: int

• Required: Yes

• Description: Required.

  The order or priority of the connector in processing context.

• Type: LocalizedValue[]
• Required: No
• Description: A list of localized labels and descriptions for use in different languages.

This type extends Metadata and inherits its fields.

• Type: string

• Required: Yes

• Description: Required.

  The unique name used to reference the object externally, such as in API calls. Must be unique across the namespace.

• Type: string

• Required: Yes

• Description: Required.

  The label displayed in the UI.

• Type: LocalizedValue[]
• Required: No
• Description: A list of localized labels and descriptions for use in different languages.

• Type: TranslationAspect (enumeration of type string)
• Required: No

• Type: string
• Required: No

• Type: boolean
• Required: No

• Type: string
• Required: No

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>

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.