Description

The IBM Engineering Workflow Management (EWM) plug-in, previously known as the IBM Rational Team Concert plug-in, provides integration with the IBM Workflow Management (EWM) server. This plug-in imports work items from an IBM EWM server to an HCL Accelerate.

Note: IBM Engineering WorkFlow Management (EWM) was formerly called IBM Rational Team Concert (RTC) prior to RTC V 6.0.6.1.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
IBM RTC Version 6.0.5, 6.0.6.1, EWM Version 7.0 or later
Created by
HCL Accelerate
Updated Date
March 8, 2021
Version Name Modified date Action

1.0.2

ucv-ext-ewm:1.0.2.tar 08-Feb-2021 07:34

ucv-ext-ewm:1.0.2.tar

1.0.2


Overview

The IBM Engineering Workflow Management (EWM) plugin provides integration with the IBM EWM server. The plugin imports work items from an IBM EWM server and provides a single view consisting of all the work items in HCL Accelerate value stream map. Data between the IBM EWM server and the HCL Accelerate server is synchronized every five minutes.

Note: IBM Engineering WorkFlow Management (EWM) was formerly called IBM Rational Team Concert (RTC). The name change occurred beginning with Version 7.0.

Compatibility

IBM RTC Version 6.0.5, 6.0.6.1 is required to run the plugin.

EWM Version 7.0 or later is required to run the plugin.

History

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

Plugin history details
Version Description
1.0.2 Initial release

Usage

To use the IBM Engineering Workflow Management (EWM) plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. Configuration properties are defined using the product user interface or a JSON file.

Integration type

The EWM plugin supports scheduled events integration. There is only one scheduled event which is described in the following table.

Scheduled events
Name Description
SyncEWMIssuesEvent Queries the IBM EWM server for new or updated work items. If a work item already exists, it is updated.

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 IBM Engineering WorkFlow Management (EWM) server. The following table describes the information for the creating a 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.

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 Bitbucket Configuration Properties table describes the IBM Engineering WorkFlow Management (EWM) configuration properties that define the connection and communications with the IBM Engineering WorkFlow Management (EWM) 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 latest version 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 configuration properties used to connect and communicate with the IBM Engineering WorkFlow Management (EWM) 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 IBM Engineering WorkFlow Management (EWM) Server plugin is ucv-ext-ewm. Yes type
IBM Engineering Workflow Management Configuration properties
Name Type Description Required Property Name
Password String The password used to authenticate with IBM EWM server. Yes password
Projects Array A list of projects from which to import work items. Yes projects
Server URL String The URL of the IBM EWM server. For example: https://server.com/ccm. Yes serverUrl
Since String The number of months for which data is to be pulled. The default is 12 months. No since
HCL Accelerate User Access Key String The user access key used to authenticate with the HCL Accelerate server. Yes ucvAccessKey
User ID String The user name used to authenticate with the IBM EWM server. Yes userId

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.


"integrations": [
    {
      "type": "ucv-ext-ewm",
      "name": "integration_name",
      "logginglevel": "info",
      "tenant_id": "tenant_id",
      "properties": {
        "serverUrl":"url_ewm_server",
        "projects" : ["project_name"],
        "userId" : "user_id",
        "password" : "password",
        "since": "60",
        "ucvAccessKey":"a-valid-user-access-key"       
      }
    }
  ]