VersionOne Integration Plugin

This topic describes how to configure the XL Release VersionOne Integration plugin.

Prerequisites

  • Install the VersionOne plugin into XLR plugins/xlr-official folder
  • The latest VersionOne Java SDK (currently 16.1.0) is embedded in the plugin (no need to install separately).
  • There is no need to create a mapping of story statuses in shared configuration (compared to the community version).

Requirements

  • VersionOne 20.0.0+: XL Release 9.5.0+

Testing / Building

./gradlew clean build

And copy the jar from build/libs into XL Release plugins folder.

Server Configuration

  • Define an Access Token using the VersionOne UI: Go to Configuration - Applications and add a new Application with name XLRelease. Use Access Token as an authentication mechanism.

You need to create a Shared Configuration for your VersionOne Server. The Shared Configuration will have the information to connect to your VersionOne Server.

ServerConfig

Release Tasks

Create Issue

This task allows you to create new asset in VersionOne SeeAsset Types for a list of possible values.

CreateIssue

Create Asset

This task allows you to create new asset (Story, Test, Defect, Task) in VersionOne

CreateAsset

Get Stories

This task allows you to get a list of the stories available in VersionOne based on a query. There are several examples of queries available on the VersionOne site. For details of the VersionOne query language

GetStories

Get Story

Only one story is returned for this task. Details of the story will be contained in the Data field

GetStory

Update Story Status

Update a story status from the available workspace statuses.

UpdateStoryStatus

Check Issue Status

Check issue (Story) by continous polling until the given VersionOne issue return an expected status.

CheckIssueStatus

The following properties are available:

Server: The VersionOne server where XL Release connects.

Ticket Id: The ID of the ticket to check.

Expected Status List: A list of statuses to check for.

Poll Interval: The time in seconds between each polling action.

The output of the task is finalStatus which is the final status of the ticket on last check.

Check Asset Status

Check asset (Story, Defect, Test, Task) by continous polling until the given VersionOne asset return an expected status.

CheckAssetStatus

The following properties are available:

Server: The VersionOne server where XL Release connects.

Asset Type: List of available asset type (Story, Defect, Test, Task).

Ticket: The ticket number of the associated asset type, such as a story number, a defect number, etc.

Expected Status List: A list of statuses to check for.

Poll Interval: The time in seconds between each polling action.

The output of the task is tickets. This is a key-value map that contains the issue IDs (keys) and the summaries (values) of the tickets that were found.

Check Query Status

Check a list of issues by continous polling until the queried VersionOne issues return an expected status.

CHeckQueryStatus

The following properties are available:

Server: The VersionOne server where XL Release connects.

Asset Type: List of available asset type (Story, Defect, Test, Task).

Query: A VersionOne query that finds the tickets that will be checked in this task.

Expected Status List: A list of statuses to check for.

Poll Interval: The time in seconds between each polling action.

The output of the task is tickets. This is a key-value map that contains the issue IDs (keys) and the summaries (values) of the tickets that were found.

Release notes

XL Release Integration Plugin 9.7.0

  • [ENG-230] Initial release.