Ajouter et configurer une étape Survey123

L’étape Survey123 vous permet de collecter, d’afficher 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 workflow, 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. Lorsque 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 un texte d’aide est configuré pour l’étape, il 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 afficher, 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 :

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

When the step is run, the following actions can be performed:

• L’enquête configurée peut être envoyée, affichée ou mise à jour.
• The step can be cancelled by clicking Cancel.
• The step can be finished by clicking Proceed.

Configurer l’étape

To configure the step, do the following:

1. Create or edit a workflow diagram to access the Step Library panel.
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.

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
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 sélectionnez Other (Autre), saisissez l’URL du portail qui contient l’enquête dans la zone de texte Portal URL (URL du portail) et appuyez sur Entrée.

   Le format peut par exemple être https://webadaptorhost.domain.com/webadaptorname.

7. Saisissez 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. Click the Options tab.
13. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      Remarque :

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

14. Optionally, provide help text for the step in the Step Help text box.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

15. Optionally, click the Style tab to change the shape and color of the step.
16. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Remarque :

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

Valeur en sortie

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

Sortie	Description	Syntaxe de l’expression ArcGIS Arcade
<GlobalID>	Renvoie l’élément globalid de la dernière enquête créée, affichée ou mise à jour.	jobOutputValue($job, '<step_id>')