Schedule a web tool to run at a later time or with recurrence, based on a list of preset parameters. Although you can use the createTask operation from the ArcGIS Portal Directory, scheduling a web tool to run can alleviate you from the effort of providing JSON for all input parameters and understanding cron expressions.
Requirements
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 your ArcGIS Enterprise and browse to the web tool to schedule. All required parameters must be completed without any validation errors.
You cannot schedule a synchronous web tool, or for geoprocessing services on a stand-alone server.
You can close ArcGIS Pro or shut down the machine where ArcGIS Pro is running, without interfering with any scheduled web tools. However, if your ArcGIS Enterprise is offline, your scheduled web tools will be impacted.
Create a web tool schedule
To schedule a web tool, complete the following steps:
- Browse to the web tool you want to schedule on the Portal tab in the Catalog pane.
- Open the task to schedule, and provide the values for input parameters.
- Click the Run button split menu and choose
Schedule .
If the Schedule button is disabled, the web tool does not support scheduling.
A pop-up window appears.
- In the pop-up window, modify the Task Name value if needed.
- Select a Recurrence option. Supported recurrences include one time, by the minutes, hourly, daily, and monthly.
Based on the Recurrence value you choose, different configuration options will be available.
- You can configure the start time, end time, repeated frequency, maximum occurrences, month, and day of a month. Day of a week is not available.
- Click the Schedule Web tool button.
- Optionally, view your scheduled tasks using the link that is provided. 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.
Considerations for scheduling a web tool
To use a web tool with an output feature service, enable the overwrite option when configuring your input parameters.
There is a limit of 30 tasks that can be scheduled. To increase this limit, contact your ArcGIS Enterprise administrator.
To edit the parameters of an existing task, delete a task, and other advanced task management options, use the ArcGIS Portal Directory and access necessary operations, such as updateTask.