UserInterfaceSettings | Metadata API Developer Guide

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

File Suffix and Directory Location

A UserInterfaceSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

UserInterfaceSettings components are available in API version 46.0 and later.

Fields

Field Name	Field Type	Description
enableAsyncRelatedLists	boolean	Indicates whether related lists are loaded asynchronously (`true`) or not (`false`). The default is `false`. Available in API version 47.0 and later. Salesforce Classic only.
enableClickjackUserPageHeaderless	boolean	Indicates whether a Visualforce page that hides the standard header has clickjack protections (`true`) or not (`false`). The default is `true`. This setting applies to all of your Visualforce pages.
enableCollapsibleSections	boolean	Indicates whether users are allowed to collapse or expand sections in record details by using the arrow icon next to the section heading. The default is `true`.
enableCollapsibleSidebar	boolean	Indicates whether users are allowed to show or hide the sidebar on every page that normally includes it (`true`) or not (`false`). The default is `false`. Applies to Salesforce Classic only.
enableCustomObjectTruncate	boolean	Indicates whether users with Customize Application permission can truncate custom objects (`true`) or not (`false`). When you truncate an object, you delete the object’s associated records permanently, while preserving the empty object and its metadata. The default is `false`. Available in API version 47.0 and later.
enableCustomSidebarOnAllPages	boolean	Indicates whether custom sidebar components are available on all pages for all org users (`true`) or not (`false`). The default is `false`. Applies to Salesforce Classic only.
enableDeleteFieldHistory	boolean	Indicates whether users can delete field history and field history archive records (`true`) or not (`false`). The default is `false`. Available in API version 47.0 and later.
enableExternalObjectAsyncRelatedLists	boolean	Indicates whether related lists of external objects are loaded asynchronously ( `true`) or not (`false`). The default is `true`. Available in API version 48.0 and later. Salesforce Classic only.
enableHoverDetails	boolean	Indicates whether an interactive overlay containing record details is displayed (`true`) or not (`false`). The default is `true`. To view hover details for a record, users need the appropriate sharing access and field-level security access for the fields in the mini page layout. Note
enableInlineEdit	boolean	Indicates whether users are allowed to edit field values on a record’s detail page (`true`) or not (`false`). The default is `true`.
enablePersonalCanvas	boolean	Indicates whether users can install and use personal canvas apps `(true)` or not `(false)`. The default is `true`. This setting applies to all of your Visualforce pages.
enableRelatedListHovers	boolean	Indicates whether related list hover links display at the top of record detail pages and custom object detail pages in Setup (`true`) or not (`false`). Users can hover over a related list link to display the list and its number of records in an interactive overlay. Users quickly view and manage the related list items from the overlay. Users can also click a related list hover link to jump to the related list without having to scroll down the page. The default is `true`. Available in API version 50.0 and later.
enableQuickCreate	boolean	Indicates whether an area displays on a tab home page ( corresponds to the Show Quick Create setting), allowing users to create a record quickly with minimal information (`true`) or not (`false`). The Quick Create area displays by default on the tab home pages for leads, accounts, contacts, and opportunities. You can control whether the Quick Create area is displayed on all relevant tab home pages.

Declarative Metadata Sample Definition

The following is an example of a UserInterfaceSettings component.

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>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the user interface settings metadata for an organization:

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

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.