Report Bursting
This document contains information about Report Bursting functionality and its use case information. Earlier this feature was known as Mapping but now it is renamed as Report Bursting. We have changed the flow of execution and improved the UI to make it more user-friendly.
This document has step by step information of how to use Report Bursting and will show one use case example.
Use Case: Report Bursting will be used in a condition when multiple
reports are required to
be generated and shared with relevant users at a specific predefined time period. Consider
the scenario where we have a BIRT report which contains the information of orders placed by
customers.
This report has a parameter for customer number and it will ask the user to
enter
a valid customer number when executed and it will provide order details for the entered
customer number. Generating order details for 1 or 2 customers is easy, you just need to run
the report manually from the report section and share reports with user.
But in case
when we
need to share order details with all customers on weekly or monthly basis, manual report
generation for each and every user will be very tedious and time-consuming as well.
Let's
assume we have to generate and share 1000 customers' reports. In order to save time, we need
to remove manual intervention and automate this process of report generation. At this stage
use of Report Bursting is advantageous. In report bursting we will get all customer number
information in a dataset and map this dataset with report using Report Bursting GUI.
After
mapping when we run this mapping, report will fetch one by one customer number and generate
report for all the users available in dataset. And by using email functionality we can Email
individual report to relevant user directly.
-Follow below steps to get hand on with Report Bursting Functionality.
In this Scenario we have demonstrated report bursting with order Details report and for order number we create or use dataset which has order number information. Then we map the report with a dataset
Prerequisites: Orders Dataset, Order Number report
1. Click on Hamburger Icon.
2. Go to Document section and click on Report Bursting, As shown in figure below:
3. Enter following details in Select/ Create Mapping Page.
Dataset: Order Details (Create or Select the dataset based on Report parameter, make sure dataset contains unique values)
4. Select report mapping to create a mapping with dataset.
- If you are doing it first time and there is no mapping created, select report mapping dropdown will show no data. But once mapping is created or you have existing mapping you can see mappings in select report mapping dropdown.
- In case you have some mappings created, when you select a dataset you will see all available mapping list under select report mapping and also you will see all mappings are grouped by Mapped and Not Mapped Keywords.
- If you have created mappings with selected dataset earlier then you can see your mapping in the Mapped list and other mappings are grouped in Not Mapped List as shown in below screenshot
5. To create new mapping with selected DS, click on + icon and It will display the following page.
6. Enter following details in Schedule Page.
Name: Order
Column Name: OrderNumber (It should be Unique)
Select Report: Order Details.rptdesign
OrderNumber: 10100, OrderNumber
7. Fill above details, as shown in figure below:
8. Click on the Output Tab.
9. Enter following details in Output Tab.
Name: Order
Select OrderNumber column in dropdown List.
Suffix: yyyyddMM_HH-mm-ss (optional)
Format: Pdf (Select the format in which you want to generate the output from the dropdown menu)
Path: /Output/Temp/ (specify the delivery path on your computer where the reports will be downloaded)
10. Fill above details, as shown in figure below:
11. Click on Save button and it will display message Created Successfully, as shown in figure below:
12. In Select Report Mapping Dropdown select the Order.
13. It will display all the Customers Ordernumber details, here you have to select the Customers orderNumber for whom you want to generate and share report.
14. In this example I am selecting first five customers OrderNumber, as shown in figure below:
15. Click on Next Button.
16. In Execute Page there are two Scenarios.
Asynchronous: Reports will be generated but will not be downloaded
Synchronous: This will work only in right now scheduling frequency. And User who is running this mapping, will receive a zip file containing all reports for selected number of users in specified format.(zip file will be downloaded in his machine)
Following steps are for Asynchronous:
17. Select Asynchronous radio button and select the format in which you want to generate the output here I am selecting the pdf format.
18. Click on Schedule button to schedule the report. Wait till you get the message of Group Schedule Successfully.
19. You can check the list of reports generated in request section as well in output>Temp folder of report section.
20. You can also schedule frequency of mapping by using schedule button given below.
21. Click on schedule button and Enter following details in Map Tab, as shown in figure below:
Column Name: OrderNumber
22. In Schedule Tab you can set the frequency as per your requirements.
23. Click on Run Button and wait till success message.
24. For Report Output go to the Documents section in that Output>>Temp folder.
25. In Temp folder you can see the reports which you have selected.
26. In Asynchronous user can see the output report, as shown in figure below:
Synchronous: In this manner, mappings can be run with only 4 output options provided that is HTML, Xlsx, PDF and Docx.
27. In order to run mapping, click on any option and wait till you see success message on top.
28. As soon as reports are generated, all reports will be downloaded in your machine in zip file.
29. You can see reports by extracting zip file and from output>temp folder of report.