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.
The AuditTrail and eSignature packages
Customizing the packages

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
      - The AuditTrail package
        Use the AuditTrail package to specify which records are to be audited when they are created or changed. When you enable a record type for audit trailing, all changes to records of that type are audited. You can also disable audit trails for any record type for which they have been enabled.
      - The eSignature package
        Use the eSignature package to require users to add their electronic signatures to records under the circumstances that you specify.
      - Customizing the packages
        Using the extensions
        AuditTrail extensions
        eSignature customizations
    - EmailPlus package
    - Attachments package
      The Attachments package stores record attachments on an external server instead of in the HCL Compass database.
  - 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.
  - 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.

Customizing the packages

You can use extensions of the AuditTrail and eSignature packages to change their behaviors. The extensions add one or more Perl functions to the Global Hooks section of the schema. Because they reside in Global Hooks, the extensions are available to all hooks in the packages. However, the extensions are invoked as conventional Perl functions, not as named hooks.