An Oracle blog about BI Publisher

  • RTF
    June 11, 2008

Template Testing

We have been working on a new project, not development but hopefully just as useful. We are putting together a set of new viewlets that will highlight and hopefully explain how to use/create template features with examples. This will be across all of our template types ... eventually. We have a big list and are working as fast as possible to get them out. We'll post them as soon as we have a reasonable amount of them ready.

One of the viewlets Jen in our Ohio office has been putting together on adding checkboxes to your output in an RTF template - adding the checkboxes is not that tough but getting them in your output can be a little tricky. We need to use the xdo.cfg file to tell the engine where the check box font will be and then which glyphs to use - I covered that here and Jen's viewlet will make things crystal clear of course.

In the course of putting the viewlet together Jen got to use the xdo.cfg file with the Template Builder for MSWord - it struck me today that I do not think we have documented or blogged where this file is?

If you check your Template Builder install you'll find the xdo.cfg file under

... Oracle\BI Publisher\BI Publisher Desktop\Template Builder for Word\config

You'll actually find the xdo example.cfg file that we ship. If you change the name we will start using it. Inside you can put your font references and properties, you'll find those listed in the user docs.

There's another file thats really useful for us and especially our support team, thats the xdodebug.cfg. If you are having problems and want some debug information or you have logged an SR support are going to want that debug info - get it up front for them and you'll be golden or at least happier because support will be able to help you much faster.

If you are testing on the template builder then you need to create the debug file as follows:

a.  Create a file called xdodebug.cfg

b.  The contents of the file should be:



this should always be set to STATEMENT to maximize the information provided in the log.

LogDir specifies where the debug files should be written to, this needs to be a writable directory for Publisher.

c.   This file should then be saved to the $JRE_TOP/lib directory - in this case JRE_TOP is going to be the 'jre' directory you are referencing in the 'Java Home' field on the Preview tab under the Tools > Options. OF course the same file can be placed on the serverside too, again, its going to sit under the JRE_TOP/lib directory. Once you have it in place run your template/report again.

You will get a bunch of files in the directory, the RTF template, the XML, the converted XSLFO template, the FO file, a log file and the final output - if things got that far. Support will want all of it. Just remember to remove the debug file when you are done - leave it and it will fill your disk!

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.