Customization of dashborads
I looking for in depth documentation for the customization and configuration of dashboards in a process template in RTC (Project Configuration -> Configuration Data -> Dashboards -> Dashboard Templates). Especially I'm looking for guidelines for defining mementos and properties for the different viewlets.
Anyone knows where to find that?
/Peter
Anyone knows where to find that?
/Peter
9 answers
Hi Curtis
Thanks for the tip. I allready know this document in the help database though. And unfortuneately it is not complete regarding mememtos and properties for all different types of viewlets, you can add to a dashboard (e.g. reports).
I'm looking for some in depth documentation for the customization and configuration of dashboards in a process template, explaining why you e.g. need to add a memento containing a property containing a mememto with three properties to make a headline. I think this is not self explanatory.
Thanks, Peter
Thanks for the tip. I allready know this document in the help database though. And unfortuneately it is not complete regarding mememtos and properties for all different types of viewlets, you can add to a dashboard (e.g. reports).
I'm looking for some in depth documentation for the customization and configuration of dashboards in a process template, explaining why you e.g. need to add a memento containing a property containing a mememto with three properties to make a headline. I think this is not self explanatory.
Thanks, Peter
Hi Peter,
You're right, it's not documented completely. We were a bit reluctant to fully document this as it exposes some of the internal workings of the viewlets that we didn't want to treat as API, but we also recognize it's a necessary feature. Long term, we intend to remove the current template editor altogether in favor of wysiwig, where you create the dashboard in the Web UI and save it as a template, so that you don't need to worry about any of the internal details.
But for now, since there is no documentation, if you could let us know which viewlet(s) you're interested in, we can write up a wiki topic for you with the details.
Thanks,
Curt
You're right, it's not documented completely. We were a bit reluctant to fully document this as it exposes some of the internal workings of the viewlets that we didn't want to treat as API, but we also recognize it's a necessary feature. Long term, we intend to remove the current template editor altogether in favor of wysiwig, where you create the dashboard in the Web UI and save it as a template, so that you don't need to worry about any of the internal details.
But for now, since there is no documentation, if you could let us know which viewlet(s) you're interested in, we can write up a wiki topic for you with the details.
Thanks,
Curt
Hi Curtis,
I'm also trying to create some Dashboard Templates and struggling with the property names and momentos to use.
I'm currently struggling with a few widgets. Ones for 'Builds', 'JUnit Test Failures' and 'Team Velocity'.
For example, for the Builds widget in the Process Configuration Source I have...
I've tried many permutations but I can't find the correct properties to use. I'm currently using RTC V2 moving to V3 shortly.
Thanks in advance,
Steve
I'm also trying to create some Dashboard Templates and struggling with the property names and momentos to use.
I'm currently struggling with a few widgets. Ones for 'Builds', 'JUnit Test Failures' and 'Team Velocity'.
For example, for the Builds widget in the Process Configuration Source I have...
<viewlet>
<preference>
<memento>
<property>
<memento>
<property>ProjectAreaName</property>
<property>'{Current Project Area}'</property>
</memento>
<memento>
<property>TeamAreaName</property>
<property>'{My Team Areas}'</property>
</memento>
</property>
</memento>
</viewlet>
I've tried many permutations but I can't find the correct properties to use. I'm currently using RTC V2 moving to V3 shortly.
Thanks in advance,
Steve
Hi Steve,
This is a common problem experienced by users.
For all of the trend report viewlets, here are instructions on how to the prime them for dashboards using the process template:
https://jazz.net/wiki/bin/view/Main/HowToPrimeDashboardTrendReportsRTC20
I'll need to follow up on this thread regarding how to prime the Builds viewlet.
Let me know if you run into difficulties with the trend report viewlets
This is a common problem experienced by users.
For all of the trend report viewlets, here are instructions on how to the prime them for dashboards using the process template:
https://jazz.net/wiki/bin/view/Main/HowToPrimeDashboardTrendReportsRTC20
I'll need to follow up on this thread regarding how to prime the Builds viewlet.
Let me know if you run into difficulties with the trend report viewlets
Hi Steve,
Regarding priming the Builds Viewlet from the process template, that viewlet doesn't use a memento for anything, so the only things you will be able to configure are what you see under its settings.
Is there something specific you are trying to achieve with it that you are having problems with?
Adam Archer
Jazz Web UI Developer
Regarding priming the Builds Viewlet from the process template, that viewlet doesn't use a memento for anything, so the only things you will be able to configure are what you see under its settings.
Is there something specific you are trying to achieve with it that you are having problems with?
Adam Archer
Jazz Web UI Developer
Hi Adam,
The Builds viewlet in the Web UI has a 'Project/Team' field which doesn't appear in the Preferences section of the Dashboad Templates editor in the Eclipse client. For that reason I assumed that the 'Project/Team' name would need to be entered using a momento.
So if my project was called "XYZ" what would the Process Configuration Source for the template look like?
Thanks in advance,
Steve
The Builds viewlet in the Web UI has a 'Project/Team' field which doesn't appear in the Preferences section of the Dashboad Templates editor in the Eclipse client. For that reason I assumed that the 'Project/Team' name would need to be entered using a momento.
So if my project was called "XYZ" what would the Process Configuration Source for the template look like?
Thanks in advance,
Steve
Hi Steve,
The setting you are talking about is the "scope" of the viewlet. Currently it is not possible to configure the scope of a viewlet in the process templates. Viewlets will always get the scope of their containing dashboard, where it is relevant. If the dashboard's scope does not apply to the viewlet, it will be unscoped by default and the user will be required to select one.
We realize this is not a great limitation and have the following work item open to address it.
https://jazz.net/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/137792
Adam Archer
Jazz Web UI Developer
The setting you are talking about is the "scope" of the viewlet. Currently it is not possible to configure the scope of a viewlet in the process templates. Viewlets will always get the scope of their containing dashboard, where it is relevant. If the dashboard's scope does not apply to the viewlet, it will be unscoped by default and the user will be required to select one.
We realize this is not a great limitation and have the following work item open to address it.
https://jazz.net/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/137792
Adam Archer
Jazz Web UI Developer