Flow Details

Navigate Flows page in Workflow Studio

The Flow details page shows in-depth information about each flow. This article offers steps on navigating this page, understanding the flow’s state and its experiences, and utilising available editing options.

Viewing flow information

1. To begin, click on the eye icon next to any flow listed on the Flows page. This will open the Flow details, where you'll find comprehensive information, including the flow's title, current state, and a brief description if provided. You'll also be able to view flow activity if the flow has been activated.
2. You can identify the current state of your flow, whether the flow is in use (Active), being designed (Draft), ended (Terminated), or facing issues (Error).

Flow overview tab

The Flow overview tab shows your flow configuration and its high-level summary.

Activity summary

The Activity summary provides a count of total, active, completed and failed Experiences for the selected flow version. This summary is available for activated flows. Hover over the count to view the full count, and refresh to view latest updates.

The following details are available for each flow:

• Total experiences: The number of experiences started from the first node.
• Complete experiences: The number of experiences that successfully reached the end of the flow, passing through each of the node's outcome paths.
• Failed experiences: An experience ends mid-flow if it cannot meet any of the outcome paths from the current node. For example, an email bounces and no fallback path is configured. You can enable outcome paths on nodes to continue experiences in these cases.
• Experience errored: An experience ends due to an unrecoverable issue that affects other experiences, which can be caused by external dependencies (e.g., invalid API credentials).

Flow preview and Experience breakdowns

The Flow preview shows the flow design, configuration and a breakdown of experience progress.

You can use the Experience breakdown statistics beneath each node to determine the points that experiences have reached, and what paths they have taken. At the end of each path, there is a number of experiences that successfully reached the end (Complete).

Selecting a node will show it's read-only configuration.

Experiences tab

The Experiences tab provides an overview of the experiences in the flow and a high-level summary of your experiences.

The Experiences table lists each individual experience started for the flow version, sorted by the most recent first. You can page

The following details are available in the table:

• Experience ID: A unique identifier of an experience.
• Last processed action: The most recent actionTooltip taken by the experience.
• Started: The date and time the experience started.
• Status: The current status of the experience. For a detailed guide on Experience statuses, see Understanding Experience Lifecycle.
• Action icons
  • View experience: Clicking on the eye icon will take you to the Experience Details page.

Search functionality

Use the search bar to quickly find Experiences by its details, time range and status. All results are will display all experiences that contain the search query.

Search results always display active experiences, while completed experiences appear only if they are within your data retention period.

The following options are available for refining your search based on specific criteria:

• Experience ID: Find a specific experience by entering the exact Experience ID.
• Experience status: Find experiences with one or more statuses, including active, completed, errored, and/or failed. A date range must be set.
• Node: Find experiences that includes a specified node and its activities. A date range will search for the specified node activities that may occur outside of the experience end time. A date range must be set, and optionally one or more experience statuses. For a detailed guide on Node Activity, see Navigating the Experience details page.
• Recipient phone: Find experiences with messages sent to or received from a phone number. The phone number should match exactly to the one provided through the trigger payload, or the recipient field of the node. A date range must be set, and optionally one or more experience statuses.
• Recipient email: Find experiences with messages sent to an email address. The email address should match exactly to the one provided in the trigger payload or recipient field of the node. A date range must be set, and optionally one or more experience statuses.
• Web request URL: Find experiences with a web request to a specific URL. The URL should match exactly to the one entered in the Make a Web Request node. A date range must be set, and optionally one or more experience statuses.

Flow versions pane

Flow versions pane provides a list all the versions of the flow, allowing you to review the past content and changes made to the flow by selecting different versions from the history.

For a detailed guide on flow states, see Understanding Flow versions and their management

Using edit and more options

To edit a flow, click the Edit button. This action is available for flows in Active and Draft state.

You can only edit flows that are currently active or in a draft state. If you click Edit a flow that has a draft on top (indicated by the 'Drafting' badge on the flow list) you will open the new draft flow version. For a detailed guide on this, see Editing activated flows

The More dropdown menu offers additional actions such as Archive, Unarchive, Delete, Duplicate, Drain, and Terminate, depending on the flow's status.

For a detailed guide on flow states, see Manage individual flows in various states

FAQ

Why does the experience show a "Message Failed" or "Message Rejected" event after progressing on the Sent path?

These events can occur later due to carrier delays. For instance, your messaging node (e.g. Conversation node) continues on the Sent path if no failures occur within the set wait time (e.g. 10 minutes). However, a 'Rejected' status might still be reported afterward if issues are detected later. You can configure the wait time in node outcomes.

Navigate the Flow details page

The Flow version pane within the Flow detailsInsert Definition Here page provides a detailed record of all changes in a flow, allowing you to review and manage different versions of a flow. This article guides you through using the flow versions effectively.

1. In Flow details, locate the Flow version pane situated to the right. It lists all the iterations of the current flow with their respective states.
2. Click on any version in the list to see a read-only view of that particular version's configuration on the Flow overviewInsert Definition Here pane. By clicking on the elements within this view, you can access the content of each node and observe how it has evolved across different versions. This feature is especially useful for comparing changes in messaging to analyse their impact on your campaign.
3. Depending on the state of the flow version you've selected such as ActiveInsert Definition Here, DrainingInsert Definition Here, TerminatedInsert Definition Here, different flow state commands such as DuplicateInsert Definition Here, TerminateInsert Definition Here, or ArchiveInsert Definition Here will be available. Utilise these commands to manage your flow's lifecycle effectively.

For a detailed guide on flow states, see Manage individual flows in various states

Navigate Flows details page

Each modification to an activeInsert Definition Here flowInsert Definition Here results in the creation of a new flow version. This versioning system is vital for maintaining the integrity of workflows while allowing for ongoing improvements and adaptations. This article explores the nuances of flow versions, it’s history, and the management options available for each.

The concept of flow versions

Whenever an active flow is edited, a new version is created. This ensures that the original configuration remains intact and available for reference if needed. The Flow versionInsert Definition Here pane within the Flow detailsInsert Definition Here page acts as a logbook, chronicling version’s state, date and time. Each version is clickable, revealing its configuration in the Flow overviewInsert Definition Here pane, allowing Pendula users to understand and compare different iterations of the flow.

Activating new versions

When a flow is activated, the new flow goes live immediately. Activating a new version of a flow sets previous versions to a DrainingInsert Definition Here status. This ensures a seamless transition, allowing active experiencesInsert Definition Here to be completed without disruption.

For a detailed guide on the process, see Editing activated flows

Version management options

Click on any version listed in the Flow version pane to view or manage that particular iteration. Depending on the state of the selected version, the Edit and More options will change to reflect the flow state change command that can be used.

For example, an active version allows for edits, while a draining version does not offer the edit option but may allow duplication or termination. These actions are designed to manage the flow according to its current stage in the lifecycle.

For a detailed guide on flow states, see Manage individual flows in various states

Activity per version

When viewing a particular flow version, all activity shown is for that particular version. The activity summary, and searching of experiences, is filtered to just the version that is being viewed.

To view statistics or search experiences across flow versions, or across specific flows or all flows, we recommend streaming activity via Activity Sync to your data storage solution of choice, and building reports or queries there.

The draining process

Draining is a critical process that occurs when a new flow version is activated. It prevents new experiences from starting in the older version while allowing ongoing experiences to reach their natural termination. The goal is to avoid any abrupt interruptions to the user's journey. During the draining phase, users also have the ability to terminate the version. Termination stops all activity within that flow version immediately.