Bursting schedules are specifically designed to burst individual groups in a report and deliver each group to a different destination. For example, you can tell CRD to burst a sales report into individual groups based on "Department" and to email each department's group to the head to that department.. The purpose of the wizard will be to guide you through the process of setting up a single report to be generated at defined intervals and delivered to one or more defined destinations.
Example: Management now wants Khan to break a report up by customer so they can more closely detail the customer's order profile. Rather than changing the report, or writing a new one, he can automatically burst the different groups.
To start the Wizard, go to the Home Tab and then select Bursting.
Continue to Bursting Schedule - General
General - Bursting Schedule Report
This Section determines the most basic properties of the schedule.
Schedule Name: The name of the schedule
Create in: The CRD folder where the schedule is stored
Report Location:The path to the report
Description: A short description to help other users identify exactly what this schedule is and what it is expected to do
Keyword: Enter some keywords which can be used later by Smart Folders to identify this schedule.
Crystal Report Fields: Check this box if you need to use Crystal Report Fields in the schedule.
Continue to Bursting Schedule - Schedule
Schedule - Bursting Schedule Report
In this section, you will decide when the report will execute. There are a variety of options:
Daily: Run a report every day or at a frequency of days.
Repeat every X Days- EX. Run the schedule every 3 days.
Weekly: Run a report on a weekly time frame.
Repeat every X weeks- EX. Run the schedule every 2 Weeks.
On- Select the specific days of the week the schedule will run. If only once a week, select only the day of the week it will run. EX. Run every Monday, Wednesday, and Friday.
Weekdays: Run the schedule Monday through Friday.
Monthly: Run the schedule on a monthly time frame.
Use the following options- Checking this box will enable you to select frequency options such as the “last Thursday of the month.” Also you can include or exclude specific months from the schedule.
Annually: run the schedule every year at a specified time.
Custom Calendar: Select the custom Calendar you wish to use. You can create a new custom calendar from the menu as well. Please see Custom Calendars for a tutorial.
Other: Other scheduling options.
Run Schedule every X Minutes, hours, days, weeks, months, years
None: No scheduling is required for this item.
Next, you will specify the time that the schedule will run as well as repetition options.
Schedule time: Specify the exact time you want your schedule to run. *Tip: keeping in mind how long it takes for your report, time your schedules accordingly!
Exception Calendar: choose a calendar that will instruct the schedule to NOT run on those specified days. Please see Custom Calendars for a tutorial.
Next to run on: displays the next run date of your schedule.
Repeat ever X hours or minutes: run your reports on a reoccurring basis during a specific time frame. EX Repeat every .25 hours until 5PM.
Enable this schedule: to enable the schedule leave the box checked. To create this schedule disabled, deselect this box.
Once you have finished creating the timing for your schedule, click finish to proceed to the next stage.
Continue to Bursting Schedule - Report
Report - Bursting Schedule Report
In this section, you will determine the parameters for your report (if any) and select options for your subreport. If your report has no parameters, you may skip this section by clicking next.
There are 3 requirements in order for CRD to detect your Crystal Report parameters and their parameter values:
1) The parameter must be in use in the report
2) The parameter must be visible
3) The parameter must be set to be prompted at runtime
If these three requirements are achieved, you should see the parameters in your report listed in this screen.
For each parameter, select from the drop down list the value the report must use. In a single schedule, only one parameter value can be run at a time per parameter. You can type a value into the field as well.
Set as Null: Set no value for this parameter.
Ignore: Do not run this parameter, ignore it at runtime.
Select from the dropdown list the upper and lower value for the parameter.
Include Value upper/lower: Include the selected parameter value in the range.
No lower/upper bound: include all values above the upper value, include all values below the lower value.
*Tip: to enable a report parameter to run for a date constant (Current Date, Yesterday etc.), select CRD Constants from the inserts window, then drag and drop your
desired constant to the parameter field.
Selecting Date Parameters via Calendar
If your report contains a date parameter, you can either manually enter dates as described earlier in this topic, or select the desired date from the built in calendar. Simply click in the date parameter field to open the calendar. Select the desired date. Click OK. If the parameter is also a time parameter, this can selected as well.
The buttons below enable you to preview the report, adjust formulae, and review subreports. You can re-query the report for parameters as well.
Preview: view the report output given the selected parameters.
Formulae: View edit and Parse the Record Selection Formulae.
Subreports: set parameters, authenticate, and re-query subreport parameters.
Set Parameters: select the parameters for the sub report. Note: Crystal 2008 API does not allow access to sub report parameters in CRD. CRD will run the subreport as they are created in Crystal.
Re-query Parameters: Re-query the report for the new parameters.
Set Database Login: Set Authentication information for the subreport.
Set Table Login: Set Authentication information for individual tables in the subreport.
*Note: Subreport parameters must be linked to the parameters in the main report
*Hint: If check the pull Crystal Report Fields box earlier, then you can insert values from your crystal report here.
This screen shows parameter information and provides advanced record selection editing capabilities.
Continue to Bursting Schedule - Report Options
Report Options - Bursting Schedule Report
Database Login: If the database requires logon credentials, check this option and enter the required username and password. If credentials are not required, uncheck the option and continue as normal (default). All values are optional. You only need to enter a value if your database, security, networking or infrastructure require it.
Saved Data: By default, CRD will always attempt to run the report using the very latest data in your database. If your report is saved "with data" and you want CRD to simply export the data in the report, then check this option.
Refresh: Check this option if you want to refresh the schedules before every execution.
Continue to Bursting Schedule - Bursting Mode
Bursting Mode - Bursting Schedule Properties
In this Section we will decide what type of bursting groups will be used, and which group values will be executed.
*Note: CRD can only burst using values within Group Header 1 of your report.
There are two types of bursting:
Simple Bursting Mode:
From the top dropdown box, select the column or formula group that is located in group header one.
In the lower dropdown box, select the group value to be bursted. It may take a few moments for the group values to be pulled.
Now you can pull the group value into the bursting list. Click the button. You will be prompted to create a destination for this group value.
Create your Destination. Each group value can go to a different destination.
You can customize a destination (i.e. SharePoint Metadata, or the email body) by inserting fields from your crystal report.
Continue adding group values until you are finished. If you want to remove a group value, select it, then click on .
If you click on , you can test a group value by importing a default destination.
Click next to continue to Bursting Schedule - Exception Handling
Advanced bursting mode:
With Advanced Bursting, multiple report groups can be exported automatically. If a destination (i.e. email addresses) can be found in your report, then you can use it to deliver group values to unique email addresses.
Similar to Simple Bursting, select your group values from the dropdown list. Unlike Simple Bursting, the destination is determined in the next step.
To select all group values for export, click . All Group values found in the report will bursted.
Check the "include all other group values" box to ensure CRD will run for all values, even if they are not specified during schedule creation.
to set the destination, continue to Bursting Schedule - Output .
Output - Bursting Schedule Report
If you have Selected Advanced Bursting, you can specify a destination for all group values.
To create a Destination click add. Go to Destinations to learn how to set one up.
*Tip: Use Crystal Report fields to customize the email output. Each group value will go to a unique destination and have an output tailored to them. See Below.
Continue to Bursting Schedule - Exception Handling.
Exception Handling - Bursting Schedule Report
Reports fail for any number of reasons - database connectivity issues, database busy, network issues and more. This screen gives you the ability to tell CRD what to do if it encounters an error.
On error, retry executing: If set to 0, CRD will deem the schedule as "Failed" the first time it encounters an error. The schedule will not run again until its next scheduled time. Change the value to tell CRD how many times you want it to retry running the report before declaring it as "Failed".
Treat as failed if not completed: If a report "hangs", this option tells CRD to declare it "Failed" after a certain length of time and to move on to other schedules in the queue. A report which "hangs" will not report an error, so the "Retry Scheduling" option will not apply.
Perform checks for blank report: If a report is blank because it genuinely returned no data, recipients can misconstrue this as an error with the scheduler. This option allows you to identify genuine empty reports and instruct CRD on what to do with them.
Check if a report is blank: With this option you can check if a report is blank.
Ignore the report and subsequent tasks: if the report is blank, do not send the report. The report will not be delivered to the destination. Subsequent tasks will not be executed.
Only run tasks if ALL reports are blank: If each bursted report is blank, the custom tasks will run.
Method Tab: Select the Method that will determine whether a report is blank.
Native: CRD will check to see if the report returns any data. If not, the report is considered blank.
SQL Query: Select this option to use a user made query that will determine if the report is blank. If the query returns no results, the report is blank.
Actions Tab: Select an action from the task list. This task will be executed in the event that a schedule is blank.
*Tip: You can send a notification if a report is considered blank instead of sending the report. Simply select “check if a report is blank” then select “Ignore the report.” In the actions tab, select “Send Email” from the list. Compose your email and save.
Continue to Bursting Schedule - Tasks
Tasks - Bursting Schedule Report
Add, Edit, delete and change the order of tasks from this screen. For more information about the Custom Tasks module, click here.
Use to export a task list, or import a previously exported task list.
Bursting Schedule Context Menu
Right-Click on a schedule to see the following actions.
Copy: Use this to copy an existing schedule. You can then paste it into another folder or the same folder. Simply open the folder you wish to paste to, right-click in the "white" space and select "Paste". Follow the on-screen instructions to complete the process.
Paste: Paste a previously copied schedule
Rename: Rename a schedule
Enabled: Schedules are Enabled when there is a check beside this option. To stop a schedule from running, or to "pause" it for a while, select this option to remove the check. Disabled schedules will not run till they are enabled again.
Refresh: When a schedule is first created, CRD caches (saves) a copy of the report. All executions of the scheduled are performed using this copy. If you make changes to your master report, you must select this option in order to pull the changes into CRD.
Preview Report: Click this option to preview your report.
Execute Schedule: This will execute the schedule immediately. Note that the next run date and time is not moved on as a result of a manual execution. They only move on if the schedule is run automatically by one of the schedulers.
Delete Schedule: Selecting this option will delete the schedule.
Properties: Selecting this option will bring up the "Properties" module containing configuration information for that schedule.
Test Schedule: This option allows you to run a test of the schedule to a destination you can specify.
Convert to Package: This option allows you to convert the bursting schedule into a packaged schedule.
Adhoc Email to Recipients: This allows you to send the output of the reports to specified email recipients in the form that appears.
Create Shortcut: This enables you to create a shortcut to the schedule that can be used to execute the schedule.
Adhoc View: This allows you to quickly preview the report.
Bursting Schedule - Properties
For more information on each of the menu items, select the relevant link below:
This screen shows you a history of the selected schedule. To see a history of all schedules, please use the System Monitor.
Clear: Use this option if you want to clear all the history for a schedule.
Refresh: Use this option to refresh all the schedule history.