{"id":23796,"date":"2020-07-03T16:47:31","date_gmt":"2020-07-03T15:47:31","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?p=23796"},"modified":"2022-09-22T12:40:46","modified_gmt":"2022-09-22T11:40:46","slug":"working-with-the-form-node","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-form-node\/","title":{"rendered":"Form Node"},"content":{"rendered":"
<\/div><\/div><\/section>
<\/div><\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

The Form node lets you integrate <\/span>Digital Forms<\/span><\/a> with Dialog Tasks. This facilitates the presentation of forms to capture user inputs for specific use cases.<\/span><\/p>\n

The primary purpose of the Form node is to represent a UI Form in the dialog task and make the form available for end-users on their channel. For example, let us consider a travel assistant that has a form to capture the customer details to make a new booking. During this process, you may want to use the form instead of prompting for each and every entity value.<\/span><\/p>\n

<\/div><\/div>\n

Add the Node<\/span><\/span><\/h1>\n

Before you can begin setting up a Form node, you need to have previously created a Digital Form to use within the node. <\/span><\/p>\n

To add a form node to the dialog task, follow the below steps:<\/span><\/p>\n

    \n
  1. Open the dialog task<\/strong> to which you want to add the Form node.<\/span><\/li>\n
  2. Add the Form node <\/strong>in the designated place. To learn how to add nodes, please <\/span>click here<\/span><\/a>. You will be shown a list of existing Digital Forms from which you can choose the one to add to this node.<\/span><\/li>\n
  3. Choose the Form Experience<\/strong>: <\/span>If you are offering your Virtual Assistant on multiple channels, you can choose whether to enable the Digital Form Experience as the default experience on all these channels, or use a combination of Digital Form Experience and Conversation Experience.<\/span><\/li>\n

    \"\"<\/a><\/p>\n

  4. Only UI Form<\/strong>: Users will be presented the Digital Form Experience on all the channels that are enabled for the assistant that you are working with. This will create a Form Node and automatically open the Component Properties panel, where you can continue configuring the node.<\/span><\/li>\n

    \"\"<\/a><\/p>\n

  5. Both Digital Form and Conversational Experience<\/strong>: You can choose the channels on which the Digital Form Experience should be enabled and all other channels will use the Conversational Experience.<\/span>
    <\/span><\/li>\n

    \"\"<\/a><\/p>\n

  6. By following this process, the Platform will automatically add a Form Experience Transition<\/em><\/strong> (Bot Action) node group,<\/strong> which ramifies into the necessary Dialog Task and Form Node, to allow you to further customize the Form Experience and Conversation Experience for your channel selection. This Transition is composed of individual nodes, which you will need to configure separately, according to their respective node types.
    \n    \"\"<\/a>\n<\/ol>\n
    <\/div><\/div>\n

    Configure the Node<\/span><\/span><\/h1>\n

    This configuration applies to the Form Node Type – regardless of whether it is standalone by selecting Only UI Form during setup, or whether it is part of a Form & Conversation Experience.<\/span><\/p>\n

    <\/div><\/div>\n

    Component Properties<\/span><\/span><\/h2>\n

    The Form Component Properties allow you to configure a variety of settings and prompts related to your Form Node, as follows: <\/span><\/p>\n\n\n\n
    \n

    Note<\/em><\/strong>: The configurations you set up or modify in this section are reflected in all other dialog tasks that use this node.<\/span><\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      \n

       <\/p>\n

    1. On the <\/span>Component Properties<\/strong> tab, under the <\/span>General Settings <\/strong>section, enter a <\/span>Name<\/strong> and <\/span>Display Name<\/strong> for the form node. Node names cannot contain spaces, but the Display Name can. <\/span><\/li>\n
    2. In the <\/span>User Prompts <\/strong> text box, enter the prompt message that you want the user to see for this form. It should instruct the user to click on the link to initiate the form. It is not recommended to change the context variable reference (of the form <\/span>{{context.form_node.formLink}}<\/span>)coded therein. You can enter channel-specific messages for user prompts. For more information, refer to <\/span>Using the Prompt Editor<\/span><\/a>.<\/span><\/li>\n
    3. In the <\/span>Error Message<\/strong> text box, review the default error message, and if required modify it. For more information, refer to <\/span>Using the Prompt Editor<\/span><\/a>.<\/span><\/li>\n
    4. In the <\/span>Submit Message<\/strong> text box, review the default message that is displayed after successful submission of the form, and if required, modify it. This message is applicable only when the UI Form is opened in a browser tab and not for Web\/Mobile SDK. For more information, refer to <\/span>Using the Prompt Editor<\/span><\/a>.<\/span><\/li>\n
    5. Under the <\/span>Web\/Mobile SDK Form Behavior<\/strong> section, you can set how the form is displayed. You can select:<\/span><\/li>\n
        \n
      1. Open full page popup form<\/strong> – This is the default setting where the form opens as a full page on the SDK chat interface.<\/span><\/li>\n
      2. Open inline form<\/strong> – The form opens as an inline form within the chat window.<\/span><\/li>\n<\/ol>\n
      3. In the <\/span>Variable Namespaces<\/strong> section, associate the variable namespaces used to execute this node and its transitions. This option is visible only when the variable namespace is enabled for the Virtual Assistant. You can go with the task level settings or customize it for this node. For more information, refer to <\/span>Managing Namespace<\/span><\/a>.<\/span><\/li>\n<\/ol>\n

        \"\"<\/a>
        \n

        <\/div><\/div>\n

        Instance Properties<\/span><\/span><\/h2>\n

        Use the Instance Properties to define any user tags that you want to set.<\/span><\/p>\n\n\n\n
        \n

        Note<\/em><\/strong>: The settings in the <\/span><\/em>Instance Properties <\/em><\/strong>tab are specific to the current dialog task and do not reflect in other dialog tasks that use this form node.<\/span><\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

         <\/p>\n

        To configure this tab, please follow these steps:<\/span><\/p>\n

          \n
        1. On the Form window, click the <\/span>Instance Properties<\/strong> tab.<\/span><\/li>\n
        2. Under the <\/span>Custom<\/strong> Tags <\/strong>section, add tags to build custom profiles of your conversations. <\/span>Click here for more<\/span><\/a>.<\/span><\/li>\n<\/ol>\n

          \"\"<\/a>
          \n

          <\/div><\/div>\n

          Connections Properties<\/span><\/span><\/h2>\n

          From the node’s <\/span>Connections<\/strong> tab, you can determine the node in the dialog task to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.<\/span><\/p>\n\n\n\n
          \n

          Note<\/em><\/strong>: These conditions are applicable only for this instance and will not affect the node when being used in any other dialog.<\/span><\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

           <\/p>\n

          For details on how to work with connection conditions, please see<\/span> Adding IF-Else Conditions to Node Connections. <\/span><\/a><\/p>\n

          \"\"<\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

          <\/div><\/div>[vc_raw_html]JTNDZGl2JTIwY2xhc3MlM0QlMjJ3LXBvc3QtZWxtJTIwcG9zdF9uYXZpZ2F0aW9uJTIwbGF5b3V0X3NpbXBsZSUyMGludl9mYWxzZSUyMiUzRSUwQSUwOSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfZmlyc3QlMjB0b19wcmV2JTIyJTIwaHJlZiUzRCUyMiUyRmRvY3MlMkZib3RzJTJGYm90LWJ1aWxkZXItdG9vbCUyRmRpYWxvZy10YXNrJTJGd29ya2luZy13aXRoLXRoZS1lbnRpdHktbm9kZSUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFUHJldmlvdXMlM0MlMkZkaXYlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLXRpdGxlJTIyJTNFJTNDc3BhbiUzRUVudGl0eSUyME5vZGUlM0MlMkZzcGFuJTNFJTNDJTJGZGl2JTNFJTBBJTNDcCUzRSUzQyUyRmElM0UlM0NiciUyMCUyRiUzRSUwQSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfc2Vjb25kJTIwdG9fbmV4dCUyMiUyMGhyZWYlM0QlMjIlMkZkb2NzJTJGYm90cyUyRmJvdC1idWlsZGVyLXRvb2wlMkZkaWFsb2ctdGFzayUyRndvcmtpbmctd2l0aC10aGUtbG9naWMtbm9kZSUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFTmV4dCUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFTG9naWMlMjBOb2RlJTNDJTJGc3BhbiUzRSUzQyUyRmRpdiUzRSUwQSUzQ3AlM0UlM0MlMkZhJTNFJTNDJTJGZGl2JTNFJTBB[\/vc_raw_html]
          <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

          [vc_raw_html]JTNDZGl2JTIwY2xhc3MlM0QlMjJ3LXBvc3QtZWxtJTIwcG9zdF9uYXZpZ2F0aW9uJTIwbGF5b3V0X3NpbXBsZSUyMGludl9mYWxzZSUyMiUzRSUwQSUwOSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfZmlyc3QlMjB0b19wcmV2JTIyJTIwaHJlZiUzRCUyMiUyRmRvY3MlMkZib3RzJTJGYm90LWJ1aWxkZXItdG9vbCUyRmRpYWxvZy10YXNrJTJGd29ya2luZy13aXRoLXRoZS1lbnRpdHktbm9kZSUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFUHJldmlvdXMlM0MlMkZkaXYlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLXRpdGxlJTIyJTNFJTNDc3BhbiUzRUVudGl0eSUyME5vZGUlM0MlMkZzcGFuJTNFJTNDJTJGZGl2JTNFJTBBJTNDcCUzRSUzQyUyRmElM0UlM0NiciUyMCUyRiUzRSUwQSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfc2Vjb25kJTIwdG9fbmV4dCUyMiUyMGhyZWYlM0QlMjIlMkZkb2NzJTJGYm90cyUyRmJvdC1idWlsZGVyLXRvb2wlMkZkaWFsb2ctdGFzayUyRndvcmtpbmctd2l0aC10aGUtbG9naWMtbm9kZSUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFTmV4dCUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFTG9naWMlMjBOb2RlJTNDJTJGc3BhbiUzRSUzQyUyRmRpdiUzRSUwQSUzQ3AlM0UlM0MlMkZhJTNFJTNDJTJGZGl2JTNFJTBB[\/vc_raw_html]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[29],"tags":[],"class_list":["post-23796","post","type-post","status-publish","format-standard","hentry","category-dialog-task"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/23796","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=23796"}],"version-history":[{"count":14,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/23796\/revisions"}],"predecessor-version":[{"id":45220,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/23796\/revisions\/45220"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=23796"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=23796"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=23796"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}