HCL Compass integration packages

An integration package integrates an external product with HCL Compass. Following is a summary of the Compass integration packages.

Important:

Earlier package versions might create different record types and fields.
Some packages are read-only; you cannot change their functionality.


Package	Description	Added or modified	Fields
AMStateTypes	Provides additional support for HCL VersionVault Unified Change Management (UCM) and its state types. Requires you to map schema states to the following state types: Waiting, Ready, Active, and Complete.	Does not add any record types. See Adding an HCL VersionVault UCM integration.	Fields added to the enabled record type: am_statetype
BaseCMActivity	Supports the BaseCMActivity record type. Included in the UCM and Enterprise schemas as a lightweight activity record type. You can use this alternative to the Defect record type as is, enable it for UCM, or develop it into a new record type. See the HCL VersionVault help.	Adds the BaseCMActivity record type. See Adding an HCL VersionVault UCM integration.	Fields included in the BaseCMActivity, record type: Owner Description Headline
HCL VersionVault (read-only)	Provides basic support for the Base HCL VersionVault integration. This package does not set up HCL Compass to use predefined HCL VersionVault policies; these policies must be set by the HCL VersionVault administrator.	Adds the cc_change_set and cc_vob_object record types. Adds the HCL VersionVault tab to the enabled record type.	Fields included in the cc_change_set: record type: objects Fields included in the cc_vob_object: record type: name object_oid vob_family_uuid Fields added to the enabled record type: cc_change_set
GitIntegration	Supports integration with GitHub. The package provides the ability to call an endpoint to create a key that is used by GitHub to secure payloads and ensure server integrity. The GitIntegration package is supported on GitHub version 2.17 and higher.	Adds the GIT_Branch, GIT_Commit, GIT_CommitFile, GIT_Config, GIT_MasterConfig, GIT_PullRequest, Git_Reference record types.	Fields added include: GIT_references GIT_counts_reference
Project	Use to track records according to project. (This package is not related to the "Project" concept in the UCM package.)	Creates a Project stateless record type.	Fields included in the Project record type: Name Description Fields added to the enabled record type: Project
UCMPolicyScripts	Supports the UCM package by adding some global scripts. Note: For UCM policy hooks, you must first explicitly get the Entity object. See the HCL Compass API Reference help.	Does not add any record types. See Adding an HCL VersionVault UCM integration.	Adding HCL VersionVault UCM integration
UnifiedChangeManagement (UCM) (read-only)	Supports the HCL VersionVault UCM process by enabling integration with HCL VersionVault 4.0 and higher. Links a HCL VersionVault UCM project with a HCL Compass user database. Requires the UCMPolicyScripts package and AMStateTypes package. Can be used with the BaseCMActivity package. Requires you to map schema states to the following state types: Waiting, Active, Ready, Complete.	Adds the UCMUtilityActivity record type. Adds UCM_Project stateless record type. Adds UCM queries to the client workspace in the Public Folders. Adds BASE action hook ucm_base_synchronize to the enabled record type. Adds some predefined policies hooks. See Adding an HCL VersionVault UCM integration.	Fields included in the UCMUtilityActivity record type: am_statetype Description Owner Headline ucm_vob_object ucm_stream_object ucm_stream ucm_view ucm_project Fields included in the UCM_Project record type: name ucm_vob_object ucm_chk_before_deliver ucm_chk_before_work_on ucm_chk_mstr_before_dlvr ucm_chk_mstr_after_dlvr ucm_cq_act_after_deliver ucm_cq_trans_after_deliver ucm_cq_act_before_chact ucm_cq_act_after_chact ucm_cq_trans_after_chact Fields added to the enabled record type: am_statetype ucm_vob_object ucm_stream_object ucm_stream ucm_view ucm_project
Webhooks	Enables Webhook integration to create and store configurations that can be used to send webhooks to external services.	Adds the Webhook, WebhookData, WebhookMaster, WebhookSecutiry record types. The Webhook action is a BASE action and is used to capture all of actions fired by the enabled record type.	Does not add any fields.