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.
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.
State models
This topic explains the concept of HCL Compass state models.
State models and the state transition matrix
Each state-based record type has a state transition matrix that lists its valid states and the actions that move the record between states.
Adding states to the state transition model
Before you add a state to the schema, you must add the state to a state transition model (called the state transition matrix), and then create a state transition.

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.
    - Record types
      This topic explains the concept of a HCL Compass record type.
    - Working with fields
      You use fields to control the type of data that users can add to a user database.
    - State models
      This topic explains the concept of HCL Compass state models.
      - State model for the Defect record type
        This topic lists the states of the Defect record type.
      - State model for the EnhancementRequest record type
        This topic lists the states of the EnhancementRequest record type.
      - State type models for packages
        This topic explains the concept of HCL Compass state type models.
      - Supporting a mixed local character set or a UTF-8 multilingual database
        This topic provides guidelines for supporting a mixed local character set deployment or a UTF-8 (8-bit Unicode Transformation Format) multilingual database.
      - Considerations in state model design
        This topic explains the issues that an effective state model must address in the design phase.
      - State models and the state transition matrix
        Each state-based record type has a state transition matrix that lists its valid states and the actions that move the record between states.
        Displaying the state model for a record type
        You can review the state model, including the defined states and actions, for a record type in the State Transition Matrix.
        Adding states to the state transition model
        Before you add a state to the schema, you must add the state to a state transition model (called the state transition matrix), and then create a state transition.
        Mapping state types
        If you add a state to a schema that uses state types, you must map that state to the appropriate package state type.
        Changing state names
        You can change the name of a state in a state model, and the name is updated in any actions that refer to it.
        Deleting states
        You can delete a state that no longer has any state transitions to or from other states.
    - Actions and action types
      Actions are the mechanism for submitting new records to the database, moving records from one state to another, and modifying or deleting records.
  - 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.
  - 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.

Adding states to the state transition model

Before you add a state to the schema, you must add the state to a state transition model (called the state transition matrix), and then create a state transition.

About this task

Procedure

To add a state to the state transition model:

In the Schema Repository Explorer view, expand the Record Types folder in your schema and then double-click on a record type.
The record type editor opens.
Click the States tab to view the state transition matrix.
Right click on the matrix and then click New State.
In the Add State window, enter a name for the new state and click OK.

Results

The new state is displayed as a source state and as a destination state in the row and column headers of the state transition matrix.

What to do next

After you create a state, you must create a state transition (that is, an action) that defines how this state is used in your state model. For more information, see To create a state transition.

You must also connect the new state to at least one other state with an action. It is a validation error to define a state that cannot be reached by any actions.

If your schema contains packages that use state types, when you add a state you must map the new state to a state type in your schema. For more information, see Mapping state types.