SchedulingRule Metadata in SFDX

Architectural Overview#

SchedulingRule (historically known as a Work Rule in Field Service) represents a mandatory, non-negotiable operational constraint applied during appointment scheduling in Field Service (FSL) and Salesforce Scheduler. While scheduling objectives score and rank qualified candidates, SchedulingRule components act as boolean gates: a service resource either satisfies the rule criteria or is immediately eliminated from candidate consideration.

In enterprise field operations, failing to enforce hard rules can have catastrophic consequences: sending an unlicensed electrician to a high-voltage utility site, dispatching a mobile nurse outside their geographic territory, or breaching statutory labor laws regarding maximum consecutive working hours. By managing SchedulingRule instances as version-controlled metadata, Technical Architects guarantee compliance across all environments and scheduling policies.

Directory and File Conventions#

SchedulingRule components reside in the schedulingRules directory of the SFDX workspace.

Key Metadata Fields#

The definition outlines the constraint mechanism, target criteria, and enforcement properties.

Declarative XML and Package Manifest Examples#

The following example configures a mandatory skill-matching rule verifying that dispatched technicians possess certifications matching work order skill requirements:

<?xml version="1.0" encoding="UTF-8"?>
<SchedulingRule xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>Mandatory Skill Match</masterLabel>
    <developerName>Mandatory_Skill_Match</developerName>
    <ruleType>MatchSkills</ruleType>
    <isActive>true</isActive>
    <isEnforceRule>true</isEnforceRule>
    <description>Disqualifies technicians who lack active certifications matching Work Order skill requirements.</description>
</SchedulingRule>

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage SchedulingRule components using standard Salesforce CLI operations:

# Retrieve all scheduling rules
sf project retrieve start --metadata SchedulingRule

# Deploy a specific rule definition
sf project deploy start --source-dir force-app/main/default/schedulingRules/Mandatory_Skill_Match.schedulingRule-meta.xml

# Validate the rule in a staging sandbox
sf project deploy validate --metadata SchedulingRule:Mandatory_Skill_Match

Architect Best Practices and Gotchas#

• Over-Constrained Schedules: Stacking too many rigid rules (e.g., tight operating hours, exact skill levels, and secondary territory exclusions) can result in zero eligible candidates (“No slots available”), degrading customer booking conversion.
• Skill Level Validation: When configuring MatchSkills, verify whether skill levels are enabled. If skill levels are active, a technician possessing the required skill at level 3 will be disqualified if the appointment specifies level 4.
• Integration with Scheduling Policies: A SchedulingRule has no impact until it is added to an active Scheduling Policy. Always deploy the associated policy metadata alongside the individual rule.

Frequently asked questions

What does SchedulingRule do in Field Service and Scheduler?

It defines hard qualification constraints that immediately disqualify ineligible service resources based on skills, territory, working hours, and availability.

Where is SchedulingRule stored in an SFDX project?

It is stored in the schedulingRules directory with the .schedulingRule-meta.xml file extension.

What happens when a candidate violates a SchedulingRule?

The candidate resource is completely excluded from the candidate pool and will not be presented or scheduled for that service appointment.

What are common examples of SchedulingRule types?

Common rule types include Match Skills, Match Territory, Service Resource Availability, Maximum Working Hours, and Required Service Resources.