TopicsForObjects

Represents the ability to assign topics to objects or to remove topic assignments.

File Suffix and Directory Location

TopicsForObjects components have the suffix .topicsForObjects and are stored in the topicsForObjects folder of the corresponding package directory.

Version

TopicsForObjects components are available in API version 41.0 and later.

Fields

Field Name Field Type Description
enableTopics boolean Required. When true, indicates whether users can assign topics or remove topic assignments. When false, users can’t assign or remove topics.
Upon org creation, this value is true for the following objects:
  • Account
  • Asset
  • Campaign
  • Case
  • Contact
  • Content Document
  • Contract
  • Event
  • Lead
  • Opportunity
  • Order
  • Solution
  • Task

For all remaining standard objects and custom objects, the default is false.

entityApiName string Required. Indicates the object’s API name for enabling topics.

Declarative Metadata Sample Definition

The following is an example of a TopicsForObjects component.

1<?xml version="1.0" encoding="UTF-8"?>
2<TopicsForObjects xmlns="http://soap.sforce.com/2006/04/metadata">
3       <enableTopics>false</enableTopics>
4       <entityApiName>Account</entityApiName>
5</TopicsForObjects>

The following is an example package.xml that references the previous definition.

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>TopicsForObjects</name>
6</types>
7<version>41.0</version>
8</Package>

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.