Introduction

The "Form" component in wolkvox Studio allows you to create a form so that the agent can capture customer data during an interaction (Agent Scripting).

Each completed field is stored in a variable (e.g., $fullname, $dni, $email, etc.), so you can later use these values within the flow (validations, database submissions, API consumption, messages, etc.).

Note that the data captured in the "Form" is not automatically stored in wolkvox Manager reports. If you need to save them, you must do so using flow components.

Configuration

Double-click the component to open its configuration panel (right side).

In the "Question" field, write the text that the agent will see as the main instruction. This text serves as a guide for the agent to know what to capture.

Below the Question, you will see a table (with columns such as Label, Type, ID Name, Default Value, and the required indicator). To create fields:

1. Right-click inside the table.
   • Select Add Item.
2. In the pop-up window, configure:
   • Label: The visible name of the field (what the agent will see).
   • Type: Field type. You can use: text, number, password, radio, select, select_search, email, checkbox, date, textarea, color.
   • ID Name: Name of the variable where the value will be stored.
     • Important: Do not write the $ sign. The system adds it internally.
     • Example: If you enter fullname, you can later use $fullname.
   • Default Value (if applicable): Default value of the field (optional). If left empty, the value is assigned when the agent fills out the form.
   • Values list (only for radio, select, and select_search): List of options separated by commas.
   • Required Field: Enable this if you want the agent to be unable to submit the form without completing this field.
   • Click "Add" to include the field in the table.

Available Field Types in the "Form" Component

When configuring a field within the "Form" component, the "Type" attribute defines the type of information the agent can capture and how that field will be displayed in the form. Below is a description of each available option:

text

• Free text field.
• Allows the agent to enter any alphanumeric value without specific restrictions.
• Recommended use: names, addresses, short comments, general references.

number

• Numeric field.
• Only allows entering numbers. Does not accept letters or special characters.
• Recommended use: ID documents, quantities, ages, numeric codes.

password

• Hidden text field.
• The entered value is displayed masked (•••••) to protect sensitive information.
• Recommended use: Temporary passwords, access codes, or sensitive information only when strictly necessary, always carefully controlling where the variable is reused.
• Important note: Although the value is visually hidden in the form, the information is stored in a normal variable. If that variable is used or displayed later in another component of the flow, the value will be shown in plain text.

radio

• Single selection from multiple options.
• The agent can only choose one option from a list defined in Values list.
• Recommended use: Yes/No questions, mutually exclusive states, unique decisions.

select

• Single-selection dropdown list.
• Displays the options defined in Values list within a dropdown menu.
• Recommended use: Closed catalogs such as products, categories, cities, plans.

select_search

• Dropdown list with search.
• Works like select, but allows searching within the list when there are many options.
• Recommended use: Long lists (e.g., models, branches, extensive references).

email

• Email field.
• Automatically validates that the entered value has the format of a valid email.
• Recommended use: Customer or contact email addresses.

checkbox

• Multiple selection or confirmation field.
• Allows checking or unchecking an option (true/false).
• Recommended use: Acceptance of terms and conditions, confirmations, authorizations.

date

• Date picker.
• Displays a calendar for the agent to select a specific date.
• Recommended use: Purchase dates, birthdates, delivery dates, expirations.

textarea

• Multiline text field.
• Allows entering long texts and is displayed as an expanded area.
• Recommended use: Observations, customer notes, detailed comments.

color

• Color picker.
• Allows selecting a color and saves its value (e.g., in hexadecimal format).
• Recommended use: Customization, visual selection, color identification.

Tip: If you need to adjust an already created field, from the same context menu of the table, you can use options such as Edit Item or Delete Item.

When you finish creating all the fields, click "Save Form" (bottom of the panel).

1. Use the captured variables in the flow (practical example).
2. Once the agent fills out the form, the data becomes available in variables prefixed with $.