Best Implementation Practices With Oracle Business Intelligence Publisher
Best Implementation Practices With Oracle Business Intelligence Publisher
2
About The Presenter: Mohan Dutt
3
Agenda
4
Typical Scenario: Multiple Reporting Environments
• Multiple
Reporting
Solutions Invoices Checks
Delivery Reports
Payment
Server
Server
Destinations
EFT/EDI
5
Business Intelligence Publisher – Single Solution
• Use BI Publisher
For:
– Authoring
Checks
– Managing Invoices
– Delivering
• Meet Business
Labels Reports
Requirements
• Remove Complexity
• Reduce TCO
Destinations XML / EFT / EDI
6
Business Intelligence Publisher
7
Business Intelligence Publisher Overview
EFT e-Commerce
Web Services
8
Best Implementation Practice
9
Get to the Latest Version of BIP for EBS
10
Get to the Latest Version of BIP for EBS
Running 11i -> MOS 422508.1 – About Oracle XMLP Release 5.6.3
Running R12 -> Congrats, you already have 5.6.3!
11
Get to the Latest Version of BIP for EBS
Patch 5.6.3!
12
BI Publisher Releases
• Release 11.5.10
– XML Publisher 5.0
• Post Release 11.5.10
– XML Publisher 5.5
Performance, Translation, Template Builder,
Common Regions
– XML Publisher 5.6
Administration UI, Data Engine, Book Binder
• Release 12
– BI Publisher 5.6.3
Runtime Optimization, Enhancements
13
Best Implementation Practice
14
Know Oracle’s Published Best Practices
http://www.oracle.com/technetwork/middleware/bi-publisher/overview/index.html
15
Know Oracle’s Published Best Practices
• Covers:
– Large data set strategies
– XML structures
– Lots of great template tips for performance, consistency, formatting.
16
Best Implementation Practice
17
Utilize the Correct Tools
• BI Publisher Desktop
Latest version is 10.1.3.4.1
Use the version built with the same libraries as 5.6.3 -> 10.1.3.2
Patch 5887917
• BI Publisher Toolbox
http://bipublisher.blogspot.com/
Bursting Designer
Delivery Designer
Report Conversion
18
Best Implementation Practice
19
Know what BIP is Capable of Within Different Applications
• Advanced Collections
• Payables
• Purchasing
20
Best Implementation Practice
21
Understand Your Delivery Options
22
Delivery Options – Bursting Control Files
Fax
Printer
23
Delivery Options – 12.1 RUP3
24
Delivery Options 12.1 RUP3
25
Delivery Options – Individual Apps
26
Delivery Options – Java APIs
• Java based APIs available to deliver via:
Fax
Email
Print
FTP
WebDAV
HTTP
• Requirements:
– Java Developer
– Document to deliver
– Recipient information
27
Delivery Options - Functionality
• Email
– Utilizes standard SMTP protocol
– Set To, CC, BCC, Subject, Attachment Name, Email Message Body, From
information.
– 1 Attachment (the BIP data file)
• Fax
– Utilizes IPP to communicate with 3rd party software/hardware to transmit data.
– Set Fax Number only
• Print
– Utilizes IPP/CUPS to communicate with Printers
– Ensure that printers can handle output data or ‘filter’ first.
28
Delivery Options - Status
29
Best Implementation Practice
30
Understand How to Troubleshoot
31
Best Implementation Practice
32
Know When/How/Where to Ask For Help!
33
Help! - Documentation
• Documentation!
34
Help! - Debugging
• Turn on debugging
• Review the logs
35
Help! Oracle Forums
http://forums.oracle.com/forums/forum.jspa?forumID=245
36
Help! – Oracle Community
Forums
Community Contributed Resource Documents
examples: Troubleshooting Oracle XML Publisher
How To Install a Font Using XMLP Admin
37
Help! – My Oracle Support
Open an official SR
38
Best Practices
• Get to the Latest Version of BIP for EBS
• Know When To Ask For Help and How and Where to Ask For it
39
Implementation Case Study
40
Prepare Environment
41
Step 1: Convert the RDF report into XML format
• Convert the RDF Report into XML format using rwconverter utility
• This utility is available with Report 9i or later
XX_TRX_PRINT.xml
XX_TRX_PRINT.RD
F
42
Step 2: Create RTF Template
RTF generated by
RTFTemplateGenerator
43
Create RTF Template – Template Builder
• Template Validation
44
Create RTF Template
45
Create RTF Template
46
Create RTF Template
• Insert Table –
– Insert Menu ->
Table / Form ->
Select Wizard option.
47
Create RTF Template
• Loop –
– <?for-each:G_LINE?>
loop through all lines
• Conditional Formatting
– display lines with
LINE_TYPE=‘LINE’
– RDF Format Trigger
logic can be
implemented like this
48
Create RTF Template
• Preview output
RTF Template
Preview PDF
49
Step 3: Create Data Template
• DataTemplateGenerator creates:
– Data Template (XX_TRX_PRINT_template.xml)
– PLS files for Report PLSQL code:
PL/SQL package specification (XX_TRX_PRINTS.pls)
PL/SQL package body (XX_TRX_PRINTB.pls)
50
Create Data Template
– Event triggers
– Flexfield support
– Data Structure
51
Create Data Template
52
Step 4: Execute PLSQL code generated
53
Step 5: Register new Concurrent Program
• Set the concurrent program output format to XML.
• Attach executable XDODTEXE to the concurrent program
54
Step 6: Register Data Definition
55
Register Data Definition
56
Step 7: Register Layout Template
57
Step 8: Create Bursting Control File
• Bursting Engine
Features
– Burst individual EDI
Control HTML
documents from a Batch
File
Data
batch
PDF
– Dynamic generation XML
Publisher
based on data
PDF
– Deliver in desired layout XML
and output format
– Deliver down desired
Templates
delivery channel
– Integrated into
concurrent processing
58
Create Bursting Control File
• Accepts a data
stream and splits it
based on multiple
criteria
• Generates output
based on a template
• Delivers the
individual
documents through
the delivery channel
of choice (Email,
Fax, Printer, File
system, FTP)
59
Step 9: Upload Bursting Control File to Data Definition
60
Step 10: Program Call to Bursting Engine
• Add code in After Report trigger to call Bursting Engine for delivery of reports
• This submits ‘XML Publisher Report Bursting Program’ program which splits current program’s XML output, generates
documents and delivers them to destination mentioned in Bursting Control File
61
BI Publisher Setup Summary
Automated process
62
BI Publisher Setup Summary
63
BI Publisher User Steps
64
BI Publisher User Steps
65
BI Publisher User Steps
66
BI Publisher User Steps
67
CTC Implementation
Invoice Print Programs
69
Invoice Print Program Changes
70
Setup Changes
71
Setup Changes
72
VeriSign Bursting Engine
Status Report
In case of failure, can deliver notification to email address setup in
XXVS_BURSTING_CONTROL_FILES valueset
Error Notification
73
Printer Issues
• PDF files generated from BI Publisher do not print on some printers
– raw PDF files generated by BI Publisher are not supported by some printers
– Metalink Note - 338990.1 explains how third party software can be used to convert
PDF files into PS format before sending them to printers.
– Create Filter for PDFTOPS utitlity in xdodelivery.cfg file and place it under
$XDO_TOP/resource directory
74
Printer Issues
• CUPS Issues
– Connection Timeout:
Log file shows “oracle.apps.xdo.delivery.DeliveryException: Connection
timed out while waiting response from server”.
Change CUPS configuration - /etc/cups/cupsd.conf
- Increase the value of
• MaxClients (controls the maximum number of simultaneous clients
that will be handled ) and
• TimeOut (timeout before requests time out)
– Connection Reset:
Log file shows “java.net.SocketException: Connection reset at
java.net.SocketOutputStream.socketWrite”
CUPS log file shows message
E [25/May/2009:03:18:01 -0700] ReadClient() 8 IPP Read Error!
Verify CUPS setup
Upgrade it to latest CUPS version
75
Printer Issues
- Step 2 : Use PDFDocMerger API to merge PDF files in single PDF file.
- Step 3 : If the printer supports PDF format, send merged PDF file to
Printer. Else convert the PDF file into PS/ PCL format before sending to
printer.
76
RTR Implementation
11i Environment Setup
• Patches Applied
– Patch #: 5713082 – The FSG patch has been applied to make the SRS
program "Program - Publish FSG Report" compatible with XML Publisher
versions 4.5, 5.0, 5.5, 5.6.0, 5.6.1, 5.6.3
– Patch#: 6332655 - This patch delivers Full Scale FSG functionality for Release
11i customers. Following are the few fixes delivered in the patch.
correct report ordering for Multiple Report Sets
correct processing for Spreadsheet/TabDelimited with Display Set
correct print styles for reprint
78
RTR – Development/Migration Procedure
79
RTR – Development/Migration Procedure (Continued…)
80
RTR – Development/Migration Procedure (Continued…)
Continued…
81
RTR – Development/Migration Procedure (Continued…)
Continued…
82
RTR – Development/Migration Procedure (Continued…)
83
RTR – Development/Migration Procedure (Continued…)
84
RTR – Development/Migration Procedure (Continued…)
XMLPTemplatesByE
xample.doc
85
Troubleshooting Oracle XML Publisher For The Oracle E-Business
Suite
In such cases the request log file shows a generic error message indicating
the the post-processing action has failed:
Continued…
86
Troubleshooting Oracle XML Publisher For The Oracle E-Business
Suite (Continued…)
The actual error returned by the XML Publisher Core engine is captured in
the OPP log file. Following are the steps to open the OPP log file:
- Login to the application
- Responsibility: System Administrator
- Function: Concurrent --> Manager --> Administer
- Select the Output Post Processor
- Click on the Processes button
- Select the Concurrent Process which was active during the time that
the request ran
- Click on the Manager Log button to open the Output Post Processor log
file
Continued…
87
Troubleshooting Oracle XML Publisher For The Oracle E-Business
Suite (Continued…)
Continued…
88
Troubleshooting Oracle XML Publisher For The Oracle E-Business
Suite (Continued…)
• Search for the Request ID in the OPP Log for the actual error
message. The error message shows that the XML file generated
had some special characters due to which the program has failed.
89
Troubleshooting Oracle XML Publisher For The Oracle E-Business
Suite (Continued…)
• In case of the following error message in the Concurrent Program Log file
follow the steps below to fix the issue.
Continued…
Note: If the issue is not fixed even after restarting the process
then the Concurent Manager needs to be bounced.
90
Troubleshooting Oracle XML Publisher For The Oracle E-Business
Suite (Continued…)
91
PTP Implementation
PTP XML Conversions
• Scope
– Purchasing Objects
– Payables Objects
– Reporting Objects
• Timeline
– Initiative Began in Summer of 2009
– Purchasing Objects Converted before 2009 Year End
– Payables Objects Converted in 2010
ACH Remittance
Check Printing
– Reporting Objects Converted on an Ad Hoc Basis
93
Purchasing Objects Conversion
• Scope
– PO PDF Document
– PO Email Capability
• Benefits
– Automated Attachments Inclusion
PO Header Level Attachments Automatically Included in PO Email
Attachments from Most Recently Updated PO Line Automatically Included in PO
Email
– Email Body Configuration
PO Email Body Fully Configurable via FND Message
– Automated PO Attachment of PO PDF
Seeded “View Document” Function Now Utilized to See PO PDF
– Font Color Now Allowed
– Optio Technology No Longer Needed
• Development Issues
– Multiple Patches Required to be Applied
– Attachments Inclusion Initially Picked Up Non-Related Attachments
Attachment ID Match Across Attachments Type
94
Payables Objects Conversion – ACH Remittances
• Scope
– ACH Remittance PDF
• Benefits
– Error Reporting
ACH Remittance Program Now Produces PDF Output File with
Failed Records and Detail
- Prior Process Required AP Review Rejected Emails to
Shared Public Folder
– Single Reprocess Capability
AP Now Has the Ability to Send Individual ACH Remittances
Based on Error Report and Reprocess Needs
– Optio Technology No Longer Needed
• Development Issues
– Initial ACH Remittance Error Report Had Insufficient Detail
95
Payables Objects Conversion – Checks
• Scope
– AP Physical Checks
• Benefits
– Ability to Save PDF File of All Checks Printed
– Check Font Stored on the Server
No Longer Required to Ask MIS OPS to Resend Check Font to Local Printers Upon Printer Reboot
– Ability to Print Anywhere
PDF File is Saved Locally and Printed
– Optio Technology No Longer Needed
• Development Issues
– DEV Team Does Not Have Access to Physical Printers
Output Differs Across Printers
– DEV Team Does Not Have Actual Check Paper
– Wrapping Lines in the Check Caused Check Layout to Shift
– Font Issues
– Number of Invoices Continuing on Multiple Pages
Only One Actual Check Can Output
96
Reporting Objects Conversion
• Scope
– Existing Oracle Reports Converted as Requested
No Overall Initiative Yet Begun to Review the Set of Reports
– Completed
Suppliers Report
– In Process
Posted Invoice Register
• Benefits
– Increased Configuration Capabilities via XML Publisher Administrator
– Report File Type Output Options to the Requestor
• Development Issues
– Layout Challenge from Existing Presentation
Not Always a Straight Forward Mirror Conversion Option
– Oracle Patch Still Required for Proper XML Report Request Default
File Type Output Option
97
Check Printing: Additional XML Setups
98
R12 BI Publisher Features
• Data Extraction Engine
• Bursting Engine
• Consolidated Document Publishing
• Template Enhancements
– RTF Templates
– Template Builder
• Delivery Manager
• Template Manager
– Translation Manager
– Configuration Manager
– Font Manager
• Integration
– OA Framework Report Viewer
– Single Step Reporting
• Performance
– Reduced processing time, memory footprint and temporary file space
99
BI Publisher Benefits
100
BI Publisher Benefits
• Improve performance
101
Business Intelligence Publisher Blogs
• Tim Dexter/BIP Official Blog: http://blogs.oracle.com/xmlpublisher
102
Contact Information:
Brent Lowe
STR Software
[email protected]
www.thelowedownblog.com
www.strsoftware.com
103
Contact Information:
Mohan Dutt
VeriSign Inc
[email protected]
www.ebizocp.blogspot.com
104
Thanks to Oracle Mix Voters
105
Q&A