Newer Version Available
Network
This type extends the Metadata metadata type and inherits its fullName field.
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 | |
|---|---|---|---|
| allowedExtensions | string | Specifies the types of files allowed in your community. This whitelist of file types lets you control what your community members upload and also prevents spammers from polluting your community with inappropriate files. Available in API version 36.0 and later. | |
| allowInternalUserLogin | boolean | Determines whether internal users can log in with their internal credentials on the community login page. Available in API version 40.0 and later. | |
| 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. Deprecated in API version 41.0 and later. Replaced by the NetworkBranding type. | |
| 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. | |
| communityRoles | CommunityRoles | Identifies users with Customer, Partner, or Employee roles in a community. Available in API version 41.0 and later. | |
| description | string | Description of the community. | |
| disableReputationRecordConversations | boolean | Determines whether to exclude contributions to records when counting points toward reputation levels, if reputation levels are enabled for the community. Available in API version 41.0 and later. | |
| emailFooterLogo | string | The document name of the logo that appears in the footer of community emails. Available in API version 41.0 and later. | |
| emailFooterText | string | The text that appears in the footer of community emails. Available in API version 41.0 and later. | |
| emailSenderAddress | string | Required. Email address from which community emails are sent. | |
| emailSenderName | string | Required. Name from which community emails are sent. | |
| enableCustomVFErrorPageOverrides | boolean | Determines whether to use custom Visualforce error pages instead of the default Visualforce error pages. Available in API version 41.0 and later. | |
| enableDirectMessages | boolean | Determines whether community users can send direct messages to start a private conversation with one or more members. Available in API version 41.0 and later. | |
| enableGuestChatter | boolean | Specifies whether guest users can access public Chatter groups in the community without logging in. | |
| enableGuestFileAccess | boolean | Determines whether guest users view asset files shared with the community on publicly accessible pages and login pages. If public access is enabled in Community Builder at the page or community level, this property is automatically enabled. Available in API version 41.0 and later. | |
| 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. |
|
| enableShowAllNetworkSettings | boolean | Shows settings that are hidden by default based on how the community is set up. Available in API version 41.0 and later. | |
| enableSiteAsContainer | boolean | Determines whether the community uses Site.com pages instead of Visualforce tabs. | |
| enableTalkingAboutStats | boolean | Determines whether community users see how many people are discussing a topic. The number of people discussing the topic appears as the user types the topic and the system gives topic suggestions. Available in API version 41.0 and later. | |
| enableTopicAssignmentRules | boolean | Enables the org to use rules to automatically assign topics to articles in a community. After it’s enabled, admins set up rules in a community to map topics to Salesforce Knowledge data categories. This field is available in API version 40.0 and later. | |
| enableTopicSuggestions | boolean | Enables topic suggestions when users write posts. Available in API version 41.0 and later. | |
| enableUpDownVote | boolean | Replaces the option to like a question or answer with the option to upvote or downvote. Available in API version 41.0 and later. | |
| forgotPasswordTemplate | string | Required. The email template used when a user forgets their password. | |
| gatherCustomerSentimentData | boolean | Gathers data when a customer looks at articles and cases in communities, for use in the Community 360 feature. This field is available in API version 40.0 and later. | |
| lockoutTemplate | string | The email template used to communicate with users when they get locked out of their org because of too many failed login attempts. Available in API version 43.0 and later. | |
| maxFileSizeKb | int | Specifies the maximum file size (in KBs) that members can upload in your community. Available in API version 36.0 and later. Enter a number between 3072 KB and your org’s maximum file size. To use the default limit of 2 GB, leave this field empty. | |
| navigationLinkSet | NavigationLinkSet | This field is available in API version 37.0 and later. | |
| 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. | |
| networkPageOverrides | NetworkPageOverride | The settings in the Administration area (in Community Management or Community Workspaces) that control which page type Change Password, Forgot Password, Home, and Login each point to. Available in API version 40.0 and later. | |
| 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 value becomes the email address from which community emails are sent. | |
| picassoSite | string | Name of the Site.com site linked to the community. | |
| recommendationAudience | RecommendationAudience | Creates an audience of new community members, or can be used to manage customized lists of audience members to organize and target recommendations. Available in API version 41.0 and later. | |
| recommendationDefinition | RecommendationDefinition | Represents a custom recommendation to drive engagement for a community. Targets a specific audience and uses channels to specify a location for the recommendation. Available in API version 41.0 and later. | |
| 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 | Required. The CustomSite associated with the community. | |
| status | NetworkStatus[] | Required. Status of the
community. Available values are:
|
|
| tabs | NetworkTabSet | Required. The tabs that are available in the community. The user that created the community selected these tabs. | |
| 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. | |
| verificationTemplate | string | The email template used to communicate with users when they must verify their identity, for example, when they log in without a password or from a new device. Available in API version 44.0 and later. | |
| 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. Available in API version 40.0 and earlier. Replaced by NetworkBranding in API version 41.0 and later.
CommunityRoles
The labels used to identify users with Customer, Partner, or Employee roles in a community. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| customerUserRole | string | The label for the Customer user role in a community. |
| employeeUserRole | string | The label for the Employee user role in a community. |
| partnerUserRole | string | The label for the Partner user role in a community. |
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. |
| profile | string | A profile that is part of the community. |
NetworkPageOverride
Represents settings in the Administration area (in Community Management or Community Workspaces) that control which page type the Change Password, Forgot Password, Home, and Login pages each point to.
RecommendationAudience
Creates an audience of new community members, or can be used to manage customized lists of audience members to organize and target recommendations. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| recommendationAudienceDetails | RecommendationAudienceDetail | The specific details of an audience for recommendations. |
RecommendationAudienceDetail
The specific details of an audience for recommendations. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| audienceCriteriaType | AudienceCriteriaType (enumeration of type string) | The criteria for the recommendation audience type. Values are:
|
| audienceCriteriaValue | string | For new member criteria, the maximum number of days since a user became a community member. Null in case of custom list criteria. |
| setupName | string | Name of the recommendation audience. |
RecommendationDefinition
Represents a list of custom recommendations to drive engagement for a community. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| recommendationDefinitionDetails | RecommendationDefinitionDetail[] | A list of custom recommendations and their details. |
RecommendationDefinitionDetail
The specific details of a custom recommendation. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| actionUrl | string | The URL for the button that lets users act on the recommendation. |
| description | string | An explanation of the recommendation that suggests what users can do. |
| linkText | string | The text label for the button. |
| scheduledRecommendations | ScheduledRecommendation | A list of scheduled recommendations. |
| setupName | string | The name of the recommendation, which appears in Setup. |
| title | string | The title of the recommendation. |
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 application calculates the upper value.
| 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, one of the 10 defaults are used.
|
| 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 acts, 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:
|
| points | int | Required. The number of points a member gets for performing the
event. The default number of points per event is:
|
ScheduledRecommendation
Represents a list of scheduled recommendations. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| scheduledRecommendationDetails | ScheduledRecommendationDetail[] | A list of scheduled recommendations. |
ScheduledRecommendationDetail
The specific details of a scheduled recommendation. Available in API version 41.0 and later.
| Field | Field Type | Description |
|---|---|---|
| channel | RecommendationChannel (enumeration of type string) | A way to group recommendations together to determine where they
show up in the community. The valid values are:
|
| enabled | boolean | Indicates whether scheduling is enabled. If true, the recommendation is enabled
and appears in communities. If false, recommendations in feeds in Salesforce mobile web aren’t removed, but no new recommendations appear. In communities, disabled recommendations no longer appear. |
| rank | int | The rank of the recommendation within the channel, which
determines the order in which it’s displayed. The scheduled recommendation is inserted into the position specified by the rank. The rank of all the scheduled recommendations after it is pushed down. If the specified rank is larger than the size of the list, the scheduled recommendation is put at the end of the list. If a rank isn’t specified, the scheduled recommendation is put at the end of the list. |
| recommendationAudience | string | The name of the audience for this scheduled recommendation. |
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 tab 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.
1<?xml version="1.0" encoding="UTF-8"?>
2<Network xmlns="http://soap.sforce.com/2006/04/metadata">
3 <allowMembersToFlag>true</allowMembersToFlag>
4 <changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>
5 <description>Metadata Community</description>
6 <emailSenderAddress>admin@networkMetadata.com</emailSenderAddress>
7 <emailSenderName>Admin User</emailSenderName>
8 <enableInvitation>false</enableInvitation>
9 <enableKnowledgeable>true</enableKnowledgeable>
10 <enableNicknameDisplay>false</enableNicknameDisplay>
11 <enablePrivateMessages>true</enablePrivateMessages>
12 <enableReputation>true</enableReputation>
13 <enableUpDownVote>true</enableUpDownVote>
14 <forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
15 <networkMemberGroups>
16 <permissionSet>Admin</permissionSet>
17 <permissionSet>Standard</permissionSet>
18 <permissionSet>ReadOnly</permissionSet>
19 <profile>Admin</profile>
20 <profile>Standard</profile>
21 <profile>ReadOnly</profile>
22 </networkMemberGroups>
23 <recommendationDefinition>
24 <recommendationDefinitionDetails>
25 <actionUrl>https://www.apple.com/iphone</actionUrl>
26 <description>Better specs and high performance for iPhones</description>
27 <linkText>iPhone 7</linkText>
28 <scheduledRecommendations>
29 <scheduledRecommendationDetails>
30 <channel>DefaultChannel</channel>
31 <enabled>false</enabled>
32 <rank>1</rank>
33 <recommendationAudience>New Member Audience</recommendationAudience>
34 </scheduledRecommendationDetails>
35 </scheduledRecommendations>
36 <setupName>Apple iPhone</setupName>
37 <title>iPhone7</title>
38 </recommendationDefinitionDetails>
39 <recommendationDefinitionDetails>
40 <actionUrl>https://www.bose.com/qc35</actionUrl>
41 <description>New Amazing Noise cancellation Headphones</description>
42 <linkText>Bose QC35</linkText>
43 <scheduledRecommendations>
44 <scheduledRecommendationDetails>
45 <channel>DefaultChannel</channel>
46 <enabled>true</enabled>
47 <rank>2</rank>
48 <recommendationAudience>Custom Audience</recommendationAudience>
49 </scheduledRecommendationDetails>
50 </scheduledRecommendations>
51 <setupName>Bose Headphones</setupName>
52 <title>Bose QC35</title>
53 </recommendationDefinitionDetails>
54 </recommendationDefinition>
55 <reputationLevels>
56 <level>
57 <branding>
58 <smallImage>communities_shared _document_folder/replevel_beginner.png</smallImage>
59 </branding>
60 <label>Beginner</label>
61 <lowerThreshold>0</lowerThreshold>
62 </level>
63 <level>
64 <branding>
65 <smallImage>communities_shared _document_folder/replevel_apprentice.png</smallImage>
66 </branding>
67 <label>Apprentice</label>
68 <lowerThreshold>51</lowerThreshold>
69 </level>
70 <level>
71 <branding>
72 <smallImage>communities_shared _document_folder/replevel_gettingthere.png</smallImage>
73 </branding>
74 <label>Getting There</label>
75 <lowerThreshold>101</lowerThreshold>
76 </level>
77 <level>
78 <branding>
79 <smallImage>communities_shared _document_folder/replevel_skilled.png</smallImage>
80 </branding>
81 <label>Skilled</label>
82 <lowerThreshold>151</lowerThreshold>
83 </level>
84 <level>
85 <branding>
86 <smallImage>communities_shared _document_folder/replevel_expert.png</smallImage>
87 </branding>
88 <label>Expert</label>
89 <lowerThreshold>201</lowerThreshold>
90 </level>
91 <level>
92 <branding>
93 <smallImage>communities_shared _document_folder/replevel_mentor.png</smallImage>
94 </branding>
95 <label>Mentor</label>
96 <lowerThreshold>251</lowerThreshold>
97 </level>
98 <level>
99 <branding>
100 <smallImage>communities_shared _document_folder/replevel_guru.png</smallImage>
101 </branding>
102 <label>Guru</label>
103 <lowerThreshold>301</lowerThreshold>
104 </level>
105 </reputationLevels>
106 <reputationPointsRules>
107 <pointsRule>
108 <eventType>FeedItemWriteAPost</eventType>
109 <points>5</points>
110 </pointsRule>
111 <pointsRule>
112 <eventType>FeedItemWriteAComment</eventType>
113 <points>3</points>
114 </pointsRule>
115 <pointsRule>
116 <eventType>FeedItemReceiveAComment</eventType>
117 <points>10</points>
118 </pointsRule>
119 <pointsRule>
120 <eventType>FeedItemLikeSomething</eventType>
121 <points>3</points>
122 </pointsRule>
123 <pointsRule>
124 <eventType>FeedItemReceiveALike</eventType>
125 <points>5</points>
126 </pointsRule>
127 <pointsRule>
128 <eventType>FeedItemMentionSomeone</eventType>
129 <points>5</points>
130 </pointsRule>
131 <pointsRule>
132 <eventType>FeedItemSomeoneMentionsYou</eventType>
133 <points>10</points>
134 </pointsRule>
135 <pointsRule>
136 <eventType>FeedItemShareAPost</eventType>
137 <points>5</points>
138 </pointsRule>
139 <pointsRule>
140 <eventType>FeedItemSomeoneSharesYourPost</eventType>
141 <points>10</points>
142 </pointsRule>
143 </reputationPointsRules>
144 <selfRegistration>false</selfRegistration>
145 <sendWelcomeEmail>true</sendWelcomeEmail>
146 <site>Network_11</site>
147 <status>UnderConstruction</status>
148 <tabs>
149 <defaultTab>Chatter</defaultTab>
150 <standardTab>Chatter</standardTab>
151 <standardTab>Account</standardTab>
152 <standardTab>Campaign</standardTab>
153 <standardTab>Case</standardTab>
154 <standardTab>Console</standardTab>
155 <standardTab>Contact</standardTab>
156 <standardTab>Contract</standardTab>
157 <standardTab>Dashboard</standardTab>
158 <standardTab>JigsawSearch</standardTab>
159 <standardTab>File</standardTab>
160 <standardTab>CollaborationGroup</standardTab>
161 <standardTab>home</standardTab>
162 <standardTab>Idea</standardTab>
163 <standardTab>Lead</standardTab>
164 <standardTab>Opportunity</standardTab>
165 <standardTab>Product2</standardTab>
166 <standardTab>UserProfile</standardTab>
167 <standardTab>report</standardTab>
168 <standardTab>Solution</standardTab>
169 </tabs>
170 <urlPathPrefix>network1</urlPathPrefix>
171 <welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>
172</Network>