1 © 2009 Oracle Corporation – Proprietary and Confidential
1© 2009 Oracle Corporation – Proprietary and Confidential
2© 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>
XMLP Troubleshooting Tips and Techniques
SPEAKERS : Suchi Mathur (GCS Support Engineer)
Q&A : Andrew Soff (Developer)
4© 2010 Oracle Corporation – Proprietary and Confidential
XMLP POWERFUL REPORTING TOOL
5
XML Publisher Concept
Separate data / layout / UI translation
Report
output
Flexibility
Reduced maintenance
Data Logic
Layout
Translation
XML Publisher
6© 2010 Oracle Corporation – Proprietary and Confidential
XMLP TROUBLESHOOTING TIPS
7© 2010 Oracle Corporation – Proprietary and Confidential
Objective
Help understand XMLP Troubleshooting
Techniques before contacting support.
Where to look for Information if in
Trouble?
Peoplesoft Recommendations for running
XMLP reports from Application.
8© 2010 Oracle Corporation – Proprietary and Confidential
Troubleshooting points
• Setup
• Debugging
• Performance Tuning
• Most commonly reported questions
• What’s new in PT850
9© 2010 Oracle Corporation – Proprietary and Confidential
XMLP Setup
• Settings are defined in XDO.cfg file (default location is
$PSHOME/appserver directory
• Primary uses:
• Setting a temporary directory
• Setting properties for PDF, RTF, and HTML output
• Setting PDF security properties
• Setting font locations and substitutions
• No need to restart Appserver or Process Scheduler if just
contents of xdo.cfg are changed
10© 2010 Oracle Corporation – Proprietary and Confidential
Sample XDO.cfg file.
<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">
<properties>
<!-- System level properties -->
<property name="xslt-xdoparser">true</property>
<property name="xslt-scalable">true</property>
<property name="system-cachepage-size">50</property>
<property name="system-temp-dir">CACHE</property>
<!-- PDF compression -->
<property name="pdf-compression">true</property>
<!-- PDF Security -->
<!-- <property name="pdf-security">true</property> -->
<!-- <property name="pdf-open-password">user</property> -->
<!-- <property name="pdf-permissions-password">owner</property> -->
</properties>
<!--<fonts>-->
<!--<font family="3 of 9 Barcode" style="normal" weight="normal">-->
<!--<truetype path=“PS-HOME\Fonts\3of9.ttf" />-->
<!--</font>-->
<!--</fonts>-->
</config>
11© 2010 Oracle Corporation – Proprietary and Confidential
XMLP setup(Contd..)
JavaVM Options=-Xrs -Dxdo.ConfigFile=%PS_HOME%/appserv/xdo.cfg
Screen shot of PSAPPSRV.cfg file Appserver configuration file
12© 2010 Oracle Corporation – Proprietary and Confidential
XMLP Setup (Cont’d..)
Screen shot of PSPRCS.cfg file Process scheduler configuration file
JavaVM Options=-Xrs -Dxdo.ConfigFile=%PS_HOME%/appserv/xdo.cfg
13© 2010 Oracle Corporation – Proprietary and Confidential
XDO Debugging/Logging Information
• Running XMLP reports in a Debug mode will help to narrow down the problem whether it is in the (XML data file,Template file, Application people code or in App engine program)
• XDO logging creates “XDO.log” file with detailed logging information.
• The files that are created during the XDO logging are XML, XSL, Translation(XLIFF) and Template files Ex( PDF,RTF) in the
Location = Temporary directory specified in the LogDir.
• Please refer GCS Solution on Support Portal DOC ID :821195.1
(How to run XMLP reports in Debug mode/Turn ON XMLP logging)
14© 2010 Oracle Corporation – Proprietary and Confidential
Debugging XMLP Reports
Create a file named xdodebug.cfg and place it
under [PS_HOME]\JRE\Lib] directory
• WindowsThe file should include following below information:
LogLevel=STATEMENT
LogDir=c:\temp (point to an appropriate temporary directory )
• UnixThe file should include following below information:
LogLevel=STATEMENT
LogDir=/ds3/ps/dssgrp/tmp (point to an appropriate temporary directory )
3) After Replication remove xdodebug.cfg from [PS_HOME]\JRE\Lib] directory.
15© 2010 Oracle Corporation – Proprietary and Confidential
Debugging XMLP Reports
Screen shot which Shows list of files created during the XMLP debugging
16© 2010 Oracle Corporation – Proprietary and Confidential
Running XMLP Reports from Command line
• Running XMLP Reports from the command line will help in testing the performance of large reports .
• Testing is done here by Bypassing Peoplecode ,Application engine Interface.
• Steps to run the reports using command line
1. Create a working directory (e.g. C:\psxmlp\comlinetest) 2. Copy RTF template and XML data file to this directory
Cont’d..
17© 2010 Oracle Corporation – Proprietary and Confidential
Running XMLP Reports from Command line
3) Set PS_HOME=C:\PT848
4) Set CLASSPATH as followsset CLASSPATH=%PS_HOME%\class\psxmlp.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\xdo56.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\xmlparserv2.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\peoplecode.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\aolj.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\i18nAPI_v3.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\axdoparser.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\bicmn.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\bipres.jar
set CLASSPATH=%CLASSPATH%;%PS_HOME%\class\jewt4.jarset CLASSPATH=%CLASSPATH%;%PS_HOME%\class\share.jar
Cont’d..
18© 2010 Oracle Corporation – Proprietary and Confidential
Running XMLP Reports from Command line
5) Convert RTF template to XSL format
C:\psxmlp\comlinetest > java -Xmx512m -Xms256m
com.peoplesoft.pt.xmlpublisher.PTRTFPocessor -genxsl template.rtf
6) Report Generation output values( PDF =2, RTF = 1, HTML = 3, EXCEL = 4)
C:\psxmlp\comlinetest > java -Xmx512m -Xms256m
com.peoplesoft.pt.xmlpublisher.PTFOProcessor -genoutput template.xsl
data.xml reportouput.pdf 2
Please refer GCS Solution on Support Portal DOC ID : 789151.1 (How to Run
XMLP Reports from the Command line.)
19© 2010 Oracle Corporation – Proprietary and Confidential
Running XMLP Reports from BI viewer
Navigation:
Start > AllPrograms >Programs >Oracle BI Publisher Desktop >Template Viewer
For Previewing reports for RTF,PDF,eText and XSL templates.
20
Running XMLP Reports from BI viewer
© 2010 Oracle Corporation – Proprietary and Confidential
Specify the specific output format Cont’d..
21
Running XMLP Reports from BI viewer
© 2010 Oracle Corporation – Proprietary and Confidential
Click on Start Processing to view the report
Cont’d..
22© 2009 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Setting System Temp Directory
By default, the system-temp-dir property is not set. This property
must be set to point to a temp folder on the server to achieve the
optimum performance.
<property name="system-temp-dir">C:\Temp</property>
Configuration
23© 2009 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Error:Java Exception: java.lang.OutOfMemoryError: during call
of com.peoplesoft.pt.xmlpublisher.PTRTFProcessor.generateXSL.
(2,763)
• Check JVM CLASSPATH probably other java programs are
consuming the JVM memory.
• Proper memory configuration for JVM should be specified to
balance between memory usage and performance . (e.g. JavaVM
Options=-Xmx256m –Xms128m).
Configuration
24© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
JavaVM Options= -Xrs -Dxdo.ConfigFile=%PS_HOME%/appserv/xdo.cfg –Xmx256m –Xms128m
• Java Heap Tuning on Process scheduler server configuration file
psprcs.cfg
25© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Java Heap Tuning on Application server configuration file psappsrv.cfg
Java Options=-Xrs -Xrs -Dxdo.ConfgFile=%PS_HOME%/apperv/xdo.cfg –Xmx256m –Xms128m
26© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Please refer GCS Solution on Support Portal DOC ID :962712.1
(Performance Tuning XMLP Reports)
• Please refer GCS Solution on Support Portal DOC ID :
64523.1(Reports get OutOfMemoryError and generates heapdump and javacore files )
27© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Choose the right type of Template PDF/RTF , PDF have highest implementation performance.
• Try to create brand new PDF templates .
• Do not reuse the existing PDF template as basis for creating of new one which results in retention of non-visible meta data which may cause performance issues.
• Please refer GCS Solution on Support Portal DOC ID :1059830.1 (XMLP Self Service W2’s very slow performance.)
PDF Template
28© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Complex Reports that require the RTF Template take greater care when designing the template and the data source.
• RTF Template converted to XSL format behind scene can switch to XSL template for complex templates.
• Run following command for RTF TO XSL conversion.
C:\psxmlp\comlinetest > java -Xmx512m -Xms256m com.peoplesoft.pt.xmlpublisher.PTRTFPocessor -genxsl template.rtf
RTF Template
Cont’d..
29© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• RTF Template does default sorting of data and may impact performance.
30
Choose the right type of Template PDF/RTF
FEATURE RTF PDF
Custom/dynamic output x
Existing PDF Template (government forms) x
Pixel perfect positioning (using Adobe) x
Charts x
PDF Output x x
HTML, Excel and potential other output formats x
Sub-templates x
Runtime parameters x
Translation files x
Higher performance on very large reports (hundreds of mega
bytes)x
Output Formulas x
Flexible Field-data mapping (XPath vs. simple name matching) x
31© 2010 Oracle Corporation – Proprietary and Confidential
Performance Tuning Tips
• Rowsets and XMLDoc data sources have
performance/memory limitations and are deprecated in
PT8.50.
• Query datasource performance is enhanced in PT850
since XML generation is now a C++ function rather than
Pcode.
• XML file is the preferred datasource since all
datasources behind the scene get converted to XML file.
Datasource
32© 2010 Oracle Corporation – Proprietary and Confidential
Tips for Running Large XMLP Reports
• Use XML File as Data source and PDF as template it has highest implementation performance.
• Create two batch processes, one to generate the XML file and one for processing the report.
• Pass the XML file to the Report processing process
• Include Data Generation and Report Processing process in one Process Scheduler Job.
33© 2010 Oracle Corporation – Proprietary and Confidential
Tips for Running Large XMLP Reports
• Use SQR or other mechanisms to generate the XML File as a preprocessing step.
• Design data source groupings as close as template structure to prevent unnecessary XSL transformations.
• Test the Report from Command line to rule out web and Application server limitations.
34© 2010 Oracle Corporation – Proprietary and Confidential
Peoplesoft Recommendations
• XML file as Data source
• RTF Template over PDF template
• Define Bursting fields/Search Fields
• Use Filters in Data source
• Running PSXPCLEAN App engine process
regularly to keep the Meta Data consistent.
35© 2010 Oracle Corporation – Proprietary and Confidential
Most Commonly Reported Questions
XMLP Printing• Post script level 3 driver
• Minimum Memory 128 MB RAM
• Make sure Printer running with Post script DLL’s
for ex: PSCRIPT5.DLL
Can obtain Printer configuration:
Information -> Information Pages->Configuration Printer menu
Cont’d..
36© 2010 Oracle Corporation – Proprietary and Confidential
Most Commonly Reported Questions
If XMLP printer requirement could not be met can use any
third party conversion software which convert the PDF to PS
file.
Windows: PDFTOPS
Unix: Ghostscript
If finding issue with XMLP printing please refer GCS
Solution on Support Portal (Sending XMLP output directly
to printer in Windows environment (Doc ID 652589.1)
37© 2010 Oracle Corporation – Proprietary and Confidential
Most Commonly Reported Questions
• How to create sample Data XML file and Schema File
• Psquery
• SQR
• File Layout
• Any Custom code
• Or any third party tools such as TRAN , XML_SPY
• E-XMLP: Which tools create XML schema and sample data files for
data source type of Rowset? (Doc ID 796304.1)
38© 2010 Oracle Corporation – Proprietary and Confidential
Most Commonly Reported Questions
• E-XMLP How to use bursting and multiple templates (Doc ID
662933.1)
• E-XMLP How to migrate XMLP File Definition objects(Doc ID
659919.1)
• E-XMLP: Temporary PDF files created and stored on the Application Server under %TMP%\PSFTP (Doc ID 1059830.1)
• E-XMLP How to Disable the Generation of XML PUBLISHER Trace (Doc ID 969132.1).
39© 2010 Oracle Corporation – Proprietary and Confidential
What’s New In PT8.50
40© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• XDO Properties(System,Global,Report)
• System Properties
Cont’d..
41© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• Global Properties:
Cont’d..
42© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• Report Properties:
Cont’d..
43© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• Deprecated Rowset and XmlDoc data sources
• Connected Query as Data source
• Sub reports capability in XMLP Reports
44© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
•Report Descriptive names
45© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• PDF Full Path Mapping
• Deprecated Schema Files
46© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• Emailing Reports
47© 2010 Oracle Corporation – Proprietary and Confidential
What’s New in PT8.50
• Alternate XML preview
48© 2010 Oracle Corporation – Proprietary and Confidential
For More Information
Search the online forum:
XML Publisher Documentation on OTN
PeopleBooks
XMLP Solutions on Support Portal-Reporting tools-XMLP
Links:
http://forums.oracle.com/forums/forum.jspa?forumID=245
http://blogs.oracle.com/xmlpublisher/applications/xmlp_for_peoplesoft/
BI Publisher BLOG:
http://blogs.oracle.com/xmlpublisher/
http://search.oracle.com
XML Publisher
49
50© 2010 Oracle Corporation – Proprietary and Confidential
THANK YOU