Notation et badges de Communities communities-scoring-and-badges
Vue d’ensemble overview
La fonction de notation et de badges d’AEM Communities permet d’identifier et de récompenser les membres de la communauté.
Les principaux aspects de la notation et des badges sont les suivants :
-
Attribuez des badges pour identifier le rôle d’un membre dans la communauté.
-
Attribution de badges de base aux membres pour les encourager à participer (quantité de contenu créé).
-
Attribution avancée de badges pour identifier les membres en tant qu’experts (qualité du contenu créé).
Notez l’attribution de badges n’est pas activée par défaut.
Badges badges
Les insignes sont placés sous le nom d’un membre pour indiquer son rôle ou sa place dans la communauté. Les badges peuvent être affichés sous forme d’image ou de nom. Lorsqu’il est affiché sous forme d’image, le nom est inclus en tant que texte secondaire pour l’accessibilité.
Par défaut, les badges se trouvent dans le référentiel à l’emplacement suivant :
/libs/settings/community/badging/images
S’ils sont stockés à un autre emplacement, ils doivent être accessibles en lecture à tous.
Les badges sont différenciés dans le contenu créé par l’utilisateur, qu’ils aient été attribués ou gagnés conformément aux règles. Actuellement, les badges attribués apparaissent sous forme de texte et les badges gagnés sous forme d’image.
Interface utilisateur de gestion des badges badge-management-ui
La console Communautés Badges permet d’ajouter des badges personnalisés qui peuvent être affichés pour un membre lorsqu’ils sont gagnés (attribués) ou lorsqu’il assume un rôle spécifique dans la communauté (attribué).
Badges attribués assigned-badges
Les badges basés sur les rôles sont attribués par un administrateur aux membres de la communauté en fonction de leur rôle dans la communauté.
Les badges attribués sont stockés dans le SRP sélectionné et ne sont pas directement accessibles. Jusqu’à ce qu’une interface utilisateur graphique soit disponible, le seul moyen d’attribuer des badges basés sur les rôles est de le faire avec du code ou cURL. Pour obtenir des instructions sur cURL, consultez la section intitulée Attribuer et révoquer des badges .
Cette version comprend trois badges basés sur les rôles :
-
modérateur
/libs/settings/community/badging/images/moderator/jcr:content/moderator.png -
gestionnaire de groupe
/libs/settings/community/badging/images/group-manager/jcr:content/group-manager.png -
membre privilégié
/libs/settings/community/badging/images/privileged-member/jcr:content/privileged-member.png
Badges attribués awarded-badges
Les badges basés sur la récompense sont attribués par le service de notation aux membres de la communauté en fonction des règles appliquées à leur activité dans la communauté.
Pour que les badges apparaissent comme une récompense pour l’activité, deux choses doivent se produire :
- Le badge doit être activé pour le composant de fonction.
- Les règles de score et de badge doivent être appliquées à la page (ou à l’ancêtre) sur laquelle le composant est placé.
Cette version comprend trois badges basés sur la récompense :
-
or
/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png -
argent
/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png -
bronze
/libs/settings/community/badging/images/bronze-badge/jcr:content/bronze.png
Badges personnalisés custom-badges
Les badges personnalisés peuvent être installés à l’aide de la console Badges et être attribués ou spécifiés dans des règles de badge.
Une fois installés à partir de la console Badges , les badges personnalisés sont automatiquement répliqués dans l’environnement de publication.
Activer la notation enable-scoring
La notation n’est pas activée par défaut. Les étapes de base pour configurer et activer la notation et l’attribution de badges sont les suivantes :
-
Identifiez les règles pour les points d’apprentissage (règles de notation).
-
Pour les points accumulés par règle de score, attribuez badges (règles de badges).
-
Appliquez les règles de score et de badge à un site communautaire.
-
Activer la création de badges pour les fonctionnalités de la communauté.
Consultez la section Test rapide pour activer la notation pour un site communautaire à l’aide des règles de notation et de badge par défaut pour les forums et les commentaires.
Application de règles au contenu apply-rules-to-content
Pour activer la notation et les badges, ajoutez les propriétés scoringRules et badgingRules à n’importe quel nœud de l’arborescence de contenu du site.
Si le site est déjà publié, après avoir appliqué toutes les règles et activé les composants, republiez le site.
Les règles qui s’appliquent à un composant activé pour les badges sont celles qui s’appliquent au nœud actuel ou à son ancêtre.
Si le nœud est de type cq:Page (recommandé), ajoutez les propriétés à son nœud jcr:content à l’aide de CRXDE|Lite.
Activer les badges pour le composant enable-badges-for-component
Les règles de score et de badge sont en vigueur uniquement pour les instances de composants qui ont activé le badge en modifiant la configuration du composant en mode création.
Une propriété booléenne, allowBadges, active/désactive l’affichage des badges pour une instance de composant. Vous pouvez la configurer dans la boîte de dialogue de modification de composant pour les composants de forum, QnA et de commentaire à l’aide d’une case à cocher intitulée Afficher les badges.
Exemple : allowBadges pour l’instance du composant Forum example-allowbadges-for-forum-component-instance
Règles de notation scoring-rules
Les règles de notation sont la base de la notation pour l’attribution de badges.
Chaque règle de notation est une liste d’une ou de plusieurs sous-règles. Les règles de score sont appliquées au contenu du site de la communauté pour identifier les règles à appliquer lorsque les badges sont activés.
Les règles de score sont héritées, mais ne s’additionnent pas. Par exemple :
-
Si page2 contient la règle de score2 et que page1 ancêtre contient la règle de score1.
-
Une action sur un composant page2 appelle à la fois règle1 et règle2.
-
Si les deux règles contiennent des sous-règles applicables pour la même
topic/verb:- Seule la sous-règle de règle 2 affecte le score.
- Les scores des deux sous-règles ne sont pas ajoutés.
Lorsqu’il existe plusieurs règles de notation, les notes sont conservées séparément pour chaque règle.
Les règles de score sont des nœuds de type cq:Page avec des propriétés sur son nœud jcr:content qui spécifient la liste des sous-règles qui le définissent.
Les scores sont stockés dans SRP.
Sous-Règles De Notation scoring-sub-rules
Les sous-règles de notation contiennent les propriétés qui détaillent les valeurs de participation à la communauté.
Chaque sous-règle de notation identifie :
- Quelles sont les activités suivies ?
- Quelle fonction communautaire spécifique est concernée ?
- Combien de points sont attribués ?
Par défaut, les points sont attribués au membre qui effectue l’action, sauf si la sous-règle spécifie que le propriétaire du contenu reçoit les points ( forOwner).
Chaque sous-règle peut être incluse dans une ou plusieurs règles de notation.
Le nom de la sous-règle suit généralement le modèle d’utilisation d’un objet, objet et verbe. Par exemple :
- member-comment-create
- member-receive-vote
Les sous-règles sont des nœuds de type cq:Page avec des propriétés sur son nœud jcr:content qui spécifient les verbes et rubriques .
Règles et sous-règles de notation incluses included-scoring-rules-and-sub-rules
Cette version comprend deux règles de notation pour la fonction Forum (une pour chacun des composants Forum et Commentaires de la fonction Forum) :
-
/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-rules/member-give-vote
/libs/settings/community/scoring/rules/sub-rules/member-is-mediated
- subRules[] =
-
/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-rules/member-give-vote
/libs/settings/community/scoring/rules/sub-rules/member-is-mediated
- subRules[] =
Remarques:
-
Les nœuds
rulesetsub-rulessont de type cq:Page. -
subRulesest un attribut de type chaîne[] sur le nœudjcr:contentde la règle. -
sub-rulespeuvent être partagées entre différentes règles de notation. -
rulesdoit se trouver dans un emplacement de référentiel avec des autorisations en lecture pour tout le monde.- Les noms des règles doivent être uniques, quel que soit l’emplacement.
Activer les règles de score personnalisées activating-custom-scoring-rules
Toute modification ou tout ajout apporté aux règles de score ou aux sous-règles dans l’environnement de création doit être installé sur l’instance de publication.
Règles de badge badging-rules
Les règles de badge lient les règles de score aux badges en spécifiant :
- Règle de notation
- Score nécessaire pour obtenir un badge spécifique
Les règles de badge sont des nœuds de type cq:Page avec des propriétés sur son nœud jcr:content qui corrélent les règles de score aux scores et aux badges.
Les règles relatives aux badges se composent d’une propriété thresholds obligatoire qui consiste en une liste ordonnée de scores mappés aux badges. Les scores doivent être classés par ordre croissant. Par exemple :
-
1|/libs/settings/community/badging/images/bronze-badge/jcr:content/bronze.png- Un badge bronze est attribué pour gagner un point.
-
60|/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png- Un badge argent est attribué lorsque 60 points ont été accumulés.
-
80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png- Un badge or est attribué lorsque 80 points ont été accumulés.
Les règles de badge sont associées à des règles de score, qui déterminent la façon dont les points s’accumulent. Consultez la section intitulée Appliquer des règles au contenu.
La propriété scoringRules d’une règle de badge limite simplement les règles de score pouvant être associées à cette règle de badge spécifique.
Règles de badge incluses included-badging-rules
Cette version comprend deux règles de badge qui correspondent aux règles de notation des forums et des commentaires.
-
/libs/settings/community/badging/rules/comments-badging -
/libs/settings/community/badging/rules/forums-badging
Remarques:
-
rulesnœuds sont de type cq:Page. -
rulesdoit se trouver dans un emplacement de référentiel avec des autorisations en lecture pour tout le monde.- Les noms des règles doivent être uniques, quel que soit l’emplacement.
Activation des règles de badge personnalisées activating-custom-badging-rules
Toute modification ou tout ajout apporté aux règles de badge ou aux images dans l’environnement de création doit être installé sur l’instance de publication.
Affecter et révoquer des badges assign-and-revoke-badges
Les badges peuvent être attribués aux membres à l’aide de la console membres ou par programmation à l’aide de commandes cURL.
Les commandes cURL suivantes indiquent ce qui est nécessaire pour une requête HTTP d’attribution et de révocation de badges. Le format de base est :
cURL -i -X POST -H header -u signin -F operation -F badge member-profile-url
header = « Accepter :application/json »
en-tête personnalisé à transmettre au serveur (obligatoire)
signin = administrator-id:password
par exemple, admin:admin
operation = « :operation=social:assignBadge » OU « :operation=social:deleteBadge »
badge = « badgeContentPath=badge-image-file »
badge-image-file = emplacement du fichier image de badge dans le référentiel
par exemple, /libs/settings/community/badging/images/moderniator/jcr:content/moderator.png
member-profile-url = point d’entrée pour le profil du membre lors de la publication
par exemple, https://<server>:<port>/home/users/community/riley/profile.social.json
- Peut faire référence à une instance de création si le service de tunnel est activé.
- Peut être un nom obscur et aléatoire (voir Liste de contrôle de sécurité concernant l’ID autorisable.
Exemples : examples
Attribuer un badge de modérateur 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
Révoquer un badge argent attribué 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
Notation et badges pour les composants personnalisés scoring-and-badges-for-custom-components
Des règles de score et de badge peuvent être créées pour les composants personnalisés en associant les rubriques d’événement créées pour le composant à des verbes.
Sujets et verbes topics-and-verbs
Lorsque les membres interagissent avec les fonctionnalités des communautés, des événements sont envoyés pour déclencher des écouteurs asynchrones, tels que des notifications et des scores.
L’instance SocialEvent d’un composant enregistre les événements comme des actions qui se produisent pour un topic. SocialEvent inclut une méthode pour renvoyer un verb associé à l’action. Il existe une relation n-1 entre actions et verbs.
Pour les composants de communautés diffusés, les tableaux suivants décrivent les verbs définis pour chaque topic disponible pour être utilisé dans les sous-règles de notation.
allowBadges, active/désactive l’affichage des badges pour une instance de composant. Vous pouvez le configurer dans les boîtes de dialogue de modification de composant mises à jour via une case à cocher intitulée Afficher les badges.Composant Calendrier
SocialEvent topic= com/adobe/cq/social/calendar
Composant Comments
SocialEvent topic= com/adobe/cq/social/comment
composant Bibliothèque de fichiers
SocialEvent topic= com/adobe/cq/social/fileLibrary
Composant Forum
SocialEvent topic= com/adobe/cq/social/forum
Composant Journal
SocialEvent topic= com/adobe/cq/social/journal
Composant QnA
SocialEvent topic = com/adobe/cq/social/qna
Composant Révisions
SocialEvent topic= com/adobe/cq/social/review
Composant Évaluation
SocialEvent topic= com/adobe/cq/social/tally/rating
Composante de vote
SocialEvent topic= com/adobe/cq/social/tally/votes
Composants activés pour la modération
SocialEvent topic= com/adobe/cq/social/modation
Événements de composant personnalisés custom-component-events
Pour un composant personnalisé, un événement social est instancié afin d’enregistrer les événements du composant en tant que actions qui se produisent pour un topic.
Pour prendre en charge la notation, l’événement social doit remplacer la méthode getVerb() afin qu’un verb approprié soit renvoyé pour chaque action. Les verb renvoyées pour une action peuvent être celles qui sont couramment utilisées (par exemple, POST) ou celles qui sont spécialisées pour le composant (par exemple, ADD RATING). Il existe une relation n-1 entre actions et verbs.
Résolution des problèmes troubleshooting
Les badges n’apparaissent pas badges-are-not-appearing
Si des règles de score et de badge ont été appliquées au contenu du site web, mais que des badges ne sont pas attribués pour une activité, assurez-vous que les badges ont été activés pour l’instance de ce composant.
Voir Activation des badges pour le composant.
La règle de notation est sans effet scoring-rule-has-no-effect
Si des règles de score et de badge ont été appliquées au contenu du site web et que des badges sont attribués à certaines actions, mais pas à d’autres, vérifiez que la règle de badge n’a pas limité les règles de score auxquelles elle s’applique.
Voir la propriété scoringRules de Règles de badge.
Frappe Sensible À La Casse case-sensitive-typo
La plupart des propriétés et des valeurs, en particulier les verbes, sont sensibles à la casse. Les verbes doivent être entièrement en MAJUSCULES lorsqu’ils sont utilisés dans une sous-règle de notation.
Si la fonctionnalité ne fonctionne pas comme prévu, assurez-vous que les données ont été correctement saisies.
Test rapide quick-test
Il est possible d’essayer rapidement de marquer et de badger à l’aide du site Tutoriel de prise en main (engage) :
-
Accédez à CRXDE Lite en mode de création.
-
Accédez à la page de base :
- /content/sites/engage/en/jcr:content
-
Ajoutez la propriété badgingRules :
- Nom :
badgingRules - Type :
String - Sélectionner Multi
- Sélectionnez Ajouter
- Enter
/libs/settings/community/badging/rules/forums-badging - Sélectionner +
- Enter
/libs/settings/community/badging/rules/comments-badging - Sélectionnez OK.
- Nom :
-
Ajoutez la propriété scoringRules :
- Nom :
scoringRules - Type :
String - Sélectionner Multi
- Sélectionnez Ajouter
- Enter
/libs/settings/community/scoring/rules/forums-scoring - Sélectionner +
- Enter
/libs/settings/community/scoring/rules/comments-scoring - Sélectionnez OK.
- Nom :
-
Sélectionnez Enregistrer tout.
Ensuite, assurez-vous que les composants forum et commentaires permettent l’affichage de badges :
-
Toujours à l’aide de CRXDE Lite.
-
Accédez au composant de forum
/content/sites/engage/en/forum/jcr:content/content/primary/forum
-
Ajoutez la propriété booléenne allowBadges , si nécessaire, et assurez-vous qu’elle est définie sur true.
- Nom :
allowBadges - Type :
Boolean - Valeur :
true
- Nom :
Ensuite, republiez le site de la communauté.
Enfin,
-
Accédez au composant sur l’instance de publication.
-
Connectez-vous en tant que membre de la communauté (par exemple, weston.mccall@dodgit.com / mot de passe).
-
Publier une nouvelle rubrique de forum.
-
La page doit être actualisée pour que le badge s’affiche.
- Déconnectez-vous et connectez-vous en tant que membre différent de la communauté (par exemple : aaron.mcdonald@mailinator.com/password).
-
Sélectionnez le forum.
Cela devrait permettre au membre de la communauté de gagner un badge en bronze visible avec sa publication sur le forum, car le premier seuil de la règle de badge des premiers forums est un score de 1.
Informations supplémentaires additional-information
Vous trouverez plus d’informations à ce sujet sur la page Notions fondamentales sur la notation et les badges destinée aux développeurs.
Pour plus d’informations sur le moteur de notation avancé, voir Notation avancée et pastilles.
Le tableau des scores configurable composant et fonction simplifie l’affichage des membres et de leurs scores sur un site communautaire.