ManagedTopics | Metadata API Developer Guide

The related Experience Cloud site must exist before you deploy managed topics. (This occurs automatically when deploying an entire org.)

Note

File Suffix and Directory Location

Components have the suffix managedTopics and are stored in the managedTopics folder. In that folder, you find separate files for each Experience Cloud site (for example, SiteNameA.managedTopics and SiteNameB.managedTopics).

Version

ManagedTopics components are available in API version 32.0 and later.

Fields

Field Name	Field Type	Description
ManagedTopic	ManagedTopic	Represents a specific navigational or featured topic.

ManagedTopic

Field Name	Field Type	Description
name	string	The topic name.
managedTopicType	string	The topic type: “Navigational” or “Featured”
topicDescription	string	An optional description of topic contents. This field is accessible only via the API; there is no corollary in the user interface.
parentName	string	The name of a parent topic for which this topic is a child. Child topics are accessible from the subtopics section of the parent topic page and their feeds are added to the parent topic feed. Only navigational topics support parent-child relationships.
position	int	The placement of this topic relative to others of the same type. The results differ depending on topic type: For top-level navigational topics, position arranges the Topics menu in the Experience Cloud site. For child navigational topics, it arranges sibling topics in the subtopics section. For featured topics, it arranges topic thumbnail images on the Experience Cloud site home page. Enter a number between 0 and 24. (The maximum amount of navigational or featured topics is 25.)

Declarative Metadata Sample Definition

The following example retrieves or deploys managed topics for all sites:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ManagedTopics</name>
6    </types>
7    <version>32.0</version>
8</Package>

The following example shows a package.xml file referencing the ManagedTopics component:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>SiteName</members>
5        <name>ManagedTopics</name>
6    </types>
7    <version>32.0</version>
8</Package>

The following example shows the ManagedTopics component itself:

1<?xml version="1.0" encoding="UTF-8"?>
2<ManagedTopics>
3    <ManagedTopic>
4        <name>Running</name>
5        <managedTopicType>Navigational</managedTopicType>
6        <topicDescription>Training advice</topicDescription>
7        <parentName></parentName>
8        <position>0</position>
9    </ManagedTopic>
10    <ManagedTopic>
11        <name>Hiking</name>
12        <managedTopicType>Navigational</managedTopicType>
13        <topicDescription>Routes and gear</topicDescription>
14        <parentName></parentName>
15        <position>1</position>
16    </ManagedTopic>
17        <ManagedTopic>
18            <name>Trails</name>
19            <managedTopicType>Navigational</managedTopicType>
20            <topicDescription>Maps for local favorites</topicDescription>
21            <parentName>Hiking</parentName>
22            <position>0</position>
23        </ManagedTopic>
24        <ManagedTopic>
25            <name>Backpacks</name>
26            <managedTopicType>Navigational</managedTopicType>
27            <topicDescription>Recommended models</topicDescription>
28            <parentName>Hiking</parentName>
29            <position>1</position>
30        </ManagedTopic>
31    <ManagedTopic>
32        <name>Footwear</name>
33        <managedTopicType>Featured</managedTopicType>
34        <topicDescription>Suggested types for each sport</topicDescription>
35        <parentName></parentName>
36        <position>0</position>
37    </ManagedTopic>
38    <ManagedTopic>
39        <name>Conditioning</name>
40        <managedTopicType>Featured</managedTopicType>
41        <topicDescription>How to get fit for any activity</topicDescription>
42        <parentName></parentName>
43        <position>1</position>
44    </ManagedTopic>
45</ManagedTopics>

Usage

Managed topic images that are uploaded in API version 50.0 and later are stored as asset files. To migrate managed topic images that are uploaded in API version 50.0 and later, use the ContentAsset metadata type. To migrate managed topic images that were uploaded in API version 49.0 and earlier, use the Document metadata type.

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.