• Documentation
  • Tutorials
  • Case studies
  • Blogs
  • Product

What's on this Page

  • Description
  • Create and configure schedules
    • Assertion plan
  • Schedules global settings
  • step
  • User guide
  • Schedules
Categories: USER GUIDE SCHEDULES
This article references one of our previous releases, click here to go to our latest version instead.

Schedules

The Schedules lets you execute Step Plans repeatedly with the help of cron expressions typically used for synthetic monitoring.

For the schedules to work correctly, ensure to properly set up the controller’s machine timezone before you start it.

Description

Let’s describe the Step sshedules view: You can access it by clicking “Sshedules” on the sidebar menu:

Here is the column description:

  • Name: The name of the schedule. Click the schedule name to modify the schedule
    • Name tooltip: a tooltip supporting HTML rendering is optionnaly added if a Descritpion has been set for this schedule
  • Environment: The environment in which the Plan will be executed
  • Cron Expression: the Cron expression used to trigger the associated Plan
    • Cron Expression tooltip: a tooltip containing the list of time range exclusions will be displayed if any were defined
  • Status: defines if the schedule is active or not
  • Action: options that let you open the linked plan, execute, edit, delete or analyze the schedule

Create and configure schedules

A schedule is defined by following properties:

  • Name: The name of the schedule.
  • Plan: the plan to be executed
  • CRON expression: define when and at which frequency the plan is executed. While the expresions are CRON based, a UI wizard helps to easily define your schedule.
  • Description: a description for this schedule which will be displayed as a tooltip on the schedules view (HTML rendering supported)
  • CRON Exclusions: optianally provide CRON expression(s) for excluding time ranges. (Example: for a schedule set to run every 5 minutes, you can exlucde the execution on weekends with “* * * ? * SAT-SUN” )
  • Execution parameters (Optional): the values for each execution parameters (i.e. Environment) as defined in customization
  • User (Optional): to execute the plan on behalf of provided username. Note: logged-in user must have sufficient right to delegate the execution, and the user on behalf must have sufficient right to execute the plan
  • Assertion plan (Optional): the assertion plan to be evaluated after each plan executions

Assertion plan

An assertion plan declares assertions to be performed on the series of executions of a schedule. It is executed after each execution of the schedule and triggers an event of type “Scheduler: Assertion of task failed“ upon failure. You can subscribe for notifications of such event by email or webhooks.

Typically an assertion plan consists of one or more AssertMetric controls that specify the assertions. AssertMetric can be for instance used to ensure that the number of failures of the executions related to a schedule remains below a defined threshold.

Schedules global settings

As an admin user, you have access to modify the Schedules global settings.

To do this, go to the Settings icon > Setting tab > scheduler, then enable scheduler. This lets you enable or disable the Scheduler globally across all projects, and you can still execute the schedules manually if needed.

You can also specify the user under which the schedules should be executed. If the field is left empty, the schedules will be executed under the user who created it.

Please note that the Schedules are greyed out when the Scheduler is disabled globally.

See Also

  • User account
  • Versioning
  • Import/Export entities
  • Cloud material download
  • Getting started
  • Home
  • Whats new?
  • Admin guide
  • SaaS guide
  • User guide
    • Keywords
    • Plans
    • Executions
    • Alerting rules
    • Incidents
    • Notifications
    • Parameters
    • Analytics
    • Analytics (beta)
    • Monitoring
    • Schedules
    • Event Broker Monitor
    • Import/Export entities
    • User account
    • Versioning
  • Developer guide
  • DevOps
  • Plugins
  • Libraries
Step Logo
    • Documentation
    • Tutorials
    • Case studies
    • Blogs
    • Product
    • Home
    • Whats new?
    • Admin guide
    • SaaS guide
    • User guide
      • Keywords
      • Plans
      • Executions
      • Alerting rules
      • Incidents
      • Notifications
      • Parameters
      • Analytics
      • Analytics (beta)
      • Monitoring
      • Schedules
      • Event Broker Monitor
      • Import/Export entities
      • User account
      • Versioning
    • Developer guide
    • DevOps
    • Plugins
    • Libraries