Thursday, February 11, 2010

BIRT Crosstab scripting

BIRT supplies scripting hooks for just about every report element in the palette. You can generally implement an onPrepare, onCreate, and onRender event handler for each of these report items. The onPrepare event fires before data is retrieved and allows you to change the design for a specific report item. The onCreate event fires when the report item is being created by the report engine’s generation task. The onRender event fires when the report item is being rendered by the report engine’s render task. These events and example are described on the BIRT website.

Some report items offer more event hooks. For example a chart item actually has over thirty event hooks that allow total customization of the chart generation and presentation phases. As a side note, all chart scripts fire during the report engine’s render task. This does not mean the database is hit at render time though. The report engine will cache the data for a chart in memory or in a report document, depending on what task type is being used to run and render the report.

The BIRT crosstab element offers onPrepare, onCreate and onRender hooks as well. These events are fired both for the crosstab as a whole and for each individual cell in the crosstab. When firing events for cells, these are processed top to bottom and left to right. Handlers can be written using the script tab at the bottom of the report design view. BIRT also supplies an event adapter to allow you to write these events in Java as well.



As an example script, you can modify the crosstab in the onPrepare like:



function onPrepareCrosstab( crosstab, reportContext )
{
var coldim = crosstab.getColumnLevels().get(0);
coldim.removeAllFilterConditions();
crosstab.getStyle().setFontFamily("Arial");
crosstab.getStyle().setFontSize("8");

}



This script removes filters from the first column level and sets some font information. Some of the more interesting capabilities are available when using the onCreateCell event hook. For example consider the following script.



function onCreateCell( cellInst, reportContext )
{

//Can reference cells by type or id - valid types "header" or "aggregation"
if( cellInst.getCellType() == "header" ) {
//Get data values see binding tab on crosstab
//if( cellInst.getDataValue("PRODUCTLINE") == "Planes" ){
if( reportContext.evaluate("dimension['ProductGroup']['PRODUCTLINE']") == "Planes" ){
cellInst.getStyle().setBackgroundColor("#FF0000");
cellInst.getStyle().setFontSize("12");
}else{
//Set the rest to yellow
cellInst.getStyle().setBackgroundColor("#FFFF00");
cellInst.getStyle().setFontSize("12");
}

}
//refer to crosstab header
if( cellInst.getCellID() == 167){
cellInst.getStyle().setBackgroundColor("Orange");
}
if( cellInst.getCellType() == "aggregation"){
//Can refernce value using getDataValue or
if( cellInst.getDataValue("PRODUCTLINE") == "Planes" ){
//set color to bluegray
cellInst.getStyle().setBackgroundColor("RGB(169,170,226)");
}
//by using reportContext.evaluate
//if( reportContext.evaluate("measure['amount']") > 50000 ){
if( cellInst.getDataValue("amount_DateGroup/quarter_ProductGroup/PRODUCTLINE") > 50000 ){
cellInst.getStyle().setBackgroundColor("Green");
cellInst.getStyle().setColor("White");
}
}
}



The onCreateCell script is passed the reportContext and an instance of the cell. The cellInst object has several methods that can be used to determine which cell is currently being processed. You can call getCellType() which will return header or aggregation. In the following image all cells in the red box will return aggregation and all others will return header.



You can also call getCellID() which will return the specific element id that your crosstab uses for that cell.



In this example the getCellID call will return 160 every time this cell is created. This can be useful when you are trying to determine if you have a new row or column in your crosstab. If this is the innermost header element then this cell will be created for every new row/column. The only drawback to this approach is that if the crosstab is in a library or you copy and paste it, the cell ids will change.

Once you know the cell you are currently processing you generally want to access the data, to make some script decision. To do this you have a couple of choices. You can call the getDataValue method on the cell instance or use the reportContext.evaluate method. When using the getDataValue method, the value you need to refer to is the data binding column name set on the crosstab item. For example:


cellInst.getDataValue("PRODUCTLINE") == "Planes"


refers to the PRODUCTLINE data binding. Also note that this is the value of the column as this particular cell is being processed.



You can also use the reportContext.evaluate method, which allows you to build an expression and bypass the binding. For example:


if( reportContext.evaluate("dimension['ProductGroup']['PRODUCTLINE']") == "Planes" )

Essentially returns the same value as the previous getDataValue(“PRODUCTLINE”) method. This is because the PRODUCTLINE data binding has:

dimension['ProductGroup']['PRODUCTLINE']


As it’s expression. This example references a particular dimension of the cube. You can reference cube measures as well.

reportContext.evaluate("measure['amount']")


As with the column binding this will return the value for the specific cell you are currently processing.

In the script posted at the top of this post, we use the cell instance object to set specific styling based on the values of various column bindings. This is done using the getStyle method.


cellInst.getStyle().setBackgroundColor("Green");
cellInst.getStyle().setColor("White");


Using this method is no different than other BIRT report items.

Using these methods and the reportContext you can write some very sophisticated scripts. For example you can store all the quantities ordered where the product line is ships to a global variable using a script similar to this:



if( cellInst.getCellType() == "aggregation" && cellInst.getCellID() == 151){
if( cellInst.getDataValue("PRODUCTLINE") == "Ships" ){
importPackage(Packages.java.lang );
var cur = cellInst.getDataValue("amount_DateGroup/quarter_ProductGroup/PRODUCTLINE");
if( reportContext.getGlobalVariable("totalplanes")==null){
reportContext.setGlobalVariable("totalplanes", new Double(Double.parseDouble(cur)) );
}else{
var oldcnt = reportContext.getGlobalVariable("totalplanes");
reportContext.setGlobalVariable("totalplanes", new Double(Double.parseDouble(oldcnt) + Double.parseDouble(cur)));
}
}
}



This value can then be referenced within the same crosstab or later in the report. For example the following expression for a text item can be used.

<VALUE-OF format="#,##0.00">reportContext.getGlobalVariable("totalplanes");</VALUE-OF>

This example can also be implemented in Java. In the attached link the report will contain two crosstabs. One where the code is done in JavaScript and the other uses an event handler written in Java, which is also attached.

The example report output is presented below.



The examples are available at Birt-Exchange.

9 comments:

Abdullah Zainul Abidin said...

This is great. But I would like to know if it's possible to hook on parameter selection. For example, I would like to have 2 list for parameters but I need it to multiselectable for both. Thus I cannot use CascadingParameters for it and would rather like to be able to call the second list to update itself when there is a change of selection in the first list. Is it possible currently with birt 2.5?

Jason Weathersby said...

Currently BIRT only supports multi-select in the last level of a cascade, and cascaded is the only way to have a second dataset fire based on the first. You could do something with a driver report. Where you have one report that displays the first multiselect parameter and in the report only have a text element that shows the second parameter selection and forwards to a second report. Kind of ugly though. Is it not possible to add an all or something like that. I have an example where my first cascade presents with an alpha list a-z, and the second level looks for customers that start with the first letter of the first cascade.

Jason Weathersby said...

I looked over the bug for this and someone has figured a way around this. Have a look at:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=208477

Jason Weathersby said...

I think using the method in the previous comment will allow you to set any level to mutli select but the second dataset will not get all the values from the first dataset as the SOAP request behind the AJAX update call is only sending one value.

Abdullah Zainul Abidin said...

Thanks for the tip. Almost got it working but of course like you said, the AJAX returns only 1 value. Thanks anyway.

Anonymous said...

I'm sorry for posting this in multiple forums and blogs, but I am kind of struggling with the below requirement and this is important for our project. I almost have 8 reports with similar requirement. I posted this on BIRT forums almost 10 days ago, but there is no response. I'm sure there's a way to do this, but just can't seem to figure it out.

I have a crosstab with date column (ex: mar-09, apr-09, ...) and rows with a name of a person. For each month, I display some number which could be anything (ex: amount of sales). I am able to define a sortcolumn and sort the columns based on the date.

But we have a requirement where the users can specify whether they would like to order the rows based on a person'name or total amount of sales and in ascending or descending order. I can pass two report parameters, sort by and sort order and sort the crosstab based on these two.

I would appreciate if anybody can provide an example (using DE API or crosstab events - onCreate, onRender, etc).

Jason Weathersby said...

Take a look at this example:
http://www.birt-exchange.org/devshare/designing-birt-reports/1201-add-sort-to-crosstab-using-de-api-in-script/#description

Anonymous said...

Works like a charm. You guys are great!

Anonymous said...

I have a crossstab with a colume that is a date value. When the date is null it displays January 1, 0001. How can I get it to display a blank if the date is null?