This forum is now out of date, for our new forum Click Here
Yellowfin 5.0 + BIRT support
Frequently Asked Question
Please see this post for information about BIRT support in Yellowfin 4.1.

In Yellowfin 5.0 and above, the BIRT adapter has been updated to support version 2.5.2 of BIRT (the latest version available at the time of release). If you are currently using a different version of BIRT and do not need to upgrade, you don't need to do anything. The Yellowfin upgrade will preserve your BIRT installation and any existing BIRT reports will keep working.

If you have a new installation of Yellowfin 5.0 and want to enable BIRT support, or have upgraded from a previous version and would like to upgrade your BIRT engine to version 2.5.2, please follow these instructions:

As with Yellowfin 4.1, the BIRT engine is not included in Yellowfin installations. Go to the BIRT website to download the BIRT deployment runtime (also called the Report Engine). The filename should be birt-runtime-2_5_2.zip.

Unzip this file into your Yellowfin installation directory. It will create a sub-directory called "birt-runtime-2_5_2".

Edit the file Yellowfin/appserver/conf/catalina.properties
Find the definition of the shared.loader property:
shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/lib/*.jar


Add the new BIRT runtime directory to the end:
shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/lib/*.jar,${catalina.base}/../birt-runtime-2_5_2/ReportEngine/lib/*.jar


You will also need the Yellowfin BIRT adapter for version 2.5.2. If you have performed a new installation of Yellowfin 5.0, the adapter will already be included in your installation (you can check for the file yfbirt252.jar in the Yellowfin/appserver/webapps/ROOT/WEB-INF/lib/ directory).

If you have upgraded from a previous version of Yellowfin, you can download the adapter here:
yfbirt252.jar
Checksums:
SHA256 (yfbirt252.jar) = ba7d5dd52446861305bebc6737ec90f13bcd370d03e582fd998796685f4e41d4
MD5 (yfbirt252.jar) = 036cb742f1a107a5cfe008c1551e2e6b

Save the adapter into the Yellowfin/appserver/webapps/ROOT/WEB-INF/lib/ directory, and remove any other BIRT adapters from this directory (yfbirt232.jar, yfbirtlegacy.jar).

If your original installation of Yellowfin was from version 4.0 or earlier, you may have additional BIRT libraries in the lib directory. These must be removed to support the new BIRT adapter. Please remove any of these libraries that you find in the lib directory:
chartengineapi.jar
com.ibm.icu_3.4.4.1.jar
com.ibm.icu_3.8.1.v20080530.jar
commons-cli-1.0.jar
commons-codec-1.3.jar
coreapi.jar
crosstabcoreapi.jar
dataadapterapi.jar
dataaggregationapi.jar
dataextraction.jar
dteapi.jar
engineapi.jar
flute.jar
js.jar
modelapi.jar
modelodaapi.jar
odadesignapi.jar
org.apache.commons.codec_1.3.0.v20080530-1600.jar
org.eclipse.emf.common_2.2.0.v200606051102.jar
org.eclipse.emf.common_2.4.0.v200808251517.jar
org.eclipse.emf.ecore.xmi_2.2.0.v200606051102.jar
org.eclipse.emf.ecore.xmi_2.4.1.v200808251517.jar
org.eclipse.emf.ecore_2.2.0.v200606051102.jar
org.eclipse.emf.ecore_2.4.1.v200808251517.jar
sac.jar
scriptapi.jar


Now you can restart Yellowfin, and you should see in the startup logs:
Initialising Birt Engine
Birt resource path: <Yellowfin>/appserver/BirtResources
Birt path: <Yellowfin>/birt-runtime-2_5_2/ReportEngine
ReportDesign version: 3.2.21
Birt adapter version: 2.5.2

Steve

Fri Oct 21, 2011 11:20 AM

Comment
Using JDBC drivers with BIRT reports

The JDBC drivers used by Yellowfin will not automatically be available to BIRT reports. You need to copy any JDBC drivers that you use into the BIRT runtime directory.

You can find the drivers that Yellowfin uses in the Yellowfin/appserver/webapps/ROOT/WEB-INF/lib/ directory. Common driver libraries are:
JTDS driver for MS SQL Server and Sybase: jtds.jar
MySQL driver: mysql-connector-java-3.1.11-bin.jar
Oracle driver: ojdbc14.jar
PostgreSQL driver: postgresql.jar
DB2 driver: db2jcc.jar, db2jcc_licence_cu.jar

Copy the required drivers into the directory:
Yellowfin/birt-runtime-2_5_2/ReportEngine/plugins/org.eclipse.birt.report.data.oda.jdbc_2.5.2.v20100205/drivers/

Restart Yellowfin to pick up the new drivers.

Steve

Thu May 6, 2010 12:43 PM

Comment
Note:
The BIRT engine does not like folder locations with 'spaces'.
So you will not be able to use the BIRT engine if your Yellowfin installation directory is c:\Yellowfin 5.1\ etc..

David

Thu Jan 27, 2011 11:51 AM