• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Contractors Network - Developing Oracle Bi (Xml) Publisher
 

Contractors Network - Developing Oracle Bi (Xml) Publisher

on

  • 6,046 views

 

Statistics

Views

Total Views
6,046
Views on SlideShare
6,039
Embed Views
7

Actions

Likes
1
Downloads
253
Comments
0

2 Embeds 7

http://www.lmodules.com 6
http://www.linkedin.com 1

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Contractors Network - Developing Oracle Bi (Xml) Publisher Contractors Network - Developing Oracle Bi (Xml) Publisher Document Transcript

    • Developing Oracle BI (XML) Publisher Reports in E-Business Suite Release 12 Authored by Yemi Onigbode
    • How to Guide Series: Developing Oracle BI (XML) Publisher Reports in E-Business Suite R12 Authored by Yemi Onigbode December 2009 © 2009 OracleContractors.com. All rights reserved. All other third party trademarks and registered trademarks are acknowledged. White Papers by Contractors Network Ltd This is one of a series of White Papers published by Contractors Network Ltd, each one focussing on a specific aspect of Oracle. Further copies of this and other White Papers can be obtained free of charge by contacting us at whitepapers@Oraclecontractors.com or the address below. If you have found the content of this White Paper interesting and useful, and wish to explore the subject matter further, we can introduce you to independent experts in this field. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 1
    • CONTENTS ABO U T C ON T RA CT O RS N ET W O RK ................................................................... 4 ABOUT THE AUTHOR ................................................................................................ 5 INTRODUCTION........................................................................................................ 6 WHAT IS ORACLE BI (XML) PUBLISHER? ................................................................ 7 BI Publisher or XML Publisher? ....................................................................................... 7 WHY USE XML PUBLISHER ....................................................................................... 8 The issue with traditional standard Oracle reports ........................................................... 8 The XML Publisher solution ............................................................................................ 9 WHEN TO USE XML PUBLISHER ............................................................................. 11 HOW XML PUBLISHER REPORTS WORKS .............................................................. 12 The Process ................................................................................................................ 12 The Output Post Processor (OPP) ................................................................................. 13 HOW IT WAS DEVELOPED ...................................................................................... 14 Define Requirements ................................................................................................... 14 Create Data Template .................................................................................................. 14 Create the Concurrent program based on the data template .......................................... 17 Add the report to the Report’s request group ................................................................ 19 Register the Report as a Data Definition in the Template Manager.................................. 20 Run the Report to extract the XML File ......................................................................... 22 Design Template ......................................................................................................... 23 Register the template in the Template Manager............................................................. 24 Run the report ............................................................................................................ 25 ENVIRONMENT SETUP............................................................................................ 27 Profile Options ............................................................................................................ 27 Runtime properties...................................................................................................... 28 FO Processing and RTF Template Properties.................................................................. 29 RTF Template Properties .............................................................................................. 30 POSSIBLE DEVELOPMENT ISSUES ......................................................................... 31 Check the Log file details............................................................................................. 31 How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 2
    • Environment Issues ..................................................................................................... 34 Coding Issues ............................................................................................................. 36 Output Post Processor (OPP) Issues ............................................................................. 40 IN A NUTSHELL....................................................................................................... 45 How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 3
    • ABO U T C ON T RA CT O RS N ET W O RK Contractors Network Ltd is a Global Oracle Contractors Network with primary focus on Oracle's E-Business Suite.  We are operated by Contractors Network Ltd with 11 offices worldwide.  We offer Contractor Resourcing with access to over 10,000 pre-qualified Oracle Applications Contractors through our local offices.  We have an innovative and cost effective model for Implementations & Upgrades - our 'Hybrid Team' solution.  We are able to offer access to Global Resolution Groups for adhoc work from as little as 15 minute increments  We provide the only global Oracle specific job search engine with a view of 10,000 + Oracle specific roles.  We interact with over 15,000 client personnel involved with the Oracle E- Business Suite.  We promote a community spirit through an Apps Blog, with 50 + Regional Authors that produce 20 articles a months.  We are a Publishing House for White Papers authored by Oracle Contractors and distribute these free, to clients and Contractors alike.  We offer access for training and demonstration of the latest release via an online Vision environment at no cost.  We offer Oracle Contractors special membership to a network of Oracle User Groups, under our umbrella, at a discounted rate. We exhibit & present at all Regional Oracle Conferences worldwide as well as local Special Interest Groups. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 4
    • ABOUT THE AUTHOR Over a decade of experience is what Yemi has in ERP systems development and maintenance. He has progressed from the early days of the IBM mainframe based systems to the present day of web based distributed systems. He has worked with large multinational consulting firms including Oracle Corporation, Accenture, Deloitte, Fujitsu Consulting, IBM, Sun Microsystems and CSC. Yemi is a hybrid techno-functional (Funky-tech) consultant. He is a hands-on Project Manager, Business Architect and Instructor, specialised mainly in Financials and Supply Chain models. He has assisted a number of businesses to find solutions to complex business issues using various technologies. Yemi is also a keen believer in self-development and research – he is at par with the current developments in the IT and communications industry. He is currently developing and implementing e-business solutions for large and medium sized companies, fully integrating their business applications with the Internet and providing a totally integrated solution. He has been developing in Java since 1996 and implementing Oracle Applications since 1997. He has recently project managed a successful Oracle BI Publisher implementation. Involved with providing the functional and technical specifications for the solution and managing the project in ensuring that the project was delivered on time and to budget. Yemi is an Oracle Financials Certified Trainer, Sun Certified Instructor and a Fellow of the Association of Chartered Certified Accountants. He has a Bachelor of Science (Honours) degree in Pure and Applied Mathematics. Yemi is also a technical writer on Accountancy and IT issues. Yemi also presents at Accounting and IT seminars; He also motivates and mentors young adults on career management and planning. If you have any questions or feedback for Yemi please email him on yemi.onigbode@oraclecontractors.com How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 5
    • INTRODUCTION The report-publishing framework in Oracle E-Business Suite (EBS) R12 has undergone a major change, and consultants are facing some challenges in applying the new technology stack. In this white paper I will address some issues that could be faced when implementing Oracle BI (XML) Publisher as a report publishing solution, and some suggested solutions and best practice guide in the implementation. I will look at the following major areas within the whitepaper 1. How Oracle BI (XML) Publisher Report works 2. How Oracle BI (XML) Publisher reports are developed 3. Key environment setup steps 4. Solutions to possible development issues This is not a definitive guide, but it will assist the average implementer to successfully implement a solid Oracle BI (XML) Publisher solution within Oracle EBS R12. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 6
    • WHAT IS ORACLE BI (XML) PUBLISHER? Oracle BI (XML) Publisher is a template-based publishing solution embedded in Oracle E- Business Suite. It provides a new approach to report design and publishing by using desktop tools with XML technology. “Oracle Business Intelligence Publisher (BI Publisher, formerly XML Publisher) is an enterprise reporting solution to author, manage, and deliver all types of highly formatted documents eliminating the need for costly point solutions. Built on open standards, IT staff and developers can create data models against practically any data source and use BI Publisher APIs to build custom applications leveraging existing data sources and infrastructure. End users can easily design report layouts using familiar desktop tools, dramatically reducing the time and cost needed to develop and maintain reports. Extremely efficient and highly scalable, BI Publisher can generate tens of thousands of documents per hour with minimal impact to transactional systems. Reports can be viewed online or scheduled for delivery to a wide range of destinations.” - Source Oracle Corporation (http://www.oracle.com/technology/products/xml-publisher/index.html) BI Publisher or XML Publisher? The Oracle BI Publisher was formerly called XML Publisher, and it is now part of Oracle’s Business Intelligence Suite. However the name XML Publisher is still used within the E- Business Suite (EBS), PeopleSoft Enterprise and JD Edwards E1. Oracle BI Publisher is also available as a standalone product. This white paper looks at the implementation within EBS R12, and will refer to “Oracle BI Publisher” as “XML Publisher” as implemented in EBS R12. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 7
    • WHY USE XML PUBLISHER XML Publisher provides an opportunity for rapid report publishing, development and maintenance. It is also possible to have multiple layouts in different languages for the same data structure. Report output can be generated as Excel, Word, PDF and HTML at runtime. The report layout can be developed in Rich Text Format (rtf), Portable Definition Format (pdf) or eText format. The development of the report can be separated between the structure of the data and the presentation of the layout. The issue with traditional standard Oracle reports Traditional Report Definition Files (rdf) are very difficult to maintain and have a high development and customisation cost. The data logic, layout and translation are all in one file. The output of the file is also displayed in a format that is not dynamic enough to be used for further analysis in tools like spreadsheets. Some Issues Let us have a look at an assumed requirement to create an invoice in three languages in two separate layouts. Such as, one layout for detailed invoice and another layout for summary invoice with the same data. This requirement will require six different rdf files to be developed. A small change in the layout would require amending all the six rdf files. With XML Publisher, the same report would have required two rtf layout files and two XML language translation files (XML Localization Interchange File Format - XLIFF). The change will require slight changes to the layout files. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 8
    • Another traditional issue is the layout presented by rdf outputs. In the diagram below, the end user desires to display the extracted file as an Excel output. Due to the fixed format of rdf, the report is not user-friendly for the requirements of the user. The XML Publisher solution XML Publisher allows the development separation of data, layout and translation. This makes it flexible to develop and easy to maintain. The design of the report can be delegated to consultants who are familiar with the desktop tools for layout customisation such as Adobe Acrobat and MS Word. The solution can also be developed rapidly. The output of the report can be decided at runtime. In this whitepaper, we will look at the steps required to create an XML Publisher solution that will create and extract to Excel as displayed below. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 9
    • How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 10
    • WHEN TO USE XML PUBLISHER XML Publisher is suited mainly for the following types of reports output:  Financial and business reports  Invoices, purchase orders, receipts, Sales Orders, Statements  Legal documents – Tax forms, Payslips, Cheques  Newsletters, Marketing documents How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 11
    • HOW XML PUBLISHER REPORTS WORKS The Process 1. Run the concurrent program 2. Concurrent program calls the data template in the Data definitions via the XDO engine 3. The Data template calls the SQL Query in the XML file 4. The Database engine generates the output and converts it to XML format via the XML Engine 5. The XML Output is generated 6. The Output is formatted using the Output Post Processor (OPP) based on the definitions in the template definitions 7. The user views the output How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 12
    • The Output Post Processor (OPP) Concurrent processing uses the OPP to enforce post-processing actions for publishing concurrent requests with XML Publisher. After the concurrent manager finishes running the concurrent program, it will contact the OPP to apply the XML Publisher template and create the final output. The OPP runs as a multi-threaded service, and will start a new thread for each concurrent request it processes. If all the OPP services have reached their respective maximum number of threads, the requests waiting to be processed remain in a queue to be processed as soon as threads become available. If no threads are available the concurrent program may complete with a warning. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 13
    • HOW IT WAS DEVELOPED Define Requirements The Business Analyst and the Functional Consultant identifies the data requirements including the layout of the data. The Functional Consultant produces a functional design document that is passed on to the Technical Consultant for the technical design and development. Create Data Template The XML Publisher data template is the method by which the request for data is communicated to the data engine. It is an XML document whose elements collectively define how the data engine will process the template to generate the XML. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 14
    • The Technical Consultant identifies where the data is held in the tables, and writes the SQL query to fetch the data. The SQL query is used in the data template to extract the data. Tip: To convert an existing Oracle Standard Report to an XML Publisher Report you do not need to create a data template. The data template is called using the Concurrent Manager. Structure of the data template Header – contains XML elements including: Doctype version, Data template tag and Properties tag with property elements to support the XML output and Data Engine properties. <?xml version="1.0" encoding="UTF-8" ?> <dataTemplate name="GLXRLSEG" defaultPackage="GL_GLXRLSEG_XMLP_PKG" version="1.0"> <properties> <property name="xml_tag_case" value="upper" /> </properties> The parameters used in the concurrent program and lexicals used for flexfields <parameters> <parameter name="P_SEGMENT_NAME" dataType = "character"></parameter> <parameter name="P_STRUCT_NUM" dataType = "number"></parameter> <parameter name="P_CONC_REQUEST_ID" dataType = "number" defaultValue="0"></parameter> </parameters> How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 15
    • <lexicals> </lexicals> Data queries – The SQL statement <dataQuery> <sqlStatement name="Q_SEGMENT_LISTING"> <![CDATA[ select v.flex_value segval, vt.description segdesc, … ]]> </sqlStatement> </dataQuery> Triggers – before and after triggers can be defined if used <dataTrigger name="beforeReportTrigger" source="GL_GLXRLSEG_XMLP_PKG.beforereport"/> The data structure is defined including any elements structure required. <dataStructure> How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 16
    • <group name="G_SEGMENT_LISTING" dataType="varchar2" source="Q_SEGMENT_LISTING"> <element name="segval" dataType="varchar2" value="SEGVAL"/> <element name="segdesc" dataType="varchar2" value="SEGDESC"/> … <element name="atype" dataType="varchar2" value="ATYPE"/> </group> </dataStructure> <dataTrigger name="afterReportTrigger" source="GL_GLXRLSEG_XMLP_PKG.afterreport()"/> </dataTemplate> More information on how to create the data template is found in XML Publisher - Administration and Developer's Guide - http://download- west.oracle.com/docs/cd/B40089_02/current/acrobat/120xdoig.pdf Create the Concurrent program based on the data template Responsibility: System Administrator Navigation: Concurrent > Program > Define Enter the following:  The Concurrent Program name – use a naming convention for your custom programs  Designate "XDODTEXE" as the executable for your concurrent program. This is the XML Publisher Java concurrent program that will execute your data template.  The Short Name that you assign to the program must match the Data Definition Code that you assigned to the data template in the Template Manager. The XML How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 17
    • Publisher executable uses the short name of the program to locate the corresponding data template in the Template Manager.  You can optionally set the Executable Options for the Java heap size during execution. This may be necessary for generating reports with large outputs. For example –Xmx1024m sets it to 1GB.  Select XML as the output format Tip: to convert an existing Oracle standard report to an XML Publisher report, use the Copy to button to create a copy of the existing report, you need to change the Program Name and the Short Name How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 18
    • More information on how to call the data template from a Concurrent Program can be found in XML Publisher - Administration and Developer's Guide http://download- west.oracle.com/docs/cd/B40089_02/current/acrobat/120xdoig.pdf Enter Parameters Click on the Parameters button to create the parameters. Enter the parameters details; note that the Token should match the Parameter name in the data template. Add the report to the Report’s request group Assign the concurrent program to an appropriate Request Group for your users to run. When your user submits the request, the Concurrent Manager executes the XML Publisher Data Template Java concurrent program. The short name of the concurrent program is used to locate the appropriate data template in the Template Manager. Responsibility: System Administrator Navigation: Security > Responsibility > Request How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 19
    • When the data generation is complete, the Concurrent Manager's Output Post Processor applies the layout template to the generated XML. Register the Report as a Data Definition in the Template Manager Responsibility: XML Publisher Administrator Function: Home > Data Definitions Button: Create data definition Enter the following information  The name of your definition  Enter the code - use the Concurrent Program short name as the code  Select the application code - and use the same application code as defined in the concurrent program. Creating the data definition maps the data with the template layout. You can have many layouts mapped to one data definition. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 20
    • Click on the apply button to confirm the details Attach the data template file to the Template Manager You can add the following to complete your Data Definition:  XML Schema is used for pdf templates  Attach your data template XML file – required if your report data query is in the data template xml file. Your report query may be in an Oracle Report (rdf) file or a PL/SQL stored procedure  Attach a sample XML output file if you want the user to preview the report before they run it. This could be useful if you have defined multiple templates for the data definition How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 21
    • Run the Report to extract the XML File Menu: View > Requests Save the output file as an xml file How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 22
    • Design Template The Technical Consultant or Report Designer uses the XML file to design the rtf template. Mark-up tags are added to the document to prepare it for merging with the XML data. XML Publisher recognizes the formatting features and converts them to XSL-FO. The template is designed in a word processing tool such as MS Word. More information on how to create the layouts can be found in XML Publisher – Report Designer’s Guide http://download- west.oracle.com/docs/cd/B40089_02/current/acrobat/120xdorg.pdf How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 23
    • Register the template in the Template Manager Responsibility: XML Publisher Administrator Function: Home > Templates Button: Create Template Assign the template to the Data Definition code of the report Enter the following additional details  The name of the report  The application  The code  The template type  The default output type  Attach the template file  Select the language  Use the Translatable checkbox for XLIFF Files How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 24
    • Run the report Menu: View > Requests Select the options button to confirm the layout required How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 25
    • The output How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 26
    • ENVIRONMENT SETUP The following set up is required for the XML Publisher solution in Oracle EBS R12 Profile Options Set the following Concurrent Profile options Responsibility: System Administrator Navigation: Profile > System Search for the Concurrent: %OPP%Timeout Concurrent: OPP Process Timeout - This profile option specifies the amount of time the OPP manager waits for the OPP to actually process the request. Concurrent: OPP Response Timeout - This profile option specifies the amount of time an OPP manager waits for the OPP to respond to its request for post processing. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 27
    • Runtime properties Set the runtime properties Responsibility: XML Publisher Administrator Function: Home > Administration > Configuration > General > Temporary Directory Enter the directory path for the temporary directory used by the FO Processor when processing large files. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 28
    • This is required to avoid "Out of Memory" errors. Tip: The Database Administrator should create a cron job that will delete these files on a regular basis. Once the output is created, the files stored in this directory are no longer required. FO Processing and RTF Template Properties Responsibility: XML Publisher Administrator Function: Home > Administration > Configuration > FO Processing Use XML Publisher's XSLT processor - Controls XML Publisher's parser usage. If set to True, XSLT will be parsed. Enable scalable feature of XSLT processor - Controls the scalable feature of the XDO parser. The property "Use XML Publisher's XSLT processor" must be set to "True" for this property to be effective. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 29
    • Enable XSLT runtime optimization - When set to "True", the overall performance of the FO processor is increased and the size of the temporary FO files generated in the temp directory is significantly decreased. To further enhance performance when you set this property to True, it is recommended that you set the property Extract attribute sets to "False". See RTF Template Properties below RTF Template Properties Extract attribute sets - The RTF processor will automatically extract attribute sets within the generated XSL-FO. The extracted sets are placed in an extra FO block, which can be referenced. This improves processing performance and reduces file size. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 30
    • POSSIBLE DEVELOPMENT ISSUES The issues mainly fall within the following categories  Environment issues – issues with setting up the environment  Coding issues – the concurrent program does not complete successfully  Output Post Processor (OPP) issues - the OPP does not complete successfully To resolve an issue view the log from the concurrent program Check the Log file details From the view requests window, select the View Log button. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 31
    • +---------------------------------------------------------------------------+ General Ledger: Version : 12.0.0 Copyright (c) 1979, 1999, Oracle Corporation. All rights reserved. ACME_GLXRLSEG_XML module: ACME Chart of Accounts - Segment Values Listing (XML) +---------------------------------------------------------------------------+ Current system time is 18-NOV-2009 12:27:18 +---------------------------------------------------------------------------+ XDO Data Engine Version No: 5.6.3 Resp: 50553 Org ID : 204 Request ID: 5871013 All Parameters: P_STRUCT_NUM=101:P_SEGMENT_NAME=Account:DebugFlag=N Data Template Code: ACME_GLXRLSEG_XML Data Template Application Short Name: SQLGL Debug Flag: N {P_SEGMENT_NAME=Account, P_STRUCT_NUM=101} Calling XDO Data Engine... +---------------------------------------------------------------------------+ How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 32
    • Start of log messages from FND_FILE +---------------------------------------------------------------------------+ +---------------------------------------------------------------------------+ End of log messages from FND_FILE +---------------------------------------------------------------------------+ +---------------------------------------------------------------------------+ Executing request completion options... +------------- 1) PUBLISH -------------+ Beginning post-processing of request 5871013 on node R1211 at 18-NOV-2009 12:27:23. Post-processing of request 5871013 completed at 18-NOV-2009 12:27:28. +--------------------------------------+ +------------- 2) PRINT -------------+ Printing output file. Request ID : 5871013 Number of copies : 0 Printer : noprint +--------------------------------------+ Finished executing request completion options. +---------------------------------------------------------------------------+ How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 33
    • Concurrent request completed successfully Current system time is 18-NOV-2009 12:27:29 +---------------------------------------------------------------------------+ Information about the report including  Report object  Time of execution  The report parameters  The code executed Other details include  The OPP publishing details - Start and end time of the OPP  Output print options  Completion time of the request Environment Issues Errors in the log file will provide a clue to the details of the issue. A common issue is the size of the temp space allocated to XML Publisher How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 34
    • Issue: java.sql.SQLException: ORA-01652: unable to extend temp segment by 128 in tablespace TEMP Solution: The DBA needs to increase the temp space. Check that the cron job required to delete the temp space is working. See the section on Environment Setup to see how to setup the temp space. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 35
    • Coding Issues Most completed in error issues are coding issues and should have been detected during development and testing. The log below shows an example of a common issue (java.sql.SQLSyntaxErrorException) that result in Completed Error status. +---------------------------------------------------------------------------+ General Ledger: Version : 12.0.0 Copyright (c) 1979, 1999, Oracle Corporation. All rights reserved. ACME_GLXRLSEG_XML module: ACME Chart of Accounts - Segment Values Listing (XML) +---------------------------------------------------------------------------+ How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 36
    • Current system time is 19-NOV-2009 00:40:23 +---------------------------------------------------------------------------+ XDO Data Engine Version No: 5.6.3 Resp: 50553 Org ID : 204 Request ID: 5871646 All Parameters: P_STRUCT_NUM=101:P_SEGMENT_NAME=Account:DebugFlag=N Data Template Code: ACME_GLXRLSEG_XML Data Template Application Short Name: SQLGL Debug Flag: N {P_SEGMENT_NAME=Account, P_STRUCT_NUM=101} Calling XDO Data Engine... --SQLException java.sql.SQLSyntaxErrorException: ORA-00904: "AD"."FLEX_VALUE_SET_ID": invalid identifier at oracle.jdbc.driver.SQLStateMapping.newSQLException(SQLStateMapping.java:91) at oracle.jdbc.driver.DatabaseError.newSQLException(DatabaseError.java:133) at oracle.jdbc.driver.DatabaseError.throwSqlException(DatabaseError.java:206) at oracle.jdbc.driver.T4CTTIoer.processError(T4CTTIoer.java:455) How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 37
    • at oracle.jdbc.driver.T4CTTIoer.processError(T4CTTIoer.java:413) at oracle.jdbc.driver.T4C8Oall.receive(T4C8Oall.java:1034) at oracle.jdbc.driver.T4CPreparedStatement.doOall8(T4CPreparedStatement.java:194) … at oracle.apps.xdo.dataengine.DataProcessor.processData(DataProcessor.java:355) at oracle.apps.xdo.oa.util.DataTemplate.processData(DataTemplate.java:334) at oracle.apps.xdo.oa.cp.JCP4XDODataEngine.runProgram(JCP4XDODataEngine.java:29 4) at oracle.apps.fnd.cp.request.Run.main(Run.java:157) +---------------------------------------------------------------------------+ Start of log messages from FND_FILE +---------------------------------------------------------------------------+ +---------------------------------------------------------------------------+ End of log messages from FND_FILE +---------------------------------------------------------------------------+ +---------------------------------------------------------------------------+ Executing request completion options... +------------- 1) PUBLISH -------------+ How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 38
    • Beginning post-processing of request 5871646 on node R1211 at 19-NOV-2009 00:40:29. Post-processing of request 5871646 failed at 19-NOV-2009 00:40:29 with the error message: One or more post-processing actions failed. Consult the OPP service log for details. +--------------------------------------+ Finished executing request completion options. +---------------------------------------------------------------------------+ Concurrent request completed Current system time is 19-NOV-2009 00:40:29 +---------------------------------------------------------------------------+ Solution Refer to the development support team In the above example there was an invalid identifier in the where clause. where vi.flex_value_set_id = :PVSETID and vit.flex_value_id = vi.flex_value_id + 0 and vit.language = userenv ('LANG') and ad.flex_value_set_id = :VSETID and vd.parent_flex_value_low = vi.flex_value How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 39
    • and vd.enabled_flag = l1.lookup_code and vdt.flex_value_id = vd.flex_value_id + 0 and vdt.language = userenv('LANG') and l1.lookup_type = 'YES/NO' Output Post Processor (OPP) Issues Concurrent Requests complete with warning After running the concurrent program, it could complete with a warning status. This is most likely caused by an OPP error. For example the OPP is not running or does not pick up the request. Solutions:  Verify that the Output Post Processor is enabled and active.  If confirmed, retrieve the OPP log file. How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 40
    • Viewing the OPP log files Responsibility: System Administrator Navigation: Concurrent > Manager > Administer 1. Select the Output Post Processor 2. Click on the Processes button 3. Select the Concurrent Process that was active during the time that the request ran 4. Click on the Manager Log button to open the Output Post Processor log file How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 41
    • Template code: ACME_GLXRLSEG_XML Template app: SQLGL Language: en Territory: 00 Output type: EXCEL [11/19/09 12:20:14 AM] [UNEXPECTED] [2044255:RT5871612] java.lang.reflect.InvocationTargetException at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) ... 17 more The log file can also be retrieved via the Oracle Application Manager. The Error Log should be passed on to the developer or the DBA, depending on the type of issue. The Output Post Processor is running but has not picked up the request By default a timeout will occur if it takes longer than 120 seconds (2 min.) for the Output Post Processor to pick up the request from the Concurrent Manager process. In that case, the Concurrent Request will complete with status Warning and the Request log file will contain error message like below. ... +————- 1) PUBLISH ————-+ How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 42
    • The Output Post-processor is running but has not picked up this request. No further attempts will be made to post-process this request, and the request will be marked with Warning status. Setting the profile option Concurrent: OPP Response Timeout to a higher value may be necessary. +————————————–+ … Solutions:  Increase the value (in seconds) for the profile option ‘Concurrent:OPP Response Timeout‘. The concurrent manager has timed out waiting for the Output Post-processor to finish this request The concurrent manager process has successfully invoked the OPP but it a timeout is encountered as the OPP takes too long to complete the job. … +————- 1) PUBLISH ————-+ The concurrent manager has timed out waiting for the Output Post-processor to finish this request. Check that there are enough Output Post-processor service processes running. More information may be found in the service process logfile. +————————————–+ … The time that this takes will depends on various elements such as: How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 43
    •  Size of the XML Data File  Complexity of the template  Performance of the server By default a timeout will occur if it takes longer then 300 seconds (5 min.) for the XML Publisher engine to generate the output file. The Concurrent Request will complete with status Warning and the Request log file will contain error message like above. Solutions:  Increase the value (in seconds) for the profile option ‘Concurrent: OPP Process Timeout’.  Increase the Java heap size for the report  Setting the profile option Concurrent: OPP Response Timeout to a higher value may be necessary. Set it to little higher value...  Set the temp dir for XMLP  Enable the scalability of the XSLT processor Properties > FO Processing > Use XML Publisher’s XSLT processor / Enable scalable feature of XSLT processor = true. See the section on environment setup on how to perform the above. Setting the above should resolve the issue. If Error persists - Check the OPP log file for more information How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 44
    • IN A NUTSHELL XML Publisher is an innovative way of designing, developing and delivering a reporting solution to meet the end users needs. It aims at reducing the complexity of the development process, with a view of reducing the overall cost of development, upgrade and maintenance. With E-Business Suite Fusion based applications around the corner XML (BI) Publisher is here to stay! How to Guide Series: Developing Oracle BI (XML) Publisher Reports in Oracle E-Business Suite R12 © 2009 Page 45