EntitlementTemplate Metadata Architecture

Architectural Overview#

EntitlementTemplate allows Service Cloud architects to predefine terms of support—such as warranty duration, allowable case volume, service hours, and milestone escalation processes—and associate them with Product catalog items. When a sales order completes and an Asset is created or registered, Salesforce can automatically instantiate an active Entitlement for the account based on the assigned template.

Automating entitlement provisioning via metadata eliminates error-prone manual data entry by customer service representatives. It ensures that customer support entitlements accurately reflect contractual warranties and premium SLA tiers across enterprise deployments.

Directory and File Conventions#

EntitlementTemplate components are stored within the entitlementTemplates directory in standard SFDX project repositories.

Key Metadata Fields#

The EntitlementTemplate metadata XML schema includes the following primary parameters:

Declarative XML and Package Manifest Examples#

Below is a declarative XML definition of a standard 1-year product warranty template:

<?xml version="1.0" encoding="UTF-8"?>
<EntitlementTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <businessHours>Default</businessHours>
    <casesPerEntitlement>25</casesPerEntitlement>
    <entitlementProcess>Standard_Case_SLA_v1</entitlementProcess>
    <name>Standard 1-Year Warranty</name>
    <term>365</term>
    <type>Web Support</type>
</EntitlementTemplate>

Manifest Definition (package.xml)#

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

CLI Retrieval and Deployment Commands#

Retrieve and deploy with sf CLI commands:

# Retrieve EntitlementTemplate metadata
sf project retrieve start --metadata EntitlementTemplate:Standard_1_Year_Warranty

# Deploy EntitlementTemplate alongside EntitlementProcess
sf project deploy start --metadata EntitlementTemplate:Standard_1_Year_Warranty EntitlementProcess:Standard_Case_SLA_v1

Architect Best Practices and Gotchas#

• Upstream Dependencies: Always deploy Settings:Entitlement, BusinessHours, and the target EntitlementProcess before or alongside EntitlementTemplate.
• Business Hours Naming: The businessHours tag references the name of an existing Business Hours record in the target org. Ensure default business hours exist across all sandbox tiers.
• Product Association: In SFDX source format, the association between Product2 records and EntitlementTemplate is established via data links (ProductEntitlementTemplate), which must be seeded using data import tools or post-deployment scripts.

Frequently asked questions

What does an EntitlementTemplate define in Salesforce?

It defines predefined warranty and support terms linked to Products, automatically granting customer entitlements when assets or products are purchased.

Can an EntitlementTemplate reference an EntitlementProcess?

Yes. An EntitlementTemplate can assign an SLA Entitlement Process and business hours calendar to automatically govern support milestones.

Where are EntitlementTemplate files stored in an SFDX project?

They are stored in force-app/main/default/entitlementTemplates/ with the file extension .entitlementTemplate-meta.xml.