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.

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.

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.

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.

Example integration for type Defect
"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"
    }
  }
]
Example integration for type Feature
"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\": \"Feature\", \"fieldMapping\": {\"name\": \"Owner\", \"creator\": \"Submitter\", \"owner\": \"Owner\", \"priority\": \"Priority\", \"description\": \"Description\", \"children\": \"Stories\"}}]",
      "timezone": "UTC-05:00"
      "since": "6"
    }
  }
]
Example integration for type Story
"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\": \"Story\", \"fieldMapping\": {\"name\": \"Owner\", \"creator\": \"Submitter\", \"owner\": \"Owner\", \"priority\": \"Priority\", \"description\": \"Description\", \"parent\": \"Feature\"}}]",
      "timezone": "UTC-05:00"
      "since": "6"
    }
  }
]