Copyright © 2001 Rational
Software and its subsidiaries. All rights reserved.
Version 2001A.04.20
Updated
08/21/2001 4:36 PM
Thank you for choosing Rational
ClearQuest®!
Please read this document to learn about new features, known product issues,
important tips, and other Rational ClearQuest product information.
1. | Supported Hardware and Software Platforms ................................................................... | 3 | |||
2. | What's New ................................................................................................................. | 4 | |||
2.1 | What's New in Rational ClearQuest v2001A.04.20 3 ............................................ | 4 | |||
2.11 | Rational ClearQuest MultiSite ....................................................................... | 4 | |||
2.1.2 | Rational ClearQuest UNIX (v2001A.04.20) ...................................................... | 5 | |||
2.2 | What was new in Rational ClearQuest v2001A.04.00 .......................................... | 5 | |||
2.2.1 | Rational ClearQuest Security Enhancements .................................................. | 6 | |||
2.2.2 | Web Enhancements .................................................................................... | 6 | |||
2.2.3 | Integration with Microsoft Project 2000 .......................................................... | 6 | |||
2.2.4 | Miscellaneous Improvements ...................................................................... | 7 | |||
3. | Upgrading from Previous ClearQuest Releases ............................................. | 7 | |||
3.1 | Upgrading from v2001A.04.00 ...................................................................... | 7 | |||
3.1.1 | Database Upgrades to v2001A ..................................................................... | 7 | |||
3.1.2 | Client Upgrades to v2001A.04.20 .................................................................. | 7 | |||
3.1.3 | Installing with other Rational v2001A.04.00 Products ....................................... | 7 | |||
3.2 | Upgrade Overview ......................................................................................... | 8 | |||
3.2.1 | Upgrading from Rational ClearQuest v2001 ...................................................... | 9 | |||
3.2.2 | Upgrading from Rational ClearQuest v2000 (Including Patch Releases) .............. | 9 | |||
3.2.3 | Upgrading from Rational ClearQuest v2.0 (Including Patch Releases) ................. | 10 | |||
3.2.4 | Upgrading from Rational ClearQuest v1.0 or v1.1 (Including Patch Releases) .... | 10 | |||
3.3 | Applying Patches to this Release ................................................................ | 10 | |||
3.3.1 | Applying Patches to Rational Suite v2001A.04.00 After Upgrading to Rational ClearQuest v2001A.04.20 ............................................................... | 11 | |||
3.3.1.1 | Rational Suite Patch v2001A.01.293.012 ...................................................... | 11 | |||
4. | ClearQuest MultiSite Tips and Workarounds .................................................. | 11 | |||
4.1 | Installing the Rational Shipping Server .......................................................... | 11 | |||
4.1.1 | Reinstall Required When ClearCase/MultiSite or the Rational Shipping Server Are Uninstalled ................................................................................................... | 12 | |||
4.2 | Using ClearQuest Product Integrations in a MultiSite Deployment ..................... | 12 | |||
4.2.1 | ClearQuest/ClearCase Integrations ................................................................. | 12 | |||
4.2.1.1 | ClearQuest MultiSite Requires UCM Package Version 3.0 ................................ | 12 | |||
4.2.1.2 | Multiutil Does Not Run on Machines that Run the ClearCase/ClearQuest UCM Integration | 12 | |||
4.2.1.3 | Must Kill cqintsrv Process Prior to Running mkreplica -export................................................................................................... | 12 | |||
4.2.2 | Other Integrations including Rational RequisitePro, Rational Test Manager, Rational Administrator, Rational PQC, Microsoft Project and Microsoft Visual Source Safe .................................................................................................... | 12 | |||
4.3 | User/Group Subscription Problems with ClearQuest MultiSite .......................... | 12 | |||
4.3.1 | Issues When All Databases are Not Replicated to All Sites (RAMBU000019099) .................... | 12 | |||
4.3.2 | Adding a User Database that will be Replicated ................................................. | 13 | |||
4.4 | Duplicate Named Objects .............................................................................. | 13 | |||
4.4.1 | Can't Rename Groups (RAMBU0016001) ......................................................... | 13 | |||
4.5 | Managing Users and Groups with MultiSite ...................................................... | 14 | |||
4.5.1 | Transferring Mastership of a User or Group ....................................................... | 14 | |||
4.5.2 | Adding a User Not Mastered at Your Site to a Group ........................................... | 14 | |||
4.6 | Multiutil with SQL Server Database containing > 10 Attachements Requires MDAC 2.6 .................................................................................. | 14 | |||
4.7 | Recovering from a mkreplica-export Failure ...................................................... | 14 | |||
4.7.1 | Unlock the Schema Repository and User Database ......................................... | 14 | |||
4.7.2 | Subsequent multiutil Commands Fail .......................................... | 15 | |||
4.8 | Restoring the Multiutil Database Set Information Following a ClearQuest Uninstall and Reinstall ................................................................................................ | 15 | |||
4.9 | Allocating Record lds When Adding Large Numbers of New Records ............ | 16 | |||
4.10 | Circular Duplicate References (RAMBU000018831) ....................................... | 16 | |||
5. | ClearQuest Tips and Workarounds ............................................................... | 16 | |||
5.1 | Correctly backing up ClearQuest databases .................................................. | 17 | |||
5.2 | Unified Change Management (UCM) Documentation ........................................ | 17 | |||
5.3 | ClearQuest with SQL Server .......................................................................... | 17 | |||
5.3.1 | SQL Server 2000 Installation .......................................................................... | 17 | |||
5.3.2 | Use of SQL Server 7.0 Service Pack 2 or SQL Server 2000 with Certain Rare Database Schemas .................................................................................... | 17 | |||
5.4 | ClearQuest with Oracle .................................................................................. | 17 | |||
5.4.1 | Oracle Database Connection Options ............................................................... | 17 | |||
5.4.2 | 'Contains' Searches are Always Case Sensitive ................................................ | 18 | |||
5.4.3 | Searching Multi-line Text Fields ...................................................................... | 19 | |||
5.4.4 | InterMedia may Require Revoking cxtadmin role ................................................ | 19 | |||
5.5 | Network Installations ...................................................................................... | 19 | |||
5.6 | Versions of ClearQuest prior to v2001.03 with MDAC 2.5.1 or Later ...................... | 19 | |||
5.7 | Debugging E-mail Notification Issues ................................................................. | 19 | |||
5.8 | Submit Date Hook (RAMBU14985) ................................................................... | 20 | |||
5.9 | Security Settings for Terminal Servers .............................................................. | 20 | |||
6. | Troubleshooting Web Services ......................................................................... | 20 | |||
6.1 | Basic Troubleshooting Tips .............................................................................. | 20 | |||
6.1.1 | Configuring IIS to work with the Anonymous User ID ........................................... | 20 | |||
6.1.2 | IIS Server (inetinfo.exe) Crash .......................................................................... | 21 | |||
6.2 | Advanced Troubleshooting Tips ........................................................................ | 21 | |||
6.2.1 | Incorrect permissions on the ClearQuest Registry Keys ...................................... | 21 | |||
6.2.2 | Incorrect Permissions on the Cache Directory .................................................... | 21 | |||
6.2.3 | Single Network Domain for SQL Server Database and ClearQuest Web Server ..... | 21 | |||
6.2.4 | Changing Script Time Out Limit ........................................................................ | 22 | |||
6.3 | Web Performance and Recommended Configurations ......................................... | 22 | |||
7. | Known Defects ............................................................................................... | 22 | |||
8. | Fixed Defects ................................................................................................. | 23 | |||
9. | Subscribing to the ClearQuest User Group ......................................................... | 23 | |||
10. | Accessing the Sample Hooks Database ............................................................ | 23 | |||
11. | Contacting Rational Technical Support ............................................................... | 23 |
Platform Software Version Operating Systems |
32-bit Note: Rational ClearQuest
is no longer supported running on Windows 95. |
Hardware Requirements | Intel 32-bit 233 MHz or higher Pentium-compatible computer Hard Drive containing system files: 43 MB (default drive is C) Hard Drive where ClearQuest is installed: 141 MB RAM Client Machines: Windows/98: 64MB Windows/NT: 128MB Windows 2000: 128MB RAM ClearQuest Administrator Machine: 256 MB RAM Web Server Machine: 1 GB Monitor Resolution: 1024x768 |
Terminal Servers | Windows
2000 Citrix MetaFrame 1.8 |
Web Browsers |
Internet Explorer
4.01 (4.72.3110.8 recommended) Note: Netscape 6 is not supported at this time. Various issues have been discovered involving a number of buttons and controls that do not operate properly with the new version of Netscape. ClearQuest may support Netscape 6 in a future release. |
Web Servers | IIS 5.0, 4.0 |
Web Clients on Non-Windows Platforms | Netscape
4.7 running on Solaris 2.5.1, Solaris 2.6, Solaris 7, Solaris 8 HP-UX 10.20, or HP-UX 11.00 |
Microsoft Office | Microsoft
Office 97 Service Release 2 Microsoft Office 2000 Service Release 1 |
ClearQuest-only Databases | Microsoft
Access 2000 Sybase SQLAnywhere 5.5.05 |
ClearQuest and ClearQuest MultiSite Databases | Microsoft
SQL Server 6.5 Service Pack 5 Microsoft SQL Server 7.0 Service Pack 2 Microsoft SQL Server 2000 Oracle 7.3.4 on Windows NT, Windows 2000, Solaris, and HP-UX Oracle 8.0.5 on Windows NT, Windows 2000, Solaris, and HP-UX Oracle 8.1.5 on Windows NT, Windows 2000, Solaris, and HP-UX Oracle 8.1.6 on Windows NT, Windows 2000, Solaris, HP-UX, and Redhat Linux Oracle 8.1.7 on Windows NT, Windows 2000, Solaris, HP-UX, and Linux IBM DB2 6.1 on Windows NT, Windows 2000 IBM DB2 7.1 on Windows NT, Windows 2000 |
Database Drivers | Windows
NT with MDAC 2.5 Windows 2000 with MDAC 2.5, 2.5.1, and 2.6 Note: MDAC 2.5 or greater is required to run Rational ClearQuest. If no version or an earlier version of MDAC is present, then MDAC 2.5 will be installed. |
Language Support | Dutch (Level
1) French (Level 2) German (Level 2) Hebrew (Level 1) Italian (Level2) Japanese (Level 2) Korean (Level 1) Simplified Chinese (Level 2) Swedish (Level 2) Traditional Chinese (Level 1) |
Since this new version of
ClearQuest (v2001A.04.20) is following so closely behind v2001A.04.00, this
Release note includes information on both releases. Rational ClearQuest v2001.04.00
was a ClearQuest only release and v2001.04.20 includes both ClearQuest and ClearQuest
MultiSite.
Based on the proven technology in Rational ClearCase MultiSite, ClearQuest MultiSite is an optional add-on solution for Rational ClearQuest that supports synchronous development efforts across geographically distributed sites. Rational ClearQuest MultiSite helps geographically distributed project teams to work together efficiently by providing local access to replicated defect and change tracking data, and enabling automatic synchronization of those databases at any time. Note that aside from a few new fields related to the MultiSite capabilities, the interface is unchanged - it's the same ClearQuest that's used by thousands of customers every day. When combined with Rational ClearCase® and ClearCase MultiSite, it provides a complete, distributed change management solution that includes support for the classic ClearCase - ClearQuest integration as well as Unified Change Management (UCM).
Support for data replication
ClearQuest MultiSite
enables replication of schema repositories and user databases across multiple
geographic locations. This lets remote sites access local up to date copies
of ClearQuest data without any performance or feature penalties.
Support for data synchronization
ClearQuest MultiSite
enables automated synchronization of changes between replicated databases. This
ensures that all user databases are updated with any modifications made to defects
or other types of change requests since the last update. Synchronization can
be scheduled to occur automatically at predefined intervals using your choice
of scheduling tools, and can also be initiated manually.
Support for record mastership
In order to ensure data integrity, ClearQuest MultiSite supports site-based
mastership of defects and other change requests. This means that only users
of the database with mastership of a given record can modify that record. Records
are accessible on a read-only basis for sites that do not have mastership, and
mastership can be easily transferred from one site to another at any time.
Administration
All ClearQuest
MultiSite replication and synchronization functions are managed through a Windows-based
command line interface (CLI). This includes initiating and monitoring replications
and synchronizations, as well as performing import/export functions and providing
status updates. To ensure no data is ever lost or corrupted, the administration
tool also provides error-recover functionality.
Platform support
While administrative
and synchronization functionality is restricted to the Windows CLI, client functionality
for ClearQuest MultiSite is available on all the platforms ClearQuest already
supports, including Windows, UNIX, and the Web.
Database support
ClearQuest MultiSite
supports Microsoft SQL Server, IBM DB2, and Oracle. Note that ClearQuest MultiSite
does not support Microsoft Access or Sybase SQLAnywhere.
Product installation
ClearQuest MultiSite
uses the Rational Suite® installation tools.
Licensing
A separate license
is required for ClearQuest MultiSite users. Each time a user logs into a replicated
database, both a ClearQuest and a ClearQuest MultiSite license are consumed.
ClearQuest MultiSite supports both node-locked and floating licenses. Standard
Rational licensing mechanisms are used.
Documentation
Administrating Rational ClearQuest MultiSite Manual - Used by ClearQuest
MultiSite administrators, this manual includes information on how to set up
replicas, perform synchronization tasks, deal with errors, and so on. It also
includes an analysis of implementation architectures. In addition to the printed
copy, this information is available through online help in a context-enabled
mode.
In addition to the new security enhancements documented below in section 2.2, ClearQuest UNIX v2001A.04.20 adds the following support:
The latest release of ClearQuest significantly improves the security model. This is achieved on two levels. First, specific defects and other change requests in ClearQuest can be hidden based on group membership. Second, Super User privileges are no longer required to perform certain administrative tasks.
Ability to Hide Change
Request Records
Enables certain defects and other types of change request records to be hidden
from specific users based on what group those users belong to. By enabling any
reference field to be a security context field, ClearQuest will hide certain
change requests from specified groups of users.
Ability to Administer
Dynamic Choice Lists
A new privilege, called Dynamic Choice List Administrator, enables creation
and modification of dynamic choice lists. This includes the ability to add,
delete, and modify entries in dynamic choice lists.
Ability to Administer
Public Queries Folder
A new privilege, called Public Folder Administrator, enables specific users
to manage the public folder. This enables certain users to move queries, charts,
report formats and reports to the public folder without Super User privileges.
New User Privilege to
View and Edit SQL Code
This privilege allows users to view and edit the SQL code that is generated
for queries. Users without this privilege can view but cannot modify the SQL
code.
Ability to Administer
Security at a Site
This privilege is related to the ability to hide change request records based
on user group membership. Users with the Security Administrator privilege can
view all data in a database since the security checks are not enabled for users
with this privilege. This enables the administrator to grant one or more users
in a specific group access to all data in the system, even if other members
of that group are restricted from viewing certain records in the database. However,
this user is not allowed to add new users or update the schema.
Easier Email Notification
Setup
Email notification can now be set up from the Web interface instead of having
to manually create registry entries. From Edit Web Settings, users can input
all relevant data to enable either MAPI or SMTP email notification mechanisms.
Ability to Pick Query
at Start-up
Queries can be selected from the Web interface as start-up queries so that the
results set is automatically displayed as soon as users log in to ClearQuest.
Start-up queries can be selected by editing the user profile.
Support for Multiple
Schema Repositories
ClearQuest Web now supports multiple schema repositories so that a single Web
server can be used to serve many schema repositories. Users can select a schema
repository from the log in screen. Once the schema repository is selected, the
end user can select from an appropriate list of user databases.
Ability to View and Edit
SQL Code Associated with a Query
ClearQuest Web allows specific, authorized users to view and edit the SQL code
that is generated for queries. By right clicking on the query in the workspace
from the Advanced Query Editor, users can view and modify the SQL code for that
query.
Rational ClearQuest now provides integration with Microsoft Project 2000. This is enabled through Rational ClearQuest Project Tracker, a Microsoft Project 2000 add-in. It provides integration with ClearQuest; by creating a two-way association between project plan tasks in Microsoft Project 2000 and defects (and/or other change requests) in ClearQuest.
With Rational ClearQuest Project Tracker, tasks can be exported from a Microsoft Project 2000 project plan to automatically create new database records in Rational ClearQuest. The tasks are automatically linked with these new database records. Corresponding tasks and records can then be synchronized, so that changes made in one system are automatically reflected in the other.
Records can also be imported
from Rational ClearQuest to create new project plan tasks in Microsoft Project
2000. These records and tasks are also linked and can continue to be synchronized
at periodic intervals. In this way, progress reported in Rational ClearQuest
can be transferred automatically to Microsoft Project 2000, so that a project
manager can always update the project plan with the most accurate and up-to-date
information. Documentation is provided in soft copy form.
Integration with Rational
SoDA
In order to offer ClearQuest customers another reporting option, (in addition
to Crystal Decisions Crystal Reports) integration with Rational SoDA® has
been added to this release. Users can choose to run a SoDA report directly from
the ClearQuest menu. SoDA provides two out of the box templates, including "AllDefectsInthisState"
and "AllDefectsBythisOwner". In both cases the user is prompted to
enter the specific state or owner to be reported on. Using SoDA, administrators
can edit the existing templates or add new ones.
Upgrade Improvements
Rational ClearQuest now upgrades schema repositories and user databases more
efficiently, reducing the upgrade time.
Downward Compatibility
Rational ClearQuest now supports downward compatibility between different releases
of the product. This enables users to upgrade to a newer version of the product
in a staged manner by first upgrading all the client machines to the new version
and then upgrading the databases.
Note: If taking advantage of ClearQuest integrations with ClearCase or Rational Suite, some additional steps are required. See the Installing Rational ClearQuest manual for details.
Terminal Server Support
ClearQuest can now be run on a terminal server machine (Citrix or Windows Terminal
Server). Other clients can then connect to the terminal server and use ClearQuest.
Database Support
Rational ClearQuest's database support has been extended to include Oracle 8.1.7
(Windows and UNIX) and IBM DB2 7.1 (on Windows).
In order to use either ClearQuest
MultiSite or the new security features introduced in v2001A.04.00 your database
must be upgraded to the v2001A level. If you upgraded your database when you
installed v2001A.04.00 then your database is ready to support these features
and another upgrade is not required.
The ClearQuest clients must
be at the v2001A level in order to work with a 2001A database. Because this
new release contains several client enhancements that improve the user experience
when working in a ClearQuest MultiSite deployment, if you intend to use ClearQuest
MultiSite, Rational recommends that you upgrade all of your clients (Windows,
UNIX, and Web Server) to v2001A.04.20 as soon as possible. You may run with
both 2001A.04.00 and 2001A.04.20 clients during the transition period.
If you install Rational ClearQuest v2001A.04.20 on a machine that already has Rational v2001A.04.00 products, the Rational Installer will give the following warning:
Upgrade Compatiblity
Setup has detected the follwoing older Rational products on your system. Rational products share many components. If you continue with this installation, Setup will upgrade all shared compents, and some of the products listed below may no longer work.
This warning should be ignored.
Rational ClearQuest v2001A.04.20 has been tested and confirmed to work correctly
with v2001A.04.00 Rational products.
In order to upgrade to ClearQuest v2001A, there are two things you need to consider. First, do you intend to use the new security model or ClearQuest MultiSite? If you intend to use either of these features, you are required to upgrade your schema repository and all of the user databases. Secondly, if you have enabled integrations with other Rational tools such as Rational ClearCase or Rational Requisite Pro or Rational Robot, you are not required to upgrade your schema repository but you must install new packages in order to continue using the integrations. Please refer to the Installing Rational ClearQuest manual for detailed information on performing upgrades and installing new packages.
NOTE: The latest information on upgrading your databases can be found in Rational Technical Support TechNote 17185.
NOTE: v2001A.04 clients must be used to accessing v2001A.04 upgraded schema repositories and user databases.
A typical upgrade cycle
would comprise some of the following steps:
Administrator:
Client:
In order to upgrade to ClearQuest v2001A, there are two things you need to consider. First, do you intend to use the new security model or ClearQuest MultiSite? If you intend to use either of these features, you are required to upgrade your schema repository and all of the user databases. Secondly, if you have enabled integrations with other Rational tools such as Rational ClearCase or Rational Requisite Pro or Rational Robot, you are not required to upgrade your schema repository but you must install new packages in order to continue using the integrations.
Upon invoking ClearQuest for the first time, you will need to connect to the ClearQuest databases again. Get the database location and connection information from your ClearQuest Administrator, and enter it when prompted.
In order to upgrade your databases, you must follow the instructions listed in the Installing Rational ClearQuest manual.
It is possible to inter-operate between releases ClearQuest v2001.03 and ClearQuest v2001A.04 (i.e. for some clients to have ClearQuest v2001.03 installed while others have ClearQuest v2001A.04 installed), however this is not recommended for the following reasons:
When using Oracle databases,
any operation involving exporting the schema or schema repository will not work
if the export is done from ClearQuest v2001 or v2001A and the import is done
on ClearQuest v2.0 or ClearQuest v2000. This is because the specification for
Oracle databases has changed from "Oracle7" to "Oracle"
in the text files created by these tools. ClearQuest v2001 and ClearQuest v2001A
support either format, but ClearQuest v2.0 and ClearQuest v2000 do not.
In order to upgrade to ClearQuest v2001A, there are two things you need to consider. First, do you intend to use the new security model or ClearQuest MultiSite? If you intend to use either of these features, you are required to upgrade your schema repository and all of the user databases. Secondly, if you have enabled integrations with other Rational tools such as Rational ClearCase or Rational Requisite Pro or Rational Robot, you are not required to upgrade your schema repository but you must install new packages in order to continue using the integrations.
Upon invoking ClearQuest for the first time, you will need to connect to the ClearQuest databases again. Get the database location and connection information from your ClearQuest Administrator, and enter it when prompted.
In order to upgrade your
databases, you must follow the instructions listed in the Installing Rational
ClearQuest manual.
It is possible to inter-operate between releases ClearQuest v2000 and ClearQuest
v2001A.04 (i.e. for some clients to have ClearQuest v2000 installed while others
have
ClearQuest v2001A.04 installed), however this is not recommended for the following reasons:
When using Oracle databases, any operation involving exporting the schema or schema repository will not work if the export is done from ClearQuest v2001 or v2001A and the import is done on ClearQuest v2.0 or ClearQuest v2000. This is because the specification for Oracle databases has changed from "Oracle7" to "Oracle" in the text files created by these tools. ClearQuest v2001 and ClearQuest v2001A support either format, but ClearQuest v2.0 and ClearQuest v2000 do not.
In order to upgrade to ClearQuest v2001A, there are two things you need to consider. First, do you intend to use the new security model or ClearQuest MultiSite? If you intend to use either of these features, you are required to upgrade your schema repository and all of the user databases. Secondly, if you have enabled integrations with other Rational tools such as Rational ClearCase or Rational RequisitePro or Rational Robot, you are not required to upgrade your schema repository but you must install new packages in order to continue using the integrations.
Upon invoking ClearQuest for the first time, you will need to connect to the ClearQuest databases again. Get the database location and connection information from your ClearQuest Administrator, and enter it when prompted.
In order to upgrade your databases, you must follow the instructions listed in the Installing Rational ClearQuest manual.
It is possible to inter-operate between releases ClearQuest v2.0 and ClearQuest v2001A.04 (i.e. for some clients to have ClearQuest v2.0 installed while others have ClearQuest 2000 or ClearQuest v2001A.04 installed), however this is not recommended for the following reasons:
When using Oracle databases, any operation involving exporting the schema or schema repository will not work if the export is done from ClearQuest v2001 and ClearQuest v2001A and the import is done on ClearQuest v2.0 or ClearQuest v2000. This is because the specification for Oracle databases has changed from "Oracle7" to "Oracle" in the text files created by these tools. ClearQuest v2001 and ClearQuest v2001A support either format, but ClearQuest v2.0 and ClearQuest v2000 do not.
Customers upgrading from ClearQuest v1.0 or v1.1 should contact Rational Technical Support for assistance.
Patches created for the previous release of ClearQuest v2001A.04.00 such as patch v2001A.04.01.293.012 cannot be applied to this release. If it is necessary to create a patch for this release for this version of ClearQuest (v2001.04.20), it will have a release number greater than v2001A.04.20 such as patch v2001A.04.21.XXX.XXX.
When installing a Rational Suite patch to a machine that has both Rational Suite v2001A.04.00 and this release of ClearQuest (v2001A.04.20), you must be careful not to overwrite the ClearQuest information i.e. do not install the ClearQuest Patch files. Only install patch files for the other Rational Suite products.
The Rational Suite Patch
has fixes for a number of the Rational Suite products. All of the ClearQuest
fixes included in this patch are also included in this release of ClearQuest.
It is not necessary to apply patch v2001A.04.01.293.012 prior to upgrading to
this release. It is not necessary or recommended to apply patch v2001A.04.01.293.012
after upgrading to this release.
Both ClearQuest MultiSite and ClearCase MultiSite use the same store-and-forward components (called the Rational Shipping Server) to transfer update packets. If you are installing ClearQuest MultiSite on a machine where ClearCase or ClearCase MultiSite is already installed, the installation option will deactivate in the ClearQuest installation program. This is to ensure integrity with your ClearCase installation.
Warning: Do not attempt to install the Rational Shipping Server from the Rational ClearQuest CD on a machine that has a ClearCase LT Client installed. If you attempt to do this, an error message will be displayed during the installation process. Consult the following table for installation conditions:
Condition | Action |
If ClearCase or ClearCase MultiSite is not installed on the machine |
Install Rational Shipping Server from the ClearQuest or Rational Suites installation CD. Configure the MultiSite Control Panel for use with ClearQuest MultiSite; see the Rational Administering ClearQuest MultiSite manual. |
If ClearCase MultiSite is already installed on the machine |
The MultiSite Control Panel and Rational Shipping Server are already installed. Configure the MultiSite Control Panel for use with ClearQuest MultiSite; see the Rational Administering ClearQuest MultiSite manual. |
If ClearCase is already installed on the machine | Install the ClearCase MultiSite component from the ClearCase CD; see "Installing the Rational Shipping Server from the ClearCase CD" section on page 55 of the Installing Rational ClearQuest manual. |
If ClearCase LT Server is installed on the machine |
Install Rational Shipping Server from the ClearQuest or Rational Suites Installation CD. Configure the MultiSite Control Panel for use with ClearQuest MultiSite; see the Rational Administering ClearQuest MultiSite manual. |
If ClearCase LT Client is installed on the machine | Do not install the Rational Shipping Server on this machine. |
If you are using ClearCase MultiSite and the Rational Shipping Server on the same computer and uninstall one of those products, the other product is partially uninstalled and stops working. To resolve the problem you must uninstall both products and then reinstall the product that is needed.
ClearQuest and ClearCase both support multisite deployments. The ClearQuest/ClearCase UCM and Base integrations have been enhanced to work in a multisite deployment. Both integrations require the use of ClearCase 4.2.
The ClearQuest UCM package has been enhanced to work in a multisite deployment. If you plan to use ClearQuest MultiSite with the UCM integration you must upgrade your UCM package to the latest version.
Multiutil requires special
dbset names that are not supported by the UCM integration. Please run multiutil
from a machine that does not require the ClearCase/ClearQuest UCM integration.
The ClearQuest Integration Server (cqintsvr) caches information about it's current session. It is important to terminate these processes if they were running during the execution of the first mkreplica -export command on the working schema repository. If this is not done, various error messages will appear on ClearCase operations indicating that the session is no longer valid. This applies to both the Windows and Unix platforms.
Other Integrations including Rational RequisitePro, Rational Test Manager, Rational Administrator, Rational PQC, Microsoft Project, and Microsoft Visual Source Safe have significant restrictions in a multisited deployment. You will not be able to modify ClearQuest records that are not mastered through these integrations. Additionally, there are further restrictions on using the RequisitePro, Test Manager, and Rational Administrator integrations in a multisite deployment. Specifically, if you have mastership of a ClearQuest record, but the associated Rational Project record is not mastered in the same ClearQuest database, these integrations are read-only and you are restricted from making changes to the integration information captured in a ClearQuest record (e.g. adding new requirements to the requirements tab).
The following subsections discuss user records but the same information applies to user group records.
When a user is subscribed to a user database that is not replicated but the schema repository is replicated then the following error will be reported when the ClearQuest administrator opens the user's database subscription form at other sites:
ERROR! An error was detected retrieving information from the ClearQuest database.
There is a reference to an object that does not exist:Object Type: MasterdataObject
Object: 16777399This error was detected at: ClearQuest Core:admasterdatamgr.cpp:2708
Recommendation: If you cannot determine how to resolve this issue, contact Rational Support and provide all the above information as well as a description of the context in which the message occurred.
When you click OK, the user's database subscription form will be displayed showing that they are not subscribed to any user databases even though they are subscribed.
This is a reporting problem only. The user will be able to access all replicas that they are subscribed to at all sites.
The workaround to this problem is to subscribe the user of the un-replicated database to all user databases using the "Subscribe All" option. For more information on user administration please consult the Administering Rational ClearQuest manual.
When adding a new user database at the working schema repository site, Rational recommends that you replicate the new user database prior to subscribing users to it.
The only exception to this rule is when a user(s) is subscribed to all databases. Users that are subscribed to all databases will work fine regardless of the order in which the steps are done.
If users are subscribed to the new database before it is replicated, those users will not be able to login to the new database replica until their database subscription is updated at the working schema repository site.
Mastership restrictions prevent most inconsistencies between replicas, but some inconsistent changes are unavoidable, particularly in the naming of new users, groups and other stateless record types and workspace objects. For example, a new user named jsmith can be created at two or more replicas during the same time period between sychronizations. If this happens, you should rename the conflicting records as soon as possible, see the Managing Replicas chapter in the Administering Rational ClearQuest MultiSite manual.
There is a defect such that once you create a group you cannot change its name or delete it. If you end up with two groups with the same name, the only option is to deactivate both groups and create new groups with unique names.
There are two ways to avoid this problem:
The steps for transferring mastership of a user or group are incorrect in both the Administering ClearQuest MultiSite manual and in the online help. The correct steps to move mastership of these items are as follows:
To add a user not mastered by your site to a group, you must do the following:
If your database is SQL Server v. 2000 or v. 7.0 and if your database contains more than 10 attachments then the machine on which you run multiutil commands must have MDAC 2.6 installed.
Symptom:
When running "mkreplica -import" the following multiutil error occurs:
multiutil: Created the schema repository CQMS.FOO.C
multiutil: Caught an exception. Detailed exception information is: SQLParamData: RETCODE=-1, State=37000, Native Error=170
SQL statement="insert into attachments_blob
(attachments_dbid,entity_dbid,entity_fielddef_id,data) values (?,?,?,?)"
[Microsoft][ODBC SQL Server Driver][SQL Server]Line 1: Incorrect syntax near '?'.
multiutil: This problem may be caused by an old version of MDAC. Please install MDAC 2.6 and try again.
Solution:
Install MDAC 2.6 on the machine that runs multiutil command. To install MDAC
2.6 go to the ClearQuest installation directory (default location is C:\program
files\rational\clearquest) and run mdac_typ-2.6.
If a mkreplica-export fails, your database may be left in a locked state. You should use the following procedures to resolve these problems or call Rational Technical Support.
installutil unlockschemarepo
db_vendor
server
database
dbo_login
dbo_password
connect_options (for Oracle: HOST=host;SID=sid )
Example: To unlock the SQL_SERVER schema repository database 'test_master_sitea' on server QE_TEST1, use:
installutil unlockschemarepo SQL_SERVER QE_TEST1 test_master_sitea multisite multisite ""
where 'multisite' is the dbo_login and password for the 'test_master_sitea' database.
installutil unlockuserdb
db_vendor
server
database
dbo_login
dbo_password
connect_options (for Oracle: HOST=host;SID=sid )
Example: To unlock the SQL_SERVER user database 'test_user_sitea' on server QE_TEST1, use:
installutil unlockuserdb SQL_SERVER QE_TEST1 test_user_sitea multisite multisite ""
where 'multisite' is the dbo_login and password for 'test_user_sitea'.
If subsequent attempts with mkreplica -export result in messages that indicate that the replica already exists or that another multiutil operation is in progress refer to Rational Technical Support Tech Note 18770 or contact Rational Technical Support.
The ClearQuest MultiSite command line interface, multiutil, uses a unique database set name to access database replicas. When ClearQuest is uninstalled from a machine, the database set information on that machine is removed. When you reinstall ClearQuest the database set information must be recreated in order for the multiutil commands to continue working.
To set the multiutil database set name on machines where you run the multiutil commands, do the following:
set BB_TEST_DBSET_NAME=CQMS.CLAN_NAME.SITE_NAME
The CLAN_NAME and SITE_NAME will be specific to your ClearQuest MultiSite installation.
cqdbsetup.exe
Note: This must be done in the context of the environment variable that was set in step 1 above.
When importing large numbers of records to a replicated ClearQuest database, either through manual data-entry, via the ClearQuest Import Tool, or via a program using the ClearQuest API, you should be aware that if a large number of records are imported without a MultiSite synchronization cycle, ClearQuest can run out of record ID's on the local site. A synchronization cycle is necessary to allocate another block of ID's.
The ID blocks are 4096 in size, and there is a buffer of 1024 at the end; if, during a synchronization cycle, it is found that a site is into the last 1024 of its 4096 allocation, a new block will be allocated.
In normal operation the process of allocating new ID blocks is transparent. However, if large numbers of records are entered in a short period of time, or if synchronization is not being run on a frequent basis, then the pool of ID's can run out. If this happens, you will get the message:
ERROR! The AUX_SERIES of ids allocated to this replica has
been exhausted. Have your site administrator synchronize
this replica with the working master site to obtain more ids.
To correct this situation, run a syncreplica -export operation. If this is the working master site, the syncreplica -export allocates a new block and you may resume entering records immediately. If this is not the working master site, you must wait for this synchronization to make a round-trip to the working master, which will allocate a new block and return it to your site. Once this cycle is complete you can continue creating new records.
There is no restriction
on running syncreplica -export and syncreplica -import during the import operation.
In a multisite deployment, it is possible to create circular duplicate links when two sites make their defects duplicates of each other during a single synchronization period. For example,
Both defects are now in the Duplicate state. This can only happen when the changes at both sites are made between synchronizations.
To resolve the circular link one of the sites should do an unduplicated action on their defect.
For information on the ClearQuest/ClearCase Unified Change Management (UCM) Integration please refer to the Rational ClearCase Documentation and Release Notes, and Appendix B of the Administering Rational ClearQuest manual.
During the installation
process for Microsoft SQL Server 2000, you have the option of selecting Windows
only authentication or mixed mode (Windows and SQL Server) authentication. You
must select mixed mode (Windows and SQL Server) authentication in order for
ClearQuest to function properly.
Also during the installation process for Microsoft SQL Server 2000, you are
prompted for a database instance name. The database instance name must be the
same as the hostname of the machine on which you are installing. This can be
accomplished by leaving the instance name blank and accepting the default. If
an instance name is required, there are several issues that will arise:
"When using the SQL Server client connectivity components from SQL Server 7.0 or earlier, you must set up an alias using the Client Network Utility before you connect to a named instance of SQL Server 2000. For example, on a SQL Server 7.0 client, to connect to a named instance of SQL Server 2000, you must add an alias that points to \\computername\pipe\MSSQL$instancename\sql\query. If you use an alias name of computername\instancename, clients can connect by specifying this name in the same way as SQL Server 2000 clients do. For the TCP/IP Sockets and NWLink IPX/SPX Net-Libraries, you must use the Client Network Utility to define an alias on the client that specifies the port address on which the named instance is listening."
Please consult the Microsoft support web site at http://support.microsoft.com/ for more information.
There is a known issue with Microsoft SQL Server 7.0 Service Pack 2 and SQL Server 2000 such that a user can use the ClearQuest schema designer to create a schema, where executing the same query three times in a row by the same process can cause certain rows and tables in the database to become locked. This will create what is known as a blocking SPID (SQL Server Process ID) on the database server. The major symptom of the problem is that the ClearQuest system becomes unavailable to all users (there maybe an hourglass, or just no response from ClearQuest). This particularly impacts the ClearQuest web interface. To diagnose if this is the problem:
The relevant Microsoft defect
number for this problem is 58388. Rational Software has developed a workaround
for this problem until such time as Microsoft provides a solution. The relevant
Rational Software Technical Support Tech Note is 13899, which can be obtained
at http://solutions.rational.com/solutions/.
When connecting to Oracle
databases, ClearQuest uses a database property called "connect_options"
which determines behavior of the client under certain configurations. Generally,
these connect options are stored in the schema repository and are replicated
to each client when they connect. This reduces workload for site-wide maintenance,
but has the side effect of limiting certain heterogeneous Oracle client version
configurations. There are several configuration options that are discussed here.
The "connect_options"
database property has several options. They are:
HOST=<host>;SID=<sid>;SERVER_VER=<ver>;CLIENT_VER=<ver>;LOB_TYPE=LONG
where,
<host> is the network hostname of the Oracle database server;
<sid> is the instance ID of the Oracle database server;
<ver> is the Oracle version number, either, 7, 8.0 or 8.1;
SERVER_VER is the Oracle database server version number;
CLIENT_VER is the Oracle client version number;
LOB_TYPE is the Oracle data type used for text fields; currently, this must be of type LONG.
Generally, the "connect_options"
property is set when the schema repository is created for the first time. This
can be modified later (on a site wide basis) for the user database using the
database properties option of ClearQuest Designer or for the schema repository
itself using the ClearQuest Maintenance tool.
When setting up a site for use with Oracle, you should carefully consider which
Oracle client versions will be used across the site. You should determine which
is the most likely Oracle client version and specify that version in the CLIENT_VER
parameter of the "connect_options" database property using ClearQuest
designer. There will then be an additional step required for clients that use
a different Oracle client version. For each client that wishes to deviate from
the site standard, you will need to enter the following at the command line:
installutil registeroracleoptions "CLIENT_VER=<ver>"
where <ver> is one of "7", "8.0", or "8.1". The installutil executable is located in the ClearQuest installation directory.
This command has the effect of creating a registry key setting under HKEY_LOCAL_MACHINE\Software\RationalSoftware\ClearQuest\2001.03.00\Core with a value OverrideOracleConnectOptions equal to "CLIENT_VER=<version>". This will then force that client to use that CLIENT_VER connect option in place of the CLIENT_VER option specified in the schema repository.
You will know that this override is required because the user will be unable to successfully connect to Oracle databases. The salient error message will indicate a version of the Openlink ODBC driver for Oracle that references the wrong Oracle client version. This can be viewed by clicking the "Details" checkbox on the login error message dialog box.
There are two major examples
of use. The first is a homogenous environment of Oracle 8.1 clients and an Oracle
8 server. The connect options string should be:
HOST=<host>;SID=<sid>;SERVER_VER=8.0;CLIENT_VER=8.1;LOB_TYPE=LONG
In this example, registeroracleoptions
is not necessary because all client versions use the Oracle 8.1 client. Another
example would be the heterogeneous case, with the majority of clients running
Oracle 7.3.4 and a few running 8.0 and 8.1 against a 7.3.4 server. The connect
options string in the database properties would be:
HOST=<host>;SID=<sid>;SERVER_VER=7;CLIENT_VER=7;LOB_TYPE=LONG
As clients install Oracle 8.0.5 or 8i (8.1.6), they would need to override the connect options with either:
installutil registeroracleoptions "CLIENT_VER=8.0"
Or
installutil registeroracleoptions "CLIENT_VER=8.1".
One final note: If you reinstall ClearQuest, this setting might be deleted as part of the reinstall. Please make sure it is set for the client after each install. It may be useful to create a ".bat" file with the appropriate installutil command options, which the user can simply double click on to reset the override. This could be placed in a network install area.
When using an Oracle database
for the backend data storage, searches using the 'Contains' operator will always
be case sensitive.
To allow the searching of
MUTLILINE_TEXT_STRINGS in ClearQuest when using an Oracle database as the backend
data storage, you must setup and enable the interMedia Text search engine. See
http://www.oracle.com/ for more information
on obtaining and configuring the interMedia engine.
Once configured, ClearQuest requires that there be at least one interMedia server
process running.
Please consult the Installing
Rational ClearQuest manual for detailed instructions on enabling multi-line
text searches.
If you are using the interMedia search engine, you must revoke the ctxadmin role from the ClearQuest user before doing any operation that constitutes a database move, such as:
When running Rational ClearQuest
from a network installation, users will not be able to create report formats
using Crystal Decisions' Crystal Reports. In order to create new report formats
in a network installation, users must execute ClearQuest from the shortcuts
menu and not by executing ClearQuest from the administrative install.
Microsoft released MDAC
2.5.1 as part of Windows 2000 SP1. With that release, ClearQuest versions prior
to v2001.03 were no longer able to successfully perform queries against Microsoft
Access databases. This manifested itself through a number of different error
messages either in the ClearQuest Client or in the ClearQuest Maintenance tool
while creating sample databases. The specific symptoms included spurious "Out
of memory" errors executing various commands. This issue has been addressed
in ClearQuest v2001A.04.00. Earlier versions of ClearQuest do not support use
of MDAC 2.5.1 or later or Windows 2000 SP1. For more information, please consult
the Microsoft knowledge base article Q272951 at http://support.microsoft.com/support/kb/articles/Q272/9/51.ASP?LN=EN-US&SD=gn&FR=0
Beginning with ClearQuest
v2001A.04.00, there is a new method for debugging e-mail notification issues.
ClearQuest, when enabled via a registry setting, will output interesting debug
information to the Windows debug log. This can be viewed using the dbwin32 tool
located under the ClearQuest install directory or any other tool that can browse
the Windows debug log. Importing the following ".reg" file after ClearQuest
has been installed will enable the e-mail notification debug information. Note
that you have to stop and restart ClearQuest for this to take effect on that
client (this would include the web server).
Native Client:
REGEDIT4
[HKEY_CURRENT_USER\Software\Rational Software\ClearQuest\Diagnostic]
"Trace"="Email"
"Output"="ODS"
"EMailSendVB"="ODS"
Webserver:
REGEDIT4
[HKEY_USERS\.default\Software\Rational Software\ClearQuest\Diagnostic]
"Trace"="Email"
"Output"="ODS"
"EMailSendVB"="ODS"
Please note that beginning with Windows 2000, you are required to have local administrator permissions to view debug output. For further information on E-mail notification please consult TechNote 17189.
The OOTB schemas define a Default Value hook for the Submit_Date field. The Perl version includes the current time component, but the Basic version does not. This is interpreted as the start of the day, local time, which can affect the results of date-based queries run from other time zones. Customers basing their schema on any of the OOTB schemas may experience this behavior.
For users to run ClearQuest properly in a Citrix or terminal server environment, the system administrator of the Windows NT or Windows 2000 server must set the appropriate security privilege for the user (the NT or Win2000 user, not the ClearQuest user) as follows:
If the permissions are incorrect, the user will receive an ODBC error when trying to logon to the CQ database.
If the permissions are incorrect,
the user cannot do any operations that need to write to the ClearQuest program
directory. For example, the user cannot create new queries.
In order to successfully run ClearQuest Web, you must ensure that IIS is configured correctly to work with the anonymous user id (typically, IUSR_<machinename>). In order to do this, you must:
The IIS Server (inetinfo.exe)
may crash when you stop the service from the Microsoft Internet Service Manager
application. If this happens, you must stop and restart the Internet Service
Manager before restarting the WWW service. If this machine provides FTP or Gopher
services, you must restart them too.
If you are using Microsoft Internet Explorer version 4.72.2106.8 or 4.71.1712.6, you will need to upgrade to a newer version, such as 4.72.3110.8. Otherwise, you will run into a JavaScript error when selecting Help, About or attempting to view an attachment.
Users of Netscape Communicator 4.0x browsers should have the following options set:
In addition to the tips
documented here, there is detailed documentation on the configuration of IIS
4.0 and IIS 5.0 in the Installing Rational ClearQuest manual.
Sometimes the ClearQuest Installation on a Win2000 Server or an NT4 Server with SP6 installed ends up with Registry Key permission settings that make them inaccessible to the Anonymous Web User. In particular the keys:
The consequences of this are that the ClearQuest Web server fails to grant logons, with one of the following messages:
See the Installing Rational ClearQuest manual, for information on setting the proper permissions.
If you haven't granted proper
permissions in the cache directory, you will not be able to logon and you will
see the following
error:
Logon Error 80020009
Could not create directory
occurred in ClearQuest.FileCache.1
See the Installing Rational ClearQuest manual, for information on setting the proper permissions.
Your SQL Server databases
must be in the same network domain as your ClearQuest Web server and any ClearQuest
clients or tools that need to connect to the database. If they are not in the
same domain, you will get errors. For more information:
Occasionally you may have your script time out. If this happens, you'll see a message that looks like:
error 'ASP 0113'
Script timed out
The maximum amount of time
for a script to execute was exceeded. You can change this limit by specifying
a new value using the Internet Service Manager. To do this:
Rational has performed extensive performance and stability testing on various web server configurations. As a result of these tests, we have developed a set of recommended database and web server configurations.
ClearQuest Web has been load tested extensively with hooks written in both Perl and VBScript. In order to ensure web stability under high loads, Rational's load testing involved 50 simultaneous users performing normal operations such as submitting records, modifying records, and executing queries. Based on this load testing, Rational recommends the following configurations for best performance and stability under high loads:
In order to ensure top performance from ClearQuest Web in a multi-user environment, please be sure the following IIS tuning is completed:
Note: Rational ClearQuest was load tested using Rational Performance Studio. Rational recommends at least 1 GB of RAM and a Pentium III processor (500 MHz and greater) on the Web server for optimal performance. All load testing above was performed on a dual processor machine. In addition, Rational recommends that the database server and the Web server be located on two different machines. Using one machine as both the database server and the Web server causes frequent hangs and script timeouts and generally causes ClearQuest Web to be unreliable.
For a list of known defects in Rational ClearQuest v2001A.04.20, please consult Rational Technical Support TechNote 18408 at http://solutions.rational.com/solutions/.
For a list of known defects in Rational ClearQuest v2001A.04.20, please consult Rational Technical Support TechNote 18409 at http://solutions.rational.com/solutions/.
The ClearQuest User Group is an e-mail forum where you can share your experiences, pose questions, or obtain useful information from other ClearQuest users. To subscribe to the group, visit the Rational web site at: http://www.rational.com/support/usergroups/
Your e-mail address will not be given out to anyone.
The ClearQuest Sample Hooks
Repository provides a place for users to trade hook scripts with one another.
The Repository is located at: http://clearquest.rational.com/
To gain access enter:
username: hooks
password: password
Select the link for the "Sample Hooks Database." From here you can browse the database of existing hooks scripts. If you have a script that others might find useful, please take a minute and add it to the database.
If you have any problems
with the software or documentation, please contact Rational Technical Support
via telephone or electronic mail as described below. For information regarding
support hours, languages spoken, and other Rational Software information, visit
the Rational web site, http://www.rational.com/support.
Rational's web site contains
an extensive library of Technical Notes. To access the Technical Notes, go to
http://solutions.rational.com/solutions//
Rational maintains Support
Centers in different geographic regions. To contact the center nearest you,
consult the chart below. If you are contacting Technical Support by phone, dial
the phone number shown below and follow the voice prompts to select ClearQuest
Technical Support.
Your Location | Telephone | Facsimile | Electronic Mail |
North America | (800) 433-5444 (Toll free) (408) 863-4000 California |
(781) 676-2460 Massachusetts |
support@rational.com |
Europe, Middle East, Africa |
+31 (0) 20 4546-200 Netherlands |
+31 (0) 20-4546-201 Netherlands |
support@europe.rational.com |
Asia Pacific | +61-2-9419-0111 Australia |
+61-2-9419-0123 Australia |
support@apac.rational.com |
© 2001 Rational Software and its subsidiaries. All rights reserved. Rational Software and its subsidiaries ("Rational") claim copyright in this Program and documentation as an unpublished work, versions of which were first licensed on the date indicated in the foregoing notice. Claim of copyright does not imply waiver of Rational's other rights. See Notice of Proprietary Rights.
NOTICE OF PROPRIETARY
RIGHTS
This computer program and documentation are confidential trade secrets and the
property of Rational Software and its subsidiaries. Use, examination, reproduction,
copying, disassembly, decompilation, transfer and/or disclosure to others, in
whole or in part, are strictly prohibited except with the express prior written
consent of Rational Software and its subsidiaries.