Ajouter et configurer une étape Survey123

L’étape Survey123 vous permet de collecter, d’examiner et de mettre à jour des enquêtes ArcGIS Survey123 dans ArcGIS Workflow Manager.

L’étape Survey123 requiert la création d’une table de propriétés étendues à partir du formulaire de l’enquête pour pouvoir associer les données de l’enquête à des tâches. Lorsqu’une enquête est envoyée, la table de propriétés étendues associées est renseignée avec les données collectées par l’enquête. Si aucune table de propriétés étendues n’est créée à partir du formulaire de l’enquête, les enquêtes peuvent être collectées, mais les données collectées ne sont pas accessibles aux tâches.

Conseil :

Pour afficher ou mettre à jour des données à partir d’enquêtes collectées en dehors de votre processus, créez une table de propriétés étendues à partir du formulaire de l’enquête. Ajoutez l’étape Update Job Properties (Mettre à jour les propriétés de l’étape) avant l’étape Survey123 dans votre diagramme de workflow et mettez à jour la valeur Link ID (ID de liaison) dans la table de propriétés étendues avec la valeur globalid d’une enquête existante.

Lorsque l’étape est exécutée dans l’application Web Workflow Manager, l’enquête configurée dans l’étape apparaît dans la vignette de la tâche. Si l’étape est exécutée dans ArcGIS Pro, un bouton Open on Web (Ouvrir sur le Web) apparaît sur la vignette de la tâche ; il permet d’ouvrir l’enquête configurée dans l’étape dans l’application Web Workflow Manager. Si l’étape est configurée avec l’aide des étapes, elle apparaît en bas de la vignette de la tâche.

Remarque :

L’utilisateur qui exécute l’étape doit disposer de privilèges suffisants dans Survey123 pour examiner, mettre à jour ou envoyer le formulaire de l’enquête configuré dans l’étape.

En savoir plus sur le partage d’enquêtes dans Survey123

Attention :

Si l’enquête configurée dans l’étape n’est pas hébergée sur le même portail ArcGIS Enterprise que ArcGIS Workflow Manager Server, il est recommandé de se connecter à l’application Web Workflow Manager et à Survey123 avec des navigateurs Web différents. Si vous êtes connecté à plusieurs portails dans le même navigateur Web lorsque l’étape est exécutée, vos identifiants de connexion Survey123 sont utilisés pour accéder à l’enquête au lieu de vos identifiants de connexion Workflow Manager.

Lorsque l’étape est exécutée, les actions suivantes peuvent être effectuées :

• L’enquête configurée peut être envoyée, affichée ou mise à jour.
• Pour annuler l’étape, cliquez sur Cancel (Annuler).
• Pour terminer l’étape, cliquez sur Proceed (Continuer).

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 Survey123 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.

   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. Dans la section Survey123 Form (Formulaire Survey123), cliquez sur Add Survey123 Form (Ajouter un formulaire Survey123).

   La boîte de dialogue Add Survey123 Form (Ajouter un formulaire Survey123) apparaît.

5. Sélectionnez l’une des options suivantes pour indiquer où se trouve votre formulaire Survey123 :
   • This Enterprise (Ce portail Enterprise) : ajoutez une enquête disponible sur le même portail que Workflow Manager.
   • ArcGIS Online : ajoutez une enquête publique située sur ArcGIS Online.
   • Other (Autre) : ajoutez une enquête publique située sur un autre portail.
6. Si vous avez sélectionné Other (Autre), spécifiez l’URL du portail qui contient l’enquête dans la zone de texte Portal URL (URL du portail) et appuyez sur Entrée.

   Pour ArcGIS Enterprise, utilisez le format https://webadaptorhost.domain.com/webadaptorname.

7. Spécifiez l’identifiant de formulaire de l’enquête dans la zone de texte Form ID (Identifiant de formulaire).
8. Saisissez un nom pour l’enquête dans la zone de texte Reference Name (Nom de référence).
9. Cliquez sur OK.

   L’enquête apparaît dans le volet Step Details (Détails de l’étape).

   Remarque :

   Pour supprimer une enquête, cliquez sur le bouton Delete Survey (Supprimer l’enquête) .

10. Cliquez sur le bouton bascule Relationship (Relation) pour passer d’une relation d’enquête un vers un (1-1) à une relation d’enquête un-à-plusieurs (1-M (Un vers plusieurs)) et inversement avec des tâches Workflow Manager.
    • 1-1 : définissez la relation un vers un pour autoriser l’association d’une seule enquête à une tâche.
    • 1-M (Un vers plusieurs) : définissez la relation un vers plusieurs pour autoriser l’association de plusieurs enquêtes à une tâche.
11. Sélectionnez l’une des options suivantes pour le paramètre Mode :
    • Create New (Créer) : permet de créer et collecter une enquête.

      Remarque :

      Cette option est disponible uniquement pour les enquêtes dotées d’une relation un vers plusieurs (1-M (Un vers plusieurs)).

    • Edit (Mettre à jour) : permet de mettre à jour une enquête.

      Remarque :

      S’il n’existe aucune enquête pour la tâche, une enquête est créée et collectée. Si l’enquête est configurée avec une relation un vers plusieurs (1-M (Un vers plusieurs)), la dernière enquête collectée est mise à jour.

    • View (Afficher) : permet d’afficher une enquête.

      Remarque :

      Si l’enquête est configurée avec une relation un vers plusieurs (1-M (Un vers plusieurs)), la dernière enquête collectée est ouverte et affichée.

12. Cliquez sur l'onglet Options.
13. 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

14. 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) + '.'

      Conseil :

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

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

15. Cliquez éventuellement sur l’onglet Style pour changer la forme et la couleur de l’étape.
16. 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.

Valeur en sortie

Une fois que l’étape est terminée, sa valeur en sortie est stockée et peut être utilisée pour déterminer le chemin suivi par le processus. Elle peut également servir d’entrée pour d’autres étapes tout au long du processus. Le tableau suivant indique la valeur en sortie de l’étape :

Sortie	Description
<GlobalID>	Renvoie l’élément globalid de la dernière enquête créée, affichée ou mise à jour.