==================================
P4CQ 1.2 Release Notes:
==================================

Table of Contents

 A.  Installation Notes
 B.  Known Issues and Defects
 C.  Release Change Log


=========================
A.  Installation Notes
=========================

OVERVIEW:

The files contained in the P4CQ distribution can be found in the .bom (manifest
file) within the release.  The distribution also includes a short readme.txt
file.

Unfortunately, there is not much documentation here yet - there needs to be
more.

The basic plan is that the ClearQuest schema should be imported into ClearQuest
as a new schema.  From there, either it can be used to start up a new schema or
the pertinent pieces can be exported and integrated into an existing schema
(the latest ClearQuest release seems to support this much better than earlier
ones).

With a P4CQ based schema up and running along with a database, ReleaseProTM can
be pointed to this database.  Within the ReleasePro distribution, there will be
a integrations/cqdb perl file.  This script can only be run under cqperl, the
perl that ships with ClearQuest (all platforms) as it employs the ClearQuest
Perl API to communicate with ClearQuest.

The cqdb script by default will look for a .cqparams file.  This file can
contain the ClearQuest user logon, passwd, and database name to connect to.
Please note that this file may need to be permission/ACL protected to protect
the passwd, which is stored as ASCII text, from being compromised.

NOTE: ADD FILE PROTECTIONS TO THE .cqparams FILE

The default search path for this file is the current directory, the 'HOME'
directory, and the 'USERPROFILE' directory (as defined by the those environment
variables).

So, to configure ReleasePro to talk to the correct ClearQuest database, set the
correct values in the .cqparams file.  Or, one can rename the integrations/cqdb
to another name, such as integrations/cqdb2, and specify "cqdb2" in the
RT_config.ini file.

Note: it is via the rt/include/RT_config.ini configuration file in the
ReleasePro distribution by which ReleasePro is configured to use
integrations/cqdb (or integrations/cqdb2) as the cqperl interface file.

SPECIFICS:

There are several independent pieces to P4CQ.  They do not all have to be
enabled for the various pieces to work.  There are:

1) the cq2p4.pl daemon which will mirror on a default 24 hour basis the
   ClearQuest defect and fixes data into the Perforce job and fixes database.
2) the loggerreview.pl daemon which keeps the ClearQuest and Perforce databases
   in sync on a default 60 second basis.
3) ClearQuest global scripts which implement the business logic concerned with
   change and fixes data within ClearQuest.
4) the ReleasePro ClearQuest integration to enable ReleasePro to store release
   data within the ClearQuest database.
5) P4DB: provides a rather nice web based drill up/down capability for all the
   data.  Currently only partially runs under IIS (see defects), but should run
   fine under Apache.


=========================
B.  Known Issues and Defects
=========================

TBD.

There is a lack of documentation...


=========================
C.  Release Change Log
=========================

  I. Release summaries:

### 1.2 (build main.20030405.* and later)

Fixed the backend scripts (P4CQ.pm based) - they did not work with the latest
version of the schema (missing and wrong defect and release record fields).
Also ported P4DB to IIS on Windows (from Apache on UNIX).

### 1.1 (build main.200303??.* and later)

The initial release.