YOOtheme
No Flash!

Tag: ibm

These items have all been tagged with the tag "ibm", You can see other tags in the Tag Cloud

CM Consult extends it licensing schemes and announces the introduction of fixed-term licenses

CM-Consult, rational-tools.info CM-Consult is now offering one year fixed-term licenses for packages that were previously available with a perpetual license only. Some of CM-Consult product packages are now available with both perpetual and fixed-term licenses. CM-Consult company gathered feedback from its clients and concluded that it would be benefitial for them to have an opportunity to choose between perpetual and fixed-term licenses when purchasing CM-Consult products.

 

One year fixed-term licenses offer several benefits. Fixed-term licenses:

  • Provide a lower introduction cost than perpetual licenses and offer a lower-cost option for projects of a shorter duration.
  • Include support and maintenance, so there is no additional maintenance cost.
  • May be used to provide a better method to control and allocate cost to individual projects and may allow more flexibility in categories of procurement funds.



GanttChart for ClearQuest. New testimonials
The GanttChart for ClearQuest tool has proved to be a very successful add-on for the ClearQuest system. It significantly simplifies the planning process in ClearQuest. Standard integration of IBM Rational ClearQuest and MS Project allows solving a number of same tasks that GanttChart solves, but with GanttChart it is much more convenient to work with a large number of heterogeneous relations between change requests, including hierarchical and sequential relations. Besides, there is no need to use two tools at the same time – a project manager can well do with ClearQuest with GanttChart add-on installed.

Our experts have gained much use from this tool. GanttChart flexible settings allow configuring the necessary representation of a Gantt chart to be displayed
. Every user has got an opportunity to build “their own” Gantt chart, where they can see the set of tasks assigned to them, and every task can be highlighted by a necessary color depending on its status, that allows the user to organize their working time in the better way. Additionally GanttChart has particularly flexible creating a Gantt chart with any queries.
 
Christian Häussler, IT Software Development Manager, HUK Coburg AG, Germany.
 
Das Plug-in „GanttChart for ClearQuest“ hat sich als eine sehr gelungene Erweiterung für ClearQuest herausgestellt, die den Planungsvorgang im ClearQuest deutlich erleichtert. Die Standardintegration von IBM Rational ClearQuest und Microsoft Project ermöglicht zwar einige ähnliche Planungsvorgänge, doch die Arbeit mit einer größeren Anzahl verschiedenartiger Verbindungen zwischen verschiedenen Änderungsanfragen, einschließlich der Hierarchie und Verbindungen einer Abfolge von Anfragen, sind in GanttChart wesentlich besser realisiert. Außerdem braucht man nicht zwei verschiedene Programme gleichzeitig zu benutzen, denn mit GanttChart kann sich ein Projektmanager alleine auf ClearQuest festlegen, ohne regelmäßig umschalten zu müssen.

Unsere Mitarbeiter haben auch viel Nutzen aus GanttChart für sich gezogen. Flexible Einstellungen der Erweiterung GanttChart ermöglichen es, die abgebildete Darstellung des Gantt-Diagramms an die gewünschten Art und Weise anzupassen. Sowohl Projektleiter, als auch Mitarbeiter haben die Möglichkeit erhalten, ein „eigenes“ Gantt-Diagramm zu erstellen, auf dem genau die Zusammenstellung von Aufgaben und Aufträgen dargestellt wird, die ihnen zugewiesen wurden. Jede Aufgabe kann mit einer beliebigen Farbe entsprechend ihrem Status markiert werden. Das ermöglicht es dem Projektleiter einen schnellen Überblick über den Stand seines Projektes zu geben oder dem einzelnen Mitarbeiter, seine Arbeitszeit besser zu organisieren. Über die Möglichkeit, ein Gantt-Diagramm über eine beliebige Queries zu erzeugen ist das Plug-in GanttChart for ClearQuest besonders flexibel.
 
Christian Häussler, IT Software Development Manager, HUK Coburg AG,  Deutschland.
 

read more testimonials


'TimeTracker' Working hours tracking module for ClearQuest

Task to  be performed, active button on taskbar

IBM Rational ClearQuest TimeTracker allows you to improve the process of estimating time actually spent on tasks and increase effectiveness of working time planning, both personal and of the whole project. It also allows saving ClearQuest licenses used.
ClearQuest TimeTracker allows you to launch tracking of time spent on tasks by the single mouse click.
Since ClearQuest Time Tracker automatically gets the list of tasks and updates task statuses, the time an employee spends working with ClearQuest significantly reduces, that allows saving up to 40% of ClearQuest licenses. Such saving is achieved due to decrease of user session duration in ClearQuest.


CM-Consult is pleased to announce the release of special license packs

«Starter» license  packCM-Consult Company is pleased to announce the release of special license packs that include licenses for the most popular CM-Consult products (GanttChart for ClearQuest, ProjectTracker, UML2ClearQuest).  Besides, the license packs include one year of advanced technical support that allows you to get consultations of CM-Consult specialists and help in configuring ClearQuest Schema for effective use of GanttChart for ClearQuest and ProjectTracker. License packs also include high-priority modifications for our products made according to your requirements.   We often face a situation when our clients use non-standard ClearQuest schemas that require adapting GanttChart for ClearQuest and ProjectTracker. License packs allow our clients to get special versions of GanttChart for ClearQuest and ProjectTrackeradapted according to their requirements.
License packs also allow significantly save money since they include the most popular products at a big discount.  You will save from $7817,58 to $44 885 (30%-45%)  depending on the License pack type.
Further, our clients will be able to buy additional license packs and single products at a discount between 10% and 25%.
Available Packs: "Starter","Advanced" and "Professional".




The new version of GanttChart for ClearQuest is available!

GanttChart 1.3 for ClearQuestGanttChart for ClearQuest 1.3 is a plug-in for IBM Rational ClearQuest 7.1 or later version. This plug-in is of interest for everybody who uses IBM Rational ClearQuest and who lacks for project management functionality. The module does not substitute the existing project management tools. It just adds operational slices into IBM Rational. For most users, the functions provided by the plug-in are enough for planning and operation management (see more info).

New features in version 1.3:

1. Ability to demonstrate a workload diagram to the owners basing on the selected diagram or general workload by projects:

  • Building the owners workload diagram on basis of the Gantt chart built earlier or data from ClearQuest
  • Representing the owners workload diagram in two views: In task view with ability to perform planning; In bar chart vie
  • Building the workload diagram by owners
  • Distributing change requests into basic (for example, tasks that have planned dates and workload), and auxiliary (for example, defects and enhancement requests that do not have planned dates and workload) by workload
  • Splitting the workload diagram into sections by owners
  • Automatically synchronizing changes in the Gantt chart and the workload diagram to improve the effectiveness of planning

Read more (screenshots and video) -->




Site news. May'10: new article and technical information
Follow us on  Twitter
Besides, we have published testimonialsof our customers and IBM specialist on GanttChart. 

In Articles and Media section, the new articleImplementing IBM RSA and IBM ClearQuest integration: UML to State-Machine with RSA plug-in. Original sources are attached to the article. In the Technical information, release notes etc. section, the following materials have been published:



GanttChart for ClearQuest. User Guide. Ver 1.3

 

Main contacts

 

CM-Consult company

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

 

Company site: http://cmcons.com (Russian site) Blog: IBM Blog (English blog) E'mails: This e-mail address is being protected from spam bots, you need JavaScript enabled to view it and This e-mail address is being protected from spam bots, you need JavaScript enabled to view it
  • Moscow
    • Uznobutovskaya st, 23, Moscow, Russia
    • Phone & fax: +7(495) 648-63-28
  • Kaliningrad
    • Office 213, Garajnaya st. 2, Kaliningrad, Russia
    • Phone & fax: +7 (4012) 563671

     

Partners in Europe
Contacts in Germany, IBTS - International Business & Technology Solutions

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

E-mail: This e-mail address is being protected from spam bots, you need JavaScript enabled to view it Scheelestr. 108, D-12209 Berlin

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

Fax: +49 (0)30 755 14 348

Contents

1. List of Abbreviations and Terms

2. Glossary

3. Introduction

3.1 Field of Application of This Document

3.2 Purpose of This Document

3.3 System Requirements

4. General Description

5. Configuration

5.1 Setting up parameters

5.2 Export and import of settings

6. Using the plug-in

6.1 Building a Gantt chart

6.2 Opening forms

6.3 Modifying planned dates

6.4 Reassigning owners

6.5 Owners workload

6.6 Saving changes

6.7 Export information

6.8 Visualization of states

7. Appendix A

 

List of Abbreviations and Terms

Abbreviation Expansion
CM Change management
DB Database

Glossary

Term Interpretation
ClearQuest IBM Rational change management system
Change Request Document/ ClearQuest object

Introduction

Field of Application of This Document

This Guide is intended for users of ClearQuest.

Purpose of This Document

The document provides users with information on functionality of the GanttChart for ClearQuest application that allows effectively use ClearQuest when planning works and tracking their statuses. The document covers the following topics:
  • Configuring the application
  • Using the application

System Requirements

To be able to use the GanttChart for ClearQuest plug-in you must have
  • IBM Rational ClearQuest Eclipse Client 7.0.0 or later version.

General Description

GanttChart for ClearQuest is the plug-in for the Eclipse client for ClearQuest that provides the following opportunities:
Building a Gantt chart on basis of executed queries. It allows building a chart of any necessary view.
  • Visualizing change request hierarchy and relations between the requests in the form of a Gantt chart.
  • Visualizing task completion rate.
  • Visualizing ratio of planned to actual dates.
  • Visualizing change requests using different colour schemes depending on the completion rate and ratio of planned to actual dates.
  • Splitting a Gantt chart on sections for visualization of composite requests for more convenient analysis and work planning.
  • Changing and saving results of updating planned dates of change requests.
  • Assigning owners for change requests;
  • Visualizing workload of an owners;
  • Opening forms of change requests from a Gantt chart;
  • Printing;
  • Visualizing State Chart Diagram;
  • Exporting to MS Project XML file.

    Configuration

     

    Setting up parameters

     

     

    Configuration includes setting up the parameters of record types for which the Gantt chart will be build. First, you should set up the connection to the DB (see Figure 1. Setting up the connection to the ClearQuest database).

     


    Figure 1. Setting up the connection to the ClearQuest database

    To adjust the module settings, in the Window menu, select Preferences. (see Figure 2. Opening the dialog box for adjusting the module settings).

     


     

    Figure 2. Opening the dialog box for adjusting the module settings
    In the Preferences dialog box, on the left, select CMC Plug-ins/GanttChart for ClearQuest. The Preferences dialog box will open. (see Figure 3. Configuring the module (the ALMRequest entity is taken as an example). This dialog box contains the following tabs:
    1. Record types - on this tab, you can configure all necessary record types, for which the Gantt chart will be built.
    2. Record types hierarchy - on this tab, you can set up all necessary relations between change requests:
      1. Hierarchical relations
      2. Sequential relations
    3. Advanced - on this tab, you can adjust additional settings.
    4. Custom - on this tab, you can adjust some custom settings to make your work with GanttChart for ClearQuest more convenient.


    Figure 3. Configuring the module (the ALMRequest entity is taken as an example)

    The Record types tab contains the following settings:
    1. Connection - the list of active ClearQuest connections. In this list, you should select the connection to the user's ClearQuest database.
    2. Record types - the list of record types that are used in the user's ClearQuest DB. In this list, select the record types that should be used for building the Gantt chart. For every record type, you can set up a number of parameters displayed on the right of the record types list:
      1. Modify action - the action performed by ClearQuest to modify the change request. It is used for saving planned values for the change requests. This is an optional parameter. You need not set it up unless you need to save changes in the Gantt chart.
      2. Assign action - the action performed by ClearQuest to transfer a change request into the Assigned state. It is used if it is necessary to automatically transfer a change request into the Assigned state when an owner is assigned to the request. This is an optional parameter. You need not set it up unless you need to automatically transfer a change request into the Assigned state.
      3. Headline - this field contains a brief description. This is a mandatory parameter.
      4. Owner - this field contains a name of an owner assigned to a change request. This parameter is optional.
      5. Plan start date - this field contains a planned date of starting work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      6. Plan end date - this field contains a planned date of finishing work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      7. Actual start date - this field contains an actual date of starting work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      8. Actual end date - this field contains an actual date of finishing work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      9. Completing percent - this field contains the task completion rate. Its value should fall into the range between 0 and 100. This parameter is optional.


    Figure 4. Configuring the hierarchy for the ALMActivity entity

    For setting up relations between change requests, you should open the Record types hierarchy tab (see Figure 4. Configuring the hierarchy for the ALMActivity entity). This tab contains the Record types list containing the list of record types that were configured on the Record types tab. For every record type, you can set up a number of relationship parameters:

     

    1. Parameters for hierarchical relations, that are displayed in a Gantt chart as aggregated tasks:
      1. Parent record - a parent change request for the request that is currently being configured.
      2. Child record - a child change request for the request that is currently being configured.
    2. Parameters for the sequential relations:
      1. Predecessor record - a change request that goes before the request that is currently being configured.
      2. Successor record - a change request that goes after the request that is currently being configured.

     


    Figure 5. Additional settings

    The Advanced tab contains the following settings:
    1. Color theme - the color scheme that will be applied to a Gantt chart.
    2. Use color events - if this option is selected, all tasks will be highlighted by different colors depending on their states:
      1. Grey - the task has not been planned.
      2. Blue - the task has been planned and the plan end date has not come yet.
      3. Yellow - the task has been planned and is in progress.
      4. Crimson - the task has been planned, but the planned start date is past due.
      5. Red - the task has been planned and the planned finish date is past due.
      6. Green - the task is completed.
    3. Split chart by section - if this option is selected, the Gantt chart is divided into sections concerning records of the first level of hierarchy.
    4. Use AMWorkActivitySchedule package - if this option is selected, you can use the AMWorkActivitySchedule package.
    5. Use users - allows creating lists of owners for using them in the Gantt chart the workload diagram:
      1. Use the record choice list - creates the list of owners that corresponds to the selected record and its Owner field;
      2. Use owners workload - allows selecting the necessary User entity which will be used a basis for building a diagram of workload per owner.
      3. Use users record type - creates the list of owners on basis of the Users record type;
      4. Use specified record type - creates the list of owners on basis of the specified type of record Record type and its main field User name, which contains the owner name.
      5. Use record types for workload - a list of configured record types which will be used as a basis for building a workload diagram;
      6. Split a diagram into sections - a workload diagram in addition to splitting by owners will also be splitted into sections by record types.
    6. Enable change preferences by administrators only - if this option is selected, the settings can be edited only by users with Super user and Security admin privileges.


    Figure 6. Custom settings

    The Custom tab contains the following elements:
    • Auto build queries - allows defining the list of queries. As a result of execution of these queries, a Gantt chart will be automatically built.

    To finish the configuration, click Apply.

    Export and import of settings

    GanttChart for ClearQuest allows exporting and importing settings. You can do it in the Preferences window using the corresponding buttons (see Figure 7. Buttons for exporting and importing settings).

     

    Figure 7. Buttons for exporting and importing settings

    To export settings, perform the following steps:
    1. In the Preferences window, click Export.
    2. In the dialog box, select the directory and specify the name of the file that will store the imported settings.
    To import settings, perform the following steps:
    1. In the Preferences window, click Import.
    2. In the dialog box, select the file with the settings.
    3. To apply the new settings, click Apply.

    Using the plug-in

     

    Building a Gantt chart

    Since GanttChart for ClearQuest uses requests selected from the ClearQuest, to build a Gantt chart it is necessary to execute a query that will return the list of records (see Figure 8. Configuring the filter of displayed records).


    Figure 8. Configuring the filter of displayed records

    In the CMC Plug-ins menu, select GanttCart for ClearQuest (see Figure 9. Launching the plug-in). The new tab GanttCart for ClearQuest will open (see Figure 10. Plug-in's tab displayed in ClearQuest).


    Figure 9. Launching the plug-in

    On the GanttCart for ClearQuest tab, in the Executed queries list, select the executed query and, to build a Gantt chart, click Fill from result (see Figure 10. Plug-in's tab displayed in ClearQuest, Figure 11. Running a query).


    Figure 10. Plug-in's tab displayed in ClearQuest


    Figure 11. Running a query

    As a result of the plug-in installation and configuration, you will get the Gantt chart (see Figure 12. Displaying the Gantt chart).


    Figure 12. Displaying the Gantt chart

    Opening forms

    GanttChart for ClearQuest allows opening forms of change requests directly from a Gantt chart. To open a change request form, click the necessary task in the Gantt chart. The ClearQuest form will open where you can perform all regular operations with the request, i.e. view, modify, change its state, etc.
    Figure 13. ClearQuest Form Opened from a Gantt Chart

     

    Modifying planned dates

    GanttChart for ClearQuest supports changing planned dates directly from a Gantt chart. To be able to modify planned dates for tasks, you should specify the following parameters:
    1. Fields containing planned dates.
    2. Modify action for a record.
    To modify planned dates for a task on a Gantt chart, you should pull one of the tasks ends by the cursor. GanttChart for ClearQuest also supports grouped operations for tasks of a Gantt chart.
    1. Selecting a group of tasks. You can select multiple tasks by clicking Shift or Ctrl and selecting the necessary tasks. Also, you can select a group of tasks by clicking Ctrl and then, using the right mouse button, selecting an area on a Gantt chart where the necessary tasks are displayed (see Figure 14. Selecting a group of tasks)


    Figure 14. Selecting a group of tasks

    1. Modifying a group of tasks. To modify a group of tasks, you should modify one of the selected tasks holding the Ctrl button.
    2. Modifying connected tasks. To modify connected tasks, you should modify one of the selected tasks holding the Shift button.
    3. Aggregated tasks. When you move an aggregated task, its child tasks are also moved, including the aggregated ones.
    The plug-in allows evaluating how the new planned dates differ from the previous ones. To do it, right-click a Gantt chart and select Show Planned Dates (see Figure 15. Displaying the shift between old and new planned dates). In the chart, additional green and red lines appear indicating the shift between old and new planned start dates and planned finish dates correspondingly. If a task has actual dates, these lines will indicate the shift between actual and planned dates of the task.


    Figure 15. Displaying the shift between old and new planned dates

    Reassigning owners

    GanttChart for ClearQuest allows assigning owners for change requests directly from a Gantt chart. To make it possible, it is necessary to apply the following settings for the record type:
    1. Owner field.
    2. Modify or Assign action.
    To assign a new owner or reassign an existing owner, do the following:
    1. On a Gantt chart, right-click a task and select Assign owner.
    2. The dialog appears (see Figure 16. Selecting an owner) with the list of available owners. To find a necessary owner in a large list, use the filter field.


    Figure 16. Selecting an owner

    1. Click OK to save changes, or Cancel to quit without saving.
    2. Before you have saved the new settings, you can restore the previous owner by clicking Restore.

    Owners workload

    GanttChart for ClearQuest allows building a workload diagram by owners on basis of data from the Gantt chart built earlier or data from ClearQuest. There are two ways to open the workload diagram:
    1. From the toolbar of the Gantt Chart


    Figure 17. Opening the workload diagram from the toolbar

    1. From the right-click menu of a task on the Gantt chart. For every task that is used for building the workload diagram, there are two additional items in the right-click menu:
      1. Show owners workload - the workload diagram will be built for owners that are selected from the Owner list for the selected record type;
      2. Show workload of available owners - the workload diagram will be built for owners that are available in the Owner list for the selected record type. This menu item is available, if the Use the record choice list option is selected in owner settings.


    Figure 18. Opening the workload diagram from the right-click menu of a task


    Figure 19. Toolbar of the workload diagram

    To build the workload diagram, set the following parameters on the toolbar of the workload diagram (see Figure 19. Toolbar of the workload diagram):
    • Period - in this field, specify the start and the end dates of the period for which the diagram should be built. By default, the start date is equal to the current date; the end date is set as current date plus two months.
    • Style - allows setting the style of the workload diagram display.
      • Tasks - in the workload diagram, in a section for every owner, a list of tasks is displayed that are assigned to the owner for the specified period. The distinguishing feature of this diagram is that you can change the planned dates for the selected tasks right from the diagram;


    Figure 20. Workload diagram: the tasks view.

    • Bars - in a section for every owner, a bar chart is build, where the height of bars for every date represents the number of tasks assigned for this owner. The color of bars depends on the number of tasks assigned to the owner:
      • Blue - one task is assigned to the owner;
      • Yellow - two tasks are assigned to the owner;
      • Red - tree or more tasks are assigned to the owner;


    Figure 21. Workload diagram: the bar view

    • Source - this option allows selecting a source for building the workload diagram:
    1. GanttChart - the workload diagram is built on basis of tasks from the Gantt chart;
    2. ClearQuest - the workload diagram is built on basis of ClearQuest records.

     

    • Owners - a list of owners for which the workload diagram is build. To specify the owner list, click the Select owners


    Figure 22. Selecting owners

     

    1. To build or refresh the workload diagram, click the Build diagram
    2. Synchronization of task parameter changes - when the planned dates of a task are changed on one diagram, they are automatically changed on another. This functionality is available when the task view of workload diagram is selected;
    3. Synchronization of display period change - when you scroll one diagram in horizontal direction, the other diagram is scrolled synchronously;
    4. Synchronization of diagram zooming - when you click buttons Zoom in

    Figure 23. Synchronous display of diagrams

     

    Saving changes

    To save the results of planning in the Gantt chart, you can use two methods (see Figure 17. Saving changes.):

    • Complete saving of all changes Click


    Figure 17. Saving changes.

     


    Figure 18. Selecting tasks for saving

    The process of updating the planned dates is logged into the console window of the Eclipse client for ClearQuest (see Figure 19. Log of the planned dates saving process):


    Figure 19. Log of the planned dates saving process

    Export information

    GanttChart for ClearQuest allows you to export the displayed information to the file in MS Project XML. For export, follow these steps:
    • Click "Export";

    Figure 20. Exporting data

    • Set the file name that you want to export the information;


    Figure 21. Selecting file name

    • Launch MS Project and select "FileaOpen";
    • Choose a file export;


    Figure 22. Opening file

    • Select "Append the data to active project"


    Figure 23. Import Wizard

    • The new plan to add a display field "Text1" and "Text2", which contain CQID information and the type of record ClearQuest;


    Figure 24. Inserting text fields

    • Information on the planned dates stored in the baseline, so to display it on the MS Project Gantt chart to choose the type of View "Tracking Gantt"

    Figure 25. View "Tracking Gantt"

    Visualization of states

    GanttChart for ClearQuest allows you to view a state chart diagram for the selected change request. To do this, follow these steps:
    • At the required change request, right-click and choose "Show state chart"

    Figure 26. Openning state chart

    • On the resulting graph displays the states and transitions between states. In parentheses at the transitions is also reflected in the number of transitions executed during the entire lifecycle of the change request.

    Figure 27. StateChart Vizualizer

     

    Appendix A

    Example of ALM-schema configuration

    The following configuration is given for guidance only. This appendix contains detailed description of configuration and step-by-step instructions for adjusting the ALM-schema:
    • Changes in the schema. Since the ALM-schema does not have all necessary fields for setting planned and actual dates, you should add them using ClearQuest Designer. For the ALMActivity record type it is necessary to add the following fields:
    1. Plan_start - planned start date, type DATE_TIME;
    2. Plan_start - planned end date, type DATE_TIME;
    3. Fact_start - actual start date, type DATE_TIME;
    4. Fact_end - actual end date, type DATE_TIME;
    5. Percent_complete - completion rate, type INT;
    6. PredecessorActivity - predecessor for a task, type REFERENCE_LIST for the record type ALMActivity;

    • Configuring the application
      • Configuring fields for ALMRequest:

  • Configuring fields for ALMTask:
  • Configuring fields for ALMAcivity:
  • Configuring relations for ALMTask:
  • Configuring relations for ALMRequest:
  •  

     




    UML2ClearQuest. User Guide. Ver 3.0

     UML2ClearQuest. UserGuide. Ver 3.0

     

    Contents

    1. List of Abbreviations and Terms

    2. Glossary 

    3. Introduction 

    3.1 Purpose of This Document

    3.2 Field of Application

    3.3 Implementation

    3.4 System Requirements

    4. General Description 

    5. Functionality 

    6. Description of User Interface Forms 

    6.1 Application main window

    6.1.1 Main menu

    6.1.2 Into ClearQuest tab

    6.1.3 From ClearQuest tab

    6.1.4 Documenting tab

    7. Working with the application 

    7.1 Restrictions imposed on Visio and StarUML diagrams

    7.2 Export into ClearQuest

    7.3 Export from ClearQuest

    7.4 Creating a document

    7.5 Filling in the document template

    7.5.1 Tags for specifying information about the schema

    7.5.2 Tags for specifying information about record types

    8. License policy 

    9. Known issues and troubleshooting 

     

    List of Abbreviations and Terms

    Abbreviation

    Expansion

    UML2ClearQuest

    Automatic Planning Module for the ClearQuest State Machine

     

    Glossary

    Term

    Interpretation

    ClearQuest Software change management system IMB Rational ClearQuest
    Record type A document or an object in ClearQuest that defines change requests that are used (task, defect, module, etc.)

     

    Introduction

     

    Purpose of This Document

    The document provides users with information on functionality of the UML2ClearQuest module that allows effectively developing and maintaining ClearQuest schemas. The document covers the following topics concerning UML2ClearQuest module:
    • UML2ClearQuest functionality
    • User interface forms
    • Module settings
    • Using the module

     

    Field of Application

    The document relates to the UML2ClearQuest module, and is intended for the end user (change management specialist) of the change management system.

     

    Implementation

    UML2ClearQuest is implemented as a separate application using .NET 2.0 technologies.

     

    System Requirements

    • ClearQuest version 2003.06.00 or later
    • MS Visio (v. 2003/2007) or StarUml 5.0
    • Framework .Net 2.0.

     

    General Description

    UML2ClearQuest application is intended first of all for easing the process of editing and maintaining schemas of change management system IBM Rational ClearQuest. This application allows improving and automating the following operations:
    1. Designing the life cycle for ClearQuest record types. ClearQuest does not provide a tool for visual modelling of life cycles of its record types. UML2ClearQuest in turn allows importing the life cycle diagrams built by MS Visio or StarUML, i.e. it allows performing visual modelling of record type behaviour within MS Visio or StarUML and easily applying the modelling results to any ClearQuest record type.
    2. Maintaining the life cycle for ClearQuest record types. When working with ClearQuest schemas it is often necessary to modify previously developed behavioural models of a record type, and UML2ClearQuest allows simplifying this process. UML2ClearQuest allows exporting the existing behavioural model from ClearQuest into MS Visio 2003 or StarUML file, modifying this model using the corresponding tool and importing results into the existing ClearQuest schema. It allows modifying state diagrams for every ClearQuest record type without using ClearQuest Designer and making these changes on basis of the same MS Visio or StarUML file.
    3. Documenting the ClearQuest schema. UML2ClearQuest allows generating documentation for ClearQuest schema of any version and allows building a document both on basis of internal template and using custom templates. It simplifies modifying documentation after modifying the ClearQuest schema. Besides, UML2ClearQuest allows adding help text for fields of ClearQuest records of any type on basis of an existing document, which is more convenient than using ClearQuest Designer.

     

    Functionality

    The UML2ClearQuest application provides the following functionality:
    1. Importing UML diagrams from MS Visio and StarUML and building on their basis behavioural models for ClearQuest record types. The diagrams can be imported in the following modes:
      1. Importing with creating a new record type. When this mode is used, an "empty" record type is created that will contain the defined behavioural model.
      2. Importing with deleting a state diagram. All existing states and activities are cleared and the state diagram is built over again on basis of the imported UML model.
      3. Importing with modifying state diagram. The UML2ClearQuest application determines the differences between the imported and existing behavioural models and modifies the existing model on basis of these differences.
    2. When updating the existing state diagram for a record type the IBM Rational ClearQuest application determines the difference between the existing and the new behavioural models and updates the existing diagram on basis if these differences. The following file formats are supported:
      1. MS Visio XML Drawing (*.vdx)
      2. MS Visio XML Stencil (*.vsx)
      3. MS Visio XML Template (*.vtx)
      4. StarUML Project File (*.uml)
    3. Exporting a state diagram for a ClearQuest record type into MS Visio or StarUML files. UML2ClearQuest allows building a UML diagram in MS Visio and StarUML formats for a ClearQuest record type. Later this diagram can be used as a source for subsequent changes of the state diagram.

     

    Description of User Interface Forms

     

    Application main window

    After the launch of UML2ClearQuest the application main window appears (see Figure 1. Main window), which provides access to all functions of the application.

    Figure 1. Main window

     

    Main menu

    The figure below (see Figure 2. Application main menu) represents the application main menu.

    Figure 2. Application main menu

    The File menu option (see Figure 3. The File menu option) duplicates the main buttons of the application interface, such as Open schema and Refresh the schema list.

    Figure 3. The File menu option

    The Settings menu option (see Figure 4. The Settings menu option) allows a user to select the interface language and set the parameters of the application. Under Parameters option, a user can set the waiting time for getting the list of available record types. At the end of the waiting time the application will stop the process of getting the list.

    Figure 4. The Settings menu option

    The Help menu option (see Figure 5. The Help menu option) allows viewing information about the version of the application and is used for installing the license.

    Figure 5. The Help menu option

     

    Into ClearQuest tab

    The Into ClearQuest tab is used for importing the state diagram into the record type. The tab is represented in the figure below (see Figure 6. Tab used for import into ClearQuest).

    Figure 6. Tab used for import into ClearQuest

    This tab contains the following elements:
    • The Fill in button - allows selecting a file with diagrams. The file format is set in the filter field of the standard Open file dialog.
    • It converts the opened file and forms the list of diagrams found.
    • The Diagrams list - contains the list of available diagrams. When the diagram is selected, it is displayed in the right part of the window.
    • The Check button - upon the button click the diagram is examined for compliance with requirements. The examination result is displayed in the Result field, and if the requirements are violated the message appears where the violated requirements are listed.
    • The Result field - displays information about compliance of the diagram with the requirements. When the requirements are fulfilled, in the field, the following text is displayed in green colour: Check is complete successfully. If any incompliance with the requirements is detected, in the field the following text is displayed in red colour: Check is complete unsuccessfully.
    • The Record type name field stores the name of the record type that will be created or modified in the ClearQuest schema.
    • The Record type DB name field stores the name of the table that will be created in the ClearQuest data base for storing information. This field becomes active only if a new record type is created. If the existing record type is modified, the field is not used.
    • The Modify the existing one option - if this option is selected, it means that the existing record type in the schema should be modified.
    • The Replace the existing one option - if this option is selected, it means that the existing record type is deleted and the new one is created instead of it.
    • The Create new option - if this option is selected, it means that the new record type is created in the schema.
    • The Add the "Modify" action check box - if this check box is selected, the action with the specified name that allows modifying records is added to the action list.
    • The Add the "Delete" action check box - if this check box is selected, the action with the specified name that allows deleting records is added to the action list;
    • The Into File option - if the option is selected, export should be performed into file.
    • The In existing scheme option - if this option is selected, the record type will be imported into the existing ClearQuest schema; If this method is selected, the list of schemes becomes active where you can select a schema into which the record type should be exported.
    • The Refresh button - requests the connection name, user name and password for connecting to ClearQuest and getting the list of available schemas for the specified connection.
    • The Schemas in list - contains the list of available schemas in the specified connection. The export will be performed into the schema selected from this list.
    • The Perform button - upon the button click, the import of states and transitions of the selected diagram is performed with parameters specified. If import to file was selected, it is necessary to specify the name and location of the target file. If import to the existing schema was selected, the program will import the record type into ClearQuest and display the result on the screen.

     

    From ClearQuest tab

    The From ClearQuest tab (see Figure 13. Tab used for export from ClearQuest) is used for exporting from the state diagram for the record type from ClearQuest.

    Figure 13. Tab used for export from ClearQuest

    This tab contains the following elements:
    • The Refresh button - requests the connection name, user name and password for connecting to ClearQuest and getting the list of available schemas for the specified connection.
    • The Record type name field stores the list of record types available in the selected ClearQuest schema.
    • The Export button - upon the button click, the selected record type is exported into the Visio or StarUML file.

     

    Documenting tab

    The Documenting tab is intended for building a document describing composition and content of record types, entities and their relations on basis of the selected ClearQuest schema (see Figure 7):

    Figure 7 - Documenting tab

    • The Refresh button - requests the connection name, user name and password (see Figure 8) for connecting to ClearQuest and getting the list of schemas available for the specified connection.
    • The Schemas in list - contains the list of available schemas in the specified connection.
    • The Version number list - contains the list of versions of the selected schema. Documenting can be performed for any version of the schema.
    • The Data on record types check box - if this check box is selected, documenting the information about record types of the schema is activated. The Section title field - in this field, you can specify the name of the section where the information about record types will be placed. The list below contains record types. From this list, you can select the record types, information on which should be saved.
    • The Data on stateless record types check box - if this check box is selected, documenting the information about schema entities is activated. The Section title field - in this field, you can specify the name of the section where the information about entities will be placed. The list below contains entities. From this list, you can select the entities, information on which should be saved.
    • The Data on the schemas check box - if this check box is selected, documenting the information about the schema is activated. The Section title field - in this field, you can specify the name of the section where the information about the schema will be placed.
    • The General data check box - if this check box is selected, documenting general information about the schema is activated. The text field allows specifying the name of the section where general information about the schema will be placed.
    • The Data on relations check box under Data on the schemas - if this check box is selected, documenting the information about relations between record types of the schema is activated. The information about relations is represented as a directional diagram. The text field allows specifying the name of the section where the information about relations will be placed.
    • The Data on relations check box under General parameters - if this check box is selected, documenting the information about relations of the record type with another record types is activated. The information about relations is represented as a directional diagram. The text field allows specifying the name of the section where the information about relations will be placed.
    • The Complete view option - if this option is selected, the fields of parent records will be displayed on the relationship diagram representing relations of record types with other record types and their fields.
    • The Simple view option - if this option is selected, the fields of parent records will not be displayed on the relationship diagram representing relations of record types with other record types and their fields.
    • The State diagram check box - if this check box is selected, documenting states of the record type and transitions between these states as a directional diagram is activated. The text field allows specifying the name of the section where the diagram will be placed.
    • The Transition matrix check box - if this check box is selected, documenting states of the record type and transitions between these states as a table is activated. The text field allows specifying the name of the section where the table will be placed.
    • The Description on actions check box - if this check box is selected, documenting the list of available actions as a table is activated. The text field allows specifying the name of the section where the table will be placed. The structure of table columns is defined by the check boxes Include the help text, Include the access control, Include the initialization, Include the validation, Include the commit, Include the notification that include into the document's table the columns Description, Access control, Initialization, Validation, Commit and Notification correspondingly.
    • The Field description check box - if this check box is selected, documenting the list of fields as a table is activated. The text field allows specifying the name of the section where the table will be placed. The structure of table columns is defined by the check boxes Include the type, Include the size, Include the help text, Include the default value, Include the permissions, Include the change of value, Include the validation, Include the choice list that include the columns Type, Size, Description, Default value, Permissions, Change value, Validation and Choice list correspondingly.
    • The Add system fields check box - if this check box is selected, the system fields are included into the list of the record type fields.
    • The Include the service data check box - if this check box is selected, the service information about the name and version of the schema is included into the document, and tags are added to the Description column of the table of the fields list for updating the help description for fields of record types in the schema.
    • The Description of the field behaviour check box - if this check box is selected, the description of behaviour of record fields as a table is added to the document. The text field allows specifying the name of the section where the table will be placed.
    • The Create document button - upon the button click, documenting of the schema is performed into the file specified by a user on basis of the set parameters.
    • The Fill in the template button - upon the button click, the existing document is filled in, and the information is added into the places marked by the special tags.
    • The Update button under Updating in the field description - upon the button click, the help description for record fields of the selected schema is updated, the update is performed on basis of the existing document with the check box Include the service data selected.

     

    Working with the application

     

    Restrictions imposed on Visio and StarUML diagrams

    Several restrictions are imposed on diagrams created in Visio and StarUML:
    1. Only objects of the UML Activity section are supported:
    • Supported objects for Visio: Initial State, Final State, State, Action State and Control Flow.
    • Supported objects for StarUML: InitialState, FinalState, ActionState, SubactivityState and Transition.
    1. The transition from Initial State or InitialState is mandatory, and there should be only one such transition.
    2. There should be at least one transition into Final State or FinalState.
    3. All transitions except transitions into Final State or FinalState must have names.
    4. Every state (State, Action State, ActionState, SubactivityState) must have at least one incoming transition and one outgoing transition.
    5. States should not have transitions into themselves.
    6. Transitions with the same names must have the same final state.
    7. All transitions should be linked to states.
    8. There should be only one transition between the same states.
    9. In Visio diagrams, it is necessary to name transitions as Action. If several names are given, the application will take only the first one as the name.
    10. In names, only Russian and Latin characters, underscore character "_" and numerals are allowed.
    11. The name length should not exceed 25 characters.
    12. There should be no states with the same names.

    The following figures represent the examples of UML diagrams in Visio (see Figure 14 - UML diagram in Visio) and StarUML (see Figure 15 - UML diagram in StarUML).

    Figure 14 - UML diagram in Visio

    Figure 15 - UML diagram in StarUML

     

    Export into ClearQuest

    For importing a state chart into ClearQuest you should open the Into ClearQuest tab and perform the following steps:
    1. To form the list of available diagrams, press the Fill in button and select the file that contains the UML diagram. If there are several diagrams, you can select the necessary one from the Diagrams list (see Figure 16. UML diagram opened in the application)

    Figure 16. UML diagram opened in the application

    1. The next step is to examine the diagram for compliance with the ClearQuest requirements. To examine the diagram, click the Check button. If the diagram complies with all requirements, the text Check is completed successfully in green will be displayed (see Figure 17. Diagram check result)

    Figure 17. Diagram check result

    Note: In the application, you can both create a new record type and modify the existing one. In the second case, you do not need to specify the name of the table for the requests in the ClearQuest data base. The name of a record type can contain Russian and Latin characters, underscore character "_" and numerals. Its length should not exceed 25 characters. The length of the name of the request table in the ClearQuest data base also should not exceed 25 characters, but it should contain only Latin characters, numerals and underscore character "_".
    1. Then you need to connect to ClearQuest. To establish connection, click the Refresh button. In the opened dialog (see Figure 18. Establishing connection to ClearQuest) specify the name of the connection where the necessary schema is located, login and password.

    Figure 18. Establishing connection to ClearQuest

    1. Type the name of the record type and select the corresponding record type. If you selected to create a new record type, you should specify the name of the table of the record type in the ClearQuest data base (see Figure 19. Specifying the name of the record type). Then you need to specify import parameters. If you need to add actions of deleting and modifying records, then select the corresponding check boxes and type the names of the added actions.

    Figure 19. Specifying the name of the record type

    1. To perform import, click the Perform button. The application will perform the import. Import results will be displayed in the new window (see Figure 19)

    Figure 20. Import results

    As a result of all performed steps, you will get the new or the updated table of states for the selected record type.

    Figure 21. Imported record type in ClearQuest Designer

     

    Export from ClearQuest

    For exporting a state chart from ClearQuest you should open the From ClearQuest tab and perform the following steps:
    1. Click the Refresh button. In the opened dialog, specify the parameters necessary for establishing the connection.
    2. Select the schema with the record type whose state diagram should be exported (see ). States and transitions between them are displayed with minimum intersections, so that it would be convenient to examine it.

    Figure 22. Preview of a state diagram for a record type

    1. Click the Export button and specify the type and name of the file, which the diagram should be exported to.
    As a result, the file containing the state diagram for the selected record type will be created (see Figure 23. Exported diagram opened in Visio):

    Figure 23. Exported diagram opened in Visio

     

    Creating a document

    For creating a document on basis of the ClearQuest schema you should open the Documenting tab and perform the following steps:
    1. Click the Refresh button. In the opened dialog, specify the parameters necessary for establishing the connection.
    2. Select the schema, for which the document should be created (see Figure 24. Selecting the schema for documenting)

    Figure 24. Selecting the schema for documenting

    1. Specify the number of the schema version (by default, the last version is specified, see Figure 25. Selecting the version of the schema):

    Figure 25. Selecting the version of the schema

    1. Select the set of the record types for documenting, set the parameters and click the Create document button (see Figure 26. Setting the documenting parameters)

    Figure 26. Setting the documenting parameters

    As a result, the document containing necessary information will be created (see Figure 27. Example of relations with other record types):

    Figure 27. Example of relations with other record types

    Besides, on the Documenting tab, you can do the following:
    1. Update help text for fields. First create a document with options Include help text, Include the service data selected. Apply changes necessary for displaying help for record fields to the created document; re-establish the connection on the Documenting tab; click the Update button and select the file with changes.
    2. Fill in the document template. In this case, documenting of the schema is performed on basis of the created template (service information for templates is described in section 7.5 Filling in the document template) Establish connection to ClearQuest, click the Fill in the template button, then select the document template for filling in.

     

    Filling in the document template

    A template is filled in on basis of the MS Word document, saved in XML format. A template is a document containing paragraphs with special tags. The application scans the document for these tags and replaces them by corresponding information. The template is filled in on basis of specified documenting parameters. It is necessary to select requests and items that are allowed to replace tags. For example, if a document contains a tag specifying a state diagram for the Task record type, but this record type is not selected from the list or the state diagram is not selected for documenting, the tag will not be replaced and will be left in the template test as is. In a template, a tag should be represented as a separate paragraph, because tags are completely replaced and if the paragraph contains any other information, it will be deleted. There are two types of tags: those specifying information for the schema and those specifying information for record types. The tag types are described in details in sections below.

     

    Tags for specifying information about the schema

    Tags of this type have the following pattern: [SchemaTemplate;information type]:
    • SchemaTemplate indicates that this tag is for including the information about the schema.
    • information type specifies the type of the information to be included into the document and can take on one of the following values:
      • info - indicates that the general information about schema is to be included;
      • relations - indicates that the relationship diagram for requests in the schema is to be included.
    Thus, there are two tags for including the information about the schema: [SchemaTemplate;info] and [SchemaTemplate;relations].

     

    Tags for specifying information about record types

    Tags of this type have the following pattern: [RecordTypeTemplate;record type name;information type]:
    • RecordTypeTemplate indicates that this tag is for including the information about a record type.
    • record type name specifies the name of the record type that is to be described in the document.
    • information type specifies the type of the information to be included into the document and can take on one of the following values:
      • relations - indicates that the relationship diagram representing relations of record type fields with the other record types of the schema is to be included;
      • adiagram - indicates that the relationship diagram for a record type is to be included.
    • smatrix - indicates that the transition matrix for a record type is to be included.
    • actions - indicates that the action list of a record type is to be included.
    • fields - indicates that the action list of a record type fields is to be included.
    • behavior - indicates that the behavioural table of a record type fields is to be included.
    Thus, there are six tags for including the information about a request:
    • [RecordTypeTemplate;record type name;relations];
    • [RecordTypeTemplate;record type name;adiagram];
    • [RecordTypeTemplate;record type name;smatrix];
    • [RecordTypeTemplate;record type name;actions];
    • [RecordTypeTemplate;record type name;fields];
    • [RecordTypeTemplate;record type name;behavior].
    For example, if you need to include into the document the state diagram of the Task record type, you should include the following string into the template: [RecordTypeTemplate;Test;adiagram].

     

    License policy

    To use the fully functional application, you need the file with the license key. Without this file, the application works in trial mode when you can export to ClearQuest and import from ClearQuest record types containing 3 states at the most, and document only one request. For viewing information about the license and importing the license key, select the About program item from the Help menu. In the appeared window (see Figure 28. Viewing information about the application and the license) information about the licensee and the mode of operation of the application (trial or fully functional). To import the license, click the Import license button and select the file containing the license key. To activate the license, restart the application.

    Figure 28. Viewing information about the application and the license

     

    Known issues and troubleshooting

    In case the UML2ClearQuest behaves unusually while performing operations, restart the application and repeat the operation. If you receive the message about incompliance of the diagram with the requirements, read the message attentively: in the message, it is indicated what requirements are not fulfilled. Then modify the diagram and try again. If an error occurs while exporting into the existing schema, read attentively the section "Details of exporting": in this section, the message of the ClearQuest console is displayed, which contains the detailed description of the error. The most frequent errors:
    1. The schema is in the Check Out state - for the selected schema, in the Designer, perform Check In or Undo Check Out.
    2. The name specified for the record type already exists - specify another name for the record type or delete the record type of the same name from the schema.
    The invalid name for the table of the record type in the ClearQuest data base if specified - specify another name for the table, since the name specified earlier is reserved.


    GanttChart for ClearQuest. User Guide. Ver 1.2

     

    CM-Consult company

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

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

    Blog: IBM Blog (English blog)

    E'mails: This e-mail address is being protected from spam bots, you need JavaScript enabled to view it and This e-mail address is being protected from spam bots, you need JavaScript enabled to view it

    • Moscow
      • Uznobutovskaya st, 23, Moscow, Russia
      • Phone & fax: +7(495) 648-63-28
    • Kaliningrad
      • Office 213, Garajnaya st. 2, Kaliningrad, Russia
      • Phone & fax: +7 (4012) 563671

       Partners in Europe

    Contacts in Germany,

    IBTS - International Business & Technology Solutions

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

    E-mail: This e-mail address is being protected from spam bots, you need JavaScript enabled to view it

    Scheelestr. 108, D-12209 Berlin

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

    Fax: +49 (0)30 755 14 348

    Contents

    1. List of Abbreviations and Terms 

    2. Glossary 

    3. Introduction 

    3.1 Field of Application of This Document 

    3.2 Purpose of This Document 

    3.3 System Requirements 

    4. General Description 

    5. Configuration 

    5.1 Setting up parameters 

    5.2 Export and import of settings 

    6. Using the plug-in 

    6.1 Building a Gantt chart 

    6.2 Opening forms 

    6.3 Modifying planned dates 

    6.4 Reassigning owners 

    6.5 Saving changes 

    6.6 Export information 

    6.7 Visualization of states 

    7. Appendix A 

     

     

     

    List of Abbreviations and Terms

     

    Abbreviation

    Expansion

    CM

    Change management

    DB

    Database

     

     

    Glossary

     

    Term

    Interpretation

    ClearQuest

    IBM Rational change management system

    Change Request

    Document/ ClearQuest object

     

     

     

    Introduction

     

     

    Field of Application of This Document

     

    This Guide is intended for users of ClearQuest.

     

     

    Purpose of This Document

     

    The document provides users with information on functionality of the GanttChart for ClearQuest application that allows effectively use ClearQuest when planning works and tracking their statuses.

    The document covers the following topics:

    • Configuring the application
    • Using the application

     

     

    System Requirements

     

    To be able to use the GanttChart for ClearQuest plug-in you must have

    • IBM Rational ClearQuest Eclipse Client 7.0.0 or later version.

     

     

    General Description

     

    GanttChart for ClearQuest is the plug-in for the Eclipse client for ClearQuest that provides the following opportunities:

    • Building a Gantt chart on basis of executed queries. It allows building a chart of any necessary view.
    • Visualizing change request hierarchy and relations between the requests in the form of a Gantt chart.
    • Visualizing task completion rate.
    • Visualizing ratio of planned to actual dates.
    • Visualizing change requests using different colour schemes depending on the completion rate and ratio of planned to actual dates.
    • Splitting a Gantt chart on sections for visualization of composite requests for more convenient analysis and work planning.
    • Changing and saving results of updating planned dates of change requests.
    • Assigning owners for change requests.
    • Opening forms of change requests from a Gantt chart;
    • Printing;
    • Visualizing State Chart Diagram;
    • Exporting to MS Project XML file.

     

     

    Configuration

     

     

    Setting up parameters

     

    Configuration includes setting up the parameters of record types for which the Gantt chart will be build. First, you should set up the connection to the DB (see Figure 1. Setting up the connection to the ClearQuest database).

     

    Figure 1. Setting up the connection to the ClearQuest database

     

    To adjust the module settings, in the Window menu, select Preferences. (see Figure 2. Opening the dialog box for adjusting the module settings).

    Figure 2. Opening the dialog box for adjusting the module settings

     

    In the Preferences dialog box, on the left, select CMC Plug-ins/GanttChart for ClearQuest. The Preferences dialog box will open. (see Figure 3. Configuring the module (the ALMRequest entity is taken as an example). This dialog box contains the following tabs:

    1. Record types - on this tab, you can configure all necessary record types, for which the Gantt chart will be built.
    2. Record types hierarchy - on this tab, you can set up all necessary relations between change requests:
      1. Hierarchical relations
      2. Sequential relations
    3. Advanced - on this tab, you can adjust additional settings.
    4. Custom - on this tab, you can adjust some custom settings to make your work with GanttChart for ClearQuest more convenient.

    Figure 3. Configuring the module (the ALMRequest entity is taken as an example)

     

    The Record types tab contains the following settings:

    1. Connection - the list of active ClearQuest connections. In this list, you should select the connection to the user's ClearQuest database.
    2. Record types - the list of record types that are used in the user's ClearQuest DB. In this list, select the record types that should be used for building the Gantt chart. For every record type, you can set up a number of parameters displayed on the right of the record types list:
      1. Modify action - the action performed by ClearQuest to modify the change request. It is used for saving planned values for the change requests. This is an optional parameter. You need not set it up unless you need to save changes in the Gantt chart.
      2. Assign action - the action performed by ClearQuest to transfer a change request into the Assigned state. It is used if it is necessary to automatically transfer a change request into the Assigned state when an owner is assigned to the request. This is an optional parameter. You need not set it up unless you need to automatically transfer a change request into the Assigned state.
      3. Headline - this field contains a brief description. This is a mandatory parameter.
      4. Owner - this field contains a name of an owner assigned to a change request. This parameter is optional.
      5. Plan start date - this field contains a planned date of starting work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      6. Plan end date - this field contains a planned date of finishing work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      7. Actual start date - this field contains an actual date of starting work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      8. Actual end date - this field contains an actual date of finishing work in the ClearQuest request. This field is not mandatory for change requests with child requests.
      9. Completing percent - this field contains the task completion rate. Its value should fall into the range between 0 and 100. This parameter is optional.

     

    Figure 4. Configuring the hierarchy for the ALMActivity entity

     

    For setting up relations between change requests, you should open the Record types hierarchy tab (see Figure 4. Configuring the hierarchy for the ALMActivity entity). This tab contains the Record types list containing the list of record types that were configured on the Record types tab. For every record type, you can set up a number of relationship parameters:

    1. Parameters for hierarchical relations, that are displayed in a Gantt chart as aggregated tasks:
      1. Parent record - a parent change request for the request that is currently being configured.
      2. Child record - a child change request for the request that is currently being configured.
    2. Parameters for the sequential relations:
      1. Predecessor record - a change request that goes before the request that is currently being configured.
      2. Successor record - a change request that goes after the request that is currently being configured.

     

    Figure 5. Additional settings

     

    The Advanced tab contains the following settings:

    1. Color theme - the color scheme that will be applied to a Gantt chart.
    2. Use color events - if this option is selected, all tasks will be highlighted by different colors depending on their states:
      1. Grey - the task has not been planned.
      2. Blue - the task has been planned and the plan end date has not come yet.
      3. Yellow - the task has been planned and is in progress.
      4. Crimson - the task has been planned, but the planned start date is past due.
      5. Red - the task has been planned and the planned finish date is past due.
      6. Green - the task is completed.
    3. Split chart by section - if this option is selected, the Gantt chart is divided into sections concerning records of the first level of hierarchy.
    4. Use AMWorkActivitySchedule package - if this option is selected, you can use the AMWorkActivitySchedule package.
    5. Use users - allows creating lists of owners for using them in the Gantt chart:
      1. Use the record choice list - creates the list of owners that corresponds to the selected record and its Owner field;
      2. Use users record type - creates the list of owners on basis of the Users record type;
      3. Use specified record type - creates the list of owners on basis of the specified type of record Record type and its main field User name, which contains the owner name.
    6. Enable change preferences by administrators only - if this option is selected, the settings can be edited only by users with Super user and Security admin privileges.

     

    Figure 6. Custom settings

     

    The Custom tab contains the following elements:

    • Auto build queries - allows defining the list of queries. As a result of execution of these queries, a Gantt chart will be automatically built.

     

    To finish the configuration, click Apply.

     

     

    Export and import of settings

     

     

    GanttChart for ClearQuest allows exporting and importing settings. You can do it in the Preferences window using the corresponding buttons (see Figure 7. Buttons for exporting and importing settings

    ).

     

    Figure 7. Buttons for exporting and importing settings

     

    To export settings, perform the following steps:

    1. In the Preferences window, click Export.
    2. In the dialog box, select the directory and specify the name of the file that will store the imported settings.

     

    To import settings, perform the following steps:

    1. In the Preferences window, click Import.
    2. In the dialog box, select the file with the settings.
    3. To apply the new settings, click Apply.

     

     

    Using the plug-in

     

     

    Building a Gantt chart

     

    Since GanttChart for ClearQuest uses requests selected from the ClearQuest, to build a Gantt chart it is necessary to execute a query that will return the list of records (see Figure 8. Configuring the filter of displayed records).

    Figure 8. Configuring the filter of displayed records

    In the CMC Plug-ins menu, select GanttCart for ClearQuest (see Figure 9. Launching the plug-in). The new tab GanttCart for ClearQuest will open (see Figure 10. Plug-in's tab displayed in ClearQuest).

    Figure 9. Launching the plug-in

    On the GanttCart for ClearQuest tab, in the Executed queries list, select the executed query and, to build a Gantt chart, click Fill from result (see Figure 10. Plug-in's tab displayed in ClearQuest, Figure 11. Running a query).

    Figure 10. Plug-in's tab displayed in ClearQuest

     

    Figure 11. Running a query

    As a result of the plug-in installation and configuration, you will get the Gantt chart (see Figure 12. Displaying the Gantt chart).

    Figure 12. Displaying the Gantt chart

     

     

    Opening forms

     

    GanttChart for ClearQuest allows opening forms of change requests directly from a Gantt chart. To open a change request form, click the necessary task in the Gantt chart. The ClearQuest form will open where you can perform all regular operations with the request, i.e. view, modify, change its state, etc.

     

    Figure 13. ClearQuest Form Opened from a Gantt Chart

     

     

    Modifying planned dates

     

     

    GanttChart for ClearQuest supports changing planned dates directly from a Gantt chart. To be able to modify planned dates for tasks, you should specify the following parameters:

    1. Fields containing planned dates.
    2. Modify action for a record.

     

    To modify planned dates for a task on a Gantt chart, you should pull one of the tasks ends by the cursor.

    GanttChart for ClearQuest also supports grouped operations for tasks of a Gantt chart.

    1. Selecting a group of tasks. You can select multiple tasks by clicking Shift or Ctrl and selecting the necessary tasks. Also, you can select a group of tasks by clicking Ctrl and then, using the right mouse button, selecting an area on a Gantt chart where the necessary tasks are displayed (see Figure 14. Selecting a group of tasks
    2. )

    Figure 14. Selecting a group of tasks

     

    1. Modifying a group of tasks. To modify a group of tasks, you should modify one of the selected tasks holding the Ctrl button.
    2. Modifying connected tasks. To modify connected tasks, you should modify one of the selected tasks holding the Shift button.
    3. Aggregated tasks. When you move an aggregated task, its child tasks are also moved, including the aggregated ones.

     

    The plug-in allows evaluating how the new planned dates differ from the previous ones. To do it, right-click a Gantt chart and select Show Planned Dates (see Figure 15. Displaying the shift between old and new planned dates

    ). In the chart, additional green and red lines appear indicating the shift between old and new planned start dates and planned finish dates correspondingly. If a task has actual dates, these lines will indicate the shift between actual and planned dates of the task.

    Figure 15. Displaying the shift between old and new planned dates

     

     

    Reassigning owners

     

     

    GanttChart for ClearQuest allows assigning owners for change requests directly from a Gantt chart. To make it possible, it is necessary to apply the following settings for the record type:

    1. Owner field.
    2. Modify or Assign action.

     

    To assign a new owner or reassign an existing owner, do the following:

    1. On a Gantt chart, right-click a task and select Assign owner.
    2. The dialog appears (see Figure 16. Selecting an owner
    3. ) with the list of available owners. To find a necessary owner in a large list, use the filter field.

    Figure 16. Selecting an owner

     

    1. Click OK to save changes, or Cancel to quit without saving.
    2. Before you have saved the new settings, you can restore the previous owner by clicking Restore.

     

     

    Saving changes

     

    To save the results of planning in the Gantt chart, you can use two methods (see Figure 17. Saving changes.):

    1. Complete saving of all changes Click (Apply changes). All changes made in the Gantt chart are saved into the ClearQuest change requests.
    2. Selective saving. Click (Analyse changes). The dialog box with the list of change requests to be saved and changed fields will open (see Figure 18. Selecting tasks for saving
    3. ). In this dialog box, you can select the change requests to be saved. Besides, you can select the following options:
      1. Save plan dates if actual dates exist - if this option is selected, the list of change requests to be saved will be supplemented with the change requests with the actual dates, for which the planned dates were modified;
      2. Update plan dates for summary tasks - if this option is selected, the list of change requests to be saved will be supplemented with the change requests that correspond to the aggregated tasks of the Gantt chart and for which the planned dates and the Modify action are specified in the settings of GanttChart for ClearQuest.

     

    Figure 17. Saving changes.

    Figure 18. Selecting tasks for saving

     

    The process of updating the planned dates is logged into the console window of the Eclipse client for ClearQuest (see Figure 19. Log of the planned dates saving process):

    Figure 19. Log of the planned dates saving process

     

     

    Export information

     

    GanttChart for ClearQuest allows you to export the displayed information to the file in MS Project XML. For export, follow these steps:

    1. Click "Export";

    Figure 20. Exporting data

    1. Set the file name that you want to export the information;

    Figure 21. Selecting file name

    1. Launch MS Project and select "FileaOpen";
    2. Choose a file export;

    Figure 22. Opening file

    1. Select "Append the data to active project"

    Figure 23. Import Wizard

    1. The new plan to add a display field "Text1" and "Text2", which contain CQID information and the type of record ClearQuest;

    Figure 24. Inserting text fields

    1. Information on the planned dates stored in the baseline, so to display it on the MS Project Gantt chart to choose the type of View "Tracking Gantt"

    Figure 25. View "Tracking Gantt"

     

     

    Visualization of states

     

    GanttChart for ClearQuest allows you to view a state chart diagram for the selected change request. To do this, follow these steps:

    1. At the required change request, right-click and choose "Show state chart"

    Figure 26. Openning state chart

    1. On the resulting graph displays the states and transitions between states. In parentheses at the transitions is also reflected in the number of transitions executed during the entire lifecycle of the change request.

    Figure 27. StateChart Vizualizer

     

     

    Appendix A

     

    Example of ALM-schema configuration

     

    The following configuration is given for guidance only.

     

    This appendix contains detailed description of configuration and step-by-step instructions for adjusting the ALM-schema:

    1. Changes in the schema. Since the ALM-schema does not have all necessary fields for setting planned and actual dates, you should add them using ClearQuest Designer. For the ALMActivity record type it is necessary to add the following fields:
      1. Plan_start - planned start date, type DATE_TIME;
      2. Plan_start - planned end date, type DATE_TIME;
      3. Fact_start - actual start date, type DATE_TIME;
      4. Fact_end - actual end date, type DATE_TIME;
      5. Percent_complete - completion rate, type INT;
      6. PredecessorActivity - predecessor for a task, type REFERENCE_LIST for the record type ALMActivity;
    2. Configuring the application
      1. Configuring fields for ALMRequest:

    1. Configuring fields for ALMTask:

    1. Configuring fields for ALMAcivity:

    1. Configuring relations for ALMTask:

    1. Configuring relations for ALMRequest:




    Implementing IBM RSA and IBM ClearQuest integration: UML to State-Machine with RSA plug-in

    Alexey Chernikov,

    Alexander Novichkov  ,

    CM-Consult (www.rational-tools.info) .

     

    Download sources 

     

    Introduction

    Introduction to RSA

    Developing a Rational Software Architect plug-in

    General notion

    Installing a plug-in in RSA

    Integrating RSA and ClearQuest 

    ClearQuest JNI

    Developing a plug-in to integrate IBM Rational ClearQuest and Rational Software Architect 

    Implementation requirements

    Creating and configuring the plug-in

    Connecting the plug-in to ClearQuest

    Getting the list of ClearQuest databases

    Getting the list of schemas located in a ClearQuest database

    Getting the list of entities in a ClearQuest database

    Getting the list of states and transitions for a ClearQuest entity

    Visualizing a state machine in UML

    Putting it all together

    Conclusion 

    Resources 

     

    Introduction

    Years of experience with IBM's change management tool – IBM Rational ClearQuest – have brought to light both its good and bad sides. While there is no doubt in the flexibility of the mechanism for creating and editing change management schemas (creating forms, programming states and transitions for change requests), one can notice a drawback in the process of programming the state transition matrix when defining the lifecycle of a change request.

    In a simple scenario, a CM Manager first develops the structure of a Change Request and describes its lifecycle in a UML diagram (this is the abstract, descriptive level, see Picture 1). After a cycle of approval, the diagram is sent to a transition matrix programmer (perhaps the Change Management Administrator), who creates a low-level implementation of the process in IBM Rational ClearQuest, based on the UML diagram.

    This is an ideal scenario, which isn't as common in practice as it should be. The Change Request lifecycle is often programmed directly into IBM Rational ClearQuest, and the UML model is never created.

    Picture 1. The "Defect" change request's lifecycle as a UML diagram

     

    As a rule, the processes used in an organization don't remain frozen – they evolve with time. As a process evolves, the schema of a process (in ClearQuest), and its UML model must both be changed. Both operations are manual. So a CM administrator would have to commit the changes to the model first, then to the ClearQuest schema (or vice versa). Both operations are prone to human error: an important transition could be missed either in the schema, or in the diagram. Unfortunately, this happens all the time in practice. The disparity between the schema and model of a documented process can be as high as 30%. Often a process continues to evolve, but its description gets left behind, and the changes go undocumented.

    Picture 2. The state transition matrix in IBM Rational ClearQuest. The sequence of transitions between different states in a change request is defined here. This matrix is a physical, low-level depiction of the process. The screenshot shows the transition matrix for the "Defect" change request.

     

    The solution to this problem lies on the surface: connect a UML modeling tool, like IBM Rational Software Architect, to ClearQuest, and import a Change Request lifecycle into that tool, then output the state transition matrix as a UML diagram.

    Such a solution would make the current state of a process readily available as a UML diagram, without the potential for translation errors.

    This article describes in detail how to create an RSA plug-in that will perform the outlined actions.

    The next logical step in making such a plug-in is providing the opportunity to export a UML diagram describing the lifecycle of a process to a ClearQuest schema, allowing for a fully automated creation process, but that is a topic of a separate article.

    Inset: A process can be represented as:

    • A UML diagram (the abstract representation);
    • A state transition matrix (the physical representation).

     

    Introduction to RSA

    Rational Software Architect is a modern integrated development environment based on Eclipse.

    Eclipse in turn is an expandable IDE; in fact, its broad capability for expansion is what makes it stand out from most other modern development environments. Eclipse is a Rich Client Platform, which means it has a micro kernel that controls the lifecycle of the application and a host of auxiliary services, which can be accessed when integrating with the environment.

    RSA can be thought of as an expanded version of Eclipse, featuring additional development tools, which retains Eclipse's ability for further expansion.

    Developing a Rational Software Architect plug-in

    The prime instrument for enhancing RSA's functionality is the plug-in. Plug-ins can have any functionality attached to them – anything that can be written in Java can work inside an Eclipse plug-in.

    Plug-ins can often be very heavyweight applications, and since the environment consists of a large number of plug-ins, which must all be initialized, it usually takes a long time to launch. For this reason it can be difficult to debug plug-ins in the development environment (especially considering that it can take a long time just to update a plug-in to the latest version – RSA 7.0.0 searches all known update sites for plug-ins, and there's no mechanism to update only a single plug-in). So for testing needs, a special Runtime Workbench is used.

    The Runtime Workbench has all the services required for RSA to work properly, but usually only contains a small subset of the plug-ins used in the normal workbench (the exact configuration of plug-ins used in the Runtime Workbench can be found in Window à Preferences à Plug-in development à Target platform).

    However, even with the simplifications of the Runtime Workbench, RSA's initialization can still take a rather long time. For more effective testing and debugging, a simpler type of application can be used, which, like the plug-in, has access to RSA's inner services – the Pluglet. It can be launched directly from a working RSA instance, without the need for a Runtime Workbench. Pluglets are a feature available only in RSA, not in Eclipse.

    Unfortunately, Pluglets are not fit for some tasks. In Rational Software Architect 7.0.0, a Pluglet containing native calls can't be launched more than once without restarting the environment, which beats the point of using them (it's faster to launch a Runtime Workbench than to restart the environment). This problem arises because a native library can only be loaded in one Java class loader at a time, and on second launch the Pluglet thinks the library it needs is already loaded in another class loader, but it has no access to the loaded library.

    In this article we'll emphasize using native libraries to interact with ClearQuest, so we won't look into Pluglets any further.

    General notions

    Plug-ins can extend the user interface, perform background tasks or provide services to other plug-ins. The specific way a plug-in is connected to the environment can be configured when creating the plug-in.

    A plug-in can be built into almost any place in RSA's user interface: different context menus, the Menu Bar, a custom View (that can be created specifically for the plug-in). The conditions under which the plug-in becomes accessible can also be configured – for example, a context menu plug-in might appear only when the context menu is called on files of a certain type.

    In this article we'll plug into the Menu Bar, creating our own menu group.

    Installing a plug-in in RSA

    Like Eclipse, RSA has a unified system for installing plug-ins. Plug-ins are bundled together to form a Feature, and features can be installed directly into RSA from an Update Site.

    Update Sites can be accessed from RSA from Help à Software Updates à Find and install…

    We'll look into the problem of installing plug-ins in more detail after we've created our own plug-in that integrates with ClearQuest.

    Integrating RSA and ClearQuest

    There are at least two possible ways to integrate RSA and ClearQuest:

    1. By using ClearQuest's COM interface.
    2. By using a library of native functions through which ClearQuest itself functions.

    In this article we'll examine only the latter. One of ClearQuest's clients is based on Eclipse, and it makes sense to reuse the work already done on integrating ClearQuest and Eclipse.

    ClearQuest JNI

    Before we begin building our plug-in, we'll need to get a hold of the library that will allow us to call ClearQuest's native functions from Java, through the Java Native Interface. This library is installed along with ClearQuest.

    It's contained in a compiled Java archive - cqjni.jar, which can be found in ClearQuest's root directory (in Windows this directory defaults to C:\Program Files\Rational\ClearQuest).

    One way to quickly access the classes in that jar is to add the archive to a project's build path, and specify the path to the natives (which is the same folder cqjni.jar is in). For normal applications this method works fine; however, when using it for plug-ins, there can be problems with testing (specifically, it's rather hard to get the native calls to work reliably in the Runtime Workbench), so we'll be using a different method in this article – we'll decompile cqjni.jar, and add the decompiled .java files to our project. Though the process is described below, please note that the source code for this article contains the decompiled classes, so you can skip this section if you wish.

    There's a variety of decent java decompilers available on the internet. We'll be using jad – a console-based decompiler which is free for non-commercial use. Most of the other free decompilers (especially ones with only a graphical interface and no console counterpart) can't decompile several files at once, which is a major drawback in our case, because CQJNI consists of a large number of classes.

    Jad can be downloaded from http://www.varaneckas.com/jad. After downloading and extracting it from the archive, it should be added to PATH (or you'll have to make sure it's accessible when working with it further).

    Next, you'll need to extract all the .class files from the aforementioned cqjni.jar (any archive program that can extract .zip files can extract them from a .jar). From the folder with the extracted .class files, launch the following command in the console to decompile:

    jad -d CQJNI -s .java *.class

    As a result, the decompiled .java files will be in the CQJNI folder. There will be a few compile-time errors in the files, which we will fix manually after we add them to Eclipse.

    Let's start out by creating a project which we will use to fix the classes and then verify that they work. Go to File à New à Other, Java Project, and call the project CQJNITest.

    Next, let's import the decompiled classes into the project. From the context menu of the project, select Import, then File System (Picture 3).

    Picture 3. Importing resources from the files system to RSA.

    In the window that appears, select "Browse…", then find the folder with the decompiled CQJNI classes, and mark it in the import dialogue window. Change the "Into folder" field to "CQJNITest/com/rational/clearquest/cqjni" (Picture 4).

    Picture 4. Configuring import parameters for the CQJNI classes

    Now, click "Finish", and our project should have a package called "com.rational.clearquest.cqjni" added to it, which should contain the decompiled classes.

    Now, let's fix them up so they don't have any compile errors. There should be two classes with errors: CPUCount and CQJNIBaseObj.

    In CPUCount, in the only static method, remove everything after "return", and also add throws ClassNotFoundException to the method declaration.

    In CQJNIBaseObj the procedureHashCode method can be rewritten in the following manner, for example: public static int procureHashCode() { synchronized(m_classLock) { _hashCode++; return _hashCode; } }

    There's another method with errors in CQJNIBaseObj - _mthclass$. It's exactly the same as the method we fixed in CPUCount, so just make the same modifications made to CPUCount, and we're done.

    Now let's create a simple test to verify that everything is working correctly:

    import com.rational.clearquest.cqjni.CQAdminSession; import com.rational.clearquest.cqjni.CQClearQuest; public class Test{ public static void main(String[] args) throws Exception{ CQClearQuest cq = new CQClearQuest(); CQAdminSession as = cq.CreateAdminSession(); System.out.println(as); } }

    Developing a plug-in to integrate IBM Rational ClearQuest and Rational Software Architect

    Now we can begin to build a plug-in for RSA which will communicate with ClearQuest and perform the functions described in the introductory section.

    Implementation requirements

    The plug-in we develop must be able to:
    1. Open an IBM Rational ClearQuest session
    2. Import an entity's state transition matrix
    3. Visualize the state transition matrix as a UML diagram

    Creating and configuring the plug-in

    First, let's create our plug-in. Go to File à New à Other, and then select "Plug-in Project" (Picture 5).

    Picture 5. The dialogue for creating a new project; select "Plug-in Project".

    When we select a name for the project - "RSACQIntegration", for example, - a window with different template proposals for our plug-in will appear. A "Hello World" plug-in will automatically create a menu group called "Sample Menu" for us, which will have an item labeled "Sample Action", which reacts to clicks by opening a dialogue window. The plug-in we're making must also extend the menu bar, so choose the "Hello World" plug-in - it will be a good base for us (Picture 6).

    Picture 6. The window with plug-in templates; we're going to use a template that extends the Menu Bar.

    All the other configurations aren't of particular interest to us right now, so from here you can simply click "Finish".

    All the information about how the plug-in will embed itself into the environment is located in plugin.xml. Opening this file from RSA will take us to the Overview page of the plug-in (Picture 7).

    Picture 7. General information about the plug-in, which is contained in the Overview tab of plugin.xml

     

    If you go to the Extensions tab, you can see an overview of the plug-ins extension points, and the actions assigned to them (Picture 8).

     

    Picture 8. The Extensions tab of plugin.xml. Displays extension points of the plug-in, and the actions performed when interacting with a certain extension point.

    From this tab you can change the interface parameters – icons, labels, etc. Everything that can be changed from the graphic representation of the plugin.xml file that RSA shows can also be modified directly in xml, the syntax specification can be found in Eclipse's official reference [3].

    В одной из двух закладок – plugin.xml или extensions – поменяем названия меню. У Sample Menu поменяем id на RSACQIntegrationMenu, а label – на RSA-CQ Integration Menu; sampleGroup поменяем на RSACQIntegrationGroup.

    Let's change some basic parameters to personalize our plug-in. For Sample Menu, set the id to "RSACQIntegrationMenu", and the label to "RSA-CQ Integration Menu", and finally change sampleGroup to "RSACQIntegrationGroup".

    Also, let's make the following changes to Sample Action:

    Set the menubarPath field to "RSACQIntegrationMenu/RSACQIntegrationGroup", the toolbarPath field to "RSACQIntegrationMenu", the label field to "Import CQ States", and finally let's enter a Tooltip: "Imports a ClearQuest state transition matrix".

    To verify that we've set everything up correctly, let's launch a Runtime Workbench with our plug-in by pressing F11 (if plugin.xml is opened in the Plug-in Development perspective, RSA will automatically decide to launch a Runtime Workbench with the opened plug-in. Otherwise, you'll probably need to set up a Run Configuration for an Eclipse Application).

    Picture 9. A custom plug-in embedded into RSA's Menu Bar as a separate menu group with a single menu item.

    In the RSA instance that appears, there should be a menu group called "RSA-CQ Integration Menu" that was added because of our plug-in being embedded into the Runtime Workbench, and it should contain a single menu item – "Import CQ States".

    If you click that menu item, a dialogue window saying "Hello, Eclipse world" will appear, because that was the default behavior automatically assigned when we created the project, which we haven't changed yet. Our next step will be to configure our plug-in so that the "Import CQ States" button does what we need it to.

    Connecting the plug-in to ClearQuest

    Close the Runtime Workbench, we won't need it anymore for now. In the main project, open SampleAction.java. It's run() method contains the code responsible for opening the test window we saw earlier. You can delete run()'s contents, we'll be writing the code that connects to ClearQuest here.

    To start off, let's add the decompiled CQJNI classes to our plug-in project. You can simply copy the entire package from the test project we created earlier.

    Our goal is to get the states and transitions for an entity, and visualize them in UML. To do this, we'll need to:

    1. Get the list of ClearQuest databases, choose one
    2. Get the list of entities in the selected database, pick an entity
    3. Get the list of states and transitions for the selected entity
    4. Output the states and transitions as a UML diagram

    To accomplish this, we'll need to create methods that provide the appropriate functionality. The source code that comes with the article covers all that functionality, so we'll only look at the main problems without going into too much detail.

    Getting the list of ClearQuest databases

    First we need to get the list of ClearQuest databases. In Windows, ClearQuest keeps that information in the registry. The exact location depends on ClearQuests version, which can also be retrieved from the registry. In this article we'll assume that the 7th version of ClearQuest is being used (the code that comes with the article shows how to work with the 6th version as well). To find out the version, the following console command can be executed:

    reg query "HKEY_CURRENT_USER\Software\Rational Software\ClearQuest" If the 7th version is installed, the answer will contain the following line: HKEY_CURRENT_USER\Software\Rational Software\ClearQuest\7.0.0 If we know the version, we can find out the list of databases by executing the following command: reg query "HKEY_CURRENT_USER\Software\Rational Software\ClearQuest\7.0.0\Core\Databases" A list of folders will be returned, and the database names will be right after "Databses\" in the list.

    Getting the list of schemas located in a ClearQuest database

    After selecting a database from the list, we can get the list of schemas in that database using CQJNI. We've already tried to perform some simple interactions with ClearQuest, and the beginning in this case will be the same as last time:

    CQClearQuest cq = new CQClearQuest();/* Create the application to communicate with */ CQAdminSession as = cq.CreateAdminSession();/* To get the list of schemas, we'll need admin access*/ as.Logon(login, password, dbset);/* dbset is one of the databases from the previous step; login and password should be the ones used to enter ClearQuest Designer. The order of parameters in the various ClearQuest API calls can be found in the ClearQuest API reference [1] (the CQJNI calls from the decompiled classes won't have sensible names unless you modify them yourself) */ CQSchemas ss = as.GetSchemas();/* This call returns a list of schemas that can be iterated*/ List<String> = new ArrayList<String>(); /* Store schema names in this list */ /* Get the names by element: */ for (int i = 0; i < ss.Count(); i++) { CQSchema s = ss.Item(i); schemas.add(s.GetName()); }

    Getting the list of entities in a ClearQuest database

    Getting the list of entities is similar to getting the list of schemas. The main difference is that now we have to use a normal session with ClearQuest, not an admin session, so the login/password should be the ones used to enter the ClearQuest client. Also, in this case databaseName is the user database.

    CQClearQuest cq = new CQClearQuest(); CQSession session = cq.CreateUserSession(); session.UserLogon(login, password, databaseName, dbSet);/* The login/password to access the ClearQuest client, not the admin user/password that was used to get the list of schemas */ String[] entities = session.GetEntityDefNames();

    Getting the list of states and transitions for a ClearQuest entity

    Once we have the list of entity names, we can get an Entity from CQ, and then we can get its list of states and transitions:

     

    CQEntityDef entity = session.GetEntityDef(entityName); String[] actions = entity.GetActionDefNames(); String[] states = entity.GetStateDefNames();

    Visualizing a state machine in UML

    Now we need to visualize the entity's imported state machine. We'll be using RSA's UML State Machine for this purpose. The source code provided with the article contains a class that creates a State Machine diagram, so just like with CQJNI, we'll only look into the main problems here.

    To work with UML in RSA, we'll first need to define the diagram's structure, and then map that structure to a visual diagram.

    For our purposes, we'll need to make a Use Case, then create a State Machine for that Use Case, then create a Region for that State Machine, and then add states and transitions to that Region. When creating a diagram for a State Machine, all the states and transitions added to the Region will be added to the diagram automatically (for most other diagram types, you'd need to explicitly map created UML elements to their diagram with a separate call).

    It's best to ensure name uniqueness: otherwise, the editor will give out a warning. In the source code supplied with the article, when attempting to create a state or transition with a non-unique name, instead of creating that state/transition, the existing state/transition is returned.

    To be able to create anything, we'll need a UML Model object. The model can be selected from the list of opened models, for example, which you can get by calling UMLModeler.getOpenedModels().

    The model can also be opened by name, or you can simply create a new model:

    model = UMLModeler.openModel(name); model = UMLModeler.createModel(name);

    Having a model object, you can create a Use Case in that model:

    UseCase uc = (UseCase) model.createPackagedElement(name, UMLPackage.eINSTANCE.getUseCase());

    Note the UMLPackage.eINSTANCE.getUseCase()call – the UML element type being created is specified in this manner. UMLPackage.eINSTANCE contains methods to create most UML elements.

    All the other elements we outlined are created similarly. You can look at the exact procedures for creating them in the source code supplied with the article.

    To create a diagram for the created UseCase, RSA's UMLDiagramHelper utility class can be used

    Diagram d = UMLModeler.getUMLDiagramHelper().createDiagram(model, UMLDiagramKind.USECASE_LITERAL); UMLModeler.getUMLDiagramHelper().createNode(d, uc);

     

    The final call visualizes the UseCase on the diagram.

     

    Putting it all together

    The article is supplied with source code that implements all the functionality discussed here. The ClearQuestIntegration class implements some convenience methods for accessing ClearQuest. CQUMLStateVisualizer can visualize an entity's state transition matrix as a UML diagram. Note that CQUMLStateVisualizer will only be able to create UML diagrams from a plug-in (or from a pluglet, but only once, as mentioned earlier).

    To finish creating our plug-in, we need to return to the run() method inside SampleAction. Using the classes from the code supplied with the article, the method should look something like this:

    try { int version = ClearQuestIntegration.getVersion(); /* First get the version of the installed ClearQuest instance */ List<String> databases = ClearQuestIntegration.getRepositories(version); /*Next get the list of ClearQuest database names*/ new CQUMLStateVisualizer(new CQClearQuest(), "admin", "", "SAMPL", databases.get(0), "Defect");/* To visualize an entity's state transition matrix in UML ("Defect" in this case – the entity's name is passed as the last parameter), we'll need a login (2nd parameter) and password (3rd parameter) to access ClearQuest and receive the transition matrix. We'll also need the name of the user database (4th parameter) and the name of a ClearQuest repository (5th parameter)*/ } catch (Exception e) { /* If the plug-in can't work for some reason, print the reason, but otherwise do nothing. */ e.printStackTrace(); }

    After filling in the plug-ins run() method, we still need to package it so it can be effectively deployed. As mentioned earlier, we'll need to create a Feature and an Update Site for this purpose.

    First, let's create a Feature. Go to в File à New à Other, and select "Feature Project" (Picture 10).

    Picture 10. Creating a Feature Project.

    Click "Next", enter a name for the Feature project ("RSACQImport", for example), and click "Next" again. In the menu that appears, you'll be prompted to choose which plug-ins will be a part of this Feature. In our case there should be only one plug-in: RSACQIntegration (Picture 11).

    Picture 11. Selecting which plug-ins will be part of a feature. Our feature should contain the RSACQIntegration plug-in, which we created earlier.

     

    After you've marked it, press "Finish".

    Next we'll need an Update Site, which will allow us to install the Feature into RSA. To create an Update site, go to File à New à Other, then select "Update Site Project" (Picture 12).

    Picture 12. Creating an Update Site Project.

    The only configurable parameter an Update Site has during creation is its name; let's call it "RSACQImportSite".

    After creating the project, a panel with the Update Site's properties should be open. The properties are kept in site.xml, and are displayed in RSA in a structured way that makes them easier to modify. To be able to install our plug-in through this Update Site, we need to add the Feature with the plug-in to the Update Site. From the properties panel, select Add Feature (Picture 13).

    Picture 13. The Site Map tab of an Update Site. Features can be submitted to an Update Site from this tab, and all the features in the Update Site are listed here.

    In the window that appears, select the Feature we created earlier (Picture 14).

    Picture 14. Selecting features for an Update Site. We need to add the feature we created earlier, to make it accessible through this Update Site.

    Finally, select Build All. Now the Update Site is ready, and we can install our plug-in from it.

    To install the plug-in, go to Help à Software Updates à Find and Install, then select Search for new features to install, and click "Next" (Picture 15).

    Picture 15. The main window for expanding RSA's plug-in configuration. From this window, you can choose to install new plug-ins, or update the ones already installed.

    In the window that appears, select "New Local Site" (since the Update Site we created is currently kept on the local files system), then find the folder containing the Update Site with our plug-in (Picture 16). You can look up the location of the Update Site by selecting "Properties" from the context menu of the Update Site's project (you can copy it from there).

    Picture 16. Adding a local Update Site to the list of Update Sites from which RSA can install and update plug-ins.

    After you've selected the Update Site's folder, click OK. The Update Site will be added to the list; mark it (also make sure the other Update Sites are not marked, we don't need to install any other plug-ins right now), and click "Finish". A window will appear prompting you to select which plug-ins from the Update Site you wish to install. Right now there should be only one plug-in, which should be selected (Picture 17).

    Picture 17. This window allows you to select which Features are to be installed from an Update Site. We need to install the Feature we created earlier, which contains our ClearQuest integration plug-in.

    When you click "Next", you'll be taken to another window, which contains the license descriptions for the features being installed. We haven't filled out any license for our Feature, so the description will be empty (Picture 18).

    Picture 18. The license agreement window for installing features. We haven't assigned any license to our Feature, so the license description is empty.

    Choose to accept the terms of the license agreement, click "Next", and a window that allows you to choose the install destination for features will appear (Picture 19). You don't have to change it, so you can click "Finish" right away.

    Picture 19. The plug-in install location configuration window.

    Since we haven't signed our feature, a warning window will appear. You can ignore it, and click "Install All" (Picture 20).

    Picture 20. A window with a warning about installing an unsigned feature.

    After the installation process is complete, RSA will need to be restarted for the changed to take effect. After restarting, there should be a new entry in the Menu Bar – the one with our plug-in.

     

    The code provided with the article imports the "Defect" entity from the SAMPL database (i.e. there's no interface to select another entity). Clicking on the menu item added by the plug-in creates a UML diagram that represents the entity's lifecycle, and opens a tab in RSA that shows the diagram (Picture 21).

    Picture 21. ClearQuest's "Defect" entity's state transition matrix visualized as a UML diagram in RSA.

    Conclusion

    Practice shows that an automated method for creating diagrams of change management processes helps eliminate translation errors. It's especially important that automation saves a significant amount of time for specialists.

    In conclusion, we'll reiterate that the next logical step for such a system is creating a duplex module that supports importing and exporting entities. This way, a state transition matrix programmer's manual labor is shifted onto the automated system, and the specialist can focus only on the process diagram.

    Resources

    [1] http://publib.boulder.ibm.com/infocenter/cqhelp/v7r0m0/index.jsp?topic=/com.ibm.rational.clearquest.apiref.doc/default_topic.htm

    [2] http://www.ibm.com/developerworks/rational/library/08/0826_makady/index.html

    [3] http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html

    [4] http://www.varaneckas.com/jad

     More info

     More articles

     

    Download  sources




    Fully Functional GanttChart for ClearQuest Trial is now Available!
     CM-Consult  announced that it now provides a free, fully-functional and unrestricted edition of its flagship product GanttChart for ClearQuest . People who download this free edition are entitled to 15 days of free technical support as well.

     




    Press-release: GanttChart for ClearQuest is added to the IBM Global Solutions Directory

     CM-Consult products intended to provide business continuity are added to the international solutions catalogue IBM Global Solutions Directory . IBM Corporation adds to this directory the most significant solutions that are based on IBM technologies and have been successfully implemented for a number of customers.
    GanttChart for ClearQuest is added to the IBM Global Solutions Directory with the ID 41151. GanttChart for ClearQuest is a plug-in for IBM Rational ClearQuest 7.0, 7.1 or later version. This plug-in is of interest for everybody who uses IBM Rational ClearQuest and who lacks for project management functionality. The module does not substitute the existing project management tools. It just adds operational slices into IBM Rational. For most users, the functions provided by the plug-in are enough for planning and operation management.

    "Recently our solution ProjectTracker has been added to the  IBM Global Solutions Directory and now the turn of  GanttChart for ClearQuest has come. This solution was developed as a result of an effort of both our specialists and our clients. The idea to create such solution has emerged as a result of close cooperation with our customers and deep understanding of their business problems. In most companies we have cooperated with the planning horizon for tasks and works is measured in months and quarters, but not years. Project managers have often to modify work schedule, update it, establish priorities, and set responsible persons. ClearQuest is a powerful tool that simplifies this process, but it has its limits. In ClearQuest, planning and representation of tasks is performed in flat view, but all managers are used to using the Gantt chart for planning. Unfortunately, the standard ClearQuest package does not provide users with such opportunity. GanttChart for ClearQuest allows managers to save a lot of time while preparing plans of work/tasks and exercising operational control over the project. In absolute terms, a manager spends about 12-16 minutes on rescheduling the average group of connected tasks without using GanttChart. Using GanttChart for ClearQuest, the same operation takes 10-15 seconds. So, using GanttChart for ClearQuest results in increasing the manager’s efficiency and manageability of the whole project. We are greatly pleased to have gained recognition of our contribution from IBM Corporation", Alexander Novichkov , the general director of CM-Consult, sais. 

     




    GanttChart for ClearQuest have been published in IBM Global Solutions Directory

    GanttChartOur product  GanttChart for ClearQuest,  are now part of the IBM Global Solutions Directory, an online directory containing applications, tools and services from IBM and IBM business partners.
    GanttChart for ClearQuest ID 41151

     

     

    More info:




    New busness partner in Europe
    PartnershipCM-Consult Ltd and Rational-Tools project present their Business Partner in Europe - IBTS - International Business & Technology Solutions. The company is based in Berlin, Germany and provides the whole range of services for CM-Consult on the territory of European Union.
    For our clients in Europe there is now a probability to negotiate the contracts for our services and solutions in those cases when the payment through Avangate and Plimus services is unavailable...
    Tags: ibm, Add more tags...,



    CM-Consult Ltd announced the sale start of the innovative solution GanttChart for ClearQuest.

    SaleCM-Consult Ltd and Rational-Tools project  announced the sale start of the innovative solution GanttChart for ClearQuest. he following special winter discounts are valid through the February 25th, 2010:

    • 50% discount for 5 and more licenses purchase. The discount is applicable for all IBM business partners if used for their own projects. (request it on This e-mail address is being protected from spam bots, you need JavaScript enabled to view it with the partner status link).
    • 25% discount for any number of licenses. Applicable only for the clients purchased ProjectTracker.
    • 20% discount for 10+ licenses one-time purchase.

    Tags: gantt, ganttchart, ibm, rational, Add more tags...,



    CM-Consult Has Been Awarded the IBM Premier Business Partner Status
    CM-Consult logoCM-Consult (www.cmcons.com and www.rational-tools.info ) has received the high appraisal of its work – it has been officially granted the IBM Premier Business Partner status within the IBM PartnerWorld for Systems & Services program, the Rational products direction.IBM Corporation grants this highest status to the business partners who meet the set of high requirements.The IBM Premier Business Partner status testifies that CM-Consult shows the high level of competence, has wide practical experience in project implementa-tion and provides high quality of solutions it has developed on basis of IBM Rational technologies and products. Several unique solutions developed by CM-Consult are already registered in the V.A.P.  Program, namely ProjectTracker and UML2ClearQuest).


    New version of UML2ClearQuest - UML2ClearQuest 3.0

     CM-Consult Ltd and the Rational-Tools.com project (www.cmcons.com and www.rational-tools.info) announce the new release of the UML2ClearQuest 3.0 software.
    UML2ClearQuest 
    is the specially designed solution that extends IBM Rational ClearQuest with the new capabilities. This solution provides the ability of the lifecycle creating and modifying for IBM Rational ClearQuest records types basing on UML-diagrams (up to UML 2.1). This solution is intended first of all for the managers of the IBM Rational ClearQuest system, who are occupied with the projecting and developing the schemes for this system in their company as well as for their customers.




    GanttChart for ClearQuest. Ad hoc planning and operational management

    Ad hoc planning and operational management. The module of the visualization of the ClearQuest tasks hierarchy as Gantt diagram

     The module is made in the form of Plug-in for IBM Rational ClearQuest 7.0 and upper. This module is intended for every person who uses IBM Rational ClearQuest and is short of project management capabilities. The module does not substitute for existing project management tools but adds the operational sections into IBM Rational. For the most experienced users the functions of this module will be absolutely enough for ad hoc planning and operational management of their projects. The module has no analogues in the world!
    CM-Consult GanttChart is featured in the IBM Global Solutions Directory ID 41151
    GanttChart for ClearQuest 1.4 is fully compatible with IBM Rational ClearQuest v. 8.0

    Download demo-version
    Download UserGuide (English)
    Download  UserGuide (German) Download   UserGuide (Russian)
    See videos and presentationsBuy now (node-locked license)



    IBM Rational ClearQuest and HP Service Desk integration
    There are a lot of organisations which possess in their stocks great amount  of similar or diverse software. Logical explanation of  this software  "zoo" is the Aspiration aspiration of each service in the company to receive for their needs the most optimal in their opinion (or in opinion of the contractor) software. And of course the desire of the software companies to achieve a profitable market Microsoft (Project, Team Foundation Server), Hewlett Packard (Service desk, Mercury), IBM Rational etc. Eventually the question whow to structure components to gain one's ends?...
    Authors: Alexander Novichkov, Alexander Shamray


    Project Tracker 2.5.1 New Version
    CM-Consult has released a new version of the solution for extended integration of IBM Rational ClearQuestand Microsoft Project (or Microsoft Project Server) 2003/2007 Project Tracker 2.5.1.
    CM-Consult ProjectTracker is featured in the IBM Global Solutions Directory  ID 38167


    CQSD ClearQuest & HP Service Desk integration
    'CQSD' - ClearQuest & HP Service Desk integration. The module is designed for synchronization of IBM Rational ClearQuest and Service call queries in HP Service desk. The decision help to combine processes for maintenance and development of software and automate the access for designers/analysts from 3-line of support to the process of request handling, that was performed manually.
    Download demo-version
     

     
    See videos and presentationsBuy now (node-locked license)



    'PDA Tester' far Rational Robot and RFT
    A PDA testing component for IBM Rational Robot and RFT to automate Pocket PC applications functional testing. The Component is implemented as a COM-object enabling IBM Rational Robot scripts to access the user interface of an application running on the Pocket PC PDA as if it were an application running on a PC. The Component consists of two parts, one provides an access to a Pocket PC, and another - realizes the management interface.
    Download demo-version
     

     
    See videos and presentationsBuy now (node-locked license)
    Tags: hpc, ibm, PDA, Pocket PC, process, rational, robot, symbian, test, test manager, uat, wince, Add more tags...,



    'CQlite' for ClearQuest. Safe and secure client
    'ClearQuest Lite' - A safe client for ClearQuest. Safe client for ClearQuest. This tool provides the owner of the project to grant the limited access to project data in CQ base for the external teams involved in project. It also allows to export bug-reports in XML to distribute it to external teams which can edit it in MS Excel and send it back for automatic synchronization with CQ base. Using this tool provides assurance in confidentiality of the project data which keeps authorized access only. The applicationmodule is designed to work with IBM Rational ClearQuest in a manner that allows the system administrator to limit user access privileges: viewing queried records, adding new records and changing the state of records.
    Download demo-version
     

     
    See videos and presentationsBuy now (node-locked license)



    'ProjectTracker' for MSP Server 2003 & 2007
    'ProjectTracker for MSP Server 2003 & 2007' MS Project and MSP Server and ClearQuest integration module. This tool is registered as the V.A.P-solution in IBM. State-of-art MS Project (Project Server 2003 & 2007) and ClearQuest integration module which allows bidirectional collaboration keeping the full hierarchy, total resources information and all dependencies as well. During planning in MS Project the module allows to import all resources available from the CQ base. It’s irreplaceable tool for excellent project management.
    CM-Consult ProjectTracker is featured in the IBM Global Solutions Directory  ID 38167
    Download demo-version
     

     
    See videos and presentationsBuy now (node-locked license)




    'cmc_RBCBR' Role-based change request access rights regulation package for ClearQuest
    Solution type: ClearQuest package
    Limitations:  Requires slight modifications of ClearQuest's schema.
    Distributed as: ClearQuest package
    Compatibility: Compatible with any ClearQuest version (including ClearQuest 7.1). Supports any schema. 


    'cmc_hvis' ClearQuest's change request hierarchy visualisation package
    Solution type: ClearQuest package
    Limitations: Doesn't work through the WEB. Requires slight modifications of ClearQuest's schema.
    Distributed as: ClearQuest package
    Compatibility: Compatible with any ClearQuest version (including ClearQuest 7.1). Supports any schema.


    Developing Packages for IBM Rational ClearQuest
    Remote development of ClearQuest packages (add-ons) complies with the declared requirements. Packages can be of any complexity. Additionally, CM-Consult provides support if necessary.


    Developing and Maintaining the ClearQuest Schemas

    The concept of this project is to identify and remotely satisfy market needs in the sphere of software development using IBM Rational tools.




    'UML2ClearQuest' Tansform UML diagrams into ClearQuest Designer state matrix
    The purpose of this application is to ease the process of programming ClearQuest Designer's state transitions matrix for change requests. UML2ClearQuest can export UML state charts to ClearQuest Designer, which makes for a simple visual design process. UML Export is supported from StarUML, IBM Rational Software Architect or MS Visio. The demo version can export diagrams to IBM Rational ClearQuest with no more than 3 states. See success story. Compatibility: Compatible with any ClearQuest version (including ClearQuest 7.1).
    Download demo-version
     

     
    See videos and presentationsBuy now (node-locked license)




    There are 35 items tagged with ibm