How to find information on BI Publisher (formerly XML Publisher)

© 2010 Oracle Corporation – Proprietary and Confidential

The following is intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decision. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle.

Safe Harbor Statement

<Insert Picture Here>

Troubleshooting XML Publisher in EBSKevin McDermott Pieter BreugelmansPrincipal Support Engineer Principal Support Engineer


AgendaTroubleshooting XML Publisher in EBS

• Introduction - Process Flows• Data gathering:

– Determine the installed XML Publisher version– Gather log / debug files for different scenarios

• Single step publishing method: OPP log file• Two step publishing method: XML Report Publisher request log• All other delivery channels: XML Publisher Core Engine debug

• Valuable Self-Service Resources• Test case requirements for Global Customer Support

– Template file (RTF, PDF, eText, XSL-FO, …)– XML Data file– Log / debug files

• References

Introduction - Process FlowsThere are three basic process flows:1. Two Step Publishing

1. Run a program with output format set to XML: generates the XML data file.

2. Submit the XML Report Publisher job, selecting the output from step 1 and layout template: generates the XML Publisher output (PDF, RTF,…).

2. One Step Publishing:– Update the concurrent program by setting the output format to XML. A

layout template is selected when submitting the job. The Output Post Processor will take the XML data generated and merges it with the selected layout template.The result of this is an XML Publisher output (PDF, RTF,…).

3. All Others:– Processes that do not use concurrent managers: web or forms based

where the XML Publisher Java APIs are called directly, eg. Pick Slip, Dunning Letters, Blanket Agreement (Preview and Print)

– XML Publisher Report Bursting Program (XDOBURSTRPT)








• References

How to Determine the Version of XML Publisher• Note 362496.1 How to Determine the Version of XML Publisher

– Based upon an output file generated by XML Publisher– Based upon the applied patches– Based upon the file version of MetaInfo.class

• Example: based upon an output file:– Responsibility : XML Publisher Administrator – Navigation Path

Tab : Templatesselect a Templatechoose Preview

save the PDF file to your desktop– Open the PDF file in Adobe Acrobat

Navigation Pathmenu FileDocument PropertiesDescription: PDF Producer XML Publisher x.x.x.

Version info via Adobe Reader

Version based upon Patch History• Oracle E-Business Suite 11i:

– Run a query on the Patch History table

• Oracle E-Business Suite Release 12.0 and 12.1– XML Publisher 5.6.3 is directly included in these releases.

• Additional patches for Oracle XML Publisher– Note 1138602.1 Overview of Available Patches for Oracle XML Publisher

(embedded in Oracle E-Business Suite)

SELECT DECODE (bug_number, '3554613', '4.5.0', '3263588', 'XDO.H', '3822219', '5.0.0', '4236958', '5.0.1', '4206181', '5.5.0', '4561451', '5.6.0', '4905678', '5.6.1', '5097966', '5.6.2', '5472959', '5.6.3') PATCH, bug_number

FROM ad_bugsWHERE bug_number IN

('3554613', '3263588', '3822219', '4236958', '4206181', '4561451', '4905678', '5097966', '5472959');








• References

Output Post Processor (OPP) log file• Single step publishing method:

– Template specified when submitting the Request– Request ends with Phase ‘Completed’ and Status ‘Warning’

• Why the need for the OPP log file?– Request log shows generic error message indicating that OPP failed:

– The real error returned by XML Publisher is stored in the OPP log file.

How to obtain the OPP log file• Two possible ways to obtain the OPP log file:

1. Oracle Applications2. Directly from the file system

1. Via Oracle Applications– Responsibility: System Administrator– Navigation Path

Responsibility : System AdministratorConcurrent

ManagerAdministration

select the Output Post Processorclick on the Processes button

select the process that was active when the request ranclick on the Manager Log button to open the OPP log file

How to obtain the OPP log file (2)

11

22

33

44

How to obtain the OPP log file (3)

How to obtain the OPP log file (4)2. Directly from the file system

1. Identify the OPP log filename:

2. The &&request_id is the Request ID of the request which ran in error.3. Sample output:

SELECT fcpp.concurrent_request_id req_id, fcp.node_name, fcp.logfile_nameFROM fnd_conc_pp_actions fcpp, fnd_concurrent_processes fcp

WHERE fcpp.processor_id = fcp.concurrent_process_idAND fcpp.action_type = 6AND fcpp.concurrent_request_id = &&request_id

Statement level logging for OPP• OPP is part of Concurrent Processing created by ATG/CP development

= implementation of the XML Publisher (XDO) APIs• OPP Statement level logging may be requested by development• Writes detailed information in the OPP log file• In general not required for troubleshooting• How to enable statement level logging? Oracle Application Manager

– Responsibility: System Administration– Navigation Path:

Concurrent Managersclick on Output Post ProcessorSelect Service Instance and ... select Statementclick on the Set Log Level button

restart the Concurrent Managersrerun the Request

• XML Publisher engine debug can be enabled to create additional log files

Statement level logging for OPP (2)

Log Level :STATEMENT

Log Level :EXCEPTION








• References

How to debug XML Report Publisher• Two step publishing method

– Run the concurrent program to obtain the XML output– Run the XML Report Publisher request which ends with Phase

‘Completed’ and Status ‘Error’– The error returned from the XML Publisher Engine will be captured in the

XML Report Publisher request log

• How to run the XML Report Publisher in debug mode:– Responsibility : System Administrator– Concurrent

ProgramDefine

Query the XML Report Publisher programClick on Parameters

Select the Debug Flag parameterChange the Default Value from N to Y

Rerun the XML Report Publisher program to capturethe complete error

How to debug XML Report Publisher (2)

How to debug XML Report Publisher (3)








• References

Debug the XML Publisher Core Engine• Direct Report Publishing from Forms or Web application• Examples:

– Preview functionality in the Template Manager– Generate PDF document from a Purchase Order

Debug the XML Publisher Core Engine (2)• Captures the most detailed debug information• Applicable to all processes that involve XML Publisher• Prefered method for Bursting processes (XDOBURSTRPT)• Captures all possible temporary files• In some cases the only available method to obtain the XML

data file (eg. direct report publishing in PO)

How to debug the XML Publisher Core Engine• How to run the XML Publisher Core Engine in debug mode:

1. Connect to the server as ‘applmgr’2. Run APPSORA.env to set the APPS environment (Windows: envshell.cmd)3. Create an $XDO_TOP/debug directory4. Create an $XDO_TOP/resource directory5. Create an xdodebug.cfg file containing:

LogLevel=STATEMENTLogDir=[absolute path to XDO_TOP]/debug

6. Restart the Concurrent Managers and Apache services.7. Reproduce the issue.8. Several debug files will be created under the $XDO_TOP/debug

• xdo.log : XML Publisher Engine debug log file• xdo_….xsl : XSL-FO version of the RTF Template• xdo_….xml : XML Data File• xdo_…. fo : temporary file created by the FO Engine (only RTF / XSL

templates)• xdo_…. out : Output File (may not exist in case of complete failure)

How to debug the XML Publisher Core Engine (2)• The screen shot below demonstrates the existance of the xdodebug.cfg

file and the debug files generated.








• References

Valuable Self-Service Resources• BI Publisher Community on MOS

https://communities.oracle.com/portal/server.pt/community/bi_publisher/323

• My Oracle Support Knowledge Contenthttp://support.oracle.com/

• BI Publisher Documentation on OTNhttp://www.oracle.com/technology/products/xml-publisher/xmlpdocs.html

• BI Publisher Bloghttp://blogs.oracle.com/xmlpublisher

• Oracle BI Publisher Consultinghttp://bipconsulting.blogspot.com/

• BI Publisher Forum on OTNhttp://forums.oracle.com/forums/forum.jspa?forumID=245

• What to use as keywords?



http://support.oracle.com/

http://www.oracle.com/technology/products/xml-publisher/xmlpdocs.html

http://www.oracle.com/technology/products/xml-publisher/xmlpdocs.html

http://blogs.oracle.com/xmlpublisher

http://bipconsulting.blogspot.com/

http://forums.oracle.com/forums/forum.jspa?forumID=245

Valuable Self-Service Resources (2)• Use specific keywords while searching for solutions• Examples:

– Java Exception: oracle.xdo.parser.v2.XMLParseException, java.lang.NullPointerException , etc.

– Keywords describing the failing process: Output Post Processor, OPP, XDOREPPB, etc

– MOS: Use Advanced Search Refine Search Related to the Product 'BI Publisher (formerly XML Publisher)'

Valuable Self-Service Resources (3)

My Oracle SupportAdvanced Search

Keywords & Product

Search Result:








• References

Test case requirements for Support• Layout Template file

– XML Publisher Administrator responsibility: download it via the Template Manager

– Saved under the LogDir in case the XML Report Publisher Core Engine ran in debug mode

• XML Data File– Single step publishing

Navigation Path:menu View

select Requestsquery the request that failedclick on the Diagnostics button

click on the View XML button

– Two step publishing: output file of the first request– Direct Report publishing: saved under the LogDir in case the XML

Report Publisher Engine ran in debug mode• A clear problem description:

– Does the Report run in error? (log files)– Is the layout of the output file incorrect? (generated output file)– …








• References

References• Note 364547.1 Troubleshooting Oracle XML Publisher for The Oracle

E-Business SuiteTroubleshooting instructions from this presentation

• Note 362496.1 How to Determine the Version of XML Publisher• Note 291792.1 Using the Output Post Processor (OPP) in Oracle

Applications Concurrent Processing• Note 422508.1 About Oracle XML Publisher Release 5.6.3• Note 1138602.1 Overview of Available Patches for Oracle XML

Publisher (embedded in Oracle E-Business Suite)

How to find information on BI Publisher (formerly XML Publisher)

Documents

Transcript of How to find information on BI Publisher (formerly XML Publisher)