Agility integration plugin

This topic describes how to configure the Digital.ai Release—Agility integration plugin.

Install the Digital.ai Agility Integration plugin

  1. Make sure you have the Digital.ai Agility Integration plugin JAR file in the Digital.ai Release’s plugins/xlr-official directory.
  2. Click Plugins from the top navigation bar and use the Digital.ai Release’s Plugin Manager to verify that the plugin is installed. If not installed, search for the plugin and install the Digital.ai Agility Integration plugin.

Requirements

  • VersionOne 20.0.0+: XL Release 9.5.0+

Add Digital.ai Release as a third-party application in Agility

  1. Log on to Agility as an Administrator.
  2. Click Applications from the Admin menu. AddApplications
  3. Add Digital.ai Release as a third-party application and click Add.
  4. Copy the access token generated and keep it handy for configuring the Agility server in Release. CopyAccessToken

Configure the Agility Server in Digital.ai Release

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

Release Tasks

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

  • Create Asset
  • Create Asset From Template
  • Create Issue
  • Get Stories
  • Get Asset
  • Update Asset
  • Update Story Status
  • Check Issue
  • Check Asset
  • Check Query
  • Update Multiple Asset Status

Create Asset

This task lets you create new assets of type Story, Test, Defect, and Task in Digital.ai Agility.

Input Properties

  • You must pass the Agility project’s oid for creating new assets such as Story, Test or Defect.
  • You must pass the Story’s oid in case you want Task type assets created in Agility.
  • You must pass the mandatory attributes required for the asset you want to create. 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.

Create Story example

  1. Task configuration for creating an Agility Story. StoryConfig
  2. Once you run the task, a new Story is created in Agility. You can find the new Story’s number in Output properties. StoryCreated Added Functionality to showcase the Asset Number and the Token from the Data section in Output properties. StoryCreated

Create Task example

  1. Task configuration for creating an Agility Task. TaskConfig
  2. Once you run the task, a new Agility task is created in Agility. You can find the new Task’s number in Output properties. TaskCreated Added Functionality to showcase the Asset Number and the Token from the Data section in Output properties. StoryCreated

    Task created in Agility.

    TaskInAgility

Create Asset from Template

This task lets you create a new asset from an existing template.

Create Asset From Template example

  1. Task configuration for creating a Story from an existing template. In this example, S-01654 is the ID of the template that’s used to create a new story. asset from template config
  2. Asset created from template. The new asset’s ID can be found in Output properties. asset created from template config
    Added Functionality to showcase the Asset Number and the Token from the Data section in Output properties. StoryCreated

Create Issue

This task lets you create a new issue in Agility. See Asset Types for a list of possible values.

CreateIssueConfig CreatedIssue Added Functionality to showcase the Asset Number and the Token from the Data section in Output properties. StoryCreated

Note: You can add both single and multi-value attributes.

To add a multi-value attribute, type the attribute’s name in the Key field, type the comma-separated values in the Value field, and click Add.

For example, the following example shows two multi-value attributes—Owners and Tags—with comma-separated values.

Versionone multi value comma separated

These values show up in Agility when you execute this Release task.

version one add owner dashboard

Get Stories

This task lets you query the Digital.ai Agility and get a list of stories. For example, you may want to query and get the list of stories owned by you. Refer to Agility’s documentation for example queries.

Here is an example to query the list of stories owned by the Admin user. GetStories

Get Asset

This task lets you retrieve data for an asset of interest.

GetAssetConfig

Once you run the task, the asset data shows up in the Data section of Output properties.

GetAssetResults

Update Asset

This task lets you update assets of type Story, Test, Defect, and Task in Digital.ai Agility. The values created at the time of create task can be updated using this *Update Asset task.

Update Asset

Update Story Status

This task lets you update an Agility Story’s status.

UpdateStoryStatusConfig

Once you run the task, the story’s status is updated, which you can verify from the Data section of the Output properties. UpdateStoryStatusResults

Update Multiple Asset Status

Update Multiple Asset status of the same type at once from available workspace statuses.

UpdateMultipleAssetStatus

Check Issue

Check the issue (Story) by continuous polling until the given Agility issue returns one or more of the expected statuses.

CheckIssueStatusConfig

CheckIssueStatusResults

The following input properties are available:

Server: The VersionOne server where XL Release connects.

Ticket: 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 Final Status which is the final status of the ticket on last check.

Check Asset

Check asset (Story, Defect, Test, Task) by continuous polling until the given Agility asset returns an expected status.

CheckAssetStatus

The following input 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

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

CheckQueryStatus

Find Story by Id

This task allows you to get story information based on Oid.

FindStoryById

The following input 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

Digital.ai Release—Agility Integration Plugin 10.1.0

The VersionOne Integration Plugin has been re-branded as Agility Integration Plugin(xlr-agility-integration in Plugin Manager). In addition:

  • You can now create Agility assets (Story and Defect) from Agility templates
  • You can now pass comma-separated attribute values for Agility fields
  • The Get Asset task replaces the Get Story task and lets you retrieve an asset’s (Story, Defect, Test, Task) data from Agility

    Note: Though the Get Asset task functionally replaces the Get Story task, the Get Story task is not removed completely for backward compatibility purposes. It shows up as Get Story (legacy).

    GetStoryLegacy

Here’s a list of Jira tickets associated with Agility Integration Plugin 10.1.0.

  • ENG-5072
  • ENG-4581
  • ENG-4579
  • ENG-4376
  • ENG-4367
  • ENG-4368
  • ENG-5452

XL Release Integration Plugin 10.0.0

Bug fix

  • [ENG-2394] - Fix bundled dependency with versionone integration

XL Release Integration Plugin 9.8.0

Improvements

  • [ENG-1528] - Updated product documentation

XL Release Integration Plugin 9.7.0

  • [ENG-230] Initial release.