# Flow Builder Overview

This section will give you an overall idea about how to use the UChat flow builder. You can open a flow and try side by side when you learn it.

IMPORTANT

💁 Please make sure you go through every detail on this page before you start building bots.

# Flow, Sub Flow and Step

flow

# Flow Type

To begin with, you need to create a flow. Currently, UChat provides you with 11 types of flow:

flow

# Sub Flow Type

Flow consists of sub flows. There are 3 types of sub flow:

Sub Flow Usage
step general sub flow, varies in flow type
step call / trigger background tasks
step process repetitive tasks

# Step Type

Sub Flow consists of steps. There are 8 types of steps:

Step Usage
step display information
step ask question and wait for user input
step process data and tasks via integrations, APIs, notifications...
step go different steps depend on conditions
step go different steps depend on probability
step send full email instead of short email notification
step jump to a step or sub flow rather than using a line connector
step define output for the function flow

Note

The differences among different types of flow are Flow Setup, Send Message Step and Question Step. Each channel has its own limitation of message types. For example, you can display a product gallery in Facebook Messenger while the SMS channel doesn't support that.

# Publish Version & Draft Version

In UChat, each flow has a Publish Version and a Draft Version.

  • Publish Version

    your bot talk to clients using the publish version.

  • Draft Version

    any editing of steps will be saved automatically to the draft version. you can edit your flow without influencing the bot and test the draft version before you "Publish".

# From Publish Version to Draft Version, 1 way:

  • click "Edit Flow" on the upper left/right corner of the flow to enter the draft version

overview

Note

You must enter Draft Version before you edit a flow.

# From Draft Version to Publish Version, 3 ways:

  • click "Publish" to save your draft to a new Publish Version
  • discard changes and revert to the newest Publish Version
  • keep draft and switch to Publish Version (by doing this, you can have a look at your publish version and when you click edit and come back, your draft is still here)

overview

Note

Don't worry if you accidentally quit during your editing, the system will keep all your modifications in Draft Version. So when you come back, simply enter Draft Version again and you can see your modifications remain intact.

TIP

You might want to create a flow first, then open the flow side by side when you read the following instruction (Facebook flow used as an example).

After entering a flow, this is what you will see:

flow builder

On the top, there is a navigation bar. From left to right there are:

Part Usage
"Demo Account" current workspace, click to go back to UChat dashboard
"UChat.com.au Support" flow type and flow name, click to go back to "All Bots"
"Main Flow" current sub flow
"Preview" preview the current subflow from the Start Step
"Build a bot..." tutorial video widget
"Joyce" current user, click for user settings, support and logout

Preview Feature

Please note that "Preview" feature is not supported in all channels. Channels support "Preview": Facebook, Telegram, WhatsApp, Line and Viber. For channels without Preview, search "talk to bot" in the documentation.

On the left-hand side, there is a sidebar. From top to bottom there are:

Section Usage
Flow Builder build subflows here
Flows manage all your subflows
Analytics bot data analysis
Live Chat inbox for all the conversations, make a human reply here
Bot Users manage bot user profile. import, export, search or delete bot users
Automation manage keywords, sequences, triggers and comments
Contents manage custom fields, tags, OTN, personas, user menus and customer feedback
Tools manage error logs, draft version tester, bot admins, widgets, multiple language and shortcuts, Facebook Ads, inbound webhooks
Broadcasts send/manage broadcasts
Settings (some are owner only) manage bot users limit, Facebook greeting text, chat widget customization, ice breakers and authorized websites

Note

Features in Automation, Contents, Tools and Settings can be different from channel to channel. In Settings, usually owner can see all the settings like bot user limit while admin and member only see part of them.

# Flow Builder

workspace

Apart from those in the above screenshot, there are a couple of more tips for using the flow builder:

tip tip tip

# Change Themes

Before you start, you can pick your favourite theme by clicking "Change Theme":

theme

choose one of them and "Apply Change".

theme

# Hide Mini-map or Tooltips

theme

Mini-map is useful when you need to move your workspace in some situations. For example, when you click and drag inside a canvas, you are moving the canvas as a whole instead of everything in the builder:

tip

You can hide the mini-map by clicking the "Hide Flow Overview" option.

With tooltip, you can see description for every feature you see in the flow builder like this:

theme

The tooltip includes a title, description, image, video link and documentation link. It is friendly to new users. For users who are already familiar with the system, you can choose to disable the tooltip by clicking the "Hide Flow Tooltips" option.

# Basic Operations to Build Flows

# Edit Step:

Click on a step to edit it, "Edit Panel" will show next to the sidebar.

workspace

Click step name to edit it. You can choose the next step at the bottom of the edit panel or drag connectors from the circle to the tile of another step.

# Connect Steps:

workspace

Create a new step or choose an existing one to be the next step. For dragging connectors, see below:

workspace workspace

TIP

When you choose an existing next step, a line will be connected from the current step to the next. Too many lines can be messy, get a Goto step to help you organize! In a Goto step, you can nominate the next step without creating a line connector.

# Select Multiple Steps (Move to Canvas/Sub Flow)

We've just learned how to move the builder by clicking and dragging. For selecting multiple steps, it's a bit similar. Hold the Shift key then click and drag to cover the steps you would like to select:

workspace

Alternatively, ctrl + click them one by one:

workspace

The selected step has a green border. After selecting multiple steps, click "Create New Canvas" to organize these steps in a canvas box, or move them to an existing sub flow. To delete multiple steps, hit the "delete" button on your keyboard after choosing several steps:

workspace

Delete on Mac

On Mac OS computer, hold fn and hit Delete to remove steps. Or use the "Delete Selected button in the editing panel.

TIP

The green start point is the entrance of a sub flow. It can't be moved to other sub flows or deleted even you include it in a group of steps.

# Copy and Paste Steps

After you select a step or multiple steps, use Ctrl + C to copy and Ctrl + V to paste it to:

  • the same subflow
  • different subflows in the same bot/flow
  • different bots/flows but the same channels (associate custom fields will be created automatically)
  • different channels (unsupported features will be removed)

TIP

Please note that you can only paste ONCE. Copy again for another paste. This is to prevent bulk pasting which can quickly blow up the flow.

That's all about it for Flow Builder Overview!! 🎉 Try building your first flow now. 😎

Last Updated: 4/27/2022, 5:06:08 AM