Context handler function
Context handler function is used to control the conversational flow of an action. You can change the order in which the params are prompted to the users in the runtime. You can also skip some params, do custom validations of the param values and ask for a confirmation before action execution in the runtime.
Please note that, the context handler function can override the order in which the static params are defined. If the context handler function is enabled, the bot will prompt the parameters in the order as dictated by the context handler function and not by the order you have declared while defining the params.
Invocation Point
Once Zia Skills detects the action of the user input, the possible param values that are present in the user input will be detected; then, the bot will prompt the first missing param to the user. When a user replies to the param prompt, Zia Skills will invoke the context handler function. Hence, context handler function is invoked for every param that is prompted in the conversation. If an action doesn’t have any params at all, the context handler function will be executed once before the execution function.
Input Arguments
In addition to the system defined input arguments, the following input arguments are also available for the Context handler function.
|
Argument |
Deluge data type |
Description |
|
userInput |
String |
Latest reply from the user. |
|
previousParam |
Map |
The param that is last prompted to the user. The user reply has been made as a value to this param. |
Return Value
Context handler function must return a Map that should be in the following format.
{
"todo":"prompt",
"prompt":{
"param_name":"<name of the param to be prompted>",
"prompt_msg":"<the text to be displayed as a prompt message>",
"options":[ ],
"buttons":[ ],
"fields":[ ],
"submit_button_label":"<the text to be displayed as the label of the submission button in the form>",
"more_button_label":"<the text to be displayed as the label of the 'more' button in the form>",
"max_submissions_allowed":"<1-100>"
},
"confirm":{
"message":"Are you sure you want to cancel?"
},
"assign":{
"clientData":{ }
}
}
"todo":"prompt",
"prompt":{
"param_name":"<name of the param to be prompted>",
"prompt_msg":"<the text to be displayed as a prompt message>",
"options":[ ],
"buttons":[ ],
"fields":[ ],
"submit_button_label":"<the text to be displayed as the label of the submission button in the form>",
"more_button_label":"<the text to be displayed as the label of the 'more' button in the form>",
"max_submissions_allowed":"<1-100>"
},
"confirm":{
"message":"Are you sure you want to cancel?"
},
"assign":{
"clientData":{ }
}
}
As shown above, the following are the keys that can be present in the map that would be returned from the Context handler function.
The following are the keys that can be present in the map that would be returned from the context handler function.
- todo (mandatory) — Used to indicate what Zia Skills should do next after completing the context handler function. It can take one of the following values only.
- prompt — Instructs the bot to prompt a param to the user.
- confirm — Instructs the bot to ask for a final confirmation for invoking the execution function of the action.
- execute — Instructs Zia Skills to invoke the Action execution function.
- prompt (mandatory, only if “todo” is set as “prompt”) — Contains a map that specifies what param is to be prompted to the user. If this key is not provided even if “todo” is set as “prompt”, the bot will prompt the next param as per the order of the param definition. So this key can be skipped if we will have to use the default order of the params definition. The map value can contain the following keys.
- param_name — The name of the param to be prompted. The param name should be one of the declared static or dynamic params.
- prompt_msg — Used to momentarily override the default prompt message of the param.
- options — The list of options of the single and multiple selection list params, only from which the user can choose.
- id — The unique id of the option.
- label — The text to be displayed as the option's label.
- preview - The additional information to be displayed for the options of the single select and multi select list params. Options previews will be available only when the input mode of the single select and multi select params is Visual.
-
header — The properties of the single select and multi select list param options. The header object should contain the following keys in the below format.
{
"id":"<the unique id for the option>",
"label":"<the text to be displayed as the option's label>",
"preview":{
"header":{
"title":"<the text to be displayed as the option preview's title>",
"description":"<the text to be displayed as the option preview's description>",
"subheading":"<the text to be displayed as the subheading to the option's preview>",
"image":{
"url":"<the url of the preview image>"
}
}
}
}If the 'header' key is configured with these appropriate key values for the options, then the previews will be displayed when the user clicks the info iconon each option.
In mobile, preview will be shown on 3D touch.
-
fields — The list of additional properties about the options. The "fields" object should contain the following keys in the below format.
[
{
"label":"<the text to be displayed as the field name>",
"value":"<the text to be displayed as the field value>"
}
]If the "preview" object is configured for an option, then the 'fields' object should be mandatorily defined for it. A maximum of seven fields can be configured for an option.
The key elements of the "preview" object are, "header" and "fields". If the "fields" object alone is configured for a "preview" object, then the previews will be displayed when the user hovers on the respective options.
Availability of previewing the single select and multi select options
- Supported Minimum client SDK version - 2.4.0.
- Not available for bots in other Zoho services.
Note : The 'preview' key is not a mandatory field that is required to be given for a single select/ multi select list param object.
-
buttons — Buttons are the preferred actions to be performed on the selected single select/multi select options. This is applicable only for the single and multiple selection list params. The "buttons" object should contain the following keys in the below format.
[
{
"id":"the unique id for the button",
"label":"the text to be displayed as the button's label",
"theme":"<positive | neutral | negative>"
}
]Note: A single / multi selection list param can have up to 3 buttons.
-
fields — Used to configure the fields and its properties for the "Form" param. The "fields" object should contain the following keys in the below format.
[
{
"label":"<label of the field>",
"name":"<unique name to identify the field>",
"type":"<valid param types>",
"mandatory":"true | false",
"default_value":"<valid value based on the respective field type>"
}
]- mandatory — If "true", then that respective field should be compulsorily filled by the user. It is "true" by default.
- For "type", the valid field types are: STRING, NUMBER, DATE, TIME, EMAIL, ARRAY_CHECKBOX, ARRAY_RADIO, DATE_RANGE, TIME_RANGE, DECIMAL_RANGE, and INTEGER_RANGE.
Note: A maximum of 10 fields can be configured for a form.
- mandatory — If "true", then that respective field should be compulsorily filled by the user. It is "true" by default.
- submit_button_label — The text that should be displayed as the label of the submission button in the form. This is applicable only for the "Form" param.
- more_button_label — The text that should be displayed as the label of the 'Save and add' button in the form. This is applicable only for the "Form" param.
Note: If "submit_button_label" and "more_button_label" are not configured for the "Form" param, then these buttons will be labelled as "Save", "Save and add" respectively by default.
- max_submissions_allowed — To specify the no. of submissions of the form that can be made by the user. You can specify the value of this key from 1 to 100. By default, the value of this key is "100". This key is applicable in configuring a form only when the "Allow multiple entries" toggle switch is enabled while creating the "Form" param.
- confirm (mandatory only if “todo” is set as “confirm”) — Contains a map that specifies the confirmation message for action execution that should be prompted to the user. The map value can contain only the following key.
- message — The confirmation message that should be prompted to the user.
- assign — The value of this key should be a map. This key is used to change the values to any of the mutable input arguments of the function. All the static params and the system defined argument “cache” are mutable.
- clientData — Used to update the client data values of the session data in the runtime.
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Action Execution function
The Execution function is the endpoint to an action execution. It defines the fulfillment of an action. This does the actual execution of the action and gives a final success (or failure) message to the user, as a result of the completion of an ...Fallback Function
When a bot receives an input message that it couldn't understand, it would reply with a "Sorry, I can't understand" message. If you wish to customize this default response message to give a reply of your own, you can customize that with Fallback ...Zoho SalesIQ: A sample Zobot powered by Zia Skills
Zobot is Zoho SalesIQ's virtual chat agent that is designed to interact with website visitors conversationally. Zobot automates the process of interacting with website visitors and helps to maintain the presence of a helping hand, even when all the ...Model & Flow of Actions
An Action of a Zia bot is characterized by its Sample sentences, Params and Functions. Params Params are the input data that are required to fulfill or execute an action. If we consider the execution of an action analogous to filling a form, then the ...Defining an Action
Adding a New Action To add a new Action to a Skill, follow the steps as given below. In the Skill's details page, under the ACTIONS tab, click the + ADD ACTION option. The Create New Action page appears. Give a meaningful name for the action. Based ...
New to Zoho LandingPage?
Zoho LandingPage Resources