Plug-in Documentation

IBM Rational Team Concert Work Items

Overview

Overview

This plug-in includes steps that work with work items in IBM Rational Team Concert. The Add Work Item Comments step adds comments to a work item. The Change Work Item Status step changes the status of a work item. The Check Work Item Status step adds comments to a work item

Compatibility

This plug-in requires version 6.0 or later of IBM UrbanCode Deploy.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

Documentation

Read about a full deployment architecture and process using WAS, BPM, and RTC here.

History

Version 13

Fixes APAR PH10100 Rational Team Concert Work Items plugin UnknownHostException

Version 12

Identify Filed Against based on `hierarchicalName` rather than `title`.
This modification may force some users to update the Filed Against field with the full `hierarchial` name rather than a shortened `title` name.
This change ensures there is no confusion when specifying the Filed Against category.

Version 11

Multiple work items can be specified in the Change Work Item Status and Add Work Item Comments steps.

Version 10

  • Added support for the oslc_cm namespace in the Additional Work Item attributes property.
  • If the rtc_cm: is added to the beginning an Additional Work Item attribute property, it will now be properly added to the new work item.
  • If no namespace is specified, rtc_cm will still be assumed.

Version 9

  • Fixes APAR PI76916 Parallel Add Comment steps to the same work item will no longer fail with a 409 error.
  • Update error output for potential invalid username or password specification.

Version 8

Fixes APAR PI74392 z/OS encoding issue with Check Work Item Status step.

Version 7

Various bug fixes.

Added Debug, Work Item Description, and Work Item Tags properties to the Create Work Item step.

Set Work Item ID as a Create Work Item output property.

Version 6

Support property file encryption.

Version 5

Added Create Work Item step.

Fixes APAR PI68389 Invalid recognition of non-generic path element.

Version 4

Added Check Work Item Status step.

Steps

Process steps in the RTC Work Items plug-in

Add Work Item Comments

Add Comments to an RTC Work Item

Input properties for the Add Work Item Comments step
Name Type Description Required
Add URL to Comment Boolean Check to append the URL of the process request to the comment to be posted. No
Comment String The comment to add to the RTC Work Item. Yes
Password Password The password to be used to connect to the RTC server. Yes
Project Name String The RTC project name containing the work item to add comments to. Yes
RTC Server URL String The URL of the RTC server like https://myserver:9443/jazz Yes
User Name String The user name to be used to connect to the RTC server. Yes
Work Item ID String The ID number of the RTC work item to add comments to. Yes

Change Work Item Status

Change the status of an RTC Work Item

Input properties for the Change Work Item Status step
Name Type Description Required
Action String The action to be performed on the work item. No
New State String The new state for the work item. Will not be used if action is given. No
Password Password The password to be used to connect to the RTC server. Yes
Project Name String The RTC project name containing the work item to add comments to. Yes
RTC Server URL String The URL of the RTC server like https://myserver:9443/jazz Yes
User Name String The user name to be used to connect to the RTC server. Yes
Work Item ID String The ID number of the RTC work item to add comments to. Yes

Check Work Item Status

Check a work item for a specific status.

Input properties for the Check Work Item Status step
Name Type Description Required
Password Password The password to use to connect to the Rational Team Concert server. Yes
Project Name String The name of the Rational Team Concert project that contains the work item to check. Yes
RTC Server URL String The URL of the Rational Team Concert server. For example: https://myserver:9443/jazz Yes
Status String A status to validate against. If the work item status doesnt match this status, the
step fails. If the statuses match, the step succeeds.
Leave blank to retrieve the work item status as
an output property.
No
User Name String The user name to use to connect to the Rational Team Concert server. Yes
Work Item ID String The ID number of the Rational Team Concert work item to check. Yes

Create Work Item

Create an RTC Work Item

Input properties for the Create Work Item step
Name Type Description Required
Add URL to Comment Boolean Check to append the URL of the process request to the comment to be posted. No
Additional Work Item attributes String Enter a new-line-separated name=value pairs for any additional or custom attributes
you want to populate in the new work item. The name is the ID of the
attribute and value is the value. This field currently only supports
rtc_cm and oslc_cm type text based value attributes as described here
https://jazz.net/wiki/bin/view/Main/ResourceOrientedWorkItemAPIv2#Attributes and non
text values are by ID reference.
No
Comment String If you want to add a comment to the new work item enter it here. Check below if you
want to add a link back to UCD execution in the comment.
No
Filed Against String The category this work item should be filed against. By default this is required and
Unassigned is not an acceptable value. This field is case sensitive.
No
Password Password The password to be used to connect to the RTC server. Yes
Project Name String The RTC project name where the work item will be created. Yes
RTC Server URL String The URL of the RTC server like https://myserver:9443/jazz Yes
User Name String The user name to be used to connect to the RTC server. Yes
Work Item Description String The description for the new work item. No
Work Item Summary String The summary/title for the new work item. Yes
Work Item Tags String List of tags to assign the new work item. Separate each tag by a new line or comma. No
Work Item Type String The type of work item you want to create, for example Defect, Task, Story, Risk, etc.
This field is case sensitive.
Yes