Configuring the BIRT runtime for HCL Compass reporting

This topic explains how to configure the BIRT Report Viewer with the HCL Compass Reporting Driver for running Compass reports. The required files for the HCL Compass Reporting Driver are in the reports folder in the Compass home directory.

Before you begin

To complete these configuration tasks, these components must be available in the HCL Compass environment:
Attention: The information in this section applies to WebSphere Application Server version 7.0. See the technote 1569987 for information on installing and configuring WebSphere Application Server version 8.0.

About this task

The configuration instructions that are described below apply to BIRT version 2.6.2.
  • For information about configuring BIRT 3.7, refer to technote 1566463.
  • For instructions on using a script to deploy the BIRT runtime, refer to technote 1960057.
  • For information about and selecting and installing other BIRT versions, refer to technote 1509579.

Configuring BIRT 2.6.2

To run BIRT reports from HCL Compass data sources, copy the Compass Reporting Driver files to the appropriate directory of the BIRT web application. The HCL Compass Reporting Driver files are packaged as Eclipse plug-ins that are installed automatically with any Compass feature. You can find the plug-ins in this directory:
Windows™
%COMPASS_HOME%\reports\driver
UNIX™ and Linux™
$COMPASS_HOME/reports/driver
The BIRT Viewer plug-ins are found in the WebSphere Application Server profile directory where HCL Compass applications are deployed. The default profile directories for Windows, UNIX, and Linux platforms are:
Windows
cq_profile_dir\installedApps\dfltCell\<birt-war.ear>\birt.war\WEB-INF\platforms\plugins
UNIX and Linux
cq_profile_dir/installedApps/dfltCell/<birt-war.ear>/birt.war/WEB-INF/platforms/plugins
Where cq_profile_dir is the default WebSphere Application profile directory that contains both the HCL Compass applications and the files for the BIRT server runtime environment.
Note: The default WebSphere Application Server cell directory is dfltCell on Windows, Unix, and Linux platforms. On the Solaris platform, the default is <srv>Node01Cell.

Procedure

  1. Go to the HCL Compass Reporting Driver installation directory in the COMPASS_HOME/reports/driver folder.
  2. Copy the plug-ins in this directory to the BIRT Report Viewer plug-ins directory cq_profile_dir/installedApps/dfltCell/<birt-war.ear>/birt.war/WEB-INF/platforms/plugins.
    com.hcl.ccm.compass.core.lib
    com.hcl.ccm.cq.jdbc
    com.hcl.ccm.cq.jdbc.nl1
    com.hcl.ccm.cq.oda.jdbc
    com.hcl.ccm.cq.oda.jdbc.nl1
    com.hcl.ccm.cq.stp

What to do next

Verify the BIRT deployment.