Chatbot Building Platform Logo of Itheta Labs

Field (Variable)

Field (Variable) – TIP

Before diving into each detailed step, let’s understand what a field (or variable) is. It might take a moment, but this is fundamental to understanding the system.

A Field (also known as a variable) is a container designed to hold a value.

Classification & Description

  • System Field and Custom Field: System fields are generated by the system with pre-defined variable names and types. In contrast, custom fields are defined by the user.
  • Bot Field and User Field: Bot fields are shared across the entire bot, while each user has a unique set of user fields.
  • Text Field, Number Field, Boolean Field, Date Field, DateTime Field, and JSON Field: These classifications are based on variable type.

User Field

User fields are unique to users. For instance, every user has their distinct name and email address. Hence, “name” and “email” are user fields.

Bot Field

Bot fields belong to the bot. For instance, a restaurant bot might contain the restaurant’s address and contact number. Therefore, “restaurant_address” and “restaurant_contact” are bot fields. These fields are consistent across all users.

System Field

System fields are generated by the system with pre-defined variable names and types. Both system bot fields and system user fields exist.

Here’s a table of some system fields:

 

Field NameField TypeVariable TypeDescriptionHow to Edit
User Nsuser fieldtextuser identification in UChatnon-editable
User Id*user fieldtextuser identification from the channelnon-editable
First Nameuser fieldtextprofile infoin Question Step/Action Step
Last Nameuser fieldtextprofile infoin Question Step/Action Step
User Nameuser fieldtextprofile infoin Action Step
Genderuser fieldtextprofile infoin Action Step
Emailuser fieldtextprofile infoin Question Step/Action Step
Phoneuser fieldtextprofile infoin Question Step/Action Step
Profile Imageuser fieldtextprofile infoin Question Step
Localeuser fieldtextprofile infonon-editable
Timezoneuser fieldtextprofile infonon-editable
Languageuser fieldtextprofile infoin Action Step
Subscribeduser fielddatetimesubscribed timenon-editable
Last Text Inputuser fieldtextuser’s last inputedited by system
Last Interactionuser fielddatetimelast action timeedited by system
Last Button Titleuser fieldtextlast button pressededited by system
Flow Nsbot fieldtextflow(bot) identification in UChatnon-editable
Sub Flow Nsbot fieldtextsub flow identification in UChatnon-editable
Page Namebot fieldtextconnected Facebook page namenon-editable
Page Idbot fieldtextconnected Facebook page idnon-editable
Page User Namebot fieldtextusername of the page in Facebooknon-editable
Last FB Commentuser fieldtextuser’s last comment text in the Facebook pageedit by system
Last FB Comment Post Iduser fieldtextpost id of where user put the last commentedit by system
Last FB Comment total tagged usersuser fieldnumbertagged users amount in last commentedit by system
Last FB Comment total new tagged usersuser fieldnumbertagged but haven’t subscribed(to bot) users amountedit by system
Last FB Comment is existing usersuser fieldnumberbefore this comment, is he/she an existing user? yes=1,no=0edit by system
Live Chat Urluser fieldtext(for agent) visit to talk to user in live chatedit by system
NOWuser fielddatetimecurrent time in user’s timezone*edited by system
TODAYuser fielddatecurrent date in user’s timezone*edited by system
BOT_CURRENT_TIMEbot fielddatetimecurrent datetime in workspace’s timezoneedited by system
ITEMuser fieldarray (JSON)each item in a JSONin “For Each” message
SELECTuser fieldarray (JSON)selected itemin “Select” new step
SHOPbot fieldarray (JSON)store informationin Ecommerce Integration
CARTuser fieldarray (JSON)user shopping cartin Action Step
ORDERuser fieldarray (JSON)user’s last orderedited by system
Useruser fieldarray (JSON)user’s profileedited by system according to other profile values
DialogFlowuser fieldarray (JSON)DialogFlow responseedited by DialogFlow agent

 

User Id in Different Channels

 

ChannelMeaningExample Value
FacebookUnique Id in your Facebook page6288386817841812

Variable Type

We offer six variable types:

  • Text: Letters, words, sentences, etc. (e.g., “Hi, Itheta.”)
  • Number: Numerical values (e.g., 123.45)
  • Boolean: Either “1” (true) or “0” (false)
  • Date: Specific dates (e.g., 2021-03-30)
  • DateTime: Date and time combined (e.g., 2022-01-01T12:00:00+10:00)
  • JSON (array): A series of variables (e.g., {"name":"Jack", "age":"20"})

Boolean Value

A boolean returns false when these values are stored in the field:

  • empty
  • null
  • ‘false’
  • false
  • ‘no’
  • 0

Create Custom Field

Now that you’re familiar with fields, it’s time to try them out!

Create a Custom Field in the Contents Section

  1. Go to Contents from the left sidebar.
  2. Select User Fields or Bot Fields.
  3. Organize your fields using folders if necessary.

 

Click the blue “+ New User/Bot Field” button on the right to create a new field. Ensure you provide a “Field Name”. After that, select the appropriate variable type and add a default value or description if necessary. Using folders can help organize variables, especially as your flow expands.

 

question

Create Custom Field in Question and Action Step

In steps like the question step:

  1. Type in a new variable name in the “Enter Field Name” box.

question

“Enter Field Name” box and click it in the drop-down list. Select corresponding variable type and here you go.

 
 

Get in TOUCH with us!

Have questions or feedback? Fill out the form below, and we’ll connect with you shortly. We’re here to help!

Leave a Reply

Your email address will not be published. Required fields are marked *