Pontuação e medalhas das comunidades communities-scoring-and-badges

Visão geral overview

O recurso de pontuação e medalhas do AEM Communities oferece a capacidade de identificar e premiar membros da comunidade.

Os principais aspectos de pontuação e medalhas são:

Nota que a atribuição de medalhas é não ativado por padrão.

Selos badges

As medalhas são colocadas sob o nome de um membro para indicar seu papel ou sua posição na comunidade. Os emblemas podem ser exibidos como uma imagem ou como um nome. Quando exibido como uma imagem, o nome é incluído como texto alternativo para acessibilidade.

Por padrão, os selos estão no repositório no seguinte local:

Se armazenadas em um local diferente, elas devem ser lidas e acessíveis a todos.

As medalhas são diferenciadas em UGC, sejam elas atribuídas ou ganhas de acordo com as regras. Atualmente, as medalhas atribuídas são exibidas como texto e as medalhas obtidas são exibidas como uma imagem.

Interface do usuário de gerenciamento de selos badge-management-ui

As Comunidades Console de selos permite adicionar medalhas personalizadas que podem ser exibidas para um membro quando ganho (premiado) ou quando ele assume uma função específica na comunidade (atribuído).

Medalhas atribuídas assigned-badges

As medalhas baseadas em função são atribuídas por um administrador aos membros da comunidade com base em sua função na comunidade.

Os emblemas atribuídos (e concedidos) são armazenados no SRP e não estão diretamente acessíveis. Até que uma GUI esteja disponível, o único meio de atribuir emblemas baseados em função é fazê-lo com código ou cURL. Para obter instruções sobre cURL, consulte a seção intitulada Atribuir e revogar selos.

Estão incluídos na versão três selos com base em funções:

Medalhas premiadas awarded-badges

Os emblemas baseados em recompensas são concedidos pelo serviço de pontuação aos membros da comunidade com base nas regras aplicadas à atividade na comunidade.

Para que os selos apareçam como uma recompensa por atividade, há duas coisas que devem acontecer:

Estão incluídos na versão três medalhas com base em recompensa:

Medalhas personalizadas custom-badges

Os emblemas personalizados podem ser instalados usando o Console de selos e atribuído ou especificado nas regras de medalha.

Quando instalados no console Selos, os selos personalizados são replicados automaticamente para o ambiente de publicação.

Ativar pontuação enable-scoring

A pontuação não está ativada por padrão. As etapas básicas para configurar e ativar a pontuação e a atribuição de medalhas são:

Consulte a Teste rápido para ativar a pontuação para um site da comunidade usando as regras padrão de pontuação e selo para fóruns e comentários.

Aplicar regras ao conteúdo apply-rules-to-content

Para ativar a pontuação e os selos, adicione as propriedades scoringRules e badgingRules para qualquer nó na árvore de conteúdo do site.

Se o site já estiver publicado, depois de aplicar todas as regras e ativar os componentes, publique novamente o site.

As regras que se aplicam a um componente habilitado para marcação são aquelas do nó atual ou de seu antecessor.

Se o nó for do tipo cq:Page (recomendado), em seguida, usando o CRXDE|Lite, adicione as propriedades à jcr:content nó.

Ativar selos para componente enable-badges-for-component

As regras de pontuação e faixas estão em vigor somente para instâncias de componentes que ativaram a marcação editando a configuração do componente no modo de criação.

Uma propriedade booleana, allowBadges, ativa/desativa a exibição de selos para uma instância de componente. É configurável na variável caixa de diálogo editar componente para componentes de fórum, QnA e comentário por meio de uma caixa de seleção rotulada Exibir selos.

Exemplo: allowBadges para a instância do componente do Fórum example-allowbadges-for-forum-component-instance

Regras de pontuação scoring-rules

As regras de pontuação são a base da pontuação para a atribuição de medalhas.

Cada regra de pontuação é uma lista de uma ou mais subregras. As regras de pontuação são aplicadas ao conteúdo do site da comunidade para identificar as regras a serem aplicadas quando os selos estiverem ativados.

As regras de pontuação são herdadas, mas não aditivas. Por exemplo:

Quando houver mais de uma regra de pontuação, as pontuações serão mantidas separadamente para cada regra.

As regras de pontuação são nós do tipo cq:Page com propriedades em seu jcr:content nó que especifica a lista de subregras que a definem.

As pontuações são armazenadas no SRP.

Sub-regras de pontuação scoring-sub-rules

As subregras de pontuação contêm as propriedades que detalham os valores para participar da comunidade.

Cada subregra de pontuação identifica:

Por padrão, os pontos são atribuídos ao membro que está executando a ação, a menos que a subregra especifique o proprietário do conteúdo como destinatário dos pontos ( forOwner).

Cada subregra pode ser incluída em uma ou mais regras de pontuação.

O nome da subregra normalmente segue o padrão de uso de um assunto, objeto, e verbo. Por exemplo:

As sub-regras são nós do tipo cq:Page com propriedades em seu jcr:contentnó que especifica a verbos e tópicos .

Regras e sub-regras de pontuação incluídas included-scoring-rules-and-sub-rules

Estão incluídas na versão duas regras de pontuação para o Função do fórum (um para os componentes Fórum e Comentários do recurso Fórum):

Notas:

Ativação de regras de pontuação personalizadas activating-custom-scoring-rules

Quaisquer alterações ou adições feitas às regras de pontuação ou subregras feitas no ambiente de criação devem ser instaladas na publicação.

Regras de insígnia badging-rules

As regras de atribuição de emblemas vinculam regras de pontuação aos emblemas especificando:

As regras de insígnia são nós do tipo cq:Page com propriedades em seu jcr:content nó que correlaciona regras de pontuação a pontuações e selos.

As regras para a aposição de thresholds propriedade que é uma lista ordenada de pontuações mapeadas aos selos. As pontuações devem ser ordenadas em valor crescente. Por exemplo:

As regras de insígnia são combinadas às regras de pontuação, que determinam como os pontos se acumulam. Consulte a seção intitulada Aplicar regras ao conteúdo.

A variável scoringRules em uma regra de notificação, o simplesmente restringe quais regras de pontuação podem ser emparelhadas com essa regra de notificação específica.

Regras de insígnia incluídas included-badging-rules

Estão incluídas na versão duas regras de insígnia que correspondem à Regras de pontuação de fóruns e comentários.

Notas:

Ativação das regras personalizadas de marcação activating-custom-badging-rules

Quaisquer alterações ou adições feitas às regras de marcação ou imagens feitas no ambiente de criação devem ser instaladas na publicação.

Atribuir e revogar selos assign-and-revoke-badges

Os emblemas podem ser atribuídos aos membros usando o console de membros ou programaticamente usando comandos cURL.

Os seguintes comandos cURL mostram o que é necessário para uma solicitação HTTP para atribuir e revogar selos. O formato básico é:

cURL -i -X POST -H cabeçalho -u fazer logon -F operação -F selo member-profile-url

cabeçalho = cabeçalho personalizado "Accept:application/json" para passar para o servidor (obrigatório)

fazer logon = administrator-id:password por exemplo, admin:admin

operação = ":operation=social:assignBadge" OR ":operation=social:deleteBadge"

selo = "badgeContentPath=badge-image-file"

badge-image-file = o local do arquivo de imagem do selo no repositório, por exemplo, /libs/settings/community/badging/images/moderator/jcr:content/moderator.png

member-profile-url = o endpoint do perfil do membro em publicar, por exemplo, https://<server>:<port>/home/users/community/riley/profile.social.json

Exemplos: examples

Atribuir um selo de moderador 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

Revogar um selo prateado atribuído 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

Pontuação e selos para componentes personalizados scoring-and-badges-for-custom-components

As regras de pontuação e medalha podem ser criadas para componentes personalizados associando os tópicos do evento criados para o componente com verbos.

Tópicos e verbos topics-and-verbs

Quando os membros interagem com os recursos de comunidades, são enviados eventos que podem acionar ouvintes assíncronos, como notificações e pontuação.

A instância SocialEvent de um componente registra os eventos como actions que ocorrem por um topic. O SocialEvent inclui um método para retornar um verb associada à ação. Existe uma n-1 relação entre actions e verbs.

Para os componentes de comunidades entregues, as tabelas a seguir descrevem a verbs definido para cada topic disponível para uso no subregras de pontuação.

Componente de calendário
SocialEvent topic= com/adobe/cq/social/calendar

Componente de comentários
SocialEvent topic= com/adobe/cq/social/comment

Componente da biblioteca de arquivos
SocialEvent topic= com/adobe/cq/social/fileLibrary

Componente do fórum
SocialEvent topic= com/adobe/cq/social/forum

Componente do diário
SocialEvent topic= com/adobe/cq/social/journal

Componente de QnA
SocialEvent topic = com/adobe/cq/social/qna

Componente de análises
SocialEvent topic= com/adobe/cq/social/review

Componente de classificação
SocialEvent topic= com/adobe/cq/social/tally/rating

Componente de votação
SocialEvent topic= com/adobe/cq/social/tally/voting

Componentes habilitados para moderação
SocialEvent topic= com/adobe/cq/social/moderation

Eventos de componente personalizados custom-component-events

Para um componente personalizado, um SocialEvent é instanciado para registrar os eventos do componente como actions que ocorrem por um topic.

Para suportar pontuação, o SocialEvent precisa substituir o método getVerb() de modo a que um verb é retornado para cada action. A variável verb retornados para uma ação podem ser aqueles normalmente usados (como POST) ou uma especializada para o componente (como ADD RATING). Existe uma n-1 relação entre actions e verbs.

Resolução de problemas troubleshooting

As medalhas não aparecem badges-are-not-appearing

Se as regras de pontuação e medalha tiverem sido aplicadas ao conteúdo do site, mas as medalhas não estiverem sendo concedidas para nenhuma atividade, verifique se as medalhas foram ativadas para a instância desse componente.

Consulte Ativar selos para componente.

A regra de pontuação não tem efeito scoring-rule-has-no-effect

Se as regras de pontuação e medalha tiverem sido aplicadas ao conteúdo do site, e as medalhas estiverem sendo concedidas para algumas ações, mas não outras, verifique se a regra de medalha não restringiu as regras de pontuação às quais se aplica.

Consulte a scoringRules propriedade de Regras de insígnia.

Erro de digitação que diferencia maiúsculas de minúsculas case-sensitive-typo

A maioria das propriedades e valores, especialmente os verbos, fazem distinção entre maiúsculas e minúsculas. Todos os verbos devem estar em MAIÚSCULAS quando usados em uma subregra de pontuação.

Se o recurso não estiver funcionando como esperado, verifique se os dados foram inseridos corretamente.

Teste rápido quick-test

É possível tentar rapidamente a pontuação e o badging usando o Tutorial de introdução (engajar) local:

Em seguida, verifique se os componentes do fórum e dos comentários permitem que os emblemas sejam exibidos:

Em seguida, republicar site da comunidade.

Finalmente,

Isso deve dar ao membro da comunidade um selo de bronze visível com sua publicação no fórum, devido ao primeiro limite da regra de classificação em fóruns ser uma pontuação de 1.

Informações adicionais additional-information

Mais informações podem ser encontradas no Fundamentos de pontuação e medalhas página para desenvolvedores.

Para obter informações sobre o mecanismo de pontuação avançado, consulte Pontuação avançada e medalhas.

O quadro de classificação configurável componente e função simplifica a exibição de membros e suas pontuações em um site da comunidade.