Pontuação de comunidades e emblemas

Visão geral

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

Os principais aspectos da pontuação e dos emblemas são:

​Observe que a atribuição de emblemas não está ativada por padrão.

CUIDADO

A estrutura de implementação visível no CRXDE Lite está sujeita a alterações assim que a interface do usuário estiver disponível.

Selos

Os símbolos são colocados sob o nome de um membro para indicar sua função ou sua posição na comunidade. Os símbolos 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 emblemas estão localizados no repositório em

  • /libs/settings/community/badging/images

Se armazenados em um local diferente, eles devem ser lidos e acessíveis a todos.

Os crachás são diferenciados no UGC quanto ao fato de terem sido atribuídos ou recebidos de acordo com as regras. Atualmente, os símbolos atribuídos são exibidos como texto e os símbolos ganhos são exibidos como uma imagem.

Interface do usuário do Gerenciamento de emblema

O console Comunidades Distinções oferece a capacidade de adicionar símbolos personalizados que podem ser exibidos para um membro quando recebidos (concedidos) ou quando assumem uma função específica na comunidade (atribuídos).

Caracteres atribuídos

Os emblemas baseados em funções são atribuídos por um administrador aos membros da comunidade com base em sua função na comunidade.

Os símbolos atribuídos (e avisados) são armazenados no SRP selecionado e não são diretamente acessíveis. Até que uma GUI esteja disponível, o único meio de atribuir emblemas baseados em funções é fazer isso com código ou cURL. Para obter instruções de cURL, consulte a seção Atribuir e Revogar emblemas.

Na versão estão incluídos três emblemas baseados em função:

  • moderador

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

  • gestor de grupo

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

  • membro privilegiado

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

    crachás atribuídos

Distinções atribuídas

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

Para que os crachás apareçam como recompensa pela atividades, há duas coisas que devem acontecer:

  • A marcação deve estar ativada para o componente de recurso.
  • As regras de pontuação e marcação devem ser aplicadas à página (ou ancestral) na qual o componente é colocado.

Na versão estão incluídos três cartões baseados em recompensa:

  • ouro

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

  • prata

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

  • bronze

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

    crachás concedidos

Observação

As regras de pontuação podem ser configuradas para atribuir pontos negativos para postagens sinalizadas como inadequadas e, portanto, afetar o valor da pontuação. No entanto, uma vez obtido um crachá, ele não será removido automaticamente devido à redução do ponto de pontuação ou a alterações na regra de pontuação.

Os emblemas atribuídos podem ser revogados da mesma forma que os emblemas atribuídos. Consulte a seção Atribuir e Revogar emblemas. As melhorias futuras incluirão uma interface do usuário para gerenciar os emblemas dos membros.

Caracteres personalizados

Os símbolos personalizados podem ser instalados usando o console Distintos e atribuídos ou especificados nas regras de identificação.

Quando instalados a partir do console Distintos, os símbolos personalizados são replicados automaticamente para o ambiente de publicação.

Ativar Pontuação

A pontuação não está ativada por padrão. As etapas básicas para a configuração e habilitação da pontuação e da atribuição dos emblemas são:

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

Aplicar regras ao conteúdo

Para ativar a pontuação e os emblemas, adicione as propriedades scoringRules e badgingRules a 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-o novamente.

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

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

Propriedade Tipo Descrição
badgingRules Sequência de caracteres uma lista de matriz de regras de identificação
regras de pontuação Sequência de caracteres uma lista de matriz de regras de pontuação
Observação

Se uma regra de pontuação parecer não ter efeito na atribuição de emblemas, verifique se a regra de pontuação não foi bloqueada pela propriedade scoringRules da regra de classificação. Consulte a seção intitulada Regras de identificação.

Ativar emblemas para o componente

As regras de pontuação e sombreamento estão em vigor somente para instâncias de componentes que habilitaram a identificação ao editar a configuração do componente no modo de criação.

Uma propriedade booleana, allowBadges, ativa/desativa a exibição de emblemas para uma instância do componente. Ele é configurável na caixa de diálogo edição de componente para o fórum, QnA e componentes de comentário por meio de uma caixa de seleção chamada Distinções de exibição.

Exemplo: allowBadges para a instância do componente do Fórum

enable-badges-component

Observação

Qualquer componente pode ser sobreposto para exibir emblemas usando o código HBS encontrado em fóruns, QnA e comentários como exemplo.

Regras de Pontuação

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

Muito simplesmente, cada regra de pontuação é uma lista de uma ou mais sub-regras. As regras de pontuação são aplicadas ao conteúdo do site da comunidade para identificar as regras a serem aplicadas quando os emblemas estiverem ativados.

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

  • Se page2 contiver a regra de pontuação2 e sua página 1 anterior contiver a regra de pontuação1.

  • Uma ação em um componente page2 chamará rule1 e rule2.

  • Se ambas as regras contiverem subregras aplicáveis para o mesmo topic/verb:

    • Somente a subregra da rule2 afetará a pontuação.
    • As pontuações de ambas as sub-regras não são adicionadas.

Quando há mais de uma regra de pontuação, as pontuações são mantidas separadamente para cada regra.

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

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

Observação

Prática recomendada: nomeie exclusivamente cada regra de pontuação.

Os nomes das regras de pontuação devem ser globalmente exclusivos; não devem terminar com o mesmo nome.

Um exemplo do que not fazer:

/libs/settings/community/scoring/rules/site1/forums-scoring
/libs/settings/community/scoring/rules/site2/forums-scoring

Sub-regras de Pontuação

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

Cada subregra de pontuação identifica:

  • Que atividades estão sendo rastreadas?
  • Que função comunitária específica está envolvida?
  • Quantos pontos são atribuídos?

Por padrão, os pontos são concedidos ao membro que está tomando a ação, a menos que a subregra especifique o proprietário do conteúdo como recebendo os 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 subject, object e verb. Por exemplo:

  • membro-comment-create
  • membro-a-voto

As subregras são nós do tipo cq:Page com propriedades no nó jcr:contentque especificam os verbos e tópicos.

Propriedade Tipo Valor Descrição
VERB Longo
  • obrigatório; o verbo corresponde a uma ação de evento
  • deve haver pelo menos uma propriedade verb
  • o verbo deve ser inserido em todas as MAIÚSCULAS
  • pode haver várias propriedades de verbo, mas nenhum duplicado
  • o valor é a pontuação a ser aplicada para este evento
  • o valor pode ser positivo ou negativo
  • uma lista de verbos suportados na versão está na seção Tópicos e Verbos
topics Sequência de caracteres
  • facultativo; restringe a sub-regra aos componentes da comunidade identificados pelos tópicos do evento
  • se especificado: value é uma string de vários valores de tópicos de evento
  • uma lista de tópicos na versão está na seção Tópicos e Verbos
  • o padrão é aplicar a todos os tópicos associados aos verbos
forOwner Booleano
  • facultativo; não relevante quando o membro está agindo sobre o conteúdo que possui
  • se verdadeiro, aplique a pontuação ao proprietário do conteúdo que está sendo executado
  • se falso, aplique a pontuação ao membro que está realizando a ação
  • o padrão é false
scoringType Sequência de caracteres
  • facultativo; identifica o mecanismo de pontuação
  • se "básico", especifica o mecanismo de pontuação com base na quantidade
    • incluído na versão
  • se "avançado", especifica o mecanismo de pontuação com base na qualidade e quantidade
  • o padrão é "basic"

Regras e sub-regras de pontuação incluídas

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

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

    • subRules[] =
      /libs/settings/community/scoring/rules/sub-rules/membro-comment-create
      /libs/settings/community/scoring/rules/sub-rules/member-receive-vote
      /libs/settings/community/scoring/rules/sub-rules/membro-em-votação
      /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/membro-forum-create
      /libs/settings/community/scoring/rules/sub-rules/member-receive-vote
      /libs/settings/community/scoring/rules/sub-rules/membro-em-votação
      /libs/settings/community/scoring/rules/sub-rules/member-is-moderated

Notas:

  • Os nós rules e sub-rules são do tipo cq:Page.

  • subRules é um atributo do tipo [] String no jcr:content nó da regra.

  • sub-rules pode ser compartilhado entre várias regras de pontuação.

  • rules deve estar localizado em um local de repositório com permissão de leitura para todos.

    • Os nomes de regras devem ser exclusivos, independentemente do local.

Ativando Regras de Pontuação Personalizadas

Quaisquer alterações ou adições feitas às regras ou sub-regras de pontuação feitas no ambiente do autor precisam ser instaladas na publicação.

Regras de marcação

As regras de marcação vinculam as regras de pontuação aos símbolos especificando:

  • Regra de pontuação
  • Pontuação necessária para receber um crachá específico

As regras de marcação são nós do tipo cq:Page com propriedades em seu nó jcr:content que correlacionam as regras de pontuação com pontuações e emblemas.

As regras para identificação consistem em uma propriedade thresholds obrigatória que é uma lista ordenada de pontuações mapeadas para símbolos. As pontuações devem ser ordenadas em valor crescente. Por exemplo:

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

    • Um crachá de bronze é avisado por ganhar 1 ponto.
  • 60|/libs/settings/community/badging/images/silver-badge/jcr:content/silver.png

    • Um selo de prata é concedido quando se acumulam 60 pontos.
  • 80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png

    • Um selo de ouro é emitido quando se acumulam 80 pontos.

As regras de marcação são emparelhadas com regras de pontuação, que determinam como os pontos se acumulam. Consulte a seção intitulada Aplicar regras ao conteúdo.

A propriedade scoringRules em uma regra de identificação simplesmente restringe quais regras de pontuação podem ser pareadas com essa regra de identificação específica.

Observação

Melhores práticas : crie imagens de emblema exclusivas para cada site AEM.

badging-rule-configuration

Propriedade Tipo Valor Descrição
limiares Sequência de caracteres (obrigatório) Uma string de vários valores do formulário 'number|path'
  • número = pontuação
  • | = barra vertical (U+007C)
  • caminho = caminho completo para o recurso de imagem de emblema
As sequências de caracteres devem ser ordenadas de modo que os números aumentem em valor e nenhum espaço em branco deve aparecer entre o número e o caminho.
Exemplo de entrada :
80|/libs/settings/community/badging/images/gold-badge/jcr:content/gold.png
badgingType Sequência de caracteres (opcional) Identifica o mecanismo de pontuação como "básico" ou "avançado". Se o mecanismo avançado de pontuação for desejado, consulte Pontuação avançada e emblemas. O padrão é "básico".
regras de pontuação Sequência de caracteres (opcional) Uma string de vários valores para restringir a regra de identificação aos eventos de pontuação identificados pelas regras de pontuação

Regras de marcação incluídas

Na versão estão incluídas duas Regras de classificação que correspondem às Fóruns e Regras de pontuação de comentários.

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

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

Notas:

  • rules nós são do tipo cq:Page.

  • rules deve estar localizado em um local de repositório com permissão de leitura para todos.

    • Os nomes de regras devem ser exclusivos, independentemente da localização.

Ativando regras personalizadas de identificação

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

Atribuir e Revogar Crachás

Os símbolos podem ser atribuídos a membros usando o console membros ou programaticamente usando comandos cURL.

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

cURL -i -X POST -H header -u logon -F operation -F badge membro-perfil-url

header = "Aceitar:aplicativo/json" cabeçalho personalizado para passar para o servidor (obrigatório)

sign = administrative-id:password por exemplo: admin:admin

operation = ":operation=social:assignBadge" OU ":operation=social:deleteBadge"

badge = "badgeContentPath=badge-image-file"

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

member-perfil-url = o ponto final do perfil do membro na publicação, por exemplo: https://<server>:<port>/home/users/community/riley/profile.social.json

Observação

O perfil-membro-url:

Exemplos:

Atribuir um selo de moderador

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 crachá prateado atribuído

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
Observação

Usar cURL para atribuir e revogar emblemas funciona em qualquer imagem de emblema, mas quando atribuídos em vez de ganhados, eles são marcados como emblemas atribuídos e manipulados de acordo.

Pontuação e símbolos para componentes personalizados

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

Tópicos e Verbos

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

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

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

Observação

Uma nova propriedade booleana, allowBadges, ativa/desativa a exibição de emblemas para uma instância do componente. Ele será configurável em caixas de diálogo de edição de componente atualizadas por meio de uma caixa de seleção chamada Distinções de exibição.

Calendar
ComponentSocialEvent topic= com/adobe/cq/social/calendário

Verbo Descrição
POST membro cria um evento de calendário
ADICIONAR comentários do membro em um evento de calendário
ATUALIZAR o evento do calendário ou comentário do membro é editado
EXCLUIR o evento ou comentário do calendário do membro é excluído

Comentários
ComponentSocialEvent topic= com/adobe/cq/social/comment

Verbo Descrição
POST membro cria um comentário
ADICIONAR membro responde ao comentário
ATUALIZAR o comentário do membro é editado
EXCLUIR o comentário do membro é excluído

Biblioteca de arquivos
ComponenteSocialEvent topic= com/adobe/cq/social/fileLibrary

Verbo Descrição
POST membro cria uma pasta
ANEXAR membro carrega um arquivo
ATUALIZAR membro atualiza uma pasta ou arquivo
EXCLUIR membro exclui uma pasta ou arquivo

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

Verbo Descrição
POST membro cria tópico do fórum
ADICIONAR respostas do membro ao tópico do fórum
ATUALIZAR o tópico do fórum do membro ou a resposta é editada
EXCLUIR o tópico do fórum do membro ou a resposta é excluída

Journal
ComponentSocialEvent topic= com/adobe/cq/social/journal

Verbo Descrição
POST membro cria um artigo de blog
ADICIONAR membro comenta em um artigo de blog
ATUALIZAR artigo ou comentário do membro do blog é editado
EXCLUIR artigo ou comentário do membro do blog é excluído

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

Verbo Descrição
POST membro cria uma pergunta QnA
ADICIONAR membro cria uma resposta QnA
ATUALIZAR pergunta ou resposta QnA do membro é editada
SELECIONAR a resposta do membro é selecionada
CANCELAR SELEÇÃO a resposta do membro é desmarcada
EXCLUIR pergunta ou resposta do membro é excluída

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

Verbo Descrição
POST membro cria revisão
ATUALIZAR a revisão do membro é editada
EXCLUIR a revisão do membro é excluída

Classificação
de componenteSocialEvent topic= com/adobe/cq/social/tally/rating

Verbo Descrição
ADICIONAR CLASSIFICAÇÃO o conteúdo do membro foi avaliado
REMOVER CLASSIFICAÇÃO o conteúdo do membro foi reduzido

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

Verbo Descrição
ADICIONAR VOTAÇÃO o conteúdo do membro foi votado
REMOVER VOTAÇÃO o conteúdo do membro foi rejeitado

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

Verbo Descrição
NEGAR conteúdo do membro negado
SINALIZADOR COMO INAPROPRIADO o conteúdo do membro está sinalizado
IMPRUDENTE COMO INAPROPRIADO o conteúdo do membro não está sinalizado
ACEITAR o conteúdo do membro é aprovado pelo moderador
FECHAR membro fecha comentário a edições e respostas
ABRIR membro reabre comentário

Eventos de componentes personalizados

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

Para suportar a pontuação, o SocialEvent precisaria substituir o método getVerb() para que um verb apropriado seja retornado para cada action. O verb retornado para uma ação pode ser um usado comumente (como POST) ou um especializado para o componente (como ADD RATING). Existe uma relação n-1 entre actions e verbs.

Resolução de problemas

Os símbolos não aparecem

Se as regras de pontuação e marcação tiverem sido aplicadas ao conteúdo do site, mas os emblemas não estiverem sendo avisados para nenhuma atividade, verifique se os emblemas foram ativados para a instância desse componente.

Consulte Ativar emblemas para o componente.

A regra de pontuação não tem efeito

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

Consulte a propriedade scoringRules de Regras de identificação.

Tipo com distinção entre maiúsculas e minúsculas

A maioria das propriedades e valores, especialmente os verbos, fazem distinção entre maiúsculas e minúsculas. Os verbos devem ser todos 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

É possível tentar marcar e marcar rapidamente usando o Site de Introdução (engajar):

  • Acesse CRXDE Lite no autor.

  • Navegue até a página base:

    • /content/sites/contact/en/jcr:content
  • Adicione a propriedade badgingRules:

    • Nome: badgingRules
    • Tipo: String
    • Selecione Multi
    • Selecione Adicionar
    • Digite /libs/settings/community/badging/rules/forums-badging
    • Selecionar +
    • Digite /libs/settings/community/badging/rules/comments-badging
    • Selecione OK
  • Adicione a propriedade scoringRules:

    • Nome: scoringRules
    • Tipo: String
    • Selecione Multi
    • Selecione Adicionar
    • Digite /libs/settings/community/scoring/rules/forums-scoring
    • Selecionar +
    • Digite /libs/settings/community/scoring/rules/comments-scoring
    • Selecione OK
  • Selecione Salvar tudo.

marcação de teste

Em seguida, verifique se os componentes do fórum e dos comentários permitem a exibição de emblemas:

  • Mais uma vez usando o CRXDE Lite.

  • Navegue até o componente do fórum

    • /content/sites/engage/en/forum/jcr:content/content/primary/forum
  • Adicione a propriedade booleana allowBadges, se necessário, e verifique se ela é verdadeira.

    • Nome: allowBadges
    • Tipo: Boolean
    • Valor: true

test-forum-component

Em seguida, republique o site da comunidade.

Finalmente,

  • Navegue até o componente na instância de publicação.

  • Fazer logon como membro da comunidade (por exemplo: weston.mccall@dodgit.com / senha).

  • Poste um novo tópico do fórum.

  • A página deve ser atualizada para que o crachá seja exibido.

    • Logout e login como um membro da comunidade diferente (por exemplo: aaron.mcdonald@mailinator.com/senha).
  • Selecione o Fórum.

Isso deve ganhar um crachá de bronze para o membro da comunidade, visível em sua publicação no fórum, devido ao primeiro limite da regra de identificação dos fóruns ter uma pontuação de 1.

bronzebadge

Informações adicionais

Mais informações podem ser encontradas na página Scoring and Badges Essentials para desenvolvedores.

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

O Quadro de líderes componente e função configuráveis simplificam a exibição de membros e suas pontuações em um site da comunidade.

Nesta página