IBM Rational ClearQuest Report Exporter
The IBM ClearQuest Report Exporter is a command line tool used to extract all report files from the Report Server for ClearQuest repository and saves the files to the local file system. Once the report files are saved to the file system, the reports can be launched from a web browser using the Report Launcher for ClearQuest web application.
Please view the license agreement in the directory /reportExporter/license before using the IBM Rational ClearQuest Report Exporter. Click here to open the English version of the license agreement.
After downloading the IBM Rational ClearQuest Report Exporter archive, follow these instructions to install the archive. The instructions assume that you are logged on to the server machine where the Report Server for ClearQuest is installed.
Windows:
C:\Program Files\IBM\RationalSDLC\ClearQuest\RCQR
Linux:
/opt/rational/clearquest/RCQR
Windows:
"%RATIONAL_COMMON%/infozip/unzip" reportExporter_<id>.zip
NOTE: The unzip program used in the previous command is not installed with all IBM Rational ClearQuest features. If the program is not present on your file system, use an alternative archive extraction program to store the archive contents on the file system.
Linux:
unzip reportExporter_<id>.zip
After extracting the file, there will be a new subdirectory named ./reportExporter, and the following files which are saved to the preexisting ./server subdirectory.
|
reportExporter.bat |
Command file to launch the report exporter on Windows. |
|
reportExporter.sh |
Shell script to launch the report exporter on Linux. |
|
reportExporter_log4j.properties |
Log configuration file to specify log4j options. |
Linux:
chmod u+x reportExporter.sh
NOTE: Shut down the Report Server for ClearQuest before running the report exporter.
This section demonstrates the command syntax used to run the IBM Rational ClearQuest Report Exporter. These instructions assume that you are logged on to the server machine where the Report Server for ClearQuest is installed. Open a command prompt and follow these instructions:
Windows:
Linux:
Each of the following parameters must be passed when invoking the report exporter.
Command:
reportExporter –username admin –password adminpw –basePath c:/reportalExport
INFO - Export report designs to file system
INFO - Loading configuration from "file:C:\Program Files\IBM\RationalSDLC\ClearQuest\RCQR\server\teamserver.properties".
INFO - Initial database connection successful
Db Product Name: Apache Derby
Db Product Version: 10.3.2.2 - (650004)
Db Name/Location: C:/Program Files/IBM/RationalSDLC/ClearQuest/RCQR/server/repositoryDB
ERROR - CRJAZ1054I Invalid ChangeEvent expiration itemType specification com.ibm.team.workitem.WorkItem:com.ibm.team.workitem.WorkItem:5184000 com.ibm.team.build.BuildResult:172800.
ERROR - CRJAZ1054I Invalid ChangeEvent expiration itemType specification com.ibm.team.build.BuildResult:com.ibm.team.workitem.WorkItem:5184000 com.ibm.team.build.BuildResult:172800.
INFO - Authenticating user "admin"
INFO - Creating new directory "c:/reportalExport"
INFO - Start export for folder "JNI" (owner=admin shared=true)
INFO - Creating new directory "c:/reportalExport/JNI"
INFO - Start export for report "Defect Summary (JNI)" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/JNI/cqbanner.JPG"
INFO - Saving "c:/reportalExport/JNI/DefectsSummary_JNI.rptdesign"
INFO - End export for report "Defect Summary (JNI)"
INFO - Start export for report "Defect By State (JNI)" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/JNI/DefectsByState_JNI.rptdesign"
INFO - End export for report "Defect By State (JNI)"
INFO - End export for folder "JNI"
INFO - Start export for folder "CM" (owner=admin shared=true)
INFO - Creating new directory "c:/reportalExport/CM"
INFO - Start export for report "Defect Summary (CM)" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/CM/cqbanner.JPG"
INFO - Saving "c:/reportalExport/CM/DefectsSummary_CM.rptdesign"
INFO - End export for report "Defect Summary (CM)"
INFO - Start export for report "Defect By State (CM)" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/CM/DefectsByState_CM.rptdesign"
INFO - End export for report "Defect By State (CM)"
INFO - End export for folder "CM"
INFO - Start export for folder "XMLDriverTest" (owner=admin shared=true)
INFO - Creating new directory "c:/reportalExport/XMLDriverTest"
INFO - Start export for report "XMLDriverTest" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/XMLDriverTest/XMLDriverTestReport.rptdesign"
INFO - Saving "c:/reportalExport/XMLDriverTest/ReportTest.xml"
INFO - End export for report "XMLDriverTest"
INFO - Start export for report "ReportWithIntegerNull" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/XMLDriverTest/ReportWithNullInteger.rptdesign"
INFO - End export for report "ReportWithIntegerNull"
INFO - End export for folder "XMLDriverTest"
INFO - Start export for folder "APARFixes" (owner=admin shared=true)
INFO - Creating new directory "c:/reportalExport/APARFixes"
INFO - Start export for report "ReportWithNull" (owner=admin shared=true)
INFO - Saving "c:/reportalExport/APARFixes/ReportWithNullInteger.rptdesign"
INFO - End export for report "ReportWithNull"
INFO - End export for folder "APARFixes"
INFO - Export completed successfully
Reports and folders that are saved in the Report Server for ClearQuest repository as unshared resources are exported to a subdirectory named unshared/<owner>. The folder structure for the resource is preserved. For example, if user “engineer” created an unshared report named “Report1” in folder “TeamReports/test”, the associated report resource file named “Report1.rptdesign“ is exported to:
<exportDirectory>/unshared/engineer/TeamReports/test/Report1.rptdesign
Special steps are needed if you want to build BIRT reports that allow user credentials to be passed by the Report Launcher for ClearQuest or entered at runtime. See the Report Launcher documentation for information about passing credentials to BIRT data sources. Failure to perform these updates causes the report to run using the credentials that are saved in the report.
This section provided information to help diagnose and correct problems that occur while running the IBM Rational ClearQuest Report Exporter.
The output of the report exporter is controlled using a log configuration file named reportExporter_log4j.properties. The default logging configuration writes informational messages from the report exporter and also outputs any error messages that are logged. If problems occur and additional debug information is needed, the log configuration file can be modified to log more details. Edit the reportExporter_log4j.properties, and make the following change:.
|
Old |
New |
|
log4j.rootLogger=ERROR, stdout |
log4j.rootLogger=DEBUG, stdout |
After making the change, rerun the reportExporter command file to activate the more granular logging.
Q: The Report Server for ClearQuest is already uninstalled. Can I use the IBM Rational ClearQuest Report Exporter to export report files from a backup version of the repository?
A: Yes. The IBM Installation Manager preserves the Report Server for ClearQuest repository during update and uninstall operations.
The repository is stored in the following default locations:
Windows:
C:\Documents and Settings\All Users\Application Data\IBM\Rational.
preserve\RCQR\repositoryDB
Linux:
/tmp/Rational.preserve/RCQR/repositoryDB
Q: We have two reports saved in the same folder, and they include different versions of the same report file. How does the report exporter handle this case?
A: When the report exporter detects that a file resource is already saved in the target directory, the new resource to be saved is assigned a unique name by prepending a numeric identifier. For example, if the report exporter tries to save a file named “reportImage.gif” and detects that the file already exists, the new resource is saved as “1_reportImage.gif”. A suitable message is logged to report this action.