FlowSettings Metadata Type in SFDX

Architectural Overview#

FlowSettings is a vital organizational configuration file under the Settings metadata umbrella that governs core execution policies, security models, and deployment behaviors for Salesforce Flow. As Salesforce continues to consolidate declarative automation on Flow as the primary engine, configuring FlowSettings correctly in scratch org definitions and deployment pipelines is a cornerstone of enterprise CI/CD reliability.

One of the most consequential capabilities controlled by FlowSettings is enableFlowDeployAsActive. Without this setting enabled, automated deployment pipelines targeting test environments or production sandboxes deploy new flow versions in Draft status, breaking automated integration testing and requiring manual intervention.

Directory and File Conventions#

In Salesforce DX projects, FlowSettings is stored within the settings/ folder as a single singleton file representing the Flow domain.

Key Metadata Fields#

The XML schema for FlowSettings provides several operational controls:

Declarative XML and Package Manifest Examples#

Below is a production-hardened Flow.settings-meta.xml configuration for enterprise CI/CD pipelines:

<?xml version="1.0" encoding="UTF-8"?>
<FlowSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableFlowDeployAsActive>true</enableFlowDeployAsActive>
    <enableFlowInterviewSharingEnabled>true</enableFlowInterviewSharingEnabled>
    <isFlowActiveSetting>true</isFlowActiveSetting>
</FlowSettings>

Scratch Org Configuration (config/project-scratch-def.json)#

{
  "orgName": "Enterprise Automation Scratch Org",
  "edition": "Enterprise",
  "settings": {
    "flowSettings": {
      "enableFlowDeployAsActive": true,
      "enableFlowInterviewSharingEnabled": true,
      "isFlowActiveSetting": true
    }
  }
}

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage FlowSettings using Salesforce CLI:

# Retrieve Flow settings from an org
sf project retrieve start --metadata Settings:Flow

# Deploy Flow settings to an automated scratch org
sf project deploy start --metadata Settings:Flow

Architect Best Practices and Gotchas#

• Scratch Org Bootstrapping: Always include flowSettings with enableFlowDeployAsActive: true in your project-scratch-def.json file. This prevents scratch org creation scripts from failing when deploying active record-triggered flows.
• Apex Test Requirements: When deploying active flows to production, Salesforce enforces that test classes achieve code coverage across any @InvocableMethod Apex classes called by the flows.
• Security Implications of Interview Sharing: Leaving enableFlowInterviewSharingEnabled disabled permits users to view and resume paused interviews initiated by other users if they possess the Run Flows permission.

Frequently asked questions

What is the role of enableFlowDeployAsActive in FlowSettings?

When enabled, it permits automated CI/CD deployment pipelines to deploy flows directly in an Active status without requiring manual administrative activation.

Where is FlowSettings stored within an SFDX repository structure?

FlowSettings is stored as force-app/main/default/settings/Flow.settings-meta.xml and retrieved as Settings member Flow in package.xml manifests.

What testing requirements apply when deploying flows in Active status to production?

Production environments require sufficient Apex test coverage across all active Apex invocable actions and processes invoked by deployed flows.