The Open Pro Project Items step allows you to open existing ArcGIS Pro project items such as maps, layouts, scenes, tasks, and web maps that are configured in the project. If the item is a mapping item, data layers can automatically point to the appropriate job-specific version of the data if one is available.
Note:
You can only run this step type from ArcGIS Pro. For a similar experience in the ArcGIS Workflow Manager web app, use the Open Web Page step.
When you run the step, the items defined in the step open in an ArcGIS Pro project. If View Error Inspector is enabled the Error Inspector pane appears and a layer with error features is added to the map. If help text is configured for the step, it appears at the bottom of the job tile.
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 any combination of ArcGIS Pro maps, layouts, web maps, and tasks to the step. The order of the items opened in ArcGIS Pro is defined by the order in which you add them to the step.
To configure the step, do the following:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Open Pro Project Items from the Step Library panel to a connection arrow of a step on the workflow canvas.
The Step Details panel appears.
- Provide a name for the step in the Step Name text box.
- In the Arguments section, click Edit.
The ArcGIS Pro Mapping Step dialog box appears.
- 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 present in the ArcGIS Pro project when the step is run or the step fails.
- Provide the name of the item you want to work with in the Name text box.
- Choose the type of item you want to work with in the Type drop-down list.
- If the Create Version step is used in your workflow diagram to create a job-specific version of your data, check the Repoint Version check box to repoint mapping item data layers to the job-specific version when the step is run.
Note:
The Repoint Version check box is unavailable for task items.
- Optionally, repeat steps 5 through 8 to add more items.
Note:
To delete an item, hover over it and click the Delete Item button
. - Optionally, click the Finish tab and check the Reset to Default check box to point the mapping item data layers back to the original version when the step is completed.
Note:
The Reset to Default check box is unavailable for task items.
- Optionally, click the Advanced tab and configure options as necessary.
- Zoom to Location—Zooms the map items to the job's location if a location is defined for the job.
- View Error Inspector—Opens the Error Inspector pane for viewing error features on the map.
For feature service data sources, error layers must be stored in the service and the data source must be branched-versioned with the validation capability.
- Click Save.
Note:
The Save button isn't available when parameters are configured with invalid values.
- Click the Options tab.
- 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 the additional automated steps without manual intervention.
- Run on a Schedule—Run the step according to a schedule you set.
- Manual—Run the step manually.
- Optionally, check the Enabled check box in the Step Commenting section to allow a user to add a comment when the step is run.
- Optionally, if you enabled step commenting, check the Required check box in the Step Commenting section to require a comment.
- 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) + '.' - Optionally, click the Style tab to change the shape and color of the step.
- Optionally, click the About tab and provide a description for the step in the Step Description text box.
Note:
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. |