ExternalDataConnector

Used to represent the object where the data was sourced.

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

File Suffix and Directory Location

ExternalDataConnector components have the suffix externalDataConnector and are stored in the externalDataConnectors folder.

Version

ExternalDataConnector components are available in API version 50.0 and later.

Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

Fields

Field Name	Field Type	Description
dataConnectionStatus	DataConnectionStatus	Indicates whether you are connected to a data source.
dataConnectorConfiguration	string	Reference to the Data Connector Configuration that is used to retrieve or receive data such as DataConnectorS3.
dataConnectorType	DataConnectorType	Type of connection such as AmazonS3.
dataPlatform	string	Reference to the Data Platform that providing/using this data such as Amazon_S3.
masterLabel	string	Required. The UI name for the ExternalDataConnector.

Declarative Metadata Sample Definition

The following is an example of a ExternalDataConnector component.

1<?xml version="1.0" encoding="UTF-8"?>
2        <ExternalDataConnector xmlns="http://soap.sforce.com/2006/04/metadata">
3        <dataConnectionStatus>Connected</dataConnectionStatus>
4        <dataConnectorConfiguration>Person</dataConnectorConfiguration>
5        <dataConnectorType>AmazonS3</dataConnectorType>
6        <dataPlatform>Amazon_S3</dataPlatform>
7        <masterLabel>AmazonS3</masterLabel>
8        </ExternalDataConnector>

Metadata API Developer Guide