What you want it to do
In the portal: Users, then a participant, to change one of these on a delivery that is already out. The defaults behind them are on the content, under Sequences. A journey sets them when it hands the card over.
What this page is for
Every other page in this set explains one part of the platform: what a surface is (one section of the home screen), what a delivery does, how a sequence is built. This page starts from what you want to happen instead.
Everything a card does on a home screen comes from six settings, plus the schedule that decides which days it is due and when it stops. Find the sentence that matches what you are after. The settings that produce it are written underneath.
Say what you want
Answer the questions on the right in plain words. The settings underneath are the answer, and the phone shows you the week they produce.
The eight questions
Each question moves exactly one thing.
| What you want to decide | The setting | Where it lands if you set nothing |
|---|---|---|
| Does it open by itself, or wait to be tapped? | autoOpen | false |
| Once they answer, does it stay with a tick or leave? | persistent | false |
| Can they back out of it without answering? | closable | true |
| Can they change their answer afterwards? | revisable | true |
| Can they put it away themselves? | dismissable | false |
| Can they answer on a day it is not due? | unscheduledSubmission | false |
| Which days is it due? | schedule, its type (once, weekly or custom) and its days | one occurrence, from the moment it is assigned |
| When does it stop for good? | schedule.end | never |
The last column is where a setting lands when neither you nor the sequence author named it. Set one of the six flags on the sequence itself and every delivery made from that sequence starts there, which is the right place for a rule that holds across a whole piece of content. Set the same flag on one delivery when you want that behaviour for one person only.
Write out both ends of every schedule. Every schedule carries a start and an
end, and both are required. Where either one is open, write {"type": "instant"} or
{"type": "never"} rather than leaving it off, or the save is refused. If a card never
appeared, read its start first.
The full grammar of days, times, every-N cadences and the four ways a schedule can end is on Schedules and recurrence. Read that page as soon as you want anything other than daily or weekly.
Ten things people build
Each tile is one whole answer. The top row of its picture is the morning, before they have touched it. The bottom row is the same week after they answer on every day it is due.
Three pairs that get mixed up
Whether it stays and whether it comes back are two different settings. persistent
decides what happens to a card the moment it is answered. The schedule decides which
days it is due at all. A card that ticks off and is there again tomorrow is
persistent: true on a daily schedule, and a card that should only ever happen once
is a schedule with a single occurrence.
unscheduledSubmission decides whether a late answer can land, and nothing else.
Recurrence is the schedule's job. Turn this on for a weekly check-in you want people
to be able to catch up on, and leave it off where an answer only counts on the day.
Opening by itself and sitting at the top are two different settings. autoOpen
opens the content in front of the participant, and the card is still on the home
screen afterwards, so somebody who backs out can find it again. The Now surface
decides where the card sits on that screen. Set both when you want a card that opens by
itself and sits at the top.
Where a setting comes from when you did not set one
Three steps, in this order.
- What the journey action set, on the one delivery it created.
- The sequence's own default, one of
defaultPersistent,defaultRevisable,defaultClosable,defaultDismissableordefaultUnscheduledSubmission. - The value in the table above.
The sequence's defaults are copied onto a delivery when it is made, not linked to it. So somebody halfway through a programme keeps the behaviour they were given, and a change to a sequence default reaches the deliveries made after the change. Two people can hold the same sequence with opposite behaviour, which is what lets one piece of content be a blocking consent screen for one participant and a reading card for another.
When a card behaves in a way the delivery does not explain, read the sequence. A journey action that names only the sequence inherits every default its author set.
What you can now do
Start from a sentence about what you want, and get to the settings without reading the reference first. Change one answer at a time, in the picker above, and see the week it produces before you build it.
Deliveries is the full reference for every field, including the ones this page does not ask about.
Persistence and dismissal is the four reasons a card leaves the screen.
Schedules and recurrence is the whole
grammar of schedule, start and end.
The moves is the other way in: seven ways to get somebody to do something, each one built from these settings.