Ajouter et configurer une étape de nettoyage

Licence :

Les membres d’une organisation doivent disposer d’une licence attribuée pour l’extension de type d’utilisateur ArcGIS Advanced Editing pour utiliser cette étape.

L’étape Cleanup (Nettoyage) peut être utilisée pour supprimer la version de la tâche active, l’emplacement défini dans la tâche, les réplicas associés à la tâche et les fichiers de réplica de l’emplacement des fichiers partagés. Lorsqu’elle est utilisée pour supprimée la version de la tâche active, l’étape Cleanup (Nettoyage) supprime la version cible dans le service d’entités de branche versionnée.

Remarque :

Les versions détenues par d'autres utilisateurs ne peuvent être supprimées que par un administrateur du portail. Si une version de tâche active est détenue par un autre utilisateur, la version ne peut pas être supprimée et l'étape de nettoyage échoue.

À la fin de l’exécution de l’étape, un message apparaît sur la tuile de la tâche avec le résultat de l’étape. Si l'étape ne réussit pas à supprimer toutes les versions de tâche associées à la tâche, le message CleanupFailed apparaît dans le titre de la tâche et cette dernière ne passe pas à l'étape suivante. Survolez le message d’erreur pour afficher des informations supplémentaires sur l’erreur. En cas d’échec de l’étape, si les codes de retour ne correspondent à aucun chemin configuré et que l’étape n’est pas facultative, l’étape reste à l’état d’échec et ne peut pas être ignorée.

Configurer l’étape

Procédez comme suit pour configurer l’étape :

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

   En savoir plus sur l’ajout d’étapes à un diagramme de processus

   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. Cochez une ou plusieurs options dans la section Arguments :
   • Job Versions (Versions de la tâche) : supprime la version active de la tâche et la version cible dans le service d’entités de branche versionnée.
   • Job Location (Emplacement de la tâche) : supprime l’emplacement défini dans la tâche.
   • Unregister Job Replicas (Désinscrire les réplicas de la tâche) : supprime l’association du réplica avec la tâche.
   • Delete Replica Files from Shared Location (Supprimer les fichiers de réplica de l’emplacement partagé) : supprime le réplica de l’emplacement des fichiers partagés
5. Cliquez sur l'onglet Options.
6. Configurez Step Options (Options de l’étape) si nécessaire.
   • 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 votre diagramme de processus est configuré pour exécuter automatiquement une séquence d’étapes qui comprend l’étape Evaluate Data Quality (Évaluer la qualité des données) ou Run GP Service (Exécuter un service de géotraitement), les étapes censées s’exécuter après l’expiration du jeton utilisateur ayant démarré la séquence d’étapes ne démarrent pas automatiquement. Vous devez disposer d’une licence pour que le rôle ArcGIS Workflow Manager Server Advanced continue d’exécuter davantage d’étapes automatisées sans intervention manuelle.

   • Run on a Schedule (Exécuter selon une planification) : l’étape s’exécute selon une planification que vous définissez.

     En savoir plus sur les options de planification

7. 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, vous devez formater le texte 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 exécutées dans l’application Web prennent uniquement en charge les URL aux formats HTTP et HTTPS. Les étapes exécutées dans ArcGIS Pro prennent uniquement en charge les formats HTTP, HTTPS et fichier.

     Vous pouvez aussi utiliser des expressions Arcade pour fournir une valeur dynamique. Si l’URL contient du texte brut et des expressions Arcade, vous devez mettre en forme le texte 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) :

     • 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).

8. Cliquez éventuellement sur l’onglet Style pour changer la forme et la couleur de l’étape.
9. 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) 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 retour	Description
S000001	L’étape s’est terminée correctement.
F000001	L’étape ne s’est pas terminée correctement.