Reporting Server provides report-specific schedules to help you control processing and distribution of reports. All schedules specify a type of recurrence: monthly, weekly, or daily.
This section explains on how to add, edit, delete schedules, manage report schedules and also on how to run the schedules on demand and enable or disable schedules in the Bold Reports On-Premise.
Schedules page displays the schedules that are accessible by the user depending on the user’s permission will be shown in the schedules page.
Schedules can be created only if the user has Create All Schedules
permission. Schedules can be created in two ways,
+
button in the left side menu.+
button in the left side menu and choose Schedule
under Create
to add a Schedule.
Actions
button in the reports grid context menu and select Schedule
to schedule the corresponding report.
Categories or Reports can be changed from schedule dialog box itself.
Schedules
from left side panel of the Report Server and click Create Schedule
button.
Category
dropdown. After selecting the category, corresponding reports under that selected category will be displayed in the report
dropdown,
To modify the parameter values, you should enable the
Set parameters
option in the schedule dialog box.
For default password, the password will be generated in the combination of first four characters of username and last four characters of email.
But, the username or first name is mandatory in the password condition.
For instance, you have a sample user with details below:
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 Email + 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 |
johnhael |
By selecting the variable the scheduled user variable is assigned directly from the server to the mail template
Email Id
and you can add multiple external recipients at a time, separate an email by a comma(,). For example [recipient1@gmail.com,recipients2@gmail.com].Note: Email attachment is selected as default.
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 folder path will be \Export and the default root path location will be C:\BoldServices\app_data\reporting\Jobs.
Max reports count - Maximum exported reports count to be save in that location.
Overwrite the Existing file - when you enable this option, it will overwrite the existing file which is present on the exported folder location.
Notify Recipients - When you enable this option, it will notify the recipients.
For saving the exported file on network location, we have to provide path in UNC format as like below,\\172.34.203.23\test\Export
Root directory path: \\172.34.203.23\test
Relative path: \Export
Write permission for that required root directory path folder.
When clicking the Schedule, the report will be scheduled in the selected recurrence.
Read Write Delete permission for that Specific Schedule will be added for the user who created the schedule.
Category, report, name, recurrence type, recurrence, start and end dates, export format and the recipients can be changed in the Edit Schedule dialog box.
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.
Schedules can be disabled at any time which will ignore any next occurrences. When enabled it will get the next occurrence and run accordingly.
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.
The following table illustrates the list of available APIs related to schedules in Bold Reports On-Premise.
Action | HTTP Method | Endpoint | Description |
---|---|---|---|
AddSchedule | POST | /api/site/{tenant-name}/v1.0/reports/schedule | Adds schedule to the server. Schedule details should be passed as input. |
UpdateSchedule | PUT | /api/site/{tenant-name}/v1.0/reports/schedule/{scheduleid} | Updates schedule. Should provide Schedule ID in path parameter and schedule details as input. |
RunScheduleReport | GET | /api/site/{tenant-name}/v1.0/schedules/{scheduleId}/run | Runs scheduled report. Should provide Schedule ID in path parameter. |
GetScheduleItemDetail | GET | /api/site/{tenant-name}/v1.0/reports/schedule/{scheduleId} | Returns the respective schedule details. Should pass Schedule ID in path parameter. |
GetScheduleItems | GET | /api/site/{tenant-name}/v1.0/reports/schedule/items | Returns list of scheduled items. |
GetSchedules | GET | /api/site/{tenant-name}/v1.0/items | Returns the list of schedules for current user. ItemType should be Schedule. |
IsScheduleNameExists | POST | /api/site/{tenant-name}/v1.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/site/{tenant-name}/v1.0/items/{id} | Returns the specified schedule details from the server. Schedule item ID should be passed in 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 in path parameter. |