FilesConnectSettings in Salesforce Metadata API

Architectural Overview#

FilesConnectSettings is an org-level settings metadata type that governs the Salesforce Files Connect platform engine. In enterprise IT landscapes, critical unstructured business documentation—such as CAD diagrams, executed legal contracts, and financial spreadsheets—typically resides in corporate content repositories such as Microsoft SharePoint, OneDrive, Google Drive, or Box.

Migrating terabytes of legacy documents directly into Salesforce ContentVersion storage is financially prohibitive and creates governance sprawl. Salesforce Files Connect provides a federated content integration architecture. FilesConnectSettings enables the org to index, search, and attach external repository documents directly to standard and custom Salesforce records via federated queries without duplicating files or consuming Salesforce file storage quotas.

Enterprise architects must include FilesConnectSettings in foundational org configuration deployments to ensure that scratch orgs and staging environments support external document linking components and test automation.

Directory and File Conventions#

FilesConnectSettings follows standard Salesforce DX settings conventions in the settings directory:

Key Metadata Fields#

The FilesConnectSettings XML schema includes the following architectural flags:

Declarative XML and Package Manifest Examples#

Below is a declarative XML definition of FilesConnect.settings-meta.xml configured for an enterprise cloud content integration:

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

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

{
  "orgName": "Files Connect Dev Org",
  "edition": "Enterprise",
  "features": ["FilesConnect"],
  "settings": {
    "filesConnectSettings": {
      "enableContentHub": true,
      "enableExternalDocType": true,
      "enableFileSharing": true
    }
  }
}

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage FilesConnectSettings with the Salesforce CLI:

# Retrieve Files Connect settings from the org
sf project retrieve start --metadata Settings:FilesConnect

# Deploy Files Connect settings to target environment
sf project deploy start --metadata Settings:FilesConnect

# Deploy all foundational settings concurrently
sf project deploy start --source-dir force-app/main/default/settings

Architect Best Practices and Gotchas#

• Prerequisite for External Data Sources: Deploy Settings:FilesConnect prior to deploying ExternalDataSource metadata that uses the ContentHub or SharePoint connectors. Attempting to deploy an external data source without enabling Files Connect will throw missing capability errors.
• Zero-Storage Impact: When users link external files through Files Connect, Salesforce creates lightweight reference pointers rather than copying binary data. This preserves Salesforce File Storage capacity while retaining native preview and sharing capabilities.
• Permission Set Licensing: Activating enableContentHub enables the platform engine, but individual users must be assigned the “Files Connect Cloud” or “Files Connect On-Premise” Permission Set License (PSL) to search and link external files.

Frequently asked questions

What capabilities are controlled by FilesConnectSettings?

FilesConnectSettings enables Salesforce Files Connect, allowing federated search and file access across SharePoint, OneDrive, Google Drive, and Box.

What is the benefit of enabling external document types via FilesConnectSettings?

It allows external files to be searched, linked, and shared across Chatter feeds and standard record layouts without consuming Salesforce file storage.

How is FilesConnectSettings deployed via the Salesforce CLI?

Run sf project deploy start with metadata set to Settings:FilesConnect to push FilesConnect.settings-meta.xml to the target org.

Does FilesConnectSettings configure the actual cloud repository credentials?

No. FilesConnectSettings enables the org capability, while Auth Providers and External Data Sources configure the repository authentication details.