Manage Schedules

This section explains on how to add, edit, delete schedules and also on how to run the schedules on demand and enable or disable schedules in the Syncfusion Report Server.

Schedules’ page displays the schedules that are accessible by the user depending on the user’s permission will be shown in the schedules’ page.

Manage Schedules

Add Schedules

Schedules can be created only if the user has Create All Schedules permission. Schedules can be created in two ways,

  1. Add schedule from create menu.

  2. Add schedule from context menu of the respective reports.

Add schedule from create menu

  • Click on Create button in the menu and select Schedule option to schedule the reports.

    Create Schedule

  • Select the required category from Category dropdown. After selecting the category, corresponding reports under that selected category will be displayed in the report dropdown,

    Create Schedule

  • Select the required report from the dropdown.

    Create Schedule

Add schedule from context menu of the respective reports

  • Click the Actions button in the schedules grid context menu and select Schedule to schedule the corresponding report.

    Create Schedule

  • Once dialog was opened, the category and report values are selected by default,

    Create Schedule

NOTE

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

  • Parameters available for the report will be shown in scheduler dialog.

    Set Parameter

  • Select the parameter values to schedule and export the reports with this filter.

    Available Parameter

NOTE

To modify the parameter values, you should enable the Set parameters option in the schedule dialog box.

  • Select the recurrence type, recurrence, start and end dates, export formats and the users to which the exported reports has to be emailed in the `Add Schedule’ dialog box.
  • Reports can be scheduled hourly, daily, weekly, monthly and yearly
  • Reports can be exported in PDF, Word, Excel, HTML, PPT and CSV formats

  • Application time zone will be shown below the date picker. Start time of the schedule will be converted to client time zone and shown in the right side for user’s convenience.

    Add Schedule 1

  • You can compress the exporting reports as a zip file by selecting the Enable File Compression option in the schedule dialog box. This is not mandatory and you can uncompress it at any time by simply unchecking that option.

    File Compression

  • You can secure the exporting reports with password protection by enabling the Enable Password Protection option in the schedule dialog box. By default, the Default Password option is selected.

NOTE

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

  • You can customize the password protection rules for exporting reports by choosing the Custom Password option.
    But, the username or first name is mandatory in the password condition.

    Custom Password

    For instance, you have a sample user with details below:

    Username : Michael

    First Name : John

    Last Name :

    Email: johnmichael@gmail.com

    With this sample user, the possible password combination and its unlock password have been explained below.

    Password Rule Unlock Password
    First four characters of Username
    +
    Last four characters of First Name     		MichJohn
    First four characters of First Name
    +
    First four characters of Last Name     		John
    First four characters of Email
    +
    Last four characters of Last Name
    +
    Last four characters of Username     		johnhael

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

    Email Attachment Checkbox

  • We can also save exported reports into any location by checking Save as file option.

    Save As Checkbox

  • To save the exported report, Export Path and Max reports count has to be filled.

    Export Path - Location to save the exported report. By default, the location will be C:\Syncfusion\Report Server\ReportServer.Web\App_Data.

    Max reports count - Maximum exported reports count to be save in that location.

  • When clicking the Schedule, the report will be scheduled in the selected recurrence.

NOTE

Read Write Delete permission for that Specific Schedule will be added for the user who created the schedule.

Edit Schedules

Category, report, name, recurrence type, recurrence, start and end dates, export format and the recipients can be changed in the Edit Schedule dialog box.

Run Now

Schedules can be made to run on demand by using this Run Now option in the schedule grid context menu. Report will be exported in the format specified and sent to the recipients.

Run Now Schedule

Enable or Disable Schedule

Schedules can be disabled at any time which will ignore any next occurrences. When enabled it will get the next occurrence and run accordingly.

Enable Disable Schedule

Delete Schedules

Schedules can be deleted from the Report Server when it is no longer required.

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

Delete Schedule

REST API Reference

The following table illustrates the list of available APIs related to schedules in Syncfusion Report Server.

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