Plug-in Documentation

IBM Engineering Workflow Management

Overview

The IBM Engineering Workflow Management (EWM) plug-in provides integration with the IBM EWM server. The plug-in imports work items from an IBM EWM server and provides a single view consisting of all the work items in Urban Code Velocity value stream map. Data between the IBM EWM server and the UrbanCode Velocity 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

This plug-in requires UrbanCode Velocity Version 1.2.6 or later and IBM RTC Version 6.0.5, 6.0.6.1, EWM Version 7.0 or later.

Versions

There is no install process for this plug-in. The EWM plug-in is identified to UrbanCode Velocity as a value stream integration. UrbanCode Velocity plug-in images are located in DockerHub and the UrbanCode Velolcity code accesses the version that you select. To view available versions, see the UrbanCode DockerHub.

History

Version 1.0.2

  • Initial release

Usage

To use the IBM Engineering Workflow Management (EWM) plug-in you must define the integration, create a value stream, and upload the integration.

The value stream map contains the properties used to define the plug-in integration. The plug-in integration is defined with a value stream within the UrbanCode Velocity user interface. Defining the integration includes defining configuration properties that connect the UrbanCode Velocity server to the Engineering Workflow Management (EWM) server.

The basic flow to use the plug-in includes:

  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 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 Integration user interface page.

Integration type

The EWM plug-in 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

From the user interface Value Steam page, click Upload to upload the value stream map which is a JSON file.

The JSON file contains the information for creating a value stream and integrating with the IBM EWM server. The following table describes the information for the creating a UrbanCode Velocity value stream map.

Value stream map information
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
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
name An assigned name to the value stream. Yes
properties List of configuration properties used to connect and communicate with the IBM EWM 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 Engineering Workflow Management plug-in is ucv-ext-ewm Yes

Configuration Properties

The configuration properties which are included in the properties field are unique to the Engineering Workflow Management plug-in and define the connection and communication to the IBM EWM server.

Configuration properties
Name Type Description Required Project 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
UrbanCode Velocity User Access Key String The user access key used to authenticate with the UrbanCode Velocity server. Yes ucvAccessKey
User ID String The user name used to authenticate with the IBM EWM server. Yes userId

Example

The following example can be used as as template to include the Engineering Workflow Management plug-in integration into the JSON file. Copy and paste the template into the JSON file 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"       
      }
    }
  ]

Demonstration

View a video demonstrating the use of the EWM plug-in.