Vergabe von Bewertungen und Abzeichen in Communities communities-scoring-and-badges

Überblick overview

Die AEM Communities-Funktion für Scoring und Abzeichen bietet die Möglichkeit, Community-Mitglieder zu identifizieren und zu belohnen.

Die Hauptaspekte der Bewertung und Abzeichen sind:

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

Zeichen badges

Abzeichen werden unter dem Namen eines Mitglieds platziert, um entweder seine Rolle oder sein Ansehen 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 Alternativtext für Barrierefreiheit eingefügt.

Standardmäßig befinden sich Badges im Repository unter:

Wenn sie an einem anderen Speicherort gespeichert sind, sollten sie von jedem gelesen und zugänglich sein.

Bei UGC wird unterschieden, ob die Abzeichen gemäß den Regeln zugewiesen wurden oder erworben wurden. Derzeit werden zugewiesene Abzeichen als Text und Earned Badges als Bild angezeigt.

Benutzeroberfläche für die Badge-Verwaltung badge-management-ui

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

Zugewiesene Abzeichen assigned-badges

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

Zugewiesene (und vergebene) Abzeichen werden im ausgewählten () gespeichert ​ sind nicht direkt zugänglich. Bis eine grafische Benutzeroberfläche verfügbar ist, können rollenbasierte Abzeichen nur über Code oder cURL zugewiesen werden. cURL-Anweisungen finden Sie im Abschnitt mit dem Titel Abzeichen zuweisen und widerrufen.

In der Version sind drei rollenbasierte Abzeichen enthalten:

Erhaltene Abzeichen awarded-badges

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

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

In der Version sind drei Belohnungs-Abzeichen enthalten:

Benutzerdefinierte Abzeichen custom-badges

Benutzerdefinierte Badges können über die Badges-Konsole“ installiert ​ oder in Badging-Regeln zugewiesen werden.

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

Scoring aktivieren enable-scoring

Die Bewertung ist standardmäßig nicht aktiviert. Die grundlegenden Schritte zum Einrichten und Ermöglichen der Bewertung und Vergabe von Abzeichen sind:

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

Regeln auf Inhalte anwenden apply-rules-to-content

Um die Bewertung und die Abzeichen 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 ist, veröffentlichen Sie die Site erneut, nachdem Sie alle Regeln angewendet und Komponenten aktiviert haben.

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

Wenn der Knoten vom Typ cq:Page ist (empfohlen), fügen Sie mithilfe von CRXDE|Lite die Eigenschaften zu seinem jcr:content Knoten hinzu.

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

Die Scoring- und Badging-Regeln sind nur für Instanzen von Komponenten wirksam, die das Badging aktiviert haben, indem die Komponentenkonfiguration im Authoring-Modus) ​ wird.

Eine boolesche Eigenschaft allowBadges aktiviert/deaktiviert die Anzeige von Badges für eine Komponenteninstanz. Sie kann im Dialogfeld „Komponente bearbeiten für Forum-, QnA- und Kommentar-Komponenten über ein Kontrollkästchen mit der Bezeichnung Badges anzeigen konfiguriert werden.

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

Bewertungsregeln scoring-rules

Bewertungsregeln sind die Grundlage für die Bewertung von Abzeichen.

Jede Bewertungsregel ist eine Liste aus einer oder mehreren Unterregeln. Auf den Inhalt der Community-Site werden Bewertungsregeln angewendet, um die Regeln zu identifizieren, die bei aktivierten Abzeichen anzuwenden sind.

Bewertungsregeln werden vererbt, sind aber nicht additiv. Zum Beispiel:

Wenn es mehr als eine Bewertungsregel gibt, werden die Bewertungen für jede Regel separat verwaltet.

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

Scores werden in SRP gespeichert.

Unterregeln für die Bewertung scoring-sub-rules

Die Scoring-Unterregeln enthalten die Eigenschaften mit Details zu den Werten für die Teilnahme an der Community.

Jede Scoring-Unterregel identifiziert:

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

Jede Unterregel kann in einer oder mehreren Bewertungsregeln enthalten sein.

Der Name der Unterregel folgt normalerweise dem Muster der Verwendung eines Subjekt, Objekt und Verb. Zum Beispiel:

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

Eingeschlossene Bewertungsregeln und Unterregeln included-scoring-rules-and-sub-rules

In dieser Version sind zwei Bewertungsregeln für die Funktion Forum enthalten (jeweils eine für die Komponente Forum und Kommentare der Funktion Forum ):

Anmerkungen:

Aktivieren benutzerdefinierter Bewertungsregeln activating-custom-scoring-rules

Alle Änderungen oder Ergänzungen an Bewertungsregeln oder Unterregeln, die in der Autorenumgebung vorgenommen wurden, müssen bei der Veröffentlichung installiert werden.

Badging-Regeln badging-rules

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

Badging-Regeln sind Knoten vom Typ cq:Page mit Eigenschaften auf ihrem jcr:content Knoten, die Bewertungsregeln mit Bewertungen und Abzeichen korrelieren.

Die Badging-Regeln bestehen aus einer obligatorischen thresholds-Eigenschaft, die eine geordnete Liste von Werten ist, die Abzeichen zugeordnet sind. Die Punktzahlen müssen in aufsteigender Reihenfolge sortiert werden. Zum Beispiel:

Badging-Regeln sind mit Bewertungsregeln gepaart, die bestimmen, wie Punkte gesammelt werden. Siehe den Abschnitt Anwenden von Regeln auf Inhalte.

Die scoringRules Eigenschaft einer Badging-Regel beschränkt einfach, welche Bewertungsregeln mit dieser bestimmten Badging-Regel gepaart werden können.

Enthaltene Badging-Regeln included-badging-rules

In dieser Version sind zwei Badging-Regeln enthalten, die den Bewertungsregeln für Foren und Kommentare entsprechen.

Anmerkungen:

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

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

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

Abzeichen können Mitgliedern entweder über die Mitgliederkonsole“ oder ​ cURL-Befehlen zugewiesen werden.

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

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

header = „Accept:Application/json“
Benutzerdefinierte Kopfzeile, die 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 = Speicherort der Badge-Grafikdatei im Repository
Beispiel: /libs/settings/community/badging/images/moderator/jcr:content/moderator.png

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

Beispiele: examples

Moderator-Badge 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

Widerrufen eines zugewiesenen silbernen Abzeichens 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

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

Bewertungs- und Badging-Regeln können für benutzerdefinierte Komponenten erstellt werden, indem die für die Komponente erstellten Ereignisthemen mit Verben verknüpft werden.

Themen und Verben topics-and-verbs

Wenn Mitglieder mit Communities-Funktionen interagieren, werden Ereignisse gesendet, die asynchrone Listener zum Trigger bringen können, z. B. Benachrichtigungen und Bewertung.

Die SocialEvent-Instanz einer Komponente zeichnet die Ereignisse als actions auf, die bei einem topic auftreten. SocialEvent enthält eine Methode zum Zurückgeben eines der Aktion zugeordneten verb. Es besteht eine n-1-Beziehung zwischen actions und verbs.

Für die bereitgestellten Communitys-Komponenten beschreiben die folgenden Tabellen die verbs, die für jede topic definiert wurden, die in (ScoringUnterregeln) ​ werden kann.

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

Komponente „Kommentare
SocialEvent topic= com/adobe/cq/social/comment

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

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

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

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

Reviews-Komponente
SocialEvent topic= com/adobe/cq/social/review

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

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

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 bei einem topic auftreten.

Um die Bewertung zu unterstützen, muss SocialEvent die Methode getVerb() überschreiben, damit für jede action ein entsprechender verb zurückgegeben wird. Die für eine Aktion zurückgegebene verb kann eine häufig verwendete (z. B. POST) oder eine für die Komponente spezialisierte (z. B. ADD RATING) sein. Es besteht eine n-1-Beziehung zwischen actions und verbs.

Fehlerbehebung troubleshooting

Abzeichen werden nicht angezeigt badges-are-not-appearing

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

Siehe Aktivieren von Abzeichen für Komponente.

Bewertungsregel hat keine Wirkung scoring-rule-has-no-effect

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

Siehe die scoringRules-Eigenschaft von Badging-Regeln.

Schreibweise unter Berücksichtigung der Groß-/Kleinschreibung case-sensitive-typo

Bei den meisten Eigenschaften und Werten, insbesondere bei den Verben, wird zwischen Groß- und Kleinschreibung unterschieden. Verben müssen in einer Scoring-Unterregel vollständig GROSSGESCHRIEBEN sein.

Wenn die Funktion nicht erwartungsgemäß funktioniert, stellen Sie sicher, dass die Daten korrekt eingegeben wurden.

Schnelltest quick-test

Sie können schnell Scoring und Badging ausprobieren, indem Sie die Seite Erste Schritte-Tutorial (Engage) verwenden:

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

Veröffentlichen ​ als Nächstes ​ Community-Site erneut.

Schließlich

Dadurch sollte das Community-Mitglied über ein Bronze-Abzeichen verfügen, das mit seinem Forumsbeitrag sichtbar ist, da der erste Schwellenwert der ersten Foren-Badging-Regel ein Score von 1 ist.

Zusätzliche Informationen additional-information

Weitere Informationen finden Sie auf der Seite Grundlagen zu Bewertungen und Abzeichen für Entwickler.

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

Die konfigurierbare LeaderboardKomponente und Funktion vereinfacht die Anzeige von Mitgliedern und deren Bewertungen auf einer Community-Site.