Description

Microfocus Application Lifecycle Management (ALM) Octane provide management or testing automation across an application lifecycle. ALC Octane provides a central place to align tasks across projects, teams, and locations. It ensures high-quality application delivery and continuous integration through Enterprise DevOps Agile management. The Micro Focus ALM Octane plugin integrates with the ALM Octane server to import ALM Octane issues.

Quick Info

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

0.0.2

ucv-ext-alm-octane:0.0.2.tar

ucv-ext-alm-octane:0.0.2.tar

0.0.2


Summary

Micro Focus ALM Octance plugin provides for integration with an ALM Octance server. It imports work items from an ALM Octane server and saves them as HCL Accelerate issues. Data between the ALM Octance server and the HCL Accelerate server is synchronized every five minutes. You can manually trigger a synchronization by disabling and then enabling the integration.

Compatibility

This plugin requires HCL Accelerate version 2.3.1 or later.

ALM Octane server version 15.0.20 or later is required.

History

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

Plugin history details
Version Description
0.2 Initial release

Usage

To use the Micro Focus ALM Octance 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 Micro Focus ALM Octance plugin supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
SyncOctaneIssueEvent Query the ALM Octane server for issues in a workspace

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 Micro Focus ALM Octance 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

A vsm.json configuration includes multiple stages. These are defined as objects inside of a stages array, which in turn belong to a phase object within a phases array. All stage queries are empty by default. You can add and remove these phases, stages, and stage queries for your entire value stream to match your process.

The following is a simple example.


"phases": [
  {
    "name": "Planning",
    "description": null,
    "stages": [
      {
        "name": "In-Design",
        "query": "issue.status='In Design' or issue.status='Draft'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "New",
        "query": "issue.status='New' or issue.status='Accepted' or issue.status='Approved' or issue.status='Opened'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Postponed",
        "query": "issue.status='Deferred'",
        "description": null,
        "wipLimit": null,
        "gates": null
      }
    ]
  },
  {
    "name": "Active Work",
    "description": null,
    "stages": [
      {
        "name": "In Progress",
        "query": "issue.status='In Progress'",
        "description": null,
        "wipLimit": null,
        "gates": null
      }
    ]
  },
  {
    "name": "Testing",
    "description": null,
    "stages": [
      {
        "name": "In Testing",
        "query": "issue.status='In Testing'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Awaiting Review",
        "query": "issue.status='Awaiting Review'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Ready",
        "query": "issue.status='Ready'",
        "description": null,
        "wipLimit": null,
        "gates": null
      }
    ]
  },
  {
    "name": "Release",
    "description": null,
    "stages": [
      {
        "name": "Planned",
        "query": "issue.status='Planned'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Scheduled",
        "query": "issue.status='Scheduled'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Failed",
        "query": "issue.status='Failed' or issue.status='Failing' or issue.status='Aborted' or issue.status='Skipped'",
        "description": null,
        "wipLimit": null,
        "gates": null
      }
    ]
  },
  {
    "name": "Completed",
    "description": null,
    "stages": [
      {
        "name": "Done",
        "query": "issue.status='Done' or issue.status='Completed' or issue.status='Fixed'",
        "description": null,
        "wipLimit": null,
        "gates": null
      },
      {
        "name": "Closed",
        "query": "issue.status='Proposed Closed' or issue.status='Closed' or issue.status='Rejected' or issue.status='Obsolete'",
        "description": null,
        "wipLimit": null,
        "gates": null
      }
    ]
  }
]

DQL Queries

ALM Octane queries are based on issue objects. These objects have standardized HCL Accelerate fields.

  • issue.type=Story
  • issue.owner=“John Bret”
  • issue.status=New
  • issue.id=1001
  • issue.project.name=Classic

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 ALM Octance Configuration Properties table describes the configuration properties that define the connection and communications with the ALM Octance server. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

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 ALM Octance 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 Micro Focus ALM Octance plugin is ucv-ext-alm-octane Yes type
Micro Focus ALM Octance Configuration Properties
Name Type Description Required Property Name
HCL Accelerate User Access Key Secure The user access key to authenticate with the Accelerate server. Yes ucvAccessKey
URL String The URL of the ALM Octane server. Yes serverUrl
User Name String The user name to authenticate with the ALM Octane server. Use either the user name and password combination or the client ID and secret comibniation. No userName
Password Secure The password used to authenticate with the ALM Octane server. No password
Client ID String The client ID used to authenticate with the ALM Octane server. Use either Username/Password or Client ID/Secret for authentication. No clientId
Client Secret Secure The client secret used to authenticate with the ALM Octane server. No clientSecret
Version String The version of ALM Octane server. Yes version
SharedSpace ID String The unique identifier(UID) of the shared space. Yes sharedspaceId
Workspace ID String The ID of the workspace. Yes workspaceId
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

The following screenshot shows the configuration properties in the user interface:

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.

Example for using Username and Password


"integrations": [
  {
    "type": "ucv-ext-alm-octane",
    "tenant_id": "5ade13625558f2c6688d15ce",
    "name": "Octane",
    "disabled": false,
    "properties": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "https://almoctane-apj.saas.microfocus.com",
      "sharedspaceId": "123001",
      "workspaceId": "1002",
      "version": "15.1.74.53",
      "userName": "<Username>",
      "password": "<Password>"
    }
  }
]

Example for using Client Id and Secret


"integrations": [
  {
    "type": "ucv-ext-alm-octane",
    "tenant_id": "5ade13625558f2c6688d15ce",
    "name": "Octane",
    "disabled": false,
    "properties": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "https://almoctane-apj.saas.microfocus.com",
      "sharedspaceId": "123001",
      "workspaceId": "1002",
      "version": "15.1.74.53",
      "clientId": "<Client Id>",
      "clientSecret": "<Client Secret>"
    }
  }
]

Examples

The following examples can be used as a template to include the ALM Octane plug-in integration into the JSON file. Copy and paste the template into the JSON file, and make appropriate changes.

Example for using Username and Password


"integrations": [
  {
    "type": "ucv-ext-alm-octane",
    "tenant_id": "5ade13625558f2c6688d15ce",
    "name": "Octane",
    "disabled": false,
    "properties": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "https://almoctane-apj.saas.microfocus.com",
      "sharedspaceId": "123001",
      "workspaceId": "1002",
      "version": "15.1.74.53",
      "userName": "<Username>",
      "password": "<Password>"
    }
  }
]

Example for using Client Id and Secret


"integrations": [
  {
    "type": "ucv-ext-alm-octane",
    "tenant_id": "5ade13625558f2c6688d15ce",
    "name": "Octane",
    "disabled": false,
    "properties": {
      "ucvAccessKey": "<User Access Key>",
      "serverUrl": "https://almoctane-apj.saas.microfocus.com",
      "sharedspaceId": "123001",
      "workspaceId": "1002",
      "version": "15.1.74.53",
      "clientId": "<Client Id>",
      "clientSecret": "<Client Secret>"
    }
  }
]