Communities Scoring and Badges

Überblick

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

Wichtigste Aspekte der Bewertung und Abzeichen sind:

• Weisen Sie badgesto zu, um die Rolle eines Mitglieds in der Community zu identifizieren.

• Grundlegende Vergabe von badgesto-Mitgliedern, um ihre Teilnahme zu fördern (Menge der erstellten Inhalte).

• Erweiterte Vergabe von badgesto identifizieren Mitglieder als Experten (Qualität der Inhalte erstellt).

Beachten Sie, dass die Vergabe von Kennzeichen nicht standardmäßig aktiviert ist.

Zeichen

Kennzeichen werden unter dem Namen eines Mitglieds platziert, um entweder ihre Rolle oder ihr Ansehen in der Gemeinschaft 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

• /libs/settings/community/badging/images

Wenn sie an einem anderen Ort gespeichert sind, sollten sie von allen gelesen werden können.

Die Kennzeichen werden in UGC differenziert, ob sie gemäß den Regeln zugewiesen wurden oder verdient wurden. Derzeit werden zugewiesene Kennzeichen als Text und verdiente Kennzeichen als Bild angezeigt.

Benutzeroberfläche der Bademanagement

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

Zugewiesene Kennzeichen

Rollenbasierte Abzeichen werden von einem Administrator entsprechend ihrer Rolle in der Community Mitgliedern zugewiesen.

Zugewiesene (und erwartete) Kennzeichen 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 Kennzeichen zuweisen und sperren.

In der Version sind drei rollenbasierte Abzeichen enthalten:

• moderator

  /libs/settings/community/badging/images/moderator/jcr:content/moderator.png

• group Manager

  /libs/settings/community/badging/images/group-manager/jcr:content/group-manager.png

• privilegiertes Mitglied

  /libs/settings/community/badging/images/privileged-member/jcr:content/privileged-member.png

  

Zuerkannte Kennzeichen

Belohnungsbasierte Abzeichen werden vom Bewertungsdienst an Mitglieder der Gemeinde vergeben, die auf Regeln beruhen, die für ihre Aktivität in der Gemeinde gelten.

Damit Kennzeichen als Belohnung für Aktivität erscheinen, müssen zwei Dinge geschehen:

• Die Abzeichen müssen für die Funktionskomponente enabled sein.
• Die Scoring- und Badging-Regeln müssen auf die Seite (oder den Vorfahren), auf der die Komponente platziert wird, angewendet werden.

In der Version sind drei belohnungsbasierte Abzeichen enthalten:

• Gold

  /libs/settings/community/badging/images/gold-badge/jcr:content/gold.png

• silber

  /libs/settings/community/badging/images/silver-badge/jcr:content/silver.png

• Bronze

  /libs/settings/community/badging/images/bronze-badge/jcr:content/bronze.png

  

Benutzerdefinierte Abzeichen

Benutzerdefinierte Abzeichen können mit der Konsole Abzeichen installiert und entweder zugewiesen oder in Absatzwegeln angegeben werden.

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

Bewertung aktivieren

Die Bewertung ist nicht standardmäßig aktiviert. Die grundlegenden Schritte zur Einrichtung und Aktivierung der Bewertung und Vergabe von Abzeichen sind:

• Identifizieren Sie die Regeln für die Ertragspunkte (Bewertungsregeln).

• Weisen Sie für Punkte, die nach Bewertungsregeln akkumuliert wurden, Abzeichen (Abbedinungsregeln) zu.

• Wenden Sie die Scoring- und Kennzeichnungsregeln auf eine Community-Site an.

• Aktivieren Sie das Abzeichnen für Community-Funktionen.

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

Regeln auf Inhalt anwenden

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

Wenn die Site bereits veröffentlicht wurde, veröffentlichen Sie die Site nach Anwendung aller Regeln und aktivierenden Komponenten erneut.

Die Regeln, die für eine badging-fähige Komponente gelten, sind die Regeln für die aktuelle Node oder deren Vorgänger.

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

Kennzeichen für Komponente aktivieren

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

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

Beispiel: allowBadges for Forum component instance

Bewertungsregeln

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

Jede Bewertungsregel ist ganz einfach eine Liste einer oder mehrerer Unterregeln. Bewertungsregeln werden auf den Inhalt der Community-Site angewendet, um die Regeln zu identifizieren, die bei Aktivierung von Kennzeichen angewendet werden.

Bewertungsregeln werden geerbt, jedoch nicht additiv. Beispiel:

• Wenn page2 Scoring rule2 enthält und die angefangene Seite1 Scoring Rule1 enthält.

• Eine Aktion auf einer Komponente "page2"ruft sowohl Regel1 als auch Regel2 auf.

• Wenn beide Regeln anwendbare Unterregeln für dasselbe topic/verb enthalten:

  • Nur die Unterregel aus Regel 2 wirkt sich auf das Ergebnis aus.
  • Die Ergebnisse beider Unterregeln werden nicht zusammen addiert.

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

Bewertungsregeln sind Knoten des Typs cq:Page mit Eigenschaften auf dem Knoten jcr:content, die die Liste der Unterregeln angeben, die diese definieren.

Scores werden in SRP gespeichert.

Bewertungsunterregeln

Die Bewertungsunterregeln enthalten die Eigenschaften, die die Werte für die Teilnahme an der Community detailliert angeben.

Jede Bewertungsunterregel identifiziert:

• Welche Aktivitäten werden verfolgt?
• Welche speziellen Gemeinschaftsfunktionen sind betroffen?
• Wie viele Punkte werden vergeben?

Standardmäßig werden Punkte an das Mitglied vergeben, das eine Aktion durchführt, es sei denn, die Unterregel legt fest, dass der Eigentümer des Inhalts die Punkte erhält ( forOwner).

Jede Unterregel kann in einer oder mehreren Bewertungsregeln enthalten sein.

Der Name der Unterregel folgt normalerweise dem Muster der Verwendung eines subject , object und verb. Beispiel:

• member-comment-create
• member-receive-Votum

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

Einbezogene Bewertungsregeln und Unterregeln

In der Version sind zwei Bewertungsregeln für die Foren-Funktion enthalten (eine für die Foren- und Kommentarkomponenten der Funktion "Forum"):

1. /libs/settings/community/scoring/rules/comments-scoring

   • subRules[] =
     /libs/settings/community/scoring/rules/sub-rules/member-comment-create
     /libs/settings/community/scoring/rules/sub-rules/member-receive-Vize
     /libs/settings/community/scoring/rules/sub-rules/member-gebe-Votum
     /libs/settings/community/scoring/rules/sub-rules/member-is-moderated

2. /libs/settings/community/scoring/rules/forums-scoring

   • subRules[] =
     /libs/settings/community/scoring/rules/sub-rules/member-forum-create
     /libs/settings/community/scoring/rules/sub-rules/member-receive-Vize
     /libs/settings/community/scoring/rules/sub-rules/member-gebe-Votum
     /libs/settings/community/scoring/rules/sub-rules/member-is-moderated

Hinweise:

• Die Knoten rules und sub-rules sind vom Typ cq:Page.

• subRules ist ein Attribut des Typs [] Stringon der jcr:content Knoten der Regel.

• sub-rules kann für verschiedene Bewertungsregeln freigegeben werden.

• rules sollte sich in einem Repository mit Leserechte für alle befinden.

  • Regelnamen müssen unabhängig vom Ort eindeutig sein.

Aktivieren benutzerdefinierter Bewertungsregeln

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

Kennzeichnungsregeln

Kennzeichnungsregeln verknüpfen Bewertungsregeln mit Kennzeichen, indem sie Folgendes angeben:

• Bewertungsregel
• Ergebnis erforderlich, um mit einem bestimmten Zeichen versehen zu werden

Kennzeichnungsregeln sind Knoten des Typs cq:Page mit Eigenschaften auf ihrem jcr:content-Knoten, die Bewertungsregeln mit Bewertungen und Abzeichen korrelieren.

Die Regeln für das Abzeichen bestehen aus einer obligatorischen thresholds-Eigenschaft, bei der es sich um eine geordnete Liste von Punktzahlen handelt, die Markierungen zugeordnet sind. Die Ergebnisse müssen in zunehmendem Wert angeordnet werden. Beispiel:

• 1|/libs/settings/community/badging/images/bronze-badge/jcr:content/bronze.png

  • Ein Bronzemaske wird für 1 Punkt erwartet.

• 60|/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png

  • Ein Silberabzeichen wird vergeben, wenn 60 Punkte gesammelt wurden.

• 80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png

  • Wenn 80 Punkte gesammelt wurden, wird ein Goldabzeichen erwartet.

Kennzeichnungsregeln werden mit Bewertungsregeln gepaart, die bestimmen, wie Punkte akkumuliert werden. Siehe Abschnitt Regeln auf Inhalt anwenden.

Die scoringRules-Eigenschaft einer Kennzeichnungsregel schränkt einfach ein, welche Bewertungsregeln mit dieser bestimmten Kennzeichnungsregel gepaart werden können.

Einbezogene Kennzeichnungsregeln

In der Version sind zwei Kennzeichnungsregeln enthalten, die den Foren- und Kommentarauswertungsregeln entsprechen.

• /libs/settings/community/badging/rules/comments-badging

• /libs/settings/community/badging/rules/forums-badging

Hinweise:

• rules Knoten sind vom Typ cq:Page.

• rules sollte sich in einem Repository mit Leserechte für alle befinden.

  • Regelnamen müssen unabhängig vom Ort eindeutig sein.

Aktivieren benutzerdefinierter Kennzeichnungsregeln

Änderungen oder Ergänzungen an den Kennzeichnungsregeln oder Bildern, die in der Authoring-Umgebung vorgenommen wurden, müssen bei der Veröffentlichung installiert werden.

Zuteilen und Entziehen von Abzeichen

Abzeichen können Mitgliedern entweder mit der members-Konsole oder programmgesteuert mit cURL-Befehlen zugewiesen werden.

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

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

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

sign = administrator-id:password zum Beispiel: admin:admin

operation = ":operation=social:assignBadge" OR ":operation=social:deleteBadge"

badge = "badgeContentPath=badge-image-file"

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

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

Beispiele:

Moderatorzeichen zuweisen

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

Sperren eines zugewiesenen Silber-Kennzeichens

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- und Badging-Regeln können für benutzerdefinierte Komponenten erstellt werden, indem die für die Komponente erstellten Ereignis-Themen mit Verben verknüpft werden.

Themen und Verben

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

Die SocialEvent-Instanz einer Komponente zeichnet die Ereignis als actions auf, die für ein topic auftreten. Das SocialEvent enthält eine Methode, um eine verb zurückzugeben, die der Aktion zugeordnet ist. Es besteht eine n-1-Beziehung zwischen actions und verbs.

Für die bereitgestellten Communities-Komponenten beschreiben die folgenden Tabellen die verbs, die für jede topic definiert sind, die in Scoring-Unterregeln verfügbar ist.

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

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

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

Forum
ComponentSocialEvent topic= com/adobe/cq/social/forum

Protokoll
ComponentSocialEvent topic= com/adobe/cq/social/Protokoll

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

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

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

Voting
ComponentSocialEvent topic= com/adobe/cq/social/tally/stimmst

Moderationsaktivierte
KomponentenSocialEvent topic= com/adobe/cq/social/moderation

Ereignis für benutzerdefinierte Komponenten

Bei einer benutzerdefinierten Komponente wird ein SocialEvent instanziiert, um die Ereignis der Komponente als actions aufzuzeichnen, die für ein topic auftreten.

Um die Bewertung zu unterstützen, muss das SocialEvent die Methode getVerb() überschreiben, sodass für jedes action ein entsprechendes verb zurückgegeben wird. Das 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

Abzeichen werden nicht angezeigt.

Wenn für den Inhalt der Website Scoring- und Kennzeichnungsregeln angewendet wurden, für keine Aktivität Kennzeichen angezeigt werden, stellen Sie sicher, dass für die Komponenteninstanz Kennzeichen aktiviert wurden.

Siehe Kennzeichen für Komponente aktivieren.

Bewertungsregel hat keine Auswirkung

Wenn für den Inhalt der Website Scoring- und Kennzeichnungsregeln angewendet wurden und für einige Aktionen, aber nicht für andere Kennzeichen vergeben werden, überprüfen Sie, ob die Kennzeichnungsregel die anzuwendenden Bewertungsregeln nicht eingeschränkt hat.

Siehe auch scoringRules-Eigenschaft von Badging Rules.

Groß-/Kleinschreibung bei Typo

Bei den meisten Eigenschaften und Werten, insbesondere bei den Verben, wird die Groß-/Kleinschreibung beachtet. Verbs müssen in einer Scoring-Unterregel als alle UPPERCASE verwendet werden.

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

Schnelltest

Es ist möglich, schnell mit der Erste Schritte-Lernprogramm-Site (interagieren) Scoring und Abzeichen zu versuchen:

• Zugriff auf CRXDE Lite beim Autor.

• Gehen Sie zur Basisseite:

  • /content/sites/engagement/de/jcr:content

• hinzufügen der badgingRules-Eigenschaft:

  • Name: badgingRules
  • Typ: String
  • Wählen Sie Multi
  • Wählen Sie Hinzufügen
  • Geben Sie Folgendes ein /libs/settings/community/badging/rules/forums-badging
  • Wählen Sie nun eine der folgenden Optionen aus +
  • Geben Sie Folgendes ein /libs/settings/community/badging/rules/comments-badging
  • Wählen Sie OK aus

• hinzufügen der Eigenschaft scoringRules:

  • Name: scoringRules
  • Typ: String
  • Wählen Sie Multi
  • Wählen Sie Hinzufügen
  • Geben Sie Folgendes ein /libs/settings/community/scoring/rules/forums-scoring
  • Wählen Sie nun eine der folgenden Optionen aus +
  • Geben Sie Folgendes ein /libs/settings/community/scoring/rules/comments-scoring
  • Wählen Sie OK aus

• Wählen Sie Alle speichern.

Stellen Sie dann sicher, dass die Forum- und Kommentarkomponenten die Anzeige von Abzeichen zulassen:

• Wieder mit CRXDE Lite.

• Zur Forumkomponente navigieren

  • /content/sites/engage/en/forum/jcr:content/content/primary/forum

• hinzufügen Sie ggf. die boolesche Eigenschaft allowBadges und stellen Sie sicher, dass sie wahr ist.

  • Name: allowBadges
  • Typ: Boolean
  • Wert: true

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

Abschließend,

• Navigieren Sie zur Komponente in der Veröffentlichungsinstanz.

• Melden Sie sich als Community-Mitglied an (z. B.: weston.mccall@dodgit.com).

• Posten Sie ein neues Forenthema.

• Die Seite muss aktualisiert werden, damit das Abzeichen angezeigt wird.

  • Abmelden und sich als anderes Community-Mitglied anmelden (z. B. aaron.mcdonald@mailinator.com).

• Wählen Sie das Forum aus.

Dies sollte dem Community-Mitglied ein Bronzemarke mit seinem Forenbeitrag sichtbar machen, da der erste Schwellenwert der ersten Regel, die das Forums-Abzeichen vorgibt, ein Wert von 1 ist.

Zusätzliche Informationen

Weitere Informationen finden Sie auf der Seite Scoring and Badges Essentials für Entwickler.

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

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