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 your project contains mapping items, data layers can automatically point to the appropriate job-specific versions of the data.
Note:
If a project package is being used to edit and sync replica layers offline, the project package cannot be shared with the Share outside organization option enabled.
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. If the step is configured with step help, it appears at the bottom of the job tile.
When you run the step in the ArcGIS Workflow Manager web app, a download 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. If 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 your 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.
Do the following to configure the step:
- 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.
- 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 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 ArcGIS Arcade expression to add it to its associated text box. - In the Arguments section, click Edit.
The ArcGIS Pro Mapping Step dialog box appears.
- 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.
- 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.
- If you chose Portal, click Add Pro Project and do the following:
- Choose one of the following options to specify where the project package is located:
- This Enterprise—A project package hosted on the same portal as Workflow Manager.
- ArcGIS Online—A project package hosted on ArcGIS Online.
- Other—A project package located on another portal.
- If you chose Other, provide the URL for the portal that contains the project package in the Portal URL text box and press Enter.
For ArcGIS Enterprise, use the format https://webadaptorhost.domain.com/webadaptorname.
- Optionally, provide a different name for the project package in the Item ID text box.
- Optionally, provide a different reference name for the project package
in the Reference Name text box.
This is the name that's displayed in the step's configuration.
- Click OK.
The project package appears on the ArcGIS Pro Mapping Step dialog box.
Note:
You can edit the project package by clicking Edit or delete the project package by clicking Delete.
- Choose one of the following options to specify where the project package is located:
- If you chose Filepath, provide the local or network path to the project package in the Filepath text box.
- 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.
- Click the Change Input Type drop-down arrow and choose an input type for the Name text box:
- String—Provide a string value for the item name.
- Arcade—Provide a dynamic value for the item name using an Arcade expression.
- 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 menu:
- Map—A map
- Layout—A page layout
- Scene—A local or global scene
- Task—A task item
- 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, if the Create Replica step is used in your workflow diagram to edit replica layers, check the Synchronize Replica Changes check box to synchronize changes when the project is opened in ArcGIS Pro.
The Synchronize Replica Changes check box is only available with the Portal and Filepath Pro Project options.
- Optionally, repeat the steps to add more items.
Tip:
To delete an item, hover over it and click Delete Item
. - 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, 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 to allow the user to resume the step or to complete more steps.
- Optionally, if you are using the step to edit replica layers in ArcGIS Pro, check the Synchronize Replica Changes check box to synchronize edits when the step is paused or completed.
The Synchronize Replica Changes check box is only available with the Portal and Filepath Pro Project options.
- 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.
Click Add Command and specify the command IDs of the custom add-in commands that you want to run. Optionally, reorder the commands or delete them.
Learn more about showing command IDs on ScreenTips in ArcGIS Pro
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.
- Optionally, turn on Restrict Edits to Job Location to restrict edits to the job's location.
- 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.
- 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.
- Click the Operator drop-down arrow and choose one of the following options:
- Click Save.
Note:
Save 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 more 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 to the step 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 to be added to the step before it can be completed.
- 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) + '.' - 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.
- 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.
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. |