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

パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所

SharingSettings 値は、settings ディレクトリの Sharing.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

SharingSettings は、API バージョン 47.0 以降で使用できます。

特別なアクセスルール

SharingSettings を使用するには、「共有の管理」権限が必要です。

項目

項目名	項目の型	説明
deferGroupMembership	boolean	グループメンバーシップの計算が一時停止されるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。この項目は、API バージョン 49.0 以降で使用できます。共有適用の延期機能は、デフォルトでは有効になっていません。この機能を Salesforce 組織で有効にするには、Salesforce カスタマーサポートまでお問い合わせください。この項目の値を `true` から `false` に変更すると、グループメンバーシップが自動的に再計算されます。deferGroupMembership を変更する前に deferSharingRules 項目を `true` に設定していない限り、共有ルールも自動的に再計算されます。組織によってはこの再計算が完了するまでにかなりの時間を要します。 deferGroupMembership 項目が `true` に設定されている場合、deferSharingRules の値を変更することはできません。共有ルールの計算は、deferSharingRules の値に関係なく一時停止されます。重要
deferSharingRules	boolean	共有ルールの計算が一時停止されるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。この項目は、API バージョン 49.0 以降で使用できます。共有適用の延期機能は、デフォルトでは有効になっていません。この機能を Salesforce 組織で有効にするには、Salesforce カスタマーサポートまでお問い合わせください。この項目の値を `true` から `false` に変更すると、共有ルールが自動的に再計算されます。組織によってはこの再計算が完了するまでにかなりの時間を要します。 deferGroupMembership 項目が `true` に設定されている場合、deferSharingRules の値を変更することはできません。共有ルールの計算は、deferSharingRules の値に関係なく一時停止されます。重要
enableAccountRoleOptimization	boolean	既存のユーザーのいない取引先の新しいサイトユーザーに個人ロールが割り当てられるか (`true`)、新規ユーザーの通常のサイトロールが作成されるか (`false`) を示します。この項目のデフォルト値は `false` です。
enableAssetSharing	boolean	納入商品の共有が有効化されるか (`true`)、納入商品のアクセス権が親オブジェクトの共有ルールによって決定されるか (`false`) を示します。この項目のデフォルト値は `false` です。
enableCommunityUserVisibility	boolean	組織の共有設定に関係なく、同じサイトのサイトユーザーがお互いを参照できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。API バージョン 47.0 以降で作成された組織の場合、この設定はゲストユーザーに適用されません。
enableExternalSharingModel	boolean	外部共有モデルが有効化されるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は、Salesforce 環境が有効になっている場合は `true` になり、有効になっていない場合は `false` になります。この項目を使用するには、「アプリケーションのカスタマイズ」権限が必要です。
enableManagerGroups	boolean	ユーザーがマネージャーおよびマネージャーの下位グループとレコードを共有できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。この項目を使用するには、「ユーザーの表示および管理」権限が必要です。
enableManualUserRecordSharing	boolean	ユーザーが各自のユーザーレコードを共有できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。
enablePartnerSuperUserAccess	boolean	スーパーユーザーアクセスをサイトのパートナーに付与できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。この項目を使用するには、「アプリケーションのカスタマイズ」権限が必要です。
enablePortalUserCaseSharing	boolean	ポータルユーザーが所有するケースの関連取引先責任者にアクセスできるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。
enablePortalUserVisibility	boolean	組織の共有設定に関係なく、同じカスタマーまたはパートナーポータル取引先のポータルユーザーがお互いを参照できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。この項目を有効化する場合は、Salesforce サポートにお問い合わせください。
enableRemoveTMGroupMembership	boolean	`true` に設定すると、エンタープライズテリトリー管理に移行した後に、元のテリトリー管理機能のグループメンバーシップ情報が削除されます。この項目のデフォルト値は `false` です。一度この項目を `true` に設定すると、再度 `false` に設定することはできません。
enableRestrictAccessLookupRecords	boolean	参照項目やシステム項目でレコードの名前を表示するためにユーザーにレコードへの読み取りアクセス権が必要か (`true`)、否か (`false`) を示します。この項目のデフォルト値は、Spring ’20 以降に作成された Salesforce 組織では `true` になり、その他のすべての組織では `false` になります。この項目は、API バージョン 48.0 以降で使用できます。
enableSecureGuestAccess	boolean	`true` の場合、ゲストユーザーの組織全体のデフォルトは [非公開] に設定されます。ゲストユーザーとレコードを共有するには、ゲストユーザー共有ルールを使用する必要があります。 API バージョン 50.0 以降では、この項目の値は自分で設定した値に関係なく常に `true` になります。この値を変更して `false` と表示されていたとしても、Salesforce に対しては効果がありません。この変更は、この項目が最初に導入された API バージョン 47.0 まで遡って適用されます。以前は、API バージョン 47.0 から 49.0 では、この項目はゲストユーザーのレコードアクセス権が保護されているか (`true`)、否か (`false`) を示していて、項目のデフォルト値は `false` でした。現在はすべての API バージョンでこの項目の値は `false` と表示されていたとしても常に `true` になります。
enableStandardReportVisibility	boolean	ユーザーがアクセス権を持っていないユーザーのデータを公開している可能性のある標準レポートのタイプに基づいて、それらのユーザーがレポートを表示できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。
enableTerritoryForecastManager	boolean	売上予測マネージャーが階層の下位のテリトリーの代理管理者として機能できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。

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

SharingSettings コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<SharingSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <deferGroupMembership>false</deferGroupMembership>
4    <deferSharingRules>false</deferSharingRules>
5    <enableAccountRoleOptimization>false</enableAccountRoleOptimization>
6    <enableAssetSharing>false</enableAssetSharing>
7    <enableCommunityUserVisibility>false</enableCommunityUserVisibility>
8    <enableExternalSharingModel>true</enableExternalSharingModel>
9    <enableManagerGroups>false</enableManagerGroups>
10    <enableManualUserRecordSharing>true</enableManualUserRecordSharing>
11    <enablePartnerSuperUserAccess>false</enablePartnerSuperUserAccess>
12    <enablePortalUserCaseSharing>false</enablePortalUserCaseSharing>
13    <enablePortalUserVisibility>true</enablePortalUserVisibility>
14    <enableRemoveTMGroupMembership>false</enableRemoveTMGroupMembership>
15    <enableRestrictAccessLookupRecords>true</enableRestrictAccessLookupRecords>
16    <enableSecureGuestAccess>true</enableSecureGuestAccess>
17    <enableStandardReportVisibility>false</enableStandardReportVisibility>
18    <enableTerritoryForecastManager>false</enableTerritoryForecastManager>
19</SharingSettings>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Sharing</members>
5        <name>Settings</name>
6    </types>   
7    <version>47.0</version>
8</Package>

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

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。