MacroSettings Metadata Type in SFDX

Architectural Overview#

MacroSettings configures organization-wide behaviors for Salesforce Macros. Macros automate repetitive agent workflows—such as inserting standard email templates, updating case statuses, logging call outcomes, and creating follow-up tasks—with a single click or keyboard shortcut in the Service and Sales Console.

From an architect’s perspective, MacroSettings establishes enterprise productivity and governance policies. Activating bulk macros allows support reps to resolve dozens of related cases simultaneously, while enabling folder sharing prevents macro sprawl by allowing administrators to organize macros into role-restricted folders with fine-grained view and edit permissions.

Directory and File Conventions#

MacroSettings is a singleton Settings metadata asset stored in the settings directory:

Key Metadata Fields#

The MacroSettings schema provides governance controls:

Declarative XML and Package Manifest Examples#

Below is an enterprise configuration of Macro.settings-meta.xml:

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

Manifest Definition (package.xml)#

Include the setting in package.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Macro</members>
        <name>Settings</name>
    </types>
    <version>68.0</version>
</Package>

CLI Retrieval and Deployment Commands#

Use the Salesforce CLI to deploy macro settings:

# Retrieve Macro settings
sf project retrieve start --metadata Settings:Macro

# Deploy macro settings across environments
sf project deploy start --source-dir force-app/main/default/settings/Macro.settings-meta.xml

Senior Architect Deployment Best Practices and Gotchas#

• Bulk Macro Irreversibility: Because bulk macros execute database modifications across up to 50 records in parallel, ensure adequate validation rules and apex triggers are in place to prevent bulk data corruption.
• Folder Migration: When migrating from flat macro sharing to enhanced folder sharing (enableMacroFolderSharing = true), existing unfiled public macros must be reorganized into folders, which can alter URL references in custom documentation.
• Console Utility Bar Placement: Enabling macro settings is only half the implementation. For users to access macros efficiently, add the Macros standard component to the Lightning Console Utility Bar in your target CustomApplication metadata.

Frequently asked questions

Where is MacroSettings stored in source format?

It resides in the settings directory within the file Macro.settings-meta.xml.

What does the enableBulkMacros setting do?

It permits agents to execute a single macro across multiple records simultaneously from list views in Service and Sales Console.

How does enableMacroFolderSharing improve governance?

It replaces flat public sharing with hierarchical folder-based permissions for organizing and restricting macro access.

Do macros require specific object permissions?

Yes, users need Read and Create access on the Macro standard object in addition to org settings enablement.