Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

ManagedTopics

Represents navigational and featured topics managed in a community. A specific community is represented by the Network component.

The related network must exist before you deploy managed topics. (This occurs automatically when deploying an entire organization.)

Note

File Suffix and Directory Location

Components have the suffix managedTopics and are stored in the managedTopics folder. In that folder, you’ll find separate files for each network (for example, NetworkNameA.managedTopics and NetworkNameB.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.
position int The placement of this topic relative to others of the same type. For navigational topics, this determines the order of the Topics menu in the community. For featured topics, this determines order of topic thumbnail images on the community 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 networks:

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>NetworkName</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        <position>0</position>
8    </ManagedTopic>
9    <ManagedTopic>
10        <name>Hiking</name>
11        <managedTopicType>Navigational</managedTopicType>
12        <topicDescription>Local trails</topicDescription>
13        <position>1</position>
14    </ManagedTopic>
15    <ManagedTopic>
16        <name>Shoes</name>
17        <managedTopicType>Featured</managedTopicType>
18        <topicDescription>Suggested types for each sport</topicDescription>
19        <position>0</position>
20    </ManagedTopic>
21    <ManagedTopic>
22        <name>Backpacks</name>
23        <managedTopicType>Featured</managedTopicType>
24        <topicDescription>Recommended models</topicDescription>
25        <position>1</position>
26    </ManagedTopic>
27</ManagedTopics>