Brightspot CMS User Guide

Setting up auto-run reports


As you create or edit an editorial content report, you have the option of making that report automatically run on a scheduled basis.

To set up a recurring schedule for a report:

  1. Click menu > Reports.
  2. Create a new report by completing the instructions found at Creating editorial content reports, or select the name of a previously created report in the Reports widget.
  3. Expand Auto-Run Report and select one of the following options:
    • None—The report only runs once.
    • Set—The reports runs on a repeating schedule that you configure by using the Hour, Day, and Month cluster.
      Reports auto run clusters.jpg Reports auto run clusters.jpg
      Clusters available to create recurrence intervals
  4. Click Save.

Recurrence settings for editorial content reports

Selecting Set in the Auto-Run Report field provides several options for you to create the recurring schedule for your report. You use the Hour, Day, and Month clusters to create the exact schedule you need.

Each cluster's settings work together. For instance, if you set the report to run Every Hour, Every Day, and Every Month, it will do just that.

Click each setting below to learn more about the recurrence options available.

By default, recurring reports are set to run every hour, every day, and every month.

Recurrence options

Hour

Use the Hour setting to specify the times during the day the report runs.
OptionDescription
At Certain HoursExpand Hours and select the hours, on a 24-hour scale, that you would like the report to run.

In the image below, the hours 6, 7, and 8 have been selected. This means that the report will run at 0600 hours, 0700 hours, and 0800 hours.
Reports recurring at certain hours.jpg Reports recurring at certain hours.jpg
At Certain Hours setting
Every HourThe report runs at the top of every hour. This is the default setting in the Hour cluster.
Every Hour in RangeThe report runs at the top of each hour, within the range you set.

For instance, in the image below, the range is 4 and 16 which equates to 4:00 AM (0400) and 4:00 PM (1600). This means that every hour between 4:00 AM and 4:00 PM, this report will run.
Reports recurrance every hour in range.jpg Reports recurrance every hour in range.jpg
Every hour in range option
Every X HoursThe report runs at the interval you set, beginning on the hour you set each day.

For instance, in the image below, the report is scheduled to begin running at 4:00 AM (0400) each day and then run every two hours after that.
Reports recurring every x hours.jpg Reports recurring every x hours.jpg
Every X Hours example

Day

Use the Day setting to specify on which days the report runs.
OptionDescription
Every DayThis setting runs the report every day. This is the default setting in the Day cluster.
Every X Days Of MonthThis setting runs the report on a set frequency based on the day of the month the recurrence is started.

Expand Start and select the day of the month (1–31) you want the report to begin running. Expand Frequency and select how often you want it to run.

In the image below, the report is set to begin on the 10th day of the current month, and to run every four days after that.
Reports every X days.jpg Reports every X days.jpg
Every X Days Of Month option
Every X Days Of WeekThis setting runs the report on a set frequency based on the day of the week the recurrence is started.

Expand Start and select the day of the week you want the report to begin running. Expand Frequency and select how often you want it to run.

In the image below, the report is set to begin on the Friday of the current week and to run every four days after that.

Reports every x day of week.jpg Reports every x day of week.jpg
Every X Days Of Week option
Last Day Of MonthThis setting runs the report on the last day of the month, beginning with the current month.
Last Weekday Of MonthThis setting runs the report on the last weekday of the month, beginning with the current month.
Last X Of MonthThis setting runs the report on the last specified day of the month, beginning with the current month.

Expand Day and select the day of the week you want this report to run.

In the image below, Day is set to Friday. This means that this report will run on every last Friday of the month.
Reports last x of month.jpg Reports last x of month.jpg
Last X Of Month option
Nearest Weekday to Xth Of MonthThis setting runs the report on nearest weekday to the day of the month that is specified.

Expand Day and select the day of the month (1–31)

In the image below, Day is set to 5. This means that this report will run on every weekday closest to the fifth of each month. If the fifth is a weekday, it will run; however, it will not run on Saturday or Sunday.
Reports nearest weekday to X of month.jpg Reports nearest weekday to X of month.jpg
Nearest Weekday to Xth Of Month option
On Certain Day Of Certain Week in MonthThis setting runs the report on the specified day of the specified week of the specified month.

Expand Week and select the week of the month you want this report to run. Expand Day and select the day of that week you want this report to run. If you select a combination that does not occur in a month, the report does not run in that month.

In the image below, Week is set to Third and Day is set to Wednesday. This means that this report runs every third week of every month on that Wednesday.
Reports day of week of month.jpg Reports day of week of month.jpg
On Certain Day Of Certain Week in Month option
On Certain Days Of MonthThis setting runs the report on the days of the month that are specified.

Expand Days and select the days of the month (1–31) that you want the report to run. You can select multiple dates.

In the image below, you can see that this report will run on the 4th, 8th, 12th, and 20th of each month.
Reports on certain days of month.jpg Reports on certain days of month.jpg
On Certain Days Of Month option
On Certain Days Of WeekThis setting runs the report on the day of the week specified. You can specify more than one day.

Expand Days and select the days of the week you want the report to run.

In the image below, this report is set to run on every Tuesday and Thursday of the month.
Reports on certain days of week.jpg Reports on certain days of week.jpg
On Certain Days Of Week option
X Days Before End Of MonthThis setting runs the report on the specified days before the end of each month.

Expand Days and select the number of days before the end of each month that you want this report to run.

In the image below, the report is set to run five days before the end of each month.
Reports x days before end of month.jpg Reports x days before end of month.jpg
X Days Before End Of Month option

Month

Use the Month setting to specify the monthly recurrence options for the report.
OptionDescription
During Certain MonthsThis setting specifies that the report will run only during the months that are selected.

Expand Months and select the months you would like this report to run. You can specify a single month or multiple months.

In the image below, the report is scheduled to run every March, June, and October.

Reports during certain months.jpg Reports during certain months.jpg
During Certain Months option
Every MonthThis setting specifies that the report will run every month. This is the default setting in the Month cluster.
Every Month In RangeThis setting specifies that the report will run each month within the range of months specified.

Expand Start and select the month to start running the report. Expand End and select the month to stop running the report.

In the image below, the report is scheduled to run every month beginning in June and ending in August.
Reports every month in range.jpg Reports every month in range.jpg
Every Month In Range option
Every X MonthsThis setting specifies that the report will run on a specified frequency based on the month selected.

Expand Start and select the month to begin running the report. Expand Frequency and select how often you would like the report to run.

In the image below, the report is scheduled to begin running in February and continue running every three months after that.
Reports every x months.jpg Reports every x months.jpg
Every X Months option

At the top of the clusters is an information bar. This information bar shows the current recurrence schedule. In the image below, the report is scheduled to run every four hours during the months of April and August.

Note
Notice that the time used for the recurrence settings is America/New York.

reports info bar.jpg reports info bar.jpg
Recurrence info bar

To illustrate how the clusters work together, a few samples are available below. Click the example heading to view what the setup would look like in Brightspot.

Example 1


  • Runs at midnight (0000), 6:00 AM (0600), noon (1200), and 6:00 PM (1800).
  • Every fifth day beginning on the first of the month.
  • Every month.
Reports example 1.jpg Reports example 1.jpg
Recurrence example

Example 2


  • Every hour.
  • On the last day of the month.
  • Only in the months of March, June, September, December.
Reports example 2.jpg Reports example 2.jpg
Recurrence example

Example 3


  • Every hour between 10:00 AM (1000) and 10:00 PM (2200).
  • Only on the Wednesday of the third week of the month.
  • Every month beginning in March and ending in June.
Reports example 3.jpg Reports example 3.jpg
Recurrence example

Previous Topic
Creating editorial content reports
Next Topic
Configuring the Content Reports widget
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Content types
Modules
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Dashboards
Publishing
Workflows
Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
Images
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Shopify
Apple News