Add and configure Survey123

The Survey123 step allows you to collect, review, and edit ArcGIS Survey123 surveys in ArcGIS Workflow Manager.

The Survey123 step requires an extended properties table to be created from the survey's form to associate survey data with jobs. When a survey is submitted, the associated extended properties table is populated with the data that was collected by the survey. If an extended properties table is not created from the survey's form, surveys can be collected, but the collected data is not accessible to jobs.

Tip:

To show or edit data from surveys that are collected outside of your workflow, create an extended properties table from the survey's form. Add the Update Job Properties step before the Survey123 step in your workflow diagram and update the Link ID value in the extended properties table with an existing survey's globalid.

When the step is run in the Workflow Manager web app, the survey configured in the step appears in the job tile. When the step is run in ArcGIS Pro, an Open on Web button appears on the job tile that opens the survey configured in the step in the Workflow Manager web app. If the step is configured with step help, it appears at the bottom of the job tile.

Note:

The user who runs the step must have sufficient privileges in Survey123 to review, edit, or submit the survey form configured in the step.

Learn more about sharing surveys in Survey123

Caution:

When the survey configured in the step is not hosted on the same ArcGIS Enterprise portal as ArcGIS Workflow Manager Server, it is recommended that you sign in to the Workflow Manager web app and Survey123 using different web browsers. If you are signed in to multiple portals in the same web browser when the step is run, your Survey123 credentials are used to access the survey instead of your Workflow Manager credentials.

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

• The configured survey can be submitted, viewed, or edited.
• The step can be canceled by clicking Cancel.
• The step can be finished by clicking Proceed.

Configure the step

Do the following to configure the step:

1. Create or edit a workflow diagram to access the Step Library panel.
2. Drag Survey123 from the Step Library panel to a connection arrow of a step on the workflow canvas.

   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. In the Survey123 Form section, click Add Survey123 Form.

   The Add Survey123 Form dialog box appears.

5. Choose one of the following options to specify where your Survey123 form is located:
   • This Enterprise—Add a survey that is available on the same portal as Workflow Manager.
   • ArcGIS Online—Add a public survey located on ArcGIS Online.
   • Other—Add a public survey located on another portal.
6. If you chose Other, provide the URL for the portal that contains your survey in the Portal URL text box and press Enter.

   For ArcGIS Enterprise, use the format https://webadaptorhost.domain.com/webadaptorname.

7. Provide the form ID for the survey in the Form ID text box.
8. Provide a name for the survey in the Reference Name text box.
9. Click OK.

   The survey appears in the Step Details panel.

   Note:

   A survey can be deleted by clicking the Delete Survey button .

10. Click the Relationship toggle button to switch between a one-to-one (1-1) or a one-to-many (1-M) survey relationship with Workflow Manager jobs.
    • 1-1—Set the relationship to one-to-one to allow only one survey to be associated with a job.
    • 1-M—Set the relationship to one-to-many to allow multiple surveys to be associated with a job.
11. Choose one of the following options as the Mode setting:
    • Create New—Create and collect a survey.

      Note:

      This option is only available for surveys with a one-to-many (1-M) relationship.

    • Edit—Edit a survey.

      Note:

      If no survey exists for the job, a survey is created and collected. If the survey is configured with a one-to-many (1-M) relationship, the last collected survey is edited.

    • View—View a survey.

      Note:

      If the survey is configured with a one-to-many (1-M) relationship, the last collected survey is opened for viewing.

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.

      Note:

      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 more 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, choose one of the following options to configure help in the step:
    • None—Configure the step without step help.
    • Text—Configure help text for the step in the Text text box.

      You can use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you must format the text as follows:

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

      Tip:

      Click This input supports Arcade Expressions and choose an ArcGIS Arcade expression to add it to its associated text box.

    • URL—Configure the step with a link to a help resource in the URL text box.

      Note:

      Steps run in the web app only support HTTP and HTTPS URL formats. Steps run in ArcGIS Pro support HTTP, HTTPS, and file formats.

      You can also use Arcade expressions to provide a dynamic value. If the URL contains plain text and Arcade expressions, you must format the text as follows:

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

      Configure the Automatically Encode Arcade Result check box:

      • If an Arcade expression returns special characters that must be escaped when converted to a URL, such as a space or a forward slash, ensure that the Automatically Encode Arcade Result check box is checked.
      • If an Arcade expression is used to form the base URL, uncheck the Automatically Encode Arcade Result check box.

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.

    Tip:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output. Click Copy Step ID to copy the step ID to your clipboard.

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 value	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

Output value

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

Output	Description
<GlobalID>	Returns the globalid of the survey that was last created, viewed, or edited.