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.
Using hooks to customize your workflow
This topic provides guidelines for using hooks to implement your workflow.
Field hooks
This topic explains the concept of a HCL Compass field hook.
Creating a dependency between fields
You can create a dependency between two fields so that when the value of the parent field changes, the value of the child field (the dependent field) changes also.

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.
  - 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.
    - Hooks
      This topic explains the concept of HCL Compass hooks.
    - Field hooks
      This topic explains the concept of a HCL Compass field hook.
      - Adding field hooks
        You can add field hooks to customize the behavior of fields by providing such features as choice-lists, field validation, default values, and permissions.
      - Editing field hooks
        You can edit field hooks to modify the current behavior of fields.
      - Deleting field hooks
        You can delete field hooks to change the behavior of fields.
      - Creating a dependency between fields
        You can create a dependency between two fields so that when the value of the parent field changes, the value of the child field (the dependent field) changes also.
      - Creating choice lists for fields
        You can use a choice-list hook to provide a list of options for a field.
      - Creating dynamic choice lists
        Dynamic lists are helpful when you want to add values to a list without editing the schema.
      - Editing dynamic lists
        You add a dynamic list in the HCL Compass Web client Designer and then define the values of that list in the HCL Compass client.
      - Specifying default values for fields
        In some cases, you might want to specify a default value for a field. You can specify a constant for the default value or you can use a script to calculate a default value.
      - Validating user input in fields
        You can use a validation hook to verify that the information a user has entered in a field is valid. If the information is not valid, the user is prompted for valid information.
    - Action hooks
      This topic explains the concept of a HCL Compass Web client action hook.
    - Execution order of field and action hooks
      Field and action hooks are run at predetermined times and in a predetermined order.
    - Record scripts
      This topic explains the concept of HCL Compass Web client record scripts.
    - Global scripts
      This topic explains the concept of HCL Compass global scripts.
    - Writing external applications
      You can write an external application in VBScript or Perl to perform tasks against a HCL Compass database.
    - Using the HCL Compass API
      This topic provides an overview of the tasks you can perform with the HCL Compass Web client API.
    - Common API calls
      This topic lists the basic building blocks from which you can create hooks.
    - Finding text in hook scripts
      You can search for specific script text in your hooks. The search includes all hooks in the schema; you do not have to specify a particular hook.
  - 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.

Creating a dependency between fields

You can create a dependency between two fields so that when the value of the parent field changes, the value of the child field (the dependent field) changes also.

About this task

When designing your schema, plan these field dependencies carefully. Dependent fields require the use of hooks, which can introduce runtime errors if not written correctly.

Procedure

To create a dependency between two fields, add a Value Changed hook to the parent field:

Start the Designer.
In the Schema Repository Explorer view, expand the Record Types folder in your schema and then expand a record type.
Click on the Fields node to open the Record Fields grid.
Click the Value Changed cell of the parent field.
Click the down arrow and click SCRIPTS > Basic or SCRIPTS > Perl.
If Instant Edit Mode is enabled, the Designer starts the Script editor. To enable or disable instant editing, click Edit > Instant Edit Mode. If necessary, double-click the cell to start the Script editor.
The Designer indicates the type of editor you are using in the title bar of the Designer window. Verify that you are using the correct editor before adding or editing your code.
In the Script editor, write a script that uses the value of the parent field to set the value of the child field. (For an example of setting a parent value based on child values, see Action hook for setting the value of a parent record.

What to do next

There are additional steps to enable dependent fields for HCL Compass Web client. See Enabling dependent fields for HCL Compass Web.