Schedule web tools in ArcGIS Pro

Schedule a web tool to run at a later time or with recurrence, based on a list of preset parameters. While you can use the createTask operation from the ArcGIS Portal Directory, scheduling a web tool can save you from having to provide JSON for input parameters and understanding cron expressions. This can also automate routine tasks using existing web tools or geoprocessing services.

When scheduling a web tool on ArcGIS Enterprise, you can choose to have the tool run locally by ArcGIS Pro. This has the advantage of having access to local datasets. You can also schedule a tool run and be managed by ArcGIS Enterprise. This allows the tool to run independently from the availability of your local computer.

However, to schedule a geoprocessing service on a stand-alone server running ArcGIS Server, you can only create a schedule managed by ArcGIS Pro.

Schedule a tool managed by ArcGIS Pro

Starting at ArcGIS Pro 3.5, you can schedule a web tool on any ArcGIS Enterprise account you have access to, or a geoprocessing service you have access to, on a stand-alone server running ArcGIS Server.

If the computer with ArcGIS Pro become unavailable or runs out of disk space, the scheduled tool will not run.

To schedule a web tool or geoprocessing service, complete the following steps:

  1. In the Catalog pane, browse to the web tool or geoprocessing service you want to schedule.
  2. Open the task to schedule, and provide values for the input parameters.
  3. Click the split menu next to the Run button Run and choose the Schedule option Calendar.

    If the Schedule button is disabled, ensure that all of the required parameters have a valid value and that none of the input parameters have errors.

    A pop-up window appears.

  4. In the pop-up window, modify the Task Name value if needed.
  5. Select a Recurrence option: One time, Minutes, Hourly, Daily, Weekly, or Monthly.

    Based on the specified Recurrence option, different configuration settings will be available.

  6. Set the additional configuration settings.
  7. Click the OK button.
  8. Optionally, view the scheduled tasks using the provided link.

    You can edit, pause or resume a schedule that you have created. You can also view the status and messages of all the runs of your tasks, including both successful and failed runs.

    The result shown in the History pane is static information and does not reflect the result of a scheduled run.

Unlike running a web tool or geoprocessing services in ArcGIS Pro, feature and raster outputs, which may be in memory or in the default geodatabase at the time the task was run, may no longer be available when you want to view the results of a past scheduled task run. As a result, web tools with an output feature service or an output image service are better if you need to access those results.

Schedule a tool managed by ArcGIS Enterprise

Starting at ArcGIS Pro 3.4, you can schedule a web tool to run if the web tools are on ArcGIS Enterprise 11.4 or later.

To schedule a web tool, you must be the owner of the web tool or an administrator of your ArcGIS Enterprise. Certain web tools, such as those generating an output feature service or an output image service, may require additional privileges, such as the create item privilege.

Before scheduling a web tool, sign in to ArcGIS Enterprise and browse to the web tool to schedule. All required parameters must be completed without any validation errors.

You cannot schedule a web tool that is based on a synchronous geoprocessing service or a geoprocessing service that is on a stand-alone server, but you can schedule a tool managed by ArcGIS Pro.

You can close ArcGIS Pro or shut down the machine where ArcGIS Pro is running, and this will not interfere with any scheduled web tools. However, if ArcGIS Enterprise becomes unavailable, your scheduled web tools will be impacted.

To schedule a web tool, complete the following steps:

  1. In the Catalog pane, browse to the web tool you want to schedule on the Portal tab.
  2. Open the task to schedule, and provide the values for the input parameters.
  3. Click the split menu next to the Run button Run and choose the Schedule on portal option Schedule on portal.

    If the Schedule on portal button is disabled, the web tool does not support scheduling or there are required input parameters that are unspecified.

    A pop-up window appears.

  4. In the pop-up window, modify the Task Name value if needed.
  5. Select a Recurrence option: One time, Minutes, Hourly, Daily, Weekly, or Monthly.

    Based on the specified Recurrence option, different configuration settings will be available.

  6. Set the additional configuration settings.
  7. Click the Schedule Web tool button.
  8. Optionally, view the scheduled tasks using the provided link.

    You can pause or resume a task that you have created. You can also view all the runs of your tasks, including both successful and failed runs.

By default, a maximum of 30 tasks can be scheduled. To increase this limit up to 50, contact your ArcGIS Enterprise administrator. Administrator cannot schedule more than 50 tasks.

To modify the parameters of an existing task, delete a task, and other task management options, use the ArcGIS Portal Directory and access necessary operations, such as updateTask.

Considerations for scheduling a tool

To schedule a web tool with an output feature service or an output image service to run more than once, enable the overwrite option when configuring the input parameters. Otherwise, your schedule will fail to run unless you manually delete the feature service or image service to be created every time before a scheduled task will be run. You can only overwrite existing services, so you may need to create a feature service or an image service before you create a schedule overwriting result feature or image service.

When providing an input layer for your scheduled task, choose a data source by browsing to a dataset on disk, or a portal item. Avoid selecting a layer from the input parameter's choice list, regardless its data source. This will ensure that the input specified is accessible and used when the schedule task is running. Otherwise, default values from the web tool or geoprocessing service may apply.