{"id":23796,"date":"2020-07-03T16:47:31","date_gmt":"2020-07-03T15:47:31","guid":{"rendered":"https:\/\/developer.kore.ai\/?p=23796"},"modified":"2021-08-04T07:27:29","modified_gmt":"2021-08-04T06:27:29","slug":"working-with-the-form-node","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/v9-0\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-form-node\/","title":{"rendered":"Form Node"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row via_grid cols_custom laptops-cols_inherit tablets-cols_inherit mobiles-cols_1 valign_top type_default stacking_default\"><\/div><\/div><\/section><div class=\"wpb_column vc_column_container\"><div class=\"vc_column-inner\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><p>Form node lets you integrate the <a href=\"\/docs\/bots\/bot-builder-tool\/action-info-task\/create-a-report-task\/#\" target=\"_blank\" rel=\"noopener noreferrer\">Digital Forms<\/a> with Dialog Task. This facilitates the presentation of form to capture user inputs for specific use cases.<\/p>\n<p>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 banking bot that has a form to capture the customer details to open a new account. You want to use the form instead of prompting for each and every entity value.<\/p>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h2><span class=\"ez-toc-section\" id=\"Set-Up\"><\/span><span id=\"Set-Up\" class=\"ez-toc-section\">Set-Up<\/span><span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Setting up a form node in a dialog task involves the following steps:<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Add_Node\"><\/span>Add Node<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>To add a form node to the dialog task, follow the below steps:<\/p>\n<ol>\n<li>Open the dialog task to add the Form node.<\/li>\n<li>Add form node in the designated place. For steps in adding nodes, <a href=\"\/docs\/bots\/chatbot-overview\/using-the-dialog-builder-tool\/#Adding_Nodes\">refer here<\/a>.<\/li>\n<li>The Form Node window is displayed with the <strong>Component Properties<\/strong> tab selected by default.<\/li>\n<\/ol>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h2><span class=\"ez-toc-section\" id=\"Configure_Node\"><\/span><span id=\"Configure\" class=\"ez-toc-section\">Configure Node<\/span><span class=\"ez-toc-section-end\"><\/span><\/h2>\n<h3><span class=\"ez-toc-section\" id=\"Component_Properties\"><\/span>Component Properties<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>The Form Component Properties allow you to configure the General Settings, User, and Error Prompts.<\/p>\n<div class=\"alert alert-info\"><b>Note:<\/b> The configurations you set up or modify in this section are reflected in all other dialog tasks that use this node.<\/div>\n<div><\/div>\n<ol>\n<li>On the <strong>Component Properties<\/strong> tab, under the <strong>General Settings <\/strong>section, enter a <strong>Name<\/strong> and <strong>Display Name<\/strong> for the form node. Node names cannot have spaces. The <strong>UI Form<\/strong> property is set to the UI Form you selected and it cannot be changed.<\/li>\n<li>In the <b>Prompt Message<\/b> text box, enter the prompt message that you want the user to see for this form. It gives instructions to 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 style=\"font-weight: 400;\"><code>{{context.form_node.formLink}}<\/code>)<\/span>coded therein. You can enter channel-specific messages for user prompts. For more information, refer to <a href=\"\/docs\/bots\/bot-builder-tool\/dialog-task\/prompt-editor\/\">Using the Prompt Editor<\/a>.<\/li>\n<li>In the <b>Error Message<\/b> text box, review the default error message, and if required modify it. For more information, refer to <a href=\"\/docs\/bots\/bot-builder-tool\/dialog-task\/prompt-editor\/\">Using the Prompt Editor<\/a>.<\/li>\n<li>In the <b>Submit Message<\/b> 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 <a href=\"\/docs\/bots\/bot-builder-tool\/dialog-task\/prompt-editor\/\">Using the Prompt Editor<\/a>.<\/li>\n<li>Under the <strong>Web\/Mobile SDK Form Behavior<\/strong> section, you can set how the form is displayed. You can select:\n<ul>\n<li><strong>Open full page popup form<\/strong> &#8211; This is the default setting where the form opens as a full page on the SDK chat interface.<\/li>\n<li><strong>Open inline form<\/strong> &#8211; The form opens as an inline form within the chat window.<\/li>\n<\/ul>\n<\/li>\n<li>In the <strong>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 bot. You can go with the task level settings or customize it for this node. For more information, refer to <a href=\"\/docs\/bots\/bot-settings\/bot-management\/managing-namespace\/\" target=\"_blank\" rel=\"noopener noreferrer\">Managing Namespace<\/a>.<\/li>\n<\/ol>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h3><span class=\"ez-toc-section\" id=\"Instance_Properties\"><\/span>Instance Properties<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>Use the Instance Properties to define any user tags that you want to set.<\/p>\n<div class=\"alert alert-info\"><b>Note:<\/b> The settings in the Instance Properties tab are specific to the current dialog task and do not reflect in other dialog tasks that use this form node.<\/div>\n<div><\/div>\n<ol>\n<li>On the Form window, click the <strong>Instance Properties<\/strong> tab.<\/li>\n<li>Under the <strong>Custom<\/strong> <strong>Tags <\/strong>section, add tags to build custom profiles of your bot conversations. <a href=\"\/docs\/bots\/bot-builder-tool\/dialog-task\/custom-meta-tags\/\">Click here for more<\/a><\/li>\n<\/ol>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\n<div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h3><span class=\"ez-toc-section\" id=\"Connections_Properties\"><\/span>Connections Properties<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>From the node\u2019s <strong>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.<br \/>\nTo setup Component Transitions, follow the below steps:<\/p>\n<ol>\n<li>On the Form window, click the <strong>Connections<\/strong> tab.<\/li>\n<li>Under the <strong>Connection Rules<\/strong> section, you can select a node from the <strong>Default<\/strong> drop-down list.<\/li>\n<li>To configure a conditional flow, click <b>Add IF<\/b>.<\/li>\n<li>Configure the conditional expression based on one of the following criteria:\n<ul>\n<li><b>Entity<\/b>: Compare an entity node in the dialog with a specific value using one of these operators: Exists, equals to, greater than equals to, less than equals to, not equal to, greater than, and less than. Select the entity, operator using the respective drop-down lists, and type the number in the <b>Value <\/b>box. For example, <i>PassengerCount (entity) greater than (operator) 5 (specified value).<\/i><\/li>\n<li><b>Context<\/b>: Compare a context object in the dialog with a specific value using one of these operators: Exists, equals to, greater than equals to, less than equals to, not equal to, greater than, and less than. For example,<b>\u00a0<\/b><i>Context. entity.PassengerCount<\/i> <i>(Context object) greater than (operator) 5 (specified value).<\/i><\/li>\n<li><b>Intent: <\/b>Select an intent that matches the next user utterance.<\/li>\n<\/ul>\n<\/li>\n<li>From the <b>Then go to<\/b> drop-down list, select the next node to execute in the dialog flow if the conditional expression succeeds. For example, if the <i>PassengerCount (entity) greater than (operator) 5 (specified value), <\/i><b>Then go to <\/b><i>Offers (sub-dialog).<\/i><\/li>\n<li>In the <b>Else <\/b>drop-down list, select the node to execute if the condition fails.<\/li>\n<li>Click <strong>Save<\/strong>.<\/li>\n<\/ol>\n<div class=\"alert alert-info\"><b>Note:<\/b> If you want to write multiple <em>If<\/em> conditions, click <strong>Add Else If<\/strong> below the last If conditional expression.<\/div>\n<p>&nbsp;<\/p>\n<\/div><\/div><div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>[vc_raw_html]JTNDZGl2JTIwY2xhc3MlM0QlMjJ3LXBvc3QtZWxtJTIwcG9zdF9uYXZpZ2F0aW9uJTIwbGF5b3V0X3NpbXBsZSUyMGludl9mYWxzZSUyMiUzRSUwQSUwOSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfZmlyc3QlMjB0b19wcmV2JTIyJTIwaHJlZiUzRCUyMiUyRmRvY3MlMkZib3RzJTJGYm90LWJ1aWxkZXItdG9vbCUyRmRpYWxvZy10YXNrJTJGd29ya2luZy13aXRoLXRoZS1lbnRpdHktbm9kZSUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFUHJldmlvdXMlM0MlMkZkaXYlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLXRpdGxlJTIyJTNFJTNDc3BhbiUzRUVudGl0eSUyME5vZGUlM0MlMkZzcGFuJTNFJTNDJTJGZGl2JTNFJTBBJTNDcCUzRSUzQyUyRmElM0UlM0NiciUyMCUyRiUzRSUwQSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfc2Vjb25kJTIwdG9fbmV4dCUyMiUyMGhyZWYlM0QlMjIlMkZkb2NzJTJGYm90cyUyRmJvdC1idWlsZGVyLXRvb2wlMkZkaWFsb2ctdGFzayUyRndvcmtpbmctd2l0aC10aGUtbG9naWMtbm9kZSUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFTmV4dCUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFTG9naWMlMjBOb2RlJTNDJTJGc3BhbiUzRSUzQyUyRmRpdiUzRSUwQSUzQ3AlM0UlM0MlMkZhJTNFJTNDJTJGZGl2JTNFJTBB[\/vc_raw_html]<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>[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":[],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/23796"}],"collection":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/comments?post=23796"}],"version-history":[{"count":31,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/23796\/revisions"}],"predecessor-version":[{"id":29411,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/23796\/revisions\/29411"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/media?parent=23796"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/categories?post=23796"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/tags?post=23796"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}