Scheduled Programmes

A scheduled programme allows you to select a date and time to start a programme, pulling a selection of customers into the programme based on various criteria that can be specified in the programme trigger. A scheduled programme can also be started by allowing it to run after an event has occurred. 

Open the Start step within the programme to specify the customers that are eligible to be put into the programme, and the conditions to start the programme.

Who to Include:

The first section of the Start step (shown below) specifies who will be eligible to be entered into the programme. In the case of a Time Trigger, this will be the same as the people who are actually put into the programme, whereas for an Event Trigger, it only specifies who can be put into the programme.

As well as selecting specific lists, segments and DPS queries to include and exclude, checking the 'Only Subscribed' checkbox at the top ensures that only subscribed customers are entered into the programme. 

Checking the 'Only Non Open/Clicks' checkbox and selecting a campaign will put only those customers who have not opened or clicked an email from the specified campaign into the programme.

Customer is in at least one of

This allows you to select a set of segments, lists, queries, looks that a customer must also be in as well as the include.

The system will get all the customers to be included
Then for each list in an and group it will create another list
  Then the customer must be in each of the grouped lists
Then the excludes remove any customers in the excludes.

So a customer must be: Included in any of the includes (and in each and group) and not excluded.


So for an include of Segment A, List B with a group where the customer must be in (Query C or List D) and excluding Segment E,
The programme will execute if you are in (Segment A or List B) and in (Query C or List D) and not in (Segment E). 

When to Start:

At the bottom of the Start step is the section to determine what conditions will start the programme. There are two options for the type of trigger: Time Trigger and Event Trigger.

1) Time Trigger:

For a Time Trigger, a date and time to start the programme are specified in the 'Start At' box. If it is a recurring programme, the reoccurring time can be set in the 'Reoccurs' box.

2) Event Trigger:

To schedule the programme via event, change the dropdown from "Time Trigger" to "Event Trigger" like the screenshot below:

Events that will start and stop the programme can then be specified. When any of the start events happen, the programme will start, and if any of the stop events happen while the programme is running, it will stop.

If more complex functionality is required, for example: starting or stopping based on a customer property, there is a section for a javascript function which can be opened by clicking on the cogs next to the 'Start On' or 'Stop On' boxes. If the start function returns true, the programme will start, otherwise, it won't. The same logic applies to the stop function. Below are some examples of such functions.

NOTE: In the start function, there are two parameters: the event data and the customer data, while in the stop function there are four parameters: the programme data, the event data, the customer data and the module data (To learn more about Module Data, see Programme Modules).. It is important, therefore, to know which parameter to use to access the required data in each function.

Meta Data

When a programme starts from a schedule it adds to following meta data to indicate the source of the customer in the programme:
(Note there are 2 underscores before trigger, and only 1 underscore before source)

__trigger: {
	_source: "<name of the source>",
	"<name of the source>": true

You can then use a conditional variable in an email based on the name of the source to show specific content to only that source, e.g. if you send customers into a programme using lists: Hot and Warm; you can show different content using the condition __trigger.Hot or __trigger.Warm.

Note that if a customer is included in multiple sources, only the first source to select the customer will be set as the _source.

The table below indicates what is used as the source for each included source type:

Customer Included From Source
Programme Programme ID
Segment Segment Name
List List Name
DPS Query DPS Query Name
Look Look Name
Mobile App App Name
general - include all customers will have the value: _all
from a specific campaign not sent will have the value: _non_send

Still need help? Contact Us Contact Us