Communities Scoring and Badges communities-scoring-and-badges
Översikt overview
AEM Communities poäng och badges ger möjlighet att identifiera och belöna communitymedlemmar.
De viktigaste aspekterna på poängsättning och märkning är:
-
Tilldela märken identifiera en medlems roll i communityn
-
Grundläggande tilldelning av märken till medlemmarna för att uppmuntra dem att delta (mängden innehåll som skapas)
-
Avancerad tilldelning av märken identifiera medlemmar som experter (kvaliteten på det material som skapas)
Anteckning att det är inte aktiverat som standard.
Badges badges
Beteckningar placeras under en medlems namn för att ange antingen deras roll eller deras ställning i communityn. Badges kan antingen visas som en bild eller som ett namn. När namnet visas som en bild inkluderas det som alternativ text för tillgänglighet.
Som standard finns emblem i databasen på
- /etc/community/badging/images
Om de lagras på en annan plats bör de vara tillgängliga för alla.
UGC har olika märken för att avgöra om de har tilldelats eller förvärvats enligt reglerna. För närvarande visas tilldelade märken som text och färdiga märken som en bild.
Användargränssnitt för hantering av emblem badge-management-ui
Communities Badges Console ger möjlighet att lägga till egna märken som kan visas för en medlem när den har förtjänats (tilldelats) eller när de får en viss roll i communityn (tilldelats).
Tilldelade märken assigned-badges
Rollbaserade märken tilldelas av en administratör till communitymedlemmar baserat på deras roll i communityn.
Tilldelade (och tilldelade) märken lagras i det valda SRP och är inte direkt tillgängliga. Det enda sättet att tilldela rollbaserade emblem är att göra det med kod eller cURL tills ett GUI är tillgängligt. Instruktioner för cURL finns i avsnittet med rubriken Tilldela och återkalla märken.
I releasen finns tre rollbaserade märken:
-
Moderator
/etc/community/badging/images/moderator/jcr:content/moderator.png
-
Gruppchef
/etc/community/badging/images/group-manager/jcr:content/group-manager.png
-
Privilegierad medlem
/etc/community/badging/images/privileged-member/jcr:content/privileged-member.png
Tilldelade märken awarded-badges
Belöningsbaserade märken delas ut av betygstjänsten till communitymedlemmar baserat på regler som tillämpas på deras verksamhet i communityn.
För att emblem ska visas som en belöning för aktivitet måste två saker hända:
I releasen ingår tre belöningsbaserade märken:
-
Guld
/etc/community/badging/images/gold-badge/jcr:content/gold.png
-
Silver
/etc/community/badging/images/silver-badge/jcr:content/silver.png
-
Bronze
/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
Egna märken custom-badges
Anpassade märken kan installeras med Badges Console och antingen har tilldelats eller angetts i märkningsreglerna.
Anpassade märken replikeras automatiskt till publiceringsmiljön när de installeras från badges-konsolen.
Aktivera poängsättning enable-scoring
Poängen är inte aktiverad som standard. De grundläggande stegen för att sätta upp och aktivera poängsättning och tilldelning av märken är:
-
Identifiera regler för intäktspunkter (poängregler)
-
För poäng som ackumuleras per poängregler tilldelar du emblem (regler för emblem)
-
Använd regler för poäng och utmärkelser på en communitywebbplats
Se Snabbtest om du vill aktivera poängsättning för en communitywebbplats med standardreglerna för poäng och märkning för forum och kommentarer.
Använd regler för innehåll apply-rules-to-content
Om du vill aktivera poängsättning och märken lägger du till egenskaperna scoringRules
och badgingRules
till valfri nod i platsens innehållsträd.
Om webbplatsen redan är publicerad, efter att ha tillämpat alla regler och aktiverat komponenter, publicerar du om den.
Reglerna som gäller för en komponent som har aktiverats för badging är reglerna för den aktuella noden eller dess överordnade nod.
Om noden är av typen cq:Page
(rekommenderas) lägger du sedan till egenskaperna med CRXDE|Lite i jcr:content
nod.
Aktivera emblem för komponent enable-badges-for-component
Poäng- och streckreglerna gäller endast för instanser av komponenter som har aktiverat badging genom att redigera komponentkonfigurationen i redigeringsläge.
En boolesk egenskap, allowBadges
, aktiverar/inaktiverar visning av emblem för en komponentinstans. Den kan konfigureras i redigeringsdialogruta för komponent for forum, QnA och kommentarkomponenter via en kryssruta med etiketten Visa emblem.
Exempel: allowBadges för instans av forumkomponent example-allowbadges-for-forum-component-instance
Poängregler scoring-rules
Poängregler är grunden för poängsättning för att tilldela märken.
Enkelt uttryckt är varje resultatregel en lista med en eller flera underregler. Poängregler tillämpas på communitywebbplatsinnehållet för att identifiera de regler som ska gälla när emblem är aktiverade.
Poängregler ärvs men är inte additiva. Till exempel:
-
Om sidan 2 innehåller bedömningsregel 2 och dess överordnade sida 1 innehåller bedömningsregel 1
-
En åtgärd för en sidkomponent2 anropar både regel1 och regel2
-
Om båda reglerna innehåller tillämpliga delregler för samma
topic/verb
:- Endast underregeln från regel 2 påverkar poängen
- Poängen från båda delreglerna läggs inte ihop
Om det finns mer än en resultatregel bevaras poängen separat för varje regel.
Poängregler är noder av typen cq:Page
med egenskaper på jcr:content
nod som anger listan med underregler som definierar den.
Bakgrundsmusik lagras i SRP.
/etc/community/scoring/rules/site1/forums-scoring
/etc/community/scoring/rules/site2/forums-scoring
Underregler för poängsättning scoring-sub-rules
Delreglerna för poängsättning innehåller egenskaper som detaljerar värdena för att delta i communityn.
Varje poängsättningsunderregel identifierar
- Vilka aktiviteter spåras
- Vilken specifik communityfunktion det gäller
- Hur många poäng tilldelas?
Som standard tilldelas poäng till den medlem som utför åtgärden, såvida inte underregeln anger att ägaren av innehållet tar emot poängen ( forOwner
).
Varje underregel kan ingå i en eller flera poängregler.
Namnet på underregeln följer vanligtvis mönstret för att använda en ämne, objekt och verb. Till exempel:
- medlem-comment-create
- medlem-receive-voice
Underregler är noder av typen cq:Page
med egenskaper på jcr:content
nod som anger verb och ämnen .
Inkluderade poängsättningsregler och underregler included-scoring-rules-and-sub-rules
I releasen finns två poängregler för Forum (en för var och en för forumfunktionen och kommentarskomponenterna för forumfunktionen):
-
/etc/community/scoring/rules/comments-scoring
-
subRules[] =
/etc/community/scoring/rules/sub-rules/member-comment-create
/etc/community/scoring/rules/sub-rules/member-receive-voice
/etc/community/scoring/rules/sub-rules/member-give-voice
/etc/community/scoring/rules/sub-rules/member-is-moderated
-
-
/etc/community/scoring/rules/forums-scoring
-
subRules[] =
/etc/community/scoring/rules/sub-rules/member-forum-create
/etc/community/scoring/rules/sub-rules/member-receive-voice
/etc/community/scoring/rules/sub-rules/member-give-voice
/etc/community/scoring/rules/sub-rules/member-is-moderated
-
Anteckningar:
-
Båda
rules
ochsub-rules
noder är av typen cq:Page -
subRules
är ett attribut av typen String[] på regelnsjcr:content
nod -
sub-rules
kan delas mellan olika poängregler -
rules
ska finnas på en databasplats med läsbehörighet för alla- Regelnamn måste vara unika oavsett plats
Aktivera anpassade poängsättningsregler activating-custom-scoring-rules
Alla ändringar eller tillägg som görs i resultatregler eller underregler i redigeringsmiljön måste installeras vid publicering.
Märkningsregler badging-rules
Regler för märkning länkar till poängregler genom att ange:
- Vilken resultatregel
- Poäng som krävs för att tilldelas ett specifikt märke
Märkningsregler är noder av typen cq:Page
med egenskaper på jcr:content
nod som korrelerar poängregler till poäng och emblem.
Reglerna för märkning består av ett obligatoriskt thresholds
egenskap som är en ordnad lista över bakgrundsmusik mappad till emblem. Poängen måste ordnas i högre värde. Till exempel:
-
1|/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
- Ett bronze-märke tilldelas för 1 poäng
-
60|/etc/community/badging/images/silver-badge/jcr:content/silver.png
- En silverbricka tilldelas när 60 poäng har samlats in
-
80|/etc/community/badging/images/gold-badge/jcr:content/gold.png
- En guldbricka utmärks när 80 poäng har samlats
Betygsregler kombineras med poängregler, som bestämmer hur poäng ackumuleras. Se avsnittet Använd regler för innehåll.
The scoringRules
egenskapen för en badging-regel begränsar helt enkelt vilka poängregler som kan kombineras med den speciella badging-regeln.
Inkluderade märkningsregler included-badging-rules
I releasen finns två badging-regler som motsvarar Ordningsregler för forum och kommentarer.
- /etc/community/badging/rules/comments-badging
- /etc/community/badging/rules/forums-badging
Anteckningar:
-
rules
noder är av typen cq:Page -
rules
ska finnas på en databasplats med läsbehörighet för alla- Regelnamn måste vara unika oavsett plats
Aktivera anpassade märkningsregler activating-custom-badging-rules
Alla ändringar eller tillägg som görs i märkningsregler eller bilder i redigeringsmiljön måste installeras vid publicering.
Tilldela och återkalla märken assign-and-revoke-badges
Medlemmar kan tilldelas märken antingen med medlemskonsol eller programmatiskt med cURL-kommandon.
Följande cURL-kommandon visar vad som krävs för en HTTP-begäran om att tilldela och återkalla emblem. Grundformatet är:
cURL -i -X POST -H header -u *inloggning * -F *operation * -F *badge * member-profile-url
header = "Acceptera:program/json"
anpassad rubrik som ska skickas till servern (obligatoriskt)
signera = administrator-id:password
till exempel: admin:admin
operation = ":operation=social:assignBadge" OR ":operation=social:deleteBadge"
bricka = "badgeContentPath=badge-image-file"
badge-image-file = platsen för badge-bildfilen i databasen
till exempel: /etc/community/badging/images/moderator/jcr:content/moderator.png
member-profile-url = slutpunkten för medlemmens profil vid publicering
till exempel: https://<server>:<port>/home/users/community/riley/profile.social.json
- Kan referera till en författarinstans om Tunneltjänst är aktiverat
- Kan vara ett otydligt, slumpmässigt namn - se Säkerhetschecklista gällande auktoriserat ID
Exempel: examples
Tilldela ett moderatormärke 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
Återkalla ett tilldelat silvermärke 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
Betyg och märken för anpassade komponenter scoring-and-badges-for-custom-components
Du kan skapa regler för klassificering och märkning för anpassade komponenter genom att koppla händelseavsnitten som skapats för komponenten till verb.
Ämnen och verb topics-and-verbs
När medlemmar interagerar med communityfunktioner skickas händelser som kan utlösa asynkrona avlyssnare, som meddelanden och poängsättning.
En komponents SocialEvent-instans registrerar händelserna som actions
som inträffar för en topic
. SocialEvent innehåller en metod för att returnera en verb
som är associerad med åtgärden. Det finns en n-1 relation mellan actions
och verbs
.
För de communitykomponenter som levereras beskrivs följande tabeller verbs
definierad för varje topic
finns att använda i underregler för poäng.
allowBadges
, aktiverar/inaktiverar visning av emblem för en komponentinstans. Den kan konfigureras i uppdaterad dialogrutor för komponentredigering genom en kryssruta med etiketten Visa emblem.Kalenderkomponent
SocialEvent topic
= com/adobe/cq/social/calendar
Komponenten Kommentarer
SocialEvent topic
= com/adobe/cq/social/comment
Filbibliotekskomponent
SocialEvent topic
= com/adobe/cq/social/fileLibrary
Forum-komponent
SocialEvent topic
= com/adobe/cq/social/forum
Journalkomponent
SocialEvent topic
= com/adobe/cq/social/journal
QnA-komponent
SocialEvent topic
= com/adobe/cq/social/qna
Granskningskomponent
SocialEvent topic
= com/adobe/cq/social/review
Klassificeringskomponent
SocialEvent topic
= com/adobe/cq/social/tally/rating
Röstkomponent
SocialEvent topic
= com/adobe/cq/social/tally/röstande
Modereringsaktiverade komponenter
SocialEvent topic
= com/adobe/cq/social/moderation
Anpassade komponenthändelser custom-component-events
För en anpassad komponent instansieras en SocialEvent för att spela in komponentens händelser som actions
som inträffar för en topic
.
För att det ska gå att använda poängsättning måste SocialEvent åsidosätta metoden getVerb()
så att verb
returneras för varje action
. The verb
som returneras för en åtgärd kan vara en vanlig åtgärd (t.ex. POST
) eller en som är specialiserad på komponenten (till exempel ADD RATING
). Det finns en n-1 relation mellan actions
och verbs
.
Felsökning troubleshooting
Inga märken visas badges-are-not-appearing
Om regler för klassificering och märkning har tillämpats på webbplatsens innehåll, men emblem inte tilldelas för någon aktivitet, kontrollerar du att emblem har aktiverats för komponentens instans.
Se Aktivera emblem för komponent.
Poängregeln har ingen effekt scoring-rule-has-no-effect
Om regler för poängsättning och märkning har tillämpats på webbplatsens innehåll, och emblem tilldelas för vissa åtgärder, men inte andra, kontrollerar du att badging-regeln inte har begränsat de poängregler som den gäller för.
Se scoringRules
egenskap för Märkningsregler.
Skiftlägeskänslig typo case-sensitive-typo
De flesta egenskaper och värden, särskilt verbet, är skiftlägeskänsliga. Verb måste vara VERSALER när de används i en underregel för poängsättning.
Om funktionen inte fungerar som väntat kontrollerar du att data har angetts korrekt.
Snabbtest quick-test
Det går snabbt att testa poängsättning och märkning med Komma igång, självstudiekurs webbplats:
-
Gå till CRXDE Lite på författaren
-
Bläddra till bassidan:
- /content/sites/engage/en/jcr:content
-
Lägg till egenskapen badgingRules:
- Namn:
badgingRules
- Typ:
String
- Välj Multi
- Välj Add
- Retur
/etc/community/badging/rules/forums-badging
- Välj
+
- Retur
/etc/community/badging/rules/comments-badging
- Välj OK
- Namn:
-
Lägg till egenskapen scoringRules:
- Namn:
scoringRules
- Typ:
String
- Välj Multi
- Välj Add
- Retur
/etc/community/scoring/rules/forums-scoring
- Välj
+
- Retur
/etc/community/scoring/rules/comments-scoring
- Välj OK
- Namn:
-
Välj Save All
Kontrollera sedan att forumkomponenterna och kommentarkomponenterna tillåter att märken visas:
-
Återigen med CRXDE Lite
-
Bläddra till forumkomponenten
/content/sites/engage/en/forum/jcr:content/content/primary/forum
-
Lägg till den booleska egenskapen allowBadges, om det behövs, och kontrollera att den är true
- Namn:
allowBadges
- Typ:
Boolean
- Värde:
true
- Namn:
Nästa, publicera igen communitywebbplatsen.
Äntligen
-
Bläddra till komponenten i publiceringsinstansen
-
Logga in som community-medlem (till exempel: weston.mccall@dodgit.com / lösenord)
-
Lägg upp ett nytt forumämne
-
Sidan måste uppdateras för att märket ska kunna visas
- Logga ut och logga in som en annan community-medlem (till exempel: aaron.mcdonald@mailinator.com / lösenord)
-
Välj forum
Detta bör göra att communitymedlemmen får ett bronze-märke synligt med sitt foruminlägg eftersom den första tröskeln för forumbadging är ett poäng på 1.
Ytterligare information additional-information
Mer information finns på Grundläggande om poäng och emblem för utvecklare.
Mer information om den avancerade bedömningsmotorn finns i Advanced Scoring and Badges.
Konfigurerbar huvudpanel komponent och function gör det enklare att visa medlemmar och deras poäng på en communitywebbplats.