Jump to main content

Product Documentation

Customer Support

HCL Compass 2.0.2

HCL Compass V2.0.2
Overview
Installing
Upgrading and migrating
Administering
Reporting
Developing
Managing change and releases
Integrating
Extending product function
Reference
Glossary
Tutorials

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.
Packages and integrations
This topic explains the concepts of HCL Compass packages and integrations.
EmailPlus package
EmailPlus record types

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.
    - Precautions when applying packages
      Follow these guidelines when you apply a package to a schema.
    - Packages available
      This topic lists the HCL Compass 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 HCL Compass.
    - The AuditTrail and eSignature packages
    - EmailPlus package
      - EmailPlus record types
        EmailPlusConfig record type
        The EmailPlusConfig record type contains the main controls for configuring the package.
        EmailPlusSiteConfig record type
        The EmailPlusSiteConfig record type defines information about the SMTP and HCL Compass web servers at each site in an HCL Compass MultiSite installation, or about the single site in a non-replicated environment.
        EmailPlusRule record type
        The EmailPlusRule record type defines the conditions under which an email message should be generated.
        EmailPlusTemplate record type
        The EmailPlusTemplate record type defines the templates for the content and layout of an email message. A template can be used by multiple rules for the same record type.
        EmailPlusAction record type
        EmailPlusAction recordy type is used by an internal caching mechanism to minimize the impact of rule evaluation on performance. There is no direct interaction with this record type.
        EmailPlusRuleSubscription record type
        The EmailPlusRuleSubscription record type enables users to subscribe to notifications that are generated by the associated EmailPlusRule.
        EmailPlusPostOffice record type
        The EmailPlusPostOffice record type holds in the HCL Compass database a copy of an email message to be sent, which the relay service then processes.
      - Working with EmailPlus templates
      - Creating EmailPlus rules
      - Customizing an enabled record type
      - Mail relay
        Use the HCL Compass 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
      - Email attachments
      - Debugging EmailPlus
      - Administration of EmailPlus
    - Attachments package
      The Attachments package stores record attachments on an external server instead of in the HCL Compass database.
  - 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.
  - 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.

EmailPlus record types

The EmailPlus package adds seven stateless record types into the schema to which the package is applied.

EmailPlusConfig record type
The EmailPlusConfig record type contains the main controls for configuring the package.
EmailPlusSiteConfig record type
The EmailPlusSiteConfig record type defines information about the SMTP and HCL Compass web servers at each site in an HCL Compass MultiSite installation, or about the single site in a non-replicated environment.
EmailPlusRule record type
The EmailPlusRule record type defines the conditions under which an email message should be generated.
EmailPlusTemplate record type
The EmailPlusTemplate record type defines the templates for the content and layout of an email message. A template can be used by multiple rules for the same record type.
EmailPlusAction record type
EmailPlusAction recordy type is used by an internal caching mechanism to minimize the impact of rule evaluation on performance. There is no direct interaction with this record type.
EmailPlusRuleSubscription record type
The EmailPlusRuleSubscription record type enables users to subscribe to notifications that are generated by the associated EmailPlusRule.
EmailPlusPostOffice record type
The EmailPlusPostOffice record type holds in the HCL Compass database a copy of an email message to be sent, which the relay service then processes.

Share: Email
Twitter

Disclaimer
Privacy
Terms of use
Cookie Preferences