Como usar as variáveis nos e-mails do Superlógica

Visão geral

As variáveis são marcadores dinâmicos que preenchem automaticamente informações do cadastro da empresa, do cliente e do plano nas mensagens enviadas pelo sistema. Essa funcionalidade personaliza as comunicações por e-mail sem a necessidade de digitação manual para cada destinatário. O recurso está disponível em notificações de boletos, réguas de inadimplência, tela de clientes e e-mails de contratação de planos.

Quando usar este artigo

Utilize este artigo para consultar a lista de variáveis disponíveis no sistema e identificar em quais telas e modelos de e-mail cada tag pode ser aplicada.

Sintoma ou cenário

Necessidade de personalizar e-mails disparados automaticamente pelo sistema inserindo dados específicos do cliente, cobrança ou contrato.

Benefício para o usuário ou operação

Preenchimento automático de dados cadastrais e financeiros nos e-mails enviados;
Direcionamento direto do destinatário para links de boletos e áreas de acesso do cliente;
Flexibilidade na personalização de notificações de contratação, réguas de cobrança e lembretes de vencimento.

Onde acessar / contexto de uso

Acesse o menu Empresa > Modelos de e-mail ou os campos de envio de mensagens nas telas de Clientes, Inadimplência e Planos.

Pré-requisitos (Antes de começar)

Perfil Exato: Usuário com as permissões Modelos - Alteração (1300) e Clientes - Notificar (1073).
Recursos Sistêmicos: Módulo de Comunicação / Modelos de E-mail ativo na licença.
Insumos e Dados Técnicos: Modelo de e-mail em edição e o código exato da variável a ser inserida.

Causas prováveis

A empresa precisa criar ou atualizar modelos de e-mail automáticos e deseja incluir dados dinâmicos do destinatário ou da cobrança para evitar a digitação manual a cada envio.

Como fazer ou corrigir

As variáveis devem ser inseridas exatamente com os caracteres % no início e no final da palavra. Cada variável funciona exclusivamente nos ambientes indicados na lista; caso uma tag seja utilizada fora da tela permitida, o sistema enviará o texto literal sem converter a informação. A tag de um ambiente não poderá ser utilizada em outro, a não ser que esta conste na lista de variáveis autorizadas.

Acesse a tela de edição do modelo de e-mail desejado (notificações de boletos, inadimplência, clientes ou contratação de planos).
No corpo ou assunto da mensagem, digite a variável correspondente ao dado que deseja preencher automaticamente.
Salve o modelo de e-mail.

Confira abaixo a relação completa das variáveis disponíveis e seus respectivos ambientes de aplicação:

Variáveis Gerais (Datas e Empresa)

%hoje%: Data do envio do e-mail. (Todos os ambientes)
%dia_atual%: Apenas o dia da data de envio. (Todos os ambientes)
%amanha%: Data posterior à data de envio do e-mail. (Todos os ambientes)
%mes_atual%: Mês atual em formato numérico. (Todos os ambientes)
%mes_atual_extenso%: Mês atual escrito por extenso. (Todos os ambientes)
%mes_anterior%: Mês anterior ao mês atual. (Todos os ambientes)
%mes_anterior_extenso%: Mês anterior escrito por extenso. (Todos os ambientes)
%mes_subsequente%: Próximo mês em formato numérico. (Todos os ambientes)
%mes_subsequente extenso%: Próximo mês escrito por extenso. (Todos os ambientes)
%ano_ atual%: Ano atual. (Todos os ambientes)
%desativar_template%: Desativa o layout/moldura padrão do e-mail no sistema. (Todos os ambientes)
%empresa_assinatura%: Nome da empresa, cidade e estado cadastrados. (Todos os ambientes)
%empresa_nome_maiusculo%: Nome fantasia da empresa em letras maiúsculas. (Todos os ambientes)
%empresa_nome%: Nome da empresa. (Todos os ambientes)
%empresa_cidade%: Cidade da empresa. (Todos os ambientes)
%empresa_cnpj%: CNPJ da empresa. (Todos os ambientes)
%empresa_licença%: Nome da licença de acesso ao sistema. (Todos os ambientes)

Variáveis de Dados do Cliente

%cliente_id%: Número do ID do cadastro do cliente no sistema. (Todos os ambientes)
%cliente_nome%: Nome completo ou razão social do cliente. (Todos os ambientes)
%cliente_nomefantasia%: Nome fantasia do cliente. (Todos os ambientes)
%cliente_cpf%: CPF ou CNPJ do cliente. (Todos os ambientes)
%cliente_e-mail%: E-mail principal cadastrado no cliente. (Todos os ambientes)
%cliente_telefone%: Telefone do cliente. (Todos os ambientes)
%cliente_fax%: Número do fax cadastrado. (Todos os ambientes)
%cliente_endereço%: Endereço completo do cliente. (Todos os ambientes)
%cliente_bairro%: Bairro do cliente. (Todos os ambientes)
%cliente_complemento%: Complemento do endereço do cliente. (Todos os ambientes)
%cliente_cidade%: Cidade do cliente. (Todos os ambientes)
%cliente_uf%: Estado (UF) do cliente. (Todos os ambientes)
%cliente_cep%: CEP do cliente. (Todos os ambientes)
%cliente_inscriçãoestadutal%: Inscrição Estadual (IE) do cliente. (Todos os ambientes)
%cliente_inscriçãomunicipal%: Inscrição Municipal (IM) do cliente. (Todos os ambientes)
%cliente_observação%: Texto registrado no campo de observações do cliente. (Todos os ambientes)
%cliente_identificador%: Código identificador do cliente utilizado para integração. (Todos os ambientes)
%cliente_vencimento%: Dia do vencimento padrão do cliente. (Todos os ambientes)
%cliente_sacadornome%: Nome do Sacador/Avalista. (Todos os ambientes)
%cliente_sacadorcnpjcpf%: CPF/CNPJ do Sacador/Avalista. (Todos os ambientes)
%cliente_numero%: Número do endereço do cliente. (Todos os ambientes)
%cliente_codigocontabil%: Código contábil registrado no cadastro do cliente. (Todos os ambientes)

Variáveis de Endereço de Entrega

%cliente_numero_entrega%: Número do endereço de entrega. (Todos os ambientes)
%cliente_endereço_entrega%: Endereço completo do local de entrega. (Notificações de boletos, Planos, Inadimplência, Clientes)
%cliente_bairro_entrega%: Bairro do local de entrega. (Todos os ambientes)
%cliente_complemento_entrega%: Complemento do endereço de entrega. (Todos os ambientes)
%cliente_cidade_entrega%: Cidade do local de entrega. (Todos os ambientes)
%cliente_uf_entrega%: Estado (UF) do local de entrega. (Todos os ambientes)
%cliente_cep_entrega%: CEP do local de entrega. (Todos os ambientes)
%cliente_ponto_referencia_entrega%: Ponto de referência do local de entrega. (Todos os ambientes)
%cliente_mesmo_endereço_entrega%: Exibe 1 para mesmo endereço ou 0 para endereço diferente. (Notificações de boletos, Planos, Clientes)

Variáveis de Notificações de Boletos

%tag_atualizado%: Informa ao cliente que o link atualiza o boleto para a data atual. (Notificações de boletos)
%endereço_boleto%: Link direto para visualizar o boleto atualizado. (Notificações de boletos)
%endereço_boleto_html%: Botão interativo para visualização do boleto atualizado. (Notificações de boletos)
%endereço_boleto_antigo%: Direciona o cliente para o boleto mais antigo em atraso. (Notificações de boletos)
%endereço_lista_boletos_antigo%: Link para a lista completa de cobranças em atraso. (Notificações de boletos)
%link_lista_boleto%: Link de acesso à área do cliente para consulta de boletos em aberto e a vencer. (Todos os ambientes)
%cobranca_mes%: Mês de referência da cobrança. (Notificações de boletos)
%cobranca_observacao%: Observações cadastradas diretamente na cobrança. (Notificações de boletos)
%cobranca_diasParaVencimento%: Quantidade de dias restantes para o vencimento. (Notificações de boletos)
%cobranca_vencimento%: Data do vencimento original da cobrança. (Notificações de boletos)
%cobranca_valor%: Valor original da cobrança. (Notificações de boletos)
%cobranca_id%: Número de identificação (ID) da cobrança no sistema. (Notificações de boletos)

Variáveis de Planos e Contratação

%plano_nome%: Nome do plano contratado. (Planos)
%plano_identificador%: Identificador numérico do plano gerado pelo sistema. (Planos)
%plano_identificadorexta%: Identificador extra do plano preenchido via API ou manualmente. (Planos)
%plano_cancelamento%: Data final do plano em contratos por prazo determinado. (Planos)
%plano_contratação%: Data de contratação do plano. (Planos)
%plano_valor%: Valor total do plano contratado. (Planos)
%plano_valor_formatado%: Quantidade de parcelas e moeda utilizada. (Planos)
%plano_adesao%: Valor total da taxa de adesão cadastrada. (Planos)
%plano_mensalidade%: Valor da mensalidade recorrente do plano. (Planos)
%plano_parcelas%: Quantidade de parcelas do plano. (Planos)
%plano_valor_primeiro_parcela%: Valor da primeira parcela em planos parcelados. (Planos)

Variáveis de Inadimplência e Tela de Clientes

%extrato_notificação%: Demonstrativo exibindo vencimento e valor do boleto em aberto. (Inadimplência, Clientes)
%link_boleto_publica%: Link direto para a área do cliente para visualização e impressão dos boletos. (Inadimplência, Clientes)
%link_boleto_publica_html%: Botão que direciona o cliente para a área do cliente. (Inadimplência, Clientes)

Resultado esperado

Os e-mails disparados pelo sistema substituem os códigos das variáveis pelas informações reais cadastradas para cada cliente, cobrança ou plano no momento do envio.

Quando escalar

Escale o atendimento ao suporte técnico caso o e-mail seja entregue ao destinatário exibindo o código da variável entre porcentagens (ex.: %cliente_nome%) em vez de convertê-lo no dado real, mesmo estando configurado no ambiente correto.

Informações que devem ser reunidas antes do escalonamento

Nome da licença;
ID do cliente ou ID da cobrança utilizada no teste de envio;
Nome da tela e modelo de e-mail onde a variável foi cadastrada;
Captura de tela (print) do e-mail recebido contendo a variável não convertida.

Regras importantes / Observações

As variáveis devem ser selecionadas exatamente como constam na lista, mantendo os símbolos de porcentagem % no início e no final.
Cada variável funciona apenas nos ambientes especificados; a inserção de variáveis de planos em modelos de e-mail de boletos impedirá a conversão dos dados.
A tag de um ambiente não poderá ser utilizada em outro, a menos que esta conste na lista de variáveis do respectivo ambiente.
A tag %desativar_template% remove a estrutura visual padrão do sistema, permitindo a utilização de um layout próprio em HTML.

Problemas comuns e como resolver

Problema: A variável aparece escrita no e-mail recebido sem substituir pelo dado do cliente.
- Causa provável: A tag foi inserida em uma tela incompatível com seu ambiente de aplicação ou houve erro de digitação no nome da variável.
- Ação recomendada: Verifique na tabela de variáveis se a tag utilizada é permitida para aquele ambiente (ex.: Notificações de boletos ou Planos) e corrija a grafia da palavra.

Dúvidas relacionadas

P: É possível utilizar uma variável de plano na notificação de envio de boleto? R: Não, as variáveis funcionam apenas nos ambientes descritos para cada uma; tags de plano utilizadas fora da tela de Planos não serão convertidas no envio.

P: O que acontece ao incluir a variável %desativar_template% no e-mail? R: Essa variável remove o cabeçalho e rodapé padrão do Superlógica, permitindo personalizar completamente a estrutura visual da mensagem.

Palavras-chave de busca

variáveis de email, campos dinâmicos email, personalizar e-mail, modelo de e-mail, tags de email, link de boleto email, notificação automática