Using BIRT v4.6
You can use the Business Intelligence and Reporting Tools (BIRT) Report Designer v4.6 to design data-pull reports for HCL Compass data sources.
About this task
To use BIRT 4.6 with HCL Compass, you must first install the following:
- HCL Compass
- IBM WebSphere Application Server (WAS) with IBM Java 8. Use 64-bit JRE for JNI
and CM data source support or use 64-bit JRE for CM-only data source support. Note: Java 8 is most easily deployed using WAS 8.5.5.12.
- Eclipse IDE for Java and Report Developers Neon-3 (for Design) (x86_32)
- BIRT Report Engine 4.6 (for Runtime)
- IBM JRE 1.8 (x86_32) (part of HCL Compass)
Configuring Eclipse IDE for Java and Report Developers with BIRT v4.6
Procedure
- Download and un-ZIP Eclipse IDE for Java and Report Developers Neon-3 (x86_32)
-
In the un-zipped directory, locate the file “eclipse.ini" and add the following lines to the
start of the file:
-vm <your-IBM-JRE-path>/jre/bin/javaw.exe
For example:
-vm c:\HCL\Compass\JAVA\bin\javaw.exe
-
Copy the HCL Compass Reporting Driver to
the Eclipse “dropins" directory.
Copy all JAR files from: <CQ_Home>\reports\driver\plugins\ to the Eclipse “dropins�? directory: <Eclipse-IDE>\dropins\, where “<Eclipse-IDE>" is the location where you un-zipped Eclipse IDE for Java and Report Developers Neon-3.
- If you already have a “workspace" that was created using BIRT Report Designer RCP 3.x and you want to use it with Eclipse IDE for Java and Report Developers Neon-3, then make a copy of the “workspace" to a new location such as “workspace-birt-4.6". Otherwise, create a new workspace name.
- Start Eclipse IDE for Java and Report Developers Neon-3 and point it to the copied workspace of “workspace-birt-4.6".
- In Eclipse, click on the Open Perspective icon and select the Report Designer perspective, or click .
-
Optional: You may wish to create a new Reporting Project to store your files. For example, Finish.
, name it and click on Note: It may be useful to put the “location" within the root of the Report Launcher reporting directory specified in the reportlauncher.properties file. To start with a fresh report, click within your project’s context.
-
To preview reports, click
. Note: If you have any errors, adjust your default browser preferences within .
Configuring Report Launcher with BIRT Runtime
- Download and un-ZIP BIRT Report Engine 4.6
-
If a BIRT runtime is already deployed for use with Report Launcher in your HCL Compass CM
Server, you must un- deploy the application runtime from the WAS profile first using the
WebSphereAdministrative Console at either: http://yourserver:12060/ibm/console or
https://yourserver:12043/ibm/console.
- Login and select .
- Check the box to the left of the BIRT runtime to be removed.
- Click on Uninstall and confirm your action. Save the change to the Master Configuration.
- Stop and then start the WAS profile to apply the change.
-
Re-deploying
-
Un-ZIP your BIRT runtime into a directory, and copy the birt.war into the this path:
<CQ_HOME>\reports\launcher\birt\birt.war
- Rename to birt46.war if you wish.
-
-
In a command shell, with administrative privilege,navigate to the directory
<CQ_HOME>\reports\launcher\birt\
- Execute the following command:
deployBIRT.[sh | bat] birt.war
For example,[Windows] deployBIRT.bat birt.war
[Linux] deployBIRT.sh birt.war
Note:If you are using WAS Administrative Security, respond to the prompts for username and password. If your WAS profile is installed in a non-defaultpath, adjust this line of the deployBIRT.* file to:set WAS_PROFILE_PATH=%COMPASS_HOME%\cqweb\cqwebprofile
- Execute the following command:
-
Test BIRT runtime http://localhost:12080/birt/.
Note:
Verify that the test report works. It will say v4.5, even if you have installed 4.6. This is a known BIRT defect. For more details, refer to the Verifying the BIRT deployment topic to verify the BIRT deployment and check the installed version.
-
When executingreports, remember to click “setcredentials" within Report
Launcher.
Note: For more information about BIRT and how to download it, refer to:
- BIRT download
- Use direct download (64-bit version) for Eclipse IDE for Java and Report Developers.
- Use direct download for Latest BIRT Runtime Release Build
- IBM JRE1.8 x86_32 can be found included with HCL Compass: <CQ_HOME>\common\JAVA\jre\bin\javaw.exe