Configuring the Crystal Reports Java Reporting Component (JRC) runtime

To use the ClearQuest Report Server for Crystal Reports for ClearQuest reporting, install and configure a supported version of the Crystal Reports Java Reporting Component (JRC) on the WebSphere Application Server.

Before you begin

If you have already installed the Java Reporting Component runtime, remove the existing version before performing these configuration steps. See Removing the Crystal Reports JRC runtime.

About this task

For information about ClearQuest supported versions of the Crystal Reports Java Reporting Component (JRC) runtime versions and where to download them, see technical note 1216371.

These instructions include references to this variable:

%CLEARQUEST_HOME%\cqweb\cqwebprofile
On Windows, this variable represents the default path for the WebSphere profile directory where ClearQuest web applications are deployed. CLEARQUEST_HOME is the directory where ClearQuest is installed.
$CLEARQUEST_HOME/cqweb/cqwebprofile/
On Linux and UNIX, this variable represents the default path for the WebSphere profile directory where ClearQuest web applications are deployed. CLEARQUEST_HOME is the directory where ClearQuest is installed.
Note: In these instructions, the installation directory for the JRC runtime is based on ClearQuest being installed in a new WebSphere profile at this default location:
cd $CLEARQUEST_HOME/cqweb/cqwebprofile/installedApps/dfltCell/RationalClearQuestWebReport.ear/CQWebReport.war
If ClearQuest was installed into an existing WebSphere Application profile, this path might be different, and the path in the instructions must be updated before copying the JRC files. One other common location to check is this directory:
/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/installedApps/dfltCell/RationalClearQuestWebReport.ear/CQWebReport.war.
If ClearQuest is hosted on the Solaris platform, the default WebSphere Application Server cell directory is <srv>Node01Cell. The value dfltCell is the default for Windows, Unix, and Linux platforms.

Procedure

  1. Download the Crystal Reports Java Reporting Component (JRC) archive file that meets your ClearQuest reporting requirements. See technical note 1216371.
  2. Copy the Crystal Reports JRC to the web application.
    On Windows
    Run the batch file to copy the JRC to the web application.

    If you are using Crystal Reports JRC version 11.8.x, run the configureJRC.bat. For JRC version 12.2.x, run configureJRC12.bat

    1. From a command prompt, go to the directory where the ClearQuest batch files were installed:
      cd %CLEARQUEST_HOME%\cqweb\cqwebprofile\installedApps\dfltCell\RationalClearQuestWebReport.ear\CQWebReportModule.war
    2. Copy the Crystal Reports JRC runtime archive file into this directory.
    3. Run one of the following commands depending on which version of the runtime you are deploying.
      configureJRC JRC_runtime_file.zip
      configureJRC12 JRC_runtime_file.zip
    On Unix
    If you are using Crystal Reports JRC, version 11.8.x, run the shell script configureJRC.sh. If you are using Crystal Reports JRC, version 12.2.x, run the configureJRC12.sh script.
    1. Open a UNIX console window and go o the directory where the ClearQuest shell scripts were installed.
      cd $CLEARQUEST_HOME/cqweb/cqwebprofile/installedApps/dfltCell/RationalClearQuestWebReport.ear/CQWebReport.war
    2. Copy the Crystal Reports JRC runtime archive file into this directory.
    3. Set the permission for the version of the script you want to run:
      chmod u+x ./configureJRC.sh
      chmod u+x ./configureJRC12.sh
    4. Run the command for the JRC version you are copying:
      ./configureJRC.sh JRC_runtime_file.zip
      ./configureJRC12.sh JRC_runtime_file.zip
  3. Stop and restart IBM WebSphere Application Server to activate the changes.
    Note: The directory in these instructions might be different if ClearQuest was installed into an existing WebSphere profile.
    On Windows:
    1. Click Start > Control Panel > Administrative Tools > Services.
    2. In the Services pane, right-click IBM WebSphere Application Server v7.0 - %CLEARQUEST_HOME%\cqweb\cqwebprofile.
    3. Click Stop.
    4. After the service stops, right-click on the server name and click Start to restart the server.
    On UNIX system and Linux:
    1. From a UNIX console window, go to the bin directory of the WebSphere profile where ClearQuest server components are installed.
      Note: The directory in these instructions might be different if ClearQuest was installed into an existing WebSphere profile.
      cd $CLEARQUEST_HOME/cqweb/cqwebprofile/bin
    2. Run these commands to stop and start the default profile:
      ./stopServer.sh server1
      ./startServer.sh server1
  4. To verify that the ClearQuest Report Server for Crystal Reports is configured properly, open a browser window and go to this URL: http://localhost:<port>/cqwebreport/CRInvoker Where <port> is the port defined in the profile to deploy the application. The default ClearQuest profile uses port 12080. The default WebSphere Application Server profile uses port 9080.
    If the server is configured properly, this message is displayed.
    The report document has expired.
  5. Additional configuration steps are required in these situations:
    • A database field name is changed in the ClearQuest schema.
    • ClearQuest display field names do not match database field names.
    • ClearQuest display field names exceed 30 characters.
    See technical note 1419660.

Feedback