SCM integration record types

There are three record types in the SCM Integration package and a placeholder which can be applied to any existing record type. All three record types are stateless.

A Compass record can have multiple events sorted on event date to give the reader a complete picture of all the SCM events associated with the record.

The record types are:

SCMIntegrationConfig

For each SCM Integration, create an SCMIntegrationConfig record. The SCMIntegrationConfig record type will hold basic information about your SCM Integration with the SCM application and who has permission to edit, create or delete SCM events.

Table 1. SCMIntegrationConfig Record Fields
Field Label	Description	Example
Config Name	Enter the name of the SCMIntegrationConfig record. The name must be unique within the database for this record type. The name should be brief and describe the SCM project. Note: This field is required. The field name is: config_name	CfgVVExpress
Enabled	Indicates if this SCM Integration is enabled or not. By default, the SCMIntegrationConfig record is enabled. To temporarily disable it, uncheck the check box. Note: This field is required. The field name is: enabled	It is enabled when checked and disabled when unchecked.
SCM Type	Represents a list of SCM Integration types from which you can select a supported SCM application. Out of the box, three types are supported: VVExpress, GitHub, and GitLab. The selected type must match the SCM application for which the SCMIntegrationConfig record is being created. For information about how to extend or customize SCM Types, see the section “Adding new SCM Types”. Note: This field is required. The field name is: scm_type	VVExpress
Description	Enter a summary to describe this SCM Integration and any special note about the configuration you want to share. Note: This field is optional. The field name is: description	Enable SCM integration with VersionVault Express for the upcoming project code name “Rocket.”
Security	A reference to SCMIntegrationSecurity record that holds a secret key to validate the connection between Compass and the SCM application for which this SCMIntegrationConfig record is being created. There is a one-to-one correspondence between an instance of an SCMIntegrationConfig record and an SCMIntegrationSecurity record. See the SCMIntegrationSecurity section for details. Note: This field is required. The field name is: scm_security	A reference to an SCMIntegrationConfig record.
Event Editors	A list of users that manually can edit, create or delete SCM events for this SCM configuration. Those would be selected users, such as the project lead. Due to the nature of loose integration, events may sometimes be assigned to the wrong record or contain some incorrect data. An event editor will be able to correct the data. Note: This field is optional. The field name is: event_editors	“lead”, “QE”

SCMIntegrationSecurity

Represents a stateless record type used to create a secret key to enable a handshake with the SCM application.

For each SCMIntegrationConfig record, you must create an SCMIntegrationSecurity record. This created record type will hold the secret key that will enable the validation of the connection with the SCM application for this SCM configuration.

The SCMIntegrationSecurity record is secured via Compass’s security context because only those in the group SCMIntegrationAdmins can see this record. The group SCMIntegrationAdmins is automatically added to the record, but the group must be created and added to the database. See the “Administration of SCM Integration” section for details.

Table 2. SCMIntegrationSecurity Record fields
Field	Description	Example
Config Name	Enter the name of the SCMIntegrationSecurity record. The name must be unique within the database for this record type. The name should be brief and describe the SCM project. By default, the name is the same as that for SCMIntegrationConfig record. Note: This field is required. The field name is: config_name	CfgVVExpress
Secret	Enter a string or use the “Generate Secret” to create a secret key to be used to validate the connection with the SCM application. Note: This field is optional. The field name is: secret	VrVmOoBkJ7KKn864c
Description	Enter a summary to describe this SCM secret, and any special note about the configuration kept private from regular users. Note: This field is optional. The field name is: description	The secret key for the SCM integration with VersionVault Express for the upcoming project code name “Rocket”.

Table 3. SCMIntegrationSecurity Record Buttons
Button	Description
Generate Secret	Generates a secret key.

Table 4. Record Script Aliases
Record Script Aliases	Description
Delete_Self	Deletes this SCMIntegrationSecret record. You cannot use the standard Delete action to delete the SCMIntegrationSecret record because the SCMIntegrationSecret record has a self-reference (for security context).

SCMIntegrationEvent

Represents a stateless record type used to hold SCM event information.

This record holds SCM events generated from SCM applications configured for SCM Integration. An SCM event belongs to a Compass record type for which an SCM Integration has been configured. A Compass record type enabled for SCM Integration can have zero or many SCM events. You can view SCM events on a Compass record type enabled for SCM Integration in the “SCM Events” tab.

An SCM event editor (see the SCMIntegrationConfig record type) can edit, create or delete an SCM event record.

Table 5. SCMIntegrationEvent fields
Field Label	Description	Example
Config Name	A list of available SCM Integration configurations to which this SCM event belongs. Note: This field is optional. The field name is: config_name	CfgVVExpress
SCM Type	The SCM Integration configuration type of the SCM Integration selected from the “Config Name” list. Note: This field is read-only. The field name is: config_name.scm_type	VVExpress
Description	The SCM integration configuration description of the SCM integration selected from the "Config Name" list. Note: This field is read-only. The field name is: config_name.description	Enable SCM integration with VersionVault Express for the upcoming project code name “Rocket”.
Type	The type of this SCM event that was initiated on the SCM application. Note: This field is required. The field name is: event_type	Assigned
Note	The note of this SCM event that was set on the SCM application. Note: This field is required. The field name is: event_note	This feature will add value to Compass.
Link	The URL to the SCM event linked to the SCM application. Note: This field is required. The field name is: event_link	`https://rocket-proj.projects.hcl.com...`
Time	The time when this SCM event was recorded or last edited in the Compass database. Note: This field is required. The field name is: event_time	1/19/2022 3:09:05 PM
Actioner	The user who created or last edited this SCM event. If the events were originated from the SCM application, the actioner's ID would be the system name. If the events were edited or created by someone who has permission to do so, the actioner would be the ID of that person. Note: This field is read-only. The field name is: event_actioner	lead

SCM Events

Represents a form tab added to any Compass record type enabled for SCM Integration.

This tab shows a list of SCM events. The list is a reference to SCMIntegrationEvent records.

An SCM event editor (see SCMIntegrationConfig record type) can edit, create or delete an SCM event record.

Table 6. SCM Events Fields
Field Label	Description	Example
Time	The time when this SCM event was recorded or last edited in the Compass database.	1/19/2022 3:09:05 PM
SCM Type	The SCM Integration configuration type of the SCM Integration selected from the “Config Name” list.	VVExpress
Type	The type of this SCM event that was initiated on the SCM application.	Assigned
Note	The note of this SCM event that was set on the SCM application.	This feature will add value to Compass.
Link	The URL to the SCM event linked to the SCM application.	`https://rocket-proj.projects.hcl.com/...`

Table 7. SCM Events Buttons
Button	Description
New	Use to manually add a new SCMIntegrationEvent record to this Compass record.
Remove	Use to manually remove an SCMIntegrationEvent record from this Compass record.

The “New” and “Remove” buttons are available only to users who are a member of event editors. Through those button’s an event editor will be able to correct any incorrect data or add missing events.

To enable the SCM integration, see How to configure the SCM integration.