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

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

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

バージョン

OrgPreferenceSettings は、API バージョン 37.0 から 47.0 で使用できます。

OrgPreferenceSettings は、API バージョン 47.0 で廃止され、API バージョン 48.0 で削除されました。API バージョン 47.0 では、preferences 項目でサポートされているほとんどの設定が、他の設定種別の Boolean 項目の形式で利用できるようになり��した。たとえば、API バージョン 47.0 以降では、ApexSettings 型の enableCompileOnDeploy 項目を使用することにより、CompileOnDeploy 設定を有効または無効にできます。

項目

項目名	項目の型	説明
preferences	OrganizationSettingsDetail[]	組織設定に関連付けられている設定。次の設定のリストで、ハイパーリンクの設定名をクリックすれば、その設定を含む設定種別のトピックに移動します。リンクがない場合、設定は別の設定種別には移動されていません。 `AnalyticsSharingEnable` (API バージョン 40.0 以降で使用可能) `ApexApprovalLockUnlock` `AsyncSaveEnabled` (API バージョン 40.0 ～ 46.0 で使用可能です) `ChatterEnabled` `CompileOnDeploy` (API バージョン 43.0 以降で使用可能) `ConsentManagementEnabled` (API バージョン 45.0 以降で使用可能) `EnhancedEmailEnabled` `EventLogWaveIntegEnabled` `LoginForensicsEnabled` `NetworksEnabled` (API バージョン 40.0 以降で使用可能) `NotesReservedPref01` `OfflineDraftsEnabled` `PathAssistantsEnabled` `S1DesktopEnabled` 有効にすると、`S1DesktopEnabled` はどのバージョンの API でも無効にすることはできません。メモ `S1EncryptedStoragePref2` `S1OfflinePref` `ScratchOrgManagementPref` (API バージョン 41.0 以降で使用可能) `SendThroughGmailPref` `SocialProfilesEnable` `Translation` (API バージョン 40.0 以降で使用可能) `VoiceEnabled` `VoiceEnabled` 設定は別のメタデータ種別に移動されていません。API バージョン 48.0 以降のスクラッチ組織で使用する場合は、スクラッチ組織機能として有効化できます。メモ

OrganizationSettingsDetail

項目名	項目の型	説明
settingName	string	設定の名前。たとえば、「S1EncryptedStoragePref2」になります。
settingValue	boolean	設定が有効化されているか (`true`)、否か (`false`) を示します。

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

OrgPreferenceSettings コンポーネントの例を次に示します。この例は、サポートされているが API バージョン 47.0 の別の設定種別の項目としてはまだ使用できない preferences の値のみを示しています。

1<?xml version="1.0" encoding="UTF-8"?>
2<OrgPreferenceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <preferences>
4        <settingName>AnalyticsSharingEnable</settingName>
5        <settingValue>true</settingValue>
6    </preferences>
7    <preferences>
8        <settingName>NetworksEnabled</settingName>
9        <settingValue>true</settingValue>
10    </preferences>
11    <preferences>
12        <settingName>NotesReservedPref01</settingName>
13        <settingValue>false</settingValue>
14    </preferences>
15    <preferences>
16        <settingName>ScratchOrgManagementPref</settingName>
17        <settingValue>true</settingValue>
18    </preferences>
19    <preferences>
20        <settingName>VoiceEnabled</settingName>
21        <settingValue>false</settingValue>
22    </preferences>
23</OrgPreferenceSettings>

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

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