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

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

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

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

バージョン

UserInterfaceSettings コンポーネントは、API バージョン 46.0 以降で使用できます。

項目

項目名	項目の型	説明
enableAsyncRelatedLists	boolean	関連リストが非同期に読み込まれるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。API バージョン 47.0 以降で利用できます。Salesforce Classic のみ
enableClickjackUserPageHeaderless	boolean	標準ヘッダーを非表示にする Visualforce ページにクリックジャック保護があるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。この設定は、すべての Visualforce ページに適用されます。
enableCollapsibleSections	boolean	レコード詳細で、ユーザがセクションヘッダーの横にある矢印アイコンを使用して、セクションの折りたたみや展開を行えるかどうかを示します。デフォルトは `true` です。
enableCollapsibleSidebar	boolean	ユーザが、折りたたみ可能な各ページのサイドバーを表示または非表示にすることができるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。Salesforce Classic にのみ適用されます。
enableCustomObjectTruncate	boolean	「アプリケーションのカスタマイズ」権限を持つユーザがカスタムオブジェクトを切り捨てることができるか (`true`)、否か (`false`) を示します。オブジェクトを切り捨てると、オブジェクトの関連レコードが完全に削除されますが、空のオブジェクトとそのメタデータは保持されます。デフォルトは `false` です。API バージョン 47.0 以降で利用できます。
enableCustomSidebarOnAllPages	boolean	この組織で、すべての組織ユーザが、すべてのページでカスタムサイドバーコンポーネントを使用できるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。Salesforce Classic にのみ適用されます。
enableDeleteFieldHistory	boolean	ユーザが項目履歴および項目履歴アーカイブレコードを削除できるか (`true`)、否か (`false`) を示します。デフォルトは `false` です。API バージョン 47.0 以降で利用できます。
enableExternalObjectAsyncRelatedLists	boolean	外部オブジェクトの関連リストが非同期に読み込まれるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。API バージョン 48.0 以降で利用できます。Salesforce Classic のみ
enableHoverDetails	boolean	レコードの詳細が含まれる対話形式のフロート表示が表示されるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。レコードの詳細のフロート表示を参照するには、ユーザに適切な共有アクセス権、およびミニページレイアウトの項目の項目レベルセキュリティアクセス権が必要です。メモ
enableInlineEdit	boolean	ユーザがレコードの詳細ページの項目値を編集できるか (`true`)、否か (`false`) を示します。デフォルトは `true` です。
enablePersonalCanvas	boolean	ユーザが個人用キャンバスアプリケーションをインストールおよび使用できるか `(true)`、否か `(false)` を示します。デフォルトは `true` です。この設定は、すべての Visualforce ページに適用されます。
enableQuickCreate	boolean	ユーザが最小限の情報でレコードを簡単に作成できる ([簡易作成を表示] 設定に対応する) 領域がタブのホームページに表示されるか (`true`)、否か (`false`) を示します。[簡易作成] 領域はデフォルトで、[リード]、[取引先]、[取引先責任者]、[商談] タブのホームページに表示されます。[簡易作成] 領域を、関連するすべてのタブのホームページに表示するかどうかを制御できます。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<UserInterfaceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3  <enableDeleteFieldHistory>false</enableDeleteFieldHistory>
4  <enableInlineEdit>true</enableInlineEdit>
5  <enableHoverDetails>false</enableHoverDetails>
6  <enableQuickCreate>true</enableQuickCreate>
7  <enablePersonalCanvas>false</enablePersonalCanvas>
8  <enableClickjackUserPageHeaderless>true</enableClickjackUserPageHeaderless>
9</UserInterfaceSettings>

パッケージマニフェストの例

組織のユーザインターフェース設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。

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

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

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