cqproject tracker user guide

MS Project and ClearQuest Integration Module

ProjectTracker

Version 2.5.1

User Guide

LLC CM-Consult

2009

CM-Consulthttp://www.rational-tools.com

http://www.cmcons.com/about_us/eng/

2

Contents

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

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

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

3.1 PURPOSE OF THIS DOCUMENT............................................................................................................... 5

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

3.3 IMPLEMENTATION ................................................................................................................................ 5

3.4 SYSTEM REQUIREMENTS ...................................................................................................................... 5

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

4.1 USAGE VARIANTS ................................................................................................................................. 6

5. FUNCTIONALITY .............................................................................................................................. 14

6. DESCRIPTION OF USER INTERFACE FORMS ............................................................................ 14

6.1 AUTHORIZATION ................................................................................................................................ 15

6.2 CONFIGURATION ................................................................................................................................ 15

6.3 SAVING ............................................................................................................................................. 26

6.4 IMPORTING ........................................................................................................................................ 27

6.5 REFRESHING ...................................................................................................................................... 29

7. ADJUSTING MODULE SETTINGS .................................................................................................. 30

7.1 MAIN RECORD SETTINGS .................................................................................................................... 31

7.2 PROJECT RECORD SETTINGS ................................................................................................................ 32

7.3 ADDITIONAL RECORD SETTING............................................................................................................ 33

7.4 ADDITIONAL FIELDS SETTINGS ............................................................................................................ 35

7.5 RESOURCE SETTINGS .......................................................................................................................... 36

7.6 ADDITIONAL SETTINGS ....................................................................................................................... 36

8. USING THE PROGRAM .................................................................................................................... 38

8.1 SAVING TASKS ................................................................................................................................... 38

8.2 CREATING A QUERY FOR IMPORT IN CLEARQUEST .............................................................................. 43

8.3 IMPORTING ........................................................................................................................................ 46

8.4 REFRESHING ...................................................................................................................................... 49

8.5 OPENING A USER INTERFACE FORM OF THE CLEARQUEST REQUEST FROM MS PROJECT ....................... 51

8.6 CREATING A NEW CLEARQUEST REQUEST .......................................................................................... 53

8.7 IMPORTING A LICENSE KEY ................................................................................................................ 55



3

LIST OF FIGURES....................................................................................................................................... 58



4

1. List of abbreviations, conventions and termsAbbreviation Expansion

ProjectTracker MS Project and ClearQuest Integration Module

MS Microsoft

MPS, MS Project Microsoft Office Project Professional 2003/2007

2. GlossaryTerm Interpretation

ClearQuest Software change management system IMB Rational ClearQuest

ClearQuest

entity type

ClearQuest entity (Defect, Task, etc.)

3. Introduction

3.1 Purpose of This Document

The document provides users with information on functionality of the ProjectTracker

module which allows effectively using MS Project and ClearQuest as a single integrated system.

The document covers the following topics:

· ProjectTracker functionality

· User interface forms

· Module settings

· Using the module

3.2 Field of Application

The document relates to the ProjectTracker module, and is intended for the end user

(project manager) of the change management system.

3.3 Implementation

The module is implemented as an add-on for MS Project, and is integrated into the MS

Project menu. The module represents a COM object implemented in the .NET 2.0 framework.

3.4 System Requirements

· MS Windows 2000/XP/2003

· ClearQuest version 2003.06.00 or later

· MS Project version 2003/2007 (English or Russian edition)

· MS Framework .Net 2.0

4. General DescriptionThe module is intended for integration of ClearQuest and MS Project, and allows

performing tighter integration than the standard IBM Rational module can provide. When

performing integration of the ClearQuest base and the MS Project plan, the module allows

mapping entity properties (synchronized data) using flexible settings. The module supports

hierarchical relations between ClearQuest requests thus it allows keeping several child (nesting)

tasks and subtasks in the plan, which will be synchronized with tasks of the MS Project plan.



6

The module allows a manager to plan work of their employees using MS Project directly.

By means of integration, you can open the Clear Quest record forms, and synchronize any fields,

displaying them directly in the MS Project plan.

The main feature of this module that distinguishes it from the standard one is the

possibility to automatically form dependency links between ClearQuest requests. This possibility

allows a manager to plan work in more detail directly in MS Project, which is more handy and

usual for them.

The module performs synchronization of information between the ClearQuest and MSProject systems using the following basic data exchange operations (see Figure 1 – Basicoperations):

· Saving Tasks

· Importing tasks

· Refreshing tasks

Figure 1 – Basic operations

4.1 Usage variants

This section contains information on variants of using hierarchical relations for

integration, and using the fields of ClearQuest requests. For the list of necessary fields, and

details on their use, see the Configuration section.

Project-Request-Task Hierarchy

The Project Tracker module supports various request hierarchies, defined in the task plan,

or the ClearQuest database. The figure below (see Figure 2 – Project-Request-Task relationship)

describes the Project-Request-Task relationship between ClearQuest entities and Ms Project

tasks.



7

Ref

eren

ce

BackReference

Figure 2 – Project-Request-Task relationship

Desription of the Project-Request-Task relationship:

1. In this hierarchy type, the following types of ClearQuest entities are used, and

they are associated with the following tasks of the MS Project plan:

1) The Project type of ClearQuest entity – the first nesting level

2) The Request type of ClearQuest entity – the second nesting level

3) The Task type of ClearQuest entity - the thirds and subsequent nesting

levels

2. The ClearQuest entity type used for identification of a project must comply with

the following requirements:

1) Availability of the following fields:

i. Name – mandatory

ii. Description – optional

iii. Owner - optional

iv. Percent complete – optional

v. Plan start date – optional

vi. Plan finish date – optional

vii. Actual start date – optional

viii. Actual finish date – optional

ix. Planned cost – optional

x. Actual cost – optional

xi. Task reference – optional

xii. Request reference – optional



8

2) An action available that provides a possibility to edit a record

3. The ClearQuest entity type used for identification of additional requests (defect,

task, etc.) must comply with the following requirements:


i. Headline – mandatory


iii. Plan start date – optional

iv. Plan finish date – optional

v. Child task reference - optional, in case tasks have references to

requests

vi. Project reference – mandatory, in case project does not have

references to requests


4. The ClearQuest entity type used for identification of a task must comply with the

following requirements:




iii. Plan start date – mandatory

iv. Plan finish date – mandatory

v. Actual start date – mandatory

vi. Actual finish date – mandatory

vii. Owner – mandatory

viii. Child task reference – mandatory, in case implementation of task

hierarchy is necessary

ix. Parent task reference – mandatory, in case implementation of task


x. Project reference – mandatory, in case there is no reference to tasks

from the project

xi. Request reference – mandatory, in case there is no reference from

the request to tasks

xii. Predecessors – optional



9

xiii. Plan work – optional

xiv. Actual work – optional


Project-Task Hierarchy

The figure below (see Figure 3 – Project-Task relationship) describes the Project-Task

relationship between ClearQuest entities and MS Project tasks.

BackR

eference Ref

eren

ce

Figure 3 – Project-Task relationship

Description of the Project-Task relationship:



1) The Project type of ClearQuest entity – the first nesting level

2) The Task type of ClearQuest entity - the second and subsequent nesting

levels

2. The ClearQuest entity type used for identification of the project must comply with

the following requirements:


i. Name – mandatory


iii. Owner - optional

iv. Percent complete – optional



10

v. Plan start date – optional

vi. Plan finish date – optional

vii. Actual start date – optional

viii. Actual finish date – optional

ix. Planned cost – optional

x. Actual cost – optional

xi. Task reference – optional
















x. Project reference – mandatory, in case there is no reference to tasks

from the project

xi. Predecessors – optional

xii. Plan work – optional

xiii. Actual work – optional


Request-Task Hierarchy



11

The figure below (see Figure 4 – Request-Task relationship) describes the Request-Task

relationship between ClearQuest entities and MS Project tasks.

BackR

eference Ref

eren

ce

Figure 4 – Request-Task relationship

Description of the Request-Task relationship:



1) The Request type of ClearQuest entity – the firts nesting level

2) The Task type of ClearQuest entity – the second and subsequent nesting

levels

2. The ClearQuest entity type used for identification of additional requests (Defect,

Enhancement, Request etc.) must comply with the following requirements:




iii. Plan start date – optional

iv. Plan finish date – optional

v. Child task reference - optional, in case tasks have references to

requests







12









nesting is necessary


nesting is necessary

x. Request reference – mandatory, in case there is no reference from

the request to tasks

xi. Predecessors – optional

xii. Plan work – optional

xiii. Actual work – optional


Task-Task Hierarchy

The figure below (see Figure 5 – Task-Task relationship) describes the Task-Task

relationaship between ClearQuest entities and MS Project tasks.



13

Figure 5 – Task-Task relationship

Description of the Task-Task relationship:



1) The Task type of ClearQuest entity - the firtst and subsequent nesting

levels











viii. Child task reference – mandatory

ix. Parent task reference – mandatory

x. Predecessors – optional

xi. Plan work – optional

xii. Actual work – optional




14

5. FunctionalityThe ProjectTracker module supports the following functionality:

· Supports hierarchical relations in ClearQuest requests

· Allows importing requests from the ClearQuest database into MS Project plan

with restoration of ClearQuest request hierarchy (the module supports hierarchical

relations not only between requests of the same type, but also between requests of

different types)

· Supports synchronization of any types of fields

· Imports user accounts from the ClearQuest database, and allows using them as

resources in the MS Project plan

· Uses special settings, regulating synchronization priorities

· Does not require installing special packages on records in the ClearQuest scheme

· Integrates into MS Project completely, and allows opening ClearQuest request

forms from the shortcut menu

6. Description of User Interface FormsAfter the installation, the ProjectTracker integrates with MS Project by adding a menu,

and building in the separate toolbar (see Figure 6 – Integrated menu).

Figure 6 – Integrated menu



15

The menu and the toolbar provide access to the following functions:

1. Connect – connecting to ClearQuest;

2. New – creating a new ClearQuest request

3. Open CQ Form – opening a form of the selected ClearQuest request;

4. Import to MSP – importing ClearQuest requests into the MS Project plan;

5. Import child records – importing child requests for the selected ClearQuest

request;

6. Save Plan to CQ – saving a whole plan to ClearQuest;

7. Save Selection to CQ – saving the requests selected from the plan to

ClearQuest;

8. Refresh MSP Plan – refreshing a whole MS Project plan from ClearQuest;

9. Refresh MSP Selection – refreshing the selected MS Project plan requests

from ClearQuest;

10. Settings – opening a form for adjusting the module settings;

11. About – opening a window with the module description.

6.1 Authorization

The authorization dialog (see Figure 7 – ClearQuest session authorization window) is the

standard authorization window that appears when the ClearQuest database session is initiated.

Figure 7 – ClearQuest session authorization window

6.2 Configuration

In the Configuration dialog, there are six tabs:



16

1. The Main tab – allows adjusting the main request fields necessary for planning

2. The Project tab – allows configuring mapping between the ClearQuest request

and the project, fields of the MS Project plan

3. The Add request tab – allows configuring the ClearQuest additional requests that

should be reflected in the plan

4. The Add fields tab – if necessary, the tab allows configuring the ClearQuest

request’s additional fields that will be included into the plan

5. The Resources tab – allows configuring automatic import of ClearQuest or MS

Project Server users into the plan

6. The Add settings tab – allows adjusting the following parameters: default

request, switching off automatic calculation, etc.

6.2.1 The Main TabThe main request is the ClearQuest request that is used as a task to an end owner, and is

associated with a task in the MS Project plan. In the Main tab, (see Figure 8 – The Main tab) you

can adjust settings of the ClearQuest main request. The tab contains the following properties:

· Record type – the ClearQuest request type intended for associating tasks of the

MS Project plan with it

· Edit – a name of the action that will be used for editing records in ClearQuest

· Assignee action – a name of the action that should be taken to assign an owner

for a task

· Change only plan dates and resources – if this option is selected, only plan

dates and resources will be saved in ClearQuest upon refreshing. Otherwise, all

changed fields of the task will be saved.

· Update plan dates and resources from CQ – select this option, if plan dates and

resources edited in ClearQuest should be updated in the MS Project plan as well

upon the MS Project plan refreshing Otherwise, these changes will be ignored and

rewritten upon saving the plan in ClearQuest.

· Headline – this field contains a brief description of the ClearQuest request, and

will be converted into the Name field of a task in the plan

· Description – this field contains a detailed description of the ClearQuest request,

and will be converted into the Note field of a task in the plan



17

· Resources – this field contains a name of an owner in the ClearQuest request

· Plan start date – this field contains a planned date for starting work in the

ClearQuest request

· Plan finish date – this field contains a planned date for finishing work in the

ClearQuest request

· Plan assignment work – this field contains planned effort of an owner in

ClearQuest. The value can be set in percentage, or in hours. If you set the value in

percentage, it will represent a planned owner’s load in percentage relative to a

whole task duration.

· Actual start date – this field contains an actual work start date in the ClearQuest

request

· Actual finish date – this field contains an actual work finish date in the

ClearQuest request

· Actual assignment work – this field contains a value of time spent on a task The

value can be set in percent, or in hours.

· Child record reference – the field that represents a reference to a child request.

The field must refer to the same request type, that is defined in the Record type

configuration field.

· Parent record reference – the field that represents a reference to a parent

request. The field must refer to the same request type, that is defined in the

Record type configuration field.

· Predecessors – this filed contains references to the ClearQuest request (the

references that must precede this request). The field must refer to the same request

type, that is defined in the Record type configuration field, and is responsible for

displaying the sequence in MS Project.



18

Figure 8 – The Main tab

6.2.2 The Project Tab

On this tab, you can configure the ClearQuest request that corresponds to the project. The

project in the MS Project plan, if it is configured, can be associated with the first level task only.

The number of projects in a plan is not limited. This tab contains the following fields:

· Record type – the ClearQuest request type that represents a project in the

ClearQuest system

· Edit action – Edit – the action that should be performed to edit a project record

in the ClearQuest system. This action should be defined if it is necessary to

synchronize planned and actual dates, completion rate, project costs in the MS

Project plan with those in the ClearQuest system, and if it is necessary to link

child requests directly from the project entity in ClearQuest.

· Use baseline for planning – select this option, only if it is necessary to edit

planned dates of the ClearQuest project from MS Project. In this case, the baseline

defined in additional settings will be used.

· Headline – the ClearQuest request field that corresponds to the project name

· Description – the ClearQuest request field that contains additional information on

the project



19

· Project manager – the ClearQuest request field that contains a project manager

resource

· Plan start – the ClearQuest request field that contains a planned date of starting a

project. You should fill in this field, if the planned date of starting a project will

be set from MS Project.

· Plan finish – the ClearQuest request field that contains a planned date of

finishing a project. You should fill in this field, if the planned date of finishing a

project will be set from MS Project.

· Plan cost – the ClearQuest request field that contains a planned project costs

· Actual start – the ClearQuest request field that contains an actual date of starting

a project. You should fill in this field, if the actual date of starting a project will be

set from MS Project.

· Actual finish – the ClearQuest request field that contains an actual date of

finishing a project. You should fill in this field, if the actual date of finishing a

project will be set from MS Project.

· Actual cost – the ClearQuest request field that contains actual project costs

· Task reference – the ClearQuest request field that contains a list of all project

tasks

· Project reference from main record – the field of the ClearQuest main request

that contains a name of a project corresponding to the main request

· Percent – the ClearQuest request field that contains an actual project completion

rate. If the rate is set, then in the ClearQuest request, there will be set a

completion rate of the task that is associated with this request.

· State – the ClearQuest request field that defines a project state, if a project is

defined using a reference



20

Figure 9 – The Project tab

6.2.3 The Add Record Types Tab

Additional requests are requests that initiate a task definition (defect, request from an

interested party, etc.) The distinctive feature of these requests is that you cannot edit any of their

fields in ClearQuest from MS Project. You can only bind child tasks to such requests. To

configure the ClearQuest additional requests, use the Add record types tab.

This tab (see Figure 10 – The Add record types tab) contains the following fields:

· Record type – configurable ClearQuest request type

· Edit – a name of the action that will be used for generating child requests in

ClearQuest;

· Headline – this field contains a brief description of the ClearQuest request

· Description – this field contains a detailed description of the ClearQuest request

· Resource – this field contains a name of an owner in the ClearQuest request

· Plan start date – this field contains a plan date for starting work in the

ClearQuest record;

· Planned finish date – this field contains a plan date for finishing work in the

ClearQuest record;

· Child record reference – the field that represents a reference to a child request.

The field must refer to the same request type, that is defined in the Record type

configuration field on the Main tab



21

· Reference from main record – this field contains a reference from the main

request to an additional request

· Project reference – the ClearQuest request field that contains a project name

· Reference from project – the ClearQuest request field that refers to a

configurable additional request

· List with results – this table contains all configured additional requests

· Add – click this button to add new requests to a table

· Delete – click this button to delete any of the configured additional requests from

a table

· Change – click this button to adjust settings of a record selected from the table of

additional requests

Figure 10 – The Add record types tab

6.2.4 The Add Fields Tab

Additional fields are the ClearQuest request fields that should be displayed in the MS

Project plan. Besides, you must have an ability to edit these fields from MS Project. You can

configure the ClearQuest request additional fields on the Add fields tab that is described below.

This tab (see Figure 11 – The Add fields tab) contains the following fields:

· Custom CQ Entity – the entity for which an additional field is configured



22

· Name ClearQuest field – the configurable ClearQuest field that should be

displayed in a plan;

· Visible name – a field name that will be displayed in the plan title

· MSProject field – an identifier of the MS Project field, into which the value from

the ClearQuest field will be copied

· Is visible – if you select this option, a configurable field will be added to the plan

as visible. Otherwise, this field will not be displayed in the plan, though values

will be recorder to the field.

· Access – defines a method of using a configured field

o Read/Write – a value in a field will be updated from the ClearQuest

record every time the plan is refreshed from ClearQuest, and a field value

from the MS Project plan will be recorded into the ClearQuest record

every time the plan is saved in ClearQuest

o Read – a field value will only be updated from the ClearQuest request

every time the plan is refreshed from ClearQuest;

o Write – a field value will only be recorded from the MS Project plan into

the ClearQuest request every time the plan is saved in ClearQuest

· List – if you select this option, a configurable field will represent a list

· Reference to – this option allows defining that a field represents a reference to

another ClearQuest entity. There are four fields under this option:

o record type – contains a list of ClearQuest entities From this list, select

the ClearQuest entity that is referenced by this field.

o field – contains a list of fields that are above the selected entity From this

list, select a field name that will be displayed in the MS Project plan

o filter – a list of fields by which you can filter a list

o value – an filtering expression

· Named list – defines a dynamic list that can be associated with a field

· List with results – this table contains all configured additional fields

· Add – click this button to add a new field

· Delete – click this button to delete any of the configured fields from a table

· Change – click this button to adjust settings of a field selected from a table



23

Figure 11 – The Add fields tab

6.2.5 The Resources Tab

On the Resources tab (see Figure 12 – The Resources Tab), you can adjust settings for

owners:

· Autoload users to MSProject plan – if you select this option, the integration

module will automatically generate a list of resources If none of the options listed

below is selected, all users defined in the User entity of the ClearQuest will be

downloaded.

· Use non-standard user entity – if you select this option, a non-standard User

entity will be used

o Record type – a name of the User entity

o Resource – the entity field containing an owner ’s name

o Description – a detailed description of a user

o Email – the field containing a user’s e-mail

o Phone – the field containing a users’ phone number

· Use db access for MSProject Server – if you select this option, a list of users

will be downloaded from the MS Project server when importing or refreshing

tasks

o Database server – a name of a database server that hosts the MS Project

Server databases



24

o Database name – a name of the MS Project Server database

o User name – a name of a user who have a read access to the MS Project

Server database

o Password – a password of a user defined above

· Use plan assignment in – in this list, you can select a unit of measure for planned

work load (percentage or hours)

· Use actual work in – in this list, you can select a unit of measure for actual work

completion (percentage or hours)

Figure 12 – The Resources Tab

6.2.6 The Add Settings Tab

On this tab (see Figure 13 – The Add settings tab), you can configure additional setings:

· Default query – this field contains a path to a filter query that will be used for

importing the ClearQuest records The entered path will be saved for a project that

is opened during configuration of integration module.

· Every task have ClearQuest record – if you select this option, the Clear Quest

record field will not be used for identification of ClearQuest records

· Autocalculate off – if you select this option, then automatic calculation during

import, refresh and save operations is switched off, that allows speeding up these

operations



25

· ClearQuest Record – the system field that is used for identification of the

ClearQuest records

· CQID – the system field that contains the identifier of the ClearQuest record

· Record Type – the system field that contains a name of the ClearQuest record

type

· State – the system field that contains a value of the State field of the ClearQuest

record

· Use baseline for planning – if you select this option, then the set planned dates

will be duplicated into the baseline selected below

· Baseline – in this list, you can select a baseline that will store the planned dates

· Use default CQ values – if you select this option, default values will be saved

during the save operation The entered path will be saved for a project that is

opened during configuration of integration module.

o Field – a name of the ClearQuest main record field that will store default

values

o Value – a default value A default value can be static, or can be equal to

the value of any MS Project field. In the latter case, the field name should

be set in square brackets.

o Update:

§ always – a value will be recorded into the ClearQuest record field

upon every saving of the plan in ClearQuest

§ empty – a value will be recorded into the ClearQuest record field

upon saving of the plan in ClearQuest only if the field is empty

· List with results – this table contains all configured default values

· Add – click this button to add new value to a table

· Delete – click this button to delete any of the configured records from a table



26

Figure 13 – The Add settings tab

6.3 Saving

After you have selected the Save Plan to CQ or Save Selection to CQ option from the

menu, the Save dialog opens (see Figure 14 – Launching the Export dialog). The dialog contains

the folowing elements:

· The text box with a log of save operation

· The Start button to launch saving

· The Stop button to stop saving

· The Close button to close the Save dialog

· The Change state if task assigned option – if a resource is assigned for a

task, the ClearQuest request is converted into a next state by the Assignee

action



27

Figure 14 – Launching the Export dialog

Export log is displayed in the following format (see Figure 15 – Export log):

Figure 15 – Export log

6.4 Importing

The Import dialog opens when you select the Import to MSP or Import child records

option from the menu (see Figure 16 – Launching the Import dialog). The dialog contains the

following elements:

· The text box with a log of import operation

· The Start button to launch importing

· The Stop button to stop importing

· The Close button to close the Import dialog

· The Use default query option– if this option is selected, the import

operation will be performed using the query defined in the Default query

field on the Add settings tab



28

Figure 16 – Launching the Import dialog

If you click Start with the Use default query option not selected, the ClearQuest filter

form will open (see Figure 17 – Selecting requests for importing), otherwise the form will not

open. To procced with imporing, you should select filtered records, and click OK.

Figure 17 – Selecting requests for importing

Import log is displayed in the following format (see Figure 18 – Import log):



29

Figure 18 – Import log

6.5 Refreshing

The Refresh dialog opens when you select the Refresh MSP plan or Refresh MSP

selection option from the menu (see Figure 19 – Launching the Synchronization dialog). The

dialog contains the following elements:

· The text box with a log of refresh operation

· The Start button to launch refreshing

· The Stop button to stop refreshing

· The Close button to close the Refresh dialog

Figure 19 – Launching the Synchronization dialog

The refresh log is displayed in the following format (see Figure 20 – Synchronization

log):



30

Figure 20 – Synchronization log

7. Adjusting Module SettingsTo open the form for adjusting the module settings, select Settings from the module

menu (see Figure 21 – Adjusting module settings).

Figure 21 – Adjusting module settings

To configure the module, you should fill in all the fields listed below. To save the

adjusted module settings, click Save. To cancel changes, click Cancel.



31

7.1 Main record settingsYou should configure the main fields for every request type that should be included into a

plan. The properties of the main fields are described in the Configuration section.

To configure the main fields, follow the steps below:

1. From the Record Type list, select the ClearQuest request type that corresponds to

the main request

2. From the Edit field, select a name of an action that will be used for editing the

ClearQuest records

3. From the Assignee action, select a name of an action that will be used for

converting the ClearQuest request into the next state upon assigning a resource for

a task

4. Select the Change only plan dates and resources option, if only planned dates

and resources should be changed upon saving values into the available ClearQuest

request

5. Select the Update plan dates and resources from CQ option, if changes of

planned dates and resources made in ClearQuest should be applied to

corresponding tasks of the MS Project plan upon refresh operation

6. From the Headline list, select a name of a field that corresponds to the main

ClearQuest request

7. From the Description list, select a name of a field that contains a detailed

description of the main ClearQuest request

8. From the Headline list, select a name of a field that corresponds to the main

ClearQuest request

9. From the Plan start date list, select a name of a field corresponding to a planned

date of starting work in the main ClearQuest request

10. From the Plan finish date list, select a name of a field corresponding to a planned

date of finishing work in the main ClearQuest request

11. From the Plan assignment work list, select a name of a field corresponding to a

planned work load in the main ClearQuest request

12. From the Actual start date list, select a name of a field corresponding to an

actual date of starting work in the main ClearQuest request



32

13. From the Actual finish date list, select a name of a field corresponding to an

actual date of finishing work in the main ClearQuest request

14. From the Actual assignment work list, select a name of a field corresponding to

an actual rate of work completion in the main ClearQuest request

15. From the Child record reference list, select a name of a field that represents a

reference to a child main ClearQuest request

16. From the Parent record reference list, select a name of a field that represents a

reference to the parent main ClearQuest request

17. From the Predecessors list, select a name of a field that represents a reference to

the preceding main ClearQuest request

7.2 Project record settings

To configure project request, follow the steps below:

1. From the Record Type list, select a name of a request type

2. From the Edit field, select a name of an action that will be used for generating

child records

3. From the Headline list, select a name of a field that corresponds to the project

ClearQuest request


description of the project ClearQuest request

5. From the Project managerlist, select a name of a field that corresponds to a

project manager of the project ClearQuest request

6. From the Plan start list, select a name of a field corresponding to a planned date

of starting work in the project ClearQuest request

7. From the Plan finish list, select a name of a field corresponding to a planned date

of finishing work in the project ClearQuest request

8. From the Plan cost list, select a name of a field corresponding to a planned costs

of works in the project ClearQuest request

9. From the Actual start list, select a name of a field corresponding to an actual date

of starting work in the project ClearQuest request



33

10. From the Actual finish list, select a name of a field corresponding to an actual

date of finishing work in the project ClearQuest request

11. From the Actual cost list, select a name of a field corresponding to an actual costs

of works in the project ClearQuest request

12. From the Task reference list, select a name of a field that represents a reference

to the main ClearQuest request

13. From the Project reference from main record list, select a name of a field that

represents a reference from the main ClearQuest request to the project ClearQuest

request

14. From the Percent list, select a name of a field corresponding to a work

completion rate in the project ClearQuest request

15. From the Statelist, select a name of a field corresponding to a work completion

rate in the project ClearQuest request

7.3 Additional record setting

Settings of additional requests can be of two types: main settings and relationship

settings. The main settings include a general description of the additional request, and relations

of the additional request to the main request, and a project. Relationship settings define relations

between additional requests.

To configure the main settings, follow the steps below:

1. From the Record Type list, select a name of a record type

2. From the Edit field, select a name of an action that will be used for binding child

requests

3. From the Headline list, select a name of a field that corresponds to the additional

ClearQuest request


description of the additional ClearQuest request

5. From the Resourcelist, select a name of a field that corresponds to an owner of

the additional ClearQuest request

6. From the Planned start date list, select a name of a field corresponding to a

planned date of starting work in the additional ClearQuest request



34

7. From the Planned finish date list, select a name of a field corresponding to a

planned date of starting work in the additional ClearQuest request

8. From the Child record reference list, select a name of a field that represents a

reference to a main ClearQuest request

9. From the Reference to main record list, select a name of a field that represents a

reference from the main ClearQuest request to the additional ClearQuest request

10. From the Project reference list, select a name of a field that represents a

reference to the project ClearQuest request

11. From the Reference from project list, select a name of a field that represents a

reference from the project ClearQuest request to the additional ClearQuest request

12. Click Add

To configure relations between additional requests, follow the steps below:

1. From the Record Type list, select the ClearQuest request type with the main

settings configured

2. From the Reference entity name list, select the name of the field

3. From the Reference field name list, select the name of the field

4. From the BackReference field name list, select the name of the field

5. From the Hard reference list, select the necessary relationship type

6. Click Add

To edit values in the table with results, follow the steps below:

1. In the table, select a line that to be edited

2. Change corresponding values

3. Click Edit

To delete lines from the table with results, follow the steps below:

1. In the table, select a line that to be deleted

2. Click Delete



35

7.4 Additional fields settings

To configure the additional fileds, you should add lines to the Add fields table. The

properties of the main fields are described in the Configuration section.

To configure the additional settings, follow the steps below:

1. From the Custom CQ Entity list, select a name of the ClearQuest request type

2. From the Name ClearQuest field list, select the name of the ClearQuest request

field

3. From the MSProject field list, select a name of the MS Project field

4. Select the necessary type of access to a field

5. If the field represents a list in the ClearQuest record, select the List option

a. If the field represents a reference to the record, select the Reference option

i. From the Record type list, select a type of the record that is referenced

by the field

ii. From the Field list, select the field of the record type defined above

(the value in this field is used for the reference)

iii. To create a filter, select the necessary Filter field that will be used for

filtering, and click +. In the Value field, type the value of the filter

after the = sign.

b. If the field represents a dynamic list, select the Named List field, and the list

name from the field that is being activated

6. Click Add

To edit values in the table with results, follow the steps below:

1. In the table, select a line that to be edited

2. Change corresponding values

3. Click Change

To delete lines from the table with results, follow the steps below:

1. In the table, select a line that to be deleted

2. Click Delete



36

7.5 Resource settings

To configure the resource settings, follow the steps below:

1. If users should be downloaded automatically into the plan, select the Autoload

users to MSProject plan option

a. If identification of owners should be performed using the ClearQuest entity

different from the Users entity, select the Use non-standard user entity option

i. From the Record Type list, select the necessary entity

ii. Select the Resource field that contains an owner’s name

iii. Select the Description field that contains a detailed description of an

owner

iv. Select the Email field that contains an owner’s e-mail

v. Select the Phone field that contains an owner’s phone number

b. If users should be downloaded from the global pool in MS Project Server, select

the Use db access for MSProject Server option

i. In the Database server field, define a name of server hosting MS Project

Server databases

ii. In the Database name field, define a name of the MS Project Server

database

iii. In the User name field, define a user name for accessing the database

server hosting MS Project Server

iv. In the Password field, define a password of the user defined above

2. From the Use plan assignment in list, select variants of planned workload change

3. From the Use actual work in list, select variants of actual workload change

7.6 Additional settings

To configure additional settings, follow the steps below:

1. Request is configured by default for every new project of MS Project

a. Click Select, and from the opened window, select a record type for whicha request should be selected (see Figure 22 – Choosing a record type forthe request), then click OK



37

Figure 22 – Choosing a record type for the request

b. In the opened window, select the necessary request, and click Run or

double-click the request to run it (see Figure 23 – Selecting a request);

then click OK

Figure 23 – Selecting a request

c. To remove association between the project and the request, click Clear

2. If the Every task have ClearQuest record option is selected, the ClearQuest

field in the plan will be ignored, and all tasks in the plan will be processed upon

save, import and refresh operations

3. If the Autocalculate off option is selected, automatic calculation will be switched

off before all operations that significantly increase the module performance when

there is a large number of tasks After the operations are completed, the project is

recalculated, and automatic calculation switches on



38

4. Special fields – all system fields necessary for the plan should be filed in System

fields should be used only for synchronization, and should not be changed

needlessly If some fields should not be displayed in the plan, they can be hidden

5. Using default values:

a. From the Field list, select a name of the ClearQuest field

b. In the Value field, enter the default value

c. Select the necessary method of using the field – always or empty

d. Click Add

e. To delete the unnecessary field, click Delete

8. Using the Program

8.1 Saving Tasks

For expoting the exisiting task plan from MS Project into ClearQuest, it is necessary that

the list of tasks have already been generated in MS Project, and properties necessary for

ClearQuest have been already set. The section below provides details on exorting the task plan:

1. Connect to the ClearQuest database (see Figure 24 – Connecting to the ClearQuest

database)

Figure 24 – Connecting to the ClearQuest database

After the connection is established successfully, the additional columns will be added

(see Figure 25 – Additional columns).



39

Figure 25 – Additional columns

2. Add new tasks, all necessary fields, and set a value of the ClearQuest field in

CQEntity

Figure 26 – New tasks for saving

3. Save the list of tasks (see Figure 27 – Saving tasks)



40

Figure 27 – Saving tasksIf the operation completes successfully, the following log will open (see Figure 28 –

Export log)

Figure 28 – Export log

4. After exporting, in the MS Project plan, system fields will be assigned to tasks (see

Figure 29 – Result of exporting tasks)



41

Figure 29 – Result of exporting tasks

5. After saving, in ClearQuest, new tasks will appear (see Figure 30 – New records in

ClearQuest)

Figure 30 – New records in ClearQuest

a. If the Predecessors field is configured in the module settings, then the

preceding records corresponding to tasks in the MS Project plan will be



42

automatically added into this field (see Figure 31 – Predecessor records in

ClearQuest)

Figure 31 – Predecessor records in ClearQuest

b. If the Child record reference field is configured in the module settings,

then the child records corresponding to tasks in the MS Project plan will be

automatically added into this field (see Figure 32 – Child records in

ClearQuest)

Figure 32 – Child records in ClearQuest



43

8.2 Creating a Query for Import in ClearQuest

The section below describes the steps you need to follow to create a query:

1. start ClearQuest and open the corresponding workspace

2. to create a new query, right-click the folder where the query will be stored, and click

New Query

Figure 33 – Creating a new query

3. In the Choose Record Type window, select a record type that should be

synchronized with the MS Project plan, and click OK

Figure 34 – Record type for query



44

4. Enter the query name, and click Enter

Figure 35 – Query name

5. To launch the ClearQuest query wizard, double-click the name of the new query, and

then click Next

Figure 36 – Query wizard – step 1

6. Select the list of fields displayed in the query resulting report , anmd click Next



45


7. Select a filtering type, if necessary


8. After the filter is configured, click Run. The query will be executed, and its result

will be displayed (see Figure 39 – Query result)



46

Figure 39 – Query result9. Save the query using the Save command in the File menu

8.3 Importing

To import tasks from ClearQuest, follow the steps below:

1. Connect to ClearQuest (see Figure 40 – Selecting an operation of importing tasks)

2. From the menu of the integration module, select the Import to MSP option (see

Figure 40 – Selecting an operation of importing tasks)

Figure 40 – Selecting an operation of importing tasks



47

3. If you want to use the query configured by default, the in the opened window (see

Figure 41 – Launching the Import dialog), select the Use default query option, and

click Start

Figure 41 – Launching the Import dialog

4. If you have not selected the Use default query option, then the window will open,

where you should select a query, run it, and, from the query results, select records that

should be imported into the MS Project plan (see Figure 42 – Selecting tasks for

importing )



48

Figure 42 – Selecting tasks for importing

5. In the Import window, in the log field, the list of imported tasks will be displayed

(see Figure 43 –Import log)

Figure 43 –Import log



49

6. In the plan, the imported tasks will be displayed (see Figure 44 –Result of importing

tasks)

Figure 44 –Result of importing tasks

8.4 Refreshing

The synchronization mode is necessary for refreshing tasks in the plan. To refresh tasks,

perform the following steps:

1. Open the up-to-date MS Project plan, and establish connection with ClearQuest

2. From the menu of the integration module, select the Refresh MSP plan option (see

Figure 45 – Selecting a synchronization operation)



50

Figure 45 – Selecting a synchronization operation

3. In the opened window (see Figure 46 – Launching the Synchronization dialog), click

Start

Figure 46 – Launching the Synchronization dialog

4. The Synchronization log window will open (see Figure 47 –Synchronization log)



51

Figure 47 –Synchronization log

8.5 Opening a User Interface Form of the ClearQuest Request from

MS Project

From MS Project, you can open the ClearQuest request form. To open the form, in the

plan, select a task that is associated with the ClearQuest request (for this record, the ClearQuest

identifier is defined); then, from the menu of the integration module, select Open CQ form (see

Figure 48 – Opening a ClearQuest request form). The ClearQuest form of the selected request

will open (see Figure 49 – ClearQuest request opened from MS Project).



52

Figure 48 – Opening a ClearQuest request form

Figure 49 – ClearQuest request opened from MS Project



53

8.6 Creating a New ClearQuest Request

The integration module supports creation of new ClearQuest request from MS Project. To

create a new request, follow the steps below:

1. From the menu of the integration module, select New

Figure 50 – Creating a new ClearQuest request

2. The dialog window with the list of all ClearQuest requests will open. Select the

necessary ClearQuest request, and click OK



54

Figure 51 – Selecting a type of the ClearQuest request

3. In the form of the new ClearQuest request, fill in all the fields, and click OK

Figure 52 – Form of a new ClearQuest request



55

8.7 Importing a License Key

Without a license key, the module works in demonstration mode (see Figure 53 –

Demonstration mode). In the demonstration mode, only the following functions are available:

· Importing ClearQuest requests into the MS Project plan

· Creating a new ClearQuest request

· Accessing forms of ClearQuest requests that were imported into the MS Project

plan

Figure 53 – Demonstration mode

To import a license key, follow the steps below:

1. From the menu of the integration module, select About



56

Figure 54 – Importing a license key

2. In the opened window, click Import license

Figure 55 – About window

3. select the location of the license key on the local disk



57

Figure 56 – Selecting a license key

4. After the license key is imported, restart MS Project to activate the key

Figure 57 – Successful import of the license key



58

List of FiguresFigure 1 – Basic operations .............................................................................................. 6

Figure 2 – Project-Request-Task relationship ................................................................... 7

Figure 3 – Project-Task relationship ................................................................................ 9

Figure 4 – Request-Task relationship ............................................................................. 11

Figure 5 – Task-Task relationship .................................................................................. 13

Figure 6 – Integrated menu ............................................................................................ 14

Figure 7 – ClearQuest session authorization window ..................................................... 15

Figure 8 – The Main tab ................................................................................................ 18

Figure 9 – The Project tab .............................................................................................. 20

Figure 10 – The Add record types tab ............................................................................ 21

Figure 11 – The Add fields tab....................................................................................... 23

Figure 12 – The Resources Tab...................................................................................... 24

Figure 13 – The Add settings tab ................................................................................... 26

Figure 14 – Launching the Export dialog ....................................................................... 27

Figure 15 – Export log ................................................................................................... 27

Figure 16 – Launching the Import dialog ....................................................................... 28

Figure 17 – Selecting requests for importing .................................................................. 28

Figure 18 – Import log ................................................................................................... 29

Figure 19 – Launching the Synchronization dialog ........................................................ 29

Figure 20 – Synchronization log .................................................................................... 30

Figure 21 – Adjusting module settings ........................................................................... 30

Figure 22 – Choosing a record type for the request ........................................................ 37

Figure 23 – Selecting a request ...................................................................................... 37

Figure 24 – Connecting to the ClearQuest database ....................................................... 38

Figure 25 – Additional columns ..................................................................................... 39

Figure 26 – New tasks for saving ................................................................................... 39

Figure 27 – Saving tasks ................................................................................................ 40

Figure 28 – Export log ................................................................................................... 40

Figure 29 – Result of exporting tasks ............................................................................. 41

Figure 30 – New records in ClearQuest ......................................................................... 41



59

Figure 31 – Predecessor records in ClearQuest .............................................................. 42

Figure 32 – Child records in ClearQuest ........................................................................ 42

Figure 33 – Creating a new query .................................................................................. 43

Figure 34 – Record type for query ................................................................................. 43

Figure 35 – Query name ................................................................................................ 44

Figure 36 – Query wizard – step 1 ................................................................................. 44



Figure 39 – Query result ................................................................................................ 46

Figure 40 – Selecting an operation of importing tasks .................................................... 46

Figure 41 – Launching the Import dialog ....................................................................... 47

Figure 42 – Selecting tasks for importing ....................................................................... 47

Figure 43 –Import log .................................................................................................... 48

Figure 44 –Result of importing tasks ............................................................................. 48

Figure 45 – Selecting a synchronization operation ......................................................... 49

Figure 46 – Launching the Synchronization dialog ........................................................ 50

Figure 47 –Synchronization log ..................................................................................... 50

Figure 48 – Opening a ClearQuest request form............................................................. 51

Figure 49 – ClearQuest request opened from MS Project ............................................... 52

Figure 50 – Creating a new ClearQuest request .............................................................. 53

Figure 51 – Selecting a type of the ClearQuest request .................................................. 54

Figure 52 – Form of a new ClearQuest request .............................................................. 54

Figure 53 – Demonstration mode ................................................................................... 55

Figure 54 – Importing a license key ............................................................................... 56

Figure 55 – About window ............................................................................................ 56

Figure 56 – Selecting a license key ................................................................................ 57

Figure 57 – Successful import of the license key ............................................................ 57

cqproject tracker user guide

Technology

project record settings

module settings

additional settings

consult http

resource settings

main record settings

additional fields settings

new clearquest request