MacroSettings

Represents an organization’s Macro settings, such as whether or not folders is enabled. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

MacroSettings values are stored in the Macro.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

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

Version

MacroSettings is available in API version 39.0 and later.

Fields

Field Name Field Type Description
enableAdvancedSearch boolean Indicates whether users can search all macro text fields (true) or not (false).
macrosInFolders boolean Indicates whether users can organize and share macros using folders (true) or not (false). Available in API version 44.0 and later.

Declarative Metadata Sample Definition

This is a sample Macro settings file.

<?xml version="1.0" encoding="UTF-8"?>
<MacroSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAdvancedSearch>true</enableAdvancedSearch>
    <macrosInFolders>true</macrosInFolders>
</MacroSettings>

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.