社群評分和預算 communities-scoring-and-badges
概觀 overview
AEM Communities評分和徽章功能提供識別及獎勵社群成員的能力。
評分和徽章的主要方面包括:
注意 獎勵徽章是 預設為未啟用.
徽章 badges
徽章會放置在成員的名稱下,以表示其在社群中的角色或地位。 徽章可以顯示為影像或名稱。 當顯示為影像時,名稱會包含為協助工具的替代文字。
依預設,徽章位於以下位置的存放庫中:
/libs/settings/community/badging/images
若儲存在其他位置,應讓每個人都可讀取這些檔案。
在UGC中會區分徽章,不論它們是依照規則指派或贏取。 目前,指派的徽章會顯示為文字,而贏取的徽章會顯示為影像。
徽章管理UI badge-management-ui
社群 徽章主控台 可讓您新增自訂徽章,當成員贏取(授予)或在社群中擔任特定角色(已指派)時,徽章會針對該成員顯示。
指派的徽章 assigned-badges
管理員會根據社群成員在社群中的角色,為其指派角色型徽章。
指派(和授予)徽章會儲存在選取的 SRP 和無法直接存取。 在GUI可用之前,指派角色型徽章的唯一方法是使用程式碼或cURL。 如需cURL指示,請參閱標題為 指派和撤銷徽章.
此版本包含三個角色型徽章:
-
版主
/libs/settings/community/badging/images/moderator/jcr:content/moderator.png
-
群組管理員
/libs/settings/community/badging/images/group-manager/jcr:content/group-manager.png
-
有特殊許可權的成員
/libs/settings/community/badging/images/privileged-member/jcr:content/privileged-member.png
獎勵徽章 awarded-badges
評分服務會根據社群成員活動中套用的規則,將獎勵型徽章授予社群成員。
若要讓徽章顯示為活動的獎勵,必須發生以下兩個情況:
此版本包含三個獎勵型徽章:
-
金級
/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png
-
銀級
/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png
-
銅級
/libs/settings/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
評分和徽章規則僅適用於已透過編輯元件設定來啟用徽章的元件例項。 製作模式.
布林值屬性, allowBadges
,啟用/停用元件例項的徽章顯示。 它可在以下位置設定: 元件編輯對話方塊 用於論壇、QnA和評論元件,透過標籤為的核取方塊 顯示徽章.
範例:論壇元件例項的allowBadges example-allowbadges-for-forum-component-instance
評分規則 scoring-rules
評分規則是獎勵徽章評分的基礎。
每個評分規則都是一或多個子規則的清單。 評分規則會套用至社群網站內容,以識別啟用徽章時要套用的規則。
評分規則是繼承的,但不會累加。 例如:
-
如果頁面2包含評分規則2,且其上階page1包含評分規則1。
-
page2元件上的動作會同時叫用rule1和rule2。
-
如果兩個規則包含相同專案的適用子規則
topic/verb
:- 只有規則2的子規則會影響分數。
- 不會新增兩個子規則的分數。
有多個評分規則時,系統會分別維護每個規則的分數。
評分規則是型別的節點 cq:Page
具有屬性 jcr:content
指定定義其之子規則清單的節點。
分數會儲存在SRP中。
/libs/settings/community/scoring/rules/site2/forums-scoring
評分子規則 scoring-sub-rules
評分子規則包含詳細說明參與社群之值的屬性。
每個評分子規則都會識別:
- 正在追蹤哪些活動?
- 涉及哪些特定的社群功能?
- 系統會給予多少點數?
依預設,點數會授予採取動作的成員,除非子規則將內容的所有者指定為接收點數( forOwner
)。
每個子規則可包含在一或多個評分規則中。
子規則的名稱通常會遵循使用的模式 主旨, 物件、和 動詞. 例如:
- member-comment-create
- 會員 — 接收 — 投票
子規則是型別的節點 cq:Page
具有屬性 jcr:content
指定下列專案的節點: 動詞和主題 .
包含評分規則和子規則 included-scoring-rules-and-sub-rules
此版本包含的兩個評分規則: 論壇功能 (論壇功能的「論壇」和「評論」元件各一個) :
-
/libs/settings/community/scoring/rules/comments-scoring
- subRules[] = /libs/settings/community/scoring/rules/sub-rules/member-comment-create /libs/settings/community/scoring/rules/sub-rules/member-receive-vote /libs/settings/community/scoring/rules/sub-give-vote /member/give-vote /libs/settings/community/scoring/rules/sub-rules/member-is-moderated
-
/libs/settings/community/scoring/rules/forums-scoring
- subRules[] = /libs/settings/community/scoring/rules/sub-rules/member-forum-create /libs/settings/community/scoring/rules/sub-rules/member-receive-vote /libs/settings/community/scoring/rules/sub-note-vote /member/settings/community/scoring/rules/sub-rules/member-is-modered
附註:
-
兩者
rules
和sub-rules
節點的型別為cq:Page。 -
subRules
是String型別的屬性[] 在規則的jcr:content
節點。 -
sub-rules
可以在各種評分規則之間共用。 -
rules
應該位在儲存庫位置,且每個人都有讀取許可權。- 無論位置為何,規則名稱必須是唯一的。
啟用自訂評分規則 activating-custom-scoring-rules
在製作環境中對評分規則或子規則所做的任何變更或新增都必須安裝在發佈上。
徽章規則 badging-rules
徽章規則透過指定以下內容,將評分規則連結至徽章:
- 評分規則
- 要授與特定徽章所需的分數
徽章規則是型別的節點 cq:Page
具有屬性 jcr:content
將評分規則與分數和徽章建立關聯的節點。
徽章的規則包含必要 thresholds
對應至徽章的分數有序清單屬性。 分數必須依遞增值排序。 例如:
-
1|/libs/settings/community/badging/images/bronze-badge/jcr:content/bronze.png
- 榮獲銅級徽章者可獲得1分。
-
60|/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png
- 當累積60分時,會授予銀級徽章。
-
80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png
- 當累積80分時,會授予金級徽章。
徽章規則會與評分規則配對,這會決定如何累積分數。 請參閱標題為的一節 套用規則至內容.
此 scoringRules
徽章規則的屬性只會限制哪些評分規則可以與該特定徽章規則配對。
包含的徽章規則 included-badging-rules
發行版本中包含兩個徽章規則,分別對應至 論壇和評論評分規則.
-
/libs/settings/community/badging/rules/comments-badging
-
/libs/settings/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 登入 -F 操作 -F 徽章 member-profile-url
頁首 = "Accept:application/json"自訂標題以傳遞至伺服器(必填)
登入 = administrator-id:password,例如admin:admin
操作 = ":operation=social:assignBadge"或":operation=social:deleteBadge"
徽章 = "badgeContentPath=badge-image-file"
badge-image-file =徽章影像檔案在存放庫中的位置,例如/libs/settings/community/badging/images/moderator/jcr:content/moderator.png
member-profile-url =發佈時成員設定檔的端點,例如https://<server>:<port>/home/users/community/riley/profile.social.json
範例: examples
指派版主徽章 assign-a-moderator-badge
curl -i -X POST -H "Accept:application/json" -u admin:admin -F ":operation=social:assignBadge" -F "badgeContentPath=/libs/settings/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=/libs/settings/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
.
針對已傳送的communities元件,下表說明 verbs
已針對每個專案定義 topic
可在以下位置使用: 評分子規則.
allowBadges
,啟用/停用元件例項的徽章顯示。 可在更新後設定 元件編輯對話方塊 透過標籤為的核取方塊 顯示徽章.行事曆元件
社交事件 topic
= com/adobe/cq/social/calendar
註解元件
社交事件 topic
= com/adobe/cq/social/comment
檔案庫元件
社交事件 topic
= com/adobe/cq/social/fileLibrary
論壇元件
社交事件 topic
= com/adobe/cq/social/forum
日誌元件
社交事件 topic
= com/adobe/cq/social/journal
QnA元件
社交事件 topic
= com/adobe/cq/social/qna
稽核元件
社交事件 topic
= com/adobe/cq/social/review
評等元件
社交事件 topic
= com/adobe/cq/social/tally/rating
投票元件
社交事件 topic
= com/adobe/cq/social/tally/voting
啟用稽核的元件
社交事件 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
如果評分和徽章規則已套用至網站的內容,但未針對任何活動授與徽章,請確定已為該元件的執行個體啟用徽章。
另請參閱 啟用元件的預算.
評分規則無效 scoring-rule-has-no-effect
如果評分和徽章規則已套用至網站的內容,且已針對某些動作(而非其他動作)授與徽章,請檢查徽章規則是否未限制其套用的評分規則。
請參閱 scoringRules
屬性 徽章規則.
區分大小寫的拼寫錯誤 case-sensitive-typo
大部分的屬性和值(尤其是動詞)都區分大小寫。 在評分子規則中使用動詞時,動詞必須全部大寫。
如果功能無法如預期運作,請確認資料已正確輸入。
快速測試 quick-test
您可以使用快速嘗試評分和徽章 快速入門教學課程 (參與)網站:
-
存取作者的CRXDE Lite。
-
瀏覽至基本頁面:
- /content/sites/engage/en/jcr:content
-
新增badgingRules屬性:
- 名稱:
badgingRules
- 類型:
String
- 選取 多個
- 選取 新增
- 輸入
/libs/settings/community/badging/rules/forums-badging
- 選取 +
- 輸入
/libs/settings/community/badging/rules/comments-badging
- 選取 確定
- 名稱:
-
新增scoringRules屬性:
- 名稱:
scoringRules
- 類型:
String
- 選取 多個
- 選取 新增
- 輸入
/libs/settings/community/scoring/rules/forums-scoring
- 選取 +
- 輸入
/libs/settings/community/scoring/rules/comments-scoring
- 選取 確定
- 名稱:
-
選取 全部儲存.
接下來,確定論壇和評論元件允許顯示徽章:
-
再次使用CRXDE Lite。
-
瀏覽至論壇元件
/content/sites/engage/en/forum/jcr:content/content/primary/forum
-
如有必要,請新增allowBadges布林值屬性,並確保其為true。
- 名稱:
allowBadges
- 類型:
Boolean
- 值:
true
- 名稱:
下一個, 重新發佈 社群網站。
最後,
-
瀏覽至發佈執行個體上的元件。
-
以社群成員身分登入(例如,weston.mccall@dodgit.com /密碼)。
-
發表新論壇主題。
-
頁面必須重新整理才能顯示徽章。
- 登出並以其他社群成員身分登入(例如:aaron.mcdonald@mailinator.com/password)。
-
選取論壇。
由於第一個論壇徽章規則的第一個臨界值是1分,這應該會為社群成員贏取可透過其論壇貼文看到的銅級徽章。
其他資訊 additional-information
如需詳細資訊,請參閱 評分和徽章要點 開發人員頁面。
如需進階評分引擎的詳細資訊,請參閱 進階評分和徽章.
可設定的排行榜 元件 和 函式 簡化社群網站上顯示成員及其分數的程式。