Comando NOTIFY

Informações do conceito

Enviar notificações por e-mail do Analytics

Envia uma mensagem de notificação de e-mail de saída para um servidor de e-mail SMTP para ser transmitida aos destinatários.

Sintaxe

Sintaxe de comando autenticado

NOTIFY SMTP SMTPUSER nome_conta_SMTP PORT número_porta <ENABLESSL> USER e-mail_remetente PASSWORD senha_criptografada MAILBOX nome_servidor_SMTP ADDRESS e-mail_destinatário <CC e-mail_destinatário_cc> <BCC e-mail_destinatário_cco> SUBJECT linha_assunto MESSAGE texto_mensagem <ATTACHMENT caminho_arquivo>

Sintaxe de comando não autenticado

Nota

Esta versão mais antiga do comando NOTIFY é destinada ao uso com sistemas de e-mail locais ou servidores de e-mail SMTP que não exigem autenticação. Ela não funciona com sistemas modernos, que geralmente exigem autenticação.

NOTIFY USER e-mail_remetente <PASSWORD senha_criptografada MAILBOX nome_servidor_SMTP ADDRESS e-mail_destinatário <CC e-mail_destinatário_cc> <BCC e-mail_destinatário_cco> SUBJECT linha_assunto MESSAGE texto_mensagem <ATTACHMENT caminho_arquivo>

Parâmetros

Nome Descrição
SMTP

Especifica a realização de um envio autenticado para um servidor SMTP (Simple Mail Transfer Protocol).

  • Especificar SMTP seu servidor SMTP exige conexões autenticadas

  • Não especificar SMTP você usa um servidor SMTP aberto e conecta usando a porta 25 ou um sistema de e-mail local que não requer autenticação

Nota

Praticamente todos os sistemas de e-mail modernos que usam SMTP exigem autenticação.

Você precisa especificar SMTP para habilitar os seguintes parâmetros:

  • SMTPUSER

  • PORT

  • ENABLESSL

SMTPUSER nome_conta_SMTP

O nome da conta do usuário para autenticação e acesso ao servidor de SMT.

Se você omitir o SMTPUSER, o endereço de e-mail do remetente especificado por USER é utilizado para acessar um sistema de e-mail local, ou um servidor de e-mail SMTP que não exija autenticação.
PORT número_porta

O número da porta a ser usada para acessar o servidor SMTP.

Talvez você tenha que entrar em contato com o seu departamento de TI para saber qual porta deve usar. Números de porta comuns para servidores SMTP são:

  • 587
  • 2525
  • 465

Você deve usar PORT se usar SMTPUSER. Se você omitir SMTPUSER, poderá omitir PORT, e a porta padrão 25 será usada.

ENABLESSL

opcional

Especifica o acesso ao servidor SMTP usando uma conexão SMTP/SSL segura.

Talvez você precise falar com seu departamento de TI para descobrir se o servidor SMTP exige uma conexão SSL. Você pode enviar e-mails de teste com e sem ENABLESSL especificado.
USER e-mail_remetente

Define o endereço de e-mail do remetente para as notificações de e-mail enviadas pelo servidor SMTP.

Nota

Dependendo da configuração do seu servidor SMTP, USER e SMTPUSER podem ou não ser a mesma conta.
PASSWORD senha_criptografada

A senha da conta do usuário para o servidor SMTP. A senha deve ser fornecida como uma cadeia criptografada.

Para obter mais informações, consulte Gerando uma senha criptografada.

Pode não ser necessária uma senha para acessar um sistema de e-mail local ou um servidor de e-mail SMTP que não exija autenticação.
MAILBOX nome_servidor_SMTP

O nome do domínio do servidor SMTP a ser usado para enviar a mensagem de e-mail. Por exemplo:

MAILBOX "smtp.exemplo.com"
ADDRESS e-mail_destinatário

O endereço de e-mail de um ou mais destinatários.

Separe vários endereços de e-mail com vírgula. Insira no máximo 1.020 caracteres.
CC e-mail_destinatário_cc

opcional

O endereço de e-mail de um ou mais destinatários de cópia.

Separe vários endereços de e-mail com vírgula. Insira no máximo 1.000 caracteres.
BCC e-mail_destinatário_cco

opcional

O endereço de e-mail de um ou mais destinatários de cópia oculta.

Separe vários endereços de e-mail com vírgula.
SUBJECT linha_assunto A linha de assunto da mensagem de e-mail.
MESSAGE texto_mensagem

O texto do corpo da mensagem de e-mail.

A mensagem usa texto simples e não permite HTML. Se você quiser inserir uma quebra de linha na mensagem, use dois caracteres de circunflexo: ^^
ATTACHMENT caminho_arquivo

opcional

O caminho e o nome do arquivo de um ou mais anexos.

Se o arquivo estiver na mesma pasta que o projeto do Analytics, não será necessário especificar o caminho do arquivo.

Coloque o caminho e o nome do arquivo dentro de aspas. Especifique vários anexos inserindo uma lista de arquivos separados por vírgula para caminho_arquivo:

ATTACHMENT "resultado1.csv,resultado2.csv"

Nota

Em uma lista separada por vírgula, confirme que não há espaços após as vírgulas.

Exemplos

Envio de um e-mail de relato de erro

Nota

Sintaxe de comando autenticado.

Você está executando um script e deseja enviar um e-mail de notificação em caso de falha do script. Use NOTIFY para definir a mensagem de e-mail e incluir dois anexos:

  • o arquivo de log
  • um arquivo .fil contendo os erros registrados
NOTIFY SMTP SMTPUSER "mail_admin@example.com" PORT 587 ENABLESSL USER "support@company.com" PASSWORD "9QZC2524830864..." MAILBOX "smtp.company.com" ADDRESS "script_admin@company.com" SUBJECT "Relatório de erros" MESSAGE "Falha ao processar script. Detalhes em anexo." ATTACHMENT "Erros.fil,ACL_Demo.log"

Envio de um e-mail de relato de erro

Nota

Sintaxe de comando não autenticado.

Você está executando um script e deseja enviar um e-mail de notificação em caso de falha do script. Use NOTIFY para definir a mensagem de e-mail e incluir dois anexos:

  • o arquivo de log
  • um arquivo .fil contendo os erros registrados
NOTIFY USER "support@company.com" MAILBOX "mail.company.com" ADDRESS "script_admin@company.com" SUBJECT "Relatório de erros" MESSAGE "Falha ao processar script. Detalhes em anexo." ATTACHMENT "Erros.fil,ACL_Demo.log"

Observações

Destinatários e anexos

O comando NOTIFY pode ser utilizado para enviar mensagens de notificação por meio de e-mail para um ou mais destinatários. As mensagens podem incluir arquivos de dados anexados e projetos do Analytics.

Um uso comum do comando NOTIFY é alertar a equipe apropriada quando um script falha inesperadamente.

Servidores SMTP compatíveis

O comando NOTIFY pode ser usado com qualquer servidor de e-mail que aceite SMTP (Simple Mail Transfer Protocol) e deve funcionar com uma ampla variedade de servidores SMTP que exigem conexões autenticadas. No entanto, ele não funciona com todos serviços ou servidores SMTP. Por exemplo, NOTIFY não é compatível com o Gmail. Para aplicativos de terceiros se conectarem a uma Conta do Google, é necessária uma configuração de segurança, além de nome de usuário e senha, compatível com NOTIFY.

De modo geral, esteja ciente de que o uso bem-sucedido de NOTIFY para enviar e-mails de saída a um servidor SMTP requer uma configuração compatível tanto no Analytics como no servidor SMTP. Se NOTIFY falhar ao conectar, mas conseguir enviar e-mails, trabalhe com seu departamento de TI para garantir que haja uma configuração de conexão compatível entre o Analytics e o servidor.

Gerando uma senha criptografada

Nota

O Analytics suporta um tamanho máximo de 30 caracteres ao especificar ou inserir uma senha de perfil do servidor, uma senha de perfil de banco de dados ou uma senha de servidor de e-mail. Especificar um valor de senha que exceda esse tamanho resulta em uma senha truncada e falha na conexão.

Você precisa fornecer um valor de senha criptografada com o parâmetro PASSWORD no comando NOTIFY. Para criptografar de modo apropriado uma senha para uso com o NOTIFY, você deve inserir a senha na caixa de diálogo Notificar na interface do usuário do Analytics.

  1. Opcional. No Analytics, digite SET NOTIFYRETRYATTEMPTS TO 0 na linha de comando

    A desativação temporária do número de novas tentativas de NOTIFY agilizará a geração da senha criptografada.

  2. No menu principal do Analytics, selecione Ferramentas > Notificar por e-mail.

  3. Na caixa de diálogo Notify, complete os campos exigidos, e os campos opcionais, conforme necessário:

    Remetente e-mail_remetente Obrigatório
    Senha

    A senha da conta do usuário, em um texto claro, para o servidor SMTP.

    Nota

    Se a senha exceder 30 caracteres, o comando NOTIFY falhará.

    		 Obrigatório
    Caminho da caixa postal nome_servidor_SMTP Obrigatório
    Para e-mail_destinatário Obrigatório
    Cc e-mail_destinatário_cc Opcional
    Cco e-mail_destinatário_cco Opcional
    Assunto linha_assunto Obrigatório
    Texto texto_mensagem Obrigatório
    Anexo caminho_arquivo Opcional

  4. Clique em OK.

    Caso você esteja tentando conectar a um servidor SMTP que exige autenticação, a tentativa de conexão falha (como esperado) mesmo se o comando NOTIFY parecer bem-sucedido.

  5. Copie o comando NOTIFY do log e cole-o em um script.

    O comando NOTIFY agora incluirá um valor criptogrado para PASSWORD.

  6. No script, adicione os seguintes parâmetros ao comando NOTIFY copiado e forneça valores de parâmetro apropriados.

    Você pode inserir os parâmetros imediatamente após a palavra-chave NOTIFY.

    • SMTP

    • SMTPUSER nome_conta_SMTP

    • PORT número_porta

    • ENABLESSL (se necessário)

  7. Se você já tiver definido o número de novas tentativas de NOTIFY como 0, digite SET NOTIFYRETRYATTEMPTS TO 5 na linha de comando.

    Se originalmente havia especificado um número de novas tentativas diferente de 5, digite o número apropriado.

  8. Execute o script para testar o comando NOTIFY.

    Se todos os valores exigidos forem configurados corretamente para funcionar com o servidor de e-mail SMTP, o comando NOTIFY deve agora ser bem-sucedido.

Como o Analytics responde às tentativas de conexão com falha

Caso o Analytics não consiga se conectar ao servidor de e-mail, ele realiza mais cinco tentativas de conexão, com uma pausa de 10 segundos entre cada tentativa. Essa função de nova tentativa automática resolve o problema de indisponibilidade momentânea de um servidor de e-mail.

Caso todas as tentativas resultem em falha, o comando NOTIFY é cancelado com o registro de uma mensagem no log, mas o script com o comando continua em processamento.

Você pode usar o comando SET para alterar o comportamento padrão de nova tentativa. Você pode especificar:

  • outro número de tentativas de conexão;

  • que não haja tentativas de conexão adicionais;

  • um valor de tempo diferente entre tentativas;

  • uma falha de script caso o comando NOTIFY não consiga conectar e seja cancelado.

Consulte Comando SET para ver informações adicionais sobre o comando SET.

Sintaxe do comando SET Observações e comentários

SET NOTIFYRETRYATTEMPTS <TO> num

 
SET NOTIFYRETRYATTEMPTS TO 10

Configuração padrão: 5 tentativas

Especifica o número de vezes que o comando NOTIFY deve tentar enviar um e-mail se a tentativa inicial falhar. Insira um número de 0 a 255. Caso seja usado 0, nenhuma tentativa adicional é feita após a primeira falha.

Um possível motivo para que o comando NOTIFY falhe ao enviar um e-mail é a indisponibilidade do servidor de e-mail.

SET NOTIFYRETRYINTERVAL <TO> segundos

 
SET NOTIFYRETRYINTERVAL TO 30

Configuração padrão: 10 segundos

Especifica a quantidade de tempo em segundos entre NOTIFYRETRYATTEMPTS. Insira um número entre 1 e 255.

SET NOTIFYFAILSTOP {ON | OFF}

 
SET NOTIFYFAILSTOP ON

Configuração padrão: OFF

  • NOTIFYFAILSTOP está OFF o Analytics permite a continuidade do script, mesmo em caso de falha de um comando NOTIFY no script.
  • NOTIFYFAILSTOP está ON o Analytics interrompe o processamento do script e grava uma mensagem no log em caso de falha de um comando NOTIFY no script. O script é interrompido após a falha inicial ou após a quantidade especificada em NOTIFYRETRYATTEMPTS, caso nenhuma das tentativas obtenha sucesso.

Nota

Um destinatário de e-mail inválido não é considerado uma falha no comando NOTIFY e não causa a interrupção do script, independentemente da configuração NOTIFYFAILSTOP.