Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Triggers

Creating a Trigger


  1. In a folder, navigate to Automations > Triggers and on the Triggers page, click Add. The Create Trigger page is displayed.
  2. Select the trigger type.
  3. In the Name field, add a name for the trigger to easily identify it.
  4. From the Process Name drop-down, select the process you want to configure a time trigger for.
  5. From the Job Priority drop-down, select the priority of the job. The default value is Inherited, meaning that the job priority is the same as the one defined for the selected process.
  6. From the Job Type drop-down, select the runtime type under which the job is to be executed.
  7. On the Execution Target tab, select your jobs' allocation mechanism and execution target.

Desciption

Dynamic Allocation

Allocate Dynamically
Only available for time triggers.

Dynamic allocation with no explicit user and machine selection allows you to execute a foreground process multiple times under the user and machine that become available first. Background processes get executed on any user, regardless if it's busy or not, as long as you have sufficient runtimes.

Using the Allocate Dynamically option you can execute a process up to 10000 times in one job.

User

The process is executed under a specific user. Only specifying the user results in Orchestrator allocating the machine dynamically. Specifying both the user and the machine means the job launches on that very user-machine pair.

Machine

The process is executed on one of the host machines attached to the selected machine template. Only specifying the machine results in Orchestrator allocating the user dynamically. Specifying both the user and the machine means the job launches on that very user-machine pair.

Make sure that runtimes matching the job type are allocated to the associated machine template. Only connected host machines associated with the active folder are displayed.

User-Machine Mappings

Only available for time triggers.

The process can be executed on multiple specific user-machine pairs. Learn more about user-machine mappings.

Note: Users part of mappings that are employed in triggers cannot be deleted or unassigned from the folder the trigger resides in. Make sure the user is not set as an execution target in a trigger so you can delete them.

  1. On the Arguments tab, provide values for input arguments if your process has any. More details about input and output arguments.
  2. From the Timezone drop-down, select the time zone according to which the trigger is to be set off. Please note that the trigger time zone is not dependent on the tenant time zone.
  3. From the Non-Working Days drop-down, select a non-working days calendar, if you want your trigger to stop firing on certain non-business days. More details about non-working days.
  4. Enable the Disable Trigger at toggle, and enter the date and time when the trigger is to be disabled.

Time Trigger

  1. Select the execution frequency of the trigger (Minutes, Hourly, Daily, Weekly, Monthly, Advanced). On the right side of this section, configure the details depending on the chosen option (frequency, exact time, or a cron expression). Orchestrator uses an open-source library to parse and display cron descriptions, which can be found here.
  2. Enable the Stop Job After toggle, and enter the amount of time that needs to pass before the job is either stopped or killed. Select if you want the job to be Stopped or Killed after the stop time elapses.
    Note: The amount of time specified here elapses according to the 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, the job stops at 1:20 p.m. even if it had stayed in a queue until 1:15 p.m., and then started.

Queue Trigger

Note: Queue triggers and SLA predictions are interdependent in terms of queue-process association. So whenever configuring one, the other is prefilled such as to have parity between the configurations. Say I define a queue trigger for queue Y to use process X. SLA predictions for queue Y can only be made using process X, therefore X is prefilled and read-only when enabling queue SLA for Y.

  1. Fill in the Minimum number of items to trigger the first job., Maximum number of pending and running jobs allowed simultaneously., Another job is triggered for each _ new item(s) fields.

Description

Minimum number of items that trigger the first job

The item-processing job is only started after the targeted queue has at least this number of new items. Deferred queue items are not counted.

Maximum number of pending and running jobs allowed simultaneously

The maximum number of allowed pending and running jobs, counted together. For 2 or more jobs allowed simultaneously, the third option needs to be defined as described below.

Another job is triggered for each __ new item(s)

The number of new queue items (on top of the number configured for the Minimum number of items that trigger the first job option) to trigger a new job.

Editing a Trigger


Click the corresponding Edit button, make the intended changes, and then click Update in the Edit Trigger window.

Disabling a Trigger


By default, a trigger gets disabled automatically after 10 failed launches and no successful runs occurring in the last day.

📘

Note:

To change the default number of failed runs causing a trigger to be disabled if there are no successful launches in a specific number of days, configure the Triggers.DisableWhenFailedCount parameter in UiPath.Orchestrator.dll.config. To update the number of days, use Triggers.DisableWhenFailingSinceDays.

To disable a trigger, click the corresponding More Actions button, and then Disable. A disabled time trigger is marked by the disabled_time_triggerdisabled_time_trigger icon in front of it. A disabled queue trigger is marked by the disabled_queue_triggerdisabled_queue_trigger icon in front of it.

Alternatively, you can select it and then click the Disable icon.

You can also configure your trigger to get automatically disabled at a specific date and time in the future. You can do that as follows:

  1. Click the corresponding Edit button.
  2. Enable the Disable Trigger at option.
  3. Fill in the desired date and time.
  4. Click Update for the changes to take effect.

Enabling a Trigger


To enable a trigger, click the corresponding More Actions button, and then Enable. An enabled time trigger is marked by the enabled_time_triggerenabled_time_trigger icon in front of it. An enabled queue trigger is marked by the enabled_queue_triggerenabled_queue_trigger in front of it.

Alternatively, you can select it and then click the Enable icon.

Removing a Trigger


To remove a trigger, click the corresponding More Actions button, and then Remove.

Alternatively, you can select it and then click Remove.

Displaying Jobs Started by a Trigger


To display the jobs started by a specific trigger, click the More Actions button, and then View jobs. This displays the Jobs window, which comprises all the jobs executed in the past through the selected trigger (if any).

Managing Non-Working Days


Creating New Calendars

  1. Open the Non-Working Days tab on the Settings page. A list with all the calendars previously defined is displayed, ordered alphabetically.
    The BankHoliday calendar is displayed here, if it exists. This calendar is created when upgrading your Orchestrator to 19.10 if you had non-working days defined in your previous version.
  2. Click Add to create a new calendar and type its name in the blank, highlighted field. The name must be unique, and it may contain a maximum of 150 alphanumeric characters. You can't create calendars with no names or containing only space characters.
  3. Click Save or press Enter on your keyboard to save the new calendar. The calendar is saved and displayed in the list of calendars.
  4. For the selected calendar, define non-working days either manually, or by uploading a .csv file, or a combination of these.
  5. In the Triggers page, when creating a new trigger or editing an existing one, select the desired calendar from the Non-working days restriction drop-down.

📘

Note

You cannot save a trigger with a timezone different than the timezone set at the tenant level (Settings page > General tab) because calendar restrictions cannot be applied in different timezones. A tenant without an explicitly defined timezone inherits it from the host.

  1. Click Update for the changes to take effect. Every change made to a calendar subsequently propagates to all triggers associated with that calendar.

Manually Selecting Non-Working Days

  1. Click a calendar to select it. The calendar on the right-side of the window is updated accordingly.
  2. On the displayed calendar click the dates on which you want your triggers to stop firing. Click again on a selected date to deselect it.
  3. Click Save to save the selected dates as non-working days.

Uploading .csv Files

Enables you to upload a series of dates into a selected calendar, directly from a .csv file. Please note that the file must be populated beforehand using a predefined format so that the upload operation is successful. The new dates from your uploaded file overwrite any dates already contained in the calendar.

📘

Important!

The .csv file must contain ExcludedDate column header. All the non-working days must be within that column, written in the YYYY-MM-DD, YYYY/MM/DD or YYYY MM DD format.
Expand the Example section below for more information.

  1. On the selected calendar click Upload csv.
  2. Navigate to the desired .csv file, select it and click Open. Orchestrator parses the file to confirm it meets formatting rules (see the example section below).
  3. Click Yes in the confirmation dialog to overwrite the dates already contained in the calendar with the new dates from your uploaded file.
  4. Click Save to save the modified calendar.

OR:

  1. Drag & Drop the desired .csv file over the selected calendar's top part. Orchestrator parses the file to confirm it meets formatting rules (see the example section below).
  2. Click Yes in the confirmation dialog to overwrite the dates already contained in the calendar with the new dates from your uploaded file.
  3. Click Save to save the modified calendar.

 

Let's say you upload into a calendar the content of the following .csv file. An easy way to create such a file is to populate the data into an excel file and save it as a .csv file:

SaveAsCSV

Or you can download a .csv file with all the pre-filled column headers and customize it to your needs.

Download file

 

Notice that this file contains a predefined column header, ExcludedDate. Enter all your non-working days in that column, using YYYY-MM-DD, YYYY/MM/DD or YYYY MM DD format.

 

 NWDCSVFile

Renaming Calendars

  1. Select a calendar in the Non-Working Days tab on the Settings page.
  2. Modify the name of the calendar.
  3. Click Save to save the changed name.

Deleting Calendars

  1. Select a calendar in the Non-Working Days tab on the Settings page.
  2. Click Delete.
  3. Click Yes in the pop-up window to confirm your intent. The calendar is deleted.

📘

Note:

You can only delete calendars that are not attached to any triggers.

You can also remove non-working days from a calendar. After clicking on a non-working day it is no longer marked. Remember to save your changes.

Updated 4 months ago


Managing Triggers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.