Clearquest client - Provide access to a running Clearquest server
Andrew DeFaria <Andrew@ClearSCM.com>
Monday, October 10, 2011 5:02:07 PM PDT
Modifed 2013/05/30 15:43:28
Provides an interface to a running Clearquest Server over the network. This means that you can use any Perl you like, not just cqperl, and you don't need to have Clearquest installed locally. In fact you can run from say Linux and talk to the Clearquest Server running on Windows.
The server allows both read and write access to a Clearquest database as defined in cqdservice.conf file. Note the username/password must be of a user who can write to the Clearquest database for write access to succeed.
A hash is passed into to the execute method, which the client should use to talk to the server, that describes relatively simple protocol to tell the server what action to perform. In both the read case and the read/write case a field named id should be defined that has a value of "<record>=<id>" (e.g. "defect=BUGDB00034429").
For the read case the rest of the keys are the names of the fields to retrieve with values that are undef'ed. For read/write, the rest of hash contains name value pairs of fields to set and their values.
Execute returns a status and a hash of name value pairs for the read case and an array of lines for any error messages for the read/write case.
The following methods are available:
Options are keep in the cq.conf file in the etc directory. They specify the default options listed below. Or you can export the option name to the env(1) to override the defaults in cq.conf. Finally you can programmatically set the options when you call new by passing in a %parms hash. The items below are the key values for the hash.
The CQ Server host to connect to
Port number to contact the server at (Default: From cq.conf)
User name to connect as (Default: From cq.conf)
Password for CQ_USERNAME
Name of database to connect to (Default: From cq.conf)
Database Set name (Default: From cq.conf)
CONFIGURATION AND ENVIRONMENT
DEBUG: If set then $debug is set to this level.
VERBOSE: If set then $verbose is set to this level.
TRACE: If set then $trace is set to this level.
ClearSCM Perl Modules
BUGS AND LIMITATIONS
There are no known bugs in this module.
Please report problems to Andrew DeFaria <Andrew@ClearSCM.com>.
LICENSE AND COPYRIGHT
Copyright (c) 2011, ClearSCM, Inc. All rights reserved.