Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ExternalDataSource

Sunlight Search, which lets you access external data sources, including SharePoint data in Salesforce via external objects, is currently available as a beta feature. You can provide feedback and suggestions on the IdeaExchange. For information on enabling this feature for your organization, contact salesforce.com.

Note

Represents the metadata associated with an external data source. Create external data sources to manage connection details for integration with data sources outside of Salesforce. It extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ExternalDataSource components are stored in the dataSources directory of the corresponding package directory. ExternalDataSource components have the extension .dataSource, and the suffix is the name of the external data source.

Version

ExternalDataSource components are available in API version 28.0 and later.

Fields

Field Name Field Type Description
apiKey string The key to connect to the external data source.
certificate string Available only for SharePoint 2010 and 2007. If a security certificate is required, click the Certificate Lookup icon to search across active certificates created in Salesforce.
customConfiguration string A custom string used for configuring the data source.
endpoint string The URL which connects to the data source.
label string A user-friendly name for the data source displayed in the Salesforce user interface, such as in list views.

Examples include Acme Team Marketing Site, or Acme SharePoint.
oauthRefreshToken string The refreshed OAuth token. Used to obtain new access tokens for an existing end user during a specified period.
oauthScope string The scope of the access token as a list of space-delimited strings for permission settings that specifies access to a specific user's data.
oauthToken string The access token issued by your authorization server.
password string The password to be used by Salesforce to access the external source. Ensure that the credentials you use have adequate privileges to be able to access the data source, perform searches, and return information about the external data. Depending on how you set up access, you may need to provide the administrator password.
principalType ExternalPrincipal Type (enumeration of type string) The identity type used to authenticate to the data source outside Salesforce. On the External Data Source Setup and Edit pages, these selections are made from the Identity Type field. The valid values are:
  • Anonymous
  • PerUser
  • NamedUser
protocol Authentication Protocol (enumeration of type string) The protocol required to access the data source outside Salesforce. If your External Data Source is SharePoint, select Basic Authentication.The valid values are:
  • NoAuthentication
  • Oauth
  • Password
remoteIdentifier string Available beginning in API version 29.0. The server URL or default external repository.
repository string Used for SharePoint Online. If metadata is not accessible, use this field to create tables and default table fields.
type string The type of data source you want to connect to. The valid values are:
  • OData
  • Sharepoint
  • SharepointOnline
username string The username to be used by Salesforce to access the external source. Ensure that the credentials you use have adequate privileges to be able to access the data source, perform searches, and return information. Depending on how you set up access, you may need to provide the administrator username.
version string The version number of the data source you’re using.