Configuración de notificaciones por correo electrónico

Última actualización: 5 de mayo de 2023

Creado para:

  • Admin
CAUTION
AEM 6.4 ha llegado al final de la compatibilidad ampliada y esta documentación ya no se actualiza. Para obtener más información, consulte nuestra períodos de asistencia técnica. Buscar las versiones compatibles here.

AEM envía notificaciones por correo electrónico a los usuarios que:

  • Se han suscrito a eventos de página, por ejemplo modificación o replicación. La variable Bandeja de entrada de notificaciones describe cómo suscribirse a estos eventos.

  • Se han suscrito a eventos de foro.

  • Debe realizar un paso en un flujo de trabajo. La variable Etapa de participante describe cómo almacenar en déclencheur las notificaciones por correo electrónico en un flujo de trabajo.

Requisitos previos:

  • Los usuarios deben tener una dirección de correo electrónico válida definida en su perfil.
  • La variable Day CQ Mail Service debe configurarse correctamente.

Cuando se notifica a un usuario, recibe un correo electrónico en el idioma definido en su perfil. Cada idioma tiene su propia plantilla que se puede personalizar. Se pueden añadir nuevas plantillas de correo electrónico para los nuevos idiomas.

NOTE
Al trabajar con AEM hay varios métodos para administrar los ajustes de configuración de dichos servicios; see Configuración de OSGi para obtener más información y las prácticas recomendadas.

Configuración del servicio de correo

Para AEM poder enviar correos electrónicos, la variable Day CQ Mail Service debe configurarse correctamente. Puede ver la configuración en la consola web. Al trabajar con AEM hay varios métodos para administrar los ajustes de configuración de dichos servicios; see Configuración de OSGi para obtener más información y las prácticas recomendadas.

Se aplican las siguientes restricciones:

  • La variable Puerto del servidor SMTP debe ser 25 o superior.

  • La variable Nombre de host del servidor SMTP no debe estar en blanco.

  • La variable Dirección "De" no debe estar en blanco.

Para ayudarle a depurar un problema con la variable Day CQ Mail Service, puede ver los registros del servicio:

com.day.cq.mailer.DefaultMailService

La configuración tiene el siguiente aspecto en la consola web:

chlimage_1-276

Configuración del canal de notificación de correo electrónico

Al suscribirse a las notificaciones de eventos de página o de foro, la dirección de correo electrónico de se establece en no-reply@acme.com de forma predeterminada. Puede cambiar este valor configurando la variable Canal de correo electrónico de notificación en la consola web.

Para configurar la dirección de correo electrónico, agregue una sling:OsgiConfig al repositorio. Utilice el siguiente procedimiento para añadir el nodo directamente mediante el CRXDE Lite :

  1. En el CRXDE Lite, añada una carpeta denominada config debajo de la carpeta de la aplicación.

  2. En la carpeta de configuración, añada un nodo denominado:

    com.day.cq.wcm.notification.email.impl.EmailChannel de tipo sling:OsgiConfig

  3. Agregue un String propiedad al nodo denominado email.from. Para el valor, especifique la dirección de correo electrónico que desea utilizar.

  4. Haga clic en Guardar todo.

Utilice el siguiente procedimiento para definir el nodo en las carpetas de origen del paquete de contenido:

  1. En jcr_root/apps/*app_name*/config folder, cree un archivo con el nombre com.day.cq.wcm.notification.email.impl.EmailChannel.xml

  2. Añada el siguiente XML para representar el nodo :

    <?xml version="1.0" encoding="UTF-8"?> <jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" jcr:primaryType="sling:OsgiConfig" email.from="name@server.com"/>

  3. Reemplace el valor de la variable email.from atributo ( name@server.com) con su dirección de correo electrónico.

  4. Guarde el archivo.

Configuración del servicio de notificación de correo electrónico del flujo de trabajo

Cuando recibe notificaciones por correo electrónico del flujo de trabajo, tanto la dirección de correo electrónico como el prefijo de URL del host se establecen en valores predeterminados. Puede cambiar estos valores configurando la variable Servicio de notificación de correo electrónico del flujo de trabajo CQ de día en la consola web. Si lo hace, se recomienda mantener el cambio en el repositorio.

La configuración predeterminada tiene el siguiente aspecto en la consola web:

chlimage_1-277

Plantillas de correo electrónico para notificaciones de página

A continuación se describen las plantillas de correo electrónico para las notificaciones de página:

/libs/settings/notification-templates/com.day.cq.wcm.core.page

La plantilla predeterminada en inglés ( en.txt) se define de la siguiente manera:

subject=[CQ Page Event Notification]: Page Event

header=-------------------------------------------------------------------------------------\n \
Time: ${time}\n \
User: ${userFullName} (${userId})\n \
-------------------------------------------------------------------------------------\n\n

message=The following pages were affected by the event: \n \
 \n \
${modifications} \n \
 \n\n
footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Personalización de plantillas de correo electrónico para notificaciones de página

Para personalizar la plantilla de correo electrónico en inglés para la notificación de página:

  1. En CRXDE, abra el archivo :

    /libs/settings/notification-templates/com.day.cq.wcm.core.page/en.txt

  2. Modifique el archivo según sus necesidades.

  3. Guarde los cambios.

La plantilla debe tener el siguiente formato:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Donde <text_x> puede ser una mezcla de texto estático y variables de cadena dinámicas. En la plantilla de correo electrónico para las notificaciones de página se pueden usar las siguientes variables:

  • ${time}, la fecha y hora del evento.

  • ${userFullName}, el nombre completo del usuario que activó el evento.

  • ${userId}, el ID del usuario que activó el evento.

  • ${modifications}, describe el tipo de evento de página y la ruta de página en formato :

    <page event="" type=""> => <page path="">

    Por ejemplo:

    PageModified => /content/geometrixx/en/products

Plantillas de correo electrónico para la notificación del foro

Las plantillas de correo electrónico para las notificaciones del foro se encuentran en:

/etc/notification/email/default/com.day.cq.collab.forum

La plantilla predeterminada en inglés ( en.txt) se define de la siguiente manera:

subject=[CQ Forum Notification]

header=-------------------------------------------------------------------------------------\n \
Time: Time: ${time}\n \
Forum Page Path: ${forum.path}\n \
-------------------------------------------------------------------------------------\n\n

message=Page: ${host.prefix}${forum.path}.html\n

footer=\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Personalización de plantillas de correo electrónico para notificaciones de foro

Para personalizar la plantilla de correo electrónico en inglés para la notificación del foro:

  1. En CRXDE, abra el archivo :

    /etc/notification/email/default/com.day.cq.collab.forum/en.txt

  2. Modifique el archivo según sus necesidades.

  3. Guarde los cambios.

La plantilla debe tener el siguiente formato:

 subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>

Donde <text_x> puede ser una mezcla de texto estático y variables de cadena dinámicas.

En la plantilla de correo electrónico para las notificaciones del foro se pueden utilizar las siguientes variables:

  • ${time}, la fecha y hora del evento.

  • ${forum.path}, la ruta a la página del foro.

Plantillas de correo electrónico para notificación de flujo de trabajo

La plantilla de correo electrónico para las notificaciones de flujo de trabajo (en inglés) se encuentra en:

/libs/settings/workflow/notification/email/default/en.txt

Se define de la siguiente manera:

subject=Workflow notification: ${event.EventType}

header=-------------------------------------------------------------------------------------\n \
Time: ${event.TimeStamp}\n \
Step: ${item.node.title}\n \
User: ${participant.name} (${participant.id})\n \
Workflow: ${model.title}\n \
-------------------------------------------------------------------------------------\n\n

message=Content: ${host.prefix}${payload.path.open}\n

footer=\n \
-------------------------------------------------------------------------------------\n \
View the overview in your ${host.prefix}/aem/inbox\n \
-------------------------------------------------------------------------------------\n \
This is an automatically generated message. Please do not reply.

Personalización de plantillas de correo electrónico para notificación de flujo de trabajo

Para personalizar la plantilla de correo electrónico en inglés para la notificación de eventos de flujo de trabajo:

  1. En CRXDE, abra el archivo :

    /libs/settings/workflow/notification/email/default/en.txt

  2. Modifique el archivo según sus necesidades.

  3. Guarde los cambios.

La plantilla debe tener el siguiente formato:

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>
NOTE
Donde <text_x> puede ser una mezcla de texto estático y variables de cadena dinámicas. Cada línea de un <text_x> El elemento debe terminar con una barra invertida ( \), excepto en la última instancia, cuando la ausencia de la barra invertida indica el final del <text_x> variable de cadena.
Puede encontrar más información sobre el formato de la plantilla en la javadocs de Properties.load() método.

El método ${payload.path.open} muestra la ruta de acceso a la carga útil del elemento de trabajo. Por ejemplo, para una página en Sitios, entonces payload.path.open sería similar a /bin/wcmcommand?cmd=open&path=….; esto se hace sin el nombre del servidor, por lo que la plantilla antepone esto a ${host.prefix}.

En la plantilla de correo electrónico se pueden utilizar las siguientes variables:

  • ${event.EventType}, tipo de evento

  • ${event.TimeStamp}, fecha y hora del evento

  • ${event.User}, el usuario que activó el evento

  • ${initiator.home}, la ruta del nodo iniciador

  • ${initiator.name}, el nombre del iniciador

  • ${initiator.email}, dirección de correo electrónico del iniciador

  • ${item.id}, el id del elemento de trabajo

  • ${item.node.id}, id del nodo en el modelo de flujo de trabajo asociado a este elemento de trabajo

  • ${item.node.title}, título del elemento de trabajo

  • ${participant.email}, dirección de correo electrónico del participante

  • ${participant.name}, nombre del participante

  • ${participant.familyName}, apellido del participante

  • ${participant.id}, id del participante

  • ${participant.language}, el idioma del participante

  • ${instance.id}, el id del flujo de trabajo

  • ${instance.state}, el estado del flujo de trabajo

  • ${model.title}, título del modelo de flujo de trabajo

  • ${model.id}, el id del modelo de flujo de trabajo

  • ${model.version}, la versión del modelo de flujo de trabajo

  • ${payload.data}, la carga útil

  • ${payload.type}, el tipo de carga útil

  • ${payload.path}, ruta de la carga útil

  • ${host.prefix}, prefijo de host, por ejemplo: http://localhost:4502

Adición de una plantilla de correo electrónico para un nuevo idioma

Para añadir una plantilla para un nuevo idioma:

  1. En CRXDE, agregue un archivo <language-code>.txt abajo:

    • /libs/settings/notification-templates/com.day.cq.wcm.core.page : para notificaciones de página
    • /etc/notification/email/default/com.day.cq.collab.forum : para notificaciones de foro
    • /libs/settings/workflow/notification/email/default : para notificaciones de flujo de trabajo

  2. Adapte el archivo al idioma.

  3. Guarde los cambios.

NOTE
La variable <language-code> se utiliza como nombre de archivo para la plantilla de correo electrónico y debe ser un código de idioma en minúsculas de dos letras que AEM reconozca. Para códigos de idioma, AEM se basa en ISO-639-1.

Configuración de las notificaciones por correo electrónico de AEM Assets

Cuando se comparten o dejan de compartir colecciones en AEM Assets, los usuarios pueden recibir notificaciones por correo electrónico de AEM. Para configurar las notificaciones por correo electrónico, siga estos pasos.

  1. Configure el servicio de correo electrónico, tal como se describe anteriormente en Configuración del servicio de correo.
  2. Inicie sesión en AEM como administrador. Haga clic en Herramientas > Operaciones > Consola web para abrir Configuración de la consola web.
  3. Editar Servlet Day CQ DAM Resource Collection. Select enviar correo electrónico. Haga clic en Guardar.
Página anterior
Página siguiente

Experience Manager