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

Überblick 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: Das Verteilen von Abzeichen ist standardmäßig nicht 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.

Badges werden in UGC 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

Mit der Communities Badges-Konsole können Sie benutzerdefinierte Abzeichen hinzufügen, die für ein Mitglied angezeigt werden können, wenn es eine bestimmte Rolle in der Community spielt (zugewiesen).

Zugewiesene Abzeichen assigned-badges

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

Zugewiesene (und vergebene) Badges werden im ausgewählten SRP gespeichert und sind nicht direkt zugänglich. 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:

Ausgegebene 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 Badges können mithilfe der Badges Console installiert und in Badging-Regeln zugewiesen oder angegeben werden.

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:

Informationen zum Aktivieren der Scoring-Funktion für eine Community-Site mithilfe der standardmäßigen Scoring- und Badging-Regeln für Foren und Kommentare finden Sie im Abschnitt Schnelltest .

Regeln auf Inhalt anwenden apply-rules-to-content

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

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 den Typ "cq:Page"(empfohlen) aufweist und dann CRXDE|Lite verwendet, fügen Sie die Eigenschaften seinem Knoten "jcr:content"hinzu.

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

Die Scoring- und Bading-Regeln gelten nur für Instanzen von Komponenten, die das Badging durch Bearbeiten der Komponentenkonfiguration im Authoring-Modus aktiviert haben.

Eine boolesche Eigenschaft allowBadges aktiviert/deaktiviert die Anzeige von Abzeichen für eine Komponenteninstanz. Sie kann im Dialogfeld Komponentenbearbeitung für Forum-, QnA- und Kommentarkomponenten über ein Kontrollkästchen mit der Bezeichnung Anzeigemarken konfiguriert werden.

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

Bewertungsregeln scoring-rules

Scoring-Regeln sind die Grundlage für die Vergabe von Badges.

Jede Scoring-Regel ist 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. Zum 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 ihrem jcr:content -Knoten, die die Liste der Unterregeln angeben, die sie definieren.

Die Punktzahl wird 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 dem Mitglied, das eine Aktion durchführt, Punkte zugewiesen, 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 von subject, object und verb. Zum Beispiel:

Unterregeln sind Knoten des Typs cq:Page mit Eigenschaften auf ihrem jcr:contentKnoten, die die Verben und Themen angeben.

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

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

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 ihrem jcr:content -Knoten, die Scoring-Regeln mit Bewertungen und Abzeichen korrelieren.

Die Badging-Regeln bestehen aus einer obligatorischen thresholds -Eigenschaft, bei der es sich um eine geordnete Liste von Bewertungen handelt, die Abzeichen zugeordnet sind. Die Werte müssen in zunehmendem Wert geordnet werden. Zum Beispiel:

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

Die Eigenschaft scoringRules einer Badging-Regel beschränkt lediglich, 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 den Foren und Kommentar-Scoring-Regeln entsprechen.

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.

Zuteilen und Entziehen von Abzeichen assign-and-revoke-badges

Kennzeichen können Mitgliedern entweder über die Konsole Mitglieder oder programmgesteuert über cURL-Befehle zugewiesen werden.

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)

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

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

badge = "badgeContentPath=badge-image-file"

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

member-profile-url = der 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=/libs/settings/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=/libs/settings/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 actions auf, die für eine topic auftreten. Das SocialEvent enthält eine Methode, mit der eine mit der Aktion verknüpfte verb zurückgegeben wird. Es gibt eine n-1 Beziehung zwischen actions und verbs.

Für die bereitgestellten Communities-Komponenten beschreiben die folgenden Tabellen die für jeden topic definierten verbs, der für die Verwendung in Scoring-Unterregeln verfügbar ist.

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

Kommentar-Komponente
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

Prü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/stimmts

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 actions aufzuzeichnen, die für eine topic auftreten.

Um die Auswertung zu unterstützen, muss das SocialEvent die Methode getVerb() überschreiben, damit für jeden action ein entsprechendes verb zurückgegeben wird. Die für eine Aktion zurückgegebene verb kann eine häufig verwendete (z. B. POST) oder für die Komponente spezialisierte (z. B. ADD RATING) sein. Es gibt eine n-1 Beziehung zwischen actions und 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 nicht für Aktivitäten vergeben werden, stellen Sie sicher, dass Abzeichen für die Instanz dieser Komponente aktiviert wurden.

Siehe Badges für Komponente aktivieren.

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 die Eigenschaft scoringRules von Badging Rules.

Typo für 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 der Site Erste Schritte-Tutorial (Interagieren) können Sie schnell versuchen, Scoring und Badging durchzuführen:

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

Als Nächstes republish die Community-Site.

Schließlich

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 auf der Entwickler-Seite Scoring- und Badges-Grundlagen .

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

Die konfigurierbare Leaderboard-Komponente component und function vereinfacht die Anzeige von Mitgliedern und deren Werten auf einer Community-Site.