{"id":27065,"date":"2021-03-17T06:38:44","date_gmt":"2021-03-17T06:38:44","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-0\/?p=27065"},"modified":"2021-03-17T06:38:44","modified_gmt":"2021-03-17T06:38:44","slug":"alert-task-report-templates","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-0\/docs\/bots\/bot-builder-tool\/alert\/alert-task-report-templates\/","title":{"rendered":"Alert Task \u2013 Report Templates"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\">\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>For some Alert tasks, <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/#Bot_Response\" target=\"_blank\" rel=\"noopener noreferrer\">as seen here<\/a>, you may want to display the bot response to the end-user as a link that can display the payload response using a template, such as a table, contact card, or formatted for a specific message type such as a weather report.<\/p>\n<p class=\"note\"><strong>Note:<\/strong> This section is not used for webhook alert tasks, action tasks, or RSS alert tasks.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h4>Configuring the Report Template Definition<\/h4>\n<p>To add a link to a task to provide more information or a report, you can define <strong>a link<\/strong> and information to display for the report as a table, weather report, or contact card in the end-user application.<br \/>\nTo get started with defining the<b>\u00a0Report Template Definition<\/b>\u00a0for a\u00a0task, on the<strong> Bot Response<\/strong>\u00a0tab, click the <strong>Expand<\/strong> icon in the<b> (Optional) Report Template Definition<\/b>\u00a0section as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/21\/DIYAlertTaskBotResponseTabReportSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-19542\" src=\"\/wp-content\/uploads\/sites\/21\/DIYAlertTaskBotResponseTabReportSection.png\" alt=\"\" width=\"820\" height=\"461\" \/><\/a><br \/>\nTo enable a report link for the task, select\u00a0<strong>Yes<\/strong> to display the <strong>Report Template\u00a0<\/strong><b>Definition<\/b>\u00a0section shown in the previous\u00a0illustration.<br \/>\nWhen you add a link to a task response message, the end-user for the Bot has the ability to select the link and get more details, such as a table of values for <em>Closed Sales Opportunities<\/em> in the\u00a0<em>SalesForce<\/em>\u00a0Bot.<br \/>\nDefine the following parameters to create a link in a task response message\u00a0for the end-user to request a report for additional information from the initial task response message:<\/p>\n<ul>\n<li><strong>Link Title<\/strong> \u2013 The link text displayed to the end-user in the task post, for example, <span style=\"color: #0000ff;\"><em>View Shopping Cart<\/em><\/span>.<\/li>\n<li><strong>Header<\/strong> \u2013 The title displayed\u00a0when the report is displayed to the end-user, for example, <em><span style=\"color: #0000ff;\">These are the items in your Shopping Cart<\/span><\/em>.<\/li>\n<li><strong>Details<\/strong> \u2013 End-user help information displayed directly below the Header in the report that describes the content of the report, for example, <span style=\"color: #0000ff;\"><em>Review your Shopping Cart<\/em><\/span>, and then click <strong>Continue<\/strong> when you are ready to place your order.<\/li>\n<li><strong>Template<\/strong> \u2013 Select one of the following\u00a0format templates to display the data from the task response. For each type, define the <strong>Column Name<\/strong>, <strong>Key Mapping<\/strong>, <strong>Data Type<\/strong>, and template-specific options.\n<ul>\n<li><strong>Table<\/strong> &#8211; Data is presented in a table format with defined columns. Each mapping for the\u00a0<strong>Table<\/strong>\u00a0template can be set to <strong>Is Sortable<\/strong>, <strong>Display as an image<\/strong>, and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-table-report\/\">Defining a Table Report<\/a>.<\/li>\n<li><strong>Fixed Column Table<\/strong> &#8211;\u00a0Data is presented in a table format with\u00a0the one or more\u00a0columns fixed.\u00a0Each mapping for the <strong>Fixed Column Table<\/strong> template can be set to <strong>Is Sortable<\/strong>, <strong>Column in fixed<\/strong>,\u00a0<strong>Display as an image<\/strong>\u00a0and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-fixed-column-table-report\/\">Defining a Fixed-Column Table Report<\/a>.<\/li>\n<li><strong>Card Layout<\/strong> &#8211; Data is presented in a contact card format.\u00a0Each mapping for the\u00a0<strong>Card Layout<\/strong>\u00a0template can be set to <strong>Is Sortable<\/strong>, <strong>Display as an image<\/strong>, and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-card-layout-report\/\">Defining a Card Layout Report<\/a>.<\/li>\n<li><strong>Weather Info<\/strong> &#8211; Date for a weather service response payload can be defined.\u00a0Each mapping for the\u00a0<strong>Weather Info<\/strong>\u00a0template can be set to <strong>Is Sortable<\/strong>,\u00a0<strong>Display as an image<\/strong>, and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-weather-info-report\/\">Defining a Weather Info Report<\/a>.<\/li>\n<li><strong>Card Layout with Actions<\/strong> \u2013 Displays a list of items with a mapped task link for each item.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-card-layout-with-actions-report\/\">Define a Card Layout with Actions Report<\/a>.<\/li>\n<li><strong>Card Layout with Group By<\/strong> \u2013 Displays a list of items grouped by a specific field.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-card-layout-with-group-by-report\/\">Define a Card Layout with Group By Report<\/a>.<\/li>\n<li><strong>Shopping Cart Layout with Actions<\/strong> \u2013\u00a0Displays a list of items with a mapped task link for each item.\u00a0For more information, see <a href=\"\/v9-0\/v9-0\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-shopping-cart-layout-with-actions-report\/\">Define a Shopping Cart Layout with Actions Report<\/a>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<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><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"For some Alert tasks, as seen here, you may want to display the bot response to the end-user as a link that can display the payload response using a template, such as a table, contact card, or formatted for a specific message type such as a weather report. Note: This section is not used for...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[67],"tags":[],"class_list":["post-27065","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/27065","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/comments?post=27065"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/27065\/revisions"}],"predecessor-version":[{"id":27066,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/27065\/revisions\/27066"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/media?parent=27065"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/categories?post=27065"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/tags?post=27065"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}