November 23, 2011 Leave a comment
By Andrew Archibald, Senior Consultant Rocela
As a curious technologist, I have recently revisited the functionality of emailing documents from Oracle E-Business to multiple recipients; a functionality called ‘bursting’ in Oracle E-Business language. I have used BI Publisher to ‘burst’ PDF’s out of Oracle E-Business R12 and save them to the server ready for printing – a relatively simple process using the web services available with BI Publisher.
However, when using Oracle E-Business R11 and XML Publisher, this method is not as straightforward and requires additional coding. Happily, there is a great deal of solid reference material out there for this (both Oracle documents and blog postings) which details the steps required for ‘bursting’ in XML Publisher.
One of the best features of XML Publisher is the ease in which you can link to Oracle E-Business Suite – if you set the code of the concurrent request to the same name as the XML Publisher data definition template, they automatically link together. My colleague Kenny Miller mentioned this in his recent post.
For now, I’m going to consider some of the “gotcha’s” when implementing ‘bursting’ functionality.
Building your RTF document, beware!
Oracle BI Publisher desktop is a great tool and makes it easy to create templates. The plug-in allows you to import demo XML and then create groupings, tables and fields on templates, but there are a couple of things that you need to watch out for.
Firstly, when you insert a new field into the template, BI Publisher creates a Word field and then attaches the BI Publisher options. The problem this can cause is around the values within the ‘advanced’ properties (right click on the field and select ‘BI Publisher’). These must match up with Word’s ‘help’ properties for that item. If they are different then the document will fail when BI Publisher tries to merge the XML and the template.
Secondly, if you are looking to ‘burst’ this document and also to store all the output as one document, you need to create a grouping which will encase your template and fields (don’t worry about headers and footers on the RTF document).
Be aware if you have a grouping on a lower set of data within your document; for example you have your invoice header details then displaying the invoice lines, the outer grouping may have an effect on the whole document. Always remember my first point about Word’s ‘help’ properties; these are easily reset by Word which will break your document. So, always check them before uploading to BI Publisher!
Building your ‘bursting’ file
Best tip is to start small, only build small components and start with small amounts of data. Don’t think that because the individual file generation works, that it will also work when it’s called a ‘bursting event’.
The log files are stored in the following places to help diagnose the issue. Log files are located in comn/util/java/jdk1.6.0_22/jre/lib for any BI Publisher logs.
The ‘bursting’ file takes an XML path as a parameter (tag <xapi:request select) which is used to split the data in the XML file output from the concurrent request and generate separate documents.
Ensure that the XML in the ‘bursting’ file is consistent with the structure of the output from the concurrent request. To view what is generated by Oracle E-Business, run the concurrent request to output the data as XML. If the XML path is incorrect you will notice that your document will only show the first record in your XML output.
These are just some of the features which you should watch out for and hopefully this will save you a few headaches! Just one more potential headache before you ‘burst’: it’s worth remembering that BI Publisher is a separately licensed Oracle product and although a restricted use license is included with Oracle E-Business Suite, it only allows certain restrictive usage of the product. One of my License Optimisation colleagues will write a blog about BI Publisher licensing soon. In the meantime, assuming you are licensed correctly, happy ‘bursting’!