Plan - Usage

To use the Plan plug-in, the plug-in must be loaded and an instance created before you can configure the plug-in integration. You define configuration properties in the user interface or in a JSON file.

Integration type

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

Name Description
syncCompassIssueEvent Query the DevOps Plan server for issues in a project.

Integration

There are two methods to integrate the plug-in:

The tables in the Configuration properties topic describe the properties used to define the integration.

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plug-in, 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. Within the JSON file is a section for integrations. It is in this section that plug-in properties can be defined.

  1. From a value stream page, 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 plug-in 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.

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.

General Configuration table

Name Description Required
image The version of the plug-in that you want to use. To view available versions, see the UrbanCode DockerHub. If a value is not specified, the latest version is used. No
name An assigned name to the value stream. Yes
loggingLevel The level of Log4j messages to log. Valid values are: all, debug, info, warn, error, fatal, off, and trace. The default is info. No
properties List of plug-in configuration properties used to connect and communicate with the Plan server. Enclose the properties within braces. Yes
tenant_id The name of the tenant. Yes
type Unique identifier assigned to the plug-in. The value for the Plan plug-in is ucv-ext-compass Yes

Plan Configuration Properties table

Name Type Description Required Property Name
DevOps Velocity User Access Key Secure The user access key to authenticate with the DevOps Velocity 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 DevOps Plan server. Yes serverUrl
Personal Access Token Secure Personal Access Token to authenticate with an application in DevOps Plan. Yes pat
Team Space String Team Space Id of the DevOps Plan tenant. Yes repo
Application Name String The name of the DevOps Plan Application. Yes db
DevOps Plan Server Timezone Dropdown The time zone offset from the Coordinated Universal Time (UTC). For example, if the plan server timezone is Asia/Kolkata select UTC+05:30 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

Example

The following example can be used as a template to include the 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": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "<server-url>",
      "pat": "<personal-access-token>",
      "repo": "<repo>",
      "db": "<db>",
      "timezone": "<timezone>",
      "since": "<since>"
    }
  }
]

Example Integration for type Feature

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

Example Integration for type Story

"integrations": [
  {
    "type": "ucv-ext-compass",
    "tenant_id": "<Tenant Id>",
    "name": "<Integration-Name>",
    "disabled": false,
    "properties": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "<server-url>",
      "pat": "<personal-access-token>",
      "repo": "<repo>",
      "db": "<db>",
      "timezone": "<timezone>",
      "since": "<since>"
    }
  }
]
Back to …   Latest Version Plan    
All Plugins Velocity Plugins 1.1.57-File 1 and 1.1.57-File 2 Readme Overview Downloads