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

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	必須。ポータルユーザーに付与された対象オブジェクトへのアクセスレベル。有効な値は、次のとおりです。 `Read` `Edit`
objectField	string	必須。対象オブジェクトへのルックアップ。標準項目、カスタム項目、または ID がサポートされます。エンタイトルメントに関連付けられた取引先またはケースの場合は、`Entitlement.Account` または `Entitlement.Case` を使用します。
object	string	必須。ポータルユーザーがアクセス権を得る対象オブジェクト。次のいずれかを示します。 `Account` `Campaign` `Contact` `Case` カスタムオブジェクト (たとえば `ObjA__c`) `Opportunity` `Order` `ServiceContract` `User` `WorkOrder` ポータルユーザーには、アクセス権のある取引先のすべての注文エンタイトルメントおよび注文品目へのアクセス権が付与されます。
userField	string	必須。取引先または取引先責任者、あるいは、取引先や取引先責任者から取得された標準項目またはカスタム項目へのユーザーのルックアップ。ルックアップでは、ユーザーまたはユーザーのマネージャーを使用できます。有効な値は、次のとおりです。 `Account` `Account.Field` `Contact` `Contact.Field` `Contact.RelatedAccount` `Manager.Account` `Manager.Contact` `Field` は、取引先または取引先責任者に基づく標準項目またはカスタム項目を表します。

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

ユーザーの取引先責任者と一致する ReportsTo 項目を持つすべての取引先責任者へのアクセス権をユーザーに付与する SharingSet コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<SharingSet xmlns="http://soap.sforce.com/2006/04/metadata">
3  <accessMappings>
4    <accessLevel>Read</accessLevel>
5    <objectField>ReportsTo</objectField>
6    <object>Contact</object>
7    <userField>Contact</userField>
8  </accessMappings>
9  <description>User Access Mapping</description>
10  <name>User</name>
11  <profiles>customer community user</profiles>
12</SharingSet>

ユーザーの取引先に関連付けられた、エンタイトルメントに関連するすべてのケースへのアクセス権をユーザーに付与する SharingSet コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<SharingSet xmlns="http://soap.sforce.com/2006/04/metadata">
3  <name>Case</name>
4   <accessMappings>
5    <accessLevel>Edit</accessLevel>
6    <objectField>Entitlement.Account</objectField>
7    <object>Case</object>
8    <userField>Account</userField>
9  </accessMappings>
10</SharingSet>

SharingSet コンポーネントとアクセス権の対応付けのリストの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<SharingSet xmlns="http://soap.sforce.com/2006/04/metadata">
3  <description>This is a basic sharing set with several access mappings.</description>
4  <name>Basic</name>
5  <profiles>customer community user</profiles>
6  <accessMappings>
7    <accessLevel>Read</accessLevel>
8    <objectField>Id</objectField>
9    <object>Account</object>
10    <userField>Account</userField>
11  </accessMappings>
12  <accessMappings>
13    <accessLevel>Edit</accessLevel>
14    <objectField>Account</objectField>
15    <object>Contact</object>
16    <userField>Account</userField>
17  </accessMappings>
18  <accessMappings>
19    <accessLevel>Edit</accessLevel>
20    <objectField>Contact</objectField>
21    <object>Case</object>
22    <userField>Contact</userField>
23  </accessMappings>
24  <accessMappings>
25    <accessLevel>Read</accessLevel>
26    <objectField>AccountLookup__c</objectField>
27    <object>HVPUAccessible__c</object>
28    <userField>Account</userField>
29  </accessMappings>
30</SharingSet>

前の定義を参照する package.xml の例を次に示します。

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2  <fullName>SharingSetBasic</fullName>
3  <types>
4    <members>HVPUAccessible__c.AccountLookup__c</members>
5    <members>HVPUAccessible__c.ContactLookup__c</members>
6    <name>CustomField</name>
7  </types>
8  <types>
9    <members>HVPUAccessible__c</members>
10    <name>CustomObject</name>
11  </types>
12  <types>
13    <members>Basic</members>
14    <name>SharingSet</name>
15  </types>
16  <version>30.0</version>
17</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。