Community (Zone) | Metadata API Developer Guide

Starting with the Summer ’13 release, Chatter Answers and Ideas “communities” have been renamed to “zones.” In API version 28, the API object label has changed to Zone, but the API type is still Community.

Note

File Suffix and Directory Location

Zones have the suffix community and are stored in the communities folder.

Version

Community (Zone) components are available in API version 27.0 and later.

Fields

When enableChatterAnswers is set to false, values specified for the following fields are ignored and not saved: communityFeedPage, emailFooterDocument, emailHeaderDocument, enablePrivateQuestions, emailNotificationUrl, and site.

Note

Field Name	Field Type	Description
active	boolean	Indicates whether the zone is active (`true`) or not (`false`).
chatterAnswersFacebookSsoUrl	string	(Read only) The Facebook sign-on URL, which is based on the Facebook authentication provider selected in your Chatter Answers settings. This field is available only if Chatter Answers and Facebook Single Sign-On for Chatter Answers are enabled.
communityFeedPage	string	The Visualforce page that hosts the zone’s feeds. This field is available when Chatter Answers is enabled in the organization.
description	string	The description of the zone.
emailFooterDocument	string	The text or HTML file that incorporates your organization’s branding into the footer of email notifications. This field is available when Chatter Answers is enabled in the organization.
emailHeaderDocument	string	The text or HTML file that incorporates your organization’s branding into the header of email notifications. This field is available when Chatter Answers is enabled in the organization.
emailNotificationUrl	string	The URL that’s included in email notifications. This field is available when Chatter Answers is enabled in the organization. This field replaces portalEmailNotificationUrl in API version 28.0 and later.
enableChatterAnswers	boolean	Indicates whether the zone has Chatter Answers enabled (`true`) or not (`false`). This field is available when Chatter Answers is enabled in the organization.
enablePrivateQuestions	boolean	Indicates whether Chatter Answers questions can be escalated to cases (`true`) or not (`false`). This field is available when Chatter Answers is enabled in the organization.
expertsGroup	string	The name of the public group that act as experts in the zone. This field is available when eitherIdeas or Answers are enabled in the organization.
portal	string	The name of the portal in which to display the zone.
portalEmailNotificationUrl	string	The portal URL that’s included in email notifications. This field is available when Chatter Answers is enabled in the organization. This field has been replaced by emailNotificationUrl in API version 28.0 and later.
reputationLevels	ReputationLevels	The fields that define the points and name of each reputation level you define. You can create up to 25 reputation levels per zone.
showInPortal	boolean	Indicates whether the zone is available to all portals (`true`) or not available to any portals (`false`).
site	string	The name of the site for the zone. This field is available when Chatter Answers is enabled in the organization.

ReputationLevels

Represents the points and reputation label that displays on hover over a user’s photo in the feed.

Field Name	Field Type	Description
chatterAnswersReputationLevels	ChatterAnswersReputationLevel []	Contains the name and value pair that describes the reputation level for Chatter Answers. Available in API version 28.0 and later.
ideaReputationLevels	IdeaReputationLevel	Contains the name and value pair that describes the reputation for Ideas. Available in API version 28.0 and later.

ChatterAnswersReputationLevel

Represents the reputation name and the number of points for that level for Chatter Answers.

Field Name	Field Type	Description
name	string	The name of the reputation level, for example, “Expert.”
value	int	The minimum number of points for the reputation level.

IdeaReputationLevel

Represents the reputation name and the number of points for that level for Ideas. Available in API version 28.0 and later.

Field Name	Field Type	Description
name	string	The name of the reputation level, for example, “Expert.”
value	int	The minimum number of points for the reputation level.

Declarative Metadata Sample Definition

The following is the definition of a community (zone) component:

1<?xml version="1.0" encoding="UTF-8"?>
2<Community xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <communityFeedPage>communityWithHeaderAndFooter_main</communityFeedPage>
5    <description>Metadata Test</description>
6    <emailFooterDocument>sampleFolder/emailFooter.html</emailFooterDocument>
7    <emailHeaderDocument>sampleFolder/emailHeader.html</emailHeaderDocument>
8    <enableChatterAnswers>true</enableChatterAnswers>
9    <enablePrivateQuestions>true</enablePrivateQuestions>
10    <expertsGroup>CommunityExperts</expertsGroup>
11    <portal>Customer Portal</portal>
12    <emailNotificationUrl>http://yourURL</emailNotificationUrl>
13<reputationLevels>
14        <chatterAnswersReputationLevels>
15            <name>Newbie</name>
16            <value>0</value>
17        </chatterAnswersReputationLevels>
18        <chatterAnswersReputationLevels>
19            <name>Smartie</name>
20            <value>500</value>
21        </chatterAnswersReputationLevels>
22        <chatterAnswersReputationLevels>
23            <name>Pro</name>
24            <value>2000</value>
25        </chatterAnswersReputationLevels>
26        <chatterAnswersReputationLevels>
27            <name>All Star</name>
28            <value>5000</value>
29        </chatterAnswersReputationLevels>
30        <ideaReputationLevels>
31            <name>Observer</name>
32            <value>0</value>
33        </ideaReputationLevels>
34        <ideaReputationLevels>
35            <name>Contributor</name>
36            <value>100</value>
37        </ideaReputationLevels>
38        <ideaReputationLevels>
39            <name>Influencer</name>
40            <value>400</value>
41        </ideaReputationLevels>
42        <ideaReputationLevels>
43            <name>Thought Leader</name>
44            <value>1500</value>
45        </ideaReputationLevels>
46    </reputationLevels>
47    <showInPortal>true</showInPortal>
48    <site>ChatterAnswersSite</site>
49</Community>