Schedules

The Schedules menu enables you to manage schedules in 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 robots.

When selecting the interval between schedule runs, if a schedule run time comes when it is still running, this schedule will not start.

At the top of the Schedules menu, in the Projects drop-down list, you can select the project with schedules to display. You can change the way the information for each schedule is presented as follows:

  • Filter the list of schedules in the table by typing a name or a part of the name in the Filter text field. See Filtering for more information.
  • Select the table columns to display for a schedule using the menu icon on the right.
  • Refresh the displayed information by clicking the refresh icon on the right.
  • Reset the custom column settings by clicking the reset icon on the right.
  • Select the number of items to display per page and navigate among pages by using the navigation menu in the bottom right corner.

By default, the following table columns are displayed for each schedule.

Column

Description

Active

When active, the schedule runs as planned. You may need to make a schedule inactive for several reasons, such as:

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

  • Because errors have been found in the robots and you do not want the schedule to run before you fix these errors.

  • Because you want to trigger the schedule manually each time it should run. This may be appropriate for some robots and schedules, such as for preparation or cleanup tasks.

Name

Name of the schedule.

Project name

Name of the project that the schedule belongs to (useful when viewing all projects).

Job count

Combination of total and active jobs. If all jobs are active, it simply lists the number of active jobs; if two of three jobs are active, it lists 2 (3).

Next run

Time when the schedule is planned to run next time.

Previous run

Time when the schedule was last run.

Interval

Planned interval between two consecutive runs of the schedule.

Total runs

How many times the schedule has been run.

Errors

Number of schedule errors during the last run of the schedule. Schedule errors do not include robot errors.

To see errors and robot errors, make sure that the log database is set up on the General tab in Settings->RoboServer log database and that database logging is enabled on the RoboServers in RoboServers->Settings->Logging.

Robot errors

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

When the RoboServer works with a scheduled robot, and the robot reports an error, the scheduler and RoboServer are not stopped as the RoboServer tries to recover from the error.

Optional Columns

Total jobs

Total number of jobs in the schedule.

Active jobs

Number of active jobs in the schedule.

Created by

Name of the user who created this schedule.

Modified by

Name of the user who last modified this schedule.

Commit message

Summary describing the commit.

Revision number

Number of the schedule revision.

Cluster

Cluster that the schedule executes on.

Create New Schedule
  1. To create a new schedule, click the plus sign in the upper left corner.

    The "Select project" dialog box appears.

  2. Select a project and click OK.

    Several new tabs open.

  3. The Basic tab contains everything necessary for setting up a schedule.

    • Name: Name of the schedule.

    • Active: Select this option to make this schedule active.

    • Simple / Cron: Select a way of defining the time plan for a schedule.

    • Every: Available only for simple schedules. Desired time interval between two consecutive runs of the schedule. It is entered as an integral number with a unit, such as "1 minute" or "3 hours."

    • Pattern: Available only for cron schedules. Pattern defining when the schedule should be run.

    • Server time zone: Available only for cron schedules. By default, the server time zone is used for running schedules. With this option, you can also select a particular UTC time zone.

    • Start time: Local time when the schedule must start.

    • Jobs priority: Execution priority for this schedule jobs over the other schedule jobs queuing to be given access to a certain resource. The priority applies to all robot jobs in the schedule. For more information, see Queuing of schedule jobs.

    • Jobs timeout: Timeout for the queuing of schedule jobs. If a schedule job has not been given access to a certain resource and executed by the time the timeout is reached, the schedule job stops queuing. The timeout applies to all robot jobs in the schedule. For more information, see Queuing of schedule jobs.

    • Pre-processing robot: Name of a robot that will be run before the schedule is started.

    • Post-processing robot: Name of a robot that will be run after all other robots in the schedule are run.

    • Run on cluster: Name of the cluster to run this schedule.

    • Commit message: Summary describing the commit.

  4. On the Advanced tab, you can configure runtime constraints.

    • Execution time limit: Set the maximum execution time for each robot in the schedule. When a robot has executed for this period of time, the server stops it, and an error is logged. The default value is -1, which means the time is not limited.

    • Extracted values limit: Select the maximum number of values each robot may output. If the robot produces more than this number of values, the server stops it, and an error is logged. The default value is -1, which means the number is not limited.

    • Run jobs sequentially: Select to execute robots in the order listed on the Jobs in schedule tab.

    • Use email notification: 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 and enter the desired email addresses in the Email addresses field.

    • Email addresses: Comma-separated list of email addresses to which notifications are sent. The first listed address is used as both a sender and receiver address. The field can contain up to 255 characters. If you exceed the number of characters in this field, the schedule is not saved.

  5. On the Jobs in schedule tab, you see the list of jobs that will run when the schedule is triggered.

    • Job name: Display name of the job. This is the name specified in the display name attribute when uploading the robot.

    • Active: When Active, the job runs when the schedule is run. You may want to make a single job within a schedule inactive for several reasons, such as:

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

      • Because errors have been found in the robots and you do not want the schedule to run before you have fixed these errors.

      • Because you want to trigger the job manually each time it should run.

    Add Jobs to Schedule

    To add jobs to a schedule, do the following.

    1. Click the plus sign in the upper left corner.

      A dialog box appears to guide you through the job creation.

    2. In the Select job type step, select an option. Available options include:

    Job Type

    Description

    Single robot

    Adds a job that runs a single robot. You can add several robots one by one. To pass input to a robot, you can specify the necessary parameters.

    Group of robots

    Adds a job that runs any number of robots which path name matches a given criteria. The robot groups are evaluated every time the schedule starts; therefore, new robots matching the selected criteria run automatically.

Actions on Schedules

When you click a context menu for a robot, the following actions are listed:

  • Create copy: Opens the wizard for schedule creation. Specify a new name, make any changes to the schedule, and click OK.
  • Deactivate/Activate: Turns off/turns on the schedule.
  • Run/Stop: Click to manually run the schedule. This is especially useful for inactive schedules. If the schedule is already running, the Stop function is active and the schedule is stopped when you click it. That is, all of its running robots are stopped as quickly as possible. The schedule is displayed as "running" until all of its robots stop executing.
  • Edit: Opens the same wizard as for schedule creation with filled parameters.
  • View: Multiple view functions are available to see information related to schedule runs as also appears in the Log view.

Alternative schedule creation

It is also possible to create a schedule from the Robots section. This is done by selecting any number of robots, right-clicking and choosing Create schedule from the context menu.