Home
Developing
Learn how to develop schemas by using the HCL Compass Designer.
Developing Schemas
You can develop or modify schemas with the HCL Compass Designer.
HCL Compass email
This topic provides a description of the supported HCL Compass Web client email features.
Automatic e-mail notification
E-mail messages can be sent to users or user groups when a record meets criteria that you define in a schema.
Creating e-mail rules
To create the e-mail rules that define the criteria for automatic e-mail notification, submit Email_Rule records from the HCL Compass client.
Specifying rule controls for an e-mail rule
You can base an e-mail rule on the contents of fields or queries. Use the Rule Controls page of the Submit Email_Rule window.

Developing
Learn how to develop schemas by using the HCL Compass Designer.
- Developing Schemas
  You can develop or modify schemas with the HCL Compass Designer.
  - Understanding the functions of the HCL Compass schema developer
    This topic provides an overview of the tasks typically performed by a schema developer.
  - Overview of the HCL Compass Designer interface
    The HCL Compass Designer includes several different windows, or views, that you will use to perform your schema development tasks.
  - HCL Compass schemas
    This topic explains the concept of a HCL Compass 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 HCL Compass.
  - Packages and integrations
    This topic explains the concepts of HCL Compass packages and integrations.
  - Test Management and Requests
    You can use the Compass 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 HCL Compass Web client accesses.
  - HCL Compass email
    This topic provides a description of the supported HCL Compass Web client email features.
    - Automatic e-mail notification
      E-mail messages can be sent to users or user groups when a record meets criteria that you define in a schema.
      - Creating e-mail rules
        To create the e-mail rules that define the criteria for automatic e-mail notification, submit Email_Rule records from the HCL Compass client.
        Specifying rule controls for an e-mail rule
        You can base an e-mail rule on the contents of fields or queries. Use the Rule Controls page of the Submit Email_Rule window.
        Specifying action controls for e-mail rules
        You can base an e-mail rule on the actions, action types, or states.
        Specifying display fields for email rules
        When you set up email notification, you can select the fields to include in the message.
        Specifying e-mail addresses for e-mail rules
        You can specify the users and user groups that will receive e-mail notifications.
        Specifying cc addresses for email rules
        You can specify the users and user groups to receive copies of email notifications.
      - Sample e-mail rules
        HCL Compass Web client provides examples of several e-mail rules.
      - Finding existing e-mail rules
        You can create a query to find all e-mail rules in a HCL Compass environment and to create an archive list of your e-mail rules.
      - Modifying existing e-mail rules
        You can use a query that lists the e-mail rules in a HCL Compass environment and then you can modify an existing e-mail rule.
      - Administering e-mail addresses
        This topic provides guidelines for HCL Compass Web client e-mail administration.
      - Enabling HCL Compass clients to send email
        To take advantage of automatic e-mail notification, each HCL Compass client on Windows™ and the UNIX™ system must enable email notification.
      - Enabling e-mail notification for HCL Compass Web
        You can set up email notification for HCL Compass Web clients according to the business rules of your schema.
    - Round-trip e-mail
      Your team can use e-mail notification with e-mail submission to update records. This process is called round-trip e-mail.
    - EmailPlus package
    - Using action hooks to send e-mail
      You can use an action notification hook to send e-mail messages when a user completes a specific action. In your hook code, you use the HCL Compass API to create the message and send it.
  - Importing and exporting data
    This topic describes how to import and export data between HCL Compass databases, and how to import data into a HCL Compass database from another defect tracking system.

Specifying rule controls for an e-mail rule

You can base an e-mail rule on the contents of fields or queries. Use the Rule Controls page of the Submit Email_Rule window.

Procedure

To specify the fields or queries on which to base the e-mail rule:

Log on to the HCL Compass client as a user with the schema designer or super user privilege.
In the HCL Compass client, click Actions > New and select the Email_Rule record type.
On the Rule Controls page, specify a name for the e-mail rule, for example, New Submissions.
Select the record type on which to base the e-mail rule, for example, Defect.
Select the fields to check for changes.
When the selected fields change, an e-mail message is sent. To send an e-mail message whenever a new defect is submitted, you do not need to select any fields. For other types of e-mail rules, you might select fields such as Headline, State, or Owner.
For Filter Query, you can select a public query to use as an additional trigger for sending an e-mail message.
An e-mail message is sent only when a user modifies a record that meets the query criteria. For example, if you select a query that finds all records associated with a beta release, an e-mail message is sent when a user modifies a record that included that query.
For this example e-mail rule, you do not need to select a filter query.
Select the Active Rule check box. To temporarily disable an e-mail rule, clear this check box.
For Operator, you can select And or Or. The Operator works on the following fields on the Rule Controls page:
- Fields to Check for Change
- Filter Query
The Operator also works on the following fields on the Action Controls page (see Specifying action controls for e-mail rules):
- Actions
- Action Types
- Source States
- Destination State
If you select And, an e-mail message is sent only if all conditions specified in these fields are met. If you select Or, an e-mail message is sent if any condition specified in these fields is met.