QualityCentral Java Client Guide

By: John Kaster

Abstract: This document tells you how to download, install, and use the QualityCentral(QC) Java client. The client allows you to create bug reports and feature requests, view reports, and comment and vote on the reports.

    Introduction

QualityCentral provides a community process for resolving, clarifying, and tracking quality issues regarding CodeGear's products and services. CodeGear Developer Network members can create bug reports and feature requests, view other members' reports, and comment and vote on the reports most important to them. CodeGear personnel also participate in QualityCentral, providing a permanent link between CodeGear customers and the teams who produce CodeGear's products.

    Installing the QC Java Client

You can download the QC Java client from http://qc.codegear.com/opentool.zip. The QC client can be run inside our Primetime-based IDE's and also as a standalone client when using JDK 1.4.x or higher.

There are several jar files included in the download zip file. QCClient.jar is the actual QualityCentral client. The other included jar files contain libraries that are required by the client. Standalone operation requires additional jar files that can be downloaded from http://qc.codegear.com/deps.zip.

    Installing as an OpenTool

The QualityCentral Java client can be run as an OpenTool inside CodeGear IDEs that use our Java-based "Primetime" IDE technology. The QualityCentral Java client has been tested with JBuilder 2006 but will likely work with previous versions as well.

To add the client as an open tool to your current Primetime-based IDE, simply copy the jar files that are included in the zip to the lib\ext directory of your installed IDE. Restart your IDE and you should see QualityCentral listed underneath your Tools menu.

If you would prefer to keep the QualityCentral files separated from other OpenTool extensions, you can also install them in another directory such as the lib\qc directory of your installed IDE. Then create a qc.config in the lib/ext directory as shown below. NOTE: the .config file must be in lib/ext, not the directory in which the QualityCentral files were installed.

# lib/ext/qc.config

addjars ../qc

    Installing as a standalone client

To run the client in standalone mode, first extract the files from both the opentool.zip and deps.zip files into the same directory. Then make sure that Java is either in your path, or that you have pointed to the Java executable for your platform, and use the following line of code to invoke the client jar:

java -jar QCClient.jar

    Client behavioral differences

The behavior of the client varies slightly depending on whether you're running standalone or inside the IDE as an open tool. The file attachment viewer built into the client is only used in standalone mode. When running the client as an open tool, the IDE editor is used to view file attachments. Using the IDE editor allows you to view images and XML documents and other types of attachments with a much better viewer than the default one included with the client. Similar differences exist when viewing the client's help files.

    Registering as a QualityCentral user

Before using this QualityCentral client, you must create your QC user account. You can register for QualityCentral by opening the location http://qc.codegear.com/qc/BCDownloadCGI.exe/ChangePassword in a browser that supports cookies. Opening this URL brings you to a page where you can change or set your QC account password. You can use the same password you've used for your BDN membership, or use a different one. If you are not currently a BDN member or don't have your BDN user cookie set in your browser, you will be redirected to the BDN account signup page automatically to get your cookie, then brought back to the QC password page.

BDN membership is free, and gives you access to the services offered on the CodeGear Developer Network, including QualityCentral.

    Connecting to the QualityCentral web service

After you have created your QC user account information, select Login from the File menu in the QualityCentral client, or click the Login button to enter your email address and password.

Make sure you use the same email address you used for setting your BDN user cookie and/or registering your QC account, and use the same password you entered for your QC account.

    Configuring the client for a proxy server

If you are using a proxy server, you will need to configure it before attempting to log in to the QC web service. The User|Preferences menu option allows you to set your:

  • Proxy host
  • Proxy port
  • Proxy user name
  • Proxy password

When you set them, the client will attempt to reconfigure your proxy information so both web service calls and straight HTTP downloads (for example, when downloading client updates) will respect the proxy settings. However, you may need to restart the client for the proxy settings to activate.

    Reporting bugs in the QualityCentral Java client

If you run into any issues with this client, or have ideas for improving it, please submit them to the QualityCentral project in QualityCentral itself, under the appropriate Client Interface area. Just be sure to set the Platform to "Java".

    Client Menus

Use the File menu for logging in and out of the QualityCentral web service, closing your current data view, and exiting the application.

Use the Reports menu for finding reports with a variety of search options, and for adding new reports to QualityCentral.

Use the User menu to view and change your user information and preferences.

Use the Scoring menu to find the top rated and top voted reports for any QualityCentral project.

Use the Help menu to display the QualityCentral help or view the client about box.

    More Information on QualityCentral

For more information on QualityCentral, refer to:

Server Response from: ETNASC04