Defining Params

Defining Params


Params are the input data received from the user, in order to complete an action. If we consider the execution of an action analogous to filling a form, then the fields in the form shall be considered as params for the action. 

For example, the params for an action to create an event would typically be,
  1. Title of the event
  2. Start time of the event
  3. End time of the event and so on

Users can give value to each of these params in a conversational way in their natural language and Zia Skills will extract the apt value for the params from the conversational user input and would convert into a computational value as per the declared data type of the param. An action can have a maximum of 20 params.

To add a new param to an action, click the  option under the PARAMS section or  option under the SET PARAM dialog box (that would appear while marking params in sample sentences).



In the NEW PARAM pop-up window, fill the following information.
  1. Param Name - A valid name for the param should comply with the following points..
    1. It should begin with a lower case alphabet.
    2. No characters other than alphabets and numbers are allowed.
    3. A param name can contain a maximum of 50 characters.
    4. It must be unique for an action.
    5. The following names cannot be used as a param, since they are reserved words in Zia Skills - userInput, previousParam, additionalParams, sessionData, broadcast, previousUserMsgs, cache, org, and user.

  2. Param TypeChoose an apt data type for the param. The following data types are supported by Zia Skills.
    1. String
    2. Integer Number
    3. Integer Number Range  two inputs representing the start and end range of integers.
    4. Decimal Number
      For this param type, you have to enter the following additional information.
      1. Precision — Specify the number of digits to be rounded off for a decimal number; the maximum precision allowed is five.
        Note: The optimal efficiency of Zia's Integer and Decimal number detection algorithm would be for numbers less than 15 digits (including decimals).
    5. Decimal Number Range — two inputs representing the start and end range of decimals. 
    6. Date
    7. Date Range — two inputs representing the start and end range of dates.
    8. Date/Time
    9. Date/Time Range — two inputs representing the start and end range of date/time.
      Note: 
      1. An action cannot have any date or time params if it has a date range or time range param.
      2. An action cannot have any integer or decimal params if it has an integer range or decimal range param.
    10. Boolean — a YES or NO input.
    11. Email
    12. Amount amount input with currency code / currency symbol.
    13. Form — a form to be displayed to the user to fill up and submit. Additionally, to allow users to make multiple submissions for this param, you need to turn on the Allow multiple entries toggle switch.

      For this param, you need to configure the properties of this form like fields, data types, default values, buttons, etc. in the Context handler function. To know more about configuring the form param, refer to this document.
      Availability of the 'Form' param
      1. Supported Minimum client SDK version - 2.4.0.
      2. Not available for bots in other Zoho services.

    1. File — a file to be uploaded as user input. For this param, you can specify what file types the user can upload.  Select the specific file types from the Allowed Types drop-down.


    2. Single selection List — a list of available options from which the user can select one.
    3. Multiple selection List — a list of available options from which the user can select more than one.

      For
       Single and Multiple selection List params, you have to enter the following additional information.
      1. OptionsThese are the list of available options from which the user can select either one or multiple choices. Click the drop-down adjacent to the Options field, and select any of the following based on your requirements.
        1. Enter manually  to configure the options statically without using any code.
        2. Fetch in runtime  to configure the options dynamically in the runtime.
      2. If you have selected Enter manually, then it is recommended to give every option as distinct value and understandable to the user.  Every option also has an ID, which is used to uniquely identify an option programmatically. Either you can enter the ID for every option manually or use the auto-generated ID as you type in the options. A valid name and ID for the selection list options should comply with the following points.
        1. ID supports only alphanumeric, hyphen and underscore.
        2. Both support a maximum of 150 characters.
        3. A selection list param can have up to 50 options.
                 
      1. If you have selected Fetch in runtime, then you can choose either Context Handler or Autocomplete Handler to define the relevant options based on your requirements.  By defining the options in any of these handler functions, you can also configure the previews for those options accordingly.
        Availability of fetching the options in runtime
        1. Supported Minimum client SDK version - 2.4.0.
        2. Not available for bots in other Zoho services.
      2. Allow values other than these options  It allows the user to submit their own value(s) rather than selecting from the list of options defined by you. If this option was enabled, then the IDs of such values will be set as 'null'.
        Availability of allowing values other than the configured options
        1. Supported Minimum client SDK version - 2.4.0.
        2. Not available for bots in other Zoho services.

      3. Buttons —  Buttons represent the actions to be executed on the selected selection list options. The default action is to submit these selected selection list options, if no buttons are configured.The following are the steps to configure a button.
        1. Click the Configure option beside the Buttons label and the CONFIGURE BUTTONS screen appears.
        2. Enter the following mandatory properties for each button.
          1. Label — The display text of the button.
          2. Id — An identifier for the business logic to uniquely identify which button is chosen during conversation.
          3. Theme  The colour scheme that reflects the appearance of the button in the conversation. The following three themes are supported.
            1. Positive — 
            2. Negative — 
            3. Neutral — 
        3. A valid name and ID for the buttons should comply with the following points.
          1. A button name and ID can include all alphanumeric and special symbols.
          2. They can contain a maximum of 150 characters.
          3. A selection list param can have up to 3 buttons.
        4. The Preview option can be used to see how the button might appear in the bot during conversation. 
          To add another button, click   and once the required buttons are successfully added, click DONE.

          Availability of buttons
          1. Supported Minimum client SDK version - 2.2.0.
          2. Not available for bots in other Zoho services.


  1.  Mode of Input It specifies the way in which a user can provide a value to the param. It can either be Textual or Visual. If Textual is chosen, the user will be able to type (in case of chat) or speak (in case of voice) the preferred value that they want to assign for the param. In case of Visual, the user have to select their input from the available options. The options will be displayed as a radio button (in case of single selection), check box (in case of multiple selection) or a date/time picker (in case of date/time range).
    Note: Mode of input is available only for range (time and date), single select and multiple select list params. 
  2. Prompt Message – It is the question that bot would ask the user to get the input for the param as a part of a bot conversation with the user. For example, to get the value for the start time of an event in the create event action, the prompt message shall be set as "At what time the event starts?" or "From when is the event?". This field should not be left empty and it should comply with the following points.
    1. It includes all alphanumeric and special symbols except #, /, \, &, *, +, = and parenthesis.
    2. It can contain a maximum of 255 characters.

      For range params, Prompt Message field is split into,
    3. Start of the Range — Prompt message to get the start value of the range.
    4. End of the Range — Prompt message to get the end value of the range.
  3. Allow to SkipIt enables the user to bypass answering a param while conversing with a bot.
    Availability of Skippable params
    1. Supported Minimum client SDK version - 2.2.0.
    2. Not available for bots in other Zoho services.

Reordering params 

The conversational flow of bot depends on the order of the defined params. Once an action is detected, bot will prompt all the unfilled params one by one with its respective prompt message, in the order that they are defined. You can rearrange the params under the PARAMS section by just dragging and dropping an individual param at the desired position. 

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        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 CRM Training
            Redefine the way you work
            with Zoho Workplace

              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 CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit

                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsFormstack alternativeEncrypted Forms

                              Wufoo alternativeSecure Forms

                              WCAG



                                        Create. Review. Publish.

                                        Write, edit, collaborate on, and publish documents to different content management platforms.

                                        Get Started Now







                                                          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.




                                                              Manage your brands on social media


                                                                • Desk Community Learning Series


                                                                • Digest


                                                                • Functions


                                                                • Meetups


                                                                • Kbase


                                                                • Resources


                                                                • Glossary


                                                                • Desk Marketplace


                                                                • MVP Corner


                                                                • Word of the Day


                                                                • Ask the Experts


                                                                  Zoho Sheet Resources

                                                                   

                                                                      Zoho Forms Resources


                                                                        Secure your business
                                                                        communication with Zoho Mail


                                                                        Mail on the move with
                                                                        Zoho Mail mobile application

                                                                          Stay on top of your schedule
                                                                          at all times


                                                                          Carry your calendar with you
                                                                          Anytime, anywhere




                                                                                Zoho Sign Resources

                                                                                  Sign, Paperless!

                                                                                  Sign and send business documents on the go!

                                                                                  Get Started Now




                                                                                          Zoho TeamInbox Resources





                                                                                                    Zoho DataPrep Demo

                                                                                                    Get a personalized demo or POC

                                                                                                    REGISTER NOW


                                                                                                      Design. Discuss. Deliver.

                                                                                                      Create visually engaging stories with Zoho Show.

                                                                                                      Get Started Now









                                                                                                                          • Related Articles

                                                                                                                          • Zoho SalesIQ: Building a Zobot with Zia Skills

                                                                                                                            Zia Skills can be used as a bot building platform for a Zobot in Zoho SalesIQ. A bot-building platform is a layer where you define the abilities and business logic of your chatbots. A bot-building platform has the following roles. Handling Natural ...
                                                                                                                          • Action Followups

                                                                                                                            Action Followups defines what the bot should recommend the user after executing an action, in order to engage the user further in conversation. The bot can display a list of suggestions or ask if it can invoke another action, that might be ...
                                                                                                                          • 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 ...
                                                                                                                            Wherever you are is as good as
                                                                                                                            your workplace

                                                                                                                              Resources

                                                                                                                              Videos

                                                                                                                              Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                              eBooks

                                                                                                                              Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                              Webinars

                                                                                                                              Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                              CRM Tips

                                                                                                                              Make the most of Zoho CRM with these useful tips.



                                                                                                                                Zoho Show Resources