Scheduling Reports
In the Sigma application, end-users (Report Consumers) can schedule reports in the following frequencies:
- Minute
- Hourly
- Daily
- Weekly Once
- Monthly
Refer the following topics:
- Creating a schedule for a report
- Viewing generated reports
- Viewing failed schedules
- Viewing schedules of all reports
- Scheduling reports in your time zone
Creating a schedule for a report
Perform the following steps in the Sigma application to schedule a report:
- Choose a report from the available Reports on the left-hand side of the page.
- Click the Schedule tab.
- Click the plus icon to create a new schedule for the selected report.
- Enter the schedule name in the Scheduler Name field.
If required, enter the reference key in the Reference field. For instance, you can enter the unique Subscription ID of a subscribed corporate customer as a reference key for the subscribed reports of the corporate customer in the Reference field, e.g. WD-7BR4GHIYTS.
The Reference is an optional field.
Click the Calendar () icon in the Starts on field and select the start date.
You can also specify the time by clicking the Clock () icon.
From the Frequency drop-down list, select the frequency of which the report needs to be scheduled. In this example, Daily is selected as the schedule frequency.
The other following frequencies are also available for scheduling reports:
- If you select Minute as the frequency type, a field appears where you can specify exact intervals of minute(s) after which the report should get scheduled. The available minute frequency intervals are: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30 and 60. The specific minute frequency intervals have been provided so that the assigned minute frequency intervals for the report schedules follow the unique and uniform patterns, ensuring that the report schedules get triggered at the specified frequency interval in a precise manner. You can even select the particular days in a week of your choice for the Minute frequency type from the Day of Week drop-down list. You can even specify the hourly interval for the selected day using the Day Starts From and Day Ends At fields.
- If you select Hourly as the frequency type, a field appears where you can specify exact intervals of hour(s) after which the report should get scheduled. You can even select the particular days in a week of your choice for the Hourly frequency type from the Day of Week drop-down list. You can even specify the hourly interval for the selected day using the Day Starts From and Day Ends At fields.
- If you select Weekly Once as the frequency type, a drop-down appears where you can select the day on which the report should get scheduled.
- If you select the Monthly frequency type, you can schedule reports on a monthly basis and apart from scheduling reports for a monthly duration, you can even schedule reports once in a fortnight or two weeks using the Run on Dates drop-down list. You can even select multiple dates from the Run on Dates drop-down list and the reports will get scheduled on the selected dates. On selecting the Last Day of Month option from the Run On Dates drop-down list, the report will get scheduled on the last day of the selected month.
- If you select Minute as the frequency type, a field appears where you can specify exact intervals of minute(s) after which the report should get scheduled. The available minute frequency intervals are: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30 and 60. The specific minute frequency intervals have been provided so that the assigned minute frequency intervals for the report schedules follow the unique and uniform patterns, ensuring that the report schedules get triggered at the specified frequency interval in a precise manner. You can even select the particular days in a week of your choice for the Minute frequency type from the Day of Week drop-down list. You can even specify the hourly interval for the selected day using the Day Starts From and Day Ends At fields.
Select the particular days of your choice in a week from the Day of Week drop-down list.
The Day of Week option is available only for the Daily, Minute and Hourly schedule frequency intervals.
- If you want the report to be scheduled on a repeated basis, click Repeat and specify the number of report schedules for the Repeat mode, e.g. 3. For instance, the scheduled report will get generated for three times on the same day, as the selected number of times for the Repeat mode is 3. Alternatively, you can increase or decrease the number of report schedules. Based on the selected report schedules for the Repeat mode, the schedules will get expired on the culmination of the selected number of times on the basis of the specified schedule for the Repeat mode.
Click the Ends On field and then proceed to click the Calendar () icon to select the end date.
The Ends On is an optional field.
For every schedule that gets failed, you can specify the duration of the the selected report schedule that needs to be repeated in the On failure retry field, with the duration set to be specified in seconds, minutes or hours, while the number of times for the report to get rescheduled for the selected duration can be specified in the for field.
Reports that failed due to exceeding the system capacity will not be included in the retry process.
- To schedule the report, click Schedule Report.
A confirmation message, indicating a successful scheduling of the report, appears. Click Ok.
Viewing generated reports
At the scheduled frequency, the report gets generated and available for download on the Generated Reports tab as shown in the following screen shot. Notifications are sent to the selected contacts on the configured channels when the scheduled reports are generated. The Scheduler information of the report will get displayed by hovering on the Schedule icon for the particular schedule instance in the Generated reports tab.
Viewing failed schedules
For the failed report schedules, the number of retries along with the name of the scheduler will get displayed by hovering on the Schedule icon for the particular schedule instance in the Generated Reports tab. Based on the provided retry number in the configured report schedule, the number of retries will get displayed for the failed report schedule instance.
Viewing schedules of all reports
Perform the following steps to view the schedules of all reports in Sigma application:
- On the left navigation, click the Reports tree.
- On the right of the page, click the Schedule tab.
- View the schedules of all the reports as shown in the following screen shot:
- Click each schedule to view its frequency configuration.
The Please update schedule label appears at the bottom of the created schedule when inappropriate data is given in the Scheduler so this message reminds the user to enter appropriate data and update the schedule.
Scheduling reports in your time zone
By default, Sigma calculates the schedules for the reports at 12:00 PM of the server time. To schedule the reports in your time zone, perform the following steps:
- On the Sigma application, click the user profile icon and select Preferences.
- On the Update Preferences screen, select the required Time Zone and click Update.
For detailed information on other report schedule-related configurations, refer the following pages:
By default Sigma doesn't allow PostgreSQL DB users to edit, delete, pause and resume scheduler. For more information on how to enable these features available to users refer to Sigma FAQ How do PostgreSQL DB users enable the scheduler's update, remove, pause, and resume options?