Add and configure Open Web Page

The Open Web Page step can be used to integrate web pages and web apps in ArcGIS Pro and the ArcGIS Workflow Manager web app. This allows Workflow Manager users to seamlessly interact with the web page or web app.

When the step is run in the Workflow Manager web app, the <Job_Name> URL Redirect dialog box appears with options to proceed or cancel. If you click Proceed, the web page or web app defined in the step opens on the Work page. Step information is displayed in the Details panel and can be minimized by clicking Minimize Collapse Panel. If you click Cancel, the step fails and a message appears on the Log Messages tab. To dismiss the <Job_Name> URL Redirect dialog box, check the Do not show this warning again check box.

When the step is run in ArcGIS Pro, the web page or web app defined in the step opens in a view in ArcGIS Pro.

Note:

When this step is being run by another person, the Running icon Running appears on the job.

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

  • The step can be paused by clicking Pause.
  • The step can be finished by clicking Finish.
Note:

If the step isn't optional, the step must be run or paused at least once before it can be finished.

Configure the step

To configure the step, do the following:

Caution:

To reduce security vulnerabilities, the Open Web Page step should only be configured for trusted web pages and web apps.

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

    The Step Details panel appears.

  3. Provide a name for the step in the Step Name text box.
  4. Provide the URL of the web page or web app in the Web Page URL text box.
    Note:

    Only HTTP and HTTPS URL formats are supported.

    You can also use ArcGIS Arcade expressions to provide a dynamic value. If the Web Page URL value contains plain text and ArcGIS Arcade expressions, you'll need to format the text as follows:

    'https://webadaptorhost.domain.com/webadaptorname/<BranchVersionedFeatureServiceName>/?versions=' + JobVersion($Job, '<DataSourceName>') + '&extent=' + JobLocation($Job)

  5. Optionally, configure the Automatically Encode Arcade Result setting as necessary.
    • If an Arcade expression is used to construct any part of the base URL in the Web Page URL text box, uncheck the Automatically Encode Arcade Result check box.
    • If any of the Arcade expressions in the Web Page URL text box return a result that includes 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.
  6. Optionally, check the Open In New Browser check box to open the web page or web app in a new browser window when the step is run in the Workflow Manager web app.
  7. Click the Options tab.
  8. 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 the workflow diagram is configured to automatically run a sequence of steps that includes the Run GP Service step, steps that attempt to run after the user token expires will not run automatically. The ArcGIS Workflow Manager Advanced organization extension is required to run additional automated steps without manual intervention.

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

      Learn more about scheduling options

  9. 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, format the text as follows:

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

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

      Steps that are run in the web app only support HTTP and HTTPS URL formats. Steps that are 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, 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 as follows:

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

  10. Optionally, click the Style tab to change the shape and color of the step.
  11. 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 Copy Step ID to copy the step ID to the 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 valueDescription

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:

OutputDescription

<URL>

Returns the URL of the web page or web app that was opened.

Related topics