Newer Version Available

This content describes an older version of this product. View Latest

SvcCatalogCategory

Represents the grouping of individual catalog items in Service Catalog.

File Suffix and Directory Location

SvcCatalogCategory components have the suffix category and are stored in the svcCatalogCategories folder.

Version

SvcCatalogCategory components are available in API version 53.0 and later.

Fields

Field Name Description
image
Field Type
string
Description
The developer name of a content document to be displayed in the Service Catalog for this category.
isActive
Field Type
boolean
Description
Indicates if a catalog category is active.
isProtected
Field Type
boolean
Description
An auto-generated value. This value currently has no impact.
masterLabel
Field Type
string
Description
Required. The primary label for the catalog category record.
parentCategory
Field Type
string
Description
If provided, the name of another SvcCatalogCategory that this category should appear under. The parent category in this field can’t have its own parent category. Categories can’t have more than one level of nesting.
sortOrder
Field Type
int
Description
Displays a set order for catalog category entities.

Declarative Metadata Sample Definition

The following is an example of a SvcCatalogCategory component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SvcCatalogCategory xmlns="http://soap.sforce.com/2006/04/metadata">
3    <image>AdobeStock_287068722</image>
4    <isActive>true</isActive>
5    <isProtected>false</isProtected>
6    <masterLabel>Workplace Services</masterLabel>
7    <sortOrder>4</sortOrder>
8</SvcCatalogCategory>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.