{"id":27075,"date":"2021-03-17T06:44:06","date_gmt":"2021-03-17T06:44:06","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-2\/?p=27075"},"modified":"2022-09-26T19:31:41","modified_gmt":"2022-09-26T18:31:41","slug":"alert-task-advanced-settings","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/alert\/alert-task-advanced-settings\/","title":{"rendered":"Alert Task \u2013 Advanced Settings"},"content":{"rendered":"
<\/div><\/div><\/section>
<\/div><\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t\r\n\t\t<\/div>\r\n\t<\/div>\r\n\n

In the Advanced Settings section, you can define alert task settings for enabling and limiting the initial set of alert messages displayed to the end-user when the task is set up, define alert message reminders, and if required, prevent duplicate messages sent to the user. <\/span>Learn more about Alert Tasks<\/span><\/a>.<\/span><\/p>\n

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

Advanced Settings Overview<\/span><\/span><\/h1>\n

In the <\/span>Advanced Settings<\/strong> section, you can define the initial polling results for a task, define an alert reminder, and specify keys the XO Platform should use to prevent duplicate alert messages, for example, in a <\/span>Twitter<\/span><\/em> or <\/span>Facebook<\/span><\/em> feed.<\/span><\/p>\n

To define advanced settings for a task, on the <\/span>Settings<\/strong> tab, click the <\/span>Expand<\/strong> icon in the <\/span>Advanced Settings<\/strong> section as shown in the following illustration.<\/span><\/p>\n

\"\"<\/a>
\n

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

Initial Polling Setup<\/span><\/span><\/h1>\n

Initial polling is an option you can define to enable display of events to end-users immediately after they set up the task. For example, for a Travel News VA , you can enable initial polling to show the last 10 news posts immediately after the end-user adds the task to their application. If initial polling is not defined, the task polling begins after the specified <\/span>Trigger Interval<\/strong> has elapsed.<\/span><\/p>\n

To enable and configure initial polling, in the <\/span>Perform Initial Poll<\/strong> section, select <\/span>Yes<\/strong>. In the <\/span>No of posts<\/strong> field, enter the number of previous posts that should be posted immediately in the end-user application, as shown in the following illustration.<\/span><\/p>\n

\"\"<\/a>
\n

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

Setting Up Alert Reminders<\/span><\/span><\/h1>\n

For some tasks, for example, a <\/span>Booking Updates <\/span><\/em>task, you may want to add a reminder to the task. The reminder sends a message to the end-user after receipt of the original task message. For example, the end-user may want to set up a 30-minute and 15-minute reminder before an event with the task message.<\/span><\/p>\n

To enable and configure reminders, in the <\/span>Enable Alert Reminder<\/strong> section, click <\/span>Yes<\/strong>. The reminder configuration section is displayed as shown in the following demonstration..<\/span><\/p>\n

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

To configure an alert reminder:<\/span><\/p>\n

    \n
      \n
    1. In the <\/span>Enable Alert Reminder<\/strong> section, click <\/span>Yes<\/strong> to display the alert reminder settings.<\/span><\/li>\n
    2. In the <\/span>Reminder Frequency<\/strong> section, click in the text box to display and select one or more intervals for the frequency of the reminder ranging from <\/span>5 mins<\/strong> to <\/span>7 days<\/strong>.<\/span><\/li>\n
    3. In the <\/span>Reminder Message<\/strong> text area, enter the message to display to the end-user for the event reminder. For example: print('Event starts in '+__frequency__); <\/code><\/span><\/span><\/li>\n
    4. In the <\/span>Identity Event Modification<\/strong> section, enter one or more keys in a comma-separated list used to identify new events. For example, <\/span>id, LastModifiedDateTime, subject<\/span><\/span>.<\/span><\/li>\n
    5. In the <\/span>Event Start Time<\/strong> section, enter the message to display to the end-user for the start date and time of the event using the alert task payload field that contains the event start time. For example,<\/span> 
      \n\n\n\n
      \n

      if (due_at) {<\/span>
      <\/span>       print(due_at);<\/span>
      <\/span>   } else if (due_on) {<\/span>
      <\/span>       var dt = new Date(created_at);<\/span>
      <\/span>       var dtt = new Date(due_on);<\/span>
      <\/span>       dt.setYear(dtt.getFullYear());<\/span>
      <\/span>       dt.setMonth(dtt.getMonth());<\/span>
      <\/span>       dt.setDate(dtt.getDate());<\/span>
      <\/span>       dt.setHours(00);<\/span>
      <\/span>       dt.setMinutes(00);<\/span>
      <\/span>       dt.setSeconds(00)<\/span>
      <\/span>       print(dt.toISOString());<\/span>
      <\/span>   }<\/span><\/p>\n

      <\/code><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        \n
      1. RRule<\/strong> – A JavaScript library for working with recurrence rules for calendar dates. Use tIn the <\/span>Format to Identify Recurrence<\/strong> section, select the type of recurrence pattern format used in the payload as one of <\/span>RRule<\/strong> or <\/span>Cron.<\/strong><\/li>\n
      2. his for iCalendar events. For more information, see <\/span>Recurrence Rule<\/span><\/a>.<\/span><\/li>\n
      3. Cron<\/strong> – Used for scheduling tasks in the future. For more information, see <\/span>Cron Expressions<\/span><\/a>.<\/span><\/li>\n<\/ol>\n<\/li>\n
      4. In the <\/span>Recurrence Pattern<\/strong> section, define the string displayed to the end-user to show the frequency of a repeating event, such as a recurring weekly meeting. For example:
        <\/span><\/span>
        \n\n\n\n
        \n

        if (typeof(Recurrence) !== 'undefined' && Recurrence) {
            var map = new Object();
            map['Daily'] = \"DAILY\";
            map['Weekly'] = \"WEEKLY\";
            map['AbsoluteMonthly'] = \"MONTHLY\";
            map['RelativeMonthly'] = \"MONTHLY\";
            map['AbsoluteYearly'] = \"YEARLY\";
            map['AbsoluteYearly'] = \"YEARLY\";
            map['First'] = 1
            map['Second'] = 2
            map['Third'] = 3
            map['Fourth'] = 4
            map['Last'] = -1
            map['Sunday'] = 'SU'
            map['Monday'] = 'MO'
            map['Tuesday'] = 'TU'
            map['Wednesday'] = 'WE'
            map['Thursday'] = 'TH'
            map['Friday'] = 'FR'
            map['Saturday'] = 'SA'
            var rrule = '';
            if (typeof(Recurrence.Pattern.Type) !== 'undefined') {
                var freq = map[Recurrence.Pattern.Type];
                rrule = rrule + 'FREQ=' + freq + ';';
            }
            if (typeof(Recurrence.Range.StartDate) !== 'undefined') {
                var stDate = new Date(Recurrence.Range.StartDate).toISOString();
                rrule = rrule + 'DTSTART=' + stDate + ';';
            }
            if (typeof(Recurrence.Pattern.Interval) !== 'undefined') {
                var interval = Recurrence.Pattern.Interval
                rrule = rrule + 'INTERVAL=' + interval + ';';
            }
            if (typeof(Recurrence.Range.EndDate) !== 'undefined' && Recurrence.Range.Type !== 'NoEnd') {
                var edDate = new Date(Recurrence.Range.EndDate).toISOString();
                rrule = rrule + 'UNTIL=' + edDate + ';';
            }
            if (typeof(Recurrence.Pattern.Month) !== 'undefined' && Recurrence.Pattern.Month !== 0) {
                rrule = rrule + 'BYMONTH=' + Recurrence.Pattern.Month + ';';
            }
            if (typeof(Recurrence.Pattern.DayOfMonth) !== 'undefined' && Recurrence.Pattern.DayOfMonth !== 0) {
                rrule = rrule + 'BYMONTHDAY=' + Recurrence.Pattern.DayOfMonth + ';';
            }
            if (typeof(Recurrence.Pattern.Index) !== 'undefined') {
                var wno = map[Recurrence.Pattern.Index];
                rrule = rrule + 'BYSETPOS=' + wno + ';';
            }
            if (typeof(Recurrence.Pattern.DaysOfWeek) !== 'undefined') {
                var arr = [];
                for (var i = 0; i < Recurrence.Pattern.DaysOfWeek.length; i++) {
                    arr.push(map[Recurrence.Pattern.DaysOfWeek[i]])
                }
                rrule = rrule + 'BYDAY=' + arr.join(',') + ';';
            }
            print(rrule);
        }<\/span><\/code><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        If the Format to Identify Recurrence<\/strong> field is set to Cron<\/strong>, then define the Event End <\/strong>section to define the string displayed to the end-user to show the date and time of the last recurring event.<\/li>\n<\/ol>\n

        Click <\/span>Save<\/strong> to save the settings.<\/span><\/p>\n

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

        Preventing Duplicate Message Alerts<\/span><\/span><\/h1>\n

        After you add your filters for the response object, you should determine if you need to apply a strategy to prevent the display of duplicate messages to the end-user. For example, if you set up an RSS task, you may want to prevent duplicate messages for the same subject, or for <\/span>Facebook<\/span><\/em>, prevent duplicate messages each time a comment is added to a post.<\/span><\/p>\n

        In the XO Platform , you can choose one of two options for <\/span>Deduplicate Strategy<\/strong>:<\/span><\/p>\n

          \n
        • None<\/strong> – This is the default method to prevent duplicate alert messages. Each incoming task payload is hashed and the latest 500 task hash values are persisted. Each new task payload is compared against the list to prevent duplicate task alert messages. This option works for most tasks.<\/span><\/li>\n
        • ExcludeByCachedIds<\/strong> – Select to enter one or more response identifier keys in a comma-separated list used to filter Kore.ai task alert messages and prevent duplication based on the cached hash value of the key for up to 500 hash values. If any of the key hash values match the response object, then the alert message is filtered and not displayed. For RSS <\/span>Alert Types<\/strong>, RSS XML payloads are parsed as JSON. To filter by RSS item, enter <\/span>$..guid[0]<\/code>._<\/span> to prevent duplicate messages using the XML < <\/span>GUID<\/span><\/em> > tag parsed to JSON as:{
              \"guid\": [<\/code>
                  \"_\": \"some link\"<\/code>
              ]<\/code>
          }<\/code><\/span><\/li>\n<\/ul>\n

          To define settings to prevent duplication messages for a task, on the <\/span>Settings<\/strong> tab, click the <\/span>Expand<\/strong> icon in the <\/span>Advanced Settings<\/strong> section to display the <\/span>Deduplicate Strategy<\/strong> section.<\/span><\/p>\n

          <\/code><\/span><\/code><\/span><\/p>\n

          <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

          In the Advanced Settings section, you can define alert task settings for enabling and limiting the initial set of alert messages displayed to the end-user when the task is set up, define alert message reminders, and if required, prevent duplicate messages sent to the user. Learn more about Alert Tasks. Advanced Settings Overview In the…<\/p>\n","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-27075","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27075","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=27075"}],"version-history":[{"count":3,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27075\/revisions"}],"predecessor-version":[{"id":45528,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27075\/revisions\/45528"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/media?parent=27075"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/categories?post=27075"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/tags?post=27075"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}