Using custom transformations in BI Publisher 10G

Out of all my posts on BI publisher, this one is my personal favorite. The article describes a mechanism to use any custom function in BI publisher reports. This opens a whole box of opportunities. The custom functions have to be written in java which means that you can code anything between the sun and the earth and then use it in your BI Publisher reports.

Let me 1^st chalk out the steps for this

1. Write your code and then compile it
2. Encapsulate your functions in a java archive (jar)
3. Put your archive on your webserver under the following directory <OracleBI_Home>\oc4j_bi\j2ee\home\applications\xmlpserver\xmlpserver\WEB-INF\lib
4. Restart your BI server
5. Use this function in your rtf template
6. Bingo!!

Let me use an example to present the process. Follow the steps to prefix ‘Hello’ to a list of names. Now, there are easier ways to concat strings in BI Publisher but the objective of this article is to present the process and not concat strings

1. Create a java file and name it customFunctions.java. Put the following code in it. Save it in C:

package customFunctions;

public class customFunctions

{

    public customFunctions()

    {

    }

    public static String helloFunction(String s)

    {

        StringBuffer stringbuffer = new StringBuffer("Hello ");

        stringbuffer.append(s);

        return stringbuffer.toString();

    }

}

2. Open command prompt and navigate to C:\. Compile this file using the following command                              javac customFunctions.java
3. customFunctions.class will be created. Create ‘customFunctions’ folder in C: and put customFunctions.class in customFunctions folder
4. Run the following command
jar -cvf customFunctions.jar customFunctions
-c  create new archive
-v  generate verbose output on standard output
-f  specify archive file name
You should be getting this message
added manifest
adding: customFunctions/(in = 0) (out= 0)(stored 0%)
adding: customFunctions/customFunctions.class(in = 532) (out= 317)(deflated 40%)
5. Place this jar in <OracleBI_Home>\oc4j_bi\j2ee\home\applications\xmlpserver\xmlpserver\WEB-INF\lib
6. Now restart your webserver (OC4J in my case)
7. Create a file called ‘customFunctions.xml’ and put it in <OracleBI_Home>\xmlp\XMLP\DemoFiles

<customFunctions>

  <listOfNames>

    <name>Vishal</name>

  </listOfNames>

  <listOfNames>

    <name>Shaili</name>

  </listOfNames>

</customFunctions>

8. Now create a rtf template and put the following things in it

a.       <?namespace:cfns=http://www.oracle.com/XSL/Transform/java/customFunctions.customFunctions?>

b.      <?for-each:listOfNames?>

c.       <?cfns:helloFunction(name)?>

d.      <?end for-each?>

Extension function namespace should start with 'http://www.oracle.com/XSL/Transform/java/'

This string is followed by the package structure of your jar.

9. Create a BI Publisher report. Select customFunctions.xml as the datasource and upload the newly created rtf in the templates section
10. You should be able to see the following output when you run the report