Configure Payload Instance Conditions

You can define the end of a journey's payload instances by duration or batch pipeline run behavior.

Summary of behaviors

Start an instance

A payload instance starts when payload instances are tracked in the journey Settings and a new payload value is included in any of the following events.

• A Metric Log, Message Log, or Test Outcomes event received for a server, streaming pipeline, or dataset component.
• A Dataset Operation event received for a dataset component.
• The first event (Run Status, Metric Log, Message Log, or Test Outcomes) received for a batch pipeline run.

See Payload Instances Overview for more information on batch pipeline run behavior.

Note

Start conditions apply by default and do not need to be configured.

End an active instance

An end condition must be configured for payload instances. Payload instances can end:

• On a schedule.
• When a specified batch pipeline component receives a run end event (a Run Status event with status of "completed," "completed with warnings," or "failed") for a run associated with the payload.
• When a specified dataset component receives a Dataset Operation write event and the event includes the payload value.

How to

To set payload instance conditions for a journey that's already been created, follow the steps below. Note that payload instance conditions can also be set during journey creation.

1. Select Journeys from the menu > choose a journey from the list > select the Settings tab.
2. Click Edit payload instance conditions.
3. Check Track payloads as separate instances.
4. Under End a payload instance, select Add Condition and configure at least one end condition.

5. Optional. Create a batch pipeline run end condition.

   1. Select When run ends for.
   2. Select a batch pipeline component included in this journey.

   When no batch pipeline components are in the journey, the drop-down reads N/A (not applicable).

6. Optional. Create a schedule end condition.

   1. Select On schedule.
   2. Click in the field.

   3. Select the timeframe: Every x hours, Every x days, On certain days, or Custom.

      Tip

      Use Custom cron expressions in your expectations. See Cron Expressions in Observability for what's supported.

   4. Complete the schedule details.

   5. Verify that the Next Time calculated by the system aligns with your expectations. Make adjustments if needed.
   6. Click Apply.

7. Optional. Create a dataset end condition.

   1. Select When write operation occurs for.
   2. Select a dataset component included in this journey.

8. When done, click Save.

At any point, click Cancel to end without saving.

How to remove an end condition

From the journey details Settings tab, click Edit payload instance conditions.

For the end condition you want to remove, click Delete. Then, click Save.