Rally - Get numeric rank values in apps and custom reports

book

Article ID: 57572

calendar_today

Updated On:

Products

CA Agile Central On Premise (Rally) CA Agile Central SaaS (Rally)

Issue/Introduction

A user is trying to display Rank (digital numbers 1, 2, 3, ....) using new Rally WS API in custom report similar to how they are displayed in UI:

<Please see attached file for image>

User-added image

Environment

Release:
Component: ACPREM

Resolution

There are three separate items that can be loosely called "Rank" but technically there is no Rank property on Rally artifacts starting with v2.0 of Web Serivces API .
The screenshot above from the Plan>Backlog page does not display Rank. The numbers 1 and 2 are not Rank values. In this example there are other stories (parent stories and scheduled stories) that automatically removed from the Backlog page. We can think of numbers 1 and 2 as a relative numbering mechanism applied to Backlog items, but they do not correspond to a Rank attribute in WS API. They are specific to the UI, to Backlog page, and cannot be fetched through WS API.

The second example when the word "Rank" is used is the?alpha-numeric DragAndDropRank attribute on Rally artifacts.
It looks like this:
P!!!)gO~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is a query in the WS API that return story US14 from the screenshot above:

<Please see attached file for image>

User-added image

And the JSON result that includes the?DragAndDropRank value of this story:

<Please see attached file for image>

User-added image

There is no Rank attribute returned, only DragAndDropRank.

The equivalent of this attribute in previous versions of WS API was indeed called "Rank", and that is the third example when the word "Rank" is used.? We should distinguish this example from the first two already mentioned. In versions prior to v2.0 Rank was a valid attribute on artifacts.

If we access a no longer supported version of WS API, 1.43 as shown below:

<Please see attached file for image>

User-added image

And ran the same query by FormattedID:

<Please see attached file for image>

User-added image

The result will return Rank value:

344934891350

<Please see attached file for image>

User-added image

Of course 344934891350 is not the same as #1 number assigned to this story on the Backlog page.

It is technically possible to translate an alpha-numeric DragAndDropRank as a Rank even though this translation is not supported.
See this KnowledgeBase article "How to interpret DragAndDropRank" for details.

 

Additional Information

agile central, wsapi, web services api, rank, draganddroprank, drag and drop rank, ranking

Attachments

1558689357547000057572_sktwi1f5rjvs16fx0.png get_app
1558689355508000057572_sktwi1f5rjvs16fwz.png get_app
1558689353457000057572_sktwi1f5rjvs16fwy.png get_app
1558689351468000057572_sktwi1f5rjvs16fwx.png get_app
1558689349569000057572_sktwi1f5rjvs16fww.png get_app
1558689347733000057572_sktwi1f5rjvs16fwv.png get_app
1558689345853000057572_sktwi1f5rjvs16fwu.png get_app
1558689344161000057572_sktwi1f5rjvs16fwt.png get_app
1558689342117000057572_sktwi1f5rjvs16fws.png get_app
1558689340170000057572_sktwi1f5rjvs16fwr.png get_app
1558689338389000057572_sktwi1f5rjvs16fwq.png get_app
1558689335179000057572_sktwi1f5rjvs16fwp.png get_app