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.
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.
Adding actions
You can add new actions as the state transitions between existing states in the State model for a schema.

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.
    - 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.
      - Displaying the Actions grid
        The Record Actions grid displays all of the actions that are defined in a schema. You can use the Record Actions grid to add, delete, and rename actions and to modify properties of an action. You can also set the access control and other policies for each action in the Record Actions grid.
      - Adding actions
        You can add new actions as the state transitions between existing states in the State model for a schema.
      - Creating state transitions
        You create state transitions when defining the state model of a schema. To create a state transition, you define an action of the type CHANGE_STATE and then select the source states and a destination state for that action.
      - Modifying actions
        You can modify action properties in from the Actions grid.
      - Defining action hooks
        You can define hooks for an action in a record type. You can customize action hooks by including scripts that use the HCL Compass API.
      - Defining the default action of states
        You can define the default action for a state in a record type so that it is highlighted in the list of all actions for a HCL Compass client user.
      - Deleting actions
        You can delete actions for a record type, but the change might require other changes to a schema such as modifying the state transition matrix or hooks that include the action name.
  - 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 actions

You can add new actions as the state transitions between existing states in the State model for a schema.

Procedure

To add a new action:

Start the Designer.
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 Actions tab to view the Record Actions grid.
Right-click on the Record Actions grid and click New Action.
The New Action window opens.
Type a name for the new action in the Action Name field.
Select an action type. If you plan to use this action to initiate a state transition, select CHANGE_STATE as the type.
Click Next.
On the Action States page, choose the source and destination states for the new action and then click Next.
Enter optional help text for the action and then click Finish.