Scheduled tasks

[ 1 About scheduled tasks ] [ 2 What permissions do I need? ] [ 3 Creating scheduled tasks ] [ 4 Activating scheduled tasks ] [ 5 Receiving scheduled task results ] [ 6 Managing scheduled tasks ]

About scheduled tasks

You have the option to schedule queries to be executed at specified intervals and have the results sent to the desired recipients in CSV format via email. This is useful for a variety of purposes, including sharing data with users without requiring them to access the platform or monitor data regularly.

To work with scheduled tasks you need to access the Administration → Scheduled tasks area from the navigation pane.

What permissions do I need?

To access the Scheduled tasks area you need to have the Scheduled tasks permission, otherwise, you will not see the option in the navigation pane.

To successfully create scheduled tasks, you need to associate a query api authentication token corresponding to your own user. If you need help with authentications tokens, visit this article.

Creating scheduled tasks

To create a scheduled task, simply click the button at the top right, fill out the form as explained below, and click the create button when you finish.

1	Name: give the task a meaningful name that helps you identify its purpose.
2	Repeats: select the desired periodicity from the dropdown. Daily: if you select this option, you must select the time of the day. The time of the day can also be written using the 24h-format (hh:mm). Weekly: if you select this option, you must select the day(s) of the week and the time of the day. Monthly: if you select this option, you must select the day(s) of the month and the time of the day. Yearly: if you select this option, you must select the month(s) of the years, the day(s) of the month, and the time of the day.
3	Sending to: introduce the email address(es) of the users you want to receive the query result. Character limit: the length of this field cannot exceed 256 characters.
4	Subject: indicate the content of the subject displayed on the emails received from this scheduled task. Character limit: the length of this field cannot exceed 140 characters.
5	Query time period: indicate the time range for the data examined by the query. You can either select time presets or specify a custom period. If you select custom, you need to specify the start and end dates using relative dates (more info about relative dates here).
6	Query expression: insert a valid query to return the desired data and create the report that will be sent. The query must be written in LINQ, using the syntax recognized by the APIs. This article will help you with the basics for constructing a query using LINQ, and you may find this article useful to adapt your query to the API standards. Character limit: the length of this field cannot exceed 249k characters.

Activating scheduled tasks

Once you've scheduled a task, remember to activate it. Failure to do so will prevent its execution and consequently, the result won't be sent. To active it, use the toggle in the Active column of the list.

Receiving scheduled task results

When a scheduled task is activated, it will be executed at the designated time and periodicity (check the Next execution column for the upcoming launch). Upon completion, the indicated email address(es) will receive an email with the result.

In this email you can find attached a CSV with the data for the specified query and time range.

Managing scheduled tasks

Filtering scheduled tasks

You have two different methods at your disposal to filter existing tasks and locate those that interest you.

You can use the global search box to find tasks containing a given string in any of their fields, and the list of tasks will be filtered as you type. To remove the filter, simply click the X icon that appears inside the search box after typing.

You can use a field's search box to find tasks containing a given string only in that specific field, and the list of tasks will be filtered as you type. When using this method, you can also specify a different criteria for the string used to find the task, which will show next to the field when selected. To remove the filter, simply click the X icon that appears next to the search box after typing or after selecting a different criteria.

Sorting scheduled tasks

You have the option to sort the list of tasks either in ascending or descending order based on the task name. Simply click the sorting arrows next to the name column for ascending order (click once more for descending order, and once more to revert the sorting to the default order).

Editing and cloning scheduled tasks

Once you create a scheduled task, you can edit it when necessary. Simply click the ellipsis menu at the end of the task row and select Edit. You can modify any of the fields and click Save changes when you finish.

Clicking Clone in the ellipsis menu will open a window with the same settings as the original, allowing you to modify any of them before creating it. As with new tasks, they are not active by default and require manual activation to start execution.

Deleting scheduled tasks

If you no longer need a scheduled task, you can easily delete it using the Delete option in the ellipsis menu at the end of the task row. This action cannot be undone, so if you are uncertain, you can simply deactivate it using the activation toggle (see section above).

Bulk actions

Actions such as enabling, disabling, or deleting tasks can be performed in bulk to save you time and optimize the process. Mark the checkboxes of the desired tasks and use the menu next to the master checkbox at the top, which shows the available actions for the tasks selected.