When a new dashboard is created, it will check if there
is a template registered for the particular dashboard type. Default
templates are specified on the server, but project administrators
can override them by placing a template in the project's process specification.
Editions note: While
Rational® Team
Concert 1.0.1
Standard edition includes the full dashboard functionality
described in this topic, the
Express and
Express-C editions now include limited
dashboard support. In the Express and Express-C editions, each project
area includes a single project dashboard with a single dashboard tab.
Dashboards are not available for individual users or teams.
To
create a dashboard template in the process specification:
- In the Team Artifacts view of the
Eclipse IDE, right-click the project area and click Open from
the pop-up menu
- Click the Process Configuration tab
at the bottom of the editor.
- In the Configuration section, select
the following node:
- In the Dashboard Templates list,
select the template to edit.
- Define one or more pages for your template.
- Define one or more columns in each page.
- Add one or more viewlets in each column.
- Configure the viewlets using the provided fields. If the
viewlets have preferences, use the Preferences tab
to set their values.
Valid mementos for the dashboard templates
When
the content of a viewlet is edited in a dashboard, the data is stored
in a data object called a "memento" as part of the dashboard repository
item. It is possible to pre-configure viewlets in dashboard templates
with the initial content as if the user already edited them. When
editing the template using the process editor, you can specify the
memento objects that will be used as the initial content. The following
is a list of viewlets that support memento, as well as valid memento
structure expected by these viewlets in order to correctly configure
them in templates:
Table 1. Viewlets that support memento
and the valid memento structure| Viewlet |
Expected memento structure |
Example |
|---|
| Work Item Queries |
A single property 'queryStringIds' with one
or more 'value' children - one for each predefined query id |
|
| HTML |
A single property 'html' with the value that
represents the raw HTML markup |
|
| Bookmarks |
A property 'bookmarks' containing one or more
child memento objects. Each child memento captures one bookmark with
the following properties:- title: Type: String. The title of the bookmark
- href: Type: String. The URL of the bookmark
- id: Type: Integer. A 1-based index of the bookmarks in
the list
- category: Type: String. A name of the category that this
bookmark belongs to
- description: Type: String. A short description of this
bookmark
A property 'nextId' of type 'Integer' should contain the
next index (one highter than the highest index specified in the bookmarks).
|
|
