Flow

Owned by Olesya Tantsyura
Last updated: Mar 12, 2024
6 min read

1. Description

The page is intended for creating Flow. Displays information about all Flow in the domain.

Flow can be used for any service scenario. Service scenarios: Inbound calls, IVR, Outbound task queue, etc.

It consists of the following elements:

  1. Creation tool (Fig.1(1));

  2. Filter block (Fig.1(2));

  3. Search field (Fig.1(3));

  4. Upload tool (Fig.1(4));

  5. Refresh button (Fig.1(5));

  6. Registry (Fig.1(6));

  7. Pagination (Fig.1(7)).

Fig. 1. Flow page

1.1. Creation tool

Use the Add button to create a new Flow (Fig.1(1)).  The Create new flow modal window (Fig.2) opens after clicking the button. The following options for creating Flow are available:

  1. Diagram;

  2. Code.

And types of schemes:

  • Voice;

  • Chat;

  • Forms;

  • Service.

The choice of flow type affects the availability of components when you create a Flow using a diagram.

Fig. 2. Create new flow modal window

1.1.1. Diagram 

Create a new Flow using the Webitel Flow Diagram tool.

Select Diagram in the Create new flow modal window, choose flow type, and click the Create button.

The Webitel Flow Diagram opens after clicking the button.

1.1.2. Code

Create a new Flow using JSON schema in the code editor. Select Code in the Create new flow modal window and click the Create button. The choice of flow type is informational.

The General tab opens after clicking the button.

1.2. Filter block

It is designed to filter the data displayed in the registry.

It consists of:

  1. Filter elements (Fig.3(1));

  2. Reset filters button (Fig.3(2));

  3. Expand filters button (Fig.3(3)).

Fig. 3. Filter block

1.2.1. Filter elements

It is possible to filter by tags - the Tags field and types - checkboxes.

1.2.2. Reset filters button

1.2.3. Expand filters button

1.3. Search field

The search is performed on the Name column.

1.4. Upload tool

It is used to upload Flow schema from a JSON file. Clicking the button (Fig.1(4)) opens a file selection window. Select the desired file on your device and click the Open button (depending on the OS, the file selection window may differ). The Import JSON modal window opens (Fig.4).

Fig. 4. File selection window

The Import JSON  modal window opens (Fig.5).

1.4.1. Import JSON  modal window 

The modal window consists of the following elements:

  1. Create new? checkbox;

  2. Name field;

  3. Add button;

  4. Close button.

Fig. 5. Import JSON  modal window 

1.4.1.1. Create new? checkbox

It is designed to update the Flow schemе without replacing the file by deleting it.

 - when you click the Add button, a new Flow schemе is created (the name must be unique);

 - when you click the Add button, a Flow scheme with the same name in the registry will be updated - replaced with the one imported.

1.4.1.2. Name field

Here, enter the Flow scheme name if you want to change it.

1.4.1.3. Add button

The Flow scheme is added to the register after clicking the Add button. The editor is Code.

1.4.1.4. Close button

After clicking the Close button, the modal window is closed, and the Flow scheme is not loaded.

1.5. Refresh button

(Fig.1 (5)).

1.6. Registry

The registry is a list of entries of existing objects in this partition, each of which consists of a set of fields:

  1. Checkbox;

  2. Name;

  3. Editor;

  4. Type;

  5. Tags;

  6. Created;

  7. Modified;

  8. Download button;

  9. Editing tool;

  10. Removal tool.

If there is no entry on the page, then an additional Add button is displayed in the register, the functionality of which duplicates the Add button in paragraph 1.1.

1.6.1. Checkbox

Fig. 6. Confirm deletion modal window

1.6.2. Name

The name of the Flow is displayed here.

1.6.3. Editor

This column displays which editor was used to create: Code or Diagram.

1.6.4. Type

This column displays the type chosen when the Flow scheme was created: Voice, Chat, Forms, or Service.

1.6.5. Tags

This column displays the tags selected for the Flow schema.

1.6.6. Created

This column displays the date the Flow scheme was created.

1.6.7. Modified

This column displays the date the Flow scheme was modified.

1.6.8. Download button

A JSON file with the Flow scheme is downloaded when the  button is clicked.

1.6.9. Editing tool

After clicking the edit button ():

  • For Flow schemes with the Code editor, the  General tab opens, in which you can edit the code of the Flow scheme; 

  • For diagrams with the Diagram editor, the Webitel Flow Diagram opens, in which you can edit the Flow scheme; 

1.6.10. Removal tool

Fig. 7. Confirm deletion modal window

1.7. Pagination

2. Opportunities

2.1. Create a new Flow scheme by Code

Goal

Create a new Flow scheme by Code

Goal

Create a new Flow scheme by Code

Preconditions

  1. Access to the Admin application;

  2. Access to the Flow partition in the Admin application;

  3. Permission to create in the Flow partition.

Steps

 

  1. Click the Add button. The Create new flow modal window opens.

  2. Select a Code.

  3. Click the Type field. The dropdown list opens.

  4. Select the required type.

  5. Click the Create button. The General tab opens.

  6. Enter data. The Save button becomes active.

  7. Click the Save button.

Result

Data saved. The Flow is created.

2.2. Create a new Flow scheme by Diagram

Goal

Create a new Flow scheme by Diagram

Goal

Create a new Flow scheme by Diagram

Preconditions

  1. Access to the Admin application;

  2. Access to the Flow partition in the Admin application;

  3. Permission to create in the Flow partition.

Steps

 

  1. Click the Add button. The Create new flow modal window opens.

  2. Select a Diagram.

  3. Click the Type field. The dropdown list opens.

  4. Select the required type.

  5. Click the Create button. The Webitel Flow Diagram tool opens.

  6. Create a flow using components. The Save button becomes active.

  7. Click the Save button.

  8. Click the Close button.

Result

Data saved. The Flow is created.

2.3. Delete a Flow

Goal

Delete a Flow

Goal

Delete a Flow

Preconditions

  1. Access to the Admin application;

  2. Access to the Flow partition in the Admin application;

  3. Permission to select and delete in the Flow partition;

  4. The presence of at least one Flow.

Steps

 

  1. Find the Flow you want to delete in the registry;

  2. Click the delete button -  . A modal window opens to confirm the deletion;

  3. Click the Delete button.

Result

The modal window closes. The Flow is deleted.

2.4. Delete several Flows

Goal

Delete several Flows

Goal

Delete several Flows

Preconditions

  1. Access to the Admin application;

  2. Access to the Flow partition in the Admin application;

  3. Permission to select and delete in the Flow partition;

  4. The presence of at least one Flow.

Steps

 

  1. Find the Flows you want to delete in the registry. Select them using the checkbox;

  2. Click the delete button at the top of the registry. A modal window opens to confirm the deletion.

  3. Click the Delete button.

Result

The modal window closes. The Flows are deleted.

2.5. Edit a Flow (Code)

Goal

Edit a Flow(Code)

Goal

Edit a Flow(Code)

Preconditions

  1. Access to the Admin application;

  2. Access to the Flow partition in the Admin application;

  3. Permission to edit in the Flow partition;

  4. The presence of at least one Flow.

Steps

 

  1. Find the Flow you want to edit in the registry.

  2. Click the edit button in the entry of this Flow. The General tab opens.

  3. Make changes.

  4. Click the Save button.

Result

Data saved.

2.6. Edit a Flow (Diagram)

Goal

Edit a Flow(Diagram)

Goal

Edit a Flow(Diagram)

Preconditions

  1. Access to the Admin application;

  2. Access to the Flow partition in the Admin application;

  3. Permission to edit in the Flow partition;

  4. The presence of at least one Flow.

Steps

 

  1. Find the Flow you want to edit in the registry.

  2. Click the edit button in the entry of this Flow. The Webitel Flow Diagram opens.

  3. Make changes.

  4. Click the Save button.

Result

Data saved.