10 Simple Steps To Implement XML Bursting Guide

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 11
At a glance
Powered by AI
The key takeaways are the 10 steps outlined to implement XML bursting in Oracle Apps to distribute reports to multiple recipients.

The steps outlined to implement XML bursting are: 1) Create RDF Report, 2) Register Executable, 3) Register Concurrent Program, 4) Create XML bursting control file, 5) Register data definition, 6) Create RTF template File, 7) Upload RTF file to data template, 8) Place RTF File on Server, 9) Add concurrent program in request group, 10) Set the Temporary Working Directory.

An RTF template is created using the XML file generated by the concurrent program. The RTF template is used by the bursting program to generate the output that will be distributed to recipients.

10 Simple steps to implement XML Bursting Guide

By Syed Farhan Ashraf | February 1, 2015


0 Comment

In this Article, We shall cover following steps to understand and implement XML Bursting feature
in Oracle Apps

1. Create RDF Report


2. Register Executable
3. Register Concurrent Program
4. Create XML bursting control file
5. Register data definition
6. Create RTF template File
7. Upload RTF file to data template
8. Place RTF File on Server
9. Add concurrent program in request group
10. Set the Temporary Working Directory
11. Submit concurrent Program and wait for email

XML Bursting Concept


Oracle Defines it as following

Oracle Reports enables you to deliver a single report to multiple destinations simultaneously.
Using the new, enhanced distribution feature, you can set up your report to be distributed to an
e-mail destination, a portal, a printer, or anywhere else when the report is run. This feature also
enables you to improve performance, since you only fetch the data once for many different
formats and destinations. Using distribution also reduces your maintenance overhead because
you only need one job request to publish the report to multiple destinations. You can refine this
further by sending the Header section to some recipients, the main to others, and the entire
report to an entirely different recipient list.
In this post of Oracle HRMS Overview, i am going to cover the step by step guide to implement
XML Bursting feature along with business requirement and its solution. In the end of this article,
there is download option through which you can download the solution files.
Business Requirement

We have a concurrent program for generating payslip and we want a concurrent program
through which payslip should be generated and output should be emailed to all persons. Every
person should receive only his related payslip.

Solution concept
There are different ways of achieving this task. But in this post i am demonstrating the feature of
XML Bursting to accomplish this task. In this example we shall create the concurrent program
and will see how to burst it through XML Bursting.
Step By Step Solution
We have to do following steps to achieve the required result

1. Create RDF Report


2. Register Executable
3. Register Concurrent Program
4. Create XML bursting control file
5. Register data definition
6. Create RTF template File
7. Upload RTF file to data template
8. Place RTF File on Server
9. Add concurrent program in request group
10. Set the Temporary Working Directory
11. Submit concurrent Program and wait for email

Note: In case of pure xml report, this report has to be called through pl/sql and xml bursting
program should be called sub sequentially passing the request id of report concurrent program.

Back to top
Step 1 – Create a report in RDF

Create a report in Oracle Report Builder and make sure that report should contain following
1. Parameter p_conc_request_id
2. User Exit in Before and After Report Triggers
3. User Exit and XML Publisher bursting program call on After Report Trigger

After Report Trigger should look like this


Back to top

Step 2 – Register Executable

Once report is ready, register its executable program through Application Developer
responsibility

Back to top

Step 3 – Register Concurrent Program


Register Concurrent Program against the executable created in step above. Make sure
the Output should be of XML type.

Add Variable to Concurrent program. These parameters will be as per your custom requirement.
In this example for simplicity purpose, i have taken only one parameter of business group id.
Make sure that token of parameter should match with parameters in RDF Report.
XML output of this program looks like this
Back to top
Step 4 – Create XML bursting control file

Next and very important step is to create the XML Bursting control file. Oracle has suggested
instructions to create the bursting control file, Following which we can control the behavior of this
feature as per our need. Find the example of sample control file.

Detailed explanation of above file is given below


Back to top
Step 5 – Register data definition
Register data definition through XML Publisher responsibility. Make Sure that Short Code of
concurrent program and Code of data definition should be same.

Back to top
Step 6 – Create RTF template File

Using the XML file that we had generated in Step 3 above, create RTF template. Creating RTF
template using XML publisher is out of scope of this post. Once template is ready, it looks like
this.
Back to top
Step 7 – Upload RTF file to data template

Create template against the data definition created above and upload the RTF template file as
shown below

Back to top
Step 8 – Upload RTF Template to Data Template
This additional step is must required. You need to upload RTF template at any location on your
server. Bursting program considers this template to generate the output. You can place this file
using WinScp software if you have access otherwise ask your DBA to place file on any location
of your application server. Preferably, you can put this template file on your temporary folder that
you will do in Step 10 ahead.
Step 9 – Add concurrent program in request group
At this step you need to add your custom program XX Employee Data – XML Bursting in request
group of your responsibility. You should also add the XML Publisher Report Bursting
Program program in addition to it. Short name of XML Bursting concurrent program
is XDOBURSTREP.

You had called this program in the After-Report parameter of you RDF report created above. If
you will not add this concurrent program in your request group, your concurrent program will
execute smoothly but xml publisher concurrent program will error out.

Back to top
Step 10 – Set the Temporary Working Directory

You also need to set the temporary working directory. Through XMP Publisher responsibility, Go
to Administration Tab

and set the value of temporary working directory.


It could be any directory where Apps user create the temporary files to be used for bursting.

Back to top
Final Step for XML Bursting – Submit concurrent Program and wait for email
At this point, all your steps are completed and its time to submit the custom concurrent
program XX Employee Data – XML Bursting.

Once you submit the program, as soon as it gets completed, it submits bursting program that we
had called in After-Report trigger of rdf report of this concurrent time. If this program gets
completed successfully and your SMTP server is configured properly, you should received an
email as per your control file.

In my case case, following is the email i received through this concurrent program.

Following is further detail, when i open the attachment in the email i received.

It is showing data that is relevant to me. Download Solution Files


Download Solution Files for XML Bursting
To Study more on this topic refer following link from Oracle.
Back to top

You might also like