Ajouter et configurer une étape Send Email (Envoyer un e-mail)

L’étape Send Email (Envoyer un e-mail) envoie une notification par e-mail à un ou plusieurs destinataires lorsque l’étape est exécutée. Ce type d’étape peut être utilisé pour envoyer des notifications lorsqu’une étape ou une tâche est terminée ou lorsqu’une étape n’aboutit pas.

Vous pouvez éventuellement configurer les paramètres de notification par e-mail pour ArcGIS Workflow Manager avant d’envoyer les notifications par e-mail avec l’étape Send Email (Envoyer l’e-mail). Les paramètres personnalisés du serveur SMTP vous permettent d’ajouter des pièces jointes, d’utiliser des adresses e-mail au lieu de noms d’utilisateur ou d’un ID de groupe et d’activer les zones de texte CC (Cc) et BCC (Cci).

Remarque :

Il se peut que vous deviez modifier des rôles personnalisés pour récupérer les adresses e-mail du membre d’organisation avec des expressions ArcGIS Arcade.

Configurer l’étape

Pour configurer l’étape, procédez comme suit :

  1. Créez ou mettez à jour un diagramme de processus pour accéder au volet Step Library (Bibliothèque d’étapes).
  2. Faites glisser Send Email (Envoyer un e-mail) depuis le volet Step Library (Bibliothèque d’étapes) vers une flèche de connexion d’une étape de la zone d’affichage du workflow.

    Le volet Step Details (Détails de l’étape) s’affiche.

  3. Spécifiez un nom pour l’étape dans la zone de texte Step Name (Nom de l’étape).
  4. Cliquez éventuellement sur le bouton bascule Enable custom SMTP server (Activer le serveur SMTP personnalisé) afin d’utiliser votre serveur SMTP pour envoyer des e-mails.
  5. Si vous ne disposez pas d’un serveur SMTP personnalisé, choisissez l’une des options Recipient Type (Type de destinataire) suivantes et spécifiez les destinataires dans la zone de texte To (À) :
    • Usernames (Noms d’utilisateur) : fournissez la liste des noms d’utilisateur en les séparant par un point-virgule ou utilisez une expression Arcade pour créer une liste dynamique de destinataires. Les expressions Arcade doivent être placées entre guillemets doubles.
    • Group ID (ID de groupe) : fournissez un seul ID de groupe ou utilisez une expression Arcade pour extraire un ID de groupe. Les expressions Arcade doivent être placées entre guillemets doubles.

    Au moins un nom d’utilisateur, un ID de groupe ou une expression Arcade valide doit être indiquée dans la zone de texte To (À).

    Attention :

    Si vous ne disposez pas d’un serveur SMTP personnalisé, le nombre maximal de destinataires est de 50. Les expressions Arcade peuvent entraîner un dépassement du nombre maximal de destinataires dans la liste des destinataires.

    Un nom d’utilisateur

    JDoe

    Un ID de groupe

    7dr6de56442840ccbf49b3f869f49b27

    Plusieurs noms d’utilisateur

    JDoe;KSmith;MFields

    Une expression Arcade

    "GetUser($CurrentPortal, jobOwner($job))['username']"

    Plusieurs expressions Arcade

    "GetUser($CurrentPortal, jobOwner($job))['username']";"jobCreator($job)";"lastRunner($job, '8b107614-c6dc-20b3-c232-e03bf7c007bc')"

    Noms d’utilisateur et expressions Arcade

    JDoe;"GetUser($CurrentPortal, jobOwner($job))['username']";KSmith;"lastRunner($job, '8b107614-c6dc-20b3-c232-e03bf7c007bc')"

    Conseil :

    Cliquez sur This input supports Arcade Expressions (Cette entrée prend en charge les expressions Arcade) This input supports Arcade expressions et sélectionnez une expression ArcGIS Arcade pour l’ajouter à la zone de texte associée.

  6. Si vous disposez d’un serveur SMTP personnalisé, spécifiez des adresses électroniques séparées par un point-virgule dans les zones de texte To (À), CC (Cc) et BCC (Cci), le cas échéant, ou utilisez une expression ArcGIS Arcade pour créer une liste dynamique de destinataires. Les expressions Arcade doivent être placées entre guillemets doubles.

    Au moins une adresse électronique valide ou une expression Arcade doit être indiquée dans les zones de texte To (À), CC (Cc) et BCC (Cci).

    Une adresse e-mail

    user1@test.com

    Plusieurs adresses e-mail

    user1@test.com;user2@test.com;user3@test.com;user4@test.com

    Une expression Arcade

    "GetUser($CurrentPortal, JobOwner($Job))['Email']"

    Plusieurs expressions Arcade

    "GetUser($CurrentPortal, JobOwner($Job))['Email']";"GetUser($CurrentPortal)['Email']";"GetUser($CurrentPortal, LastRunner($Job, 'f50d740d-cc04-9296-4ce3-181e82604465'))['Email']"

    Adresses e-mail et expressions Arcade

    user1@test.com;"GetUser($CurrentPortal, JobOwner($Job))['Email']";user3@test.com;"GetUser($CurrentPortal)['Email']"

    Conseil :

    Cliquez sur This input supports Arcade Expressions (Cette entrée prend en charge les expressions Arcade) This input supports Arcade expressions et sélectionnez une expression ArcGIS Arcade pour l’ajouter à la zone de texte associée.

  7. Indiquez un objet pour la notification par e-mail dans la zone de texte Subject (Objet).

    Vous devez indiquer un objet. La zone de texte Subject (Objet) ne peut pas rester vide.

    Vous pouvez également utiliser des expressions Arcade pour attribuer une valeur dynamique à l’objet. Si l’objet contient du texte brut et des expressions Arcade, mettez en forme le texte comme suit :

    JobName($Job) + 'is ready'

  8. Spécifiez le texte du message de la notification par e-mail dans la zone de texte Body (Corps).

    Vous devez fournir un message dans le corps. La zone de texte Body (Corps) ne peut pas rester vide.

    Vous pouvez également utiliser des expressions Arcadepour attribuer une valeur dynamique au corps.

    Si le corps contient du texte brut et des expressions ArcadeArcade, mettez en forme le texte comme suit :

    '<b>' + JobName($Job) + '</b>, created by <b>' + JobCreator($Job) + '</b>, was started on <b>' + Text(Date(JobStartDate($Job)), 'dddd, MMMM D, Y') + '</b>.'
    Attention :

    Si vous ne disposez pas d’un serveur SMTP personnalisé, la taille du corps de l’e-mail est limitée à 100 ko. Les expressions Arcade peuvent provoquer le dépassement de la taille limite maximale.

  9. Si vous disposez d’un serveur SMTP personnalisé, vous pouvez inclure des pièces jointes dans la notification par e-mail à l’aide des options suivantes figurant sous Include Attachments (Inclure des pièces jointes) :
    • None (Aucune) : n’incluez pas de pièce jointe de la tâche dans la notification par e-mail.
    • All (Toutes) : incluez tous les dossiers de pièces jointes de la tâche dans la notification par e-mail.
    • By Folder (Par dossier) : spécifiez une liste de noms de dossier de pièces jointes de tâches séparés par une virgule dans la zone de texte By Folder (Par dossier) pour spécifier les dossiers de pièces jointes de tâches à inclure dans la notification par e-mail.
      Remarque :

      Les dossiers des pièces jointes de tâche se trouvent dans l’élément de processus et ne correspondent pas à des chemins du système de fichiers.

    Remarque :

    Si une tâche comporte plusieurs pièces jointes, elles sont envoyées sous la forme d’un seul fichier .zip, et la structure des dossiers de pièces jointes de la tâche est préservée.

  10. Cliquez éventuellement sur Preview email (Aperçu de l’e-mail) pour afficher un aperçu de l’e-mail.
    Remarque :

    Si l’e-mail contient une expression Arcade propre à une tâche, vous devez indiquer un ID de tâche valide dans la zone de texte Preview Email (Aperçu de l’e-mail) avant de pouvoir afficher un aperçu de l’expression Arcade. Si l’e-mail contient une expression Arcade pour la valeur en sortie d’une étape, cette dernière doit être terminée avant de pouvoir afficher un aperçu de la valeur en sortie.

    La fenêtre Email Preview (Aperçu de l’e-mail) s’affiche avec une liste de destinataires et un aperçu de l’objet et du corps.

  11. Cliquez sur l'onglet Options.
  12. Définissez les paramètres Step Options (Options de l’étape) comme il convient :
    • Manual (Manuel) : l’étape est exécutée manuellement.
      • Optional (Facultatif) : permet de finaliser la tâche sans l’exécuter.
    • Automatic (Automatique) : l’étape est exécutée dès qu’elle devient active.
      Remarque :

      Si le diagramme de processus est configuré pour exécuter automatiquement une séquence d’étapes qui comprend l’étape Exécuter un service de géotraitement, les étapes censées s’exécuter après l’expiration du jeton utilisateur ne démarrent pas automatiquement. L’extension d’organisation ArcGIS Workflow Manager Advanced est nécessaire à l’exécution des étapes automatisées supplémentaires sans intervention manuelle.

    • Run on a Schedule (Exécution planifiée) : l’étape s’exécute selon une planification définie.

      En savoir plus sur les options de planification

  13. Sélectionnez éventuellement l’une des options suivantes pour configurer l’aide dans l’étape :
    • None (Aucune) : configurez l’étape sans son aide.
    • Text (Texte) : configurez le texte de l’aide de l’étape dans la zone de texte Text (Texte).

      Vous pouvez utiliser des expressions ArcGIS Arcade pour attribuer une valeur dynamique à l’aide de l’étape. Si l’aide de l’étape contient du texte brut et des expressions Arcade, mettez le texte en forme comme suit :

      
      'For further assistance, please contact' + JobCreator($Job) + '.'

    • URL (URL) : configurez l’étape avec un lien vers une ressource d’aide dans la zone de texte URL (URL).
      Remarque :

      Les étapes qui sont exécutées dans l’application Web prennent en charge uniquement les formats d’URL HTTP et HTTPS. Les étapes qui sont exécutées dans ArcGIS Pro prennent en charge les formats d’URL HTTP et HTTPS ainsi que les formats de fichier.

      Vous pouvez aussi utiliser des expressions Arcade pour fournir une valeur dynamique. Si l’URL contient du texte brut et des expressions Arcade, mettez le texte en forme comme suit :

      
      'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

      Configurez la case à cocher Automatically Encode Arcade Result (Encoder automatiquement le résultat Arcade) comme suit :

      • Si une expression Arcade renvoie des caractères spéciaux à échapper lors de la conversion en URL, comme des espaces ou des barres obliques, assurez-vous que la case Automatically Encode Arcade Result (Encoder automatiquement le résultat Arcade) est cochée.
      • Si une expression Arcade est utilisée pour constituer l’URL de base, décochez la case Automatically Encode Arcade Result (Encoder automatiquement le résultat Arcade).

  14. Cliquez éventuellement sur l’onglet Style pour changer la forme et la couleur de l’étape.
  15. Cliquez éventuellement sur l’onglet About (À propos de) et spécifiez une description pour l’étape dans la zone de texte Step Description (Description de l’étape).
    Conseil :

    L’onglet About (À propos de) contient également l’ID de l’étape qui peut être utilisé avec les propriétés de tâche dynamiques pour obtenir la sortie d’une étape. Cliquez sur Copy Step ID (Copier l’ID d’étape) Copy Step ID pour copier l’ID de l’étape dans le presse-papiers.

Valeur de retour

Une fois l’étape terminée, sa valeur de retour est stockée pour indiquer le résultat de l’étape. La valeur de retour peut être immédiatement évaluée en utilisant des chemins pour déterminer les prochaines étapes du processus. Vous pouvez également récupérer la valeur de retour des étapes terminées tout au long du processus à l’aide d’expressions ArcGIS Arcade. Le tableau suivant répertorie les valeurs de retour de l’étape :

Valeur de retourDescription

S000001

L’étape s’est terminée correctement.

F000001

L’étape ne s’est pas terminée correctement.

Rubriques connexes