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.
Overview of package application process
This topic explains the general steps involved in applying a package to a schema.
Applying packages
Packages add new functions to a schema or integrate schemas with other software packages. You can use the Package Wizard to apply 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.
      - Applying packages
        Packages add new functions to a schema or integrate schemas with other software packages. You can use the Package Wizard to apply packages.
      - Enabling record types
        When a package is set up to enable record types in your schema, you can specify which of these existing record types to modify.
      - Mapping state types
        If a package includes any state types, you must map the states in your schema to the state types in the package being applied.
      - Assigning default actions for states
        You can define default actions for states, which ensures that there is always a way to move from a source state to a target state.
    - 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
    - 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.

Applying packages

Packages add new functions to a schema or integrate schemas with other software packages. You can use the Package Wizard to apply packages.

Before you begin

Note that if you are working in a MultiSite environment, you must always apply packages from the same site.

Procedure

To apply a package by using the Package Wizard:

In the HCL Compass Schema Repository Explorer, right-click on the schema version to which you want to apply the package and click Packages > Apply Package.
The Package Wizard opens and lists all available package versions.
Select a package revision to apply.
The Designer determines whether the selected package can be applied to the schema without affecting the schema components.
- If it can, click Finish. The Designer will attempt to apply the package to the schema and you will see a success or failure message on completion.
- If it cannot, click Next and continue to the next step.
The Apply Package to Record Types page of the wizard lists the record types in your schema that the package can enable or modify, for example, by adding fields, actions, or a script. Select the record types that you want the package to enable. Click Finish or Next:
- To skip this step without selecting any boxes, click Finish or Next.
- To enable the record types in the Package Wizard later, click Packages > Setup Record Types for Packages. For more information, see Enabling record types.
When you add a package that uses state types, the Setup State Types page opens. For each of the records that you have applied the package to, select the appropriate state type for each of that record's states. Click Finish or Next.
On this page of the wizard, you must assign state types to the states for each record type that you choose to enable. For each state in the package, click the State Type field and select the appropriate state type from the existing schema that should be mapped to this state. You must map each of your existing states to a state type in that package. You can map more than one state to a state type, but each state type requires at least one state. When you are finished, click Finish.
To skip this step, click Finish. You can set the state types later by clicking Packages > Setup State Types. For more information, see Mapping state types.