コミュニティのスコアとバッジ communities-scoring-and-badges
概要 overview
AEM Communitiesのスコアとバッジ機能を使用すると、コミュニティメンバーを特定し、報奨を与えることができます。
スコアとバッジの主な側面は次のとおりです。
-
バッジを割り当て コミュニティ内のメンバーの役割を特定するには
-
バッジの基本的な授与 メンバーの参加を奨励するために(作成されたコンテンツの数量)
-
バッジの高度な授与 メンバーをエキスパートとして識別する(作成されたコンテンツの質)
注意 バッジの授与は デフォルトでは有効になっていません.
バッジ badges
バッジは、コミュニティ内での役割または地位を示すために、メンバーの名前の下に配置されます。 バッジは、画像として、または名前として表示できます。 画像として表示される場合、この名前はアクセシビリティのための代替テキストとして含まれます。
デフォルトでは、バッジは次の場所のリポジトリに配置されます。
- /etc/community/badging/images
別の場所に保存されている場合は、すべてのユーザーが読み取りアクセス可能である必要があります。
UGC では、バッジをルールに従って割り当てたか、獲得したかを区別します。 現在は、割り当てられたバッジがテキストとして表示され、獲得したバッジが画像として表示されます。
バッジ管理 UI badge-management-ui
コミュニティ バッジコンソール は、獲得(与えられる)時やコミュニティで特定の役割を担う(割り当てられる)時に、メンバーに対して表示できるカスタムバッジを追加する機能を提供します。
割り当てられたバッジ assigned-badges
ロールベースのバッジは、コミュニティ内での役割に基づいて、管理者がコミュニティメンバーに割り当てます。
割り当てられた(および待ち受けの)バッジは、選択した SRP およびは直接アクセスできません。 GUI が使用できるようになるまで、ロールベースのバッジを割り当てる唯一の方法は、コードまたは cURL を使用して割り当てることです。 cURL の手順については、「 バッジの割り当てと取り消し.
このリリースには、次の 3 つの役割ベースのバッジが含まれています。
-
モデレーター
/etc/community/badging/images/moderator/jcr:content/moderator.png
-
グループマネージャー
/etc/community/badging/images/group-manager/jcr:content/group-manager.png
-
権限を持つメンバー
/etc/community/badging/images/privileged-member/jcr:content/privileged-member.png
授与されたバッジ awarded-badges
報酬ベースのバッジは、コミュニティ内のアクティビティに適用されるルールに基づいて、スコア付けサービスによってコミュニティメンバーに付与されます。
アクティビティに対する報酬としてバッジを表示するには、次の 2 つの処理が必要です。
このリリースには、次の 3 つの報酬ベースのバッジが含まれています。
-
ゴールド
/etc/community/badging/images/gold-badge/jcr:content/gold.png
-
シルバー
/etc/community/badging/images/silver-badge/jcr:content/silver.png
-
ブロンズ
/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
カスタムバッジ custom-badges
カスタムバッジは、 バッジコンソール バッジルールで割り当てるか指定します。
バッジコンソールからインストールすると、カスタムバッジはパブリッシュ環境に自動的にレプリケートされます。
スコアリングを有効にする enable-scoring
スコアリングは、デフォルトでは有効になっていません。 スコア付けとバッジの授与を設定して有効にする基本的な手順は次のとおりです。
-
ポイント獲得のルールを指定する (スコア付けルール)
詳しくは、 クイックテスト セクションを開き、フォーラムとコメントのデフォルトのスコアルールとバッジルールを使用して、コミュニティサイトのスコアを有効にします。
コンテンツへのルールの適用 apply-rules-to-content
スコアとバッジを有効にするには、プロパティを追加します scoringRules
および badgingRules
を、サイトのコンテンツツリー内の任意のノードに追加します。
サイトが既に公開されている場合は、すべてのルールを適用してコンポーネントを有効にした後、サイトを再公開します。
バッジが有効なコンポーネントに適用されるルールは、現在のノードまたはその上位ノード用のものです。
ノードのタイプがの場合 cq:Page
(推奨)次に、CRXDE|Lite を使用して、プロパティをそのに追加します。 jcr:content
ノード。
コンポーネントのバッジを有効にする enable-badges-for-component
スコアルールとバッディングルールは、 オーサリングモード.
boolean プロパティ allowBadges
コンポーネントインスタンスのバッジの表示を有効または無効にします。 これは、 コンポーネント編集ダイアログ フォーラム、Q&A、コメントコンポーネントの場合は、「 」というラベルの付いたチェックボックスを使用します。 バッジを表示.
例:フォーラムコンポーネントインスタンスの allowBadges example-allowbadges-for-forum-component-instance
スコアルール scoring-rules
スコア付けルールは、バッジを授与するためのスコア付けの基礎です。
非常に簡単に、各スコアルールは 1 つ以上のサブルールのリストです。 バッジが有効な場合に適用するルールを識別するために、スコアルールがコミュニティサイトのコンテンツに適用されます。
スコア付けルールは継承されますが、加算的ではありません。 次に例を示します。
-
page2 にスコアルール 2 が含まれ、その上位ページ 1 にスコアルール 1 が含まれる場合
-
page2 コンポーネントのアクションは、rule1 と rule2 の両方を呼び出します。
-
両方のルールに同じに適用可能なサブルールが含まれる場合
topic/verb
:- ルール 2 のサブルールのみがスコアに影響を与えます
- 両方のサブルールのスコアは、一緒には追加されません
複数のスコアルールがある場合、スコアは各ルールごとに個別に維持されます。
スコア付けルールは、 cq:Page
プロパティを含む jcr:content
定義するサブルールのリストを指定するノード。
スコアは SRP に保存されます。
/etc/community/scoring/rules/site1/forums-scoring
/etc/community/scoring/rules/site2/forums-scoring
スコアサブルール scoring-sub-rules
スコア付けサブルールには、コミュニティに参加するための値の詳細を示すプロパティが含まれます。
各スコアサブルールは、
- 追跡されているアクティビティ
- 関連する特定のコミュニティ機能
- 与えられるポイント数
デフォルトでは、サブルールでコンテンツの所有者がポイント ( forOwner
) をクリックします。
各サブルールは、1 つ以上のスコアルールに含めることができます。
通常、サブルールの名前は、 件名、オブジェクト および 動詞. 次に例を示します。
- member-comment-create
- member-receive-vote
サブルールは、タイプのノードです cq:Page
プロパティを含む jcr:content
ノード 動詞とトピック .
含まれるスコアルールとサブルール included-scoring-rules-and-sub-rules
このリリースには、 フォーラム機能 (フォーラム機能の「フォーラム」および「コメント」コンポーネントごとに 1 つずつ):
-
/etc/community/scoring/rules/comments-scoring
-
subRules[] =
/etc/community/scoring/rules/subrules/member-comment-create
/etc/community/scoring/rules/subrules/member-receive-vote
/etc/community/scoring/rules/subrules/member-give-vote
/etc/community/scoring/rules/subrules/member-is-moderated
-
-
/etc/community/scoring/rules/forums-scoring
-
subRules[] =
/etc/community/scoring/rules/subrules/member-forum-create
/etc/community/scoring/rules/subrules/member-receive-vote
/etc/community/scoring/rules/subrules/member-give-vote
/etc/community/scoring/rules/subrules/member-is-moderated
-
メモ:
-
両方
rules
およびsub-rules
ノードのタイプは cq:Page です。 -
subRules
は String 型の属性です[] 規則のjcr:content
ノード -
sub-rules
は、様々なスコアルールで共有できます -
rules
はリポジトリの場所に配置し、全員に対して読み取り権限を付与する必要があります- ルール名は、場所に関係なく一意である必要があります
カスタムスコアルールのアクティブ化 activating-custom-scoring-rules
オーサー環境でスコアルールやサブルールに対して行った変更や追加は、パブリッシュ環境にインストールする必要があります。
バッジルール badging-rules
バッジルールは、次の項目を指定することで、スコアルールをバッジにリンクします。
- どのスコアルールか
- 特定のバッジを待機するために必要なスコア。
バッジルールはタイプのノードです cq:Page
プロパティを含む jcr:content
スコアルールをスコアおよびバッジに関連付けるノード。
バッジのルールは必須の thresholds
バッジにマッピングされたスコアの順序付きリストであるプロパティ。 スコアは、値を増やすために並べ替える必要があります。 次に例を示します。
-
1|/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
- 1 ポイントの獲得に対してブロンズバッジが待機されています
-
60|/etc/community/badging/images/silver-badge/jcr:content/silver.png
- シルバーバッジは 60 ポイントの累積時に授与されます
-
80|/etc/community/badging/images/gold-badge/jcr:content/gold.png
- 80 ポイントが累積すると、ゴールドバッジが表示されます
バッジルールは、ポイントの累積方法を決定するスコアルールと対になります。 「 コンテンツへのルールの適用.
この scoringRules
プロパティは、特定のバッジルールと対にできるスコアルールを制限するだけです。
含まれるバッジルール included-badging-rules
このリリースには、 フォーラムおよびコメントのスコアリングルール.
- /etc/community/badging/rules/comments-badging
- /etc/community/badging/rules/forums-badging
メモ:
-
rules
ノードのタイプは cq:Page です。 -
rules
はリポジトリの場所に配置し、全員に対して読み取り権限を付与する必要があります- ルール名は、場所に関係なく一意である必要があります
カスタムバッジルールの有効化 activating-custom-badging-rules
オーサー環境でバッジルールや画像に加えた変更や追加は、すべてパブリッシュ環境にインストールする必要があります。
バッジの割り当てと取り消し assign-and-revoke-badges
バッジは、 メンバーコンソール または cURL コマンドをプログラムで使用する。
次の cURL コマンドは、バッジの割り当てと取り消しに HTTP リクエストで必要な処理を示します。 基本的な形式は次のとおりです。
cURL -i -XPOST-H ヘッダー -u *signin * -F *operation * -F *badge * member-profile-url
ヘッダー = "Accept:application/json"
サーバーに渡すカスタムヘッダー(必須)
サインイン = administrator-id:password
例:admin:admin
操作 = ":operation=social:assignBadge" OR ":operation=social:deleteBadge"
バッジ = "badgeContentPath=badge-image-file"
badge-image-file =リポジトリ内のバッジ画像ファイルの場所
例:/etc/community/badging/images/moderator/jcr:content/moderator.png
member-profile-url =公開時のメンバーのプロファイルのエンドポイント
例:https://<server>:<port>/home/users/community/riley/profile.social.json
- オーサーインスタンスを参照する場合、 トンネルサービス 有効
- わかりにくく、ランダムな名前である可能性があります。詳しくは、 セキュリティチェックリスト 許可可能 ID に関して
例: examples
モデレーターバッジを割り当て assign-a-moderator-badge
curl -i -X POST -H "Accept:application/json" -u admin:admin -F ":operation=social:assignBadge" -F "badgeContentPath=/etc/community/badging/images/moderator/jcr:content/moderator.png" /home/users/community/updcs9DndLEI74DB9zsB/profile.social.json
割り当てられたシルバーバッジを取り消す revoke-an-assigned-silver-badge
curl -i -X POST -H "Accept:application/json" -u admin:admin -F ":operation=social:deleteBadge" -F "badgeContentPath=/etc/community/badging/images/silver/jcr:content/silver.png" /home/users/community/updcs9DndLEI74DB9zsB/profile.social.json
カスタムコンポーネントのスコアとバッジ scoring-and-badges-for-custom-components
カスタムコンポーネントに対してスコアルールとバッジルールを作成するには、コンポーネント用に作成されたイベントトピックを動詞に関連付けます。
トピックと動詞 topics-and-verbs
メンバーがコミュニティ機能とやり取りすると、通知やスコアリングなどの非同期リスナーをトリガーにできるイベントが送信されます。
コンポーネントの SocialEvent インスタンスは、イベントを actions
それは topic
. SocialEvent には、 verb
アクションに関連付けられている。 ここに n-1 ~間の関係 actions
および verbs
.
配信されるコミュニティコンポーネントについて、次の表で次の内容を説明します verbs
それぞれに定義 topic
~で使用できる スコアサブルール.
allowBadges
コンポーネントインスタンスのバッジの表示を有効または無効にします。 更新時に設定可能になります コンポーネント編集ダイアログ ラベル付きのチェックボックスを通じて バッジを表示.カレンダーコンポーネント
SocialEvent topic
= com/adobe/cq/social/calendar
コメントコンポーネント
SocialEvent topic
= com/adobe/cq/social/comment
ファイルライブラリコンポーネント
SocialEvent topic
= com/adobe/cq/social/fileLibrary
フォーラムコンポーネント
SocialEvent topic
= com/adobe/cq/social/forum
ジャーナルコンポーネント
SocialEvent topic
= com/adobe/cq/social/journal
Q&A コンポーネント
SocialEvent topic
= com/adobe/cq/social/qna
レビューコンポーネント
SocialEvent topic
= com/adobe/cq/social/review
評価コンポーネント
SocialEvent topic
= com/adobe/cq/social/tally/rating
投票コンポーネント
SocialEvent topic
= com/adobe/cq/social/tally/voting
モデレートが有効なコンポーネント
SocialEvent topic
= com/adobe/cq/social/moderation
カスタムコンポーネントイベント custom-component-events
カスタムコンポーネントの場合、 SocialEvent がインスタンス化され、コンポーネントのイベントが actions
それは topic
.
スコアリングをサポートするには、 SocialEvent でメソッドを上書きする必要があります getVerb()
適切な verb
が返される action
. この verb
アクションに対して返されるのは、一般的に使用される ( POST
) またはコンポーネント専用の ( 例えば ADD RATING
) をクリックします。 ここに n-1 ~間の関係 actions
および verbs
.
トラブルシューティング troubleshooting
バッジが表示されません badges-are-not-appearing
スコアルールとバッジルールが Web サイトのコンテンツに適用されていて、どのアクティビティに対してもバッジが表示されない場合は、そのコンポーネントのインスタンスに対してバッジが有効になっていることを確認します。
詳しくは、 コンポーネントのバッジを有効にする.
スコア付けルールは無効です scoring-rule-has-no-effect
スコアルールとバッジルールが Web サイトのコンテンツに適用され、一部のアクションにバッジが与えられ、他のアクションにはバッジが与えられない場合は、適用されるスコアルールがバッジルールによって制限されていないことを確認します。
詳しくは、 scoringRules
プロパティ バッジルール.
大文字と小文字の区別 case-sensitive-typo
プロパティや値のほとんど、特に動詞は、大文字と小文字が区別されます。 スコアサブルールで使用する場合、動詞はすべて大文字にする必要があります。
機能が期待どおりに動作しない場合は、データが正しく入力されていることを確認します。
クイックテスト quick-test
スコアとバッジを、 入門チュートリアル (エンゲージメント)サイト:
-
作成者のCRXDE Liteにアクセス
-
ベースページを参照します。
- /content/sites/engage/en/jcr:content
-
badgingRules プロパティを追加します。
- 名前:
badgingRules
- 型:
String
- 選択 複数
- 選択 追加
/etc/community/badging/rules/forums-badging
と入力します。+
を選択します。/etc/community/badging/rules/comments-badging
と入力します。- 選択 OK
- 名前:
-
scoringRules プロパティを追加します。
- 名前:
scoringRules
- 型:
String
- 選択 複数
- 選択 追加
/etc/community/scoring/rules/forums-scoring
と入力します。+
を選択します。/etc/community/scoring/rules/comments-scoring
と入力します。- 選択 OK
- 名前:
-
選択 すべて保存
次に、フォーラムとコメントのコンポーネントでバッジを表示できるようにします。
-
CRXDE Lite
-
フォーラムコンポーネントを参照
/content/sites/engage/en/forum/jcr:content/content/primary/forum
-
必要に応じて、allowBadges ブール型プロパティを追加し、true に設定する
- 名前:
allowBadges
- 型:
Boolean
- 値:
true
- 名前:
次に、 再公開 コミュニティサイトです。
最後に
-
パブリッシュインスタンス上のコンポーネントを参照します。
-
コミュニティメンバーとしてサインイン ( 例:weston.mccall@dodgit.com / password)
-
新しいフォーラムトピックを投稿します
-
バッジを表示するには、ページを更新する必要があります
- ログアウトし、別のコミュニティメンバーとしてログインします ( 例:aaron.mcdonald@mailinator.com / password)
-
フォーラムを選択
これにより、コミュニティメンバーは、最初のフォーラムバッジルールの最初のしきい値がスコア 1 なので、フォーラム投稿でブロンズバッジを表示できます。
追加情報 additional-information
詳しくは、 スコアとバッジの基本事項 開発者向けのページ
高度なスコアエンジンについて詳しくは、 高度なスコアとバッジ.
設定可能なリーダーボード コンポーネント および 関数 は、コミュニティサイトでのメンバーとそのスコアの表示を簡素化します。