この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

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

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

ExternalDataSource

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

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

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

バージョン

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

項目

項目名 データ型 説明
apiKey string 将来の使用のために予約されています。
authProvider string AuthProvider コンポーネントで表される認証プロバイダ。
certificate string Lightning Connect と SharePoint 2010 および 2007 で使用できます。証明書を指定する場合、Salesforce が、各外部システムへの接続確立時に、指定された認証方式に加えて証明書を提供します。この証明書は、要求がユーザの組織からのものであることを確認するデジタル署名に使用されます。
customConfiguration string データソースの構成に使用されるカスタム文字列。
たとえば、次の JSON コード化された設定文字列では、type が OData に設定されている場合に適用されるパターンを定義します。
1{"noIdMapping":"false","searchFunc":"",
2"searchEnabled":"true","format":"ATOM",
3"requestCompression":"true","timeout":"120"}
パラメータは、ユーザインターフェースの次の項目に対応します。
  • noIdMapping — [大量データ]
  • searchFunc �� [Salesforce 検索のカスタムクエリオプション]
  • searchEnabled — [Salesforce 検索に含まれる]
  • format — [形式]
  • requestCompression — [圧縮要求]
  • timeout — [接続タイムアウト]
endpoint string データソースのサービス URL またはルート URL。ユーザインターフェースの URL に対応します。
label string リストビューなどの Salesforce ユーザインターフェースに表示される、データソースのわかりやすい名前。

たとえば、Acme Team Marketing Site や Acme SharePoint などです。
oauthRefreshToken string OAuth 更新トークン。古いトークンの期限が切れたときに、エンドユーザの新しいアクセストークンを取得するために使用します。
oauthScope string アクセストークンの範囲。特定のユーザデータへのアクセス権を指定する権限セットが、スペースで区切られた文字列のリストとして示されています。ユーザインターフェースの [範囲] に対応します。
oauthToken string 権限サーバによって発行されるアクセストークン。
password string 外部システムにアクセスするために組織で使用するパスワード。使用するログイン情報に、データソースへのアクセス、検索の実行、外部データに関する情報の復帰を行うための十分な権限があることを確認してください。アクセスの設定方法によっては、システム管理者のパスワードの指定を必要とする場合があります。
principalType External​PrincipalType​ (string 型の列挙) 外部システムの認証用の ID 種別。ユーザインターフェースの [ID 種別] に対応します。有効な値は、次のとおりです。
  • Anonymous
  • PerUser
  • NamedUser
protocol Authentication​Protocol​ (string 型の列挙) Salesforce 外のデータソースへのアクセスに必要なプロトコル。外部データソースが SharePoint の場合、[基本認証] を選択します。有効な値は、次のとおりです。
  • NoAuthentication
  • Oauth
  • Password
repository string SharePoint Online に使用します。メタデータにアクセスできない場合、この項目を使用してテーブルとデフォルトのテーブル項目を作成します。
type ExternalData​SourceType​ (string 型の列挙) 接続先であるデータソースのタイプ。有効な値は、次のとおりです。
  • ID
  • OData
  • SimpleURL
username string 外部システムにアクセスするために組織で使用するユーザ名。使用するログイン情報に、データソースへのアクセス、検索の実行、情報の復帰を行うための十分な権限があることを確認してください。アクセスの設定方法によっては、システム管理者のユーザ名の指定を必要とする場合があります。
version string 使用しているデータソースのバージョン番号。

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

Lightning Connect の外部データソースの定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalDataSource xmlns="http://soap.sforce.com/2006/04/metadata">
3    <authProvider>FacebookAuth</authProvider>
4    <customConfiguration>{"noIdMapping":"false",
5    "searchFunc":"","searchEnabled":"true","format":"ATOM",
6    "requestCompression":"true","timeout":"120"}</customConfiguration>
7    <endpoint>http://myappname.herokuapp.com/DataHub.svc</endpoint>
8    <label>DataHub</label>
9    <principalType>NamedUser</principalType>
10    <protocol>Oauth</protocol>
11    <type>OData</type>
12</ExternalDataSource>