Scores en badges van gemeenschappen communities-scoring-and-badges

Overzicht overview

Met de functie AEM Communities scoring en badges kunnen leden van de gemeenschap worden geïdentificeerd en beloond.

De belangrijkste aspecten van scoring en badges zijn:

Nota dat het verlenen van badges niet door gebrekwordt toegelaten.

Badges badges

De badges worden onder de naam van een lid geplaatst om hun rol of hun status in de gemeenschap aan te geven. Badges kunnen als een afbeelding of als een naam worden weergegeven. Wanneer de naam als afbeelding wordt weergegeven, wordt deze opgenomen als alternatieve tekst voor toegankelijkheid.

Standaard bevinden badges zich in de volgende opslagplaats:

Als ze op een andere locatie zijn opgeslagen, moeten ze door iedereen toegankelijk worden gelezen.

De badges worden in UGC gedifferentieerd, ongeacht of zij volgens de regels zijn toegewezen of verdiend. Momenteel worden toegewezen badges weergegeven als tekst en worden verdiende badges als een afbeelding weergegeven.

Bandenbeheer-gebruikersinterface badge-management-ui

De console van de Banden van Gemeenschappen 🔗 laat u douanebadges toevoegen die voor een lid kunnen worden getoond wanneer verdiend (toegekend) of wanneer zij een specifieke rol in de (toegewezen) gemeenschap nemen.

Toegewezen badges assigned-badges

Op rollen gebaseerde badges worden door een beheerder toegewezen aan leden van de community op basis van hun rol in de community.

De toegewezen (en toegekende) badges worden opgeslagen in geselecteerde SRPen zijn niet direct toegankelijk. Totdat een GUI beschikbaar is, is het enige middel om op rol-gebaseerde badges toe te wijzen dit met code of cURL. Voor cURL instructies, zie de sectie die wordt genoemd Wijs en trek Badgesterug.

In de release zijn drie badges op basis van rollen opgenomen:

Toegewezen badges awarded-badges

Op basis van beloningen ontvangen de leden van de gemeenschap een toegangspasje met een score op basis van regels die gelden voor hun activiteiten in de gemeenschap.

Om badges als beloning voor activiteit te laten verschijnen, moeten er twee dingen gebeuren:

De release bevat drie beloningsbadges:

Aangepaste badges custom-badges

De badges van de douane kunnen worden geïnstalleerd gebruikend de console van Badgesen of toegewezen of in het badging regels gespecificeerd.

Wanneer deze vanaf de Badges-console zijn geïnstalleerd, worden aangepaste badges automatisch naar de publicatieomgeving gerepliceerd.

Muziek inschakelen enable-scoring

Scores is niet standaard ingeschakeld. De basisstappen voor het opzetten en mogelijk maken van scoring en toekenning van badges zijn:

Zie de Snelle sectie van de Testom het scoren voor een communautaire plaats toe te laten gebruikend het gebrek het scoren en het badging regels voor forums en commentaren.

Regels toepassen op inhoud apply-rules-to-content

Als u scoring en badges wilt inschakelen, voegt u de eigenschappen scoringRules en badgingRules toe aan elk knooppunt in de inhoudsstructuur voor de site.

Als de site al is gepubliceerd, publiceert u de site opnieuw nadat u alle regels hebt toegepast en componenten hebt ingeschakeld.

De regels die op een badging-toegelaten component van toepassing zijn zijn die voor de huidige knoop of zijn voorvader.

Als het knooppunt van het type cq:Page is (aanbevolen), voegt u met behulp van CRXDE|Lite de eigenschappen toe aan het jcr:content -knooppunt.

Badges voor component inschakelen enable-badges-for-component

De het scoren en het inkleuren regels zijn in feite slechts voor instanties van componenten die merkend hebben toegelaten door de componentenconfiguratie in auteurswijzeuit te geven.

Een Booleaanse eigenschap, allowBadges , schakelt de weergave van badges voor een componentinstantie in of uit. Het is configureerbaar in de component geeft dialoogvoor forum uit, QnA, en commentaarcomponenten door een checkbox geëtiketteerd Badges van de Vertoning.

Voorbeeld: allowBadges voor instantie van de component Forum example-allowbadges-for-forum-component-instance

Scoreregels scoring-rules

Scoreregels vormen de basis voor scoring bij het toekennen van badges.

Elke scoreregel is een lijst met een of meer subregels. Scoreregels worden toegepast op de inhoud van de communautaire plaats om de regels te identificeren om toe te passen wanneer de badges worden toegelaten.

Scoreregels worden overgeërfd, maar niet additief. Bijvoorbeeld:

Wanneer er meer dan één scoreregel is, worden de scores afzonderlijk gehandhaafd voor elke regel.

Scoreregels zijn knooppunten van het type cq:Page met eigenschappen op het knooppunt jcr:content die de lijst met subregels opgeven die deze definiëren.

Scores worden opgeslagen in SRP.

Subregels voor scores scoring-sub-rules

De subregels voor scoring bevatten de eigenschappen die de waarden voor deelname aan de gemeenschap in detail beschrijven.

Elke scoring-subregel identificeert:

Standaard worden punten toegewezen aan het lid dat de handeling uitvoert, tenzij de subregel de eigenaar van de inhoud opgeeft als ontvangende punten ( forOwner).

Elke subregel kan in een of meer scoreregels worden opgenomen.

De naam van de onderregel volgt typisch het patroon van het gebruiken van a onderwerp, voorwerp, en werkb. Bijvoorbeeld:

Subrules zijn knopen van type cq:Page met eigenschappen op zijn jcr:content knoop die werkwoorden en onderwerpenspecificeren.

Inclusief rangtelregels en subregels included-scoring-rules-and-sub-rules

Omvat in de versie zijn twee het scoren regels voor de Functie van het Forum(elk voor het Forum en de componenten van Commentaren van de eigenschap van het Forum):

Nota's:

Aangepaste sorteerregels activeren activating-custom-scoring-rules

Wijzigingen of toevoegingen aan de in de ontwerpomgeving aangebrachte scoreregels of subregels moeten bij publicatie worden geïnstalleerd.

Badgingregels badging-rules

De regels van de Badging koppelen het scoring regels aan badges door te specificeren:

Badgingregels zijn knooppunten van het type cq:Page met eigenschappen op het jcr:content -knooppunt die correleren tussen scoreregels en scores en badges.

De regels voor badging bestaan uit een verplichte eigenschap thresholds die een geordende lijst is met scores die zijn toegewezen aan badges. De scores moeten in stijgende waarde worden bevolen. Bijvoorbeeld:

De regels van de Badging zijn gepareerd met het scoring regels, die bepalen hoe de punten zich ophopen. Zie de sectie genoemd Regels op Inhoudtoepassen.

De eigenschap scoringRules op een badging-regel beperkt eenvoudig welke scoring-regels met die bepaalde badging-regel kunnen worden gekoppeld.

Ingesloten Badgingregels included-badging-rules

Omvat in de versie zijn twee het Badging Regels die aan de Forums en Commentaren het Scoren Regelsbeantwoorden.

Nota's:

Aangepaste Badgingregels activeren activating-custom-badging-rules

Wijzigingen of toevoegingen aan badgingregels of afbeeldingen die in de ontwerpomgeving zijn aangebracht, moeten bij publicatie worden geïnstalleerd.

Badges toewijzen en intrekken assign-and-revoke-badges

De badges kunnen aan leden worden toegewezen die of de ledenconsolegebruiken of programmatically cURL bevelen gebruiken.

De volgende cURL-opdrachten tonen wat nodig is voor een HTTP-aanvraag voor het toewijzen en intrekken van badges. De basisindeling is:

cURL - i -X POST - H kopbal - u signaleert - F verrichting - F badge lid-profiel-url

kopbal = "Accept:application/json"
aangepaste header die aan de server moet worden doorgegeven (vereist)

teken = beheerder-identiteitskaart:wachtwoord
bijvoorbeeld admin:admin

verrichting = ":operation=social:assignBadge"OF ":operation=social:deleteBadge"

badge = "badgeContentPath= badge-image-file"

badge-beeld-dossier = de plaats van het dossier van het merkbeeld in de bewaarplaats
bijvoorbeeld /libs/settings/community/badging/images/moderator/jcr:content/moderator.png

lid-profiel-url = het eindpunt voor het profiel van het lid op publiceren
bijvoorbeeld https://<server>:<port>/home/users/community/riley/profile.social.json

Voorbeelden: examples

Een moderatorbadge toewijzen 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

Toegewezen zilverbadge intrekken 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

Scores en badges voor aangepaste componenten scoring-and-badges-for-custom-components

Het scoren en het merkteken de regels kunnen voor douanecomponenten worden gecreeerd door de gebeurtenisonderwerpen te associëren die voor de component met werkwoorden worden gecreeerd.

Onderwerpen en werven topics-and-verbs

Wanneer leden communiceren met functies van gemeenschappen, worden gebeurtenissen verzonden die asynchrone listeners, zoals meldingen en scoring, kunnen activeren.

De instantie SocialEvent van een component registreert de gebeurtenissen als actions die voor een topic voorkomen. De SocialEvent bevat een methode om een verb te retourneren die aan de handeling is gekoppeld. Er is een n-1 verhouding tussen actions en verbs.

Voor de geleverde gemeenschappen componenten, beschrijven de volgende lijsten verbs die voor elk topic beschikbaar voor gebruik in het scoren subrulesworden bepaald.

Component van de Kalender
SocialEvent topic= com/adobe/cq/social/agenda

Component van Commentaren
SocialEvent topic= com/adobe/cq/social/comment

de Component van de Bibliotheek van het Dossier
SocialEvent topic= com/adobe/cq/social/fileLibrary

Component van het Forum
SocialEvent topic= com/adobe/cq/social/forum

Component van het Dagboek
SocialEvent topic= com/adobe/cq/social/journaal

Component QnA
SocialEvent topic = com/adobe/cq/social/qna

Component van Revisies
SocialEvent topic= com/adobe/cq/social/review

de Component van de Classificatie
SocialEvent topic= com/adobe/cq/social/tally/rating

Stemende Component
SocialEvent topic= com/adobe/cq/social/tally/stemgerechtigd

moderatie-Toegelaten Componenten
SocialEvent topic= com/adobe/cq/social/moderation

Aangepaste componentgebeurtenissen custom-component-events

Voor een aangepaste component wordt een SocialEvent geïnstantieerd om de gebeurtenissen van de component op te nemen als actions die voor een topic voorkomen.

Voor ondersteuning van scoring moet de methode getVerb() worden overschreven door de SocialEvent, zodat de juiste verb wordt geretourneerd voor elke action methode. De verb die voor een actie wordt geretourneerd, kan een algemene instructie zijn (zoals POST ) of een speciale instructie voor de component (zoals ADD RATING ). Er is een n-1 verhouding tussen actions en verbs.

Problemen oplossen troubleshooting

Badges worden niet weergegeven badges-are-not-appearing

Als op de inhoud van de website wel scoring- en badgingregels zijn toegepast, maar er geen badges worden toegekend voor activiteiten, moet u ervoor zorgen dat badges zijn ingeschakeld voor de instantie van die component.

Zie Badges voor Componenttoelaten.

Scoreregel heeft geen effect scoring-rule-has-no-effect

Als op de inhoud van de website scoring- en badingregels zijn toegepast en badges worden toegekend voor bepaalde acties, maar niet voor andere, controleert u of de regel voor badging de scoringregels waarop deze van toepassing is, niet heeft beperkt.

Zie het scoringRules bezit van het Badging Regels.

Hoofdlettergevoelig (typ) case-sensitive-typo

De meeste eigenschappen en waarden, met name de werkwoorden, zijn hoofdlettergevoelig. Bij gebruik in een scoringsubregel moeten de hoekpunten allemaal HOOFDLETTERS zijn.

Als de functie niet naar behoren werkt, controleert u of de gegevens correct zijn ingevoerd.

Snel testen quick-test

Het is mogelijk om het scoren en het tekenen snel te proberen gebruikend Begonnen het Leerprogramma(verbind) plaats:

Zorg er daarna voor dat de forum- en commentaarcomponenten het weergeven van badges toestaan:

Daarna, herpubliceerde communautaire plaats.

Tot slot:

Dit zou het lid van de gemeenschap een bronzen badge moeten verdienen die met hun forumpost zichtbaar is omdat de eerste drempel van de forums-badging regel een score van 1 is.

Aanvullende informatie additional-information

Meer informatie kan op de het Scoren van de Hoofdzaak van Badgespagina voor ontwikkelaars worden gevonden.

Voor informatie over de geavanceerde het scoren motor, zie Geavanceerde het Scoreren en Badges.

De configureerbare component van Leaderboard 🔗 en functievereenvoudigt de vertoning van leden en hun scores op een communautaire plaats.