Network

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

Network コンポーネントは、対応するパッケージディレクトリの networks ディレクトリに保存されます。ファイル名はコミュニティ名に一致し、拡張子は .network です。

バージョン

このオブジェクトは、API バージョン 28.0 以降で使用できます。

項目

項目	データ型	説明
allowMembersToFlag	boolean	コミュニティのユーザが投稿またはコメントを不適切としてフラグ付けできるかどうかを決定します。フラグが付けられた項目は、レビューのためにコミュニティモデレータに送信されます。API バージョン 29.0 以降で利用できます。
branding	Branding	コミュニティで使用する配色、ヘッダー、フッター。
caseCommentEmailTemplate	string	ケースコメントがケースに追加されたか変更された場合に、コミュニティメンバーに通知するときに使用されるメールテンプレート。
changePasswordTemplate	string	パスワードがリセットされたことをユーザに通知するときに使用されるメールテンプレート。
description	string	コミュニティの説明。
emailSenderAddress	string	コミュニティメールの送信元となるメールアドレス。
emailSenderName	string	コミュニティメールの送信元となる名前。
enableGuestChatter	boolean	ゲストユーザがログインせずにコミュニティの公開 Chatter グループにアクセスできるかどうかを指定します。
enableInvitation	boolean	ユーザが他のユーザをコミュニティに招待できるかどうかを指定します。
enableKnowledgeable	boolean	コミュニティメンバーが、トピックに関する知識のあるユーザを表示し、その知識についてユーザ��支持できるかどうかを決定します。API バージョン 30.0 以降で使用できます。
enableNicknameDisplay	boolean	コミュニティのほとんどの場所に、ユーザの氏名ではなくニックネームを表示するかどうかを示します。デフォルトで `false` に設定されます。API バージョン 32.0 以降で使用できます。
enablePrivateMessages	boolean	コミュニティメンバーが非公開メッセージを送受信できるかどうかを決定します。API バージョン 30.0 以降で使用できます。
enableReputation	boolean	コミュニティのメンバーに対する評価が計算および表示されるかどうかを決定します。API バージョン 31.0 以降で使用できます。有効な場合、reputationLevels と reputationPointsRules が使用されます。データファイルに reputationLevels と reputationPointsRules のどちらも定義されていない場合、デフォルト値が使用されます。
forgotPasswordTemplate	string	ユーザがパスワードを忘れたときに使用されるメールテンプレート。
networkMemberGroups	NetworkMemberGroups	コミュニティへのアクセス権を持つプロファイルおよび権限セット。これらのプロファイルまたは権限セットを持つユーザは、コミュニティのメンバーです。コミュニティにも関連付けられている権限セットが (顧客グループの) Chatter 顧客に割り当てられている場合、その Chatter 顧客はコミュニティに追加されません。メモ
newSenderAddress	string	EmailSenderAddress の新しい値として入力され、まだ未確認のメールアドレス。ユーザが送信元メールアドレスの変更を要求し、確認メールに正常に応答すると、NewSenderAddress の値で EmailSenderAddress の値が上書きされます。これが、コミュニティメールの送信元メールアドレスになります。
picassoSite	string	コミュニティにリンクしている Site.com サイトの名前。
reputationLevels	ReputationLevelDefinitions	メンバーが特定のアクションを実行してポイントを獲得したときに、メンバーに割り当てられる評価レベル。
reputationPointsRules	ReputationPointsRules	メンバーが特定の定義済みアクションを実行したときに獲得するポイント。
selfRegProfile	string	セルフ登録するユーザに割り当てられるプロファイル。この値は、コミュニティで selfRegistration が有効になっている場合にのみ使用されます。API バージョン 29.0 以降で利用できます。
selfRegistration	boolean	コミュニティでセルフ登録が可能かどうかを指定します。
sendWelcomeEmail	boolean	新しいユーザがコミュニティに追加されたときに、お知らせメールを送信するかどうかを指定します。
site	string	コミュニティに関連付けられている CustomSite。
status	NetworkStatus[]	コミュニティの状況。選択可能な値は次のとおりです。 Live — コミュニティがオンラインで、メンバーはアクセスできます。 DownForMaintenance — コミュニティは以前は公開されていましたが、オフラインになっています。「コミュニティの作成および設定」権限を持つメンバーは、プロファイルまたはメンバー種別に関係なくオフラインのコミュニティの設定に引き続きアクセスできます。メンバーはオフラインのコミュニティにはアクセスできませんが、ユーザインターフェースのドロップダウンには引き続き [CommunityName (オフライン)] と表示されます。 UnderConstruction — コミュニティがまだ公開されていません。「コミュニティの作成および設定」権限を持つユーザは、プロファイルがコミュニティに関連付けられていれば、この状況のコミュニティにアクセスできます。コミュニティの公開後は、再びこの状況になることはありません。
tabs	NetworkTabSet	コミュニティで使用できるタブ。これらのタブは、コミュニティを作成したユーザが選択します。
urlPathPrefix	string	サイトを他のサイトと区別する、サイトの URL 上のパスの最初の部分。たとえば、サイト URL が mycompany.force.com/partners である場合、partners は urlPathPrefix になります。
welcomeTemplate	string	新しいコミュニティメンバーにお知らせメールを送信するときに使用されるメールテンプレート。

Branding

コミュニティに適用されるブランド設定と配色を表します。

項目	データ型	説明
loginFooterText	string	コミュニティログインページのフッターに表示されるテキスト。
loginLogo	string	外部ユーザに対してコミュニティログインページに表示されるロゴ。
pageFooter	string	コミュニティページのフッターに表示される画像。.html ファイルである必要があります。
pageHeader	string	コミュニティページのヘッダーに表示される画像。.html、.gif、.jpg、.png ファイルを使用できます。
primaryColor	string	有効なタブに使用される色。
primaryComplementColor	string	primaryColor で使用されるフォントの色。
quaternaryColor	string	コミュニティのページの背景色。
quaternaryComplementColor	string	quaternaryColor で使用されるフォントの色。
secondaryColor	string	リストとテーブルの上境界線に使用される色。
tertiaryColor	string	編集ページと詳細ページのセクションヘッダーの背景色。
tertiaryComplementColor	string	tertiaryColor で使用されるフォントの色。
zeronaryColor	string	ヘッダーの背景色。
zeronaryComplementColor	string	zeronaryColor で使用されるフォントの色。

NetworkMemberGroup

コミュニティに割り当てられたプロファイルおよび権限セットを表します。いずれかのプロファイルまたは権限セットを持つユーザは、(顧客グループの) Chatter 顧客でない限り、コミュニティのメンバーです。

項目	データ型	説明
permissionSet	string	コミュニティに割り当てられた権限セット。コミュニティにも関連付けられている権限セットが (顧客グループの) Chatter 顧客に割り当てられている場合、その Chatter 顧客はコミュニティに追加されません。メモ
profile	string	コミュニティの一部であるプロファイル。

ReputationBranding

評価レベルのブランド設定。

項目	データ型	説明
smallImage	string	評価レベル��関連付けられたカスタム画像。拡張子が .jpeg、.png、または .gif のファイルを使用します。画像はドキュメントとして保存されます。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で使用できます。

ReputationLevelDefinitions

コミュニティ内で特定の定義されたアクションを実行することでメンバーが達成できる評価レベルを表します。

項目	データ型	説明
level	ReputationLevel[]	評価レベルを表します。

ReputationLevel

評価レベルの名前と下限値を表します。上限値はアプリケーションによって計算されます。

項目	データ型	説明
branding	ReputationBranding[]	評価レベルに関連付けられたブランド設定を表します。具体的には、評価レベルのカスタム画像です。この項目は省略可能です。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で使用できます。
label	string	評価レベルの名前。この項目は省略可能です。指定されていない場合、デフォルトが使用されます。次の 10 個のデフォルトレベルがあります。レベル 1 レベル 2 レベル 3 レベル 4 レベル 5 レベル 6 レベル 7 レベル 8 レベル 9 レベル 10
lowerThreshold	double	必須。この評価レベルの範囲の下限値。たとえば、この評価レベルがポイント 1 ～ 50 の場合、1 が lowerThreshold です。

項目

データ型

説明

branding

ReputationBranding[]

評価レベルに関連付けられたブランド設定を表します。具体的には、評価レベルのカスタム画像です。

この項目は省略可能です。指定されていない場合は、デフォルトの評価レベル画像が使用されます。API バージョン 32.0 以降で使用できます。

label

string

評価レベルの名前。

この項目は省略可能です。指定されていない場合、デフォルトが使用されます。次の 10 個のデフォルトレベルがあります。

レベル 1
レベル 2
レベル 3
レベル 4
レベル 5
レベル 6
レベル 7
レベル 8
レベル 9
レベル 10

lowerThreshold

double

必須。この評価レベルの範囲の下限値。たとえば、この評価レベルがポイント 1 ～ 50 の場合、1 が lowerThreshold です。

ReputationPointsRules

コミュニティのポイントシステムのポイントルールを表します。

項目	データ型	説明
pointsRule	ReputationPointsRule[]	行動とそれに関連付けられたポイントを表します。

ReputationPointsRule

ポイントルールの行動と関連付けられたポイント値を表します。アクションを実行したユーザは、関連付けられたポイントを獲得します。

項目	データ型	説明
eventType	string	必須。ポイントを獲得するためにメンバーが実行する必要がある行動の種別。次の値を使用できます。 `FeedItemWriteAPost` `FeedItemWriteAComment` `FeedItemReceiveAComment` `FeedItemLikeSomething` `FeedItemReceiveALike` `FeedItemMentionSomeone` `FeedItemSomeoneMentionsYou` `FeedItemShareAPost` `FeedItemSomeoneSharesYourPost` `FeedItemPostAQuestion` `FeedItemAnswerAQuestion` `FeedItemReceiveAnAnswer` `FeedItemMarkAnswerAsBest` `FeedItemYourAnswerMarkedBest` `FeedItemEndorseSomeoneForKnowledgeOnATopic` `FeedItemEndorsedForKnowledgeOnATopic`
points	int	必須。行動を実行してメンバーが取得するポイント数。行動ごとのデフォルトのポイント数は次のとおりです。 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

項目	データ型	説明
customTab	string	コミュニティの一部であるカスタムタブ。
defaultTab	string	コミュニティの [ホーム] タブ。メンバーがログインすると、このページが最初に表示されます。
standardTab	string	コミュニティの一部である標準タブ。

宣言的なメタデータの定義のサンプル

次に、ネットワークの XML 定義のサンプルを示します。

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>

メタデータ API 開発者ガイド