1. MS Project and ClearQuest Integration Module ProjectTracker Version 2.5.1 User Guide LLC CM-Consult 2009

2. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ Contents 1. LIST OF ABBREVIATIONS, CONVENTIONS AND TERMS........................................................... 42. GLOSSARY ........................................................................................................................................... 43. INTRODUCTION.................................................................................................................................. 5 3.1 PURPOSE OF THIS DOCUMENT ............................................................................................................... 53.2 FIELD OF APPLICATION ......................................................................................................................... 53.3 IMPLEMENTATION ................................................................................................................................ 53.4 SYSTEM REQUIREMENTS ...................................................................................................................... 54. GENERAL DESCRIPTION .................................................................................................................. 5 4.1 USAGE VARIANTS ................................................................................................................................. 65. FUNCTIONALITY.............................................................................................................................. 146. DESCRIPTION OF USER INTERFACE FORMS ............................................................................ 14 6.1 AUTHORIZATION ................................................................................................................................ 156.2 CONFIGURATION ................................................................................................................................ 156.3 SAVING ............................................................................................................................................. 266.4 IMPORTING ........................................................................................................................................ 276.5 REFRESHING ...................................................................................................................................... 297. ADJUSTING MODULE SETTINGS .................................................................................................. 30 7.1 MAIN RECORD SETTINGS .................................................................................................................... 317.2 PROJECT RECORD SETTINGS ................................................................................................................ 327.3 ADDITIONAL RECORD SETTING............................................................................................................ 337.4 ADDITIONAL FIELDS SETTINGS ............................................................................................................ 357.5 RESOURCE SETTINGS .......................................................................................................................... 367.6 ADDITIONAL SETTINGS ....................................................................................................................... 368. USING THE PROGRAM .................................................................................................................... 38 8.1 SAVING TASKS ................................................................................................................................... 388.2 CREATING A QUERY FOR IMPORT IN CLEARQUEST .............................................................................. 438.3 IMPORTING ........................................................................................................................................ 468.4 REFRESHING ...................................................................................................................................... 498.5 OPENING A USER INTERFACE FORM OF THE CLEARQUEST REQUEST FROM MS PROJECT ....................... 518.6 CREATING A NEW CLEARQUEST REQUEST .......................................................................................... 538.7 IMPORTING A LICENSE KEY ................................................................................................................ 55 2 3. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ LIST OF FIGURES....................................................................................................................................... 583 4. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 1. List of abbreviations, conventions and termsAbbreviationExpansion ProjectTrackerMS Project and ClearQuest Integration Module MSMicrosoft MPS, MS Project Microsoft Office Project Professional 2003/2007 2. Glossary Term Interpretation ClearQuest Software change management system IMB Rational ClearQuest ClearQuest ClearQuest entity (Defect, Task, etc.) entity type4 5. 3. Introduction3.1Purpose of This DocumentThe 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 module3.2Field of ApplicationThe document relates to the ProjectTracker module, and is intended for the end user (project manager) of the change management system.3.3ImplementationThe 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.4System 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.04. 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. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/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 MS Project systems using the following basic data exchange operations (see Figure 1 Basic operations): Saving Tasks Importing tasks Refreshing tasks Figure 1 Basic operations4.1Usage variantsThis 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 HierarchyThe 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.6 7. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/BackReferenceReferenceFigure 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, andthey are associated with the following tasks of the MS Project plan:1) The Project type of ClearQuest entity the first nesting level2) The Request type of ClearQuest entity the second nesting level3) The Task type of ClearQuest entity - the thirds and subsequent nesting levels2. The ClearQuest entity type used for identification of a project must comply withthe following requirements:1) Availability of the following fields:i. Name mandatory ii. Description optionaliii. Owner - optionaliv. Percent complete optional v. Plan start date optionalvi. Plan finish date optionalvii. Actual start date optional viii. Actual finish date optionalix. Planned cost optional x. Actual cost optionalxi. Task reference optionalxii. Request reference optional 7 8. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/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:1) Availability of the following fields:i. Headline mandatory ii. Description optionaliii. 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 requests2) An action available that provides a possibility to edit a record 4. The ClearQuest entity type used for identification of a task must comply with thefollowing requirements:1) Availability of the following fields:i. Headline mandatory ii. Description optionaliii. Plan start date mandatory iv. Plan finish date mandatory v. Actual start date mandatory vi. Actual finish date mandatoryvii. 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 hierarchy is necessary 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 tasksxii. Predecessors optional8 9. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/xiii. Plan work optionalxiv. Actual work optional 2) An action available that provides a possibility to edit a recordProject-Task HierarchyThe figure below (see Figure 3 Project-Task relationship) describes the Project-Task relationship between ClearQuest entities and MS Project tasks. BackReferenceReferenceFigure 3 Project-Task relationshipDescription of the Project-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 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: 1) Availability of the following fields: i. Name mandatoryii. Description optionaliii. Owner - optionaliv. Percent complete optional9 10. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/v. Plan start date optional vi. Plan finish date optional vii. Actual start date optionalviii. Actual finish date optional ix. Planned cost optionalx. Actual cost optional xi. Task reference optional 2) An action available that provides a possibility to edit a record3. The ClearQuest entity type used for identification of a task must comply with the following requirements: 1) Availability of the following fields: i. Headline mandatoryii. Description optional iii. Plan start date mandatory iv. Plan finish date mandatoryv. Actual start date mandatory vi. Actual finish date mandatory vii. Owner mandatoryviii. Child task reference mandatory, in case implementation of taskhierarchy is necessary ix. Parent task reference mandatory, in case implementation of taskhierarchy is necessaryx. Project reference mandatory, in case there is no reference to tasksfrom the project xi. Predecessors optional xii. Plan work optionalxiii. Actual work optional 2) An action available that provides a possibility to edit a record Request-Task Hierarchy 10 11. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/The figure below (see Figure 4 Request-Task relationship) describes the Request-Task relationship between ClearQuest entities and MS Project tasks. BackReferenceReferenceFigure 4 Request-Task relationshipDescription of the 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 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: 1) Availability of the following fields:i. Headline mandatoryii. Description optional iii. Plan start date optional iv. Plan finish date optionalv. Child task reference - optional, in case tasks have references to requests 2) An action available that provides a possibility to edit a record 3. The ClearQuest entity type used for identification of a task must comply with the following requirements: 1) Availability of the following fields:11 12. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ i. Headline mandatoryii. Description optional iii. Plan start date mandatoryiv. Plan finish date mandatoryv. Actual start date mandatoryvi. Actual finish date mandatory vii. Owner mandatoryviii. Child task reference mandatory, in case implementation of tasknesting is necessaryix. Parent task reference mandatory, in case implementation of tasknesting is necessaryx. Request reference mandatory, in case there is no reference fromthe request to tasksxi. Predecessors optional xii. Plan work optionalxiii. Actual work optional 2) An action available that provides a possibility to edit a recordTask-Task HierarchyThe figure below (see Figure 5 Task-Task relationship) describes the Task-Task relationaship between ClearQuest entities and MS Project tasks.12 13. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/Figure 5 Task-Task relationship Description of the Task-Task relationship:1. In this hierarchy type, the following types of ClearQuest entities are used, andthey are associated with the following tasks of the MS Project plan: 1) The Task type of ClearQuest entity - the firtst and subsequent nesting levels2. The ClearQuest entity type used for identification of a task must comply with thefollowing requirements: 1) Availability of the following fields: i. Headline mandatory ii. Description optionaliii. Plan start date mandatoryiv. Plan finish date mandatory v. Actual start date mandatoryvi. Actual finish date mandatory vii. Owner mandatory viii. Child task reference mandatoryix. Parent task reference mandatory x. Predecessors optionalxi. Plan work optional xii. Actual work optional 2) An action available that provides a possibility to edit a record13 14. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 5. FunctionalityThe ProjectTracker module supports the following functionality: Supports hierarchical relations in ClearQuest requests Allows importing requests from the ClearQuest database into MS Project planwith restoration of ClearQuest request hierarchy (the module supports hierarchicalrelations not only between requests of the same type, but also between requests ofdifferent types) Supports synchronization of any types of fields Imports user accounts from the ClearQuest database, and allows using them asresources 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 requestforms from the shortcut menu6. 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 menu14 15. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/The menu and the toolbar provide access to the following functions:1.Connect connecting to ClearQuest;2.New creating a new ClearQuest request3.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.1AuthorizationThe 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 window6.2ConfigurationIn the Configuration dialog, there are six tabs: 15 16. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/1. The Main tab allows adjusting the main request fields necessary for planning2. The Project tab allows configuring mapping between the ClearQuest requestand the project, fields of the MS Project plan3. The Add request tab allows configuring the ClearQuest additional requests thatshould be reflected in the plan4. The Add fields tab if necessary, the tab allows configuring the ClearQuestrequests additional fields that will be included into the plan5. The Resources tab allows configuring automatic import of ClearQuest or MSProject Server users into the plan6. The Add settings tab allows adjusting the following parameters: defaultrequest, 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 theMS 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 ownerfor a task Change only plan dates and resources if this option is selected, only plandates and resources will be saved in ClearQuest upon refreshing. Otherwise, allchanged fields of the task will be saved. Update plan dates and resources from CQ select this option, if plan dates andresources edited in ClearQuest should be updated in the MS Project plan as wellupon the MS Project plan refreshing Otherwise, these changes will be ignored andrewritten upon saving the plan in ClearQuest. Headline this field contains a brief description of the ClearQuest request, andwill 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 plan16 17. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 owners 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.17 18. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 8 The Main tab 6.2.2 The Project TabOn 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 theClearQuest system Edit action Edit the action that should be performed to edit a project recordin the ClearQuest system. This action should be defined if it is necessary tosynchronize planned and actual dates, completion rate, project costs in the MSProject plan with those in the ClearQuest system, and if it is necessary to linkchild requests directly from the project entity in ClearQuest. Use baseline for planning select this option, only if it is necessary to editplanned dates of the ClearQuest project from MS Project. In this case, the baselinedefined 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 onthe project18 19. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 reference19 20. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ Figure 9 The Project tab 6.2.3 The Add Record Types TabAdditional 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 inClearQuest; 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 theClearQuest record; Planned finish date this field contains a plan date for finishing work in theClearQuest 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 typeconfiguration field on the Main tab 20 21. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ Reference from main record this field contains a reference from the mainrequest 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 aconfigurable 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 froma table Change click this button to adjust settings of a record selected from the table ofadditional requests Figure 10 The Add record types tab 6.2.4 The Add Fields TabAdditional 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 configured21 22. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 table22 23. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 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 usedo Record type a name of the User entityo Resource the entity field containing an owner s nameo Description a detailed description of a usero Email the field containing a users e-mailo 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 taskso Database server a name of a database server that hosts the MS Project Server databases23 24. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 TabOn 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 operations24 25. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 defaultvalueso Value a default value A default value can be static, or can be equal tothe value of any MS Project field. In the latter case, the field name shouldbe 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 table25 26. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ Figure 13 The Add settings tab 6.3SavingAfter 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 atask, the ClearQuest request is converted into a next state by the Assigneeaction26 27. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ Figure 14 Launching the Export dialogExport log is displayed in the following format (see Figure 15 Export log): Figure 15 Export log6.4 ImportingThe 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 tab27 28. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ Figure 16 Launching the Import dialogIf 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 importingImport log is displayed in the following format (see Figure 18 Import log): 28 29. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 18 Import log6.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): 29 30. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ Figure 20 Synchronization log7. 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 settingsTo 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. 30 31. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 7.1Main 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 tothe main request2.From the Edit field, select a name of an action that will be used for editing theClearQuest records3.From the Assignee action, select a name of an action that will be used forconverting the ClearQuest request into the next state upon assigning a resource fora task4.Select the Change only plan dates and resources option, if only planned datesand resources should be changed upon saving values into the available ClearQuestrequest5.Select the Update plan dates and resources from CQ option, if changes ofplanned dates and resources made in ClearQuest should be applied tocorresponding tasks of the MS Project plan upon refresh operation6.From the Headline list, select a name of a field that corresponds to the mainClearQuest request7.From the Description list, select a name of a field that contains a detaileddescription of the main ClearQuest request8.From the Headline list, select a name of a field that corresponds to the mainClearQuest request9.From the Plan start date list, select a name of a field corresponding to a planneddate of starting work in the main ClearQuest request10. From the Plan finish date list, select a name of a field corresponding to a planneddate of finishing work in the main ClearQuest request11. From the Plan assignment work list, select a name of a field corresponding to aplanned work load in the main ClearQuest request12. From the Actual start date list, select a name of a field corresponding to anactual date of starting work in the main ClearQuest request 31 32. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 13.From the Actual finish date list, select a name of a field corresponding to anactual date of finishing work in the main ClearQuest request 14.From the Actual assignment work list, select a name of a field corresponding toan 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 areference to a child main ClearQuest request 16.From the Parent record reference list, select a name of a field that represents areference to the parent main ClearQuest request 17.From the Predecessors list, select a name of a field that represents a reference tothe preceding main ClearQuest request7.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 generatingchild records 3. From the Headline list, select a name of a field that corresponds to the projectClearQuest request 4. From the Description list, select a name of a field that contains a detaileddescription of the project ClearQuest request 5. From the Project managerlist, select a name of a field that corresponds to aproject manager of the project ClearQuest request 6. From the Plan start list, select a name of a field corresponding to a planned dateof starting work in the project ClearQuest request 7. From the Plan finish list, select a name of a field corresponding to a planned dateof finishing work in the project ClearQuest request 8. From the Plan cost list, select a name of a field corresponding to a planned costsof works in the project ClearQuest request 9. From the Actual start list, select a name of a field corresponding to an actual dateof starting work in the project ClearQuest request32 33. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/10. From the Actual finish list, select a name of a field corresponding to an actualdate of finishing work in the project ClearQuest request11. From the Actual cost list, select a name of a field corresponding to an actual costsof works in the project ClearQuest request12. From the Task reference list, select a name of a field that represents a referenceto the main ClearQuest request13. From the Project reference from main record list, select a name of a field thatrepresents a reference from the main ClearQuest request to the project ClearQuestrequest14. From the Percent list, select a name of a field corresponding to a workcompletion rate in the project ClearQuest request15. From the Statelist, select a name of a field corresponding to a work completionrate in the project ClearQuest request7.3Additional record settingSettings 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 type2.From the Edit field, select a name of an action that will be used for binding childrequests3.From the Headline list, select a name of a field that corresponds to the additionalClearQuest request4.From the Description list, select a name of a field that contains a detaileddescription of the additional ClearQuest request5.From the Resourcelist, select a name of a field that corresponds to an owner ofthe additional ClearQuest request6.From the Planned start date list, select a name of a field corresponding to aplanned date of starting work in the additional ClearQuest request 33 34. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 7. From the Planned finish date list, select a name of a field corresponding to aplanned date of starting work in the additional ClearQuest request 8. From the Child record reference list, select a name of a field that represents areference to a main ClearQuest request 9. From the Reference to main record list, select a name of a field that represents areference from the main ClearQuest request to the additional ClearQuest request 10.From the Project reference list, select a name of a field that represents areference to the project ClearQuest request 11.From the Reference from project list, select a name of a field that represents areference 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 mainsettings 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 34 35. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 7.4Additional fields settingsTo 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 type2.From the Name ClearQuest field list, select the name of the ClearQuest requestfield3.From the MSProject field list, select a name of the MS Project field4.Select the necessary type of access to a field5.If the field represents a list in the ClearQuest record, select the List optiona. If the field represents a reference to the record, select the Reference optioni. From the Record type list, select a type of the record that is referenced by the fieldii. 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 listname from the field that is being activated6.Click AddTo edit values in the table with results, follow the steps below:1.In the table, select a line that to be edited2.Change corresponding values3.Click ChangeTo delete lines from the table with results, follow the steps below:1.In the table, select a line that to be deleted2.Click Delete35 36. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 optiona. 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 owners nameiii. Select the Description field that contains a detailed description of an owneriv. Select the Email field that contains an owners e-mail v. Select the Phone field that contains an owners phone numberb. 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 databaseiii. In the User name field, define a user name for accessing the database server hosting MS Project Serveriv. 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 change7.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 OK36 37. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 22 Choosing a record type for the requestb. In the opened window, select the necessary request, and click Run ordouble-click the request to run it (see Figure 23 Selecting a request);then click OK Figure 23 Selecting a requestc. To remove association between the project and the request, click Clear 2. If the Every task have ClearQuest record option is selected, the ClearQuestfield in the plan will be ignored, and all tasks in the plan will be processed uponsave, import and refresh operations 3. If the Autocalculate off option is selected, automatic calculation will be switchedoff before all operations that significantly increase the module performance whenthere is a large number of tasks After the operations are completed, the project isrecalculated, and automatic calculation switches on37 38. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/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 hidden5. 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 Delete8. Using the Program8.1Saving TasksFor 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 ClearQuestdatabase)Figure 24 Connecting to the ClearQuest databaseAfter the connection is established successfully, the additional columns will be added (see Figure 25 Additional columns). 38 39. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 25 Additional columns 2. Add new tasks, all necessary fields, and set a value of the ClearQuest field inCQEntityFigure 26 New tasks for saving 3. Save the list of tasks (see Figure 27 Saving tasks)39 40. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/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 (seeFigure 29 Result of exporting tasks)40 41. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/Figure 29 Result of exporting tasks 5. After saving, in ClearQuest, new tasks will appear (see Figure 30 New records inClearQuest) 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 be41 42. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/automatically added into this field (see Figure 31 Predecessor records inClearQuest) 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 beautomatically added into this field (see Figure 32 Child records inClearQuest)Figure 32 Child records in ClearQuest 42 43. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 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 clickNew Query Figure 33 Creating a new query 3. In the Choose Record Type window, select a record type that should besynchronized with the MS Project plan, and click OK Figure 34 Record type for query 43 44. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 4. Enter the query name, and click EnterFigure 35 Query name 5. To launch the ClearQuest query wizard, double-click the name of the new query, andthen click NextFigure 36 Query wizard step 1 6. Select the list of fields displayed in the query resulting report , anmd click Next44 45. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 37 Query wizard step 2 7. Select a filtering type, if necessaryFigure 38 Query wizard step 3 8. After the filter is configured, click Run. The query will be executed, and its resultwill be displayed (see Figure 39 Query result)45 46. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 39 Query result 9. Save the query using the Save command in the File menu8.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 (seeFigure 40 Selecting an operation of importing tasks)Figure 40 Selecting an operation of importing tasks46 47. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 3. If you want to use the query configured by default, the in the opened window (seeFigure 41 Launching the Import dialog), select the Use default query option, andclick StartFigure 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 thatshould be imported into the MS Project plan (see Figure 42 Selecting tasks forimporting )47 48. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 48 49. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/6. In the plan, the imported tasks will be displayed (see Figure 44 Result of importingtasks) Figure 44 Result of importing tasks8.4RefreshingThe 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 ClearQuest2. From the menu of the integration module, select the Refresh MSP plan option (seeFigure 45 Selecting a synchronization operation)49 50. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ Figure 45 Selecting a synchronization operation 3. In the opened window (see Figure 46 Launching the Synchronization dialog), clickStart Figure 46 Launching the Synchronization dialog 4. The Synchronization log window will open (see Figure 47 Synchronization log)50 51. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 47 Synchronization log8.5Opening a User Interface Form of the ClearQuest Request from MS ProjectFrom 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). 51 52. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/Figure 48 Opening a ClearQuest request formFigure 49 ClearQuest request opened from MS Project52 53. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 8.6Creating a New ClearQuest RequestThe 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 NewFigure 50 Creating a new ClearQuest request2. The dialog window with the list of all ClearQuest requests will open. Select the necessary ClearQuest request, and click OK53 54. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/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 OKFigure 52 Form of a new ClearQuest request 54 55. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 8.7Importing a License KeyWithout 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 planFigure 53 Demonstration modeTo import a license key, follow the steps below: 1. From the menu of the integration module, select About 55 56. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 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 56 57. CM-Consulthttp://www.rational-tools.com http://www.cmcons.com/about_us/eng/ 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 57 58. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ List of Figures Figure 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 58 59. CM-Consult http://www.rational-tools.comhttp://www.cmcons.com/about_us/eng/ 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 37 Query wizard step 2 ................................................................................. 45 Figure 38 Query wizard step 3 ................................................................................. 45 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............................................................ 5759