GuidesReferenceChangelogVideosDiscord
Reference
Sign UpLogin

Journey Mapping

Overview

The Journey Mapping Data Operation is used to map Journeys into either a new or existing sessions. This makes it possible to call on a Data Flow in order to create new sessions or interact with existing ones, streamlining the process of, for instance, mutating the state of a previously established session.

As part of the process of mapping Journeys, the Journey Mapping Data Operation provides a means of fine control over how this next Journey will be Identified. This can be done either by defining the sessionID directly, or – if matching an Identifier to an existing session – via an Identifier that was set by the Set Identifier Action.

organizing info

Use Cases

  • Making it possible for users to send a partially-completed form to another Actor to complete
  • Finding and pivoting to existing sessions in order to better consolidate information
  • Allowing external users to activate new Journeys by accessing a Data Flow build into a Portal

Data Operation Properties

Journey Behavior

This section defines how the initial Journey will pivot: by starting an entirely new Journey, or by looking up and mapping to an existing Journey.

Start a New Journey

When this option is selected, the Journey Mapping Data Operation will attempt to start a brand-new Journey. This data operation also provides, through the Journey Identifier Expression, a means to define how the new Journey will be Identified.

It's possible for this to contradict with the mandate to start a new Journey if the given Identifier isn't unique: by definition, all Journey Identifiers must be one-of-a-kind so that they can be used to Identify individual Journeys. Upon selecting the Start a New Journey option, Dropdown menu appears that makes it possible to define how such a contradiction should be resolved, should it occur:

organizing info

There are two options if the Identifier is found in an existing Journey:

  • Replace Current Journey - Funnel into the Journey associated with the Identifier intended for the new Journey that was going to be created.
  • Abort - Do not pivot Journeys at all and continue as though this data operation was never called upon.

Note that in neither case does a new Journey get created; it is not possible to create a new Journey that has the same Identifier as an established Journey.

Lookup and use an existing Journey

When this option is selected, the Journey Mapping Data Operation will search for an existing Journey that matches the Journey Identifiers defined in a later section [Journey Identifier Expression. If such a Journey exists, it will funnel the user into that established Journey.

However, it might not always be the case that such an established Journey exists. Upon selecting the Lookup and use an existing Journey option, a Dropdown menu will appear, making it possible to define how the data operation will be resolved, should this occur:

organizing info

There are two ways to resolve the data operation if there is no existing Journey to replace:

  • Create New Journey - Start a brand-new Journey defined by the given Identifier.
  • Abort - Do not pivot Journeys at all and continue as though this data operation was never called upon.

Start Parameters

The Start Parameters section defines what information will be passed from the current Journey to the next. It accepts data in the form of a JSON object or an App Object. Data passed here is stored under session.start. 

Journey Identifier Expression

This section defines the Identifier(s) that define the Journey being pivoted to. In the case of starting a new Journey, this will create an Identifier for that Journey; in the case of pivoting to an existing Journey, this defines how to Identify which established Journey will replace the initial Journey.

There are three types of Identifier Expressions: 

  • Text - Any unique combination of numbers and text that can be used to Identify the session.
  • Journey ID - Also known as the session_id, this is the primary identification assigned to a Journey when it first begins.
  • Phone - The phone number associated with the Actor of the Journey.

These Identifier Expressions can be selected from the dropdown menu to the immediate right of the expression:

organizing info

The expression itself parses Airscript.

While all Journey Identifiers must be unique, a single Journey can have multiple Identifiers, and arbitrarily many can be associated with the new Journey. Click on the '+' icon at the bottom of the Journey Mapping Data Operation section to add a new Journey Identifier Expression. Click on the trash icon to the right of an Identifier Expression to delete it.

Results

The Journey Mapping Data Operation differs from many other Data Operations in that it cannot be properly tested within Connection Builder. It is not meant to return output as much as it is meant take an action, that is, pivot from one Journey to another. However, once an app is published, it is possible to access the output of the Journey Mapping Data Operation if that output is returned from the Data Flow as a whole. This output is an object that contains information pertaining to the Session ID of the new Journey, the Session ID of the old Journey, and when the new Journey is set to expire.