MfgServiceConsoleSettings Metadata Type in SFDX

Architectural Overview#

The MfgServiceConsoleSettings metadata type represents the organizational toggle for the Service Console for Manufacturing. Built on the Salesforce Lightning Service Console foundation, this industry-specific solution empowers customer service representatives (CSRs) in manufacturing enterprises with a unified 360-degree view of connected assets, active service agreements, extended warranties, related cases, and replacement orders.

From a DevOps and systems architecture standpoint, MfgServiceConsoleSettings acts as an essential deployment prerequisite. Attempting to deploy customized Manufacturing Service Console Lightning Record Pages (FlexiPage), console navigation tabs, or industry-specific actions into an environment where this setting is disabled triggers dependency validation failures during CI/CD execution.

Directory and File Conventions#

Following the standard Salesforce DX settings pattern, MfgServiceConsoleSettings is represented as an XML document located inside the settings/ directory.

Key Metadata Fields#

The MfgServiceConsoleSettings schema defines the foundational boolean toggle for the application:

Declarative XML and Package Manifest Examples#

Below is the standard XML structure for enabling the Manufacturing Service Console:

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

Package Manifest (package.xml)#

Reference MfgServiceConsole under the Settings type in manifest files:

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

CLI Retrieval and Deployment Commands#

Use the Salesforce CLI to deploy or inspect MfgServiceConsoleSettings:

# Retrieve MfgServiceConsole settings into local workspace
sf project retrieve start --metadata Settings:MfgServiceConsole

# Deploy settings to target sandbox or production org
sf project deploy start --metadata Settings:MfgServiceConsole

# Deploy entire settings directory
sf project deploy start --source-dir force-app/main/default/settings

Architect Best Practices and Gotchas#

• Pipeline Ordering: Always deploy Settings:MfgServiceConsole prior to deploying any console FlexiPage components or custom Lightning App definitions that rely on Manufacturing Service Console modules.
• Scratch Org Configuration: Ensure your scratch org definition includes the Manufacturing and ServiceCloud features in project-scratch-def.json to prevent deployment rejections.
• Permission Sets: Enabling the console provides the foundation; CSR users must also be assigned the Manufacturing Service Console user license and appropriate PermissionSet to view the console tabs.

Frequently asked questions

What does MfgServiceConsoleSettings enable in Salesforce?

It enables Service Console for Manufacturing, delivering specialized asset timelines, warranty tracking, and service workflows for manufacturing customer service reps.

What license is required for MfgServiceConsoleSettings?

A Manufacturing Cloud license and Service Cloud license are required before this setting can be enabled and deployed.

How is MfgServiceConsoleSettings structured in package.xml?

It is declared as a member of the Settings metadata type with member name MfgServiceConsole in package.xml.

Where is the settings file stored in an SFDX project?

It is stored in force-app/main/default/settings/MfgServiceConsole.settings-meta.xml.