Show Menu
SUJETS×

Score et badges des communautés

Présentation

La fonction de notation et de badges des communautés AEM permet d’identifier et de récompenser les membres de la communauté.
Les principaux aspects de la notation et des insignes sont les suivants :
Notez que l’attribution de badges n’est pas activée par défaut .
La structure d’implémentation visible dans CRXDE Lite peut être modifiée une fois que l’interface utilisateur est disponible.

Badges

Les insignes sont placés sous le nom d'un membre pour indiquer soit son rôle, soit son statut 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 comme texte de remplacement pour l’accessibilité.
Par défaut, les badges se trouvent dans le référentiel à l’adresse
  • /etc/community/badging/images
S’ils sont stockés à un autre emplacement, ils doivent être lus accessibles à tous.
Les insignes sont différenciés en UGC quant à savoir s'ils ont été attribués ou s'ils ont été acquis 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

La console Badges communautaires permet d'ajouter des badges personnalisés qui peuvent être affichés pour un membre lorsqu'il est gagné (attribué) ou lorsqu'il assume un rôle spécifique dans la communauté (attribué).

Badges attribués

Un administrateur attribue aux membres de la collectivité des badges fondés sur le rôle en fonction de leur rôle dans la collectivité.
Les badges attribués (et 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 consiste à utiliser du code ou cURL. Pour obtenir des instructions sur l’URL, voir la section intitulée Attribuer et révoquer des badges .
Cette version comprend trois badges basés sur les rôles :
  • Modérateur
    /etc/community/badging/images/moderator/jcr:content/moderator.png
  • Gestionnaire de groupe
    /etc/community/badging/images/group-manager/jcr:content/group-manager.png
  • Membre privilégié
    /etc/community/badging/images/privileged-member/jcr:content/privileged-member.png

Badges décernés

Le service de notation décerne aux membres de la collectivité des badges de récompense en fonction des règles appliquées à leur activité dans la collectivité.
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 ancêtre) sur laquelle le composant est placé.
La version comprend trois badges basés sur la récompense :
  • Or
    /etc/community/badging/images/gold-badge/jcr:content/gold.png
  • Argent
    /etc/community/badging/images/silver-badge/jcr:content/silver.png
  • Bronze
    /etc/community/badging/images/bronze-badge/jcr:content/bronze.png
Les règles de score peuvent être configurées pour affecter des points négatifs aux publications marquées comme inappropriées et affecter ainsi la valeur de score. Cependant, une fois qu’un badge est gagné, il n’est pas automatiquement supprimé en raison de la réduction du point de notation ou des modifications apportées aux règles de notation.
Les badges attribués peuvent être révoqués de la même manière que les badges attribués. Voir la section Attribuer et révoquer des badges . Les améliorations futures comprendront une interface utilisateur pour gérer les badges des membres.

Badges personnalisés

Les badges personnalisés peuvent être installés à l’aide de la console Console Badges Badges et être affectés ou spécifiés dans les 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 le score

Le score n’est pas activé par défaut. Les étapes de base de la configuration et de l’activation de la notation et de l’attribution des badges sont les suivantes :
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.

Appliquer des règles au contenu

Pour activer les scores et les badges, ajoutez les propriétés scoringRules et badgingRules à n’importe quel noeud 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é par badge sont celles du noeud actif ou de son ancêtre.
Si le noeud est de type cq:Page (recommandé), ajoutez les propriétés à son jcr:content noeud à l’aide de CRXDE|Lite.
Propriété
Type
Description
badgingRules
Chaîne #
une liste de règles de mise en badge
scoringRules
Chaîne #
une liste de tableaux de règles de notation
Si une règle d’évaluation ne semble pas avoir d’effet sur l’attribution des badges, assurez-vous que la règle d’évaluation n’a pas été bloquée par la propriété scoringRules de la règle d’évaluation. Voir la section intitulée Règles de badge.

Activer les badges pour le composant

Les règles de notation et de bourrage sont en vigueur uniquement pour les instances de composants qui ont activé le badge en modifiant la configuration du composant en mode de création.
Propriété booléenne allowBadges , active/désactive l’affichage des badges pour une instance de composant. Il est configurable dans la boîte de dialogue d’édition des composants pour les composants forum, QnA et de commentaire via une case à cocher intitulée Afficher les badges .

Exemple : allowBadges pour l’instance de composant Forum

N’importe quel composant peut être superposé pour afficher les badges à l’aide du code HBS trouvé dans les forums, QnA et les commentaires comme exemple.

Règles de score

Les règles de notation sont la base de la notation pour l’attribution des badges.
Très simplement, chaque règle de score est une liste d’une ou de plusieurs sous-règles. Des 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 pas additifs. Par exemple :
  • Si la page2 contient la règle de score2 et sa 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 la règle2 affectera le score
    • Les scores des deux sous-règles ne sont pas additionnés.
S’il existe plusieurs règles de notation, les scores sont conservés séparément pour chaque règle.
Les règles de score sont des noeuds de type cq:Page avec des propriétés sur son jcr:content noeud qui spécifient la liste des sous-règles qui le définissent.
Les scores sont stockés dans SRP.
Meilleure pratique : attribuez un nom unique à chaque règle de score.
Les noms des règles de score doivent être uniques au niveau mondial ; ils ne doivent pas se terminer par le même nom.
Voici un exemple de ce que ne pas faire : /etc/community/score/rule/site1/forums-score /etc/community/score/rule/site2/forums-score

Sous-règles de score

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 activités sont suivies ?
  • Quelle fonction communautaire spécifique implique ?
  • Nombre de points attribués
Par défaut, les points sont attribués au membre qui agit, sauf si la sous-règle spécifie le propriétaire du contenu comme recevant 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 sujet, d’un objet et d’un verbe . Par exemple :
  • members-comment-create
  • membre-bénéficiaire-vote
Les sous-règles sont des noeuds de type cq:Page avec des propriétés sur son jcr:content noeud qui spécifient les verbes et les rubriques .
Propriétés Type Description de la valeur
VERB Long
  • requis; le verbe correspond à une action d’événement.
  • il doit y avoir au moins une propriété verb
  • le verbe doit être saisi en MAJUSCULE
  • il peut exister plusieurs propriétés de verbe, mais pas de doublons
  • la valeur est le score à appliquer pour cet événement
  • la valeur peut être positive ou négative
  • la liste des verbes pris en charge dans cette version figure dans la section Rubriques et verbes .
topics Chaîne[]
  • facultatif; limite la sous-règle aux composants de la communauté identifiés par les rubriques d’événement.
  • si spécifié : est une chaîne de plusieurs valeurs des rubriques d’événement
  • la liste des rubriques de la version se trouve dans la section Rubriques et versions .
  • s’applique par défaut à toutes les rubriques associées aux verbes.
forOwner Booléen
  • facultatif; n'est pas pertinent lorsque le membre agit sur le contenu qu'il possède
  • si la valeur est true, appliquez un score au propriétaire du contenu concerné
  • si la valeur est false, appliquez un score à l’action du membre
  • default est false
scoringType Chaîne
  • facultatif; identifie le moteur de notation
  • si "de base", indique le moteur de notation en fonction de la quantité
    • inclus dans la version
  • si "advanced", indique le moteur de notation en fonction de la qualité et de la quantité
  • default is "basic"

Règles et sous-règles de score incluses

Cette version comprend deux règles de notation pour la fonction du forum (une pour chacune des composantes du forum et des commentaires) :
  1. /etc/community/score/rule/commentaires-score
    • subRules # =
      /etc/community/score/rule/sub-rule/members-comment-create
      /etc/community/score/rule/sub-rule/members-receive-vote
      /etc/community/score/rule/sub-rule/members-don-vote
      /etc/community/score/rule/sub-rule/members-is-modérated
  2. /etc/community/score/rule/forums-score
    • subRules # =
      /etc/community/score/rule/sub-rule/members-forum-create
      /etc/community/score/rule/sub-rule/members-receive-vote
      /etc/community/score/rule/sub-rule/members-don-vote
      /etc/community/score/rule/sub-rule/members-is-modérated
Remarque:
  • Les deux rules et sub-rules les noeuds sont de type cq:Page
  • subRules est un attribut de type String # sur le jcr:content noeud de la règle
  • sub-rules peut être partagée entre différentes règles de notation
  • rules doit être situé dans un emplacement de référentiel avec une autorisation de lecture pour tout le monde
    • Les noms de règle doivent être uniques quel que soit l’emplacement

Activation de règles de score personnalisées

Toute modification ou tout ajout apporté aux règles de notation ou aux sous-règles apportées dans l’environnement de création doit être installé lors de la publication.

Règles de badge

Les règles de badge lient les règles de notation aux badges en spécifiant :
  • Quelle règle de score
  • Le score nécessaire pour obtenir un badge spécifique
Les règles de badge sont des noeuds de type cq:Page avec des propriétés sur son jcr:content noeud qui corrélent les règles de notation aux scores et aux badges.
Les règles de badge se composent d’une thresholds propriété obligatoire qui est une liste ordonnée de scores mappés sur des badges. Les scores doivent être classés en valeur croissante. Par exemple :
  • 1|/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
    • Un badge en bronze est décerné pour avoir gagné 1 point
  • 60|/etc/community/badging/images/silver-badge/jcr:content/silver.png
    • Un badge d'argent est attribué lorsque 60 points ont été accumulés
  • 80|/etc/community/badging/images/gold-badge/jcr:content/gold.png
    • Un badge d'or est décerné lorsque 80 points ont été accumulés
Les règles de badge sont associées aux règles de notation, qui déterminent le mode d’accumulation des points. Voir la section intitulée Appliquer des règles au contenu .
La scoringRules propriété d’une règle de badge limite simplement les règles de notation qui peuvent être associées à cette règle de badge particulière.
Meilleure pratique : créez des images de badge propres à chaque site AEM.
Propriétés Type Description de la valeur
seuils Chaîne[] (obligatoire) Chaîne à plusieurs valeurs du formulaire "number|path"
  • nombre = score
  • | = le caractère de ligne verticale (U+007C)
  • chemin = chemin complet vers la ressource image de badge
Les chaînes doivent être triées afin que les nombres augmentent en valeur et qu’aucun espace blanc ne s’affiche entre le nombre et le chemin. Exemple d’entrée : 80|/etc/community/badging/images/gold-badge/jcr:content/gold.png
badgingType Chaîne (Facultatif) Identifie le moteur de notation comme étant "de base" ou "avancé". Si vous souhaitez utiliser le moteur de notation avancé, voir Scores et badges avancés. La valeur par défaut est "basic".
scoringRules Chaîne[] ( facultatif ) Chaîne à plusieurs valeurs qui limite la règle de badge aux événements de notation identifiés par les règles de notation

Règles de badge incluses

Cette version comprend deux règles de mise en badge qui correspondent aux règles de notation des commentaires et des forums.
  • /etc/community/badging/Rules/Comments-badging
  • /etc/community/badging/Rules/forums-badging
Remarque:
  • rules les noeuds sont de type cq:Page
  • rules doit être situé dans un emplacement de référentiel avec une autorisation de lecture pour tout le monde
    • Les noms de règle doivent être uniques quel que soit l’emplacement

Activation de règles de badge personnalisées

Toute modification ou tout ajout apporté aux règles de mise en badge ou aux images effectuées dans l’environnement de création doit être installé lors de la publication.

Affectation et révocation de badges

Des badges peuvent être attribués aux membres à l’aide de la console BADGES, panneau membres ou par programmation à l’aide des commandes cURL.
Les commandes cURL suivantes indiquent ce qui est nécessaire pour une demande HTTP d’attribution et de révocation de badges. Le format de base est le suivant :
cURL -i -X POST -H header -u *signature * -F *opération * -F *badge * membre-profil-url
header = "Accept:application/json" en-tête personnalisé à transmettre au serveur (obligatoire)
signature = administrator-id:password par exemple : admin:admin
operation = ":operation=social:assignBadge" OR ":operation=social:deleteBadge"
badge = "badgeContentPath= badge-image-file "
badge-image-file = emplacement du fichier image de badge dans le référentiel par exemple : content/moderator.png
members-profile-url = point de terminaison du profil du membre lors de la publication par exemple : https://<serveur>:<port>/home/users/community/riley/profile.social.json
Le membre-profil-url
  • Peut faire référence à une instance d’auteur si le service Service Tunnel tunnel est activé
  • Peut être un nom aléatoire et obscur - voir Liste de contrôle de sécurité concernant l'ID autorisé

Exemples:

Attribuer un badge de modérateur

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

Révocation d’un badge d’argent attribué

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

L’utilisation de cURL pour attribuer et révoquer des badges fonctionne pour n’importe quelle image de badge, mais lorsqu’elle est attribuée à la place d’un badge gagné, elle est marquée comme un badge attribué et gérée en conséquence.

Scores et badges pour les composants personnalisés

Il est possible de créer des règles de score et de badge pour les composants personnalisés en associant les rubriques d’événement créées pour le composant aux verbes.

Rubriques et verbes

Lorsque les membres interagissent avec les fonctionnalités des communautés, des événements sont envoyés, qui peuvent déclencher des écouteurs asynchrones, tels que des notifications et des scores.
L’instance SocialEvent d’un composant enregistre les événements comme actions cela se produit pour un topic composant. SocialEvent inclut une méthode pour renvoyer une verb associée à l’action. Il existe une relation n-1 entre actions et verbs .
Pour les composants de communautés livrés, les tableaux suivants décrivent les verbs paramètres définis pour chaque topic disponible à utiliser dans les sous-règles de notation.
Une nouvelle propriété booléenne allowBadges , active/désactive l’affichage des badges pour une instance de composant. Il sera configurable dans les boîtes de dialogue de modification des composants mises à jour par le biais d’une case à cocher intitulée Badges d’affichage.
Composant ​Calendrier SocialEvent topic = com/adobe/cq/social/calendar
Verbe
Description
POST
crée un événement de calendrier
AJOUTER
commentaires de membre sur un événement de calendrier
UPDATE
l’événement de calendrier ou le commentaire du membre est modifié.
DELETE
l’événement de calendrier ou le commentaire du membre est supprimé
Composant ​de commentaires SocialEvent topic = com/adobe/cq/social/comment
Verbe
Description
POST
crée un commentaire
AJOUTER
les réponses du membre au commentaire
UPDATE
le commentaire du membre est modifié.
DELETE
commentaire du membre supprimé
Composant ​de bibliothèque de fichiers SocialEvent topic = com/adobe/cq/social/fileLibrary
Verbe
Description
POST
crée un dossier
ATTAQUE
le membre télécharge un fichier
UPDATE
met à jour un dossier ou un fichier
DELETE
supprime un dossier ou un fichier
Composant ​du forum SocialEvent topic = com/adobe/cq/social/forum
Verbe
Description
POST
membre crée une rubrique de forum
AJOUTER
réponses des membres au sujet du forum
UPDATE
Le sujet ou la réponse du membre du forum est modifié
DELETE
Le sujet ou la réponse du membre du forum est supprimé
Composant ​du journal SocialEvent topic = com/adobe/cq/social/journal
Verbe
Description
POST
crée un article de blog
AJOUTER
commentaires d'un membre sur un article de blog
UPDATE
l’article ou le commentaire du blog du membre est modifié.
DELETE
article ou commentaire de blog du membre supprimé
Composant ​QA SocialEvent topic = com/adobe/cq/social/qna
Verbe
Description
POST
crée une question QnA
AJOUTER
crée une réponse QnA
UPDATE
QnUne question ou une réponse du membre est modifiée
SELECT
la réponse du membre est sélectionnée
DÉSÉLECTIONNER
la réponse du membre est désélectionnée
DELETE
qualité du membre Une question ou une réponse est supprimée
Composant ​Révisions SocialEvent topic = com/adobe/cq/social/review
Verbe
Description
POST
membre crée une révision
UPDATE
révision du membre est modifiée
DELETE
la révision du membre est supprimée
Composant ​de notation SocialEvent topic = com/adobe/cq/social/tally/rating
Verbe
Description
AJOUTER UNE COTATION
le contenu du membre a été amélioré
SUPPRIMER LA COTE
le contenu du membre a été mal évalué
Composant ​de vote SocialEvent topic = com/adobe/cq/social/tally/vote
Verbe
Description
AJOUTER UN VOTE
le contenu du membre a été voté
SUPPRIMER LE VOTE
le contenu du membre a été rejeté
Composants SocialEvent prenant en charge la modération topic = com/adobe/cq/social/modération
Verbe
Description
DENY
contenu du membre refusé
INDICATEUR COMME INAPPROPRIÉ
le contenu du membre est marqué
INAPPROPRIÉ
le contenu du membre n’est pas marqué
ACCEPTER
le contenu du membre est approuvé par le modérateur
CLOSE
le membre ferme les commentaires aux modifications et aux réponses
OUVRIR
membre réouvre le commentaire

Evénements de composant personnalisés

Dans le cas d’un composant personnalisé, un événement SocialEvent est appelé pour enregistrer les événements du composant comme actions cela se produit pour un topic composant.
Pour prendre en charge la notation, SocialEvent doit remplacer la méthode getVerb() afin qu’un paramètre approprié verb soit renvoyé pour chaque action événement. Le verb retour d’une action peut être un élément couramment utilisé ( POST ) ou spécialisé pour le composant ( ADD RATING ). Il existe une relation n-1 entre actions et verbs .

Résolution des incidents

Les badges ne s’affichent pas

Si des règles de notation et de badge ont été appliquées au contenu du site Web, mais que les badges ne sont attribués à aucune activité, assurez-vous que les badges ont été activés pour l’instance de ce composant.

Règle de score sans effet

Si des règles de notation et de badge ont été appliquées au contenu du site Web et que des badges sont attribués pour certaines actions, mais pas pour d’autres, vérifiez que la règle de badge n’a pas limité les règles de notation auxquelles elle s’applique.
Voir la scoringRules propriété des règles de badge.

Type sensible à la casse

La plupart des propriétés et des valeurs, en particulier les verbes, sont sensibles à la casse. Les verbes doivent être tous en MAJUSCULE lorsqu’ils sont utilisés dans une sous-règle de score.
Si la fonction ne fonctionne pas comme prévu, assurez-vous que les données ont été saisies correctement.

Test rapide

Il est possible d’essayer rapidement de marquer et de marquer des points à l’aide du site Getting Started Tutorial (engager) :
  • Accès à CRXDE Lite sur l’auteur
  • Accédez à la page de base :
    • /content/sites/interaction/fr/jcr:content
  • Ajoutez la propriété badgingRules :
    • Nom : badgingRules
    • Type : String
    • Sélectionner plusieurs
    • Sélectionner Ajouter
    • Enter /etc/community/badging/rules/forums-badging
    • Sélectionner +
    • Enter /etc/community/badging/rules/comments-badging
    • Cliquez sur OK
  • Ajoutez la propriété scoringRules :
    • Nom : scoringRules
    • Type : String
    • Sélectionner plusieurs
    • Sélectionner Ajouter
    • Enter /etc/community/scoring/rules/forums-scoring
    • Sélectionner +
    • Enter /etc/community/scoring/rules/comments-scoring
    • Cliquez sur OK
  • Select Save All
Ensuite, assurez-vous que les composants du forum et des commentaires permettent l’affichage des badges :
  • Utilisation 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
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 / password)
  • Publication d’un nouveau sujet de forum
  • La page doit être actualisée pour que le badge s’affiche.
  • Sélectionner le forum
Cela devrait permettre au membre de la communauté de recevoir un badge en bronze visible avec son billet sur le forum, car le premier seuil de la règle de badge sur les forums est un score de 1.

Informations supplémentaires

More information may be found on the Scoring and Badges Essentials page for developers.
Pour plus d’informations sur le moteur de notation avancé, voir Advanced Scoring and Badges (Note et badges avancés).
Le composant et la fonction configurable du Tableau de bord simplifie l’affichage des membres et de leurs scores sur un site communautaire.