Add and configure Open Pro Project Items

The Open Pro Project Items step allows you to open existing projects or project packages in ArcGIS Pro. You can configure the items that you want to add to the project, such as maps, layouts, scenes, task items, and web maps, to ensure that work is being performed on the correct items. If the project contains mapping items, data layers can automatically point to the appropriate job-specific versions of the data.

When you run the step in ArcGIS Pro, the items defined in the step open in the specified ArcGIS Pro project. If the step is configured with the Run ArcGIS Pro Command option, the ArcGIS Pro custom add-in command configured in the step runs when the project is opened. If the step is configured with the View Error Inspector option, the Error Inspector pane appears when the project is opened and a layer with error features is added to the map in ArcGIS Pro. When the step is configured with step help, the step help appears at the bottom of the job tile.

When you run the step in the ArcGIS Workflow Manager web app, the Download ArcGIS Pro Project button appears in the job tile. Download the .pitemx file and double-click the file to open the project in ArcGIS Pro. If the step is configured with the Run ArcGIS Pro Command option, ArcGIS Pro runs the configured custom add-in command. If the step is configured with the View Error Inspector option, the Error Inspector pane appears and a layer with error features is added to the map. When the step is configured with step help, it appears at the bottom of the job tile.

Caution:

Before opening the downloaded .pitemx file in ArcGIS Pro, add a portal connection to the portal that contains the workflow item.

The .pitemx file can only be used once to open the project in ArcGIS Pro. To open the project again, you must download a new .pitemx file from the job tile in the Workflow Manager web app.

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

You can add project packages hosted on an ArcGIS Enterprise portal, ArcGIS Online, or a file system. You can configure the items that you want to add to the project, such as maps, layouts, scenes, web maps, and task items. The order in which the items are opened in ArcGIS Pro is defined by the order in which you add them to the step.

To configure the step, do the following:

1. Create or edit a workflow diagram to access the Step Library panel.
2. Drag Open Pro Project Items 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. Optionally, add the message that you want to appear when the step is run in the User Prompt text box.

   If the user prompt contains plain text and ArcGIS Arcade expressions, format the text as follows:

   'This job is currently assigned to ' + JobOwner($Job) + '.'

   Tip:

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

5. In the Arguments section, click Edit.

   The ArcGIS Pro Mapping Step dialog box appears.

6. In the Pro Project section, choose one of the following options to specify where the project is located:
   • Current—The project package that's currently open inside of ArcGIS Pro.

     Learn more about opening a project in ArcGIS Pro

   • Portal—A project package hosted on an ArcGIS Enterprise portal or ArcGIS Online.
   • Filepath—A project package hosted on a network file share or a local file system.

     You can also use ArcGIS Arcade expressions to provide a dynamic value.

7. If you chose Portal, choose an ArcGIS Pro project data reference from the Pro project drop-down menu.
8. If you don't have an ArcGIS Pro project associated with the workflow diagram, add an ArcGIS Pro project data reference:
   1. Click Add data reference from the drop-down menu.

      The Add data reference dialog box appears.

   2. Add a data reference by doing one of the following:
      • Browse for item—Browse and choose from a list of items on the current portal.

        Tip:

        You can refine results by applying filters and tags to the search.

      • Enter item ID manually—Choose the environment where the data reference is located and provide the item ID and reference name in the Item ID and Reference Name text boxes. If you chose Other, provide the URL to the ArcGIS organization that contains the data reference in the Portal URL text box.

        The item is automatically validated by Workflow Manager and the data reference type is set in the Type bar.

        If the data reference cannot be validated, you must provide the item ID to a valid data reference that matches the set data reference type.

   3. Click OK to save the data reference, or click Cancel to exit.
9. If you chose Filepath, provide the local or network path to the project package in the Filepath text box.
10. In the Open Items section, click Open New Item to add the items you want to open in the project.

    Note:

    The items must be in the ArcGIS Pro project when the step is run or the step fails.

11. Click the Change Input Type drop-down arrow and choose an input type for the Name text box:

    • Selection—Choose from a list of ArcGIS Pro data references associated with the workflow diagram. If you don't have an ArcGIS Pro data reference associated with the workflow diagram, click Add ArcGIS Pro data reference.

      Choose the item type from the Pro Item Type drop-down menu and provide the name of the item in the Pro Item Name text box.

      Learn more about managing data references

    • Arcade—Choose the item type from the Type drop-down menu and provide a dynamic value for the item name using an Arcade expression.
12. Optionally, repeat the steps to add more items.

    Tip:

    To delete an item, hover over it and click Delete Item .

13. Optionally, if you chose Portal or Filepath as the Pro Project setting, check the Close ArcGIS Pro Project check box to close the project when the step is paused or completed.

    When the step is paused or completed, the project is closed and ArcGIS Pro remains open so that you can resume the step or complete more steps.

14. Optionally, click the Advanced tab and configure options as necessary.
    • Zoom to Location—Zooms the map to the job's location if a location is defined for the job.
    • View Error Inspector—Opens the Error Inspector pane for reviewing error features on the map.

      For feature service data sources, error layers must be stored in the service and the data source must be a branch version with the validation capability.

    • Run ArcGIS Pro Command—Runs ArcGIS Pro custom add-in commands when the items configured in the step are opened. Choose an ArcGIS Pro command from the drop-down menu.

      If you don't have an ArcGIS Pro command data reference associated with the workflow diagram, click Add ArcGIS Pro data reference and provide the command name and command ID in the Command Name and Command ID text boxes.

      Optionally, click Add Command to add more ArcGIS Pro commands.

      Note:

      Only command IDs from custom add-ins can be used. If multiple commands are specified, the commands run in the order in which they are configured in the step.

      Learn more about showing command IDs on ScreenTips in ArcGIS Pro

15. Optionally, turn on Restrict Edits to Job Location to restrict edits to the job's location.
    1. Click the Operator drop-down arrow and choose one of the following options:
       • Intersect with Job Location—Allows edits to features that intersect the job location.
       • Completely within Job Location—Allows edits to features that are entirely within the job location.
    2. Optionally, provide a value in the Buffer text box to allow edits to features within the specified distance of the job's location.

       You can also use ArcGIS Arcade expressions to provide a dynamic value.

       If the buffer contains an Arcade expression, it must evaluate to an integer.

16. Click Save.

    Note:

    Save isn't available when parameters are configured with invalid values.

17. Click the Options tab.
18. 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

19. Optionally, check the Enabled check box in the Step Commenting section to allow a user to add a comment to the step when the step is run.
20. Optionally, if you enabled step commenting, check the Required check box in the Step Commenting section to require a comment to be added to the step before it can be completed.
21. 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.

22. Optionally, click the Style tab to change the shape and color of the step.
23. 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 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 value	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.