Pipeline Settings

This topic presents the setting options available for your pipeline.

You can access the pipeline settings from the The "Overview" page icon is a square divided into several other squares. Overview page of the pipeline.

Pipeline settings from the "Overview" page.

It includes the following non-versioned and editable features:

1 - Name

Names are mandatory, with a maximum of 255 characters, and unique within a project.

2 - Description

Descriptions are optional and have no restrictions, but it’s a good practice to add them and keep them short and informative.

3 - Scheduled run Icon for runtime types is a calendar.

There are two runtime types:

  • The manual run, which requires you to click Run to start the pipeline.

  • The scheduled run, which launches the pipeline according to the schedule you choose.

    Scheduled pipelines can also be started manually.

    The Scheduled run type has three schedule modes: Simple, Shortcut, and Expert.

    • In Simple mode, you can easily specify variables through the user interface. There are many possibilities.

      Screenshot of the settings for the scheduled run type in simple mode

    • In Shortcut mode, you can choose the recurrence of your run on an hourly, daily, weekly, monthly, or annual basis. All other settings are automatic.

      Screenshot of the settings for the scheduled run type in shortcut mode

    • In Expert mode, you can specify variables using the Cron format. The Cron time string consists of five values separated by spaces: [minute] [hour] [day of the month] [month] [day of the week]. They are based on the following information:

      Table 1. Cron format
      Descriptor Acceptable values

      Minute

      0 to 59, or *

      Hour

      0 to 23, or *

      Day of the month

      1 to 31, or *

      Month

      1 to 12, or *

      Day of the week

      0 to 7 (0 and 7 both represent Sunday), or *

      The Cron time string must contain entries for each character attribute. If you want to set a value using only minutes, you must have asterisk characters for the other four attributes that you’re not configuring.

      Screenshot of the settings for the scheduled run type in expert mode

      Once you have finished scheduling your run, you will see the summary of your choice written below and the time of the next run.

Regardless of the Scheduled run type that you selected, you can specify the time zone for your jobs or pipelines. When specifying its time and day, you should know that:

  • The default value in the time zone selection is your browser’s time zone.

  • The next schedule preview will be displayed in the time zone of your browser.

  • Daylight Saving Time (DST) is automatically adjusted.

  • Runs scheduled for the 29th, 30th, or 31st day of the month will not run in months with less than 29, 30, or 31 days.

    Example 1. French time settings

    UTC time is two hours behind French time, so if you want your job to run at midnight French time, set it to two hours later, that is, at 2 a.m.

4 - Alerts The "Alerts" icon is a bell.

Alerts are optional and can be set to receive an email when the status of your pipeline changes. They can be sent to multiple email addresses to notify you of the following status changes:

  • queued requested Requested: the pipeline’s run has been requested and is being executed.

  • queued requested Queued: the pipeline is waiting for the necessary resources to be executed.

  • spinner Running: the pipeline is up and running.

  • success Succeeded: the pipeline has been successfully executed.

  • stop Stopping: the pipeline is stopping.

  • stop Stopped: the pipeline has stopped running.

  • failed Failed: the pipeline has crashed.

  • unknown Unknown: the pipeline no longer runs because an error has occurred.