{"id":27069,"date":"2021-03-17T06:41:41","date_gmt":"2021-03-17T06:41:41","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-2\/?p=27069"},"modified":"2022-09-27T09:05:25","modified_gmt":"2022-09-27T08:05:25","slug":"alert-task-defining-filters","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/alert\/alert-task-defining-filters\/","title":{"rendered":"Alert Task \u2013 Defining Filters"},"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

You can define filters for end-users to limit 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. <\/span>Learn more about Alert Tasks<\/span><\/a>.<\/span><\/p>\n

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

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

To get started with defining filters for a task, on the <\/span>Settings<\/strong> tab, click the <\/span>Expand<\/strong> icon in the <\/span>Filters<\/strong> section, and then click <\/span>Add<\/strong> as shown in the following illustration.<\/span><\/p>\n

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

When you click <\/span>Add<\/strong>, the <\/span>Alert Task Filter<\/strong> dialog is displayed as shown in the following illustration.<\/span><\/p>\n

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

Define the fields described in the following table to create a new filter for a task.<\/span><\/p>\n\n\n\n\n\n\n\n\n
\n

PARAMETER NAME<\/strong><\/p>\n<\/th>\n

\n

DESCRIPTION<\/strong><\/p>\n<\/th>\n<\/tr>\n

\n

Name<\/span><\/p>\n<\/td>\n

\n

Specify the name of the <\/span>Filter<\/strong> displayed to the end-user in the <\/span>Filters<\/strong> section when configuring the task, for example, Notify me only when the below user tweets.<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Field Name<\/span><\/p>\n<\/td>\n

\n

Enter the name of the field to filter the task on, or click <\/span>Select Field<\/strong> to display a drop-down list of field names parsed from the <\/span>Response Sample<\/strong> defined on the task <\/span>API Request<\/strong> tab.<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

Field Type<\/span><\/p>\n<\/td>\n

\n

Select the type of input field to collect the user input.<\/span><\/p>\n

    \n
  • Textbox<\/strong> – Displays a text box to the user. In the <\/span>Placeholder<\/strong> field, enter a description for the field. <\/span><\/li>\n
  • Textarea<\/strong> – Displays a text area box to the user, typically allowing them to enter several sentences. In the <\/span>Placeholder<\/strong> field, enter a description for the text area.<\/span><\/li>\n
  • Static Dropdown<\/strong> – Displays a drop-down list of choices to the user. Click <\/span>Add Option<\/strong> to begin adding the list of items, with the following parameters:<\/span><\/li>\n
      \n
    • Option Name <\/strong>– The name of the option displayed to the user.<\/span><\/li>\n
    • Option Value<\/strong> – The value associated with the option.<\/span><\/li>\n
    • Click <\/span>Save<\/strong>. To add additional items, click <\/span>Add Option<\/strong> again. Edit or remove options in the <\/span>Actions<\/strong> column for options.<\/span><\/li>\n<\/ul>\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 <\/span>JIRA<\/span><\/em> task notification. Define the following properties for a dynamically populated drop-down.<\/span><\/li>\n
        \n
      • Endpoint URL<\/strong> – The VA’s endpoint URL, for example, <\/span>https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/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.<\/span><\/li>\n
      • Endpoint Method<\/strong> – Select one of the following:<\/span><\/li>\n
          \n
        • GET<\/strong> – Specifies an HTTP Request GET method for the task field.<\/span><\/li>\n
        • POST<\/strong> – Specifies an HTTP Request POST method for the task field.<\/span><\/li>\n<\/ul>\n
        • Response Path<\/strong> – The path in the response that contains the desired drop-down list values, for example, <\/span>data<\/span>.<\/span><\/li>\n
        • Label Key<\/strong> – The key for the label of the drop-down option, for example, <\/span>name<\/span>.<\/span><\/li>\n
        • Optional Value Key<\/strong> – The key for the value of the drop-down option, for example, <\/span>id<\/span>.<\/span><\/li>\n<\/ul>\n<\/ul>\n
            \n
          • Checkbox<\/strong> – Displays a list of choices that the user can select from – one or more. Click <\/span>Add Option<\/strong> to begin adding the list of items to display, with the following parameters:<\/span><\/li>\n
              \n
            • Option Name <\/strong>– The name of the option displayed to the end-user.<\/span><\/li>\n
            • Option Value<\/strong> – The corresponding value for the option name.<\/span><\/li>\n<\/ul>\n
            • Type Ahead<\/strong> – 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 URL defined for the task. For example, a list of projects for a <\/span>JIRA<\/span><\/em> task notification message. Define the following properties for a dynamically populated drop-down.<\/span><\/li>\n
                \n
              • Endpoint URL<\/strong> – The Va’s endpoint URL, for example, <\/span>https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/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.<\/span><\/li>\n
              • Endpoint Method<\/strong> – Select one of the following:<\/span><\/li>\n
                  \n
                • GET<\/strong> – Specifies an HTTP Request GET method for the task field.<\/span><\/li>\n
                • POST<\/strong> – Specifies an HTTP Request POST method for the task field.<\/span><\/li>\n<\/ul>\n
                • Response Path<\/strong> – The path in the response that contains the desired drop-down list values, for example, <\/span>data<\/span>.<\/span><\/li>\n
                • Option Label Key<\/strong> – The key for the label of the drop-down option, for example, <\/span>name<\/span>.<\/span><\/li>\n
                • Option Value Key<\/strong> – The key for the value of the drop-down option, for example, <\/span>id<\/span>.<\/span><\/li>\n<\/ul>\n
                • Dynamic Checkbox<\/strong> – Displays 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 VA , for example, a list of projects for a <\/span>JIRA<\/span><\/em> task notification. Define the following properties for a dynamically populated list of choices as checkboxes.<\/span><\/li>\n
                    \n
                  • Endpoint URL<\/strong> – The VA’s endpoint URL, for example, <\/span>https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/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.<\/span><\/li>\n
                  • Endpoint Method<\/strong> – Select one of the following:<\/span><\/li>\n
                      \n
                    • GET<\/strong> – Specifies an HTTP Request GET method for the task field.<\/span><\/li>\n
                    • POST<\/strong> – Specifies an HTTP Request POST method for the task field.<\/span><\/li>\n<\/ul>\n
                    • Response Path<\/strong> – The path in the response that contains the desired drop-down list values, for example, <\/span>data<\/span>.<\/span><\/li>\n
                    • Label Key<\/strong> – The key for the label of the drop-down option, for example, <\/span>name<\/span>.<\/span><\/li>\n
                    • Box Value Key<\/strong> – The key for the value of the drop-down option, for example, <\/span>id<\/span>.<\/span><\/li>\n<\/ul>\n<\/ul>\n<\/td>\n<\/tr>\n
\n

Data Type<\/span><\/p>\n<\/td>\n

\n

The data type for the content received from the endpoint URL. One of:<\/span><\/p>\n

    \n
  • Text<\/strong> – The user input for this filter is expected as text.<\/span><\/li>\n
  • Number<\/strong> – The user input for this filter is expected as an integer.<\/span><\/li>\n
  • Date<\/strong> – The user input for this filter is a date.<\/span><\/li>\n
  • List<\/strong> – The user input for this filter is a comma-separated list.<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
\n

Operators<\/span><\/p>\n<\/td>\n

\n

Select one or more filter operations that the end-user can select to apply to the filter. Depending on the <\/span>Data Type<\/strong> selected, one or more of the following options are available to select to display to the end-user in the filter.<\/span><\/p>\n