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
Debugging EmailPlus

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.
      - 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

Debugging EmailPlus

About this task

Follow these steps to enable the EmailPlus debugging functionality:

Procedure

Define a system environment variable called EMP_DEBUGOUT_LEVEL. Set the value of the EMP_DEBUGOUT_LEVEL variable to one of the these values:

Option	Description
1	List all EmailPlus function calls and the parameters passed to the functions
2	List all EmailPlus function calls, the parameters passed to the functions and the return values
3	Full Debugging, which can generate a lot of output

If you are debugging on Linux™ or UNIX™ systems, you must set the value of the EMP_DEBUGOUT_FILE variable to the name of a file that Rational® ClearQuest® can write to. Dot not include spaces in the full path of the debug file name. For example, create a file name similar to this line:EMP_DEBUGOUT_FILE=/tmp/EmailPlusDebug.log.

What to do next

To view the debugging output on Microsoft™ Windows™, run the Windows™ Debugger (dbwin32.exe). The debugging output that is generated by EmailPlus has this prefix:

#EMP_DEBUGOUT# <DATE> : <FUNCTION NAME> : <DEBUG MESSAGE>

For example, when the EMP_DEBUGOUT_LEVEL variable value is 2, the following output might be generated:

3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_isEmailPlusActive: START
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_CacheConfig: START - Cache EmailPlusConfig
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_CacheConfig: END
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_isEmailPlusActive: EMP::ConfigCache::isEmailPlusActive = <YES>
3712: #EMP_DEBUGOUT# 2009-10-23 11:45:21 :EMP_isEmailPlusActive: END  - isEmailPlusActive=<1>

To view the debugging output on Linux™ or UNIX™ systems, view the content of the file that you defined in the EMP_DEBUGOUT_FILE variable. When you enable EmailPlus debugging, Rational® ClearQuest® performance is affected. Enable debugging only when you need to, and then disable it when debugging is completed. You must define or modify the EMP_DEBUGOUT_FILE variable before you start the Rational® ClearQuest® client. Changes that you make to the EMP_DEBUGOUT_FILE variable while the Rational® ClearQuest® client is running is not recognized until the Rational® ClearQuest® client is restarted.