Scores et badges des communautés

Présentation

La fonction de notation et de badges 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 :

• Attribuer des badges pour identifier le rôle d'un membre dans la communauté

• Attribution de base de badgestes aux membres pour encourager leur participation (quantité de contenu créé)

• Attribution avancée de badgess pour identifier les membres comme experts (qualité du contenu créé)

​​Notez que l’attribution de badges n’est pas activée par défaut.

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 en tant que 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 selon qu'ils ont été attribués ou acquis selon les règles. Actuellement, les badges attribués apparaissent sous forme de texte et les badges gagnés apparaissent sous forme d’image.

Interface utilisateur de gestion des badges

La console Communautés Badges 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 affectés

Un administrateur attribue aux membres de la communauté des badges fondés sur le rôle en fonction de leur rôle dans la communauté.

Les badges attribués (et attribués) sont stockés dans le SRP sélectionné et ne sont pas directement accessibles. Tant qu’une interface graphique n’est pas disponible, le seul moyen d’attribuer des badges basés sur les rôles consiste à le faire avec du code ou de l’URL. Pour obtenir des instructions sur les 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 groupes

  /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 attribués

Le service de notation accorde aux membres de la communauté des badges récompensés 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é.

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

Badges personnalisés

Les badges personnalisés peuvent être installés à l'aide de la console 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 pour la configuration et l'activation de la notation et de l'attribution des badges sont les suivantes :

• Identifier les règles pour les points de rémunération (règles de notation)

• Pour les points cumulés par règle de score, affectez badges (règles de badge)

• Appliquer les règles de notation et de badge à un site communautaire

• Activation du badge 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.

Appliquer des règles au contenu

Pour activer la notation et les badges, ajoutez les propriétés scoringRules et badgingRulesà tout 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:contentnoeud à l'aide de CRXDE|Lite.

Propriété	Type	Description
badgingRules	Chaîne[]	une liste de tableau de règles de badge
scoringRules	Chaîne[]	une liste de tableau de règles de score

Activer les badges pour le composant

Les règles d’évaluation et de classement ne sont en vigueur que pour les instances de composants qui ont activé la mise en badge en modifiant la configuration du composant en mode de création.

Une 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 de modification des composants pour les composants de forum, de QnA et de commentaires par le biais d'une case à cocher intitulée Afficher les badges.

Exemple : allowBadges pour l'instance de composant Forum

Règles de score

Les règles de score sont la base de la notation pour l’attribution de 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é afin d’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 le 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.

Lorsqu’il existe plusieurs règles de score, 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:contentnoeud qui spécifient la liste des sous-règles qui le définissent.

Les scores sont stockés dans SRP.

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 sont les activités 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, objet et verbe. Par exemple :

• membre-commentaire-créer
• membre-réception-vote

Les sous-règles sont des noeuds de type cq:Page avec des propriétés sur son jcr:contentnoeud qui spécifient les verbes et rubriques.

Propriété	Type	Valeur Description
VERB	Long	requis ; le verbe correspond à une action de événement il doit y avoir au moins une propriété verbe le verbe doit être saisi en UPPERCASE il peut y avoir plusieurs propriétés de verbes, mais aucun duplicata la valeur est le score à appliquer pour ce événement la valeur peut être positive ou négative une liste de verbes prise en charge dans la version se trouve dans la section Rubriques et verbes.
topics	Chaîne[]	facultatif ; restreint la sous-règle aux composants de la communauté identifiés par des sujets de événement si spécifié : est une chaîne de plusieurs valeurs de rubriques de événement une liste des rubriques de la version se trouve dans la section Rubriques et verbes. par défaut est appliquée à 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, appliquer un score à l'action du membre false par défaut
scoringType	Chaîne	facultatif ; identifie le moteur de notation si "de base", spécifie le moteur de notation en fonction de la quantité inclus dans la version si "avancé", indique le moteur de notation en fonction de la qualité et de la quantité nécessite un package supplémentaire default is "basic"

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

Cette version comprend deux règles de notation pour la fonction Forum (une pour les composants Forum et Commentaires de la fonction Forum) :

1. /etc/community/score/rules/commentaires-score

   • subRules[] =

     /etc/community/scoring/rules/sub-rules/members-comment-create

     /etc/community/scoring/rules/sub-rules/members-receive-vote

     /etc/community/scoring/rules/sub-rules/members-don-vote

     /etc/community/scoring/rules/sub-rules/members-is-modérated

2. /etc/community/scoring/rules/forums-score

   • subRules[] =

     /etc/community/scoring/rules/sub-rules/membre-forum-create

     /etc/community/scoring/rules/sub-rules/members-receive-vote

     /etc/community/scoring/rules/sub-rules/members-don-vote

     /etc/community/scoring/rules/sub-rules/members-is-modérated

Remarques:

• Les noeuds ruleset sub-rules sont de type cq:Page

• subRulesest un attribut de type [] Stringon the rule's jcr:content node

• sub-rules peut être partagée entre différentes règles de notation

• rulesdoit ê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 d’auteur doit être installé lors de la publication.

Règles d’insigne

Les règles de mise en 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:contentnoeud qui mettent en corrélation les règles de score avec les scores et les badges.

Les règles de badge consistent en une propriété thresholdsobligatoire qui est une liste ordonnée de scores mappés à des badges. Les scores doivent être trié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 attribué lorsque 80 points ont été accumulés

Les règles de badge sont associées à des règles de score, qui déterminent comment les points s’accumulent. Voir la section intitulée Appliquer des règles au contenu.

La propriété scoringRulesd'une règle de badge limite simplement les règles de score qui peuvent être associées à cette règle de badge particulière.

Propriété	Type	Valeur Description
seuils	Chaîne[]	(obligatoire) Chaîne à plusieurs valeurs du formulaire "numéro|chemin" nombre = score | = la ligne verticale char (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 vide 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 d’évaluation comme étant "de base" ou "avancé". Si vous souhaitez utiliser le moteur de score avancé, voir Advanced Scoring and Badges. La valeur par défaut est "basic".
scoringRules	Chaîne[]	(facultatif) Chaîne à plusieurs valeurs pour limiter la règle de badge aux événements de notation identifiés par les règles de notation

Règles de mise en badge incluses

Cette version comprend deux règles de mise en badge qui correspondent aux Forums et aux règles de score des commentaires.

• /etc/community/badging/rules/comments-badging
• /etc/community/badging/rules/forums-badging

Remarques:

• rules les noeuds sont de type cq:Page

• rulesdoit ê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é

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

Affectation et révocation de badges

Des badges peuvent être attribués à des membres à l'aide de la console members 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 = "Accepter:application/json"
en-tête personnalisé à transmettre au serveur (obligatoire)

signature = administrator-id:password
par exemple : admin:admin

operation = ":operation=social:assignBadge" OU ":operation=social:deleteBadge"

badge = "badgeContentPath=badge-image-file"

badge-image-file = l’emplacement du fichier image de badge dans le référentiel.
par exemple : /etc/community/badging/images/modérator/jcr:content/moderator.png

Member-profil-url = point de terminaison du profil du membre lors de la publication
par exemple : https://<serveur>:<port>/home/users/community/riley/profile.social.json

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évoquer un badge argenté affecté

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

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 de é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 sous la forme actionsqui se produisent pour un topic. SocialEvent inclut une méthode permettant de renvoyer une verbvaleur associée à l’action. Il existe une relation n-1 entre actionset verbs.

Pour les composants de communautés livrés, les tableaux suivants décrivent les verbsdéfinies pour chaque topicdisponible pour l'utilisation dans sous-règles de notation.

Calendrier
ComponentSocialEvent topic= com/adobe/cq/social/calendar

Verbe	Description
POST	crée un événement de calendrier
AJOUTER	commentaires d'un membre sur un événement de calendrier
UPDATE	le événement de calendrier ou le commentaire du membre est modifié
DELETE	le événement de calendrier ou le commentaire du membre est supprimé

Commentaires
ComponentSocialEvent topic= com/adobe/cq/social/comment

Verbe	Description
POST	crée un commentaire
AJOUTER	réponse du membre au commentaire
METTRE À JOUR	le commentaire du membre est modifié
DELETE	le commentaire du membre est supprimé

File Library
ComponentSocialEvent topic= com/adobe/cq/social/fileLibrary

Verbe	Description
POST	crée un dossier
ATTAQUE	le membre télécharge un fichier
METTRE À JOUR	met à jour un dossier ou un fichier
DELETE	supprime un dossier ou un fichier

Forum
ComponentSocialEvent 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
METTRE À JOUR	le sujet ou la réponse du forum du membre est modifié
DELETE	le sujet ou la réponse du membre du forum est supprimé

Journal
ComponentSocialEvent 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
METTRE À JOUR	article ou commentaire du blog du membre modifié
DELETE	article ou commentaire du blog du membre supprimé

QnA
ComponentSocialEvent topic = com/adobe/cq/social/qna

Verbe	Description
POST	crée une question QnA
AJOUTER	crée une réponse QnA
METTRE À JOUR	Question ou réponse QnA du membre 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	QnUne question ou réponse du membre est supprimée

Critiques
ComponentSocialEvent topic= com/adobe/cq/social/review

Verbe	Description
POST	membre crée une révision
METTRE À JOUR	révision du membre est modifiée
DELETE	la révision du membre est supprimée

Evaluation
ComponentSocialEvent topic= com/adobe/cq/social/tally/rating

Verbe	Description
AJOUTE	le contenu du membre a été amélioré
SUPPRESSION DE LA COTE	le contenu du membre a été réduit

Vote du
composantSocialEvent topic= com/adobe/cq/social/tally/vote

Verbe	Description
AJOUTER VOTE	le contenu du député a été voté
SUPPRIMER LE VOTE	le contenu du député a été rejeté, voté

Composants prenant en charge la modérationSocialEvent topic= com/adobe/cq/social/modération

Verbe	Description
DENY	le contenu du membre est refusé
INDICATEUR 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

Événements de composants personnalisés

Pour un composant personnalisé, un SocialEvent est appelé pour enregistrer les événements du composant sous la forme actionsqui se produisent pour un topic.

Pour prendre en charge le score, SocialEvent doit remplacer la méthode getVerb() afin qu’un verbapproprié soit renvoyé pour chaque action. L'élément verb renvoyé pour une action peut être couramment utilisé (tel que POST) ou spécialisé pour le composant (tel que ADD RATING). Il existe une relation n-1 entre actionset verbs.

Résolution des incidents

Les badges n'apparaissent 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.

Voir Activer les badges pour le composant.

La règle de score n'a aucun 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 propriété scoringRulesdes Règles d'insigne.

Type sensible à la casse

La plupart des propriétés et valeurs, en particulier les verbes, sont sensibles à la casse. Les verbes doivent être en MAJUSCULES 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 Didacticiel de prise en main (engager) :

• Accéder au CRXDE Lite sur l’auteur

• Accédez à la page de base :

  • /content/sites/learn/fr/jcr:content

• Ajoutez la propriété badgingRules :

  • Nom : badgingRules
  • Type : String
  • Sélectionner Multi
  • Sélectionner Ajouter
  • Enter /etc/community/badging/rules/forums-badging
  • Sélectionner +
  • Saisissez /etc/community/badging/rules/comments-badging
  • Cliquez sur OK

• Ajoutez la propriété scoringRules :

  • Nom : scoringRules
  • Type : String
  • Sélectionner Multi
  • Sélectionner Ajouter
  • Saisissez /etc/community/scoring/rules/forums-scoring
  • Sélectionner +
  • Saisissez /etc/community/scoring/rules/comments-scoring
  • Cliquez sur OK

• Sélectionner Enregistrer tout

Ensuite, assurez-vous que les composants du forum et des commentaires permettent l'affichage des badges :

• Utilisation de nouveau du 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 vraie.

  • Nom : allowBadges
  • Type : Boolean
  • Valeur: true

Ensuite, republier le site communautaire.

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 un nouveau sujet de forum

• La page doit être actualisée pour que le badge s’affiche.

  • Déconnexion et connexion en tant que membre de la communauté différent (par exemple : aaron.mcdonald@mailinator.com / mot de passe)

• Sélectionner le forum

Cela devrait permettre au membre de la communauté d'obtenir un badge en bronze visible avec son billet sur le forum car le premier seuil de la règle de badge de forums est un score de 1.

Informations supplémentaires

Pour plus d'informations, consultez la page Scoring and Badges Essentials destinée aux développeurs.

Pour plus d’informations sur le moteur de score avancé, voir Advanced Scoring and Badges.

Le tableau de bord configurable composant et fonction simplifie l'affichage des membres et leurs scores sur un site communautaire.