SharingSet
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
たとえば、ポータルユーザーまたはコミュニティユーザーに、その取引先レコードに関連するすべてのケースへのアクセス権を付与できます。同様に、ポータルユーザーまたはコミュニティユーザーに、そのユーザーの取引先レコードで識別される親取引先に関連するすべてのケースへのアクセス権をユーザーに付与できます。
ファイルのサフィックスおよびディレクトリの場所
SharingSet コンポーネントのサフィックスは .sharingSet で、sharingSets フォルダーに保存されます。
バージョン
SharingSet コンポーネントは、API バージョン 30.0 以降で使用できます。
特別なアクセスルール
Spring ’20 以降、このオブジェクトにアクセスできるのは、「設定・定義を参照する」権限を持つユーザーのみとなります。また、このオブジェクトを編集できるのは、「共有の管理」権限を持つユーザーのみとなります。共有セットを作成または更新するには、「アプリケーションのカスタマイズ」権限が必要です。
共有セットは、次のライセンスで使用できます。
- 認証 Web サイト
- Customer Community Login
- カスタマーコミュニティプラス
- パートナーコミュニティ
- カスタマーコミュニティユーザー
- High Volume Customer Portal
- 大規模ポータル
- Overage Authenticated Website ユーザー
- Overage High Volume Customer Portal ユーザー
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| accessMappings | AccessMapping[] | 共有セットのアクセス権の対応付けのリスト。 |
| description | string | 共有セットの説明。最大 255 文字です。 |
| name | string | 必須。API アクセスの一意の識別子。ユーザーインターフェースの [共有セット名] に対応します。 |
| profiles | string[] | 対象オブジェクトへのアクセス権を付与されたユーザーのプロファイル。プロファイルは、共有セットを使用できるライセンスに関連付けられている必要があります。詳細は、「特別なアクセスルール」を参照してください。 |
AccessMapping
AccessMapping は、共有セットのアクセス権の対応付けを表します。これにより、ユーザーに関連付けられた取引先または取引先責任者をルックアップして、対象オブジェクトへのアクセス権が付与されます。
対象オブジェクト、または対象オブジェクトとそれに関連付けられたオブジェクトの両方 (取引先とその取引先責任者およびケースなど) へのアクセス権をポータルユーザーに付与できれます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| accessLevel | string | 必須。ポータルユーザーに付与された対象オブジェクトへのアクセスレベル。有効な値は、次のとおりです。
|
| objectField | string | 必須。対象オブジェクトへのルックアップ。標準項目、カスタム項目、または ID がサポートされます。エンタイトルメントに関連付けられた取引先またはケースの場合は、Entitlement.Account または Entitlement.Case を使用します。 |
| object | string | 必須。ポータルユーザーがアクセス権を得る対象オブジェクト。次のいずれかを示します。
ポータルユーザーには、アクセス権のある取引先のすべての注文エンタイトルメントおよび注文品目へのアクセス権が付与されます。 |
| userField | string | 必須。取引先または取引先責任者、あるいは、取引先や取引先責任者から取得された標準項目またはカスタム項目へのユーザーのルックアップ。ルックアップでは、ユーザーまたはユーザーのマネージャーを使用できます。有効な値は、次のとおりです。
Field は、取引先または取引先責任者に基づく標準項目またはカスタム項目を表します。 |
宣言的なメタデータの定義のサンプル
ユーザーの取引先責任者と一致する ReportsTo 項目を持つすべての取引先責任者へのアクセス権をユーザーに付与する SharingSet コンポーネントの例を次に示します。
ユーザーの取引先に関連付けられた、エンタイトルメントに関連するすべてのケースへのアクセス権をユーザーに付与する SharingSet コンポーネントの例を次に示します。
SharingSet コンポーネントとアクセス権の対応付けのリストの例を次に示します。
前の定義を参照する package.xml の例を次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。