メタデータ API 開発者ガイド
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
SharingRules
共有ルールのセットを表します。SharingRules を使用すると、対象ユーザグループのアクセスレベルを指定するルールを使用して、レコードをユーザのセットと共有できます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。詳細は、Salesforce オンラインヘルプの「共有ルールの概要」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
SharingRules は、対応するエンティティディレクトリに保存され、ファイル名はエンティティ名と一致します。たとえば、accountSharingRules ディレクトリには取引先共有ルールの Account.sharingRules ファイルが含まれます。カスタムオブジェクトの SharingRules は、customObjectSharingRules ディレクトリに保存されます。このディレクトリには、ObjA__c.sharingRules など、拡張子が .sharingRules のファイルが含まれます。ObjA はカスタムオブジェクト種別の開発者名を指します。
バージョン
SharingRules コンポーネントは、API バージョン 24.0 以降で使用できます。
項目
次の情報は、標準オブジェクトとカスタムオブジェクトの共有ルールの実装を理解していることを前提としています。これらの項目についての詳細は、Salesforce オンラインヘルプの「共有設定の概要」を参照してください。
| 項目 | データ型 | 説明 |
|---|---|---|
| fullName | string | API アクセスの一意の識別子。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
AccountSharingRules
取引先の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | AccountCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | AccountOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
CampaignSharingRules
キャンペーンの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | CampaignCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | CampaignOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
CaseSharingRules
ケースの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | CaseCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | CaseOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
ContactSharingRules
取引先責任者の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | ContactCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | ContactOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
LeadSharingRules
リードの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | LeadCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | LeadOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
OpportunitySharingRules
商談の共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | OpportunityCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | OpportunityOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
AccountTerritorySharingRules
取引先テリトリーの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| rules | AccountTerritorySharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。sharedFrom 項目の許容値のリストは次のとおりです。
|
CustomObjectSharingRules
カスタムオブジェクトの共有ルールを表します。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | CustomObjectCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| ownerRules | CustomObjectOwnerSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
UserSharingRules
ユーザの共有ルールを表します。ユーザの共有ルールでは、グループのメンバーを別のグループのメンバーと共有できます。SharingRules メタデータ型を拡張し、その fullName 項目を継承します。
| 項目 | データ型 | 説明 |
|---|---|---|
| criteriaBasedRules | UserCriteriaBasedSharingRule[] | ユーザの条件に基づくルールを定義するリスト。 |
| membershipRules | UserMembershipSharingRule[] | ユーザのメンバーシップに基づくルールを定義するリスト。 |
宣言的なメタデータの定義のサンプル
2 つの取引先所有者に基づく共有ルールの定義を次に示します。ファイル名は、accountSharingRules ディレクトリ下の Account.sharingRules に対応します。この定義では、ownerRules が AccountOwnerSharingRule に対応します。
1<?xml version="1.0" encoding="UTF-8"?>
2<AccountSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
3 <ownerRules>
4 <fullName>G1Dev_G2New</fullName>
5 <sharedFrom>
6 <group>G1Dev</group>
7 </sharedFrom>
8 <sharedTo>
9 <group>G2New</group>
10 </sharedTo>
11 <accountAccessLevel>Read</caseAccessLevel>
12 <caseAccessLevel>None</caseAccessLevel>
13 <contactAccessLevel>Read</contactAccessLevel>
14 <name>G1Dev_G2New</name>
15 <opportunityAccessLevel>Edit</opportunityAccessLevel>
16 </ownerRules>
17 <ownerRules>
18 <fullName>G2New_R1New</fullName>
19 <sharedFrom>
20 <group>G2New</group>
21 </sharedFrom>
22 <sharedTo>
23 <roleAndSubordinates>R1New</roleAndSubordinates>
24 </sharedTo>
25 <accountAccessLevel>Edit</accountAccessLevel>
26 <caseAccessLevel>Read</caseAccessLevel>
27 <contactAccessLevel>Edit</contactAccessLevel>
28 <name>G2New_R1New</name>
29 <opportunityAccessLevel>None</opportunityAccessLevel>
30 </ownerRules>
31</AccountSharingRules>ユーザの条件に基づく共有ルールとユーザのメンバーシップに基づく共有ルールの定義を次に示します。ファイル名は、userSharingRules ディレクトリ下の User.sharingRules に対応します。
1<?xml version="1.0" encoding="UTF-8"?>
2<UserSharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
3 <criteriaBasedRules>
4 <fullName>shareUsers2</fullName>
5 <sharedTo>
6 <group>Asia_Division</group>
7 </sharedTo>
8 <criteriaItems>
9 <field>FirstName</field>
10 <operation>equals</operation>
11 <value>John</value>
12 </criteriaItems>
13 <name>shareUsers2</name>
14 <userAccessLevel>Read</userAccessLevel>
15 </criteriaBasedRules>
16 <membershipRules>
17 <fullName>shareUsers1</fullName>
18 <sharedTo>
19 <group>South_America_Division</group>
20 </sharedTo>
21 <sharedFrom>
22 <group>Asia_Division</group>
23 </sharedFrom>
24 <name>shareUsers1</name>
25 <userAccessLevel>Read</userAccessLevel>
26 </membershipRules>
27</UserSharingRules>package.xml ファイルのサンプルを次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>UserRule</members>
5 <name>UserCriteriaBasedSharingRule</name>
6 </types>
7 <types>
8 <members>*</members>
9 <name>UserMembershipSharingRule</name>
10 </types>
11 <version>32.0</version>
12</Package>