Configuring dashboard templates in the process

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.
About this task
Editions note: While Rational Team Concert™ Standard edition and Enterprise edition include the full dashboard functionality described in this topic, the Express and Express-C editions 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.
Note: You must be logged in to the Admin Web UI and be a member of either the JazzProjectAdmins group or the JazzAdmins group.

To create a dashboard template in the process specification:

  1. In the Team Artifacts view of the Eclipse IDE, right-click the project area and click Open from the pop-up menu
  2. Click the Process Configuration tab at the bottom of the editor.
  3. In the Configuration section, select the following node:

    Project Configuration > Configuration Data > Dashboards > Dashboard Templates

  4. In the Dashboard Templates list, select the template to edit. You can create and configure more than one contributor template. To create an additional contributor template, select the contributor entry and click Add another template.
    Dashboard template list with available templates and associated properties area, containing the Add another template button.
    Enter unique names and IDs for each contributor template. These names appear in the Create Dashboard menu in the Web client, with the first contributor template in the list acting as the default template when the user clicks Create Dashboard.
  5. Define one or more pages for your template.
  6. Define one or more columns in each page.
  7. Add one or more viewlets in each column.
  8. Configure the viewlets using the provided fields. If the viewlets have preferences, use the Preferences tab to set their values.

    Viewlet chooser entries in the project process configuration

Results

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
Memento structure example for Work Item Queries viewlet
HTML A single property 'html' with the value that represents the raw HTML markup
Memento structure example for HTML viewlet
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).

Memento structure example for Bookmarks viewlet

Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug