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:

Opmerking de toekenning van badges standaard niet ingeschakeld.

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 dataopslag op

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

De badges zijn in de UGC verschillend wat betreft de vraag of zij volgens de regels werden toegewezen of verdiend. Momenteel worden toegewezen badges weergegeven als tekst en worden verdiende badges als een afbeelding weergegeven.

Bandenbeheer-interface badge-management-ui

De Gemeenschappen Badges-console biedt de mogelijkheid om aangepaste badges toe te voegen die voor een lid kunnen worden weergegeven wanneer het lid zijn verdiend (toegekend) of wanneer het een specifieke rol in de gemeenschap (toegewezen) op zich neemt.

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.

Toegewezen (en aangepaste) badges worden opgeslagen in de geselecteerde SRP en niet rechtstreeks toegankelijk zijn. Totdat een GUI beschikbaar is, is het enige middel om op rol-gebaseerde badges toe te wijzen dit met code of cURL. Zie de sectie over cURL-instructies Badges toewijzen en intrekken.

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 kunnen weergeven, moeten er twee dingen gebeuren:

De release bevat drie beloningsbadges:

Aangepaste badges custom-badges

Aangepaste badges kunnen worden geïnstalleerd met de Badges-console en toegewezen of opgegeven in badgingregels.

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 Snel testen om het scoren voor een communautaire site mogelijk te maken met de standaardregels voor scoring en badging voor forums en opmerkingen.

Regels toepassen op inhoud apply-rules-to-content

Als u scoring en badges wilt inschakelen, voegt u de eigenschappen toe scoringRules en badgingRulesnaar een knooppunt in de inhoudsstructuur voor de site.

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

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 is cq:Page (aanbevolen), voegt u met behulp van CRXDE|Lite de eigenschappen toe aan de bijbehorende jcr:contentknooppunt.

Badges voor component inschakelen enable-badges-for-component

De regels voor inschalen en insluiten zijn alleen van toepassing op instanties van componenten die intekenen hebben ingeschakeld door de componentconfiguratie te bewerken in ontwerpmodus.

Een Booleaanse eigenschap, allowBadgesschakelt u de weergave van badges voor een componentinstantie in of uit. Het is configureerbaar in dialoogvenster voor bewerken van componenten voor forum, QnA en commentaarcomponenten door een checkbox geëtiketteerd Badges weergeven.

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

Scoreregels scoring-rules

Scoreregels vormen de basis voor scoring met het oog op het toekennen van badges.

Heel eenvoudig, is elke het scoren regel een lijst van één of meerdere sub-regels. 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 jcr:contentknooppunt dat de lijst opgeeft met subregels die deze definiëren.

Scores worden opgeslagen in SRP.

Subregels voor score scoring-sub-rules

De scoringsubregels 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 in de subregel wordt aangegeven dat de eigenaar van de inhoud de punten ontvangt ( forOwner).

Elke subregel kan in een of meer scoreregels worden opgenomen.

De naam van de subregel volgt doorgaans het patroon van het gebruik van een onderwerp, object en werkwoord. Bijvoorbeeld:

Subregels zijn knooppunten van het type cq:Page met eigenschappen jcr:contentknooppunt dat de werkwoorden en onderwerpen .

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

In de release zijn twee scoreregels opgenomen voor de Functie van forum (elk voor de onderdelen Forum en Opmerkingen van het Forum):

Opmerkingen:

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 jcr:contentknooppunt dat de correlatie heeft tussen de scoreregels en scores en badges.

De regels voor het aanbrengen van een kenteken bestaan uit een verplicht thresholdseigenschap die een geordende lijst is met scores die aan badges zijn toegewezen. 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 met de titel Regels toepassen op inhoud.

De scoringRuleshet bezit op een merkingsregel beperkt eenvoudig welke het schatten regels met die bepaalde merkingsregel kunnen worden geparineerd.

Ingesloten Badgingregels included-badging-rules

In de release zijn twee Badging Rules opgenomen die overeenkomen met de Scoreregels voor forums en opmerkingen.

Opmerkingen:

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 de leden worden toegekend met behulp van de ledenconsole of via programmacode met cURL-opdrachten.

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 header -u *signin * -F *operation * -F *badge * member-profile-url

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

handtekening = administrator-id:password
bijvoorbeeld: admin:admin

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

badge = "badgeContentPath=badge-image-file"

badge-image-file = de locatie van het merkimagebestand in de gegevensopslagruimte
bijvoorbeeld: /etc/community/badging/images/moderator/jcr:content/moderator.png

member-profile-url = het eindpunt voor het profiel van het lid bij publicatie
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=/etc/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=/etc/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 actionsdie voor een topic. De SocialEvent bevat een methode om een verbaan de handeling is gekoppeld. Er is een n-1 relatie tussen actionsen verbs.

Voor de geleverde community-componenten worden in de volgende tabellen de volgende verbsgedefinieerd voor elk topicbeschikbaar voor gebruik in scoring-subregels.

Kalendercomponent
SocialEvent topic= com/adobe/cq/social/agenda

Component Opmerkingen
SocialEvent topic= com/adobe/cq/social/comment

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

Forum-component
SocialEvent topic= com/adobe/cq/social/forum

Journal-component
SocialEvent topic= com/adobe/cq/social/journaal

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

Component Reviews
SocialEvent topic= com/adobe/cq/social/review

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

Stemcomponent
SocialEvent topic= com/adobe/cq/social/tally/stemgerechtigd

Componenten met moderatie
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 actionsdie voor een topic.

Ter ondersteuning van scoring moet de methode SocialEvent worden overschreven getVerb() zodat verbis geretourneerd voor elk action. De verb De geretourneerde waarde voor een handeling kan een veelgebruikte handeling zijn (zoals POST) of een voor de component gespecialiseerde instantie (zoals ADD RATING). Er is een n-1 relatie tussen actionsen verbs.

Problemen oplossen troubleshooting

Badges worden niet weergegeven badges-are-not-appearing

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

Zie Badges voor component inschakelen.

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 de scoringRuleseigenschap van Badgingregels.

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 snel scoring en badge te proberen met de Zelfstudie Aan de slag site:

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

Volgende, herpubliceren de site van de gemeenschap.

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 is te vinden op de Scores en Badges Essentials pagina voor ontwikkelaars.

Voor informatie over de geavanceerde scoring-engine raadpleegt u Geavanceerde scores en Badges.

Het configureerbare Leaderboard component en function vereenvoudigt de weergave van leden en hun scores op een community-site.