ExternalDataSource | メタデータ API 開発者ガイド

外部データソースに関連付けられたメタデータを表します。外部データソースを作成して、Salesforce 組織の外部に保存されているデータおよびコンテンツとのインテグレーションに関する接続の詳細を管理します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

ExternalDataSource コンポーネントは、対応するパッケージディレクトリの dataSources ディレクトリに保存されます。ExternalDataSource コンポーネントにはサフィックス .dataSource があり、プレフィックスは外部データソースの名前です。

バージョン

ExternalDataSource コンポーネントは、API バージョン 28.0 以降で使用できます。

項目

項目名	データ型	説明
apiKey	string	将来の使用のために予約されています。
authProvider	string	AuthProvider コンポーネントで表される認証プロバイダ。
certificate	string	証明書を指定する場合、Salesforce 組織が、各外部システムとの双方向 SSL 接続確立時に証明書を提供します。この証明書は、要求がユーザの組織からのものであることを確認するデジタル署名に使用されます。
customConfiguration	string	外部データソースの type に固有の設定パラメータの文字列。 Lightning Connect (Salesforce アダプタ) の customConfiguration Lightning Connect (OData 2.0 アダプタ) の customConfiguration Lightning Connect (カスタムアダプタ) の customConfiguration
endpoint	string	外部システムの URL。ユーザインターフェースの URL に対応します。
label	string	ユーザにわかりやすい外部データソースの名前。表示ラベルは、リストビューなどの Salesforce ユーザインターフェースに表示されます。たとえば、Acme Team Marketing Site や Acme SharePoint などです。
oauthRefreshToken	string	OAuth 更新トークン。古いトークンの期限が切れたときに、エンドユーザの新しいアクセストークンを取得するために使用します。
oauthScope	string	アクセストークンを要求するための権限の範囲を指定します。ユーザインターフェースの [範囲] に対応します。
oauthToken	string	外部システムによって発行されるアクセストークン。
password	string	外部システムにアクセスするために組織で使用するパスワード。使用するログイン情報に、外部システムにアクセスしたり、検索を実行したり、データを返したり、外部システムのメタデータに関する情報を返したりするのに十分な権限があることを確認してください。
principalType	`ExternalPrincipalType` (string 型の列挙)	外部システムへのアクセスに 1 セットのログイン情報と複数セットのログイン情報のどちらを使用するかを決定します。ユーザインターフェースの [ID 種別] に対応します。有効な値は、次のとおりです。 `Anonymous` `PerUser` `NamedUser`
protocol	`AuthenticationProtocol` (string 型の列挙)	外部システムへのアクセスに必要な認証プロトコル。有効な値は、次のとおりです。 `NoAuthentication` `Oauth` `Password` クラウドベースの Files Connect 外部システムにアクセスするには、[Oauth 2.0] を選択します。社内システムの場合、[パスワード認証] を選択します。単純な URL データソースの場合、[認証なし] を選択します。
repository	string	SharePoint Online に使用します。メタデータにアクセスできない場合、この項目を使用してテーブルとデフォルトのテーブル項目を作成します。
type	`ExternalDataSourceType` (string 型の列挙)	Lightning Connect の場合、外部システムに接続するアダプタを指定します。有効な値は、次のとおりです。 `OData` — OData 2.0 アダプタ `SfdcOrg` — Salesforce アダプタ `ApexClassId` — Apex コネクタフレームワーク経由で作成されたカスタムアダプタを定義する `DataSource.Provider` クラス Files Connect の場合、データソース種別を指定します。有効な値は、次のとおりです。 `ContentHubSharepoint` — SharePoint 2010 または 2013 `ContentHubSharepointOffice365` — SharePoint Online `ContentHubSharepointOneDrive` — OneDrive for Business `ContentHubGDrive` — Google ドライブ Chatter が有効になっている場合、`SimpleURL` を指定して、認証を必要としない Web サーバでホストされているデータにアクセスすることもできます。 `Identity` および `Wrapper` 種別は、将来の使用のために予約されています。
username	string	外部システムにアクセスするために組織で使用するユーザ名。使用するログイン情報に、外部システムにアクセスしたり、検索を実行したり、データを返したり、外部システムのメタデータに関する情報を返したりするのに十分な権限があることを確認してください。
version	string	将来の使用のために予約されています。

Lightning Connect (Salesforce アダプタ) の customConfiguration

次の JSON 符号化された設定文字列の例では、外部データソースの type が SfdcOrg に設定されている場合に適用されるパラメータを定義します。

1{"apiVersion":"32.0","environment":"CUSTOM",
2"searchEnabled":"true","timeout":"120"}

パラメータは、ユーザインターフェースの次の項目に対応します。

apiVersion — [API バージョン]
environment — [接続先]
searchEnabled — [Salesforce 検索に含まれる]
timeout — [接続タイムアウト]

Lightning Connect (OData 2.0 アダプタ) の customConfiguration

次の JSON 符号化された設定文字列の例では、外部データソースの type が OData に設定されている場合に適用されるパラメータを定義します。

1{"compatibility":"DEFAULT","noIdMapping":"false",
2"inlineCountEnabled":"true","searchEnabled":"true",
3"format":"ATOM","requestCompression":"false",
4"pagination":"SERVER","timeout":"120"}

パラメータは、ユーザインターフェースの次の項目に対応します。

compatibility — [特殊な互換性]
format — [形式]
inlineCountEnabled — [要求の行数]
noIdMapping — [大量データ]
pagination — [サーバ駆動のページ設定]
requestCompression — [圧縮要求]
searchEnabled — [Salesforce 検索に含まれる]
searchFunc — [Salesforce 検索のカスタムクエリオプション]
timeout — [接続タイムアウト]

Lightning Connect (カスタムアダプタ) の customConfiguration

次の JSON 符号化された設定文字列の例では、外部データソースの type が DataSource.Provider クラスの ID に設定されている場合に適用されるパラメータを定義します。

1{"noIdMapping":"false"}

noIdMapping パラメータは、ユーザインターフェースの [高データボリューム] 項目に対応します。

宣言的なメタデータの定義のサンプル

Lightning Connect (OData 2.0 アダプタ) の外部データソースの定義を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
3    <authProvider>FacebookAuth</authProvider>
4    <customConfiguration>{"compatibility":"DEFAULT",
5    "noIdMapping":"false","inlineCountEnabled":"true",
6    "searchEnabled":"true","format":"ATOM",
7    "requestCompression":"false","pagination":"SERVER",
8    "timeout":"120"}</customConfiguration>
9    <endpoint>http://myappname.herokuapp.com/DataHub.svc</endpoint>
10    <label>DataHub</label>
11    <principalType>NamedUser</principalType>
12    <protocol>Oauth</protocol>
13    <type>OData</type>
14</ExternalDataSource>