Scribd Logo
Upload

Welcome to Scribd!

  • 455 views

    Integration of XML Publisher With OAF - v1

    Uploaded by

    sreenivasagurani
    This document describes how to integrate Oracle XML Publisher with Oracle Application Framework (OAF) to generate reports in PDF, MS Word, Excel, and HTML formats directly from an OAF page without submitting a concurrent program. The key steps are: 1) Generate XML data from a view object and register it as the data definition. 2) Design a template in XML Publisher and register it. 3) Invoke the XML Publisher APIs to process the template against the XML data and generate the output file in the desired format. 4) Return the output file to the user by setting the appropriate HTTP response headers and content type.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as DOC, PDF, TXT or read online from Scribd

    Integration of XML Publisher With OAF - v1

    Uploaded by

    sreenivasagurani
    455 views6 pages
    This document describes how to integrate Oracle XML Publisher with Oracle Application Framework (OAF) to generate reports in PDF, MS Word, Excel, and HTML formats directly from an OAF page without submitting a concurrent program. The key steps are: 1) Generate XML data from a view object and register it as the data definition. 2) Design a template in XML Publisher and register it. 3) Invoke the XML Publisher APIs to process the template against the XML data and generate the output file in the desired format. 4) Return the output file to the user by setting the appropriate HTTP response headers and content type.

    Original Title

    Integration of XML Publisher with OAF_v1

    Copyright

    © Attribution Non-Commercial (BY-NC)

    Available Formats

    DOC, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    This document describes how to integrate Oracle XML Publisher with Oracle Application Framework (OAF) to generate reports in PDF, MS Word, Excel, and HTML formats directly from an OAF page without submitting a concurrent program. The key steps are: 1) Generate XML data from a view object and register it as the data definition. 2) Design a template in XML Publisher and register it. 3) Invoke the XML Publisher APIs to process the template against the XML data and generate the output file in the desired format. 4) Return the output file to the user by setting the appropriate HTTP response headers and content type.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as DOC, PDF, TXT or read online from Scribd
    Download as doc, pdf, or txt
    455 views6 pages

    Integration of XML Publisher With OAF - v1

    Uploaded by

    sreenivasagurani
    This document describes how to integrate Oracle XML Publisher with Oracle Application Framework (OAF) to generate reports in PDF, MS Word, Excel, and HTML formats directly from an OAF page without submitting a concurrent program. The key steps are: 1) Generate XML data from a view object and register it as the data definition. 2) Design a template in XML Publisher and register it. 3) Invoke the XML Publisher APIs to process the template against the XML data and generate the output file in the desired format. 4) Return the output file to the user by setting the appropriate HTTP response headers and content type.

    Copyright:

    Attribution Non-Commercial (BY-NC)
    Download as DOC, PDF, TXT or read online from Scribd
    Download as doc, pdf, or txt
    of 6

    Integration of XML Publisher with OAF

    Generating output in PDF, MSWord, MSExcel and HTML Format:

    It is a very common requirement where we want to generate reports in PDF, MSWord, MS Excel and
    HTML format from an OAF page itself without submitting any concurrent program.

    To generate the output in PDF or other formats we need the following:


     XML Data Definition, registered with Apps
     Template, registered with Apps
     XML Publisher APIs to process the template and generate the output in required format.

    As we are going to generate the output from OAF, we need to generate the XML data using view object,
    View Object is having inbuilt functionality to read and write data in XML format. View Object is having
    one method called writeXML which will generate the data in XML format. We can use it for two
    purposes:
    1. To generate XML Data in Jdeveloper Embedded OC4J Sever Log (It will give XML Definition
    of data; we can use it for designing our Template and register this as Data definition).
    2. To generate XML data for actual template processing.

    Steps to Generate the Output in required format:

    Step 1: Create OAWorkspace, Project, packages, VO and AM (I hope you are already familiar with
    these)

    Step 2: Import following Packages in AM and Controller:

    import java.io.ByteArrayInputStream;
    import java.io.ByteArrayOutputStream;
    import javax.servlet.ServletOutputStream;
    import javax.servlet.http.HttpServletResponse;
    import oracle.apps.fnd.framework.webui.beans.table.OAAdvancedTableBean;
    import oracle.apps.xdo.oa.schema.server.TemplateHelper;
    import oracle.jbo.XMLInterface;

    Step 3: Create one method in your AM to generate XML output, call this method from your
    processRequest mathod and get it printed on Jdeveloper console:
    Your code for should look like this:

    public void getPrintDataXML()


    {
    try
    {
    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
    OAViewObject vo = (OAViewObject)am.findViewObject("XXEGASRPrintPageVO1");
    ((XMLNode) vo.writeXML(4, XMLInterface.XML_OPT_ALL_ROWS)).print(outputStream);
    System.out.println(outputStream.toString());
    }
    catch(Exception e)
    {
    throw new OAException (e.getMessage());
    }
    }

    Statements highlighted will print the XML data generated by your view object to Jdeveloper console.
    In first line vo.writeXML will generate the XML for VO and print method will write the XML data in
    outputstream that can further be used to print XML data on Jdeveloper console using println method.

    You can copy this output and save with some meaningful name and use it to register as data definition
    and to design your template(copy only XML data).

    Step 4: Design your template


    Step 5: Register your Template and data Definition in Oracle Apps

    Click on “Create Data Definition” button

    Fill in all the mandatory columns and give a short code for your data definition and clink on “Apply”
    button, now click on “Template” Tab

    Click on template tab and then press “Create Template” button


    Fill in all the mandatory columns and give a short code (It will be used by XML Publisher APIs to
    process the template) for your template and clink on “Apply” button

    Step 5: Generate output, using XML publisher APIs

    Step 6.1: Create a submit button to Generate the output say “Print”
    Step 6.2: Add following method to your AM Impl class

    public XMLNode getPrintDataXML()//XMLNode


    {
    OAViewObject vo = (OAViewObject)findViewObject("EmpVO1");
    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
    XMLNode xmlNode = (XMLNode) vo.writeXML(4, XMLInterface.XML_OPT_ALL_ROWS);
    return xmlNode;
    }
    Step 6.3: Handle the event for “Print” button:

    /*
    * Handles functionality of Print button
    */
    if(pageContext.getParameter("btnPrint")!=null)
    {
    // Get the HttpServletResponse object from the PageContext. The report output is written to
    HttpServletResponse.
    DataObject sessionDictionary = (DataObject)pageContext.getNamedDataObject("_SessionParameters");
    HttpServletResponse response =
    (HttpServletResponse)sessionDictionary.selectValue(null,"HttpServletResponse");
    try {
    ServletOutputStream os = response.getOutputStream();

    // Set the Output Report File Name and Content Type


    String contentDisposition = "attachment;filename=PrintPage.pdf";
    response.setHeader("Content-Disposition",contentDisposition);
    response.setContentType("application/pdf");
    // Get the Data XML File as the XMLNode
    XMLNode xmlNode = (XMLNode) am.invokeMethod("getPrintDataXML");
    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
    ByteArrayInputStream inputStream = new ByteArrayInputStream(outputStream.toByteArray());
    ByteArrayOutputStream pdfFile = new ByteArrayOutputStream();

    //Generate the PDF Report.


    //Process Template
    TemplateHelper.processTemplate(

    ((OADBTransactionImpl)pageContext.getApplicationModule(webBean).getOADBTransaction()).getAp
    psContext(),
    “AK”,//APPLICATION SHORT NAME
    “Print Template TMP”, //TEMPLATE_SHORT_CODE

    ((OADBTransactionImpl)pageContext.getApplicationModule(webBean).getOADBTransaction()).getUs
    erLocale().getLanguage(),

    ((OADBTransactionImpl)pageContext.getApplicationModule(webBean).getOADBTransaction()).getUs
    erLocale().getCountry(),
    inputStream,
    TemplateHelper.OUTPUT_TYPE_PDF,
    null,
    pdfFile);
    //TemplateHelper.

    // Write the PDF Report to the HttpServletResponse object and flush.


    byte[] b = pdfFile.toByteArray();
    response.setContentLength(b.length);
    os.write(b, 0, b.length);
    os.flush();
    os.close();
    pdfFile.flush();
    pdfFile.close();

    }
    catch(Exception e)
    {
    response.setContentType("text/html");
    throw new OAException(e.getMessage(), OAException.ERROR);
    }
    pageContext.setDocumentRendered(true);

    Now run your page and click on Print button:


    In this manner we can generate the output in Excel, Word and HTML format also but we need to modify
    our code a bit…

    The statements in red color need to be modified:

    First file name in following statement :


    String contentDisposition = "attachment;filename=PrintPage.pdf";
    It can be <userdefined_filename>.doc/.xls/.htm

    Second is file MIME Type needs to be changed:


    response.setContentType("application/pdf");

    Here application/pdf can be replaced with valid MIME type for Excel/Word and HTML

    Third TemplateHelper.OUTPUT_TYPE_PDF, in this OUTPUT_TYPE_PDF can be replaced by


    OUTPUT_TYPE_HTML/ OUTPUT_TYPE_EXCEL/ OUTPUT_TYPE_RTF.

    You might also like

    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy