Configure Batch Instance Conditions¶
You can define the start and end of a journey's instances by the behavior of batch pipeline runs.
Tip
When a batch condition is set, the system can show you upcoming instances for visibility into future events.
Summary of behaviors¶
Start a new instance¶
A new instance starts each time a run begins for a certain batch pipeline in a journey.
Note, the default start condition always applies in addition to a batch condition.
End an active instance¶
The instance in progress ends when a run ends (i.e. Run Status event with a run status of "completed," "completed with warnings," or "failed") for a certain batch pipeline in a journey.
By default, Observability always ends an active instance when a new instance starts for the same journey.
Prerequisites¶
For a batch pipeline to appear in the Instance Conditions selector, it must already be included in the journey. To add components to a journey, select the Relationships tab. See Create Relationships for more details.
How to¶
You can set start and/or end batch conditions for instances.
The following describes how to configure batch conditions for a journey that's already been created. Note that instance conditions can also be set during journey creation.
- Select Journeys from the menu > choose a journey from the list > select the Settings tab.
- Under Instance Conditions, click Edit journey instance conditions.
-
Optional. Create a batch start condition.
- Under Start a new instance, select Batch.
- Select a batch pipeline component.
-
Optional. Create a batch end condition.
- Under End an active instance, select Add Condition.
- Select When run ends for.
- Select a batch pipeline component.
-
When done, click Save.
At any point, click Cancel to end without saving.
How to change a start condition¶
From the journey details Settings tab, click Edit journey instance conditions under Instance Conditions.
Select a different start condition type and configure the details. Then, click Save.
How to remove an end condition¶
From the journey details Settings tab, click Edit journey instance conditions under Instance Conditions.
For the end condition you want to remove, click Delete. Then, click Save.