メタデータ API 開発者ガイド
jExternalDataSource
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
ExternalDataSource コンポーネントは、対応するパッケージディレクトリの dataSources ディレクトリに保存されます。ExternalDataSource コンポーネントにはサフィックス .dataSource があり、プレフィックスは外部データソースの名前です。
バージョン
ExternalDataSource コンポーネントは、API バージョン 28.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| authProvider | string | AuthProvider コンポーネントで表される認証プロバイダ。 |
| certificate | string | 証明書を指定する場合、Salesforce 組織が、各外部システムとの双方向 SSL 接続確立時に証明書を提供します。この証明書は、要求がユーザの Salesforce 組織からのものであることを確認するデジタル署名に使用されます。 |
| customConfiguration | string | 外部データソースの type に固有の設定パラメータの文字列。 |
| customHttpHeader | CustomHttpHeader[] | OData 2.0 または OData 4.0 コネクタで使用されるカスタム HTTP ヘッダーを表します。API バージョン 43.0 以降で使用できます。 |
| endpoint | string | 外部システムの URL。または、指定ログイン情報でその URL が定義されている場合は、指定ログイン情報 URL。ユーザインターフェースの URL に対応します。 指定ログイン情報 URL にはスキームcallout:、指定ログイン情報の名前、必要に応じて追加されたパスが含まれます。例: callout:My_Named_Credential/some_path。 クエリ文字列を指定ログイン情報 URL に追加できます。指定ログイン情報 URL とクエリ文字列の間の区切り文字として疑問符 (?) を使用します。たとえば、callout:My_Named_Credential/some_path?format=json です。 |
| isWritable | boolean |
この組織の Lightning プラットフォームとユーザが、外部データソースに関連付けられている外部オブジェクトのレコードの作成、更新、削除ができるようにします。外部オブジェクトデータは組織外に保存されます。デフォルトでは、外部オブジェクトは参照のみです。ユーザインターフェースの [書き込み可能外部オブジェクト] に対応します。 API バージョン 35.0 以降で使用できます。ただし、API バージョン 39.0 以降でのみ、Salesforce Connect の組織間アダプタを使用して、この項目を true に設定できます。 |
| label | string | ユーザにわかりやすい外部データソースの名前。表示ラベルは、リストビューなどの Salesforce ユーザインターフェースに表示されます。 たとえば、Acme Team Marketing Site や Acme SharePoint などです。 |
| oauthRefreshToken | string | OAuth 更新トークン。トークンの期限が切れたときに、エンドユーザの新しいアクセストークンを取得するために使用します。 |
| oauthScope | string | アクセストークンを要求するための権限の範囲を指定します。ユーザインターフェースの [範囲] に対応します。 |
| oauthToken | string | 外部システムによって発行されるアクセストークン。 |
| password | string | 外部システムにアクセスするために組織で使用するパスワード。使用するログイン情報に、外部システムにアクセスしたり、検索を実行したり、データを返したり、外部システムのメタデータに関する情報を返したりするのに十分な権限があることを確認してください。 |
| principalType | ExternalPrincipalType (string 型の列挙) | 外部システムへのアクセスに 1 セットのログイン情報と複数セットのログイン情報のどちらを使用するかを決定します。ユーザインターフェースの [ID 種別] に対応します。有効な値は、次のとおりです。
|
| protocol | AuthenticationProtocol (string 型の列挙) | 外部システムへのアクセスに必要な認証プロトコル。有効な値は、次のとおりです。
クラウドベースの Files Connect 外部システムにアクセスするには、[Oauth 2.0] を選択します。社内システムの場合、[パスワード認証] を選択します。 単純な URL データソースの場合、[認証なし] を選択します。 |
| repository | string | SharePoint Online に使用します。メタデータにアクセスできない場合、この項目を使用してテーブルとデフォルトのテーブル項目を作成します。 |
| type | ExternalDataSourceType (string 型の列挙) | Salesforce Connect の場合、外部システムに接続するアダプタを指定します。有効な値は、次のとおりです。
Files Connect の場合、データソース種別を指定します。有効な値は、次のとおりです。
Chatter が有効になっている場合、SimpleURL を指定して、認証を必要としない Web サーバでホストされているデータにアクセスすることもできます。 Identity および Wrapper 種別は、将来の使用のために予約されています。 統合検索の外部データソース型の有効な値は OpenSearch です。 |
| username | string | 外部システムにアクセスするために組織で使用するユーザ名。使用するログイン情報に、外部システムにアクセスしたり、検索を実行したり、データを返したり、外部システムのメタデータに関する情報を返したりするのに十分な権限があることを確認してください。 |
| version | string | 将来の使用のために予約されています。 |
CustomHttpHeader
OData 2.0 または OData 4.0 コネクタで使用されるカスタム HTTP ヘッダーを表します。API バージョン 43.0 以降で使用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | カスタム HTTP ヘッダーの説明。 |
| headerFieldName | string | 必須。カスタム HTTP ヘッダー項目の説明。 |
| headerFieldValue | string | 必須。数式から派生したカスタム HTTP ヘッダー項目の値。 |
| isActive | boolean | カスタム HTTP ヘッダー項目が有効か (true) 無効か (false) を指定します。 |
Salesforce Connect (組織間アダプタ) の customConfiguration
- apiVersion — [API バージョン]
- environment — [接続先]
- searchEnabled — [検索の有効化]
- timeout — [接続タイムアウト]
Salesforce Connect (OData 2.0 または 4.0 アダプタ) の customConfiguration
- compatibility — [特殊な互換性]
- csrfTokenEnabled — [CSRF 保護]
- csrfTokenName — [対 CSRF トークン名]
- format — [形式]
- inlineCountEnabled — [要求の行数]
- noIdMapping — [大量データ]
- pagination — [サーバ駆動のページ設定]
- requestCompression — [圧縮要求]
- searchEnabled — [検索の有効化]
- searchFunc — [Salesforce 検索のカスタムクエリオプション]
- timeout — [接続タイムアウト]
Salesforce Connect (カスタムアダプタ) の customConfiguration
noIdMapping パラメータは、ユーザインターフェースの [高データボリューム] 項目に対応します。