Integration Steps

Integration type

The DevOps Plan plug-in supports scheduled events integration which are listed in the following table.

Integration Procedure

There are two methods to integrate the plug-in:

• Using the user interface
• Using a JSON file

Method 1: Integrating the DevOps Plan plug-in by using the user interface

1. On the Home page, click Settings > Integrations > Available tab.

2. Select DevOps Plan from the list, and then click Install.
The Add DevOps Plan Integration dialog is displayed.

3. Specify the properties by referring to the following table:

The following table lists the required fields that you must provide to integrate the DevOps Plan plug-in.

4. Click Add.

The integration is listed on the Integrations page and Status field displays that the integration is Online. If the integration is not successful, the Status field displays that integration is Failed. You must use the View log option to troubleshoot the integration.

5. Synchronization of plug-in is set to 5 minutes by default. You can disable synchronization by using toggle icon in the Disable/Enable section on the Configured tab.

Method 2: Integrating the DevOps Plan plug-in by using a JSON file

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plug-in properties can be defined. Refer to the sample JSON code in Configuration Properties section.

To integrate the DevOps Plan plug-in using a JSON, perform the following steps:

1. Navigate to value stream page, and then click the necessary value stream.

2. Click  icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.

3. Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.

4. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Configuration Properties section for more details.

5. Click Save.

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

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

• 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 plug-in integrations.
• The DevOps Plan Configuration Properties table describes the DevOps Plan configuration properties that define the connection and communications with the DevOps Plan server.

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

JSON code sample

The following example can be used as a template to include the DevOps Plan plug-in 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": "<Integration-Name>",
    "disabled": false,
    "properties": {
      "userAccessKey": "<User Access Key>",
      "serverUrl": "<devops-plan-server-url>",
      "pat": "<personal-access-token>",
      "repo": "<repo>",
      "db": "<db>",
      "since": "<since>"
    }
  }
]

Example integration for type Feature

"integrations": [
  {
    "type": "ucv-ext-compass",
    "tenant_id": "<Tenant Id>",
    "name": "<Integration-Name>",
    "disabled": false,
    "properties": {
      "userAccessKey": "<User Access Key>",
      "serverUrl": "<devops-plan-server-url>",
      "pat": "<personal-access-token>",
      "repo": "<repo>",
      "db": "<db>",
      "since": "<since>"
    }
  }
]

Example integration for type Story

"integrations": [
  {
    "type": "ucv-ext-compass",
    "tenant_id": "<Tenant Id>",
    "name": "<Integration-Name>",
    "disabled": false,
    "properties": {
      "userAccessKey": "<User Access Key>",
      "serverUrl": "<devops-plan-server-url>",
      "pat": "<personal-access-token>",
      "repo": "<repo>",
      "db": "<db>",
      "since": "<since>"
    }
  }
]

Usage

The DevOps Plan plug-in imports and synchronizes issues from an DevOps Plan server into an HCL DevOps Velocity server.

Perform the following steps to create a value stream

1. On the Velocity Home page, click Create value stream.

2. Perform the following steps in Step 1.
Specify the properties for the selected step by referring to the following table:

3. Select the Application Lifecycle Management Integration from the list in Step 2 Integrations dialog, and then click Next.

4. Select the phases for Planning, Development, and Completed in Step 3 Stages/Phases dialog.

5. Click Save.

A value stream is created.

The DevOps Plan project is integrated into the value stream. All the work items are imported to HCL DevOps Velocity and you can access project data and manage issues. Each dot in the value stream page represents a card. Select the dot to display a card with information about the dot, including its history.