Description

HCL Compass is a comprehensive change tracking system for software development environments. The HCL Compass plugin provides an integration with Compass server to import and synchronize HCL Compass issues into an HCL Accelerate server.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
HCL Accelerate version 2.0.0 or later
Created by
HCL Software
Website
Version Name Action

1.0.14

ucv-ext-compass:1.0.14.tar

1.0.16

ucv-ext-compass:1.0.16.tar

1.0.18

ucv-ext-compass:1.0.18.tar

1.0.20

ucv-ext-compass:1.0.20.tar

1.0.22

ucv-ext-compass:1.0.22.tar

ucv-ext-compass:1.0.14.tar

1.0.14


ucv-ext-compass:1.0.16.tar

1.0.16


ucv-ext-compass:1.0.18.tar

1.0.18


ucv-ext-compass:1.0.20.tar

1.0.20


ucv-ext-compass:1.0.22.tar

1.0.22


Summary

The plugin imports work items as issues from HCL Compass server into HCL Accelerate. Data between the HCL Compass server and HCL Accelerate is synchronized by the syncCompassIssueEvent scheduled event which runs every five minutes by default. A data sync can be forced by toggling disable/enable on the integration.

Compatibility

This plugin requires HCL Accelerate version 2.0.0 or later.

The HCL Compass server version 1.0.1.00 or later is required.

Upgrade notes

Beginning with HCL Accelerate version 2.4.0 users must enter a user access key is required to connect with the HCL Accelerate server. If you are upgrading from a previous version, you must obtain and add the key to the HCL Accelerate User Access Key configuration property. If the user access key is not added, the integration fails.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
20 Auto-generated User Access Key support added (support starts with HCL Accelerate version 2.4.0 or later)
18 Minor enhancements
16 Minor enhancements
14 Minor enhancements

Usage

Use the HCL Compass plugin to import and synchronize issues from an HCL Compass server into an HCL Accelerate server. To use the HCL Compass plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The HCL Compass plugin supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
syncCompassIssueEvent Query the Compass server for issues in a project.

Integration

There are two methods to integrate the plugin:

  • Using the user interface
  • Using a JSON file

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plugin, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream and integrating with the HCL Compass server. The following table describes the information for the creating an HCL Accelerate value stream map.

  1. Download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plugin configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. View the new integration on the Integrations page.

Stage Queries

When using a vsm.json file to configure, it includes multiple stages. Stages are defined as objects within a stages array. The stages array is part of a phase object within a phases array. You can modify both phases and stages to match your own process. All stage queries are empty by default. You can add and remove phases, stages, and stage queries for your entire value stream.

The following is a simple example.


"phases": [
  {
    "name": "Planning",
    "description": "Preparing Defects for Work",
    "stages": [
      {
        "name": "Submitted",
        "query": "issue.status=Submitted",
        "description": "",
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Postponed",
        "query": "issue.status=Postponed",
        "description": "",
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Duplicates",
        "query": "issue.status=Duplicates",
        "description": "",
        "wipLimit": null,
        "gates": null
      }
    ]
  },
  {
    "name": "In-Progress",
    "description": "Work Process to Resolve Defects",
    "stages": [
      {
        "name": "Opened",
        "query": "issue.status=Opened",
        "description": "",
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Assigned",
        "query": "issue.status=Assigned",
        "description": "",
        "wipLimit": null,
        "gates": null
      }
    ]
  },
  {
    "name": "Completed",
    "description": "Defect Tracking after Work Completed",
    "stages": [
      {
        "name": "Resolved",
        "query": "issue.status=Resolved",
        "description": "",
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Closed",
        "query": "issue.status=Closed",
        "description": "",
        "wipLimit": null,
        "gates": null
      }
    ]
  }
]

DQL Queries

HCL Compass queries are based on issue objects. These objects have standardized HCL Accelerate fields. Some standard fields are automatically mapped, while others are defined by custom mapping. Aside from standard fields, the HCL Compass issue object also contains a rawIssue field that is unique to HCL Compass.

  • issue.type=Defects
  • issue.owner=“John Bret”
  • issue.status=Assigned
  • issue.id=SAMPL000000012
  • issue.project.name=Classic
  • issue.rawIssue.customer=“Customer A”

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

  • The General Configuration Properties table describes configuration properties used by all plugin integrations.
  • The HCL Compass Configuration Properties table describes the configuration properties that define the connection and communications with the HCL Compass server.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

General Configuration properties
Name Description Required Property Name
NA The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
Integration Name An assigned name to the value stream. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
NA List of plugin configuration properties used to connect and communicate with the HCL Compass server. Enclose the properties within braces. Yes properties
The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plugin. The value for the HCL Compass plugin is ucv-ext-compass Yes type
HCL Accelerate User Access Key An auto-generated user access key provides credentials for communicating with the HCL Accelerate server. Yes NA
HCL Compass Configuration Properties
Name Type Description Required Property Name
HCL Accelerate User Access Key Secure The user access key to authenticate with the HCL Accelerate server. This property is not available starting with version 1.0.18 of the plugin. Yes ucvAccessKey
URL String The URL and port of the HCL Compass server. Yes serverUrl
Username String The user name to authenticate with the HCL Compass server. Yes userName
Password Secure The password to authenticate with the HCL Compass server. No password
Repo String The repository name of the HCL Compass project. Yes repo
Database String The name of the HCL Compass database from where the data to be pulled. Yes db
Custom Field Mapping Multiline Map Compass fields to Accelerate as a JSON Object. See the >Custom mapping field properties topic. Yes fieldMapping
Compass Server Timezone Dropdown The time zone offset from the Coordinated Universal Time (UTC). Yes timezone
Import issues or work items from a specified number of months String Issues or work items are imported for the specified number of months when the plugin runs for the first time. No since
Resync Boolean If checked, any changes to mapping is propagated to already imported data. No resync

Custom mapping field properties

Custom mapping fields are not required because mappings can be derived from the Compass JSON data. However, when specifying custom mapping fields, they must be provided through the Compass configuration or the HCL Accelerate Create Integration form. The Create Integration form takes precedence.

Property Name Description
type The type of work item. For example: Defect.
name The name or headline in HCL Compass.
creator The creator of the work item. For example: submitter or created by field in HCL Compass.
owner The owner of the work item. This can be the Owner field in HCL Compass.
priority The priority of the work item. This can be the Priority or Hierarchy field in HCL Compass.
description The description or headline in HCL Compass.

JSON code example

The following example can be used as a template to include the Compass plugin integration into the JSON file. Copy and paste the template into the JSON file and make the appropriate changes.


"integrations": [
  {
    "type": "ucv-ext-compass",
    "tenant_id": "<Tenant Id>",
    "name": "Compass",
    "disabled": false,
    "properties": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "https://10.13.14.67:8190",
      "userName": "admin",
      "password": "admin",
      "repo": "1.0.0",
      "db": "SAMPL",
      "fieldMapping": "[{\"type\": \"Defect\", \"fieldMapping\": {\"name\": \"Owner\", \"creator\": \"Submitter\", \"owner\": \"Owner\", \"priority\": \"Priority\", \"description\": \"Description\"}}]",
      "timezone": "UTC-05:00"
      "since": "6"
    }
  }
]