Configuração de notificação por email

Última atualização em 2023-05-04
  • Criado para:
  • Admin
ATENÇÃO

AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

O AEM envia notificações por email para usuários que:

  • Inscreveram-se em eventos de página, por exemplo, modificação ou replicação. O Caixa de entrada de notificações descreve como assinar esses eventos.

  • Inscreveram-se nos eventos do fórum.

  • É necessário executar uma etapa em um fluxo de trabalho. O Etapa do participante descreve como acionar a notificação por email em um workflow.

Pré-requisitos:

  • Os usuários precisam ter um endereço de email válido definido em seu perfil.
  • O Day CQ Mail Service precisa ser configurado corretamente.

Quando um usuário é notificado, ele recebe um email no idioma definido em seu perfil. Cada idioma tem seu próprio modelo que pode ser personalizado. Novos modelos de email podem ser adicionados para novos idiomas.

OBSERVAÇÃO

Ao trabalhar com AEM, existem vários métodos de gestão das definições de configuração para esses serviços; see Configuração do OSGi para obter mais detalhes e as práticas recomendadas.

Configuração do serviço de email

Para que o AEM possa enviar emails, a variável Day CQ Mail Service precisa ser configurado corretamente. Você pode exibir a configuração no console da Web. Ao trabalhar com AEM, existem vários métodos de gestão das definições de configuração para esses serviços; see Configuração do OSGi para obter mais detalhes e as práticas recomendadas.

As seguintes restrições se aplicam:

  • O Porta do servidor SMTP deve ser 25 ou superior.

  • O Nome do host do servidor SMTP não deve ficar em branco.

  • O Endereço "De" não deve ficar em branco.

Para ajudar você a depurar um problema com o Day CQ Mail Service, você pode assistir aos registros do serviço:

com.day.cq.mailer.DefaultMailService

A configuração é a seguinte no console da Web:

chlimage_1-276

Configuração do canal de notificação por email

Ao assinar notificações de eventos de página ou de fórum, o endereço de email de formulário é definido como no-reply@acme.com por padrão. Você pode alterar esse valor configurando a variável Canal de email de notificação no Console da Web.

Para configurar o endereço de e-mail do , adicione um sling:OsgiConfig para o repositório. Use o procedimento a seguir para adicionar o nó diretamente usando o CRXDE Lite:

  1. No CRXDE Lite, adicione uma pasta chamada config abaixo da pasta do aplicativo.

  2. Na pasta de configuração, adicione um nó chamado:

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

  3. Adicione um String propriedade do nó nomeado email.from. Para o valor , especifique o endereço de email que deseja usar.

  4. Clique em Salvar tudo.

Use o procedimento a seguir para definir o nó nas pastas de origem do pacote de conteúdo:

  1. Em seu jcr_root/apps/*app_name*/config folder, crie um arquivo chamado com.day.cq.wcm.notification.email.impl.EmailChannel.xml

  2. Adicione o seguinte XML para representar o nó:

    <?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. Substitua o valor da variável email.from atributo ( name@server.com) com seu endereço de email.

  4. Salve o arquivo.

Configuração do serviço de notificação por email do fluxo de trabalho

Quando você recebe notificações por email do workflow, o endereço de email de e o prefixo do URL de host são definidos como valores padrão. Você pode alterar esses valores configurando a variável Serviço de Notificação por Email do Workflow CQ Dia no Console da Web. Se isso for feito, é recomendável manter a alteração no repositório.

A configuração padrão é a seguinte no Console da Web:

chlimage_1-277

Modelos de email para notificação de página

Os modelos de email para notificações de página estão localizados abaixo:

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

O modelo padrão em inglês ( en.txt) é definido da seguinte forma:

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.

Personalização de modelos de email para notificação de página

Para personalizar o modelo de email em inglês para notificação de página:

  1. No CRXDE, abra o arquivo :

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

  2. Modifique o arquivo de acordo com suas necessidades.

  3. Salve as alterações.

O modelo precisa ter o seguinte formato:

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

Onde <text_x> pode ser uma combinação de texto estático e variáveis de sequência dinâmica. As variáveis a seguir podem ser usadas no modelo de email para notificações de página:

  • ${time}, a data e a hora do evento.

  • ${userFullName}, o nome completo do usuário que acionou o evento.

  • ${userId}, a ID do usuário que acionou o evento.

  • ${modifications}, descreve o tipo do evento de página e o caminho da página no formato :

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

    Por exemplo:

    PageModified => /content/geometrixx/en/products

Modelos de email para notificação do fórum

Os modelos de email para notificações de fórum estão localizados em:

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

O modelo padrão em inglês ( en.txt) é definido da seguinte forma:

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.

Personalização de modelos de email para notificação do fórum

Para personalizar o modelo de email em inglês para notificação do fórum:

  1. No CRXDE, abra o arquivo :

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

  2. Modifique o arquivo de acordo com suas necessidades.

  3. Salve as alterações.

O modelo precisa ter o seguinte formato:

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

Onde <text_x> pode ser uma combinação de texto estático e variáveis de sequência dinâmica.

As variáveis a seguir podem ser usadas no modelo de email para notificações do fórum:

  • ${time}, a data e a hora do evento.

  • ${forum.path}, o caminho para a página do fórum.

Modelos de email para notificação de fluxo de trabalho

O modelo de email para notificações de workflow (inglês) está localizado em:

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

É definido da seguinte forma:

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.

Personalização de modelos de email para notificação de fluxo de trabalho

Para personalizar o modelo de email em inglês para notificação de evento de workflow:

  1. No CRXDE, abra o arquivo :

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

  2. Modifique o arquivo de acordo com suas necessidades.

  3. Salve as alterações.

O modelo precisa ter o seguinte formato:

subject=<text_1>
 header=<text_2>
 message=<text_3>
 footer=<text_4>
OBSERVAÇÃO

Onde <text_x> pode ser uma combinação de texto estático e variáveis de sequência dinâmica. Cada linha de um <text_x> item precisa ser encerrado com uma barra invertida ( \), exceto para a última instância, quando a ausência da barra invertida indicar o fim do <text_x> variável da string.

Mais informações sobre o formato do modelo podem ser encontradas na seção javadocs de Properties.load() método .

O método ${payload.path.open} revela o caminho para a carga do item de trabalho. Por exemplo, para uma página em Sites , em seguida payload.path.open seria semelhante a /bin/wcmcommand?cmd=open&path=….; isso é sem o nome do servidor, por isso o modelo prepara com ${host.prefix}.

As variáveis a seguir podem ser usadas no modelo de email:

  • ${event.EventType}, tipo de evento

  • ${event.TimeStamp}, data e hora do evento

  • ${event.User}, o usuário que acionou o evento

  • ${initiator.home}, o caminho do nó iniciador

  • ${initiator.name}, o nome do iniciador

  • ${initiator.email}, endereço de email do iniciador

  • ${item.id}, a id do item de trabalho

  • ${item.node.id}, id do nó no modelo de fluxo de trabalho associado a este item de trabalho

  • ${item.node.title}, título do item de trabalho

  • ${participant.email}, endereço de e-mail do participante

  • ${participant.name}nome do participante

  • ${participant.familyName}, nome familiar do participante

  • ${participant.id}, id do participante

  • ${participant.language}, a língua do participante

  • ${instance.id}, a id do fluxo de trabalho

  • ${instance.state}, o estado do fluxo de trabalho

  • ${model.title}, título do modelo de fluxo de trabalho

  • ${model.id}, a id do modelo de fluxo de trabalho

  • ${model.version}, a versão do modelo de fluxo de trabalho

  • ${payload.data}, a carga

  • ${payload.type}, o tipo de carga

  • ${payload.path}, caminho da carga

  • ${host.prefix}, prefixo do host, por exemplo: http://localhost:4502

Adicionar um modelo de email para um novo idioma

Para adicionar um modelo para um novo idioma:

  1. No CRXDE, adicione um arquivo <language-code>.txt abaixo:

    • /libs/settings/notification-templates/com.day.cq.wcm.core.page : para notificações de página
    • /etc/notification/email/default/com.day.cq.collab.forum : para notificações do fórum
    • /libs/settings/workflow/notification/email/default : para notificações de fluxo de trabalho
  2. Adapte o arquivo ao idioma.

  3. Salve as alterações.

OBSERVAÇÃO

O <language-code> usado como o nome de arquivo do modelo de email precisa ser um código de idioma em letras minúsculas que seja reconhecido pela AEM. Para códigos de idioma, o AEM depende do ISO-639-1.

Configuração de notificações de email do AEM Assets

Quando as coleções no AEM Assets são compartilhadas ou não, os usuários podem receber notificações por email do AEM. Para configurar notificações por email, siga estas etapas.

  1. Configure o serviço de email, conforme descrito acima em Configuração do serviço de email.
  2. Faça logon no AEM como administrador. Clique em Ferramentas > Operações > Console da Web para abrir a Configuração do Console da Web.
  3. Editar Servlet de coleta de recursos Day CQ DAM. Selecionar enviar email. Clique em Salvar.

Nesta página