Welcome
Developing
Learn how to develop schemas by using the Rational® ClearQuest® Designer.
Developing Schemas
You can develop or modify schemas with the Rational® ClearQuest® Designer.
Packages and integrations
This topic explains the concepts of Rational® ClearQuest® packages and integrations.
EmailPlus package
Mail relay
Use the Rational® ClearQuest® EmailRelay service to implement a private relay service to forward email requests to a server that is registered for Simple Mail Transfer Protocol (SMTP) server access.
Configuring the EmailRelay application
Use the cqemailrelay.pl Perl script to configure EmailRelay, to specify the relay mode, and to start and stop EmailRelay.
Configuring the EmailRelay application: Examples
These examples show how to configure the EmailRelay application for use in replicated and non-replicated Rational® ClearQuest® database environments, well as with two or more Rational ClearQuest user databases.
Changing the EmailRelay configuration
If you change the replication configuration of the Rational® ClearQuest® database, you must change the EmailRelay configuration to work with the changed Rational ClearQuest database.

IBM ClearQuest 10.0.9
Overview
Learn general information about the product.
Installing
Learn how to install the product.
Upgrading and migrating
Learn how to upgrade and migrate data for the product.
Administering
Learn how to administer the product.
Reporting
Learn how to generate reports for the product.
Developing
Learn how to develop schemas by using the Rational® ClearQuest® Designer.
- Developing Schemas
  You can develop or modify schemas with the Rational® ClearQuest® Designer.
  - Understanding the functions of the Rational® ClearQuest® schema developer
    This topic provides an overview of the tasks typically performed by a schema developer.
  - Overview of the Rational® ClearQuest® Designer interface
    The Rational® ClearQuest® Designer includes several different windows, or views, that you will use to perform your schema development tasks.
  - Rational® ClearQuest® schemas
    This topic explains the concept of a Rational® ClearQuest® schema.
  - Customizing a schema
    To modify how change requests are handled, you need to use the Designer to customize the records and fields of a schema.
  - Schemas and packages
    This topic explains the concept of using schemas and packages in Rational® ClearQuest®.
  - Packages and integrations
    This topic explains the concepts of Rational® ClearQuest® packages and integrations.
    - Precautions when applying packages
      Follow these guidelines when you apply a package to a schema.
    - Packages available
      This topic lists the Rational® ClearQuest® packages that are currently available, grouped by category.
    - Overview of package application process
      This topic explains the general steps involved in applying a package to a schema.
    - Examples: The Notes, Attachments, and Email packages
      The most commonly used packages are Notes, Attachments, and Email.
    - Checking which packages have been applied to a schema
      Before you apply new packages or package versions, you can check which package versions have already been applied to a schema.
    - Upgrading packages
      This topic explains the concept of upgrading packages in Rational® ClearQuest®.
    - The AuditTrail and eSignature packages
    - EmailPlus package
      - EmailPlus record types
      - Working with EmailPlus templates
      - Creating EmailPlus rules
      - Customizing an enabled record type
      - Mail relay
        Use the Rational® ClearQuest® EmailRelay service to implement a private relay service to forward email requests to a server that is registered for Simple Mail Transfer Protocol (SMTP) server access.
        SMTP Relay
        The SMTP Relay is an email transport method in which email is sent as soon as an Rational® ClearQuest® record is committed.
        PostOffice Relay
        The PostOffice Relay is an email transport method in which email is registered in the Rational® ClearQuest® database, which prevents loss of email messages.
        The Rational® ClearQuest® EmailRelay application
        The Rational® ClearQuest® EmailRelay application is a service-based application that runs as a WebSphere® application. It receives XML-encoded mail notifications from your EmailPlus-enabled Rational ClearQuest database or from querying the Rational ClearQuest database for email records. Then, the EmailRelay application translates the requests or data into email.
        Configuring the EmailRelay application
        Use the cqemailrelay.pl Perl script to configure EmailRelay, to specify the relay mode, and to start and stop EmailRelay.
        cqemailrelay.pl script
        Use the cqemailrelay.pl script to generate and customize the cqemailrelay_cfg.xml EmailRelay XML configuration file.
        Configuring the length of multiline text
        Rational® ClearQuest® can fail to send mail if the configuration of multiline text is inappropriate for the length of such data.
        Configuring the EmailRelay application: Examples
        These examples show how to configure the EmailRelay application for use in replicated and non-replicated Rational® ClearQuest® database environments, well as with two or more Rational ClearQuest user databases.
        The EmailRelay application on a non-replicated, single Rational® ClearQuest® database
        This scenario is the simplest in which you can use the EmailRelay application. It requires no special setup or configuration.
        The EmailRelay application on a non-replicated Rational® ClearQuest® database with multiple Rational® ClearQuest® databases
        In this scenario, two or more Rational® ClearQuest® databases are configured for use with the EmailRelay application in a non-replicated environment.
        The EmailRelay application on a replicated, single Rational® ClearQuest® database
        When your Rational® ClearQuest® database is replicated, you must specify the -replicaname parameters in the cqemailrelay.pl Perl script. Then, you must run cqemailrelay.pl at each site.
        The EmailRelay application on a replicated Rational® ClearQuest® database with multiple Rational® ClearQuest® databases
        When your Rational® ClearQuest® database is replicated, you must specify the -replicaname parameters to the cqemailrelay.pl Perl script. Then you run cqemailrelay.pl, at each site in which the Rational ClearQuest database is enabled for EmailPlus.
        Changing the EmailRelay configuration
        If you change the replication configuration of the Rational® ClearQuest® database, you must change the EmailRelay configuration to work with the changed Rational ClearQuest database.
        Switching between SMTP and SMTPS settings in the EmailRelay configuration
        When you switch between Simple Mail Transfer Protocol (SMTP) and Simple Mail Transfer Protocol Security (SMTPS) settings in the Rational® ClearQuest® EmailRelay configuration by using the cqemailrelay.pl script, you must manually update the <properties> block of the Rational ClearQuest EmailRelay configuration file to reflect the change.
        Importing a keystore certificate into WebSphere® for use with the EmailRelay service
        If you configure Rational® ClearQuest® EmailRelay to use Simple Mail Transfer Protocol Security (SMTPS) as the communication protocol for your email server, you must import the signer certificate for your email server. Then, EmailRelay can communicate with the email server over SSL using SMTPS.
        Troubleshooting the cqemailrelay.pl script
        If the CQER_AppServer_HOME environment variable does not point to the path to where the IBM® WebSphere® Application Server is installed or if it is not set, then an error will be generated when you run the cqemailrelay.pl script.
        EmailRelay XML customization
        Customize three sections of the cqemailrelay_cfg.xml file to provide the EmailMail server with information about your email environment.
        Starting and stopping the EmailRelay application
        The cqemailrealay.pl script starts and stops the EmailRelay application.
        Setting up EmailRelay for different types of email servers
        Rational® ClearQuest® EmailRelay uses configuration files to support an SMTP Email server. If your server requires additional parameters, they are supplied using the <properties> settings.
      - Performance
      - Notifications
        The Rational® ClearQuest® Notifications feature is available in EmailPlus package 2.5 and higher and can be used in the Modern Web user interface offered by Rational ClearQuest.
      - Email attachments
      - Debugging EmailPlus
      - Administration of EmailPlus
    - Attachments package
      The Attachments package stores record attachments on an external server instead of in the Rational® ClearQuest® database.
  - Test Management and Requests
    You can use the ClearQuest® TestManagement and Requests feature to create and track test plans and add approval processes to the record.
  - Working with Forms
    You must create a record form for each record type in your schema. You can also define a submit form for each record type.
  - Creating a security model
    This topic provides an overview of the process to create a security model.
  - Using hooks to customize your workflow
    This topic provides guidelines for using hooks to implement your workflow.
  - Record locking
    When multiple users attempt to simultaneously update a record, the database locking model ensures that the update from each user succeeds as a unit, but each update overwrites the previous update.
  - Customizing the Web
    The Designer provides many ways to customize the underlying schema and functionality that the Rational® ClearQuest® Web client accesses.
  - Rational® ClearQuest® email
    This topic provides a description of the supported Rational® ClearQuest® Web client email features.
  - Importing and exporting data
    This topic describes how to import and export data between Rational® ClearQuest® databases, and how to import data into a Rational ClearQuest database from another defect tracking system.
Managing change and releases
Learn how to manage change and release in the product.
Integrating
You can integrate Rational® ClearQuest® with other software by adding packages to existing schema.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.
Tutorials

Changing the EmailRelay configuration when the Rational® ClearQuest® database replication is changed

If you change the replication configuration of the Rational® ClearQuest® database, you must change the EmailRelay configuration to work with the changed Rational® ClearQuest® database.

EmailRelay cannot automatically detect that the Rational® ClearQuest® database has been changed from replicated to non-replicated or vice versa. If you change the replication of the database, delete or rename the existing cqemailrelay_cfg.xml EmailRelay configuration file. Then, run the cqemailrelay.pl script against the changed Rational® ClearQuest® database.