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.
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 HCL Compass import file
If you are exporting data from an existing HCL Compass database, you can use the Export feature to create the import file.
Import file format for history information
This topic contains guidelines for history import files.

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.
  - 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.
    - Overview of importing and exporting data
      Using the Import and Export wizards, you can move data such as records, history, and attachments from other change request systems and between HCL Compass databases.
    - Adding and removing code page headers from exported files
      You can use the cpheader command to add and remove data code page header information to and from exported queries, charts, reports, report formats, and form files created by using the original HCL Compass Web client Designer.
    - Starting the import process
      This topic explains the process for exporting and importing data in HCL Compass Web client.
    - Testing the import process
      This topic provides an overview of the steps you should follow to test the import process.
    - Creating an import schema
      Before you can import data into a HCL Compass database, you must create an import schema or modify an existing schema to support the data to be imported.
    - Creating a database for imported data
      Before importing data into a HCL Compass database, you must create a user database to hold the imported data and associate this database with the import schema.
    - Creating a HCL Compass import file
      If you are exporting data from an existing HCL Compass database, you can use the Export feature to create the import file.
      - Import file format for record types
        This topic provides guidelines for record type import files.
      - Import file format for history information
        This topic contains guidelines for history import files.
      - Import file format for attachments
        This topic provides guidelines for attachment import files.
    - Configuring the Import Tool
      You can customize the behavior of the Import Tool with the Import Tool preference page.
    - Exporting data
      You can export data from a HCL Compass database.
    - Importing data into HCL Compass
      This topic provides an overview of the steps required to import data into HCL Compass Web client.

Import file format for history information

This topic contains guidelines for history import files.

Each history import file must contain history information for only one record type. If you are importing multiple record types, create a history import file for each record type that contains history information.

The format for the history import file requires that each history entry be on a separate row and that each entry include the original ID number to identify the record to which the history belongs.

The remaining fields contain information about the action that was performed and must include the following fields:

Original record ID
Time stamp
User name
Action performed
Old state
New state

If you use the Export feature to export history data from another HCL Compass database, the original (old) record ID is saved in a field named display_name. Map the display_name field to the original (old) record ID.

The history import file in the following example uses the original IDs of the records for which this is the history:


"id","timestamp","user_name","action_name","old_state","new_state" 
"1","Apr  6 2000 8:31AM","srahman","close","open","closed" 
"2","Apr  6 2000 9:40AM","srahman","verify","closed","verified"

In dates, do not truncate the year to the last two digits. You can use any of the following date formats:

"6 April 2003"
"April 6, 2003 8:30:00"
"8:30:00 Apr 6 2003"
"4/6/2003 8:30:00PM"