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.

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 DevOps Velocity 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 DevOps Velocity 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.

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>"
    }
  }
]