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

Network

Represents a community. Communities are branded spaces for your employees, customers, and partners to connect. You can customize and create communities to meet your business needs, then transition seamlessly between them. Use the Network component for Salesforce Communities. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component. It 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
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.
changePasswordEmailTemplate 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.
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.
enablePrivateMessages boolean Determines if community members can send and receive private messages. Available in API version 30.0 and later.
forgotPasswordEmailTemplate 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.
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.
sitesPicasso string
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 Manage 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 Manage 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.
secondaryComplementColor string Font color used with secondaryColor.
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.

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    <forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>
25    <networkMemberGroups>
26        <permissionSet>Admin</permissionSet>
27        <permissionSet>Standard</permissionSet>
28        <permissionSet>ReadOnly</permissionSet>
29        <profile>Admin</profile>
30        <profile>Standard</profile>
31        <profile>ReadOnly</profile>
32    </networkMemberGroups>
33    <selfRegistration>false</selfRegistration>
34    <sendWelcomeEmail>true</sendWelcomeEmail>
35    <site>Network_11</site>
36    <status>UnderConstruction</status>
37    <tabs>
38        <defaultTab>Chatter</defaultTab>
39        <standardTab>Chatter</standardTab>
40        <standardTab>Account</standardTab>
41        <standardTab>Campaign</standardTab>
42        <standardTab>Case</standardTab>
43        <standardTab>Console</standardTab>
44        <standardTab>Contact</standardTab>
45        <standardTab>Contract</standardTab>
46        <standardTab>Dashboard</standardTab>
47        <standardTab>JigsawSearch</standardTab>
48        <standardTab>File</standardTab>
49        <standardTab>CollaborationGroup</standardTab>
50        <standardTab>home</standardTab>
51        <standardTab>Idea</standardTab>
52        <standardTab>Lead</standardTab>
53        <standardTab>Opportunity</standardTab>
54        <standardTab>Product2</standardTab>
55        <standardTab>UserProfile</standardTab>
56        <standardTab>report</standardTab>
57        <standardTab>Solution</standardTab>
58    </tabs>
59    <urlPathPrefix>network1</urlPathPrefix>
60    <welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>
61</Network>