ExternalDataConnector

Used to represent the object where the data was sourced.

This type extends Metadata and inherits its fields.

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

Introduced in API version 50.0.

You need the Salesforce CustomizeApplication permission to access this object.

• Type: DataConnectionStatus (enumeration of type string)
• Required: Yes
• Description: Indicates whether you’re connected to a data source.
• Possible values:
  • Connected
  • Disconnected
  • Failed

• Type: string
• Required: Yes
• Description: Reference to the Data Connector Configuration that is used to retrieve or receive data such as DataConnectorS3.

• Type: DataConnectorType (enumeration of type string)
• Required: Yes
• Description: Type of connection such as AmazonS3.
• Possible values:
  • ACCOUNTENGAGEMENT
  • AmazonS3
  • CuratedEntity
  • DataCloud
  • ExternalPlatform
  • GoogleCloudStorage
  • IngestApi
  • SalesforceCommerceCloud
  • SalesforceDotCom
  • SalesforceInteractionStudio
  • SalesforceMarketingCloud
  • SFTP
  • StreamingApp
  • UPLOAD

• Type: string
• Required: Yes
• Description: Reference to the Data Platform that provides or uses this data, such as Amazon_S3.

• Type: ExternalDataTranObject[]
• Required: No
• Introduced: API version 56.0
• Description: Stores the schema objects related to the data connector.

• Type: string
• Required: Yes
• Description: Required. The UI name for the ExternalDataConnector.

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>