A newer version of this documentation is available: View the Latest Version

PipelineCondition

Pipeline conditions define whether a pipeline is automated or for which criteria it gets created.
With PipelineCondition, own conditions can be implemented using the \TechDivision\ProcessPipelines\Api\PipelineConditionInterface, which can be used in a Pipeline.XML.
The isReady function is used to define when precisely a pipeline should be created via the heartbeat.
The components contain a additional set of standardized pipeline conditions:

Condition Description

Condition	Description
*NoAutoSpawn*	The `NoAutoSpawn` condition prevents the execution of pipelines on a heartbeat. This condition should be used if pipelines are not allowed to get executed, e.g., every minute.
*NoSiblingInProgess*	The `NoSiblingInProgess` condition checks if another pipeline with the same name and status running is currently active.
*WebsiteActive*	Pipelines can also be run dedicatedly for individual Magento websites, depending on the implementation. With the `WebsiteActive` pipeline condition, it gets checked whether websites are active at all.
*CronExpression*	The `CronExpression` condition can be used to create pipelines/steps at defined times, e.g. at 01:00 at night. The `CronExpression` condition checks whether the stored cron expression is reached and the execution is within the heartbeat pulse. The time definition/cron expression can be defined as DI-Types via `data`.
*ConfigurableCronExpression*	The `ConfigurableCronExpression` is an extension of the `CronExpression` condition. It can be used to make the `CronExpression` configurable via a stored Magento backend configuration.

NoAutoSpawn

The NoAutoSpawn condition prevents the execution of pipelines on a heartbeat.

This condition should be used if pipelines are not allowed to get executed, e.g., every minute.

NoSiblingInProgess

The NoSiblingInProgess condition checks if another pipeline with the same name and status running is currently active.

WebsiteActive

Pipelines can also be run dedicatedly for individual Magento websites, depending on the implementation.

With the WebsiteActive pipeline condition, it gets checked whether websites are active at all.

CronExpression

The CronExpression condition can be used to create pipelines/steps at defined times, e.g. at 01:00 at night.
The CronExpression condition checks whether the stored cron expression is reached and the execution is within the heartbeat pulse.
The time definition/cron expression can be defined as DI-Types via data.

ConfigurableCronExpression

The ConfigurableCronExpression is an extension of the CronExpression condition.

It can be used to make the CronExpression configurable via a stored Magento backend configuration.

The ConfigurableCronExpression can only be controlled by the DI.
The ConfigurableCronExpression checks if the CronExpression condition is reached and if it is within the heartbeat pulse.