It's all about the answers!

Ask a question

How to display a formatted query result in a RTC dashboard External Content widget


8
5
Jeffery Hanson (1472711) | asked Oct 21 '13, 12:48 p.m.
JAZZ DEVELOPER
edited Mar 07 '14, 1:45 p.m. by Geoffrey Clemm (30.0k23035)

Why is this functionality useful?

  1. You want to show the results of a cool query you have developed in a dashboard widget. You can show the extra work item attributes that you have included in the query results.
  2. You use the External Content widget to display only the HTML-formatted results of your query without the entire RTC page you normally get when showing a query using this same widget.
  3. This is great for showing formatted query results that have attribute displays that include HTML fields such as Description, Executive Summary, etc.

How do you do this?

Accepted answer


permanent link
Sara Willett (8611) | answered Mar 21 '14, 1:49 p.m.
This was a great question and answer and it led my team to finding a shortcut to make this even easier!
  1. Run your desired query
  2. Click the 'View Full Result Set in Printable Format' button in the upper right corner (on the web client)
  3. This should open a new tab/window with it's own URL.  Use that URL in your External Widget.
    1. You'll get the same URL as suggested above but without having to manually create it!
Jeffery Hanson selected this answer as the correct answer

Comments
Ginny Ghezzo commented Mar 21 '14, 2:26 p.m.
JAZZ DEVELOPER

Oh Sara!  This is wonderful!  Thank you!  


Jeffery Hanson commented Mar 21 '14, 3:05 p.m.
JAZZ DEVELOPER

Thanks for this short cut! This makes it so easy. I really appreciate you adding to this thread.

3 other answers



permanent link
Geoffrey Clemm (30.0k23035) | answered Mar 07 '14, 1:46 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER
From Jeff Hanson:
  1. Run your query of choice from the Work Items pull down in your web browser then take a look at the browser’s address bar. You end up with an address similar to this:
    • https://<server>:<port>/ccm/web/projects/<RtcProjectName>#action=com.ibm.team.workitem.runSavedQuery&id=_Rga6UChpEeOoTPLFnqdgog
  2. Find the UUID of the query: id=_Rga6UChpEeOoTPLFnqdgog
  3. Build the URL for the External Content widget
    • Use this syntax: https://<server>:<port>/ccm/resource/itemOid/com.ibm.team.workitem.query.QueryDescriptor/<queryID>?_mediaType=text/html
    • You end up with a new URL similar to this: https://jke.banking.com:9443/ccm/resource/itemOid/com.ibm.team.workitem.query.QueryDescriptor/_Rga6UChpEeOoTPLFnqdgog?_mediaType=text/html
  4. Add an External Content widget to a tab in your dashboard
  5. Edit the widget by selecting the Settings option of the widget and paste the URL into the External URL field of the settings editor
  6. Click on OK
  7. You will see a nicely formatted, table-based display of your query results with the HTML-format that you used in the HTML fields, such as Description

How did I figure this out?

I was surfing the RTC project dashboard for how the development team uses it to communicate information and found a query results display that caught my eye. I reverse engineered the External Content widget from the RTC v4.0.5 project dashboard and found the solution to a problem that I had been trying to solve for a while now. While it lasts here is a link to the dashboard I used with the RTC 4.0.5 Feature Teams widget.

We can always count on the RTC development team to showcase cool dashboard widget features!


Comments
Ginny Ghezzo commented Oct 21 '13, 5:32 p.m. | edited Mar 07 '14, 1:47 p.m.
JAZZ DEVELOPER

Let's play this like Jeopardy :

What is Something I have been trying to figure out how to do and is incredibly awesome!

Thanks Jeff for reverse engineering this and posting it here. 


Clement Liu commented Mar 07 '14, 10:19 a.m. | edited Mar 07 '14, 1:48 p.m.

This is very nice! Thank you! 


sam detweiler commented Mar 07 '14, 10:33 a.m. | edited Mar 07 '14, 1:56 p.m.

Agreed, this is fabulous! 


permanent link
Ad Smeets (111) | answered Jun 11 '15, 7:19 a.m.
Found this solution and it works great. I used it to create a query showing links between requirements, related tescases and defects found during testexecution. 

The query in CCM is showing me the state of the test exececution. On the CCM dasboard (external content) it is not showing this. Is it possible to get the information on the dashboard?

Comments
Jeffery Hanson commented Jun 11 '15, 7:54 p.m.
JAZZ DEVELOPER

Ad,

Not that I can determine. That particular functionality, test case execution status decorator, is part of the OSLC integration and display in the RTC query results. The external content widget display is based on the View Full Result Set in Printable Format which only contains hyperlinks to the related artifacts, without any extra rich display of data. Furthermore, from the RTC query you cannot access any attributes from the linked test case so that is not an option either.

You could put the direct link to the query in the External Content widget, which would solve that display need but then you would be looking at the normal query results page, not the printable view.

Hope that helps.

Regards,

Jeff


permanent link
Ad Smeets (111) | answered Jun 12 '15, 6:49 a.m.
This helps to show the information on a RQM dashboard so that's great and many thanks. Step 1 is taken ;)
Is it possible to hide the header in the screen since I am in RQM already and only referring to a CCM query in the webbrowser?

Comments
Jeffery Hanson commented Jun 12 '15, 11:28 a.m.
JAZZ DEVELOPER

I don't know. I've tried to figure it out myself in the past but was not successful.

Your answer


Register or to post your answer.