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.

To ensure that the import operation is successful, address these issues when you create the import schema:

• To prevent data corruption, the schema repository of the import schema must have the same data code page value as the database set that exports the data. For more information, see the information about code pages in the online help for the Administrator's role.
• The import schema must contain the record types, fields, field behaviors, and data types required to support your data. It must also contain the actions and state transitions that you want to use with the imported records and a record form that users can use to view and modify the imported data.
• The state names in the import file must match those defined in the import schema. If you want to use different state names, use those names in the import file also. For example, if your current application uses the state name Submitted, but you renamed that state to New in the import schema, you must replace Submitted with New in the import file.
• All fields and states in your current environment must be mapped to a field and state in the HCL Compass database. Data in unmapped fields is not imported. If the state field is not mapped, all records are set to the Submitted state, which renders your state model ineffective.
• If you are updating existing records, the import schema must have an action of the Modify type.
• If you are importing history, attachments, or duplicate records or are upgrading existing records, the import schema must contain a field to store the original ID value; the original ID values are required for both operations. See Original record IDs.
• If you are importing records that contain reference lists, the import schema must contain a record type that is the destination for the reference. For example, if you are importing defect records that contain a field for a project, you must create the project records before you import the defect records and then populate the project record type with project names.

Data types are validated as they are imported. If the records you are importing contain unsupported data types, you can map those data types to supported data types. See Supported data types.

For more information, see HCL Compass schemas and Customizing a schema.

Duplicate records

If you are importing duplicate records, the import schema must have an action of the Duplicate type. It must also include a Duplicate state and the state of the record before it was changed to Duplicate.

The record form must include the controls that support viewing and modifying duplicate records. Use the Duplicate Base control to view the ID of the parent record. Use the Duplicate Dependents control to view the IDs of the duplicate records. For an example, see the Duplicates tab of the Defect record type in any predefined schema.

Original record IDs

HCL Compass software assigns a new record ID to each imported record,

Your import schema must include a field for the original record ID. The original record ID is used to maintain data integrity when importing duplicate records, history, and attachments, and when updating existing records. It is also used when re-creating parent/child links. It can be used in queries to find records by using the original record ID.

If you use the Export wizard to export data from another HCL Compass database, map the ID field in the import file to the original (old) record ID field.