メタデータ API 開発者ガイド
jSharingSet
共有セットを表します。共有セットでは、アクセス権の対応付けを定義して、ポータルユーザまたはコミュニティユーザに、取引先または取引先責任者に関連付けられたオブジェクトへのアクセス権を付与します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
たとえば、ポータルユーザまたはコミュニティユーザに、その取引先レコードに関連するすべてのケースへのアクセス権を付与できます。同様に、ポータルユーザまたはコミュニティユーザに、そのユーザの取引先レコードで識別される親取引先に関連するすべてのケースへのアクセス権をユーザに付与できます。詳細は、Salesforce ヘルプの「共有セットの概要」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
SharingSet コンポーネントのサフィックスは .sharingSet であり、sharingSets フォルダに保存されます。
バージョン
SharingSet コンポーネントは、API バージョン 30.0 以降で��用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| 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 コンポーネントの例を次に示します。
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>