SvcCatalogCategory Metadata Type in SFDX

Architectural Overview#

The SvcCatalogCategory metadata type represents the hierarchical classification structure used within Salesforce Service Catalog (part of Employee Service and IT Service Management). When organizations provide internal employee service portals or customer-facing service catalogs, users navigate through structured service categories—such as Workplace Services, Hardware Provisioning, Software Access, and HR Inquiries—to submit catalog requests.

Architecturally, SvcCatalogCategory defines both top-level service groupings and child subcategories. It encapsulates visual branding assets (image), display sorting order (sortOrder), and parent-child taxonomy (parentCategory). Managing catalog categories as version-controlled metadata enables platform architects to maintain synchronized request taxonomies across sandbox testing and production portals.

Directory and File Conventions#

In SFDX source projects, SvcCatalogCategory components reside within the svcCatalogCategories directory:

Key Metadata Fields#

The SvcCatalogCategory schema encapsulates the taxonomy structure, labels, and display ordering:

Declarative XML and Package Manifest Examples#

Below is a declarative SvcCatalogCategory representing a child category under the IT Services catalog:

<?xml version="1.0" encoding="UTF-8"?>
<SvcCatalogCategory xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName>Hardware_Requests</fullName>
    <masterLabel>Hardware Requests</masterLabel>
    <image>Laptop_Icon_Asset</image>
    <parentCategory>IT_Services</parentCategory>
    <sortOrder>2</sortOrder>
    <isActive>true</isActive>
    <isProtected>false</isProtected>
</SvcCatalogCategory>

To include all service catalog categories in package.xml:

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

Retrieval and Deployment#

Use modern Salesforce CLI commands to manage catalog categories:

# Retrieve all Service Catalog categories
sf project retrieve start --metadata "SvcCatalogCategory:*"

# Deploy specific category to staging org
sf project deploy start --metadata "SvcCatalogCategory:Hardware_Requests" --target-org staging-sandbox

# Inspect deployed categories using Tooling API
sf data query --query "SELECT Id, DeveloperName, MasterLabel, ParentCategoryId FROM SvcCatalogCategory" --use-tooling-api

Senior Architect Considerations#

1. Asset Deployment Order: If referencing an image, ensure the corresponding ContentDocument or asset library file exists in the target org prior to deploying the category metadata.
2. Category Pruning: Deactivating a category (isActive = false) immediately hides all child catalog items from end users without deleting historical request records.
3. Item Associations: Catalog items link to categories via SvcCatalogItemDef. Keep item definitions and categories coupled within the same feature branch.

Frequently asked questions

What is the purpose of SvcCatalogCategory in Salesforce?

SvcCatalogCategory organizes individual Service Catalog items into browsable parent and child categories for self-service experience portals.

Which folder stores SvcCatalogCategory files in SFDX?

They are stored in force-app/main/default/svcCatalogCategories with the .category-meta.xml or .category file extension.

Can SvcCatalogCategories have multiple levels of nested hierarchy?

No, Service Catalog categories support a maximum of one level of nesting; a parent category cannot have its own parent.

Does SvcCatalogCategory support wildcard retrieval in package.xml?

Yes, SvcCatalogCategory supports the wildcard asterisk symbol in package.xml manifests.