20min

User Attributes

1. Introduction

Attributes are used to store data entered by the user during the conversation that can be later transferred or used in various use-cases.

User attributes can also be used as variables for storing data related to a path execution. For example – the email or username of a chatbot user, items ordered, quantity and delivery address for a pizza ordering bot and so on.

2. How does it work

The following example will provide you with an in-depth knowledge of its functioning.

For example – I have an attribute called Name that will store the names of my users.

User A enters Adam User B enters Beck User C enters Cenly

 

Attribute name 
Name 
Age 
User A 
Adam
21
User B 
Beck
32
User C 
Cenly
19

This information will be stored just for these users and they won’t be mixed up as we have identifiers to map them.

3. Methods to use Attribute Feature

You can invoke this feature into the platform via the following methods. 

  • Date Input Nodes – Request User Data, Form and Identity node.
  • Processing Nodes – Set Attribute Node.
  • Display Information nodes – Send Message With Options node.
  • JSON and Script nodes.
  • Website scripts.

4. System Defined Attributes

Engati has two different sets of attributes –

System Defined – Attributes that are automatically created by  Engati for capturing the data.

For example – Facebook is a channel that provides user names of the person, hence this value is automatically pre-populated in the user.user_name attribute.

A standard system Attribute has a structure {{user.<attribute name>}}

Example: Attribute for full name {{user.user_name}}. This is a system generated.

Document image

Custom attributes – Attributes created by the Users for their use-case.

System-defined attributes generate values based on the channels they are deployed on. Z

The type and name of the attribute are defined while creation.

Note : 

Attributes that are already present in the bot are system-defined and we would encourage users to not create another attribute with the same name as a system-defined attribute.

This overrides the existing functionality of value generation and makes it a custom attribute that in turn will no longer automatically capture the values.

5. Viewing and Using attribute Values

To call an attribute inside the relevant node you can use the { and a dropdown will be shown with the list of attributes.

To call an attribute inside the script node you can use the # and a dropdown will be shown with the list of attributes.

You can use APIs to filter out results based on attribute name and their value by the Engati API.

Attributes and their values are stored for each user that can be accessed via the Users page.

Document image

6. Standard Attribute Length

The attributes are limited in size by design. The constraint is due to performance factors.

Here are the standard limits:

  1.   Up to 25K characters for in-flow usage
  2. Up to 1000 characters for also persisting this information in DB for reporting and segmentation.

Note: For double-byte characters, these limits may be halved.

In order to deal with larger data, it is a standard practice for any development to split the data or use paginated responses.

In case of any issues feel free to reach out to support@engati.com.



Updated 01 Jul 2022
Did this page help you?
Yes
No