HCL Compass packages

This topic describes the latest version of each HCL Compass package.

Earlier package versions might create different record types and fields. Some packages consist entirely of functions that cannot be changed.

Some out-of-the-box schemas are locked such that you cannot modify them or apply packages with a placeholder to be set on record types. Before using any package to those schemas, you must first enable package editing. After applying package(s), disable package editing. Out-of-the-box schemas that require enabling package editing are:

Table 1. Schemas that require enabling package editing
Package Name Package Summary
Agile The Agile schema helps agile teams follow agile practices, and product managers track agile team progress.
EssentialSAFe EssentialSAFe schema is a full featured schema which ships with HCL Compass v2.0.1 and later versions.
To enable package editing, from the command prompt launch the packageutil enablepackageediting command line tool. For example:
c:\packageutil enablepackageediting -dbset DBSETNAME admin XXX -enable admin
To disable package editing, use this command:
 packageutil enablepackageediting -dbset DBSETNAME admin XXX -disable admin

In the above examples, package editing is enabled and then disabled on the database DBSETNAME for the user admin with a password of XXX.

Package Description Added or modified Fields

ALMProject

ALMWork*

 Provide an ready to use solution to help teams manage the work of delivering software projects. Add ALM best practices that can be used as is, or extended and applied to existing Compass implementations. See Using HCL Compass ALM. Adds many new record types. The major record types that are added are the following:
  • ALMProject
  • ALMRole
  • ALMSecurityPolicy
  • ALMRequest
  • ALMTask
  • ALMActivity
  • ALMWorkConfiguration
 ALMWork and ALMProject do not extend your record types.
Attachments (read-only) Supports adding and removing attachments related to a record. Adds an Attachments tab to the enabled record type. Fields added to enabled record type:
  • Attachments
AuditTrail Supports auditing of changes to HCL Compass records. See The AuditTrail package.
Customer Supports the integration of customer data with your defect and change tracking system. Adds a Customer stateless record type. Also adds reference fields for customer information to the record type that you select. Fields included in the Customer record type:
  • Attachment
  • CallTrackingID
  • Company
  • Description
  • Email
  • Fax
  • Name
Fields added to enabled record type:
  • Customer
  • Customer_Severity
EmailPlus* Enhances the basic email notification functionality.
Enhancement Request Supports an additional record type for product enhancement requests. Adds the Enhancement Request record type. Fields included in EnhancementRequest record type:
  • Customer_Company
  • Customer_Email
  • Customer_Name
  • Customer_Phone
  • Customer_Priority
  • Description
  • Headline
  • Keywords
  • Owner
  • Priority
  • Product
  • Product_Area
  • Request_Type
  • Submit_Date
  • Submitter
  • Target_Release
eSignature Enables the electronic signing of records by the users who changed them. See The eSignature package.
GlobalScriptUtility Adds global scripts to your schema. You can access several functions from your hook code to display forms to users. No new record types are added, only global scripts. No new fields are added.
History (read-only) Preserves a historical account of all actions taken on a record. Adds a History tab to the enabled record type. No fields added.
Notes® Preserves a historical account of all notes that were entered on a record by date and user. Adds a Notes® tab to the enabled record type. Also adds a base action called Init_Note_Entry in the enabled record type, which deletes the Note_Entry value. Fields added to enabled record type:
  • Note_Entry
  • Notes_Log
OSLCLinks Supports Collaborative Lifecycle Management integrations. Adds an OSLC links tab to the enabled record type. Fields added to enabled record type:
  • oslc_links
Project Contains the Project record type.
Resolution Adds support for tracking how a record was resolved. Requires you to map schema states to the following state types:
  • Not_Resolved
  • Resolved
 Adds a Resolution tab to the enabled record type. Fields added to enabled record type:
  • Resolution
  • Resolution_Statetype (read-only)