|
Rational ClearQuest Client for Eclipse, Version 6.14.0, Release Notes |
First Edition (November 2004) This edition applies to Rational ClearQuest Client for Eclipse, Version 6.14.0 and to all subsequent releases and modifications until otherwise indicated in new editions.
Copyright International Business Machines Corporation 1997, 2004. All rights reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
1.0 About this release
1.1 Product compatibility
1.2 New in this
release
2.0 Installation, upgrade, and
configuration information
2.1 Hardware
and software requirements
2.2
Installation and update notes
3.0 Known limitations, problems,
and workarounds
3.1 Limitations
3.1.1 Creating or modifying
dynamic choice lists is not supported.
3.1.2 Submit record defaults
created in the Native client is not compatible with the CQEC Record Template
feature
3.1.3 Charts and reports are not
fully supported on Windows.
3.1.4 Batch record update with
mixed record types is not supported.
3.1.5 ActiveX and Picture form
controls are not available.
3.1.6 MultiSite is not fully
supported.
3.1.7
Linux-specific limitations
3.1.8 Column sorting is disabled
for SQL queries
3.1.9 Radio button controls and
grouped fields are not printed
3.1.10 Query default display
fields and filters are not shared with the Native client
3.1.11 Email notification rules
are not cached
3.2 Known
problems and workarounds
3.2.1 Drag and drop of queries
between connections is not supported.
3.2.2 A failed record script
action results in an exception if the scripting language is Perl.
3.2.3
Working with attachments
3.2.4 Installation and
uninstallation
3.2.5 Setting remotely mastered
personal workspace objects to run at startup causes an error.
3.2.6 SQL Queries with the same
column names display incorrect data.
3.2.7 ClearQuest preferences can
not be edited because the necessary capability is disabled
3.2.8 The OK button on the record
form is not enabled when completing required fields
3.2.9
Linux-specific issues
3.2.10 A reference field with a
large number of values causes Eclipse to hang.
3.2.11 "Can not
restore workbench layout" error message is shown when starting Eclipse.
3.2.12 Manipulating reports
prevents the release of database connections and licenses
3.2.13 Performing actions during
startup object execution may cause unexpected behavior
3.2.14 Multiline sorting is not
supported
3.2.15 Records are not marked
"Deleted" if the first column is not the unique key
3.2.16
Eclipse Integration
3.2.17
Using "New Window" to launch a second workbench may cause some
problems
3.2.18 Chart set
to run at startup may result in a workbench crash while logging into a database
3.2.19 Running some
reports may result in a workbench hang
3.2.20 Email
notification of submitted records requires a prior query to be run
3.2.21 Submitting
an email rule may result in a crash
4.0 Contacting customer support
The Rational ClearQuest Client for Eclipse provides seamless integration between ClearQuest and Eclipse, using native Eclipse interface techniques. Eclipse views exist for ClearQuest workspace navigation, query results, record details and charting. Several standard Eclipse views are leveraged, such as Properties and Console.
Many common IBM(R) Rational(R)ClearQuest(R) tasks are streamlined within Eclipse. Change requests can be submitted from various integration points, such as the main tool bar, the Task or Problems view, or editor markers and resources from navigation-style views. Using the query wizard, or previously defined personal and shared team queries, change requests are identified and listed. The previously defined queries can be enabled to run at login. For example, a query that finds all defects assigned to you runs when you login, automatically creating your ToDo list. From the query results, you can then update or change the state of change requests as needed.
These Release Notes are accurate at the time this product was prepared for release. The most recent version of this file as well as translated versions of this file are available in the IBM Publications Center at http://www.ibm.com/shop/publications/order. Search for "ClearQuest + Eclipse" to find the latest version of these Release Notes in the IBM Publications Center. (To search for the IBM Publications Center, go to http://www.ibm.com/ and enter "IBM Publications Center" in the Search field.)
IBM Rational ClearQuest is a customizable defect and change tracking system that organizes and automates the processes involved in submitting, assigning, tracking, testing and releasing change requests. In order to use the Rational ClearQuest Client for Eclipse, you must install and configure the basic Rational ClearQuest application (version 2003.06.14). Contact your local Rational ClearQuest administrator to find out how to install and configure your Rational ClearQuest client application and establish a connection to a database.
Query Results View pagination allows the user to determine the number of records displayed per page in the Query Results view. The user may navigate from page to page by using the controls at the bottom of that view.
The number of records displayed per page is initially set to 100 records per page. It may be changed by the user using Window->Preferences->Team->ClearQuest->Advanced. The new preference is used when you rerun the query or execute a new query, but is not used by existing Query Result views. Setting the number of records to more than 500 records per page is not recommended and may result in slower performance.
Recently submitted record queries return records of the type that have been submitted during the current session. These queries are created automatically as records are submitted, and are listed in the ClearQuest Navigator view in the Recently Submitted folder. Only one query exists for each record type per session. Any changes to this query (filters or display fields) are persisted until the session ends.
Recently Submitted record queries are stored in a read-only folder named "Recently Submitted". No workspace objects can be created, copied/pasted, or dragged/dropped. However, queries inside this folder may be copied/pasted into a user's private folder for later use.
The Record Templates feature in the ClearQuest Client for Eclipse allows the user to create a set of templates per database connection and record type. Each database connection can have multiple templates for each record type creator. Record templates in the ClearQuest Client for Eclipse are analogous to field value defaults in the ClearQuest Native Client. However, record templates save the values for all the fields for the entity as is for the present state, not just the ones that have been modified. When a template is loaded, all the values from the saved template are loaded, discarding values previously entered. Record templates are not interoperable with ClearQuest Native Client defaults.
The Record Templates control is located at the bottom of any Submit dialog. The dropdown list box provides a list of previously created templates that apply to the current database and record type. The multifunction control next to this list offers the ability to load data from a template, add, delete, or rename a template, or set a template as default.
Import and Export of templates are allowed to transfer the entire set of templates to another ClearQuest Eclipse client. The Import/Export functionality is available under ClearQuest > Miscellaneous.
The ClearQuest Client for Eclipse supports creation and execution of reports. The process of creating a new report is similar to that of creating a new query. Select the context menu item New Report within the ClearQuest Navigator view. Follow the steps within the New Report Wizard. You will be prompted to select a record type, query, and report format to apply to the report. Once created, the report is saved within the user's workspace for later use.
Please refer to Section 3.1.3 of this document for details on how reporting in the ClearQuest Client for Eclipse differs from the ClearQuest native client.
Before installing the Rational ClearQuest Client for Eclipse, the Rational ClearQuest basic application must be installed and configured properly. If necessary, consult ClearQuest product documentation for installation and configuration details. You must have a current Rational ClearQuest license to configure and run the basic application.
In order to install the Rational ClearQuest Client, you must have a compatible Eclipse installation (Eclipse 3.0 or greater, or a Rational Software Development Platform product). If you are not using a Rational Software Development Platform product, you must also install the Eclipse Modeling Framework (EMF) installed. You can install EMF using the following steps:
- Start Eclipse
- Click on Help->Software Updates...->Find and Install
- Select "Search for new features to install", and click Next
- Expand the Eclipse.org update site, and select "EMF SDK 2.0.0 (EMF + SDO + XSD)", and click Next
- Select the feature "Eclipse Modeling Framework (EMF)" version 2.0.0, and click Next
- Accept license terms, and click Next
- Click Finish to install
For more information, refer to the EMF portion of Eclipse.org (http://www.eclipse.org/emf/).
You can install the integrated Rational ClearQuest Client in two different ways: by connecting to a publicly available IBM Rational Update Manager Web site or from a locally installed Eclipse Update Manager site.
Installing Rational ClearQuest Client for Eclipse from a publicly available IBM Rational Eclipse Update Manager Web site
- In any Eclipse perspective, click Help > Software Updates > Find and Install.
- In the Install/Update window, select Search for new features to install. Click Next. (Rational Software Development Platform products will have the necessary update site already listed, and may proceed to step 5.)
- In the Install window, click New Remote Site.
- In the New Update Site window, type a name for the update site you are creating, such as Rational ClearQuest.
- In the URL field, type the Web address that provides access to the Rational ClearQuest Client for Eclipse code: http://www3.software.ibm.com/ibmdl/pub/software/rationalsdp/clearquest/60/update/
- Click OK to create the update site listing.
- Select the check box next to the site name (such as Rational ClearQuest). If there is more than one installable feature available at the update site, click the plus sign next to the site name to list all the features.
- Select Rational ClearQuest as the feature you wish to install. Click Next.
- In the Search Results window, select the latest installable version, then click Next to continue.
- When the Feature License window is displayed, read the licensing information, then select I accept the terms in the license agreements. Click Next to continue.
- In the Install Location window, click Add site, then select a location where the Rational ClearQuest Client for Eclipse application will be installed. Click Finish to continue.
- In the Feature Verification window, click Install to begin downloading the Rational ClearQuest Client for Eclipse files.
- After the installation is complete, Eclipse displays the following message: You will need to restart Eclipse for the changes to take effect. Would you like to restart now? If you are adding or updating other features, click No and install or update the next feature. If you have completed all feature installs, click Yes.
Installing Rational ClearQuest Client for Eclipse from a locally installed Eclipse Update Manager site
The integrated Rational ClearQuest Client for Eclipse is available for download from either the IBM Rational Software Support home page or from Rational developerWorks. To download the client, visit the following URL, click the ClearQuest Plug-ins link and then click the Rational ClearQuest Client for Eclipse link: http://www.ibm.com/developerworks/rational/library/1376.html. You can also go to the Rational Software Support home page (http://www.ibm.com/software/rational/support/) and search for "ClearQuest Client for Eclipse" to find the Eclipse client download. Click on the Downloads option below the search box to limit the number of search results returned. On the download Web page, a copy of the Eclipse Update Manager site is available as a zip file. This can be used to host a standalone Eclipse Update Manager site.
- Download the CQEclipseClient_6_14_0.zip file
- Extract the zip file to a directory on a single user machine or on a network accessible file share for access by multiple users.
- In any Eclipse perspective, click Help > Software Updates > Find and Install.
- In the Install/Update window, select Search for new features to install. Click Next.
- In the Install window, click New Local Site.
- Browse to the location where you extracted the CQEclipseClient_6_14_0.zip file and select the directory containing the site.xml file. Click OK.
- Select the check box next to the site name just added. If there is more than one installable feature available at the update site, click the plus sign next to the site name to list all the features.
- Select Rational ClearQuest as the feature you wish to install. Click Next.
- In the Search Results window, select the latest installable version, then click Next to continue.
- When the Feature License window is displayed, read the licensing information, then select I accept the terms in the license agreements. Click Next to continue.
- In the Install Location window, click Add site, then select a location where the Rational ClearQuest Client for Eclipse application will be installed. Click Finish to continue.
- In the Feature Verification window, click Install to begin downloading the Rational ClearQuest Client for Eclipse files.
- After the installation is complete, Eclipse displays the following message: You will need to restart Eclipse for the changes to take effect. Would you like to restart now? If you are adding or updating other features, click No and install or update the next feature. If you have completed all feature installs, click Yes.
Hardware
- Disk space: Installed product requires 500 MB
- Memory: 256 MB
- CPU: 500 MHz
Software
- Operating systems:
- Windows 2000 Professional (SP 4)
- Windows XP Professional (SP1 or SP2)
- Windows 2003 Server
- RedHat Enterprise Linux(R) 3.0 Workstation - using the GTK version of Eclipse
- SUSE(R)Linux Enterprise Server 9 (SLES) - using the GTK version of Eclipse
- Eclipse application:
- Eclipse development platform 3.0 or greater (Eclipse 3.0.1 recommended)- Rational Software Development Platform
In order to improve responsiveness of the Eclipse application, increase the amount of memory allocated to Eclipse. For example, to enable Eclipse to use a maximum of 256 MB of RAM, simply add this parameter to eclipse.exe: -vmargs -Xmx256m.
To use the Rational ClearQuest Client for Eclipse on a Linux system, run the Rational ClearQuest setup shell prior to starting Eclipse. When starting Eclipse, if you see the message IBM Rational ClearQuest is either not installed or not configured properly, check to make sure the ClearQuest setup shell is active. By default, the setup shell is located in /opt/rational/clearquest/cq_setup.sh. When using the IBM JRE version 1.4.2 with this product, specify the arguments -vmargs -Xj9 when starting Eclipse. Refer to the readme file that accompanies the IBM JRE for more information.
Creating or modifying dynamic choice lists is not supported.
The ClearQuest Client for Eclipse uses a different set of defaults for the Submit record action. Changes to the defaults in the ClearQuest Client for Eclipse are not to the defaults in the ClearQuest native client, and vice-versa.
Reports and Charts are not fully supported:
- Creating charts is not supported.
- Running charts or reports with dynamic filters is not supported.
- You can create copies of reports and charts, but not report formats.
- You can copy and paste a folder containing report formats, but saving the pasted report formats is not supported.
- You can not run a unsaved report
- Only one startup chart and one startup report may be executed during a login. Multiple startup charts/reports are not supported.
Performing a batch update of records that includes mixed record types is not supported. The workaround is to select only one type of record when performing a batch update.
ActiveX and Picture form controls are not supported. This limits certain capabilities such as custom ActiveX controls and integrations with other Rational products like ClearCase UCM change set control.
Full MultiSite function is not supported. You cannot change the mastership of a workspace object such as a folder, query, chart, report or report format.
- Report and chart execution are disabled on Linux.
- Printing is not supported on Linux.
- Use of the product on SuSE Enterprise Linux 9 while logged in as the root account is unsupported. Doing this will result in a crash.
Once a query is converted to a SQL query, clicking the columns titles does not sort the results.
Printing is currently not supported for form values listed in a radio button control. Data fields which are grouped together are not being printed.
3.1.10 Query default display fields and filters are not shared with the Native client
Query default display fields and filters set in the ClearQuest Client for Eclipse are not used by the Native client. However, the default display fields and filters are shared with ClearQuest Web Java (CQWJ).
3.1.11 Email notification rules are not cached
Email Rule caching is disabled in the ClearQuest Client for Eclipse.
Drag and drop of queries or workspace objects between different Rational ClearQuest connections in the Query Navigator view is not supported.
If a record script alias is executed and fails, and the scripting language is Perl, an exception results. Record scripts written in Visual Basic do not have this problem.
- The open attachment function allows you to read an attachment within Eclipse. To modify an attachment, you must save the attachment to your local file system, delete it from the record, modify it locally, and then add it back to the record.
- Do not open an attachment file that is not compatible with your current operating system. For example, some files with a Linux extension cannot be opened in Microsoft Windows. If you attempt to open an incompatible file, you will see an error message such as "Problems opening editor" and/or "The file does not exist."
- If a record is set to read-only, modifications are not allowed, including adding an attachment. In the Query Results view, however, Add Attachment is still shown as a valid action. You should not try to add an attachment to a read-only record.
- Deleting two or more record attachments at once from the Query Results view will not auto refresh the attachment tree node in Results view even though they are successfully deleted.
- If you open an attachment more than once, the add attachment and delete attachment buttons sometimes become disabled. If this occurs, select a different record and then re-select the original record.
- If you currently have a file attachment open in an editing application, do not try to add the file as an attachment. This may cause Eclipse, or your editing application, to crash. Save and close the file before attaching it to a record.
- When modifying a record in details view and attempting to save an attachment, then canceling that save, will prevent a record in Modify state from being committed. The modify action should be discarded and the record re-modified, if this occurs.
- Record attachments should not use a name identical to that of any file in the Eclipse root folder (for instance, notice.html). If such a filename is used, the user will not be able to save or open that attachment.
Errors may occur during uninstall which prevent a proper removal of the ClearQuest Client. To avoid these errors, close the ClearQuest perspective and disable the ClearQuest feature prior to uninstalling the ClearQuest feature.
There is a known bug in Eclipse 3.0 which sometimes prevents Eclipse from automatically restarting after installing the ClearQuest Client. The workaround is to restart Eclipse manually, either by double-clicking eclipse.exe in the directory where Eclipse is installed, or using the Eclipse desktop shortcut, if you created one.
When you uninstall the Rational ClearQuest Client for Eclipse, a dialog may be displayed with the following error message: The current configuration contains errors and this operation can have unpredictable results. Do you want to continue?. You can ignore this error and click OK to continue uninstalling.
When using MultiSite, if you set a remotely mastered personal workspace object (such as a query or chart) to run at startup, an error occurs. The workaround is to set the object to run at startup again. The operation should be successful when re-executed.
If a SQL query has column titles of the same name, then the data shown in the columns will have the same values. The workaround is to execute a parameterized version of the query.
When editing Eclipse preferences, if the Team node does not appear, then Team capability needs to be enabled. To do this, in the Preferences dialog, go to Workbench > Capabilities and enable ClearQuest Defect and Change Tracking capability, which will also enable Team activity.
If the OK button is not enabled even though all required data is entered, move the input focus to another field. This only occurs when the final field in which data was entered was a required field, as validation is checked after a user leaves that field.
- The default Linux font sizes can render the labels in ClearQuest dialogs too large, which results in the labels being truncated. The workaround is to decrease the Linux desktop application font size.
- Dialogs containing group boxes with labels sometimes exhibit incorrect positioning of controls, which results in truncated form controls. The workaround is to update the ClearQuest schema and remove the label on the group box.
- When running on Red Hat Enterprise Linux 3.0, items displayed in the Query Results view cannot be expanded or collapsed by clicking on the plus sign icon. The workaround is to right-click and then use the context sensitive menu to select Expand Selected, or use the Collapse All toolbar button.
- Using the creator tool item menu option during the execution of multiple large queries is not recommended.
- E-mail options are not saved on Linux.
- When using the combo box control on Linux, user-entered values that do not match the values already present in the choice list are discarded when the user tabs out of the control.
Due to a known problem with Rational ClearQuest and a known limitation of Eclipse, when a large number of records are retrieved for a reference field query filter or control, Eclipse ceases to operate properly (hangs).
Use the Window > Reset perspective menu option to eliminate this error message.
The database connection and license locked for a ClearQuest database are not released upon logout if reports are manipulated. To release the database connection and license, restart the Eclipse workbench.
Performing ClearQuest actions during startup object execution may cause exceptions to occur. To avoid these exceptions, wait for the startup object execution to finish before performing ClearQuest actions.
If a multiline field is included in the Query Result view, user cannot sort that field by clicking the column title.
If the 1st column of the query result view is not the unique key of the record(for example, id for defects), then deleting a record from the query result list will not mark that record "deleted" and all the actions are not disabled for that record. Refresh the list will remove the deleted record.
3.2.16 Eclipse integration
Users should not create a record using Eclipse client integration without first connecting to a database. The user may do this either by logging in as normal, or by choosing the ClearQuest > New ClearQuest record... context menu option. Attempting to submit a record using the context menu option New <record type> using <database>... without being connected to any database will result in an error. If this occurs, the workbench should be restarted.
Launching a second workbench while another workbench is already running is not recommended. It may cause some of the following problems:
- One of the workbenches will have its navigator view disabled.
- Running a query in one will display the result in the other workbench's view.
- On Linux, closing the second workbench will cause the first workbench to be closed as well.
3.2.18 Chart set to run at startup may result in workbench crash while logging into a database
In some cases, a particular startup chart may cause the workbench to crash during login. If this occurs, modify the chart to not run during startup.
3.2.19 Running some reports may result in a workbench hang
Certain reports may cause the workbench to hang (become non-responsive).
3.2.20 Email notification of submitted records requires a prior query to be run
Email notification may not occur on submitted records if a query has not yet been run on the current database. If this occurs, run any query on the database before submitting a record.
3.2.21 Submitting an email rule may result in a crash
Email rules cannot be submitted on Linux using the Rational ClearQuest Client for Eclipse. They can be submitted on Windows; however, the Filter Query option within an email rule cannot be used. If problems occur, use a different ClearQuest client to submit an email rule.
To provide feedback on the Rational ClearQuest Client for Eclipse beta, or to submit a problem or issue, use the Feedback link on the beta Web page.
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of LicensingFor license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia CorporationThe following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (I) the exchange of information between independently created programs and other programs (including this one) and (II) the mutual use of the information which has been exchanged, should contact:
IBM CorporationSuch information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.
IBM, Rational and ClearQuest are trademarks of International Business Machines Corporation in the United States, other countries, or both.
Microsoft, Windows, ActiveX and Visual Basic are either registered trademarks or trademarks of Microsoft Corporation in the United States, other countries, or both.
Red Hat is a trademark of Red Hat Incorporated in the United States, other countries, or both.
Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
SUSE is a registered trademark of SUSE LINUX AG, a Novell company, in the United States, other countries, or both.