Form File

1. Description

Component for dynamic pages (forms) of the Agent that displays a container for input/output files in the Workspace.

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.

1.1. Form file 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 — outgoing (connecting with the following block) branch. When hovering over the Out field, a switch appears. The switch allows this component to be connected to a component that already has a connection.

The presence of an 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 button deletes the block from the Flow Schema.

1.2. Form file settings panel

It consists of the following elements (Fig. 2):

1.2.1. Id

Here, you enter the name* (unique within the Flow) – a service name that is not displayed on the page. It is used as a variable for further access to values.

1.2.2. View

It is designed to customize the view (Fig. 3).

It consists of the following fields:

1. Initial value;

2. Label;

3. Hint;

4. Readonly;

5. Collapsible.

1.2.3. Initial value

If the Readonly switch is on:

A variable is called in the Initial value field, into which the attached files from the email are set.

You can set such a variable in the Get Email component in the Set variables element: enter attachments in the Value field, and enter the name of the variable that will be called here in the Key field.

For example, in the Get Email component, in the Set variables element, in the Value field attachments was entered, and Files was entered in the Key field. Then enter  ${Files} in the Initial value field.

If the Readonly switch is off:

A variable is called in the Initial value field, into which the files will be set for the sending message.

1.2.4. Label

Enter the text that will be displayed as a title above the files in this field. If the field is left empty, then the container will be without a title (Fig. 3).

1.2.5. Hint

You can enter a hint in this field. The tooltip will be displayed when you hover over the  icon.

The icon will not be displayed if the field is left blank (Fig. 3).

1.2.6. Readonly

— displays a container for input files in the Workspace (Fig. 3).

• Clicking on the button downloads the input file in ZIP format.

• Clicking on the file name downloads it.

— displays the container for outgoing files in the Workspace (Fig. 3).

Clicking on the button opens a window for selecting a file to be attached.

1.2.7. Collapsible

The switch is responsible for the ability to expand/collapse the block with files:

— the block with files is expanded by default without the ability to collapse;

— the block with files is collapsed by default. It is possible to expand/collapse the block.

• — expand the block with file;

• — collapse a block with file (Fig. 3).

1.2.8. Element "Link file"

Used to link files to entities. Consists of the following elements:

• “Custom channel” toggle;

• “Channel” field;

• “Entity id” field.

1.2.9. “Custom channel” switcher

A switcher that determines whether a custom channel should be used.

Disabled by default.

1.2.10. “Channel” field

A selection field that contains two options:

• email — for files from emails;

• case — for files attached to cases.

1.2.11. “Entity id” field

An input field for entering the entity identifier.

1.2.12. Break

Responsible for the completion of the flow execution.

• — initiates the end of the flow execution after the given component.

• — the switch is in the off position.

1.2.13. 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 .

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.

Fig. 4. Setting a limit

1.2.14. 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.

Fig. 5. Add description