Discover how to schedule reports in Tathya using alternate interfaces, either via a dashboard or a chart, and configure the scheduled report settings for frequency and content.
A report can also be scheduled via a dashboard or via a chart.
View a dashboard and, in the top right corner, select the ellipsis icon and then Manage email report > Set up an email report.
View a chart and, in the top right corner, select the ellipsis icon and then Manage email report > Set up an email report.
Report Name (required): Enter a memorable name for the new report and, in the Description field, enter a brief description of the report.
After the word Every, select the frequency of the report. Options include:
Year
Month
Week
Day
Hour
Minute
After you select one of the above, the scheduler will present options that are relevant to your choice.
For dashboards, only Image (PNG) is supported so this is automatically selected. For charts, choose between:
Image (PNG) embedded in the email field to receive the chart as an image that is directly embedded within the email message body.
Formatted CSV attached in the email field to receive the chart's raw data as a comma-separated value file that is attached to the email.
Your schedule has now been created. To verify, select Settings → Alerts & Reports → Reports tab.
Learn how to create alerts in Tathya to stay informed about important data changes and trends.
On the Alerts interface, select + Alert to create a new alert.
The Add Alert window appears.
In the Alert Name field (required), enter a name for your new alert.This will also serve as the subject of the email.
In the Owner's field (required), select one or more owners for the alert. Owners have the ability to edit an alert and are notified in case of any execution failures.
In the Description (optional) field, enter a short but meaningful description of the alert, to be included in the alert message.
The Active toggle switch is automatically enabled.
Move to the Alert Condition panel. This area is used to define the event that triggers the activation and notification of the alert.
In the Database field (required), select the database in which the SQL query should be executed.
In the SQL Query field (required), enter a SQL statement that defines the nature of the alert (the metric you want to monitor).
In the Trigger Alert If... field (required), define the condition, and in the Value field (required), enter the associated value of the condition.
This panel is used to define the frequency at which the data is checked to see if the defined condition has been met.
The first schedule option enables you to specify a highly granular schedule based on your specific requirements. Data can be checked every minute, hour, day, week, month, or year.
After setting a schedule, the subsequent CRON field will automatically populate with an equivalent CRON expression that represents your defined schedule.
Alternatively, you can also directly enter a CRON expression by selecting the secondary radio button and entering the expression in the CRON Schedule field.
A CRON expression is a string representing a schedule. It is used to define the timing of recurring tasks or jobs in systems where periodic execution of tasks is required.
The basic structure of a CRON expression consists of five fields, representing minute, hour, day of the month, month, and day of the week. Each field can have a specific value or a wildcard (*) to represent any possible value. Here's the general format:
| | | | | | | | | +----- Day of the week (0 - 6) (Sunday is both 0 and 7) | | | +------- Month (1 - 12) | | +--------- Day of the month (1 - 31) | +----------- Hour (0 - 23) +------------- Minute (0 - 59)
0 0 * * *: Check data at midnight every day.
*/15 * * * *: Check data every 15 minutes.
0 2 * * 1-5: Check data at 2:00 AM every weekday (Monday to Friday).
In the Timezone field, select the drop-down menu and choose your timezone.
In the Log Retention field (required), enter the number of days that the alert will be stored in the execution log. By default, this is set to 90 days.
In the Working Timeout field (required), enter the number of seconds that the alert job is allowed to run before it results in an automatic timeout. By default, this is set to 3600 seconds.
In the Grace Period field, enter the number of seconds that should pass before the alert can trigger relative to when a previous alert was triggered. If an alert triggers within this period, its status will be On Grace, and the alert's evaluation will commence when this period concludes. By default, this is set to 14400 seconds.
In the Message Content section, select either the Dashboard or Chart radio button. Then, in the drop-down field, select the relevant dashboard or chart, a custom link will be prepared and sent based on the defined notification method.
Screenshot Width: An optional parameter that allows you to customize the width (in pixels) for your alert dashboard/chart screenshot.
Ignore cache when generating screenshot: Checkbox to produce real-time data (invalidating cache).
In the Notification Method section, select Add notification method. The Select delivery method drop-down field appears. Select either Email or Slack, as needed. On selection, you will be prompted to enter an email address or the channel name. You can also configure it to be sent to both recipient types.
To finalize your alert, select Add.
You can create an alert for whenever the count of unfillable orders in a day exceeds the defined threshold of 20.
Set conditions for the count of unfillable orders in a day to be greater than 20 and choose the daily time granularity for the evaluation. Specify the email addresses of the operations and customer support teams so that they receive immediate email notifications when facing a higher volume of unfillable orders.
Tathya will automatically trigger the alert and notify the designated team members via email whenever the daily count of unfillable orders exceeds 20.
Learn how to create and automate reports in Tathya to track important metrics at specified intervals.
After successfully setting up alerts, you may also want to generate regular reports to keep track of important metrics. Tathya allows you to automate the process of creating and sending reports at specified intervals.
Follow the steps below to create and schedule reports:
Navigate to the Alerts & Reports screen. By default, you'll land on the Alerts interface. To access the Reports screen, click on the Reports tab.
On the Reports interface, select + Report to create a new report. The "Add Report" window appears.
Report Name field (required), enter a descriptive name for your report. This will also serve as the subject of the email.
Owner(s) field (required), select one or more owners for the report. Owners have the ability to edit the report and are notified in case of any execution failures.
Description (optional), provide a brief and meaningful description of the report.
The "Active" toggle switch is enabled by default.
Ensure that the Superset Admin user is added as the owner whenever scheduling a new report to prevent the report from being disabled if the current owner is deactivated.
This panel is used to define how frequently the report will be sent to a defined notification channel(s).
Specify Time: The first schedule option enables you to specify a highly granular schedule based on your specific requirements. Data can be checked every minute, hour, day, week, month, or year. The day, week, month, and year options all allow you to define a schedule down to the hour & minute granularity.
Check or Enter CRON: After setting a schedule, the subsequent CRON field will automatically populate with an equivalent CRON expression that represents your defined schedule.
Alternatively, you can also directly enter a CRON expression by selecting the secondary radio button and entering the expression in the CRON Schedule field.
(To learn more about CRON expressions, please refer to the alerts section)
In the Timezone field, select the drop-down menu and choose your timezone.
Log Retention (required): Enter the number of days the report will be stored in the execution log (default is 90 days).
Working Timeout (required): Set the maximum duration for the report job to run before an automatic timeout (default is 3600 seconds).
In the Message Content section, select either the Dashboard or Chart radio button. Then, in the drop-down field, select the relevant dashboard or chart — a screenshot of the dashboard or chart will be sent along with a link.
When sending a chart, be sure to indicate whether a screenshot will be sent (in PNG format) or as a CSV file. For Table and Pivot Tables, you can also choose to include the chart on the email text (rather than as an attachment).
Screenshot Width: This is an optional parameter that allows you to customize the width (in pixels) for your dashboard / chart screenshot.
* **Ignore Cache:** Check this box to generate real-time data and invalidate cache.
In the Notification Method section, select Add notification method. The Select delivery method drop-down field appears. Select either Email or Slack, as needed. On selection, you will be prompted to enter an email address or the channel name. You can also configure it to be sent to both recipient types.
To finalize and save your report, select Add.
By following these steps, you can easily create and schedule reports in Tathya, ensuring that the relevant users receive timely and accurate information.
Discover how to configure Alerts & Reports in Tathya, enabling event-triggered notifications and scheduled notifications for effective data monitoring and analysis.
Now that you've successfully created charts and added them to dashboards, the next crucial step is to set up Alerts and Reports. The Alerts & Reports feature in Tathya enables creating event-triggered notifications (Alerts) or scheduled notifications (Reports).
An alert provides a custom link to a chart or an entire dashboard and is triggered when a predefined event occurs. This event is a logical condition within your data.
A report offers a snapshot of a chart or an entire dashboard, accompanied by a link for further exploration and slicing & dicing of the query. Unlike alerts, reports run on a defined schedule (e.g., daily at 7 pm, weekly, etc.).
In the Toolbar, hover over Settings.
From the drop-down menu, select Alerts & Reports.
Upon reaching the Alerts & Reports screen, the Alerts interface is displayed by default. You can easily toggle between the Alerts and Reports tabs to control the content they wish to view.
Below the Alerts and Reports tabs is “Last Updated” information, this simply conveys when the screen was last updated with data. You can force refresh the page by selecting the circular “Refresh” icon.
The filters and search features enable you to quickly find the alert or report that you're looking for, which is invaluable when there are many entries.
Created By:
Select a user to display alerts or reports created by that individual.
Status:
Select an option to display alerts or reports that match the selected status. Available status options include:
Default: Displays all entries regardless of status.
Success: Displays entries that ran successfully.
Working: Displays entries that are currently being processed.
Error: Displays entries that did not successfully run.
Not Triggered: Displays entries with a trigger that has not yet been activated.
On Grace: Displays entries that are currently in a defined grace period.
Search:
To use the Search feature, simply enter a term in the text-entry field and hit or select the magnifying glass icon. A list of entries that include your search criteria will appear in the table.
The Alerts and Reports tables include the following column headers:
Last Run:
Displays the date, time, and UTC hour difference when the entry last ran.
Name:
Represents the name of the alert or report, as defined when adding or editing the entry.
Schedule:
Indicates the defined schedule of the alert or report (e.g., every hour, every minute, etc.).
Notification Method:
Displays an icon indicating that notifications will be sent via email.
Owners:
Icons indicating the owner(s) of the alert or report.
Active:
A toggle switch indicating whether the alert or report is currently enabled or not.
Actions (visible on cursor hover):
Icons that enable you to access the execution log, edit the entry, or delete the entry.
By leveraging these features, you can efficiently manage and monitor alerts and reports, ensuring timely and relevant notifications based on predefined conditions or schedules.