Usar metadados em uma notificação por email

Última atualização em 2023-05-04
  • Criado para:
  • User
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.

Use metadados para preencher informações em uma notificação de email de fluxo de trabalho de formulários

Você pode usar a etapa Atribuir tarefa para criar e atribuir tarefas a um usuário ou grupo. Quando uma tarefa é atribuída a um usuário ou grupo, uma notificação por email é enviada ao usuário definido ou a cada membro do grupo definido. Um notificação por email contém o link da tarefa atribuída e as informações relacionadas à tarefa.

Você pode usar metadados em um modelo de email para preencher dinamicamente as informações em uma notificação por email. Por exemplo, o valor do título, da descrição, da data de vencimento, da prioridade, do fluxo de trabalho e da última data na seguinte notificação de email é selecionado dinamicamente no tempo de execução (quando uma notificação de email é gerada).

default-email-template

Os metadados são armazenados em pares de valores chave. Você pode especificar a chave no template de email e a chave é substituída por um valor no tempo de execução (quando uma notificação por email é gerada). Por exemplo, na amostra de código abaixo, "$ {workitem_title} " é uma chave. Ele é substituído pelo valor "Loan-Request" no tempo de execução.

subject=Task Assigned - ${workitem_title}

message=<html><body>\n\
 <table>\n\
  <tbody>\n\
   <tr>\n\
    <td>\n\
      Sample Company\n\
    </td>\n\
   </tr>\n\
   <tr>\n\
    <td>\n\
     <pre style="font-size: 13px; font-family: Helvetica, Arial, sans-serif;  font-weight: normal; color: #323232;"> Hello ${workitem_assignee},\n\
 The following task has been assigned to you:</pre>\n\
    </td>\n\
   </tr>\n\
   <tr>\n\
    <td>\n\
     <table>\n\
      <tbody>\n\
       <tr style="border-bottom: solid 2px #FFFCF9;">\n\
        <td> TITLE</td>\n\
        <td>\n\
         <p>${workitem_title}</p>\n\
        </td>\n\
       </tr>\n\
                            <tr style="border-bottom: solid 2px #FFFCF9;">\n\
        <td> DESCRIPTION</td>\n\
        <td>\n\
         <p>${workitem_description}</p>\n\
        </td>\n\
       </tr>\n\
       <tr style="border-bottom: solid 2px #FFFCF9;">\n\
        <td> DUE DATE</td>\n\
        <td>\n\
         <p>${workitem_due_date}</p>\n\
        </td>\n\
       </tr>\n\
       <tr style="border-bottom: solid 2px #FFFCF9;">\n\
        <td> PRIORITY</td>\n\
        <td>\n\
         <p>${workitem_priority}</p>\n\
        </td>\n\
       </tr>\n\
       <tr>\n\
        <td> WORKFLOW</td>\n\
        <td>\n\
         <p>${workitem_workflow}</p>\n\
        </td>\n\
       </tr>\n\
      </tbody>\n\
     </table>\n\
    </td>\n\
   </tr>\n\
   <tr style = "text-align: center; vertical-align: middle;">\n\
    <td> \n\
     <a href="${workitem_url}" target="_blank" style="background-color: #1EBBBB; font-size: 18px; line-height: 25px; font-weight: bold; color: #FFFFFF; text-decoration: none; padding: 15px 15px 15px 15px;">Open Task</a>\n\
    </td>\n\
   </tr>\n\
   <tr>\n\
    <td>\n\
     <p><span style="font-size: 12px; font-weight: normal; font-style: italic; color: #919191;">This is an automatically generated email. Please do not reply to this email.</span></p>\n\
    </td>\n\
   </tr>\n\
  </tbody>\n\
 </table>\n\
</body>\n\
</html>\n\

Uso de metadados gerados pelo sistema em uma notificação por email

Um aplicativo AEM Forms fornece várias variáveis de metadados (pares de valores chave) prontos para uso. Você pode usar essas variáveis em um modelo de email. O valor da variável é baseado no aplicativo de formulários associado. A tabela a seguir lista todas as variáveis de metadados disponíveis para uso imediato:

Chave Descrição
workitem_title Título do aplicativo de formulários associado.
url_do_item_de_trabalho URL para acessar o aplicativo de formulários associado.
descrição_do_item_de_trabalho Descrição do aplicativo de formulários associado.
workitem_priority Prioridade especificada para o aplicativo de formulários associado.
data_de_vencimento_do_item_de_trabalho Última data para agir no aplicativo de formulários associado.
workflow_do_item Nome do fluxo de trabalho associado ao aplicativo forms.
workitem_assign_timestamp Data e hora em que o item de fluxo de trabalho foi atribuído ao destinatário atual.
workitem_assignee Nome do destinatário presente.
host_prefix URL do servidor do autor. Por exemplo, https://10.41.42.66:4502
publish_prefix URL do servidor de publicação. Por exemplo, https://10.41.42.66:4503

Uso de metadados personalizados em uma notificação por email

Você também pode usar metadados personalizados em uma notificação por email. Os metadados personalizados contêm informações além dos metadados gerados pelo sistema. Por exemplo, detalhes de política recuperados de um banco de dados. Você pode usar um pacote ECMAScript ou OSGi para adicionar metadados personalizados no repositório crx:

Usar o ECMAScript para adicionar metadados personalizados

ECMAScript é uma linguagem de script. Ele é usado para aplicativos de servidor e scripts do lado do cliente. Execute as seguintes etapas para usar o ECMAScript para adicionar metadados personalizados a um modelo de email:

  1. Faça logon no CRX DE com uma conta administrativa. O URL é https://[server]:[port]/crx/de/index.jsp

  2. Navegue até /apps/fd/dashboard/scripts/metadataScripts. Crie um arquivo com a extensão .ecma. Por exemplo, usermetadata.ecma

    Se o caminho mencionado acima não existir, crie-o.

  3. Adicione o código ao arquivo .ecma que tem a lógica de gerar metadados personalizados em pares de valores chave. Por exemplo, o código ECMAScript a seguir gera metadados personalizados para uma apólice de seguro:

    function getUserMetaData()  {
    //Commented lines below provide an overview on how to set user metadata in map and return it.
    var HashMap = Packages.java.util.HashMap;
    var valuesMap = new HashMap();
    valuesMap.put("policyNumber", "2017568972695");
    valuesMap.put("policyHolder", "Adobe Systems");

    return valuesMap;
}

  4. Clique em Salvar tudo. Agora, o script está disponível para seleção em AEM modelo de fluxo de trabalho.

    atributask-metadata

  5. (Opcional) Especifique o título do script:

    Se você não especificar o título, o campo Metadados personalizados exibirá o caminho completo do arquivo ECMAScript. Execute as seguintes etapas para especificar um título significativo para o script:

    1. Expanda o nó do script, clique com o botão direito do mouse no nó jcr:content e clique em Misturas.

    2. Digite mix:título na caixa de diálogo Editar misturas e clique em +.

    3. Adicione uma propriedade com os seguintes valores.

      Nome jcr:title
      Tipo String
      Valor Especifique o título do script. Por exemplo, metadados personalizados para o detentor da política. O valor especificado é exibido na etapa Atribuir tarefa .

Usar um pacote OSGi e uma interface Java para adicionar metadados personalizados

Você pode usar a interface Java WorkitemUserMetadataService para adicionar metadados personalizados a modelos de email. Você pode criar um pacote OSGi que use a interface Java WorkitemUserMetadataService e implantá-lo no servidor AEM Forms. Disponibiliza os metadados para seleção na etapa Atribuir tarefa .

Para criar um pacote OSGi com a interface Java, adicione SDK do cliente da AEM Forms jar e jarro de granito arquivos como dependências externas para o projeto do pacote OSGi. Você pode usar qualquer Java IDE para criar um pacote OSGi. O procedimento a seguir fornece etapas para usar o Eclipse para criar um pacote OSGi:

  1. Abra o Eclipse IDE. Navegue até Arquivo > Novo projeto.

  2. Na tela Selecionar um assistente, selecione Projeto Maven e clique em Avançar.

  3. No projeto Novo Maven, mantenha os padrões e clique em Avançar. Selecione um arquétipo e clique em Avançar. Por exemplo, maven-archetype-quickstart. Especifique a ID do grupo, a ID do artefato, a versão e o pacote para o projeto e clique em Concluir. O projeto é criado.

  4. Abra o arquivo pom.xml para edição e substitua todo o conteúdo do arquivo pelo seguinte:

  5. Adicione o código-fonte que usa a interface Java WorkitemUserMetadataService para adicionar metadados personalizados para modelos de email. Um código de exemplo é listado abaixo:

    package com.aem.impl;

import com.adobe.fd.workspace.service.external.WorkitemUserMetadataService;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;

import java.util.HashMap;
import java.util.Map;

@Component
@Service
@Properties({
        @Property(name = Constants.SERVICE_DESCRIPTION, value = "A sample implementation of a user metadata service."),
        @Property(name = WorkitemUserMetadataService.SERVICE_PROPERTY_LABEL, value = "Default User Metadata Service")})

public class WorkitemUserMetadataServiceImpl
  implements WorkitemUserMetadataService
{
  public WorkitemUserMetadataServiceImpl() {}

  public Map<String, String> getUserMetadataMap()
  {
    HashMap<String, String> metadataMap = null;
    metadataMap = new HashMap();
    metadataMap.put("test_metadata", "tested-interface implementation");
    return metadataMap;
  }
}

  6. Abra um prompt de comando e navegue até o diretório que contém o projeto do pacote OSGi. Use o seguinte comando para criar o pacote OSGi:

    mvn clean install

  7. Faça upload do pacote para um servidor AEM Forms. Você pode usar AEM Gerenciador de pacotes para importar o pacote para o servidor AEM Forms.

Após a importação do pacote, é possível selecionar os metadados na etapa Atribuir tarefa e usá-lo como modelo de email.

Página anterior
Next page

Nesta página