clearquest timetracker admin guide

Administrator Guide

Working hours management module

ClearQuest Time TrackerVersion 1.1

Ltd CM-Consult

Moscow

2010

CM-Consult & Rational-Tools project

www.rational-tools.infowww.cmcons.comrational.tools.info@gmail.com

Partners in Europe:IBTS - International Business& Technology Solutionshttp://[email protected]

_________________________________________________________________________

2

Contacts1. Main contacts

CM-Consult company

Rational-Tools project – the new area of international tools

development

Mail site: http://rational-tools.info (English site)

Company site: http://cmcons.com (Russian site)

Blog: IBM Blog (English blog)

Twitter: http://twitter.com/rrationaltools

E'mails: [email protected] and [email protected]

· Moscowo Uznobutovskaya st, 23, Moscow, Russiao Phone & fax: +7(495) 648-63-28

· Kaliningrado Office 213, Garajnaya st. 2, Kaliningrad, Russiao Phone & fax: +7 (4012) 563671

2. Partners in EuropeContacts in Germany:

IBTS - International Business & Technology Solutions

Internet: http://www.ibts-online.com

E-mail: [email protected]

Scheelestr. 108, D-12209 Berlin

Tel.: +49 (0)30 755 14 304

Fax: +49 (0)30 755 14 348

http://www.cmcons.com/

http://rational-tools.info/

http://cmcons.com/

https://www.ibm.com/developerworks/mydeveloperworks/blogs/alex/

http://twitter.com/rrationaltools

mailto:[email protected]


http://www.ibts-online.com/

http://www.ibts-online.com/





_________________________________________________________________________

3

Contents

1. LIST OF ABBREVIATIONS AND TERMS ......................................................................................... 4

2. GLOSSARY ........................................................................................................................................... 4

3. INTRODUCTION .................................................................................................................................. 5

3.1 PURPOSE OF THE DOCUMENT ................................................................................................................ 5

3.2 FIELD OF APPLICATION......................................................................................................................... 5

4. GENERAL DESCRIPTION .................................................................................................................. 5

5. ARCHITECTURE ................................................................................................................................. 5

6. INSTALLATION ................................................................................................................................... 6

7. SOFTWARE AND DOCUMENTATION PACK.................................................................................. 9

8. CONFIGURATION ............................................................................................................................. 10

9. QUICK DEPLOYMENT ..................................................................................................................... 11

10. SYSTEM REQUIREMENTS .............................................................................................................. 11




_________________________________________________________________________

4

1. List of Abbreviations and TermsAbbreviation Expansion

AS Automated System

CM Change management

CQTT Working hours management module Clear Quest Time Tracker

OS Operating System

SS Software System

2. GlossaryTerm Interpretation

ClearQuest Software change management system IMB Rational ClearQuest

Record type Document/ ClearQuest object




_________________________________________________________________________

5

3. Introduction

3.1 Purpose of the Document

The purpose of this document is to provide administrators with specific information about

the program, and give them instructions for installing and maintaining CQTT.

3.2 Field of Application

The document relates to Clear Quest Time Tracker - the working hours management

module, and is intended for CQTT administrator.

4. General DescriptionThis document does not provide a general description of the product. For general

description, see the User Guide for the working hours management module Clear Quest Time

Tracker.

5. ArchitectureCurrent version of CQTT is implemented in compliance with the architecture represented

in the Figure 1 – CQTT.

The program is designed as a client application that works with records of ClearQuest change

management system interacting with it via its API. All configuration settings/values of the

application are stored in the registry branch HKEY_CURRENT_USER\Software\CM-

Consult\CQ_TimeTracker.

The list of connections/datbases is populated from the registry branch

HKEY_LOCAL_MACHINE\SOFTWARE\Rational Software\ClearQuest\<CQ

version>\Install\MasterDatabase.




_________________________________________________________________________

6

Figure 1 – CQTT architecture

6. InstallationTo install the application, launch the installation wizard and follow the steps. The

installation consists of five steps, each represented by the corresponding figure (see Figure 2 –

Step 1, starting installation, Figure 3 – Step 2, selecting installation directory, Figure 4 –

Step 3, confirming installation, Figure 5 – Step 4, installation progress, Figure 6 – Step 5,

finishing installation).

The figures below show the installation steps.




_________________________________________________________________________

7

Figure 2 – Step 1, starting installation

Figure 3 – Step 2, selecting installation directory




_________________________________________________________________________

8

Figure 4 – Step 3, confirming installation

Figure 5 – Step 4, installation progress




_________________________________________________________________________

9

Figure 6 – Step 5, finishing installation

7. Software and Documentation PackCQTT installation package includes:

1. This document – Administrator Guide for working hours management module

ClearQuest Time Tracker.

2. setup.exe – program installer.

3. Setup_CQ_TimeTracker.msi – installation package archive.

In some cases, the installation package can be compressed for convinient transport.

The installer copies the following files to your computer:

1. ClearQuestTimeTracker.exe – program executable file.

2. ClearQuestTimeTracker.exe.config – program configuration file.

3. Interop.CCINTSVRLib.dll – COM wrapper for ClearQuest service.

4. Interop.ClearQuestOleServer.dll – COM wrapper for ClearQuest OLE server.

5. User Guide for CQTT.doc – User Guide for working hours management

module.

6. ClearQuestTimeTracker.chm – HTML help for the program.




_________________________________________________________________________

10

8. ConfigurationConfiguring the application consists in configuring record type settings on the Record

type settings tab (see Figure 8 – Configuring record type). In CM, the record type is a task to

be performed. Record type settings are password protected: to change the settings, you need to

enter the application administrator password (see Figure 7 – Restricting configuration

changes). This restriction is set up to ensure the SS CQTT stability. Configuration of record type

settings should be performed by the administrator. The default administrator password is set to

the current month, day and time in the format MMDDHH.

Figure 7 – Restricting configuration changes

Configuration includes selecting relevant parameters from the lists, populated on basis of

the connected schema. If you have not selected a value from a list, the list is marked by the sign

, and you cannot save changes or continue working. Every field has a tool tip explaining its

purpose.




_________________________________________________________________________

11

Figure 8 – Configuring record type

9. Quick DeploymentThe quick deployment of the program includes:

· Installing the program to the user’s computer (see section 6.Installation),

· Configuring the main record type that represents a task to be performed.

All settings are stored in Windows registry, in branches automatically created by CQTT:

HKEY_CURRENT_USER\Software\CM-

Consult\CQ_TimeTracker\Profiles\Connection’/’user db’\EntitySettings.

10. System RequirementsMinimum hardware requirements:

· Intel® Celeron® processor (1 GHz or more).

· At least 256 Mb RAM (depends on size of your database).

· 1 Gb of available space on a hard drive.

· 1 Mb of available space on a hard drive for installation.




_________________________________________________________________________

12

Software requirements:

· Operating system Microsoft® Windows® 2000 SP4 or Microsoft® Windows®

XP Professional SP2.

· Microsoft.NET Framework v.2.0.

· Windows Installer 3.1 (KB893803) update is installed.

· Operating system critical updates are installed.