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. We maintained certain terms to avoid any effect on customer implementations.

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 (enumeration of type string) Indicates whether you’re connected to a data source. Valid values are:
  • Connected
  • Disconnected
  • Failed
dataConnectorConfiguration string Reference to the Data Connector Configuration that is used to retrieve or receive data such as DataConnectorS3.
dataConnectorType DataConnectorType (enumeration of type string) Type of connection such as AmazonS3. Valid values are:
  • ACCOUNTENGAGEMENT
  • AmazonS3
  • CuratedEntity
  • DataCloud
  • ExternalPlatform
  • GoogleCloudStorage
  • IngestApi
  • SalesforceCommerceCloud
  • SalesforceDotCom
  • SalesforceInteractionStudio
  • SalesforceMarketingCloud
  • SFTP
  • StreamingApp
  • UPLOAD
dataPlatform string Reference to the Data Platform that provides or uses this data, such as Amazon_S3.
externalDataTranObjects ExternalDataTranObject Stores the schema objects related to the data connector. Available in API version 56.0 and later.
masterLabel string Required. The UI name for the ExternalDataConnector.

Declarative Metadata Sample Definition

The following is an example of a ExternalDataConnector component.

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