Difference between revisions of "BIRT/FAQ/Scripting"
(→Q: Is it possible to use cell.setProperty( ) to set the width of cells?)
(→Q: Does BIRT support page totals?)
|Line 19:||Line 19:|
== Scripting ==
== Scripting ==
Revision as of 14:20, 11 January 2007
Back to BIRT FAQ Index
- 1 Aggregates (Totals)
- 2 Scripting
- 3 Accessing Java Classes
- 4 Logging
Q: What aggregate operations does BIRT support?
"Aggregate" is the fancy word to describe totals. BIRT supports a wide variety of totals: sum, running sum, average, minimum, maximum, count, count distinct, and many more. See the ROM Scripting Specification for details.
Q: Does BIRT support look-ahead (two-pass) aggregates?
Look-ahead aggregates are of the form "this value as a percentage of an overall total". For example, a customer's sales as a percentage of overall sales for a sales rep, sales region, and so on. These are often called two-pass aggregates becuase they require the reporting tool to make one pass over the data to compute totals, then another pass to compute the percentages for each record.
BIRT does provide support for such totals. Just enter the calculation and BIRT figures out the right way to compute it:
Total.percent( row.Sales, Total.sum( row.Sales ) )
Q: Is an example of simple calculations like count, sum, max, min?
Q: Can I add custom logic (scripting) to my report?
sum( row.orderTotal )
This summarizes the orderTotal column over all rows. This makes aggregates look like other expressions, even though the BIRT report engine needs to "rewrite" them.
Q: Good, but most report developers don't like to write code.
1. Simple expressions: row.Price * row.Quantity 2. Business expressions: choose a salutation (Mr., Mrs., Ms., etc.) depending on a database code, and concatenate the salutation, first name and last name. 3. Complex logic written in Java: Compute the recommendation rating for a stock based on factors in the database, and proprietary stock-rating algorithms.
Simple tasks require no code. This includes conditional formatting (make negative numbers red, for example), data transformations (filters, sorting, totals), conditional display (hide certain fields for certain types of customers), and so on.
Accessing Java Classes
Q: Can BIRT access existing Java code or objects?
importPackage( "com.company.AppLogic" );
importPackage is not suported in BIRT 1.0, so the previous line will not work: To use outside packages, you will need to use the fully qualified name of the object var abc;
abc = new Packages.com.company.AppLogic();
obj = new MyClass( ); result = obj.calculate( row.balance, row.dueDate );
With BIRT 2.1 there are several ways to include your custom classes into BIRT's scripting classpath.
- If you are using the BIRT Designer, you have to add your classes to the classpath of the BIRT Viewer Plugin: org.eclipse.birt.report.viewer. To do this you have two choices:
- Put your .class files into the birt/WEB-INF/classes subfolder of the Viewer-plugin. Don't forget to apply the correct directory structure according to your package name.
- Package your classes into one or more jar-files and put them into the birt/scriptlib subfolder of the Viewer-plugin.
- When using the BIRT Runtime to run reports outside the Designer, package your custom classes into a jar-file and put them into the ReportEngine/lib subfolder of the BIRT Runtime distribution.
- In Eclipse enviroment, it seems that BIRT Runtime load the classes in the $project/bin directory. Because it is quite bad to add the classes in development phase in the directories like birt/scriptlib and birt/WEB-INF/classes. Although it is not perfect to put classes in the $project/bin directory, it is more convenient for development. I don;t know why Birt runtimee cannot use the classes pathes set for the eclipse project. Any comments?
Q: Where can I find logs?
When using BIRT Designer the logs can be found in the directory $ECLIPSE_HOME/plugins/org.eclipse.birt.report.viewer_version/birt/logs. The logging can be configured in the file $ECLIPSE_HOME/plugins/org.eclipse.birt.report.viewer_version/birt/WEB-INF/web.xml, namely the properties BIRT_VIEWER_LOG_DIR and BIRT_VIEWER_LOG_LEVEL.
You can use standard Java logging package. First initialize the Logger:
importPackage(Packages.java.util.logging); var fileHandler = new FileHandler("/tmp/birt.log", true); var rootLogger = Logger.getLogger(""); rootLogger.addHandler(fileHandler);
and then you can log the string with