Prabhakar Somanathan

XML Publisher/BI Publisher Document Viewer ( Common Region ) - Blob Domain

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.Please read the article  BI Publisher Document Viewer Common Region- Embeded Report Output in OA Framework Page  to understand the basics of XML Publisher 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 RTF, 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 data source is the method of obtaining the data XML file required for the report. This article discusses in details the steps involved in integrating XML Publisher Document Viewer Region with OA Framework page using Blob Domain data source. The Blob Domain data source is used when we want to report on a low volume of data in database tables or we have the XML data available in database table BLOB column. The Document Viewer Region requires the following page context parameter for its initialization.

Lets start developing a simple OAF page to generate a XML Publisher Employee Detail Report of employees working in a particular Department.

Steps involved :

1) Designing the OAF BC4J Data Model.

2) Designing the OAF Page and generating the Data XML

3) Designing the RTF Template using Data XML

4) Registering the Template with Oracle Applications.

5) Design the Employee Report OAF Page with Document Viewer Region

6) Set the Page Context Parameters and data XML

7) Execute the page.

The steps 1 to 4 are same as the steps 2 to 5 explained in article Integrating XML Publisher and OA Framework. Lets discuss with step 5 onwards.

Step 5 : Design the Employee Report OAF Page with Document Viewer Region

Design a OAF page with two regions. The Region 1 should have a Text Input for Dept No search. The Region 2 should be based on the XML Publisher Document Viewer Region "/oracle/apps/xdo/oa/common/webui/DocumentViewerRn.MainRegion" . The Page should look like this.

Step 6 : Set the Page Context Parameters and generate the data XML

Set the page context parameters required for the BlobDomain datasource in the controller's processRequest method. Handle the Run submit button in the processFormRequest , generate the data XML and set the XML_DATA_BLOB page context parameter.

Controller Code :

Import :

    import java.io.OutputStream;

    import oracle.apps.fnd.common.AppsContext;

    import oracle.apps.xdo.oa.util.OAHelper;

    import oracle.jbo.domain.BlobDomain;

    import oracle.xml.parser.v2.XMLNode;

    import java.io.ByteArrayOutputStream;

ProcessRequest :

  public void processFormRequest(OAPageContext pageContext, OAWebBean webBean)

  {

    super.processRequest(pageContext, webBean);

    // Get the current Locale

    OAApplicationModule am = pageContext.getApplicationModule(webBean);

    AppsContext appscontext =  

    ((OADBTransactionImpl)am.getOADBTransaction()).getAppsContext();

    String locale = null;

    try

    {

      String as[] = OAHelper.getISOCodes(appscontext, appscontext.getCurrLangCode());

      locale = as[0]+"-"+as[1];

    }

    catch(SQLException sqlexception)

    {

      throw new OAException(sqlexception.getMessage(), (byte)0);

    }

    // Set the page context parameter required for datasource BlobDomain.

    pageContext.putParameter("p_DataSource", "BlobDomain");

    pageContext.putParameter("p_DataSourceCode", "EmpDataDefinition");

    pageContext.putParameter("p_DataSourceAppsShortName", "XXXX");

    pageContext.putParameter("p_XDORegionHeight", "700");

    pageContext.putParameter("p_TemplateCode", "Emp_Template");

    pageContext.putParameter("p_TemplateAppsShortName", "XXXX");

    pageContext.putParameter("p_Locale", locale);   

  }

ProcessFormRequest :

  public void processFormRequest(OAPageContext pageContext, OAWebBean webBean)

  {

    super.processFormRequest(pageContext, webBean);

    OAApplicationModule am = pageContext.getApplicationModule(webBean);

    // Handle the Run button event.

    if(pageContext.getParameter("Go") != null)

    {

      String deptNo = pageContext.getParameter("DeptNo");

      Serializable params[] = {

          deptNo

      };     

      // Generate the Data XML. The data xml should contain the employees of the specified dept

      // number

      XMLNode xmlNode = (XMLNode) am.invokeMethod("getDeptEmpDataXML",params);

      try{

        // Create a blob object and add the data xml to it.

        BlobDomain blob = new BlobDomain();

        OutputStream os = blob.getBinaryOutputStream();

        xmlNode.print(os);

        os.close();

        pageContext.putSessionValueDirect("XML_DATA_BLOB", blob);

      }

      catch(Exception e)

      {

        throw new OAException(e.getMessage(), (byte)0);

      }

    }

  }

EmpAMImpl :

  // In this example we are generating data xml from data in existing database table. We can

  // also get the the data xml from a blob column in a database table.

  public XMLNode getDeptEmpDataXML(String deptNo)

  {

    EmpVOImpl vo = getEmpVO1();

    vo.initQuery(deptNo);

    XMLNode xmlNode = (XMLNode) vo.writeXML(4, XMLInterface.XML_OPT_ALL_ROWS);

    return xmlNode;

  }

EmpVOImpl :

    public void initQuery(String deptNo)

    {

      setWhereClause(null);

      setWhereClauseParams(null);

      setWhereClause("DEPTNO = :1");

      setWhereClauseParam(0, deptNo);

      executeQuery();

    }

Step 7 : Execute the OAF page

Deploy the OAF and the BC4J components in the middle tier. Open the OAF page, enter the dept number and click on the run button. This will generate a inline Employee XML Publisher Report.  Select the output format as per the requirement.

Note : Testing the XML Publisher Report from Jdeveloper requires setting up multiple libraries in the classpath. Hence i would suggest testing the code in the middle tier directly.

If any one has worked on different approach of implementing the BlobDomain DataSource, then please share the implementation logic.

Prabhakar Somanathan

Add comment