Network

Declarative Metadata File Suffix and Directory Location

Network components are stored in the networks directory of the corresponding package directory. The file name matches the community name, and the extension is .network.

Version

This object is available in API version 28.0 and later.

Fields

Field	Field Type	Description
allowMembersToFlag	boolean	Determines whether users in the community can flag posts or comments as inappropriate. Flagged items are sent to a community moderator for review. Available in API version 29.0 and later.
branding	Branding	The color scheme, header, and footer used in the community.
caseCommentEmailTemplate	string	Email template used when notifying community members when a case comment has been modified or added to a case.
changePasswordTemplate	string	Email template used when notifying a user that their password has been reset.
description	string	Description of the community.
emailSenderAddress	string	Email address from which community emails are sent.
emailSenderName	string	Name from which community emails are sent.
enableGuestChatter	boolean	Specifies whether guest users can access public Chatter groups in the community without logging in.
enableInvitation	boolean	Determines whether users can invite others to the community.
enableKnowledgeable	boolean	Determines if community members can see who’s knowledgeable on topics and endorse people for their knowledge on a topic. Available in API version 30.0 and later.
enableNicknameDisplay	boolean	Determines if user nicknames display instead of their first and last names in most places in the community. Set to `false` by default. Available in API version 32.0 and later.
enablePrivateMessages	boolean	Determines if community members can send and receive private messages. Available in API version 30.0 and later.
enableReputation	boolean	Determines if reputation is calculated and displayed for community members. Available in API version 31.0 and later. If enabled, reputationLevels and reputationPointsRules are used. If no reputationLevels or reputationPointsRules are not defined in the data file, the default values are used.
forgotPasswordTemplate	string	The email template used when a user forgets their password.
networkMemberGroups	NetworkMemberGroups	The profiles and permission sets that have access to the community. Users with these profiles or permission sets are members of the community. If a Chatter customer (from a customer group) is assigned a permission set that is also associated with a community, the Chatter customer won’t be added to the community. Note
newSenderAddress	string	Email address that has been entered as the new value for EmailSenderAddress but has not been verified yet. After a user has requested to change the sender email address and has successfully responded to the verification email, the NewSenderAddress value overwrites the value in EmailSenderAddress. This becomes the email address from which community emails are sent.
picassoSite	string	Name of the Site.com site linked to the community.
reputationLevels	ReputationLevelDefinitions	The reputation levels assigned to members when they accrue points by performing certain actions.
reputationPointsRules	ReputationPointsRules	The points members accrue when they perform certain defined actions.
selfRegProfile	string	The profile assigned to users who self register. This value is used only if selfRegistration is enabled for the community. Available in API version 29.0 and later.
selfRegistration	boolean	Determines whether self registration is available for the community.
sendWelcomeEmail	boolean	Determines whether a welcome email is sent when a new user is added to the community.
site	string	The CustomSite associated with the community.
status	NetworkStatus[]	Status of the community. Available values are: Live—The community is online and members can access it. DownForMaintenance—The community was previously published, but was taken offline. Members with “Create and Set Up Communities” can still access the setup for offline communities regardless of profile or membership. Members are not able to access offline communities, but they still appear in the user interface drop-down as CommunityName (Offline). UnderConstruction—The community has not yet been published. Users with “Create and Set Up Communities” can access communities in this status if their profile is associated with the community. Once a community is published, it can never be in this status again.
tabs	NetworkTabSet	The tabs that are available in the community. These tabs are selected by the user that created the community.
urlPathPrefix	string	The first part of the path on the site's URL that distinguishes this site from other sites. For example, if your site URL is mycompany.force.com/partners, then partners is the urlPathPrefix.
welcomeTemplate	string	The email template used when sending welcome emails to new community members.

Branding

Represents the branding and color scheme applied to the community.

Field	Field Type	Description
loginFooterText	string	The text that appears in the footer of the community login page.
loginLogo	string	The logo that appears on the community login page for external users.
pageFooter	string	An image that appears on the footer of the community pages. Must be an .html file.
pageHeader	string	An image that appears on the header of the community pages. Can be an .html, .gif, .jpg, or .png file.
primaryColor	string	The color used for the active tab.
primaryComplementColor	string	Font color used with primaryColor.
quaternaryColor	string	The background color for pages in the community.
quaternaryComplementColor	string	Font color used with quaternaryColor.
secondaryColor	string	The color used for the top borders of lists and tables.
tertiaryColor	string	The background color for section headers on edit and detail pages.
tertiaryComplementColor	string	Font color used with tertiaryColor.
zeronaryColor	string	The background color for the header.
zeronaryComplementColor	string	Font color used with zeronaryColor.

NetworkMemberGroup

Represents the profiles and permission sets that are assigned to the community. Users with one of the profiles or permission sets are members of the community, unless the user is a Chatter customer (from a customer group).

Field	Field Type	Description
permissionSet	string	A permission set that is assigned to the community. If a Chatter customer (from a customer group) is assigned a permission set that is also associated with a community, the Chatter customer won’t be added to the community. Note
profile	string	A profile that is part of the community.

ReputationBranding

Branding for the reputation level.

Field	Field Type	Description
smallImage	string	Custom image associated with a reputation level. Use files with these extensions: .jpeg, .png, or .gif. Images are stored as documents. If not specified, the default reputation level image is used. Available in API version 32.0 and later.

ReputationLevelDefinitions

Represents reputation levels members can achieve by performing certain defined actions in a community.

Field	Field Type	Description
level	ReputationLevel[]	Represents reputation levels.

ReputationLevel

Represents the name and lower value of the reputation level. The upper value is calculated by the application.

Field	Field Type	Description
branding	ReputationBranding[]	Represents any branding associated with the reputation level, specifically, the custom image for the reputation level. This field is optional. If not specified, the default reputation level image is used. Available in API version 32.0 and later.
label	string	Name of the reputation level. This field is optional. If not specified, defaults are used. These are the 10 default levels: Level 1 Level 2 Level 3 Level 4 Level 5 Level 6 Level 7 Level 8 Level 9 Level 10
lowerThreshold	double	Required. The lower value in the range for this reputation level. For example, if this reputation level is for points 1–50, 1 is the lowerThreshold.

Field

Field Type

Description

branding

ReputationBranding[]

Represents any branding associated with the reputation level, specifically, the custom image for the reputation level.

This field is optional. If not specified, the default reputation level image is used. Available in API version 32.0 and later.

label

string

Name of the reputation level.

This field is optional. If not specified, defaults are used. These are the 10 default levels:

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Level 7
Level 8
Level 9
Level 10

lowerThreshold

double

Required. The lower value in the range for this reputation level. For example, if this reputation level is for points 1–50, 1 is the lowerThreshold.

ReputationPointsRules

Represents points rules in a community’s point system.

Field	Field Type	Description
pointsRule	ReputationPointsRule[]	Represents events and their associated points.

ReputationPointsRule

Represents the event and associated point value for a points rule. When a user performs the action, they accrue the associated points.

Field	Field Type	Description
eventType	string	Required. The type of event a member has to perform to get points. The available values are: `FeedItemWriteAPost` `FeedItemWriteAComment` `FeedItemReceiveAComment` `FeedItemLikeSomething` `FeedItemReceiveALike` `FeedItemMentionSomeone` `FeedItemSomeoneMentionsYou` `FeedItemShareAPost` `FeedItemSomeoneSharesYourPost` `FeedItemPostAQuestion` `FeedItemAnswerAQuestion` `FeedItemReceiveAnAnswer` `FeedItemMarkAnswerAsBest` `FeedItemYourAnswerMarkedBest` `FeedItemEndorseSomeoneForKnowledgeOnATopic` `FeedItemEndorsedForKnowledgeOnATopic`
points	int	Required. The amount of points a member gets for performing the event. The default number of points per event is: FeedItemWriteAPost +1 FeedItemWriteAComment: +1 FeedItemReceiveAComment: +5 FeedItemLikeSomething: +1 FeedItemReceiveALike: +5 FeedItemMentionSomeone: +1 FeedItemSomeoneMentionsYou: +5 FeedItemShareAPost: +1 FeedItemSomeoneSharesYourPost: +5 FeedItemPostAQuestion: +1 FeedItemAnswerAQuestion: +5 FeedItemReceiveAnAnswer: +5 FeedItemMarkAnswerAsBest: +5 FeedItemYourAnswerMarkedBest: +20 FeedItemEndorseSomeoneForKnowledgeOnATopic: +5 FeedItemEndorsedForKnowledgeOnATopic: +20

NetworkTabSet

Field	Field Type	Description
customTab	string	Custom tab that is part of the community.
defaultTab	string	The Home tab for the community. When members log in, this is the first page they see.
standardTab	string	Standard tab that is part of the community.

Declarative Metadata Sample Definition

A sample XML definition of a network is shown below.

1<?xml version="1.0" encoding="UTF-8"?>
2<Network xmlns="http://soap.sforce.com/2006/04/metadata">
3    <allowMembersToFlag>true</allowMembersToFlag>
4    <branding>
5        <loginFooterText>salesforce.com</loginFooterText>
6        <loginLogo>Communities_Shared_Document_Folder/header2_png.png</loginLogo>
7        <pageFooter>Branding/footer_html.html</pageFooter>
8        <pageHeader>Branding/header_Image.jpg</pageHeader>
9        <primaryColor>#AF5800</primaryColor>
10        <primaryComplementColor>#FFFFFF</primaryComplementColor>
11        <quaternaryColor>#286FB8</quaternaryColor>
12        <quaternaryComplementColor>#FFFFFF</quaternaryComplementColor>
13        <secondaryColor>#000000</secondaryColor>
14        <tertiaryColor>#FFFFFF</tertiaryColor>
15        <tertiaryComplementColor>#222222</tertiaryComplementColor>
16        <zeronaryColor>#0A3764</zeronaryColor>
17        <zeronaryComplementColor>#FFFFFF</zeronaryComplementColor>
18    </branding>
19    <changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>
20    <description>Metadata Community</description>
21    <emailSenderAddress>admin@networkMetadata.com</emailSenderAddress>
22    <emailSenderName>Admin User</emailSenderName>
23    <enableInvitation>false</enableInvitation>
24    <enableKnowledgeable>true</enableKnowledgeable>
25    <enableNicknameDisplay>false</enableNicknameDisplay>
26    <enablePrivateMessages>true</enablePrivateMessages>
27    <enableReputation>true</enableReputation>
28    <forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
29    <networkMemberGroups>
30        <permissionSet>Admin</permissionSet>
31        <permissionSet>Standard</permissionSet>
32        <permissionSet>ReadOnly</permissionSet>
33        <profile>Admin</profile>
34        <profile>Standard</profile>
35        <profile>ReadOnly</profile>
36    </networkMemberGroups>
37    <reputationLevels>
38        <level>
39            <branding> 
40                <smallImage>communities_shared _document_folder/replevel_beginner.png</smallImage>
41            </branding>
42            <label>Beginner</label>
43            <lowerThreshold>0</lowerThreshold>
44        </level>
45        <level>
46            <branding> 
47                <smallImage>communities_shared _document_folder/replevel_apprentice.png</smallImage>
48            </branding>
49            <label>Apprentice</label>
50            <lowerThreshold>51</lowerThreshold>
51        </level>
52        <level>
53            <branding> 
54                <smallImage>communities_shared _document_folder/replevel_gettingthere.png</smallImage>
55            </branding>
56            <label>Getting There</label>
57            <lowerThreshold>101</lowerThreshold>
58        </level>
59        <level>
60            <branding> 
61                <smallImage>communities_shared _document_folder/replevel_skilled.png</smallImage>
62            </branding>
63            <label>Skilled</label>
64            <lowerThreshold>151</lowerThreshold>
65        </level>
66        <level>
67            <branding> 
68                <smallImage>communities_shared _document_folder/replevel_expert.png</smallImage>
69            </branding>
70            <label>Expert</label>
71            <lowerThreshold>201</lowerThreshold>
72        </level>
73        <level>
74            <branding> 
75                <smallImage>communities_shared _document_folder/replevel_mentor.png</smallImage>
76            </branding>
77            <label>Mentor</label>
78            <lowerThreshold>251</lowerThreshold>
79        </level>
80        <level>
81            <branding> 
82                <smallImage>communities_shared _document_folder/replevel_guru.png</smallImage>
83            </branding>
84            <label>Guru</label>
85            <lowerThreshold>301</lowerThreshold>
86        </level>
87    </reputationLevels>
88    <reputationPointsRules>
89        <pointsRule>
90            <eventType>FeedItemWriteAPost</eventType>
91            <points>5</points>
92        </pointsRule>
93        <pointsRule>
94            <eventType>FeedItemWriteAComment</eventType>
95            <points>3</points>
96        </pointsRule>
97        <pointsRule>
98            <eventType>FeedItemReceiveAComment</eventType>
99            <points>10</points>
100        </pointsRule>
101        <pointsRule>
102            <eventType>FeedItemLikeSomething</eventType>
103            <points>3</points>
104        </pointsRule>
105        <pointsRule>
106            <eventType>FeedItemReceiveALike</eventType>
107            <points>5</points>
108        </pointsRule>
109        <pointsRule>
110            <eventType>FeedItemMentionSomeone</eventType>
111            <points>5</points>
112        </pointsRule>
113        <pointsRule>
114            <eventType>FeedItemSomeoneMentionsYou</eventType>
115            <points>10</points>
116        </pointsRule>
117        <pointsRule>
118            <eventType>FeedItemShareAPost</eventType>
119            <points>5</points>
120        </pointsRule>
121        <pointsRule>
122            <eventType>FeedItemSomeoneSharesYourPost</eventType>
123            <points>10</points>
124        </pointsRule>
125    </reputationPointsRules>
126    <selfRegistration>false</selfRegistration>
127    <sendWelcomeEmail>true</sendWelcomeEmail>
128    <site>Network_11</site>
129    <status>UnderConstruction</status>
130    <tabs>
131        <defaultTab>Chatter</defaultTab>
132        <standardTab>Chatter</standardTab>
133        <standardTab>Account</standardTab>
134        <standardTab>Campaign</standardTab>
135        <standardTab>Case</standardTab>
136        <standardTab>Console</standardTab>
137        <standardTab>Contact</standardTab>
138        <standardTab>Contract</standardTab>
139        <standardTab>Dashboard</standardTab>
140        <standardTab>JigsawSearch</standardTab>
141        <standardTab>File</standardTab>
142        <standardTab>CollaborationGroup</standardTab>
143        <standardTab>home</standardTab>
144        <standardTab>Idea</standardTab>
145        <standardTab>Lead</standardTab>
146        <standardTab>Opportunity</standardTab>
147        <standardTab>Product2</standardTab>
148        <standardTab>UserProfile</standardTab>
149        <standardTab>report</standardTab>
150        <standardTab>Solution</standardTab>
151    </tabs>
152    <urlPathPrefix>network1</urlPathPrefix>
153    <welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>
154</Network>

Metadata API Developer’s Guide