Geoprocessing tools can be run immediately or scheduled to run at a later time or with recurrence. Scheduling a geoprocessing tool provides you the ability to do the following:
- Automate a tool you need to run regularly
- Run a long-running or computationally intensive process at a convenient, specified time when you will not be using the machine for other tasks
- Run multiple geoprocessing tools concurrently outside the ArcGIS Pro application using a stand-alone Python executable
To schedule a geoprocessing tool, you will fill in all required tool parameters, choose the Schedule Run command, and provide settings about when the scheduled tool should run. You can manage the tools you have scheduled in the Geoprocessing>Scheduled section of the History pane.
Every geoprocessing tool can be scheduled. To schedule a geoprocessing tool, follow the steps below.
Scheduling a geoprocessing tool requires that all changes to the project must be saved. The geoprocessing tool may use project items such as layers as input, so it is required to save the project so those items will exist in project storage.
Scheduling a geoprocessing tool is not possible if you are using named user licensing and you have not selected Sign me in automatically. This is required for the scheduled tool to run outside the ArcGIS Pro application.
- Find the desired geoprocessing tool and open the tool.
- Specify all desired tool parameters.
- Choose to run the tool immediately or schedule the geoprocessing tool to run at a later time. Use the Run button's split menu to choose Schedule .
- In the Schedule window, specify the task name, start date and time, recurrence, expiration, and other options for how and when the scheduled tool should run. Click Schedule to finish and schedule the tool.
The scheduled tool will be added to the Geoprocessing > Scheduled Tasks section of the History pane, the tool scheduling will be enabled, and the tool will begin running at the date and time you specified in the Schedule Options window.
Manage scheduled tools
Scheduled geoprocessing tools are listed in the Geoprocessing>Scheduled section of the History pane. The Scheduled section will display all tools that are scheduled to run on the machine using your user account, regardless of the project from which the tools were scheduled. You must be logged in to the machine for scheduled tools to run.
Each tool in the Scheduled section will include a list of the execution history of the tool. Each time the scheduled tool runs, a new time-stamped item will be added below the entry for the scheduled tool with an icon indicating whether the execution completed successfully or failed.
The tool completed successfully.
The tool completed with warnings. Click View Details or hover over the status icon to view the warning messages.
The tool failed. Click View Details or hover over the status icon to view the error messages.
You can manage scheduled geoprocessing tools in the following ways:
- Change schedule options such as date and time, recurrence, expiration, and other options.
- Run the scheduled tool. This is useful for testing fast-running processes that you have scheduled to run some time in the future, to ensure the tool can complete successfully.
- Pause the scheduled tool. When a scheduled tool is paused, it will not run on the schedule again until the tool is resumed.
- Clear the execution history of a scheduled tool. This has no effect on future executions of the tool.
- Delete the scheduled tool. This stops any future scheduled executions of the tool, clears the execution history of the scheduled tool, and removes the tool from the Scheduled section.
Extend scheduled geoprocessing
Scheduling a geoprocessing tool creates a folder and several files including a Python script in the user directory %localappdata%\Esri\ArcGISPro\Geoprocessing\<your scheduled tool name>. You can extend the scheduled operation to include multiple geoprocessing tools by editing the Python script in the scheduled tool folder and adding additional geoprocessing tools to the script.
- If scheduling an extension tool directly, or a model tool that includes an extension tool, no special steps are required.
- If scheduling a script tool that includes an extension tool, the script must include CheckOutExtension calls to check out the appropriate extensions.
If you are using a Named User or Single Use license, extension tools can be used without any special considerations.