Skip to main content

Pipeline Triggers

Pipeline triggers are used to start the execution of a pipeline based on a cron schedule using the Bot Service.

Every pipeline trigger is also represented in OctoMesh's Asset Repository. This allows you to manage and monitor the triggers in the Admin Panel.

Prerequisites

  • Only Data Pipelines with a Mesh Pipeline can be triggered using the Bot Service.
  • The Trigger node FromPipelineTriggerEvent@1 must be the first node in the pipeline you want to trigger.

Admin Panel

Pipeline triggers can be managed in the Admin Panel under the Communication/Pipeline Triggers tab. The overview provides information about the trigger's status and allows you to perform operations on the trigger.

Pipeline Trigger Overview

Operations

The following operations can be performed on a pipeline trigger:

  • Edit: Edit the trigger's configuration.
  • Delete: Delete the trigger's configuration and remove the trigger from the Asset Repository.
  • Clone: Clone the trigger's configuration.
  • Update deployment: Update the deployment of the trigger's configuration at the Bot Service.

Edit View of a Pipeline Trigger

The Edit view of a pipeline trigger allows you to edit the trigger's configuration. This includes the name, an optional description, the cron schedule, see the deployment state and pipelines that are executed by the trigger.

Pipeline Trigger Edit View

Cron schedules are used to define the time when the pipeline should be triggered. The cron schedule is defined using the following format:

* * * * * *
- - - - - -
| | | | | |
| | | | | +-- Year (range: 1900-3000)
| | | | +---- Day of the Week (range: 1-7, 1 standing for Monday)
| | | +------ Month (range: 1-12)
| | +-------- Day of the Month (range: 1-31)
| +---------- Hour (range: 0-23)
+------------ Minute (range: 0-59)

Typical expressions are:

  • * * * * * *: Every second
  • 0 * * * * *: Every minute
  • 0 0 * * * *: Every hour
  • 0 0 0 * * *: Every day at midnight
  • 0 0 0 * * 1: Every Monday at midnight
  • 0 0 0 1 * *: Every first day of the month at midnight

Deployment of a Pipeline Trigger

Triggering a pipeline is done by the Bot Service. The Bot Service is a service that is responsible for executing pipelines based on triggers. The Bot Service is a tenant-independent service that is responsible for managing the lifecycle of the triggers, including creating, updating, and deleting triggers.

On the status page a deployed trigger is visible. The status page shows the last execution time of the trigger and the next execution time of the trigger. For testing purposes, manually the execution of the trigger can be started with the Trigger now button.

Pipeline Trigger Status View