This is UltimateRPA Documentation
Scheduler

Running Scheduler

Scheduler is run by clicking on the Scheduler.exe file in the UltimateRPA Tools directory.

TutorialScheduler_File.png
Figure 1 Scheduler file

Basic features of Scheduler

A basic feature of Scheduler is its automated execution of debugged robotic script from the Robot application, which simulates real-user work. The most common step in Scheduler is the creation of "Tasks". A task defines the execution of robotic script from Robot at predefined time intervals. The configurations created are stored in a scheduling script, i.e. in a file with the UltimateRPA-Scheduler extension.

Practical example of the use of Scheduler

The following demonstration describes how to create a scheduling script that executes robotic scripts called tut1_first_robotization.py and tut2_find_element.py in the tutorial directory every 4 minutes every Monday.

Creating a Queue

When you open Scheduler, you first need to create a "Queue" containing a Tasks list, i.e. a list of robotic scripts from Robot. Right-click in the Queues group frame to open the context menu. Here, select Add Queue. This operation (the creation of a Queue) can also be carried out by selecting the Edit-Add Queue option from the Scheduler main menu or by using the icon with the leaf symbol and the blue plus in the toolbar.

TutorialScheduler_AddQueue.png
Figure 2 Adding a Queue

In the Queue Settings dialog box, set the name of the Queue, its active days and its times. In the Queue Name edit box, enter "Test URPA" and click Time Settings.

TutorialScheduler_QueueSettings.png
Figure 3 Queue Settings dialog box

In the Time Settings dialog box, set the exact time at which the Queue is to be run on an active day. In the Selection Method dropdown field, set Repetitive. In the Beginning Repetition edit box, set 00:00. In the End of Repetition edit box, set 23:59. In the Repeat Every edit box, set 4 minutes and press the Add button. After you press the Add button, the right side of the dialog box displays a list of the times at which the Queue, once run, will start executing a robotic script defined in the first Task on an active day.

TutorialScheduler_TimeSettings.png
Figure 4 Time Settings dialog box

Press the OK button in the Time Settings dialog box and then in the Queue Settings dialog box. In the Queues group frame, the "Test URPA" item is displayed. This represents the Queue.

Creating a Task

Once a Queue is created, a Task can be added to it. Add a Task to the Queue by right-clicking the Queue name in the Queues group frame and selecting Add Task in the context menu. This operation (the creation of a Task) can also be carried out by selecting the Edit-Add Task option from the Scheduler main menu or by using the icon with the check symbol and the blue plus in the toolbar.

TutorialScheduler_AddTask.png
Figure 5 Adding a Task

In the Task Settings dialog box, define the robotic script that is tied to the Task, and define the end of the Task's active time. In the Task Name edit box, add the text "Tutorial 1". This will be used to represent the Task in the Queues group frame. Use the icon on the right part of the Script to Run edit box to set the path to the robotic script tut1_first_robotization.py. In the Before Running the Task, Scheduler Should Wait edit box, set the value to 5 seconds. This specifies the delay before the execution of the robotic script. In the Task Should End Within edit box, set the value to 1. This defines the maximum possible robotic script execution time in minutes.

TutorialScheduler_TaskSettings1_en.png
Figure 6 Task settings

Press the OK button in the Task Settings dialog box. In the Queues group frame, add the item "Tutorial 1" – representing the Task – under "Test URPA". To validate that the "Tutorial 1" Task has been set correctly, you can select Start Immediately in the context menu invoked by right-clicking above the Task "Tutorial 1". After this option is selected, the robotic script tied to the Task "Tutorial 1" will be run after a five-second delay.

TutorialScheduler_StartImmediately.png
Figure 7 One-time running of a Queue

To add another Task to the Queue, invoke the context menu by right-clicking the Queue name in the Queues group frame and selecting Add Task. Fill in the Task Settings dialog box in the same way as for the Task "Tutorial 1". In the Task Name edit box, fill in the text "Tutorial 2", use the icon on the right side of the Script to Run edit box to set the path to the robotic script tut2_find_element.py. In the Before Running the Task, Scheduler Should Wait edit box, set a value of 5. In the Task Should End edit box, set the value to 1 and press OK.

TutorialScheduler_TaskSettings2_en.png
Figure 8 Adding the Task "Tutorial 2"

Defining active days

Active days specify the days on which robotic scripts are to be run in the Queue. Right-click on the Queue name "Test URPA" in the Queues group frame to invoke the context menu. Here, select Edit (this operation can also be carried out by double-clicking on the Queue name or by selecting Edit-Edit from the Scheduler main menu after selecting a Queue in the Queues group frame).

TutorialScheduler_EditQueue.png
Figure 9 Queue editing

In the Queue Settings dialog box, click Days Settings.

TutorialScheduler_DaySettingsSelect.png
Figure 10 Queue editing

In the Days Settings dialog box, left-click the green plus button in the Actions column in the Meets One of the Following Conditions group frame.

TutorialScheduler_DaysSettingsDialog.png
Figure 11 Days Settings dialog box

In the Condition Editor dialog box, set All Days in the Schedule On dropdown field. In the Run dropdown field, set the Weekly value and mark the Mon button.

TutorialScheduler_ConditionEditor.png
Figure 12 Condition Editor

After pressing the OK button in the Condition Editor dialog box, a list of the active days of the Queue "Test URPA" appears in the Preview list in the Days Settings dialog box.

TutorialScheduler_DaysSettingsDialog_Mondays.png
Figure 13 Setting active days – Monday

Press the OK button in the Days Settings dialog box to save the active days of the Queue "Test URPA" that have been set.

Running a Queue

To run the Queue "Test URPA", you need to invoke the context menu by right-clicking above the Queue "Test URPA" in the Queues group frame.

TutorialScheduler_TurnOnSelected.png
Figure 14 Running the Queue "Test URPA"

In the context menu, select Turn On Selected. On the right of the Scheduler dialog box, the active times of the Tasks "Tutorial 1" and "Tutorial 2" appear in the Timetable group frame .

TutorialScheduler_Running.png
Figure 15 Running Queue "Test URPA"

Ending Queue execution

To end the execution of the Queue "Test URPA", you need to invoke the context menu by right-clicking above the Queue "Test URPA" in the Queues group frame and select Turn Off Selected.

TutorialScheduler_StopQueue.png
Figure 16 Ending playback of the Queue "Test URPA"

When the execution of the Queue ends, the items in this Queue are removed from the Timetable list on the right of the Scheduler dialog box.