Webitel: Documentation

While

1. Description

It is a conditional component designed to create a loop that will repeat while the checked condition is true.

This component is present in flow types like:

  • Voice;

  • Chat;

  • Forms;

  • Service.

The block (Fig.1(1)) is used in space to build the Flow. The settings panel for this component opens (Fig.1(2)) when you click on the block.

While.png

Fig.1. While component

1.1. While block

The block consists of the following elements:

  1. The name of the component;

  2. In branch — receiving (connecting with the previous block) branch;

  3. Out branch — execution of the Flow scheme on this branch occurs if the condition specified in the Condition field is not met or after execution of the Flow scheme on the do branch the number of times entered in the settings. The maximum number of passes is set in the Max steps field. Outgoing branch (connecting to the next block);

  4. Do branch — execution of the Flow scheme on this branch occurs when the condition specified in the Expression field is met.

When hovering over the Out, or Do field, a switch appears. The switch allows this component to be connected to a component that already has a connection.

The presence of an  Screenshot 2024-11-07 154742.png  icon indicates that the switch is on, and this component can be connected to a component that already has a connection.

Changing the switch position removes the outgoing branch of this component.

The  Screenshot 2024-11-07 155145.png  button deletes the block from the Flow Schema.

1.2. While settings panel

It consists of the following elements:

  1. Condition;

  2. Max steps;

  3. Break;

  4. Limit;

  5. Add description.

1.2.1. Condition

The test condition is entered here.

All variables in Webitel are marked like this — ${ }. The variable name is enclosed in curly braces. The next step is to specify the condition.

For example, it is necessary to check whether the variable out_w is more significant than zero. The field entry will look like this:

${out_w}>0 

If the condition is met, the do branch is used.

1.2.2. Max steps

Here, you enter the maximum number of passes on the do branch — the condition entered in the Condition field is met.

It is used to avoid looping of the circuit.

1.2.3. Break

Responsible for the completion of the flow execution.

  • image-20250627-120834.png — initiates the end of the flow execution after the given component.

  • image-20250627-120816.png — the switch is in the off position.

1.2.4. Limit

It is intended to determine the maximum number of passes through this component.

The failover branch appears in the edited component when the limit is set image2024-1-26_12-1-12.png .

The failover branch will be used if more passes are passed through the component than entered in the Max field.

Clicking on the Add Limit button adds a Max field and a Delete limit button.

The number of possible passes is indicated in the Max field.

Clicking on the Delete limit button removes the limit and returns the Add limit button.

Limit.png


Fig. 2. Setting a limit

1.2.5. Add description

When you click the Add description button, a Description field and a Delete description button will be added.

The Description field is used to add comments to the component.

Clicking the Delete description button removes the description field and brings back the Add description button.

Description.png

Fig. 3. Add description