Creating and managing guide journeys

The Journeys feature allows you to group multiple walkthrough guides from a selected application into a single list to track the overall completion progress.

Understanding journeys

Journeys help users monitor their progress across related guides, displaying completion status as a percentage within Context help popups. Expandable views allow users to see which guides are included in a journey and which guides they have already completed.

Whenever a user completes a guide, the context help view automatically updates the information. Completed journeys remain visible to users.

Creating and configuring journeys

Access journeys from the Adoption content tab > Journeys subtab within a selected application.

To create a journey, select New journey from the top right corner of the page.

  1. Define basic settings for your journey.

    • Name: Input a name for your journey.

      • This is the name that is displayed to users in context help.

    • Description: Input a short description for your journey.

      • This is only visible to administrators.

  2. Define a composition for your journey:

    • Use the search bar to find and add guides by name.

      • Only published guides are visible to end users, but you can include unpublished guides in the composition.

      • Each guide can be assigned to multiple journeys.

      • If all available guides are added, the search bar will disappear.

    • Arrange the order of guides using drag and drop.

    • Remove a guide by clicking the bin icon, which appears on hover.

  3. Set conditions that define when the journey is accessible via Context help.

    • These conditions relate to:

      • Whether the user has viewed or completed this journey.

      • Whether the user has viewed or completed related journeys.

      • Browser language settings.

      • The frequency at which the journey is shown to the user.

      • Predefined custom fields, such as User attributes or Device attributes, to create rule-based conditions.

      • Predefined key pages.

    • When displayed to users, journey conditions take priority over the conditions set for individual guides. This ensures users see the whole journey instead of individual guides within it.

  4. Save your journey. It will not be visible to users until you activate it. See Managing journeys below.

Managing journeys

Journeys are displayed in a table, with a search bar available for filtering. The table features the following columns:

  • Active: Displays whether each journey is currently visible to users. Use the toggle button to define activity status.

    • Active journeys are displayed to all users.

    • Deactivating a journey requires confirmation via a prompt.

  • Name: Displays the name of each journey.

  • Description: Displays the administrator-defined description of each journey.

  • Last update: Displays the exact time and date when each journey last underwent configuration changes in DD/MM/YYYY HH:MM:SS format.

  • Action menu: Gives you the option to Edit or Delete a journey.

Journey analytics integration

Whenever guides are launched from a journey, they trigger an NQL event that can be tracked via Investigations. This information is stored in the trigger_method field from web.guide_executions table.

Example

The following query retrieves the number of times the "Welcome guide" within the "Kanopy corp" application was launched:

  • Automatically

  • Manually as a standalone guide

  • Manually from a journey.

web.guide_executions
| where application.name == "Kanopy corp" and guide.name == "Welcome guide"
| summarize automatically = number_of_executions.sumif(trigger_method  in [auto_started]), manually = number_of_executions.sumif(trigger_method  in [context_help, manual]), journey = number_of_executions.sumif(trigger_method in [journey])

RELATED TOPICS

Last updated

Was this helpful?