How do I send reports on a schedule in Cloud Reporting?

Bold Reports® Cloud provides report-specific schedules to help you manage the processing and distribution of reports. All schedules specify a type of recurrence, which can be hourly, daily, weekly, monthly, or yearly.

You can add, edit, delete, and manage report schedules, run schedules on demand, and enable or disable schedules.

The schedules page displays the schedules that are accessible to the user based on their permissions.

Manage Schedules

How to add a schedule

Users with the Create All Schedules permission can add a schedule in three ways:

  1. Add a schedule from the + icon in the left side menu.
  2. Add a schedule from the context menu of the respective reports.
  3. Add a schedule from the schedule listing page.

Add a schedule from the Create button menu

  • Click the + icon in the left side menu, and then select Schedule. Schedule option in the plus menu of the left side panel

  • Choose the required category from the Category dropdown. Once a category is selected, the corresponding reports under that category will be displayed in the Report dropdown menu. Category dropdown listing reports available to schedule

  • Select the report from the Report dropdown.

    Select Report

Add a schedule from the context menu of the respective reports

  • Click the Actions button in the reports grid context menu, then select Create Schedule to schedule the corresponding report. Create Schedule option in the reports grid Actions menu

  • In the schedule dialog that opens, the Category and Report values are preselected. Schedule dialog with category and report preselected

    Categories or Reports can be changed from the schedule dialog box.

  • After you add the schedule details, click Next.

Add a schedule from the schedule listing page

  • Click Schedules in the left side panel of the Bold Reports® Report Server, and then click the Create Schedule button. Create Schedule from schedule page

  • Select the required category from the Category dropdown. After selecting the category, the corresponding reports under that selected category will be displayed in the Report dropdown, Category dropdown in the schedule dialog from the Schedules page

  • Select the required report from the Report dropdown. Report dropdown in the schedule dialog after choosing a category

  • Select the export name from the dropdown options, which include Schedule Name, Report Name, Timestamp and Date Format. Export name options such as schedule name, report name, and timestamp

Export FileName predefined variables

  • Schedule Name : The name assigned to the specific schedule.
  • Report Name : The name of the report that is scheduled.
  • Timestamp : A unique identifier generated based on the exact date and time the report was scheduled.
  • Date Format : The format in which the date will be displayed in the report.

How to handle scheduled reports with no data

No Data Options control whether a scheduled report with no data sends an email without an attachment or sends no email. When the option is enabled, the schedule follows the selected behavior:

  • When Send mail without attachment option is selected, the system sends an email notification without attaching the report if the report has no data. Send mail without attachment option for reports with no data

  • When Do not send mail option is selected, no email will be sent if the scheduled report contains no data. Do not send mail option for reports with no data

Configure Report Parameters

You set report parameter values for a schedule by enabling Set Parameters in the schedule dialog and choosing a Source of value of None, Use Default, or Expression.

  • When the Source of value is set to None, you can manually select values from the available parameter list. Parameter values chosen manually with Source of value set to None

  • Select the parameter values to apply as filters when the scheduled report is exported. Available Parameter

  • When the Source of value is set to Use Default, the scheduler executes the report using the report’s default parameter values without modification. Source of value set to Use Default for a report parameter

  • When the Source of value is set to Expression, the parameter value is evaluated dynamically based on the expression provided during schedule execution. Source of value set to Expression for a report parameter

    Note: To modify the parameter values, enable the Set Parameters option in the schedule dialog box.

Configure Recurrence Intervals

You set how often a schedule runs (hourly, daily, weekly, monthly, or yearly) and its start and end dates in the Add Schedule dialog.

  • Select the recurrence type, recurrence interval, start date, and end date in the Add Schedule dialog.

  • Reports can be scheduled to run hourly, daily, weekly, monthly, or yearly.

  • The application’s time zone will be displayed below the date picker. The start time of the schedule will be converted to the client’s time zone and displayed on the right side for the user’s convenience. Schedule start date picker with the application time zone

How to compress and password-protect exported files

You can compress a schedule’s exported reports into a zip file and protect them with a password from the schedule dialog.

  • Select Enable File Compression in the schedule dialog to compress the exported reports into a zip file. This option is optional; clear it to export uncompressed reports. File Compression

  • Exported reports can be made more secure with password protection by enabling the Enable Password Protection option in the schedule dialog box. The Default Password option is selected by default.

    For the default password, the password will be generated as a combination of the first and last four characters of the email.

  • To customize the password rules for exported reports, select Custom Password.

  • The password rule must include the username or first name. Custom Password option for password protected schedule exports

  • When configuring a Custom Password for exported reports, the available password conditions depend on the recipient type:

    • Internal users: Passwords can be generated using any combination of the selected user attributes, such as First Name, Last Name, Email, and Custom Text.
    • External recipients: Password creation supports only Email and Custom Text. User-specific fields such as First Name and Last Name are not supported for external recipients.

    Custom password conditions based on the recipient type

For example, consider a sample user with the following details:

First Name : John
Last Name : Michael
Email: [email protected]

With this sample user, the possible password combinations and their unlock passwords are explained below.

Password Rule Unlock Password
First four characters of Email
+
Last four characters of First Name
johnJohn
First four characters of First Name
+
First four characters of Last Name
JohnMich
First four characters of Email
+
Last four characters of Last Name
johnhael

How to customize the mail template

The mail template sets the email text that a schedule sends to Report Server users, and you can customize it with predefined variables.

  • The mail template defines the text that is sent via email to the Report Server user.

  • Initially, the default template will be displayed in the mail template. If the custom password is enabled, the user can add a password hint to the mail template if necessary.

  • You can also customize the email template to your preference. Customize Email Template

Mail template predefined variables

When you select a variable, the corresponding user information is automatically retrieved from the server and inserted into the mail template.

  • {Full Name}: The recipient’s full name
  • {First Name}: The recipient’s first name
  • {Last Name}: The recipient’s last name
  • {Schedule Name}: The name of the schedule
  • {Report Name}: The name of the scheduled report
  • {Report Link}: The link to the scheduled report
  • {Export Format}: The chosen export file format for the schedule
  • {Date}: Specifies the date when the schedule is triggered
  • {Organization Name}: The Organization name, retrieved from the site settings
  • {Report Image}: Provides support for inserting the report into the email body as an image.

Configure the export types

You choose one or more export formats for a schedule and then deliver the exported reports as an email attachment or to an FTP or SFTP location.

  • Reports can be exported in one or multiple formats such as PDF, Word, Excel, HTML, PPT, CSV, and XML.

    Multiple export formats selected for a scheduled report

NOTE: Multiple selected export formats are delivered as a single ZIP attachment. When only one export format is selected, the report is attached in the corresponding file format.

Email attachment

  • Exported reports can be sent to individual users or groups by selecting the Email attachment option.

  • Additionally, the exported reports can be sent to external recipients by providing their Email addresses. You can add multiple external recipients at once by separating the emails with a comma(,). For example: [[email protected],[email protected]]. External recipient email addresses for scheduled report delivery

    Note: Email attachment option is selected by default.

Combine Recipients

  • Select the Combine Recipients option to send a single email to all selected recipients instead of multiple individual emails.

  • When enabled, the selected users, groups, and external recipients receive the scheduled report in a single email.

  • When disabled, separate emails are sent to each selected recipient.

    Combine Recipients Option

  • When the Combine Recipients option is enabled, the CC section becomes available. You can add users, groups, and external recipients as CC recipients.

    CC Recipients Section

Note: When the Combine Recipients option is selected and no CC recipients are added, all selected users, groups, and external recipients in the To field receive a single email. When the Combine Recipients option is not selected, separate emails are sent to each recipient.

Reply to Email

When Email attachment is selected, the Reply to email option is enabled. Enter a Reply-To email address to direct replies to that address instead of the sender’s email. Reply to Email

Export to FTP or SFTP Location

  • To save the exported file at a network location, you must provide the path in UNC (Universal Naming Convention) format. For example, ftp://192.168.203.23/Export or sftp://192.168.203.23/Export

    Root directory path: ftp://192.168.203.23

    Relative path: /Export

    • The root directory path can be specified in Schedule Report Settings, while the relative path can be specified when creating the schedules.

    • If the Export folder does not exist, the folder will be created automatically while running the schedules.

      Write permission is required for the root directory path folder.

  • Click Schedule to schedule the report for the selected recurrence.

    Read, Write, Delete permissions for that Specific Schedule will be granted to the user who created the schedule.

How to run a schedule on demand

You run a schedule on demand by selecting Run Now in the schedule grid context menu. The report is exported in the specified format and sent to the recipients along with a link to the report in Bold Reports® via email. Run now schedule

How to view schedule run history

You view a schedule’s run history by selecting Run History in the schedule grid context menu. Run History option in the schedule grid context menu

How to edit a schedule

You change a schedule’s category, report, name, recurrence type, recurrence interval, start and end dates, export format, and recipients in the Edit Schedule dialog box. Edit Schedule dialog with recurrence, export format, and recipients

How to delete a schedule

You delete a schedule that is no longer required from the schedules grid context menu.

Click the Actions button in the schedules grid context menu and select Delete to delete the schedule. Delete schedule

Frequently asked questions

Can I send scheduled reports to people outside my organization?

Yes. Enter external recipients’ email addresses in the schedule, separated by commas. External recipients can use only Email and Custom Text in custom password rules.

Can I deliver scheduled reports to Amazon S3 or an FTP server?

Yes. Configure the S3 bucket or the FTP or SFTP root path in Schedule report settings, then set the relative path when you create the schedule.

How do I stop all schedules on my site?

Open Settings, go to the Reports tab, and enable Disable Process Schedule. All scheduled tasks for the site stop until you clear the option.

Can I test a schedule without waiting for the next run?

Yes. Select Run Now in the schedule grid context menu. The report is exported and sent to the recipients with a link to the report.

REST API reference

The following table lists the REST APIs for schedules.

Action HTTP Method Endpoint Description
AddSchedule POST /api/site/{tenant-name}/v1.0/reports/schedule Adds a schedule to the server. Schedule details should be provided as input.
UpdateSchedule PUT /api/site/{tenant-name}/v1.0/reports/schedule/{scheduleid} Updates a schedule. Schedule ID should be provided in the path parameter, and the schedule details should be provided as input.
RunScheduleReport GET /api/site/{tenant-name}/v1.0/schedules/{scheduleId}/run Runs a scheduled report. Should provide a schedule ID in the path parameter.
GetScheduleItemDetail GET /api/site/{tenant-name}/v1.0/reports/schedule/{scheduleId} Returns the respective schedule details. Should pass Schedule ID in the path parameter.
GetScheduleItems GET /api/site/{tenant-name}/v1.0/reports/schedule/items Returns the list of scheduled items.
GetSchedules GET /api/site/{tenant-name}/v1.0/items Returns the list of schedules for the current user. ItemType should be Schedule.
IsScheduleNameExists POST /api/site/{tenant-name}/v1.0/items/is-name-exists Returns an item's existence, whether the given schedule name already exists or not on the server. Schedule name and ItemType as Schedule should be passed in the request body.
GetScheduleDetail GET /api/site/{tenant-name}/v1.0/items/{id} Returns the specified schedule details from the server. Schedule item ID should be passed as a path parameter.
DeleteSchedule DELETE /api/site/{tenant-name}/v1.0/items/{id} Deletes the specified schedule from the server. Schedule item ID should be passed as a path parameter.