Home > Articles > Software Development & Management > UML

  • Print
  • + Share This
This chapter is from the book

Administering and Customizing ClearQuest

For complete information about administering ClearQuest, including a description of how to get your users up and running, see Administering IBM Rational ClearQuest, which you should have received with your software. (You can also pull the manual from the IBM website.) Either way, you've got a lot of reading to do. The following subsections provide a summary of the tasks ahead of you.

ClearQuest Databases and Schemas

[A.4.2] Now we're starting to get into the nuts and bolts of your change management system. A ClearQuest schema contains the metadata that defines the process for how users work with records in ClearQuest. The schema includes the following:

  • Record type definitions
  • Forms used to submit and modify a record
  • Field definitions and behavior
  • States a record can be in
  • Actions used to modify or change the state of a record
  • Hooks written in VBScript or Perl that further customize fields and actions

ClearQuest includes several predefined schemas that you can use as provided or customize to fit your workflow; you can also create and implement your own schemas. What you do depends on your development processes and your comfort level with the system. If you're relatively new to the system, your best bet is to implement the standard ClearQuest configuration out of the box and then slowly modify the system as your users and administrator grow more comfortable with the system.

ClearQuest stores schemas in a schema repository. A ClearQuest installation usually consists of one schema repository and one or more user databases, depending on how you segment your user population. You can have separate user databases for each project or group several projects together in one database. Something important to consider, however, is that if you want to generate reports and charts across several projects, you will want to put the projects in the same database.

Another important note: Projects that share a database must use the same schema; once a database is associated with a schema, it can be upgraded only with a newer version of that same schema. In other words, the database cannot use an older version of the schema or a completely different schema—so plan accordingly.

Starting ClearQuest Designer

A ClearQuest schema defines the process of working with a record, along with the Record form and relevant fields. Records have a variety of different states. The defect record begins in the Submitted state; from there you can change the state of the record to Closed, or you can modify the record without changing its state. However, to further automate your system, the administrator will use ClearQuest Designer to make targeted changes to the overall schema. Again, you can start with the standard schema and make changes after everyone feels more comfortable with the application.

At this point, you will want to do some customizations. Here are some of the steps and activities.

  1. Check out the schema. To customize a schema, you must first check it out of the schema repository.
  2. Add a new state. The ClearQuest Designer State Transition Matrix shows the various states that a record can be in and the actions that move the record from one state to another.
  3. Add a new action. The Actions grid shows all of the actions that can be performed on a record. To add a new action, you first add the action to the Actions grid and then associate it with the appropriate states.
  4. Create a new field. To create a new field, open the Fields grid. This grid shows all of the fields on the Record form, their types, and their default values.
  5. Define the behavior of the new field. The Behaviors grid shows how fields behave when the associated record is in each state. You can define whether a field is read-only, mandatory, or optional in each state, or define default behavior for all states. You can also create a user behavior that restricts user access to the field. Open the Behaviors grid, then right-click on the field and use the popup menu to define the behavior of the field.
  6. Add a new field to the Record form. After creating a field, you must add it to the Record form.
  7. Create an action hook. A hook is a trigger for pieces of code that ClearQuest executes at specified times to more fully implement your workflow. ClearQuest provides many predefined hooks that you can easily modify to suit your needs. You can also use the ClearQuest API to write hook code in Microsoft VBScript or Perl.

    ClearQuest supports four types of hook code.

    • Field hooks provide a way to validate the contents of a field or to assign field values.
    • Action hooks implement tasks at key points in the lifecycle of a record.
    • Record scripts allow you to associate a hook with a control, such as a pushbutton or a shortcut menu option, on a single record.
    • Global scripts allow you to reuse hook code within other hooks.

    Use the ClearQuest Script Editor to edit the hook so that it initializes the value of the associated field.

  8. Check in the schema. At any time while working on a schema, you can test your work in progress. This upgrades the test database with your latest changes, which provides a quick way to test your changes in the ClearQuest client without affecting your production user database.

    When you're satisfied that your schema changes are working correctly, check the schema into the schema repository. Once the schema is checked in, you can use it to upgrade your user database. ClearQuest prompts you to back up the schema repository and the database before upgrading.

  9. Select a ClearQuest schema. Table 4-2 shows a list of the predefined schemas included in ClearQuest (see Introducing Rational ClearQuest). ClearQuest schemas consist of various packages that provide specific functionality. You can add individual packages to an existing ClearQuest schema or to your own customized schema. For a full list of schemas and descriptions, see Administering Rational ClearQuest.

Table 4-2. Predefined Schemas

Schema

Description

AnalystStudio

Is compatible with Rational Suite AnalystStudio. Contains customization for use with Rational RequisitePro.

Blank

Contains only system fields. Use this schema to create a schema from scratch.

Common

Contains metadata that is common to all of the ClearQuest schemas.

DefectTracking

Contains the fields necessary to start using ClearQuest to track defects in a software development environment.

DevelopmentStudio

Is compatible with Rational Suite DevelopmentStudio. Contains fields and rules that work with Rational Purify, Quantify, and PureCoverage.

Enterprise

Is used with Rational Suite EnterpriseStudio. Contains fields and hooks that work with all Rational products.

TestStudio

Is compatible with Rational Suite TestStudio. Contains fields and rules that work with Rational TeamTest, RequisitePro, Purify, Quantify, and PureCoverage.

UnifiedChangeManagement

Supports the UCM process by providing integration with Rational ClearCase.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020