Salesforce Dictionary — Free Salesforce GlossarySalesforce Dictionary

Manifest File

Development🟡 Intermediate

Definition

In Salesforce DX, the package.xml file that lists which metadata components to retrieve from or deploy to a Salesforce org, specifying component types and their members for migration operations.

Real-World Example

a senior developer at TerraForm Tech uses Manifest File to solve a complex business requirement that cannot be addressed with declarative tools alone. They implement Manifest File with proper error handling, write 98% test coverage, and document the solution for future maintainers. The code passes security review on the first attempt.

Why Manifest File Matters

In Salesforce DX (and the older Force.com Migration Tool), a Manifest File is the package.xml file that lists which metadata components to retrieve from or deploy to a Salesforce org. It specifies component types (CustomObject, ApexClass, Layout, etc.) and their members (specific names or wildcards like '*' for all). The manifest is used by deployment tools to know exactly what to move between orgs or between local source and an org.

Manifest files are how source-driven Salesforce development handles the metadata API. Tools like the Salesforce CLI and the Salesforce Extensions for VS Code can use manifest files to specify deployments. For source-tracked workflows with Scratch Orgs, manifest files matter less because source tracking handles which files need pushing. For non-source-tracked deployments and for working with managed metadata, manifest files remain essential for specifying exactly what should move.

How Organizations Use Manifest File

  • Quantum LabsUses manifest files for deployments to non-source-tracked sandboxes, specifying exactly which metadata to push.
  • TerraForm TechGenerates manifest files programmatically as part of their CI/CD pipeline for deployments to client orgs.
  • CodeBridgeMaintains hand-crafted manifest files for specific deployment scenarios where source tracking isn't sufficient.

🧠 Test Your Knowledge

1. What is a Manifest File in Salesforce DX?

2. When are manifest files necessary?

3. What's the file format?

See something that could be improved?

Suggest an Edit