Communities-Scoring und -Abzeichen communities-scoring-and-badges

Übersicht overview

Die AEM Communities-Scoring- und -Badges-Funktion bietet die Möglichkeit, Community-Mitglieder zu identifizieren und zu belohnen.

Die wichtigsten Aspekte von Scoring und Badges sind:

Hinweis die Vergabe von Abzeichen nicht standardmäßig aktiviert.

Zeichen badges

Abzeichen werden unter dem Namen eines Mitglieds platziert, um entweder ihre Rolle oder ihre Stellung in der Community anzugeben. Abzeichen können entweder als Bild oder als Name angezeigt werden. Wenn der Name als Bild angezeigt wird, wird er als alternativer Text für die Barrierefreiheit eingefügt.

Standardmäßig befinden sich Abzeichen im Repository unter

Wenn sie an einem anderen Speicherort gespeichert sind, sollten sie für alle lesbar sein.

Abzeichen werden in UGC dahingehend unterschieden, ob sie gemäß den Regeln zugewiesen wurden oder verdient wurden. Derzeit werden zugewiesene Abzeichen als Text und Earned Abzeichen als Bild angezeigt.

Benutzeroberfläche der Badge-Verwaltung badge-management-ui

Die Gemeinschaften Badges-Konsole bietet die Möglichkeit, benutzerdefinierte Abzeichen hinzuzufügen, die für ein Mitglied angezeigt werden können, wenn es eine bestimmte Rolle in der Community übernimmt (zugewiesen).

Zugewiesene Abzeichen assigned-badges

Rollenbasierte Abzeichen werden von einem Administrator den Community-Mitgliedern basierend auf ihrer Rolle in der Community zugewiesen.

Zugewiesene (und erwartete) Zeichen werden in der ausgewählten SRP und nicht direkt zugänglich sind. Solange keine grafische Benutzeroberfläche verfügbar ist, können rollenbasierte Abzeichen nur mit Code oder cURL zugewiesen werden. Anweisungen zu cURL finden Sie im Abschnitt mit dem Titel Zuweisen und Sperren von Abzeichen.

In der Version sind drei rollenbasierte Abzeichen enthalten:

Ausgezeichnete Abzeichen awarded-badges

Belohnungsbasierte Abzeichen werden vom Scoring-Dienst an Community-Mitglieder vergeben, basierend auf Regeln, die auf ihre Aktivität in der Community angewendet werden.

Damit Abzeichen als Belohnung für Aktivitäten angezeigt werden, müssen zwei Dinge geschehen:

In der Version sind drei belohnungsbasierte Abzeichen enthalten:

Benutzerdefinierte Abzeichen custom-badges

Benutzerdefinierte Abzeichen können mit der Badges-Konsole und entweder zugewiesen oder in Badging-Regeln angegeben.

Bei der Installation über die Badges-Konsole werden benutzerdefinierte Abzeichen automatisch in die Veröffentlichungsumgebung repliziert.

Scoring aktivieren enable-scoring

Die Auswertung ist standardmäßig nicht aktiviert. Die grundlegenden Schritte zum Einrichten und Aktivieren der Auswertung und Verleihung von Abzeichen sind:

Siehe Schnelltest -Abschnitt, um die Scoring-Funktion für eine Community-Site mithilfe der standardmäßigen Scoring- und Badging-Regeln für Foren und Kommentare zu aktivieren.

Regeln auf Inhalt anwenden apply-rules-to-content

Um Scoring und Badges zu aktivieren, fügen Sie die Eigenschaften hinzu scoringRules und badgingRuleszu einem beliebigen Knoten in der Inhaltsstruktur für die Site.

Wenn die Site bereits veröffentlicht wurde, veröffentlichen Sie die Site erneut, nachdem Sie alle Regeln angewendet und Komponenten aktiviert haben.

Regeln, die für eine Badging-fähige Komponente gelten, sind diejenigen für den aktuellen Knoten oder dessen Vorgänger.

Wenn der Knoten vom Typ cq:Page (empfohlen) und fügen Sie dann mithilfe von CRXDE|Lite die Eigenschaften zu seiner jcr:contentKnoten.

Aktivieren von Abzeichen für Komponenten enable-badges-for-component

Die Scoring- und Bading-Regeln sind nur für Instanzen von Komponenten wirksam, die Badging aktiviert haben, indem sie die Komponentenkonfiguration in Authoring-Modus.

eine boolesche Eigenschaft, allowBadgesaktiviert/deaktiviert die Anzeige von Abzeichen für eine Komponenteninstanz. Er kann im Dialogfeld "Komponentenbearbeitung" für Forum-, Fragen- und Kommentarkomponenten über ein Kontrollkästchen mit der Bezeichnung Anzeigemarken.

Beispiel: allowBadges für die Instanz der Forum-Komponente example-allowbadges-for-forum-component-instance

Scoring-Regeln scoring-rules

Scoring-Regeln sind die Grundlage für die Bewertung zum Zweck der Vergabe von Badges.

Jede Scoring-Regel ist ganz einfach eine Liste mit einer oder mehreren Unterregeln. Scoring-Regeln werden auf den Community-Site-Inhalt angewendet, um die Regeln zu identifizieren, die bei der Aktivierung von Badges angewendet werden sollen.

Scoring-Regeln werden vererbt, sind jedoch nicht additiv. Beispiel:

Wenn es mehr als eine Scoring-Regel gibt, werden die Werte für jede Regel separat beibehalten.

Scoring-Regeln sind Knoten des Typs cq:Page mit Eigenschaften auf jcr:content-Knoten, der die Liste der Unterregeln angibt, die ihn definieren.

Die Bewertungen werden im SRP gespeichert.

Scoring-Unterregeln scoring-sub-rules

Die Scoring-Unterregeln enthalten die Eigenschaften, die die Werte für die Teilnahme an der Community detailliert beschreiben.

Jede Scoring-Unterregel identifiziert

Standardmäßig werden Punkte dem Mitglied zugewiesen, das eine Aktion durchführt, es sei denn, die Unterregel legt den Eigentümer des Inhalts als Empfänger der Punkte fest ( forOwner).

Jede Unterregel kann in einer oder mehreren Scoring-Regeln enthalten sein.

Der Name der Unterregel folgt normalerweise dem Muster der Verwendung einer Betreff, Objekt und verb. Beispiel:

Unterregeln sind Knoten des Typs cq:Page mit Eigenschaften auf jcr:contentKnoten, der die verbs und topics .

Einbezogene Scoring-Regeln und Unterregeln included-scoring-rules-and-sub-rules

In der Version sind zwei Scoring-Regeln für die Forumsfunktion (jeweils eine für die Komponenten Forum und Kommentare der Funktion Forum ):

Anmerkungen:

Aktivieren benutzerdefinierter Scoring-Regeln activating-custom-scoring-rules

Änderungen oder Ergänzungen an Scoring-Regeln oder Unterregeln, die in der Autorenumgebung vorgenommen werden, müssen in der Veröffentlichungsumgebung installiert werden.

Badging-Regeln badging-rules

Badging-Regeln verknüpfen Scoring-Regeln mit Abzeichen, indem Folgendes angegeben wird:

Badging-Regeln sind Knoten des Typs cq:Page mit Eigenschaften auf jcr:content-Knoten, der Scoring-Regeln mit Bewertungen und Abzeichen korreliert.

Die Badging-Regeln beinhalten eine obligatorische thresholds-Eigenschaft, die eine geordnete Liste von Bewertungen darstellt, die Abzeichen zugeordnet sind. Die Werte müssen in zunehmendem Wert geordnet werden. Beispiel:

Badging-Regeln werden mit Scoring-Regeln gepaart, die bestimmen, wie Punkte gesammelt werden. Siehe Abschnitt mit dem Titel Regeln auf Inhalt anwenden.

Die scoringRules-Eigenschaft einer Badging-Regel schränkt einfach ein, welche Scoring-Regeln mit dieser Badging-Regel gepaart werden können.

Einbezogene Badging-Regeln included-badging-rules

In der Version sind zwei Badging-Regeln enthalten, die dem Foren und Kommentar-Scoring-Regeln.

Anmerkungen:

Aktivieren benutzerdefinierter Badging-Regeln activating-custom-badging-rules

Änderungen oder Ergänzungen an Badging-Regeln oder Bildern, die in der Autorenumgebung vorgenommen werden, müssen in der Veröffentlichungsumgebung installiert werden.

Zuweisen und Sperren von Abzeichen assign-and-revoke-badges

Abzeichen können Mitgliedern zugewiesen werden, indem sie entweder Mitgliederkonsole oder programmgesteuert mithilfe von cURL-Befehlen.

Die folgenden cURL-Befehle zeigen, was für eine HTTP-Anfrage zum Zuweisen und Sperren von Badges erforderlich ist. Das Standardformat lautet:

cURL -i -X POST -H header -u *signin * -F *operation * -F *badge * member-profile-url

header = "Accept:application/json"
Benutzerdefinierter Header, der an den Server übergeben wird (erforderlich)

Anmeldung = administrator-id:password
Beispiel: admin:admin

operation = ":operation=social:assignBadge" ODER ":operation=social:deleteBadge"

badge = "badgeContentPath=badge-image-file"

badge-image-file = Speicherort der Badge-Bilddatei im Repository
Beispiel: /etc/community/badging/images/moderator/jcr:content/moderator.png

member-profile-url = Endpunkt für das Profil des Mitglieds bei der Veröffentlichung
Beispiel: https://<server>:<port>/home/users/community/riley/profile.social.json

Beispiele: examples

Moderatorzeichen zuweisen assign-a-moderator-badge

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

Verknüpftes Silber-Zeichen sperren revoke-an-assigned-silver-badge

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

Scoring und Abzeichen für benutzerdefinierte Komponenten scoring-and-badges-for-custom-components

Scoring- und Badging-Regeln können für benutzerdefinierte Komponenten erstellt werden, indem die für die Komponente erstellten Ereignisthemen Verben zugeordnet werden.

Themen und Verben topics-and-verbs

Wenn Mitglieder mit Communities-Funktionen interagieren, werden Ereignisse gesendet, die asynchrone Listener wie Benachrichtigungen und Scoring Trigger werden können.

Die SocialEvent-Instanz einer Komponente zeichnet die Ereignisse als actionsdie für topic. Das SocialEvent enthält eine Methode zum Zurückgeben einer verbmit der Aktion verknüpft ist. Es gibt eine n-1 Beziehung actionsund verbs.

Die folgenden Tabellen beschreiben für die bereitgestellten Communities-Komponenten die verbsfür jeden topiczur Verwendung in Scoring-Unterregeln.

Kalenderkomponente
SocialEvent topic= com/adobe/cq/social/calendar

Kommentarkomponente
SocialEvent topic= com/adobe/cq/social/comment

Dateibibliothekskomponente
SocialEvent topic= com/adobe/cq/social/fileLibrary

Forumkomponente
SocialEvent topic= com/adobe/cq/social/forum

Journalkomponente
SocialEvent topic= com/adobe/cq/social/journal

QnA-Komponente
SocialEvent topic = com/adobe/cq/social/qna

Überprüfungskomponente
SocialEvent topic= com/adobe/cq/social/review

Bewertungskomponente
SocialEvent topic= com/adobe/cq/social/tally/rating

Abstimmungskomponente
SocialEvent topic= com/adobe/cq/social/tally/stimmberechtigt

Moderationsfähige Komponenten
SocialEvent topic= com/adobe/cq/social/moderation

Benutzerdefinierte Komponentenereignisse custom-component-events

Bei einer benutzerdefinierten Komponente wird ein SocialEvent instanziiert, um die Ereignisse der Komponente als actionsdie für topic.

Um die Auswertung zu unterstützen, muss das SocialEvent die Methode überschreiben getVerb() , damit verbwird für jeden action. Die verb für eine Aktion zurückgegeben wird, kann eine häufig verwendete Aktion sein (z. B. POST) oder einer für die Komponente spezialisierten Komponente (z. B. ADD RATING). Es gibt eine n-1 Beziehung actionsund verbs.

Fehlerbehebung troubleshooting

Abzeichen werden nicht angezeigt badges-are-not-appearing

Wenn Scoring- und Badging-Regeln auf den Inhalt der Website angewendet wurden, Abzeichen jedoch für keine Aktivität erwartet werden, stellen Sie sicher, dass Abzeichen für die Instanz dieser Komponente aktiviert wurden.

Siehe Aktivieren von Abzeichen für Komponenten.

Scoring-Regel hat keine Auswirkung scoring-rule-has-no-effect

Wenn Scoring- und Badging-Regeln auf den Inhalt der Website angewendet wurden und Abzeichen für einige Aktionen, aber nicht für andere zugewiesen werden, überprüfen Sie, ob die Badging-Regel die Scoring-Regeln, für die sie gilt, nicht eingeschränkt hat.

Siehe scoringRulesEigenschaft von Badging-Regeln.

Groß-/Kleinschreibung case-sensitive-typo

Bei den meisten Eigenschaften und Werten, insbesondere den Verben, wird zwischen Groß- und Kleinschreibung unterschieden. Verben müssen bei Verwendung in einer Scoring-Unterregel alle UPPERCASE sein.

Wenn die Funktion nicht wie erwartet funktioniert, stellen Sie sicher, dass die Daten korrekt eingegeben wurden.

Schnelltest quick-test

Mit dem Tutorial "Erste Schritte" Site (engagieren):

Stellen Sie als Nächstes sicher, dass die Forum- und Kommentarkomponenten die Anzeige von Abzeichen zulassen:

Als Nächstes erneut veröffentlichen die Community-Site.

Abschließend,

Dies sollte dem Community-Mitglied ein Bronzesymbol mit seinem Forumsbeitrag vermitteln, da der erste Schwellenwert der Regel für Forumsabzeichen 1 beträgt.

Zusätzliche Informationen additional-information

Weitere Informationen finden Sie unter Grundlagen zu Scoring und Abzeichen für Entwickler.

Informationen zur erweiterten Scoring-Engine finden Sie unter Erweiterte Scoring- und Badges.

Das konfigurierbare Leaderboard component und function vereinfacht die Anzeige von Mitgliedern und deren Ergebnissen auf einer Community-Site.