AEM Communities评分和徽章功能提供了识别和奖励社区成员的能力。
评分和徽章的主要方面包括:
注释 颁发徽章是 默认未启用.
在CRXDE Lite中可见的实施结构在UI可用时可能会发生更改。
徽章放置在成员的名称下,以表明他们在社区中的角色或地位。 徽章可以显示为图像或名称。 当显示为图像时,该名称将作为辅助功能的替换文本包含在内。
默认情况下,徽章位于存储库中的
/libs/settings/community/badging/images
如果存储在其他位置,则每个人都可以读取这些文件。
在UGC中,将根据规则来区分徽章的分配或获得。 目前,分配的徽章显示为文本,已获得的徽章显示为图像。
社区 徽章控制台 提供添加自定义徽章的功能,当成员获得(奖励)或在社区中承担特定角色(已分配)时,可以显示这些徽章。
基于角色的徽章由管理员根据社区成员在社区中的角色分配给社区成员。
已分配(和等待)的徽章存储在选定的中 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
评分服务会根据适用于社区成员活动的规则,向社区成员授予基于奖励的徽章。
为了让徽章显示为对活动的奖励,必须发生以下两件事:
此版本中包含三个基于奖励的徽章:
金级
/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
评分规则可以配置为为标记为不适当的帖子分配负分,从而影响评分值。 但是,获得徽章后,不会由于评分点减少或评分规则更改而自动删除该徽章。
授予的徽章可以与分配的徽章相同的方式撤销。 请参阅 分配和撤销徽章 部分。 未来的改进将包括一个用于管理成员徽章的UI。
可以使用安装自定义徽章 徽章控制台 在徽章规则中指定或指定的属性。
从“徽章”控制台安装后,自定义徽章会自动复制到发布环境。
默认情况下不启用评分。 设置和启用徽章评分和奖励的基本步骤如下:
确定获得点数的规则(评分规则)。
请参阅 快速测试 区域来启用对社区站点的评分,使用论坛和评论的默认评分和徽章规则。
要启用评分和徽章,请添加属性 scoringRules
和 badgingRules
到站点内容树中的任意节点。
如果站点已发布,请在应用所有规则和启用组件后,重新发布站点。
应用于启用了徽章的组件的规则适用于当前节点或其祖先的规则。
如果节点的类型为 cq:Page
(推荐),然后使用CRXDE|Lite将属性添加到其 jcr:content
节点。
属性 | 类型 | 描述 |
---|---|---|
徽章规则 | 字符串 | 数组列表 徽章规则 |
评分规则 | 字符串 | 数组列表 评分规则 |
如果评分规则似乎对奖励徽章没有影响,请确保评分规则未受到徽章规则的scoringRules属性的阻止。 请参阅标题为的部分 徽章规则.
评分和标记规则仅对通过编辑中的组件配置启用了标记的组件实例有效 创作模式.
布尔型属性, allowBadges
,启用/禁用组件实例的徽章显示。 它可在 “组件编辑”对话框 对于论坛、QnA和评论组件,请通过标记为的复选框访问 显示徽章.
任何组件都可以覆盖,以使用论坛、问题与解答和评论中的HBS代码作为示例来显示徽章。
评分规则是评分的基础,用于授予徽章。
很简单,每个评分规则都是一个包含一个或多个子规则的列表。 评分规则将应用于社区站点内容,以确定在启用徽章时要应用的规则。
评分规则是继承的,但不是累加的。 例如:
如果页面2包含评分规则2,并且其祖先page1包含评分规则1。
page2组件上的操作将同时调用rule1和rule2。
如果两个规则都包含相同规则的适用子规则 topic/verb
:
当有多个评分规则时,将分别为每个规则维护得分。
评分规则是类型的节点 cq:Page
具有属性 jcr:content
指定定义它的子规则列表的节点。
分数存储在SRP中。
最佳实践:唯一地命名每个评分规则。
评分规则名称应在全局范围内是唯一的;它们不应以相同的名称结尾。
以下示例 非 待办事项:
/libs/settings/community/scoring/rules/site1/forums-scoring
/libs/settings/community/scoring/rules/site2/forums-scoring
评分子规则包含详细说明参与社区的值的属性。
每个评分子规则标识:
默认情况下,积分被授予采取行动的会员,除非子规则将内容的所有者指定为接收积分( forOwner
)。
每个子规则可以包含在一个或多个评分规则中。
子规则的名称通常遵循以下模式: 主题 , 对象 和 动词. 例如:
子规则是类型的节点 cq:Page
具有属性 jcr:content
指定以下项的节点: 动词和主题 .
属性 | 类型 | 价值 描述 |
---|---|---|
VERB |
长整型 |
|
topics |
字符串 |
|
forOwner |
布尔值 |
|
scoringType |
字符串 |
|
此版本中包含两个评分规则, 论坛功能 (论坛功能的论坛和评论部分各一个):
/libs/settings/community/scoring/rules/comments-scoring
/libs/settings/community/scoring/rules/forums-scoring
注释:
两者 rules
和 sub-rules
节点的类型为cq:Page。
subRules
是字符串类型的属性[] 在规则的 jcr:content
节点。
sub-rules
可以在各种评分规则之间共享。
rules
应位于存储库位置,且每个人都具有读取权限。
在创作环境中对评分规则或子规则所做的任何更改或添加需要安装在发布上。
徽章规则通过指定以下内容将评分规则链接到徽章:
徽章规则为类型的节点 cq:Page
具有属性 jcr:content
将评分规则与分数和徽章关联的节点。
徽章规则包含必需 thresholds
属性,是映射到徽章的分数的有序列表。 分数必须按递增值排序。 例如:
1|/libs/settings/community/badging/images/bronze-badge/jcr:content/bronze.png
60|/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png
80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png
徽章规则与评分规则配对,后者确定积分的积累方式。 请参阅标题为的部分 将规则应用于内容.
此 scoringRules
徽章规则的属性只是限制哪些评分规则可以与该特定徽章规则配对。
最佳实践:创建每个AEM站点唯一的徽章图像。
属性 | 类型 | 价值 描述 |
---|---|---|
阈值 | 字符串 | (必需) 格式为“数字|路径”的多值字符串
示例条目: 80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png |
徽章类型 | 字符串 | (可选) 将评分引擎标识为“基本”或“高级”。 如果需要高级评分引擎,请参阅 高级评分和徽章. 默认值为“basic”。 |
评分规则 | 字符串 | (可选)一个多值字符串,可将标记规则限制为评分规则标识的评分事件 |
此版本中包含两个与对应的徽章规则 论坛和评论评分规则.
/libs/settings/community/badging/rules/comments-badging
/libs/settings/community/badging/rules/forums-badging
注释:
rules
节点的类型为cq:Page。
rules
应位于存储库位置,且每个人都具有读取权限。
在创作环境中对标记规则或图像所做的任何更改或添加都需要安装在发布上。
可以使用将徽章分配给成员 成员控制台 或使用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
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
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
使用cURL分配和撤销徽章适用于任何徽章图像,但是,当分配而不是获得徽章时,它们会被标记为已分配的徽章并进行相应处理。
通过将为组件创建的事件主题与动词相关联,可以为自定义组件创建评分和徽章规则。
当成员与社区功能交互时,发送可触发异步侦听器的事件,例如通知和评分。
组件的SocialEvent实例将这些事件记录为 actions
发生于 topic
. SocialEvent包括用于返回 verb
与操作相关联。 有一个 n-1 关系介于 actions
和 verbs
.
对于交付的社区组件,下表描述了 verbs
为每项定义 topic
可在以下位置使用 评分子规则.
新的布尔值属性, allowBadges
,启用/禁用组件实例的徽章显示。 它将在更新中配置 组件编辑对话框 通过标记为的复选框 显示徽章.
日历组件
社交事件 topic
= com/adobe/cq/social/calendar
动词 | 描述 |
---|---|
POST | 成员创建日历事件 |
添加 | 成员对日历事件的评论 |
更新 | 编辑成员的日历事件或评论 |
删除 | 已删除成员的日历事件或评论 |
注释组件
社交事件 topic
= com/adobe/cq/social/comment
动词 | 描述 |
---|---|
POST | 成员创建注释 |
添加 | 成员对评论的回复 |
更新 | 编辑成员的注释 |
删除 | 已删除成员的评论 |
文件库组件
社交事件 topic
= com/adobe/cq/social/fileLibrary
动词 | 描述 |
---|---|
POST | 成员创建文件夹 |
附加 | 成员上传文件 |
更新 | 成员更新文件夹或文件 |
删除 | 成员删除文件夹或文件 |
论坛组件
社交事件 topic
= com/adobe/cq/social/forum
动词 | 描述 |
---|---|
POST | 成员创建论坛主题 |
添加 | 成员对论坛主题的回复 |
更新 | 编辑成员的论坛主题或回复 |
删除 | 已删除成员的论坛主题或回复 |
日志组件
社交事件 topic
= com/adobe/cq/social/journal
动词 | 描述 |
---|---|
POST | 成员创建博客文章 |
添加 | 成员对博客文章的评论 |
更新 | 编辑成员的博客文章或评论 |
删除 | 已删除成员的博客文章或评论 |
问题与解答组件
社交事件 topic
= com/adobe/cq/social/qna
动词 | 描述 |
---|---|
POST | 成员创建QnA问题 |
添加 | 成员创建问题与解答答案 |
更新 | 编辑成员的问题或答案 |
SELECT | 已选择成员的答案 |
取消选择 | 已取消选择成员的答案 |
删除 | 已删除成员的QnA问题或答案 |
审核组件
社交事件 topic
= com/adobe/cq/social/review
动词 | 描述 |
---|---|
POST | 成员创建审核 |
更新 | 编辑成员的审阅 |
删除 | 已删除成员的审核 |
评级组件
社交事件 topic
= com/adobe/cq/social/tally/rating
动词 | 描述 |
---|---|
添加评级 | 成员内容已上调 |
删除评级 | 成员内容已降级 |
投票组件
社交事件 topic
= com/adobe/cq/social/tally/voting
动词 | 描述 |
---|---|
添加投票 | 会员内容已投赞成票 |
删除投票 | 成员内容已被否决 |
启用审核的组件
社交事件 topic
= com/adobe/cq/social/moderation
动词 | 描述 |
---|---|
拒绝 | 成员内容被拒绝 |
标记为不适当 | 已标记成员的内容 |
取消标记为不适当 | 成员的内容未标记 |
接受 | 审阅人已批准成员的内容 |
关闭 | 成员关闭评论以进行编辑和回复 |
OPEN | 成员重新打开注释 |
对于自定义组件,会实例化SocialEvent以将组件的事件记录为 actions
发生于 topic
.
要支持评分,SocialEvent需要覆盖方法 getVerb()
以便适当地 verb
针对每个返回 action
. 此 verb
针对操作返回的可能是常用的(例如 POST
)或专用于组件的组件(例如 ADD RATING
)。 有一个 n-1 关系介于 actions
和 verbs
.
如果评分和徽章规则已应用于网站的内容,但未出现任何活动的徽章,请确保已为该组件的实例启用徽章。
参见 为组件启用徽章.
如果评分和徽章规则已应用于网站的内容,并且授予了一些操作的徽章,但没有授予其他操作,请检查徽章规则是否未限制其适用的评分规则。
请参阅 scoringRules
属性 徽章规则.
大多数属性和值(尤其是动词)区分大小写。 在评分子规则中使用动词时,必须全部大写。
如果功能无法按预期工作,请确保已正确输入数据。
可以使用快速尝试评分和标记 入门教程 (参与)站点:
访问CRXDE Lite作者。
浏览到基本页:
添加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 /密码)。
发布新的论坛主题。
必须刷新页面才能显示徽章。
选择论坛。
由于第一个论坛徽章规则的第一个阈值为1分,因此这应该会为该社区成员获取一个其论坛帖子可见的铜牌。
欲知更多信息,请访问 评分和徽章要点 适用于开发人员的页面。
有关高级评分引擎的信息,请参阅 高级评分和徽章.