Dashboard Template
Hi,
This question is regarding RTC dashboard template. I am trying to customize personal dashboard template and added few viewlet like, com.ibm.team.workitem.viewlet.statistics and com.ibm.team.workitem.viewlet.queryresults which will use query I created and added into predefined query. When I create dashboard sing this template I get following error. CRRDV5018E The widget could not be refreshed because data is missing. The project area item ID is undefined. Refresh the widget. If you have widget editing permissions, open the widget settings area and select a different work item query. Otherwise, contact the contributor or team that owns the widget. Though This viewlet expect Project Name and Query Name. Not sure How to add this Project Name information in viewlet. Can it be done using memento? what properties/values it supports? Also Currently RTC supports only, Project, Team and Contributor Dashboard. Any plan for role based dashboard? or workaround? Thanks, Sachin Chitrakoti |
3 answers
do you see any results when you run the query on its own
for the role based dashboard, there are couple of similar requests, listed below: Role based/ Role driven dashboards (152825) Support role-based personal dashboard templates (194545) if you find these do not match your requirement, suggest raising a new enhancement. Comments Thanks Dinesh,
|
Hi Sachin,
Here is the answer to your inquiry.
I've already verified the provided examples in a test dashboard template.
--------------------------------------------------------------------------------------------------------------------------------------------
Work Item Statistics Viewlet
--------------------------------------------------------------------------------------------------------------------------------------------
Example
<viewlet id="com.ibm.team.workitem.viewlet.statistics" title="Statistics Template Test">
<preference id="presentation" value="h-bar"/>
<preference id="query" value="com.ibm.team.workitem.queries.predefined.openTasks"/>
<preference id="queryCategory" value="${project-item-id}"/>
<preference id="parameter" value="com.ibm.team.workitem.attribute.creator"/>
</viewlet>
Presentation Preference Values
Pie Chart pie
Column Chart bar
Horizontal Bar Chart h-bar
Table table
Tag Cloud list
Note: Only one value can be specified (arity = 1)
Query Preference Values
The value must be an external string ID referring to a predefined query declared in the project's corresponding
process specification.
For a list of predefined queries defined for a given project area, open the Project Area Editor,
select the the "Process Configuration" tab and go to the following section:
Project Configuration > Configuration Data > Work Items > Predefined Queries
e.g.
Open created by me com.ibm.team.workitem.queries.predefined.openCreated
Closed created by me com.ibm.team.workitem.queries.predefined.closedCreated
Open Track Build Items com.ibm.team.workitem.queries.predefined.openTrackBuildItems
Open Adoptions com.ibm.team.workitem.queries.predefined.openAdoptions
Resolved by me com.ibm.team.workitem.queries.predefined.myResolved
Open subscribed by me com.ibm.team.workitem.queries.predefined.openSubscribed
Closed subscribed by me com.ibm.team.workitem.queries.predefined.closedSubscribed
Open assigned to me (current sprint) com.ibm.team.workitem.queries.predefined.myOpenCurrent
Recently modified com.ibm.team.workitem.queries.predefined.recentlyModified
Recently closed com.ibm.team.workitem.queries.predefined.recentlyClosed
Done Stories com.ibm.team.workitem.queries.predefined.doneStories
Open Tasks com.ibm.team.workitem.queries.predefined.openTasks
Done Tasks com.ibm.team.workitem.queries.predefined.doneTasks
Blocked Work Items com.ibm.team.process.scrum.blocked
Open Impediments com.ibm.team.process.scrum.openImpediments
Open Stories com.ibm.team.process.scrum.openStories
Note: Only one value can be specified (arity = 1)
Query Category Preference Values
The query category provides the corresponding execution scope or context for the specified
work item query.
The viewlet expects the value to be the UUID of the project area.
Since the UUID value is not user-friendly or easily obtained, a variable (that is interpolated at
runtime) can be utilized to represent the project area: ${project-item-id}
Note: Only one value can be specified (arity = 1)
Parameter Preference Values
The parameter value must be an external string ID referring to a work item attribute.
The work item attribute must be an enumerable attribute type.
e.g. Severity, Priority, Type etc.
e.g. NOT Summary, Description, Creation Date
To determine the external IDs for work item attributes defined for a given project area, open the Project Area Editor,
select the the "Process Configuration" tab and go to the following section:
Project Configuration > Configuration Data > Work Items > Types and Attributes
Then, select the desired attribute in the "Attributes" section and click the "Edit..." button to obtain the external ID from the "ID"
field.
Otherwise, out-of-the-box external IDs for predefined work item attributes can be found in the following JS module
in the "WorkItem" component from the "RTC Development" stream:
com.ibm.team.workitem.web.client.internal.WorkItemAttributes
e.g.
Severity com.ibm.team.workitem.attribute.severity
Priority com.ibm.team.workitem.attribute.priority
Found In com.ibm.team.workitem.attribute.version
Type com.ibm.team.workitem.attribute.workitemtype
Status com.ibm.team.workitem.attribute.state
Created By com.ibm.team.workitem.attribute.creator
Owned By com.ibm.team.workitem.attribute.owner
Resolution com.ibm.team.workitem.attribute.resolution
Filed Against com.ibm.team.workitem.attribute.category
Planned For com.ibm.team.workitem.attribute.target
Resolved By com.ibm.team.workitem.attribute.resolver
Tags com.ibm.team.workitem.attribute.tags
Modified By com.ibm.team.workitem.attribute.modifiedby
Note: Only one value can be specified (arity = 1)
--------------------------------------------------------------------------------------------------------------------------------------------
Work Items Viewlet
--------------------------------------------------------------------------------------------------------------------------------------------
Example
<viewlet id="com.ibm.team.workitem.viewlet.queryresults" title="Work Items Template Test">
<preference id="defaultQuery" value="com.ibm.team.workitem.queries.predefined.openTasks"/>
<preference id="queryCategory" value="${project-item-id}"/>
<preference id="items" value="5"/>
<preference id="secondIcon" value="["com.ibm.team.workitem.attribute.priority","com.ibm.team.workitem.attribute.severity"]"/>
</viewlet>
Default Query Preference Values
This value is the same as the one used by the Work Item Statistics viewlet.
See: "Query Preference Values"
Query Category Preference Values
This value is the same as the one used by the Work Item Statistics viewlet.
See: "Query Category Preference Values"
Items Preference Value
This value is simply a positive integer number greater than 0.
It represents the number of work item results (items) to show in the viewlet content area
after executing the specified work item query.
Note: Only one value can be specified (arity = 1)
Second Icon Preference Values
The second icon preference corresponds to the "Additional Icons" field where a user
can specify additional work item-related icons for work item query results that correspond
to work item attributes.
This value is the same as the one used by the Work Item Statistics viewlet - except the
arity and value format is different.
See: "Parameter Preference Values"
One or more values can be specified (arity = n, where n > 0)
The value format is that of a serialized string version of a JSON array.
The JSON array contains external IDs referring to work item attributes.
e.g. JSON representation of Severity & Priority attributes:
["com.ibm.team.workitem.attribute.severity", "com.ibm.team.workitem.attribute.priority"]
e.g. Serialized JSON string representation of Severity & Priority attributes:
["com.ibm.team.workitem.attribute.priority","com.ibm.team.workitem.attribute.severity"]
Note: The XML ": (double quote: " ) external entity is required to preserved the validity of the XML process specification mark-up
(If the UI forms editor is used, the double quote characters are automatically converted to external entities for you)
Hope That Helps,
Mike
|
Hi to all! I have to insert in a dashboard template for ccm project areas a widget of Requirement Managements or Quality Management, like "Reviews" of RM. Which viewlet have I to select? I don't see viewlet that refer to other Jazz application. and which identifier to use?
Thanks in advance!
|
Your answer
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.