VersionOne Integration Plugin

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

Prerequisites

  • Install the VersionOne plugin into the XLR plugins/xlr-official folder

Requirements

  • VersionOne 20.0.0+: Digital.ai Release 9.5.0+

Server Configuration

  • Define an Access Token using the VersionOne UI: Go to Configuration - Applications and add a new Application with the name Digital.ai Release. 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.

To create Shared Configuration do the following steps:

  1. Log on to Digital.ai Release as an Administrator.
  2. Select Settings > Shared Configuration and click the + icon next to VersionOne Server.
  3. Type a title, URL and paste the VersionOne access token generated earlier.
  4. Click Test to verify your connection to the VersionOne server.
  5. Click Save when the connection is successful.

ServerConfig

Release Tasks

Here’s a list of tasks that you can perform with VersionOne.

  • Create Issue
  • Create Asset
  • Get Stories
  • Get Story
  • Update Story Status
  • Check Issue Status
  • Check Asset Status
  • Check Query Status

Create Issue

This task allows you to create new issue in VersionOne. See Asset Types for a list of possible values.

CreateIssue

Create Asset

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

Note: A mandatory field attribute for the asset type that needs to be configured based on the VersionOne instance. For example, you must pass Name as an attribute (which is used as the Title for the asset in Agility) for creating a new Story.

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 the issue (Story) by continuous polling until the given VersionOne issue returns an expected status.

CheckIssueStatus

The following properties are available:

Server: The VersionOne server where Digital.ai 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 Digital.ai 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 Digital.ai 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.8.0

Improvements

  • [ENG-1528] - Updated product documentation

XL Release Integration Plugin 9.7.0

  • [ENG-230] Initial release.