Schedules

The Schedules subsection enables you to manage the schedules on this Management Console. A schedule denotes a selection of robots and plans for running them. Running the schedule means running the selected robots (in parallel or sequence) optionally executing pre and post run scripts or robots. The following information is displayed for each schedule in the list of schedules. The information is presented in columns, some of the columns are hidden by default, and can be shown by clicking the down arrow on the column header, and selecting the columns.

Column

Description

Active

Whether the schedule will actually be run when planned. You may want to make a schedule inactive for several reasons. Some examples are:

  • Because the function performed by the schedule currently is not needed.

  • Because errors have been found in the robots and you don't want the schedule to run before you have fixed these errors.

  • Because you want to trigger the schedule manually each time it should run. This may be appropriate for some robots and schedules, e.g. for preparation or clean-up tasks.

Name

The name of the schedule.

Project Name

The name of the project that the schedule belongs to (useful when the 'All' project is selected)

Robot count

A combination of total and active robots. If all robots are active it will simply list the number of active robots, if 2 of 3 robots are active it will list 2 (3)

Total robots (hidden by default)

The total number of robots in the schedule. (To see the robots, edit the schedule as described below.)

Active robots (hidden by default)

The number of active robots in the schedule. (To see the robots, edit the schedule as described below.)

Next Run

The time when the schedule is planned to be run next.

Previous Run

The time when the schedule was last run.

Interval

The planned interval between two consecutive runs of the schedule.

Total Runs

How many times the schedule has been run.

Created By (hidden by default)

The name of the user that created this schedule.

Modified By (hidden by default)

The name of the user that last modified this schedule.

Object DB (hidden by default)

(The Object DB is a legacy feature, and used with collection robots prior to version 7.2.)

The name of the database where to store values extracted by this schedule's robots. When not empty, a Database Storage Environment will be passed along with the robots to RoboServer.

RoboManager DB (hidden by default)

(The RoboManager DB is a legacy feature, and used with collection robots prior to version 7.2.)

The name of the database where to store log information data about robots run via this schedule. When not empty, a Database Robot Info Environment and a Database Message Environment will be passed along with the robots to RoboServer.

Cluster (hidden by default)

The cluster that the schedule executes on.

Delete

Click this button to delete the schedule.

Edit

Click this button to edit the schedule. This is also useful for viewing more details on a specific schedule. You can also edit a schedule by double clicking the row.

Run/Stop

Click to manually run the schedule. This is especially useful for inactive schedules.

If the schedule is already running, it will be stopped. That is, all its running robots will be stopped as quickly as possible. The schedule will be seen as "running" until all its robots have been stopped.

Errors

The number of schedule errors during the last run of the schedule. Schedule errors do not include robot errors. Schedule errors are errors that prevent the schedule from running, such as a deleted cluster or errors in pre-, post-processing.

Robot Errors

The number of robot errors that occurred in robots run by this schedule.

Schedule Information


You can right click a schedule to bring up the following popup menu

Schedule context menu (right click)

Clicking the Add button in the upper left corner opens a dialog for creating a new schedule. If the current project selection is 'All', when clicking the add button, you have to select an actual project before you can add a new schedule.

Clicking the button in the "Edit" column or double-clicking anywhere in the row for an existing schedule brings up the edit dialog, which is useful for changing the schedule or for viewing all details about it.

Create New Schedule Dialog

The dialog contains three tabs: Basic, Advanced, and Legacy. The basic tab contains everything necessary for setting up a normal schedule. On the advanced tab you can configure runtime constraints.

The following information can be configured for schedules:

Field

Description

Name

The name of the schedule.

Active

An active schedule is marked with a check mark.

Simple / Cron

Used to select between two different ways of defining the time plan for a schedule.

Every

(Available only for Simple schedules.)

The desired time interval between two consecutive runs of the schedule. This is entered as an integral number with a unit, e.g. "1 minute" or "3 hours".

Pattern

(Available only for Cron schedules.)

A pattern defining when the schedule should be run. See Cron Schedule for details of the format.

Pre-processing

The name of a script or robot that will be run as part of the schedule, before any other robots are run.

  • To run a script, the "Allow File System and Command Line Access" must first be enabled in the RoboServer settings. These settings can be found in the installation folder or from the start menu on Windows. The script file can be a windows .cmd or a Linux.sh file. The field must contain the absolute location of the file, like c:\scripts\truncatedb.cmd. If you use this you have to remember to copy the scripts when importing projects or restoring backups.

  • For a robot, use for example runrobot: TutorialCase1 to run the TutorialCase1 robot from the repository.

Post-processing

The name of a script or robot that will be run as part of the schedule, after all other robots have been run. See pre-processing above for details.

Run on cluster

The name of the cluster to run this schedule on.

Robots (to the right)

See the table below.

Execution Time Limit (Advanced tab)

Set the maximum execution time for each robot in the schedule. When a robot has executed for this period of time, the server will stop it, and an error will be logged.

Extracted Values Limit (Advanced tab)

Select the maximum number of values each robot may output. If the robot outputs more than this number of values, the server will stop it, and an error will be logged.

Run robots sequentially (Advanced tab)

If checked, the robots will execute in the order listed on the basic tab.

Use Email Notification (Advanced tab)

Check to receive an email whenever a robot fails. If several robots in a schedule fail, you will get one email for each robot each time the schedule runs.

Email notification works only if you configure an SMTP server in the Options Tab and enter the desired email addresses in the following field.

Email Addresses (Advanced tab)

A comma-separated list of email addresses to which notifications will be sent.

"New/Edit Schedule" Dialog Fields


On the right-hand side you see the list of jobs that will run when the schedule triggers.

Column

Description

Job Name

The display name of the job. This is selected when the job is created.

Active

Whether the job will actually be run when the schedule is run. You may want to make a single job within a schedule inactive for much the same reason you might make an entire schedule inactive.

Remove

Click this button to remove the job from this schedule. This will not delete any robots referred to by the jobs.

Edit

Click here to edit the job.

Robot Information In a Schedule


You can add jobs to the schedule by clicking the  Add Job " button in the upper right-hand corner. This will open a wizard that will take you through the steps of creating a job.

The Help button in the upper right-hand corner of the Schedules tab will open the Management Console User's Guide in your browser.

Alternate schedule creation

It is also possible to create a schedule when located on the Robots Tab. This is done by selecting any number of robots, right-clicking and choosing Create Schedule from the context menu. This will open the New Schedule Dialog with the robot(s) already added.