Fusion Blog

EBS Blog


Contact Us

Prabhakar Somanathan
  • Register

Oracle Gold Partners, our very popular training packages, training schedule is listed here
Designed by Five Star Rated Oracle Press Authors & Oracle ACE's.

webinar new Click here to raise Support Ticket. Get reply within 48 hours.

Search Courses

User Rating: 5 / 5

Star ActiveStar ActiveStar ActiveStar ActiveStar Active

XML Publisher/BI Publisher Document Viewer [ Common Region ]
Embed BI Publisher output into OA Framework Page in real time

The XML Publisher is also know as BI Publisher. In this article we will understand the XML Publisher OA Document Viewer Region. In the next set of articles we will develop OA Framework pages with the Document Viewer region.

Every XML Publisher/BI Publisher report requires the creation of

  • Data XML
  • RTF Template
  • Date Definition
  • Template Definition

Note : The Template can be defined in RFT, PDF, Excel ..

Please read the article Integrating XML Publisher and OA Framework to understand the basics of XML Publisher/BI Publisher and the steps involved in creating the above mentioned components.

The XML Publisher common user interface document viewer or common region is an Oracle Applications Framework (OAF) shared region provided by XML Publisher to view the XML Publisher report in HTML,PDF,RTF,EXCEL format inline within OA Framework page.

We can design a page that has two regions. The top region containing the Search criteria and Bottom region containing the Document Viewer. Now you can enter the search criteria and see the report in multiple formats inline within a OA Framework page.


The initialization of Document Viewer region is based on a set of predefined page context parameter that should be set in the Controller of the OA Framework page that contains the document viewer shared region.

The predefined page context is used to determine the following
1) XML Publisher Template to be used.
2) XML Publisher Data source to be used.
3) Data XML generation Method
4) Output type
5) Document Viewer Region height
6) Language and Territory.

The following are the page context parameters which should be set.






The data xml required for the report can be obtained from one of the following data source. Each data source requires a set of page context parameter to be set.


  • Concurrent Program Request Id (DATA_SOURCE_TYPE_REQUEST_ID)

Concurrent program can be used to generate the XML file as output using multiple techniques. Requires the following context parameter set

p_RequestId:Enter the concurrent request ID.



XML File available on any system path. Requires the following context parameter set

p_DataSourceCode : Enter the

DataSourceCode from the Template Manager


p_DataSourceAppsShortName : Enter the

Application Short name for the data

source definition.

p_AbsolutePath : Enter the absolute path for the XML data file.



XML file is stored in a blob column of the database table. It is obtained from the database and store in a java object BlobDomain. Requires the following context parameter set

p_DataSourceCode : Enter the

DataSourceCode from the Template Manager


p_DataSourceAppsShortName : Enter the

Application Short name for the data

source definition.

XML_DATA_FILE : Enter the BLOBDomain that contains the XML data file.


  • Final document for preview (DATA_SOURCE_TYPE_DOCUMENT)

Data present in PDF, RTF, HTML and EXCEL file. Requires the following context parameter set

p_AbsolutePath : Enter the absolute path

for the document file.

p_DocumentType : Enter the document

type to determine the correct content

type. Valid values are: PDF, RTF, EXCEL,




Specify the Template to be used to render the report. If not set, then the XML Publisher provides a LOV to select the templates based on p_DataSourceCode parameter .


Required only when p_TemplateCode is set.

Enter the Application short name of the application to which the template is assigned in the Template Manager.



The value "Default" can be entered to select the default template locale. If not set, then XML Publisher provides a e a list to select available locales for the selected template.



Valid output types are: RTF, PDF, EXCEL, and HTML, depending on the template type. If not set, then XML Publisher will provide a list to select the output types.



Height of the XDO common region window expressed as a percentage

As specified above, the data xml could be generated in 4 ways.
1) Concurrent Program
2) XML Data File
3) Blob Domain
4) Final Document.

Hence we should know when to we use these XML data generation method. As per my understanding we should use

1) Concurrent Program :
If you want to do reporting on a high volume of data in database tables, then it will require enough time to generate the XML Data. So you can use a concurrent program to generate the xml data.

2) Blob Domain :
If you want to do reporting on a low volume of data in database tables or you have the XML data available in BLOB columns, then you can use Blob Domin to generate the xml data.

3) XML Data File :
There are cases when we know the data on which we are going to frequent reports. If we are hitting such cases, we can generate the XML Data file using some technique and place it in a shared location in the Middle Tier. Then we can use this XML file to generate the report.

3) Final Document :
There are cases when we have multiple documents which we would like to show inline within OAF region. If we are hitting such cases, we can this technique to generate the report.

In our next set of articles we will see a demo on each of the above mentioned methods.

Prabhakar Somanathan


0 #1 Rehan Yusuf 2008-06-07 14:10
Hello Prabhakar, thanks for sharing this ... I have a quick question though. Is this "OA Document Viewer Region" based on an iFrame region ?
I had tried to do something similar a while back, that is, the application page should show output based on the data extraction logic / report at runtime, dictated by the Controller (based on user input ofcourse). The only thing one could do in that situation was to add a child region at runtime, of type iFrame, and point the source document to the final ouput of a XMLP report using the XDO API. Although, we didn't quite like the aesthetics of the final results. So, I'm wondering if this "OA Document Viewer Region" is improvising on the iFrame method.
I'm asking so that I better understand this feature. Thanks in advance.

Cheer s !
0 #2 Rachna Garg 2008-06-11 05:17
Thanks Prabhakar for sharing this. I have one question.... in my situation I am using a concurrent program to get the XML output into PDF format. I have created 32 subtemplates which I am importing into a main template for 32 countries. But my one country is divided into 4 legal entities and I have a requirement to create four different templates for each country but I am unable to do this as for all the for legal entities organization ID is same.

So could you please help me how can I provide user a option to choose right template on basis of correct legal entity.

What I have done, I created four different concurrent programs for each legal entity and user can choose any of the concurrent program as required.

Than ks & Regards,
0 #3 Nidhi Dadwal 2008-06-27 18:23

My project requirement is to export the data to an excel sheet using XML Publisher, which is very much psbl. The complexity lies in the data format. Actually the data in our report will be in diffrent clours (red , yellow, green) and client wants same data (with colours) when they export the data from application to the Excel.

0 #4 Gauri 2008-06-30 02:51
HI Nidhi,
Its possible to have different colors in a XML Publisher report. XMl Publisher has a feature called conditional formating .
You can define a condition and inside the condition u can mention the color that should be used to display the text.

For example if u want to highlight the a column with a different color, then use the coding in the table cell where the column values will be displayed.


If you want a specific region in the report to have a different color, then you can place the region within a similar logic i shown above.

Hope this helps you.

P rabhakar.S
0 #5 Kosstubh 2008-07-29 06:21
i want to create a rtf template such that if i choose html, everything should come in red color(say) and if i choose pdf, everything should come in blue color(say). how can i achieve this?

0 #6 Zuboff 2009-01-09 03:46

I've got problem with exporting decimal numbers from BI publisher to XLS format (Excel, Excel 2000). For example number 2.21 is displayed as II.21 (1.2.2021). Other formats works fine. I suppose the problem is in setting of a delimiter of decimal places in BI publisher. Please advise how to change the delimiter of decimal from '.' to ',' or any other solution.

Than ks a lot.
0 #7 Somasekhar 2009-01-21 11:30
Please tell me how to call concurrent program in OAF

So masekhar.
0 #8 pawan kumar 2009-03-06 09:18
Hi ,
I need to make a search page like if i search for 'Fax issue' ,it should send this search criteria along with user id to a different application in "XML" format . This different application recieves these search criteria and replies the search result back in xml format . My OA framework region should display this xml as search result.
Is it possible in OA Framework region?
0 #9 shravan pentamsetty 2009-05-18 06:23
I created a report.It is working fine.
I want the output type to be pdf.
The report generates an RTF output file as the default output type is RTF.
I am able to get the PDF output by selecting the output format in options tab present in concurrent program submission form.
I want to change the default output type to PDF.
Can you suggest me on this.
0 #10 Ravin L. Gogri 2009-06-11 16:43
I have output in Excel. How do I output data in multiple sheets if the records are more than 65000.


Ravin L. Gogri
0 #11 Sujay 2009-06-15 23:40
How to use the data xml being generated from a Concurrent Program ?
0 #12 Krishna_b 2009-06-16 18:06
Great Article ..........Thank s Prabhakar for sharing this
0 #13 Ambika 2010-02-18 19:30

I have an RDF Report which generates the XML data and XML template registered in BI publisher.

Req uirement is to fire the custom existing report instead of standard report.

The standard controller seems to generate XML and generate OA framework report as shown in your example.

But I want to extend the existing controller / overwrite the standard to call my custom report.

Can you tell me how to do this?
0 #14 dinesh khandekar 2010-06-04 09:15
Dear guru,

I have one requirement where i have to shown details of item after line. but details may be multiple for single line.
so i wanted this details comes in horizontal not vertical manner plz kindly give solution.
0 #15 Anand1906 2011-07-28 03:56
hi prabhakar,
thanks for the info, i want to know how we can generate the report based on userid using the OAF
i am the newbie in OAF..

thanks in advance
0 #16 nike shoes cheap 2011-08-14 23:38
I am really enjoying reading your well written articles. It looks like you spend a lot of effort and time on your blog. I have bookmarked it and I am looking forward to reading new articles. Keep up the good work
0 #17 Marco Martinez 2011-10-28 13:42
I have output in Excel. How do I output data in multiple sheets if the report have two querys diferent.

Add comment

Security code

Search Trainings

Fully verifiable testimonials

Apps2Fusion - Event List

<<  Aug 2021  >>
 Mon  Tue  Wed  Thu  Fri  Sat  Sun 
  2  3  4  5  6  7  8

Enquire For Training

Related Items

Fusion Training Packages

Get Email Updates

Powered by Google FeedBurner