UiPath Orchestrator Guide

Field Descriptions

The Schedules Page

Field
Description

Search

search

Looks for schedules that match your input. You can search according to the schedule name, process and environment name.

Filter

filter

Enables you to filter the page according to the state of the schedule (Enabled or Disabled).
The icon changes as follows:

  • filter_not_applied - a filter is not applied
  • filter_applied - a filter is applied; if you click the Filters button when it is in this state, all filters are removed.

Add

add

Opens the Add Schedule window, which enables you to create a new schedule. For more information, see The Add Schedule Window.

Active

Indicates if a schedule is active or not. A disabled schedule displays the disabled icon. An enabled schedule displays the enabled icon.
When hovering over one of these icons, a check box that enables you to select a schedule is displayed.

Name

The name of the schedule as it was filled in when it was created.

Process

The name of the process that has been scheduled to be executed.

Environment

The name of the environment that is used in a given schedule.

Trigger Details

Displays the time when the execution of the process is scheduled. The time is displayed according to the time zone you selected when creating the schedule. For schedules that have been disabled, Disabled is displayed instead.

Next Run Time

Displays the amount of time until the next execution of the process. Hovering over this field displays the exact time and date. If the schedule is in a different timezone than the one configured per tenant, the difference is displayed in the tooltip.

Stop After

Displays the amount of time to pass before the schedule stops.

Edit

edit

Opens the Edit Schedule window, which enables you to make changes to a schedule.

More Actions

more_actions

It is displayed when hovering over a schedule. It enables you to access a menu with multiple options:

  • View Jobs - Displays all the jobs started by the corresponding schedule in the Jobs page.
  • Enable - Enables the selected schedule. This option is available only if the selected schedule is disabled.
  • Disable - Disables an active schedule. This option is available only if the selected schedule is enabled.
  • Remove - Removes the corresponding schedule - schedules can be removed even if they are active.

When selecting schedules, the Remove, Disable and Enable buttons are also available at the top of the page, instead of the Search and Filter options.

The Add Schedule Window

The Schedule Tab

Field
Description

Name

Mandatory.
Adds a custom name to your schedule, so that you can easily identify them.

Process

Mandatory.
Displays a drop-down list of all the available processes and enables you to select the one that you want to schedule.

Timezone

Mandatory.
The timezone according to which the schedule is executed. By default, UTC is selected.

The Apply non-working day restrictions option is disabled for schedules configured with a timezone different than the one set at tenant level (Settings page > General tab). A tenant without an explicitly defined timezone inherits it from the host.

Trigger

Define whether or not non-working days restrictions apply to your schedule. Do this by either enabling or disabling the Apply non-working day restrictions option. By default, the option is disabled.
Please remember that the Apply non-working day restrictions option is disabled for schedules configured with a timezone different than the one set at tenant level (Settings page > General tab). A tenant without an explicitly defined timezone inherits it from the host.

On the Trigger tab you can also define triggers for process execution. Your process can be configured to trigger:

  • every few 1, 5, 10, 15 or 30 minutes;
  • once every number of hours
  • on a daily, weekly or monthly basis at a specific hour;
  • on selected weekdays at a specific hour;
  • according to a custom cron expression.
    The schedule is configured by default to start once every minute on all Robots, without a stop time.

Execution Target

Execute the specified package according to the following options:

  • All Robots - enables you to execute the schedule on all the Robots from the indicated environment (the default option)
  • Specific Robots - displays all the Robots in the environment assigned to the selected process, and enables you to manually select the ones to execute it.
  • Allocate Dynamically - Displays a field in which you can specify how many times the selected process is to be executed. As soon as a Robot from the specified environment becomes available, it executes the process, taking into account the given schedule.

Actions

Displays the Stop Job after and Disable Schedule at toggle switches. By default, both of them are disabled.

Stop Job after enables the schedule to stop after a specified amount of time, which can be expressed in days, hours or minutes.
Note: The maximum accepted value for Stop After is 10 Days.

Additionally, when you enable this option, you are required to select either Stop or Kill to establish if you want to stop or force stop the schedule. Kill is selected by default.

Note: The amount of time indicated in the Stop After section elapses according to your specifications, even if the job is queued. For example, if you schedule a job to run at 1 p.m. and set it to stop after 20 minutes, at 1:20 p.m. the job stops even if it had stayed in a queue until 1:15 p.m., and then started.

Disable Schedule at allows you to set a date and time when the schedule being defined gets automatically disabled.

Create

Creates the schedule with the selected configuration and saves it in the database. This button is available only if you filled in a name, selected a process, configured a schedule, and chosen the Robot(s) to execute it.

Cancel

Closes the Add Schedule window without saving your settings.

The Parameters Tab

Field
Description

Parameters

The name and type of an argument that was set at design time, in Studio.

Value

Enables you to view and edit the value of input parameters.
The value of an input parameter can be marked as follows:

  • No value - No value was provided for the parameter, at a package and process level.
  • Inherited from package - The value was provided by default in Studio.
  • Inherited from process - The value was provided at process level (in the View Process window).

If no In or In/Out arguments have been defined in Studio, the following message is displayed: Input parameters are not defined for this version.