Commande NOTIFY

Information de concept

Envoyer des notifications par e-mail à partir d'Analytics

Soumet un message de notification sortant par e-mail vers un serveur de messagerie SMTP pour qu'il soit relayé aux destinataires.

Syntaxe

Syntaxe de commande authentifiée

NOTIFY SMTP SMTPUSER nom_compte_SMTP PORT numéro_du_port <ENABLESSL> USER e-mail_destinataire PASSWORD mot_de_passe_crypté MAILBOX nom_serveur_SMTP ADDRESS e-mail_destinataire <CC e-mail_destinataire_cc> <BCC e-mail_destinataire_cci> SUBJECT ligne_objet MESSAGE texte_message <ATTACHMENT chemin_fichier>

Syntaxe de commande non authentifiée

Remarque

Cette ancienne version de la commande NOTIFY est destinée à être utilisée avec des systèmes de messagerie locale ou des serveurs de messagerie SMTP qui ne nécessitent aucune authentification. Elle ne fonctionne pas avec les systèmes de messagerie modernes qui nécessitent généralement une authentification.

NOTIFY USER e-mail_expéditeur <PASSWORD mot_de_passe_crypté> MAILBOX nom_serveur_SMTP ADDRESS e-mail_destinataire <CC e-mail_destinataire_cc> <BCC e-mail_destinataire_cci> SUBJECT ligne_objet MESSAGE texte_message <ATTACHMENT chemin_fichier>

Paramètres

Nom Description
SMTP

Spécifie l’envoi d’une soumission authentifiée à un serveur SMTP (Simple Mail Transfer Protocol server).

  • Spécifier un SMTP votre serveur SMTP exige des connexions authentifiées

  • Ne pas spécifier de SMTP vous utilisez un serveur SMTP ouvert et vous vous connectez en utilisant le port 25, ou un système de messagerie local qui ne requiert pas d’authentification

Remarque

Pratiquement tous les systèmes de messagerie modernes utilisant le SMTP requièrent une authentification.

Vous devez spécifier un SMTP pour activer les paramètres suivants :

  • SMTPUSER

  • PORT

  • ENABLESSL

SMTPUSER nom_compte_SMTP

Le nom du compte utilisateur pour s’authentifier et accéder au serveur SMTP.

Si vous ignorez SMTPUSER, l'adresse e-mail d'expédition indiquée par USER est utilisée pour accéder à un système de messagerie locale ou à un serveur de messagerie SMTP qui ne nécessite pas d'authentification.
PORT numéro_port

Numéro du port à utiliser pour accéder au serveur SMTP.

Vous aurez peut-être besoin de contacter votre département informatique pour connaître le port à utiliser. Les numéros de port courants pour les serveurs SMTP sont :

  • 587
  • 2525
  • 465

Vous devez utiliser PORT si vous utilisez SMTPUSER. Si vous omettez SMTPUSER, vous pouvez omettre PORT et le port 25 par défaut est utilisé.

ENABLESSL

optionnel

Indique l'accès au serveur SMTP à l'aide d'une connexion SMTP/SSL sécurisée.

Vous devrez peut-être contacter votre service informatique pour savoir si votre serveur SMTP nécessite une connexion SSL. Vous pouvez aussi envoyer des e-mails de test avec et sans ENABLESSL spécifié.
USER e-mail_expéditeur

Définit une adresse e-mail pour les notifications par e-mail envoyées via le serveur SMTP.

Remarque

Selon la configuration de votre serveur SMTP, USER et SMTPUSER peuvent être ou non le même compte.
PASSWORD mot_de_passe_crypté

Mot de passe du compte utilisateur pour le serveur SMTP. Le mot de passe doit être fourni en tant que chaîne cryptée.

Pour plus d'informations, consultez la section Générer un mot de passe crypté.

Un mot de passe n'est pas obligatoire pour accéder à un système de messagerie locale ou à un serveur de messagerie SMTP qui ne nécessite pas d'authentification.
MAILBOX nom_serveur_SMTP

Nom de domaine du serveur SMTP à utiliser pour envoyer le courrier électronique. Par exemple :

MAILBOX "smtp.exemple.com"
ADDRESS e-mail_destinataire

Adresse électronique d'un ou plusieurs destinataires.

Séparez plusieurs adresses électroniques par des virgules. Saisissez 1020 caractères au maximum.
CC e-mail_destinataire_cc

optionnel

Adresse électronique d'un ou plusieurs destinataires mis en copie carbone.

Séparez plusieurs adresses électroniques par des virgules. Saisissez 1020 caractères au maximum.
BCC e-mail_destinataire_cci

optionnel

Adresse électronique d'un ou plusieurs destinataires mis en copie carbone invisible.

Séparez plusieurs adresses électroniques par des virgules.
SUBJECT ligne_objet Ligne d'objet du message électronique.
MESSAGE texte_message

Corps de texte du message électronique.

Le message est en texte brut et ne prend pas en charge HTML. Si vous souhaitez insérer un saut de ligne dans votre message, utilisez deux caractères caret : ^^.
ATTACHMENT chemin_fichier

optionnel

Chemin d’accès et nom de fichier d’une ou de plusieurs pièces jointes.

Si le fichier se trouve dans le même dossier que le projet Analytics, vous n’avez pas besoin d’indiquer le chemin du fichier.

Mettez le chemin et le nom du fichier entre guillemets. Indiquez plusieurs pièces jointes en saisissant les fichiers dans une liste de valeurs séparées par des virgules pour chemin_fichier :

ATTACHMENT "result1.csv,result2.csv"

Remarque

Dans une liste de valeurs séparées par des virgules, assurez-vous qu’il n’y a pas d’espace après les virgules.

Exemples

Envoi d'un e-mail de rapport d'erreurs

Remarque

Syntaxe de commande authentifiée.

Vous exécutez un script, et vous souhaitez envoyer un e-mail de notification si le script échoue. À l'aide de NOTIFY, vous définissez le message électronique et incluez deux pièces jointes :

  • le fichier trace
  • un fichier .fil contenant les erreurs enregistrées
NOTIFY SMTP SMTPUSER "e-mail_admin@exemple.com" PORT 587 ENABLESSL USER "support@societe.com" PASSWORD "9QZC2524830864..." MAILBOX "smtp.societe.com" ADDRESS "script_admin@societe.com" SUBJECT "Error Report" MESSAGE "Échec du traitement du script. Détails joints." ATTACHMENT "Erreurs.fil,ACL_Demo.log"

Envoi d'un e-mail de rapport d'erreurs

Remarque

Syntaxe de commande non authentifiée.

Vous exécutez un script, et vous souhaitez envoyer un e-mail de notification si le script échoue. À l'aide de NOTIFY, vous définissez le message électronique et incluez deux pièces jointes :

  • le fichier trace
  • un fichier .fil contenant les erreurs enregistrées
NOTIFY USER "support@societe.com" MAILBOX "mail.societe.com" ADDRESS "script_admin@societe.com" SUBJECT "Rapport d’erreur" MESSAGE "Echec du traitement du script. Détails joints." ATTACHMENT "Erreurs.fil,ACL_Demo.log"

Remarques

Destinataires et pièces jointes

Vous pouvez utiliser la commande NOTIFY pour envoyer des messages de notification à un ou plusieurs destinataires. Les messages peuvent inclure des fichiers de données et des projets Analytics en pièces jointes.

Une utilisation courante de la commande NOTIFY consiste à informer les personnes concernées de l’échec inattendu d’un script.

Serveurs SMTP compatibles

La commande NOTIFY peut être utilisée avec n’importe quel serveur de messagerie prenant en charge le protocole SMTP (Simple Mail Transfer Protocol) et devrait fonctionner avec un large éventail de serveurs SMTP nécessitant des connexions authentifiées. Toutefois, elle ne fonctionne pas avec tous les serveurs ou services SMTP. Par exemple, NOTIFY ne fonctionne pas avec Gmail. Pour que des applications tierces puissent se connecter à un compte Google, il faut une configuration de sécurité allant au-delà du nom d’utilisateur et du mot de passe pris en charge par NOTIFY.

D’une manière générale, il faut savoir que l’utilisation de NOTIFY pour soumettre des e-mails sortants à un serveur SMTP nécessite une configuration compatible du côté d’Analytics et du côté du serveur SMTP. Si NOTIFY ne parvient pas à se connecter et à envoyer des e-mails, consultez votre service informatique pour vous assurer qu’il existe une configuration de connexion compatible entre Analytics et le serveur.

Générer un mot de passe crypté

Remarque

Analytics prend en charge une longueur maximale de 30 caractères pour les mots de passe spécifiés de profil de serveur, de profil de base de données ou de serveur de messagerie. La spécification d'une valeur de mot de passe dépassant cette longueur entraînera une troncature du mot de passe et un échec de la connexion.

Vous devez fournir une valeur de mot de passe crypté avec le paramètre PASSWORD dans la commande NOTIFY. Pour crypter correctement un mot de passe afin de l'utiliser avec NOTIFY, vous devez le saisir dans la boîte de dialogue Notifier dans l'interface utilisateur Analytics.

  1. Facultatif. Dans Analytics, dans la ligne de commande, entrez SET NOTIFYRETRYATTEMPTS TO 0.

    Le fait de désactiver temporairement les tentatives de relance de NOTIFY accélère la génération du mot de passe crypté.

  2. Dans le menu principal Analytics, sélectionnez Outils > Notifier par courrier électronique.

  3. Dans la boîte de dialogue Notifier, remplissez les champs requis et des champs optionnels, si besoin :

    Expéditeur e-mail_expéditeur Obligatoire
    Mot de passe

    Mot de passe du compte utilisateur, en texte clair, pour le serveur SMTP.

    Remarque

    Si le mot de passe dépasse 30 caractères, la commande NOTIFY échouera.

    		 Obligatoire
    Chemin boîte réception nom_serveur_SMTP Obligatoire
    Vers e-mail_destinataire Obligatoire
    CC e-mail_destinataire_cc Optionnel
    Cci e-mail_destinataire_cci Optionnel
    Objet ligne_objet Obligatoire
    Texte texte_message Obligatoire
    Pièce jointe chemin_fichier Optionnel

  4. Cliquez sur OK.

    Si vous essayez de vous connecter à un serveur SMTP qui nécessite une authentification, la tentative de connexion échouera (comme c’est à prévoir), même si la commande NOTIFY semble avoir été exécutée avec succès.

  5. Copiez la commande NOTIFY à partir du journal et collez-la dans un script.

    La commande NOTIFY comporte désormais une valeur cryptée pour PASSWORD.

  6. Dans le script, ajoutez les paramètres suivants à la commande NOTIFY copiée et fournissez des valeurs de paramètre appropriées.

    Vous pouvez insérer les paramètres immédiatement après le mot-clé NOTIFY.

    • SMTP

    • SMTPUSER nom_compte_SMTP

    • PORT numéro_port

    • ENABLESSL (si nécessaire)

  7. Si vous avez précédemment défini le nombre de tentatives de relance de NOTIFY à 0, entrez SET NOTIFYRETRYATTEMPTS TO 5 dans la ligne de commande.

    Si vous aviez initialement indiqué un nombre différent de tentatives, au lieu de 5, entrez le nombre approprié.

  8. Exécutez le script pour tester la commande NOTIFY.

    Si toutes les valeurs requises sont configurées correctement pour fonctionner avec le serveur de messagerie SMTP, la commande NOTIFY devrait être exécutée normalement.

Comment Analytics répond aux tentatives de connexion échouées

Si Analytics n'est pas en mesure de se connecter avec le serveur de messagerie, il réalise cinq tentatives supplémentaires pour se connecter, avec une pause de 10 secondes entre chaque tentative. Cette fonctionnalité de relance automatique répond au problème de l’indisponibilité momentanée d’un serveur de messagerie.

Si toutes les tentatives de connexion échouent, la commande NOTIFY est annulée, avec un message écrit dans la trace, mais le script contenant la commande continue son processus.

Vous pouvez utiliser la commande SET pour modifier le comportement par défaut. Vous pouvez indiquer :

  • un nombre différent de tentatives de connexion

  • aucune tentative de connexion supplémentaire

  • un intervalle de temps différent entre les tentatives

  • un échec du script si la commande NOTIFY ne parvient pas à se connecter et est annulée

Pour plus d’informations sur la commande SET, voir Commande SET.

Syntaxe de la commande SET Exemples et remarques

SET NOTIFYRETRYATTEMPTS <TO> num

 
SET NOTIFYRETRYATTEMPTS TO 10

Paramètre par défaut : 5 tentatives

Indique le nombre de fois où la commande NOTIFY tentera d'envoyer un message électronique en cas d'échec de la première tentative. Entrez un nombre compris entre 0 et 255. Si vous entrez 0, aucune autre tentative ne sera effectuée après un premier échec.

Une raison possible d'échec d'envoi de message électronique par la commande NOTIFY est l'indisponibilité du serveur de messagerie.

SET NOTIFYRETRYINTERVAL <TO> secondes

 
SET NOTIFYRETRYINTERVAL TO 30

Paramètre par défaut : 10 secondes

Indique la durée en secondes entre les NOTIFYRETRYATTEMPTS. Entrez un nombre compris entre 1 et 255.

SET NOTIFYFAILSTOP {ON | OFF}

 
SET NOTIFYFAILSTOP ON

Paramètre par défaut : OFF

  • NOTIFYFAILSTOP est sur OFF Analytics autorise la poursuite du script même en cas d'échec d'une commande NOTIFY dans le script.
  • NOTIFYFAILSTOP est sur ON Analytics arrête le traitement d'un script et écrit un message dans la trace si une commande NOTIFY échoue dans le script. Le script s'arrête après le premier échec ou après le nombre NOTIFYRETRYATTEMPTS spécifié, si aucune des tentatives n'aboutit.

Remarque

Un destinataire de message électronique incorrect n’est pas considéré comme un échec de la commande NOTIFY et n’entraîne pas l’arrêt d’un script quel que soit le paramètre NOTIFYFAILSTOP.