{"id":27069,"date":"2021-03-17T06:41:41","date_gmt":"2021-03-17T06:41:41","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-0\/?p=27069"},"modified":"2021-03-17T06:41:41","modified_gmt":"2021-03-17T06:41:41","slug":"alert-task-defining-filters","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-0\/docs\/bots\/bot-builder-tool\/alert\/alert-task-defining-filters\/","title":{"rendered":"Alert Task \u2013 Defining Filters"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

As we have seen here<\/a>, you can define filters for end-users to limits the results of an alert task to the results an end-user needs. For example, you can define a filter for the name, or account, or business. When the alert is set up by the end-user, and the filter applied, only alert messages that meet the filter specifications are displayed to the end-user.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Defining Filters<\/span><\/h2>\n

To get started with defining filters for a\u00a0task, on the Settings<\/strong>\u00a0tab, click the Expand<\/strong> icon in the Filters<\/strong> section, and then click Add<\/strong> as shown in the following illustration.
\n\"Alert<\/a>
\nWhen you\u00a0click Add<\/strong>, the Alert\u00a0Task Filter<\/strong> dialog is displayed as shown in the following illustration.
\n\"Alert<\/a>
\nThe Filter<\/strong> defined in the previous illustration is displayed to the end-user as a filter labeled Owner<\/em>, with the Field Type<\/strong> set to\u00a0Dynamic Dropdown<\/strong>\u00a0to enable the end-user to select a name from a dynamically populated list of owners defined in the response payload.
\nDefine the fields described in the following table to create a new filter for a task.<\/p>\n\n\n\n\n\n\n\n\n
PARAMETER NAME<\/strong><\/td>\nDESCRIPTION<\/strong><\/td>\n<\/tr>\n
Name<\/td>\nSpecify the name of the Filter<\/strong> displayed to the end-user in the\u00a0Filters<\/strong> section when configuring the task, for example, Notify me only when the below user tweets.<\/td>\n<\/tr>\n
Field Name<\/td>\nEnter the name of the field to filter the task on, or click Select Field<\/strong> to display a drop-down list of field names parsed from the Response Sample<\/strong> defined on the task\u00a0API Request<\/b> tab.<\/td>\n<\/tr>\n
Field Type<\/td>\nSelect the type of input field to collect the user input.<\/p>\n
    \n
  • Textbox<\/strong> – Displays a text box to the user. In the Placeholder<\/strong> field, enter a description for the field, for example, Type\u00a0in the name you want to embroider.<\/span><\/li>\n
  • Textarea<\/strong> – Displays a text area box to the user, typically allowing to enter several sentences. In the Placeholder<\/strong> field, enter a description for the text area.<\/li>\n
  • Static Dropdown<\/strong> – Displays a drop-down list of choices to the user. Click Add Option<\/strong> to begin adding the list of items, with the following parameters:\n
      \n
    • Option Name <\/strong>– The name of the option displayed to the user.<\/li>\n
    • Option Value<\/strong> – The value associated with the option.<\/li>\n
    • Default Value<\/strong> – Select the default value for the list when more than one option is defined.<\/li>\n
    • Searchable<\/strong> – Select to enable type-ahead suggestions from the list matching the user’s typing.<\/li>\n<\/ul>\n

      Click Save<\/strong>. To add additional items, click Add Option<\/strong> again. Edit or remove options in the Actions<\/b> column for options.<\/li>\n

    • Dynamic Dropdown<\/strong> – Displays a drop-down list dynamically populated at runtime based on the response from a URL for your Bot, for example, a list of projects for a JIRA<\/em>\u00a0task notification. Define the following properties for a dynamically populated drop-down.\n
        \n
      • Endpoint URL<\/strong> – The Bot\u00a0endpoint URL, for example,\u00a0https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n
      • Endpoint Content Type<\/strong> – One of these content types expected from the specified endpoint URL: JSON, RSS, XML, Encoded JSON, CSV, or Text.<\/li>\n
      • Endpoint Method<\/strong> – Select one of the following:\n
          \n
        • GET<\/strong> – Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n
        • POST<\/strong> – Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n
        • Response Path<\/strong> – The path in the response that contains the desired drop-down list values, for example, data<\/span>.<\/li>\n
        • Label Key<\/strong> – The key for the label of the drop-down option, for example, name<\/span>.<\/li>\n
        • Optional Value Key<\/strong> – The key for the value of the drop-down option, for example, id<\/span>.<\/li>\n
        • Add Payload Field<\/strong> – Click to add one or more fields from the response payload as options for the type-ahead field. For each type ahead field option, enter the Payload field key<\/strong> and the Payload field value<\/strong>, and then click Save<\/strong>. Edit or delete payload fields in the Actions<\/strong> column.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
            \n
          • Check Box<\/strong> – Displays a list of choices that the user can select from – one or more.\u00a0Click Add Option<\/strong> to begin adding the list of items to display, with the following parameters:\n
              \n
            • Option Name <\/strong>– The name of the option displayed to the end-user.<\/li>\n
            • Option Value<\/strong> – The corresponding value for the option name.<\/li>\n<\/ul>\n<\/li>\n
            • Type Ahead<\/strong>\u00a0– Displays a dynamically populated drop-down list of choices to the user at runtime when the user enters three or more characters that match the search results based on the response from the\u00a0URL defined for the task. For example, a list of projects for a JIRA<\/em>\u00a0task notification message. Define the following properties for a dynamically populated drop-down.\n
                \n
              • Endpoint URL<\/strong> – The Bot\u00a0endpoint URL, for example,\u00a0https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n
              • Endpoint Content Type<\/strong> – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, Twitter Encoded JSON, Multipart\/Form-data, or Multipart\/Related.<\/li>\n
              • Endpoint Method<\/strong> – Select one of the following:\n
                  \n
                • GET<\/strong> – Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n
                • POST<\/strong> – Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n
                • Response Path<\/strong> – The path in the response that contains the desired drop-down list values, for example, data<\/span>.<\/li>\n
                • Label Key<\/strong> – The key for the label of the drop-down option, for example, name<\/span>.<\/li>\n
                • Option Value Key<\/strong> – The key for the value of the drop-down option, for example, id<\/span>.<\/li>\n
                • Add Payload Field<\/strong> – Click to add one or more fields from the response payload as options for the type-ahead field. For each type ahead field option, enter the Payload field key<\/strong> and the Payload field value<\/strong>, and then click Save<\/strong>. Edit or delete payload fields in the Actions<\/strong> column.<\/li>\n
                • Editable<\/strong> – Enables the end-user to enter text free-from in the field as an option when type-ahead search results do not match.<\/li>\n<\/ul>\n<\/li>\n
                • Dynamic Check Box<\/b> –\u00a0Displays a list of choices that the end-user can select one or more from, which are dynamically populated at runtime based on the response from a URL for your Bot, for example, a list of projects for a JIRA<\/em>\u00a0task notification. Define the following properties for a dynamically populated list of choices as checkboxes.\n
                    \n
                  • Endpoint URL<\/strong> – The Bot\u00a0endpoint URL, for example,\u00a0https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n
                  • Endpoint Content Type<\/strong> – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, Encoded JSON, CSV, or Text.<\/li>\n
                  • Endpoint Method<\/strong> – Select one of the following:\n
                      \n
                    • GET<\/strong> – Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n
                    • POST<\/strong> – Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n
                    • Response Path<\/strong> – The path in the response that contains the desired drop-down list values, for example, data<\/span>.<\/li>\n
                    • Label Key<\/strong> – The key for the label of the drop-down option, for example, name<\/span>.<\/li>\n
                    • Box\u00a0Value Key<\/strong> – The key for the value of the drop-down option, for example, id<\/span>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
Data Type<\/td>\nThe data type for the content received from the endpoint URL. One of:<\/p>\n
    \n
  • Text<\/strong> – The user input\u00a0for this filter is expected as text.<\/li>\n
  • Number<\/strong> – The user input for this filter\u00a0is expected as an integer.<\/li>\n
  • Date<\/strong> – The user input for this filter\u00a0is a date.<\/li>\n
  • List<\/strong> – The user input for this filter is a comma-separated list.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
Operators<\/td>\nSelect one or more filter operations that the end-user can select to apply to the filter. Depending on the Data Type<\/strong> selected, one or more of the following options are available to select to display to the end-user in the filter.<\/p>\n