{"id":27065,"date":"2021-03-17T06:38:44","date_gmt":"2021-03-17T06:38:44","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-2\/?p=27065"},"modified":"2022-09-26T20:55:50","modified_gmt":"2022-09-26T19:55:50","slug":"alert-task-report-templates","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-2\/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><span style=\"font-weight: 400\">For some Alert tasks, <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/#Bot_Response\"><span style=\"font-weight: 400\">as seen here<\/span><\/a><span style=\"font-weight: 400\">, 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.<\/span><\/p>\n<table style=\"background-color: #fffbea;width: 100%\" width=\"100%\">\n<tbody>\n<tr>\n<td width=\"100%\">\n<p><strong><em>Note:<\/em><\/strong><em><span style=\"font-weight: 400\"> This section is not used for webhook alert tasks, action tasks, or RSS alert tasks.<\/span><\/em><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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>\n<h1><span class=\"ez-toc-section\" id=\"Configuring_Report_Templates\"><span style=\"font-weight: 400\">Configuring Report Templates&nbsp;<\/span><\/span><\/h1>\n<p><span style=\"font-weight: 400\">To add a link to a task to provide more information or a report, you can define <\/span><strong>a link<\/strong><span style=\"font-weight: 400\"> and information to display for the report as a table, weather report, or contact card in the end-user application.<\/span><\/p>\n<p><span style=\"font-weight: 400\">To get started with defining the<\/span><strong> Report Template Definition<\/strong><span style=\"font-weight: 400\"> for a task, on the<\/span><strong> Bot Response<\/strong><span style=\"font-weight: 400\"> tab, click the <\/span><strong>Expand<\/strong><span style=\"font-weight: 400\"> icon in the<\/span><strong> (Optional) Report Template Definition<\/strong><span style=\"font-weight: 400\"> section as shown in the following illustration.<\/span><\/p>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-2\/wp-content\/uploads\/sites\/45\/20220926205429\/schedule-configured.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-2\/wp-content\/uploads\/sites\/45\/20220926205429\/schedule-configured-1024x377.png\" alt=\"\" width=\"640\" height=\"236\" class=\"alignnone size-large wp-image-45579\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-2\/wp-content\/uploads\/sites\/45\/20220926205429\/schedule-configured-1024x377.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-2\/wp-content\/uploads\/sites\/45\/20220926205429\/schedule-configured-300x111.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-2\/wp-content\/uploads\/sites\/45\/20220926205429\/schedule-configured.png 1503w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/p>\n<p><span style=\"font-weight: 400\">To enable a report link for the task, select <\/span><strong>Yes<\/strong><span style=\"font-weight: 400\"> to display the <\/span><strong>Report Template Definition<\/strong><span style=\"font-weight: 400\"> section shown in the previous illustration.<\/span><\/p>\n<p><span style=\"font-weight: 400\">When you add a link to a task response message, the end-user has the ability to select the link and get more details, such as a table of values.Define the following parameters to create a link in a task response message for the end-user to request a report for additional information from the initial task response message:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400\"><strong>Link Title<\/strong><span style=\"font-weight: 400\"> &ndash; The link text displayed to the end-user in the task post, for example, <\/span><em><span style=\"font-weight: 400\">View Booking<\/span><\/em><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Header<\/strong><span style=\"font-weight: 400\"> &ndash; The title displayed when the report is displayed to the end-user, for example, <\/span><em><span style=\"font-weight: 400\">This is your booking selection<\/span><\/em><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Details<\/strong><span style=\"font-weight: 400\"> &ndash; End-user help information displayed directly below the Header in the report that describes the content of the report, for example, <\/span><em><span style=\"font-weight: 400\">Review your Booking<\/span><\/em><span style=\"font-weight: 400\">, and <\/span><span style=\"font-weight: 400\">then click <\/span><strong>Continue<\/strong><span style=\"font-weight: 400\"> when you are ready to place your order.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Template<\/strong><span style=\"font-weight: 400\"> &ndash; Select one of the following format templates to display the data from the task response. For each type, define the <\/span><strong>Column Name<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Key Mapping<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Data Type<\/strong><span style=\"font-weight: 400\">, and template-specific options.<\/span><\/li>\n<ul>\n<li style=\"font-weight: 400\"><strong>Table<\/strong><span style=\"font-weight: 400\"> &ndash; Data is presented in a table format with defined columns. Each mapping for the <\/span><strong>Table<\/strong><span style=\"font-weight: 400\"> template can be set to <\/span><strong>Is Sortable<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Display as an image<\/strong><span style=\"font-weight: 400\">, and <\/span><strong>Display it as a link<\/strong><span style=\"font-weight: 400\">. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/dialog-task\/defining-a-table-report\/\"><span style=\"font-weight: 400\">Defining a Table Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Fixed Column Table<\/strong><span style=\"font-weight: 400\"> &ndash; Data is presented in a table format with one or more fixed columns. Each mapping for the <\/span><strong>Fixed Column Table<\/strong><span style=\"font-weight: 400\"> template can be set to <\/span><strong>Is Sortable<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Column in fixed<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Display as an image<\/strong><span style=\"font-weight: 400\"> and <\/span><strong>Display it as a link<\/strong><span style=\"font-weight: 400\">. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/dialog-task\/defining-a-fixed-column-table-report\/\"><span style=\"font-weight: 400\">Defining a Fixed-Column Table Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Card Layout<\/strong><span style=\"font-weight: 400\"> &ndash; Data is presented in a contact card format. Each mapping for the <\/span><strong>Card Layout<\/strong><span style=\"font-weight: 400\"> template can be set to <\/span><strong>Is Sortable<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Display as an image<\/strong><span style=\"font-weight: 400\">, and <\/span><strong>Display it as a link<\/strong><span style=\"font-weight: 400\">. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/dialog-task\/defining-a-card-layout-report\/\"><span style=\"font-weight: 400\">Defining a Card Layout Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Weather Info<\/strong><span style=\"font-weight: 400\"> &ndash; Date for a weather service response payload can be defined. Each mapping for the <\/span><strong>Weather Info<\/strong><span style=\"font-weight: 400\"> template can be set to <\/span><strong>Is Sortable<\/strong><span style=\"font-weight: 400\">, <\/span><strong>Display as an image<\/strong><span style=\"font-weight: 400\">, and <\/span><strong>Display it as a link<\/strong><span style=\"font-weight: 400\">. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/dialog-task\/defining-a-weather-info-report\/\"><span style=\"font-weight: 400\">Defining a Weather Info Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Card Layout with Actions<\/strong><span style=\"font-weight: 400\"> &ndash; Displays a list of items with a mapped task link for each item. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/action-info-task\/define-a-card-layout-with-actions-report\/\"><span style=\"font-weight: 400\">Define a Card Layout with Actions Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Card Layout with Group By<\/strong><span style=\"font-weight: 400\"> &ndash; Displays a list of items grouped by a specific field. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/dialog-task\/define-a-card-layout-with-group-by-report\/\"><span style=\"font-weight: 400\">Define a Card Layout with Group By Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Shopping Cart Layout with Actions<\/strong><span style=\"font-weight: 400\"> &ndash; Displays a list of items with a mapped task link for each item. For more information, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/action-info-task\/define-a-shopping-cart-layout-with-actions-report\/\"><span style=\"font-weight: 400\">Define a Shopping Cart Layout with Actions Report<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<\/ul>\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\/v10-2\/wp-json\/wp\/v2\/posts\/27065","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/comments?post=27065"}],"version-history":[{"count":3,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27065\/revisions"}],"predecessor-version":[{"id":45582,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27065\/revisions\/45582"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/media?parent=27065"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/categories?post=27065"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/tags?post=27065"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}