1. Introduction #
In a business scenario, user information plays a crucial role in classifying new and returning users. Floatchat offers a feature called the Identity Node, which allows bot builders to collect user information and store it for returning users. This node enables the creation of input forms where users can provide their information, with an optional authentication validation before proceeding further. Let’s explore how to use the Identity Node in Floatchat.
2. Setup #
2.1 Creating the Node
To add an Identity Node, navigate to the Add a Node Modal and select the Identity Node.
As a bot builder, you can configure the following settings for the Identity Node:
- Title: This setting allows you to set the heading for the form (mandatory configuration).
- Subtitle: You can add a subheading to provide additional context for the form.
- Mode: The admin can choose the appropriate user identification mechanism, such as:
- Data Capture: This mode enables the collection of user information and saves it to attributes.
- Authenticate via JSON API: In this mode, user information can be collected and authenticated with a backend server using the JSON API node. The input fields and validations work similarly to the JSON API node.
You can define up to five fields for the form. Each field will have the following attributes:
- Display Name: This is the label shown on the form.
- Attribute Name: The user’s input will be saved to the attribute name defined.
- Type: You can define a type to serve as a validator for the user’s input.
- Unique Identifier: When checked, this attribute will be used to identify the user uniquely.
2.3 End-User Flow
When the Identity Node is encountered in a bot flow, the end user will see a form-like screen with the specified details to be filled in.
The form fields and validation conditions can be defined by the admin during node configuration.
The end user needs to fill in all the displayed fields to proceed, unless the Skip option is enabled by the admin.
The information entered in the form can be used to identify the bot user in future workflows.
- If the response includes a parameter named “username” (when using the Identity Node with JSON API), it will be used as the username.
- If the above condition is not satisfied, the system checks if any of the form attribute names is “username”.
- If the username is not found in step 2, it checks if the user already has a username. If yes, the username remains the same. If no, the first attribute marked as unique during node configuration will be set as the username.
This concludes the explanation of using the Identity Node in Floatchat.