Puntuación y distintivos de comunidades communities-scoring-and-badges
Información general overview
La función de puntuación y distintivos de AEM Communities permite identificar y premiar a los miembros de la comunidad.
Los principales aspectos de la puntuación y las insignias son:
-
Asignar distintivos identificar el papel de un miembro en la comunidad
-
Asignación básica de distintivos a los miembros para fomentar su participación (cantidad de contenido creado)
-
Asignación avanzada de distintivos para identificar a los miembros como expertos (calidad del contenido creado)
Nota que la concesión de distintivos es no habilitado de forma predeterminada.
Insignias badges
Los distintivos se colocan bajo el nombre de un miembro para indicar su papel o su posición en la comunidad. Los distintivos pueden mostrarse como una imagen o como un nombre. Cuando se muestra como una imagen, el nombre se incluye como texto alternativo para la accesibilidad.
De forma predeterminada, los distintivos se encuentran en el repositorio en
- /etc/community/badging/images
Si se almacenan en una ubicación diferente, todos deben poder leerlos.
Los distintivos se diferencian en UGC en cuanto a si fueron asignados o ganados según las reglas. Actualmente, los distintivos asignados aparecen como texto y los distintivos obtenidos aparecen como una imagen.
Interfaz de usuario de administración de distintivos badge-management-ui
Las Comunidades Consola Distintivos proporciona la capacidad de agregar distintivos personalizados que se pueden mostrar para un miembro cuando se ganan (se conceden) o cuando asumen una función específica en la comunidad (se asignan).
Distintivos asignados assigned-badges
Un administrador asigna los distintivos basados en el rol a los miembros de la comunidad según su rol en la comunidad.
Los distintivos asignados (y adjudicados) se almacenan en el SRP y no son directamente accesibles. Hasta que una GUI esté disponible, el único medio para asignar distintivos basados en funciones es hacerlo con código o cURL. Para obtener instrucciones de cURL, consulte la sección titulada Asignar y revocar distintivos.
En la versión se incluyen tres distintivos basados en funciones:
-
Moderador
/etc/community/badging/images/moderator/jcr:content/moderator.png
-
Administrador de grupos
/etc/community/badging/images/group-manager/jcr:content/group-manager.png
-
Miembro privilegiado
/etc/community/badging/images/privileged-member/jcr:content/privileged-member.png
Distintivos asignados awarded-badges
El servicio de puntuación concede distinciones basadas en premios a los miembros de la comunidad en función de las normas aplicadas a su actividad en la comunidad.
Para que los distintivos aparezcan como recompensa por la actividad, hay dos cosas que deben suceder:
En la versión se incluyen tres distintivos basados en premios:
-
Oro
/etc/community/badging/images/gold-badge/jcr:content/gold.png
-
Plata
/etc/community/badging/images/silver-badge/jcr:content/silver.png
-
Bronce
/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
Distintivos personalizados custom-badges
Los distintivos personalizados se pueden instalar utilizando la variable Consola Distintivos y se han asignado o especificado en reglas de distintivo.
Cuando se instalan desde la consola Distintivos, los distintivos personalizados se replican automáticamente en el entorno de publicación.
Habilitar puntuación enable-scoring
La puntuación no está activada de forma predeterminada. Los pasos básicos para configurar y habilitar la puntuación y la concesión de distintivos son:
-
Identificar las reglas para obtener puntos (reglas de puntuación)
-
Para los puntos acumulados por reglas de puntuación, asigne distintivos (reglas de distintivo)
-
Aplicar las reglas de puntuación y de distintivo a un sitio de la comunidad
Consulte la Prueba rápida para habilitar la puntuación para un sitio de la comunidad usando las reglas de puntuación y distintivo predeterminadas para los foros y comentarios.
Aplicar reglas al contenido apply-rules-to-content
Para habilitar la puntuación y los distintivos, agregue las propiedades scoringRules
y badgingRules
a cualquier nodo del árbol de contenido del sitio.
Si el sitio ya está publicado, después de aplicar todas las reglas y habilitar los componentes, vuelva a publicar el sitio.
Las reglas que se aplican a un componente habilitado para distintivos son las del nodo actual o su antecesor.
Si el nodo es del tipo cq:Page
(recomendado), usando CRXDE|Lite, agregue las propiedades a su jcr:content
nodo .
Habilitar distintivos para componentes enable-badges-for-component
Las reglas de puntuación y de intercalación solo están en vigor para las instancias de componentes que han habilitado el distintivo mediante la edición de la configuración de componentes en modo de creación.
Una propiedad booleana, allowBadges
, activa o desactiva la visualización de distintivos para una instancia de componente. Se puede configurar en la variable cuadro de diálogo de edición de componentes para componentes de foro, control de calidad y comentarios mediante una casilla de verificación etiquetada Mostrar distintivos.
Ejemplo: allowBadges para la instancia de componente Foro example-allowbadges-for-forum-component-instance
Reglas de puntuación scoring-rules
Las reglas de puntuación son la base de la puntuación para la concesión de distintivos.
Muy simplemente, cada regla de puntuación es una lista de una o más subreglas. Las reglas de puntuación se aplican al contenido del sitio de la comunidad para identificar las reglas que se aplicarán cuando se habiliten los distintivos.
Las reglas de puntuación se heredan pero no son aditivas. Por ejemplo:
-
Si la página 2 contiene la regla de puntuación 2 y su página anterior 1 contiene la regla de puntuación 1
-
Una acción en un componente de página2 invocará tanto la regla1 como la regla2
-
Si ambas reglas contienen subreglas aplicables para el mismo
topic/verb
:- Solo la subregla de la regla 2 afectará a la puntuación
- Las puntuaciones de ambas subreglas no se suman
Cuando hay más de una regla de puntuación, las puntuaciones se mantienen por separado para cada regla.
Las reglas de puntuación son nodos del tipo cq:Page
con propiedades en su jcr:content
que especifican la lista de subreglas que la definen.
Las puntuaciones se almacenan en SRP.
/etc/community/scoring/rules/site1/forums-scoring
/etc/community/scoring/rules/site2/forums-scoring
Subreglas de puntuación scoring-sub-rules
Las subreglas de puntuación contienen las propiedades que detallan los valores para participar en la comunidad.
Cada subregla de puntuación identifica
- Qué actividades se están rastreando
- Qué función de comunidad específica está involucrada
- ¿Cuántos puntos se conceden?
De forma predeterminada, se otorgan puntos al miembro que realiza la acción, a menos que la subregla especifique el propietario del contenido que recibe los puntos ( forOwner
).
Cada subregla se puede incluir en una o más reglas de puntuación.
El nombre de la subregla suele seguir el patrón de uso de una asunto, objeto y verbo. Por ejemplo:
- member-comment-create
- miembro-recibo-voto
Las subreglas son nodos del tipo cq:Page
con propiedades en su jcr:content
nodo que especifica el verbos y temas .
Reglas de puntuación y subreglas incluidas included-scoring-rules-and-sub-rules
En la versión se incluyen dos reglas de puntuación para la variable Función del foro (una para los componentes Foro y Comentarios de la función Foro):
-
/etc/community/scoring/rules/comments-scoring
-
subRules[] =
/etc/community/scoring/rules/sub-rules/member-comment-create
/etc/community/scoring/rules/sub-rules/member-receive-vote
/etc/community/scoring/rules/sub-rules/member-to-vote
/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-vote
/etc/community/scoring/rules/sub-rules/member-to-vote
/etc/community/scoring/rules/sub-rules/member-is-moderated
-
Notas:
-
Ambas
rules
ysub-rules
los nodos son de tipo cq:Page -
subRules
es un atributo de tipo String[] en la reglajcr:content
node -
sub-rules
puede compartirse entre varias reglas de puntuación -
rules
debe estar ubicado en una ubicación de repositorio con permiso de lectura para todos- Los nombres de las reglas deben ser únicos independientemente de la ubicación
Activación de reglas de puntuación personalizadas activating-custom-scoring-rules
Los cambios o adiciones realizados en las reglas de puntuación o en las subreglas realizadas en el entorno de creación deben instalarse en la publicación.
Reglas de distintivo badging-rules
Las reglas de distintivo vinculan las reglas de puntuación a los distintivos especificando:
- Qué regla de puntuación
- La puntuación necesaria para obtener un distintivo específico
Las reglas de distintivo son nodos del tipo cq:Page
con propiedades en su jcr:content
que correlacionan las reglas de puntuación con puntuaciones e insignias.
Las reglas para el distintivo consisten en un thresholds
que es una lista ordenada de puntuaciones asignadas a distintivos. Las puntuaciones deben ordenarse en valor creciente. Por ejemplo:
-
1|/etc/community/badging/images/bronze-badge/jcr:content/bronze.png
- Se otorga una insignia de bronce por ganar 1 punto
-
60|/etc/community/badging/images/silver-badge/jcr:content/silver.png
- Se otorga una insignia de plata cuando se acumulan 60 puntos
-
80|/etc/community/badging/images/gold-badge/jcr:content/gold.png
- Se otorga una insignia de oro cuando se acumulan 80 puntos
Las reglas de distintivo están acompañadas de reglas de puntuación que determinan cómo se acumulan los puntos. Consulte la sección titulada Aplicar reglas al contenido.
La variable scoringRules
en una regla de distintivo simplemente restringe qué reglas de puntuación se pueden emparejar con esa regla de distintivo en particular.
Reglas de distintivo incluidas included-badging-rules
En la versión se incluyen dos reglas de distintivo que corresponden a la variable Reglas de puntuación de foros y comentarios.
- /etc/community/badging/rules/comments-badging
- /etc/community/badging/rules/forums-badging
Notas:
-
rules
los nodos son de tipo cq:Page -
rules
debe estar ubicado en una ubicación de repositorio con permiso de lectura para todos- Los nombres de las reglas deben ser únicos independientemente de la ubicación
Activación de reglas de distintivo personalizadas activating-custom-badging-rules
Los cambios o adiciones realizados en las reglas de distintivo o en las imágenes realizadas en el entorno de creación deben instalarse en la publicación.
Asignar y revocar distintivos assign-and-revoke-badges
Los distintivos se pueden asignar a los miembros mediante la variable consola miembros o mediante programación, usando comandos cURL.
Los siguientes comandos cURL muestran lo que es necesario para una solicitud HTTP para asignar y revocar distintivos. El formato básico es:
cURL -i -X POST -H header -u *firma * -F *operación * -F *distintivo * member-profile-url
header = "Accept:application/json"
encabezado personalizado para pasar al servidor (obligatorio)
inicio de sesión = id de administrador:contraseña
por ejemplo: admin:admin
operation = ":operation=social:assignBadge" O ":operation=social:deleteBadge"
distintivo = "badgeContentPath=badge-image-file"
badge-image-file = la ubicación del archivo de imagen del distintivo en el repositorio
por ejemplo: /etc/community/badging/images/moderator/jcr:content/moderator.png
member-profile-url = el punto final del perfil del miembro en la publicación
por ejemplo: https://<server>:<port>/home/users/community/riley/profile.social.json
- Puede hacer referencia a una instancia de autor si la variable Servicio de túnel está habilitado
- Puede ser un nombre oscuro y aleatorio; consulte Lista de comprobación de seguridad acerca del ID autorizado
Por ejemplo: examples
Asignar un distintivo de moderador 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
Revocar un distintivo de plata asignado 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
Puntuación y distintivos para componentes personalizados scoring-and-badges-for-custom-components
Se pueden crear reglas de puntuación y de distintivo para componentes personalizados al asociar los temas de evento creados para el componente con verbos.
Temas y verbos topics-and-verbs
Cuando los miembros interactúan con las funciones de las comunidades, se envían eventos que pueden almacenar en déclencheur a los oyentes asincrónicos, como notificaciones y puntuación.
La instancia SocialEvent de un componente registra los eventos como actions
que se producen para un topic
. SocialEvent incluye un método para devolver un verb
asociado a la acción . Hay un n-1 relación entre actions
y verbs
.
Para los componentes de comunidades entregados, los siguientes cuadros describen la variable verbs
definido para cada topic
disponible para su uso en subreglas de puntuación.
allowBadges
, activa o desactiva la visualización de distintivos para una instancia de componente. Se puede configurar en actualizado cuadros de diálogo de edición de componentes mediante una casilla de verificación etiquetada Mostrar distintivos.Componente de calendario
SocialEvent topic
= com/adobe/cq/social/calendar
Componente Comentarios
SocialEvent topic
= com/adobe/cq/social/comment
Componente Biblioteca de archivos
SocialEvent topic
= com/adobe/cq/social/fileLibrary
Componente Foro
SocialEvent topic
= com/adobe/cq/social/forum
Componente Asiento
SocialEvent topic
= com/adobe/cq/social/journal
Componente QnA
SocialEvent topic
= com/adobe/cq/social/qna
Componente de revisiones
SocialEvent topic
= com/adobe/cq/social/review
Componente de clasificación
SocialEvent topic
= com/adobe/cq/social/tally/rating
Componente de votación
SocialEvent topic
= com/adobe/cq/social/tally/vote
Componentes habilitados para moderación
SocialEvent topic
= com/adobe/cq/social/moderation
Eventos de componente personalizados custom-component-events
Para un componente personalizado, se crea una instancia de SocialEvent para registrar los eventos del componente como actions
que se producen para un topic
.
Para admitir la puntuación, SocialEvent tendría que anular el método getVerb()
para que verb
se devuelve para cada action
. La variable verb
devuelta para una acción puede ser de uso común (por ejemplo, POST
) o uno especializado para el componente (por ejemplo, ADD RATING
). Hay un n-1 relación entre actions
y verbs
.
Solución de problemas troubleshooting
Los distintivos no aparecen badges-are-not-appearing
Si se han aplicado reglas de puntuación y de distintivo al contenido del sitio web, pero no se han concedido distintivos para ninguna actividad, asegúrese de que se hayan habilitado distintivos para la instancia de ese componente.
Consulte Habilitar distintivos para componentes.
La regla de puntuación no tiene efecto scoring-rule-has-no-effect
Si se han aplicado reglas de puntuación y de distintivo al contenido del sitio web y se están concediendo distintivos para algunas acciones, pero no para otras, compruebe que la regla de distintivo no haya restringido las reglas de puntuación a las que se aplica.
Consulte la scoringRules
propiedad de Reglas de distintivo.
Tipo sensible a mayúsculas y minúsculas case-sensitive-typo
La mayoría de las propiedades y los valores, especialmente los verbos, distinguen entre mayúsculas y minúsculas. Los verbos deben ser MAYÚSCULAS cuando se utilizan en una subregla de puntuación.
Si la función no funciona como se espera, asegúrese de que los datos se han introducido correctamente.
Prueba rápida quick-test
Es posible probar rápidamente la puntuación y el distintivo utilizando la variable Tutorial de introducción (participación) sitio:
-
CRXDE Lite de acceso en autor
-
Vaya a la página base:
- /content/sites/engagement/en/jcr:content
-
Agregue la propiedad badgingRules :
- Nombre:
badgingRules
- Tipo:
String
- Select Multi
- Select Agregar
- Entrar
/etc/community/badging/rules/forums-badging
- Seleccionar
+
- Entrar
/etc/community/badging/rules/comments-badging
- Select OK
- Nombre:
-
Agregue la propiedad scoringRules :
- Nombre:
scoringRules
- Tipo:
String
- Select Multi
- Select Agregar
- Entrar
/etc/community/scoring/rules/forums-scoring
- Seleccionar
+
- Entrar
/etc/community/scoring/rules/comments-scoring
- Select OK
- Nombre:
-
Select Guardar todo
A continuación, asegúrese de que los componentes de foro y comentarios permitan que se muestren distintivos:
-
De nuevo con el CRXDE Lite
-
Vaya al componente del foro
/content/sites/engage/en/forum/jcr:content/content/primary/forum
-
Agregue la propiedad booleana allowBadges, si es necesario, y asegúrese de que sea verdadera
- Nombre:
allowBadges
- Tipo:
Boolean
- Valor:
true
- Nombre:
Siguiente, volver a publicar el sitio de la comunidad.
Finalmente,
-
Vaya al componente en la instancia de publicación
-
Inicie sesión como miembro de la comunidad (por ejemplo: weston.mccall@dodgit.com / password)
-
Publicar un nuevo tema de foro
-
La página debe actualizarse para que se muestre el distintivo
- Cierre sesión e inicie sesión como otro miembro de la comunidad (por ejemplo: aaron.mcdonald@mailinator.com / password)
-
Seleccione el foro
Esto debería ganar al miembro de la comunidad una insignia de bronce visible con su publicación en el foro debido a que el primer umbral de la regla de la insignia de foro es una puntuación de 1.
Información adicional additional-information
Puede encontrar más información en la Aspectos básicos de la puntuación y los distintivos para desarrolladores.
Para obtener información sobre el motor de puntuación avanzado, consulte Puntuación avanzada y distintivos.
Placa de inicio configurable componente y function simplifica la visualización de miembros y sus puntuaciones en un sitio de comunidad.