Customizing the work item editor

You can customize the structure of the work item editor by defining tabs, sections, and presentations. Sections are areas of related content on tabs. Presentations identify the work item attributes that appear on sections. The structure applies to both the Rational Team Concert™ client and the Web interface.
About this task
An editor presentation is associated with a work item type. After you create or modify an editor presentation, you bind it to a work item type by using the Editor Presentation Bindings aspect editor. If a work item type does not have its own editor presentation, it uses the default editor presentation defined for its type category.

You can re-use tabs and sections. If you re-use a tab or section that is shared with other editor presentations, any changes that you make to it appear in the other editor presentations as well. An alternative approach is to create a duplicate tab or section. Changes that you make to a duplicate tab or section are limited to the current editor presentation.

  1. In the Team Artifacts view, right-click the project area and select Open.
  2. Click the Process Configuration tab. Expand Project Configuration, then Configuration Data, and then Work Items. Click Editor Presentations. To create an editor presentation, click Add Presentation. Enter an ID for the presentation and click OK. Define the editor presentation in a hierarchical manner. Define tabs first. Then define the sections that appear on each tab. Finally, define the presentations that appear in each section.

    Click Add Tab. In the Title field, enter the name that you want to appear on the tab in the Work Item editor. Select one of the existing layouts. To re-use an existing tab definition, select Reuse Existing Tab and select a tab ID from the list. Otherwise, select Create Tab Id and enter an ID. Click OK to save the tab definition.

    Click Add Section to add a section to the tab that you just defined. In the Title field, enter the name that you want to appear on the page in the Work Item editor. To re-use an existing section definition, select Reuse Existing Section and select a section ID from the list. Otherwise, select Create Section Id and enter an ID. Click OK to save the section definition. Click OK to save the section definition.

    Click Add Presentation to add a presentation to the section that you just defined. If the presentation will be referenced from elsewhere, such as by a link from the Quick Information section, enter an ID for the presentation in the Id field. In the Attribute field, select an attribute to add to the section. You can use the predefined attributes or you can use custom attributes, which you define in the Work Item Types aspect editor. You can further configure some presentations by adding properties, such as readonly. Click OK to save the presentation definition.

    You can configure the work item editor header by adding presentations to the Header Section. The configured presentations are displayed in one row across the top of all tabs of the work item editor.

    To configure a Quick Information section, add a Quick Information presentation. In the presentation definition, add a property named quickinformationConfiguration and set the value to the name of the Quick Information configuration. Use the Quick Information Configuration aspect editor to create a configuration.

  3. Click Save to save your changes.
  4. Click Editor Presentation Bindings. Select the editor presentation ID and the work item type to bind it to. You can bind editor presentations to each of the following editors:
    • Work Item Editor – primary editor
    • Inline Work Item Editor – inline editor in the query results of the Web UI
    • Lightweight Work Item Creation Dialog – presentation section in Deliver and Resolve wizard
    • Plan Editor Preview – plan preview used for the plan editor preview pane (Eclipse client) and the inline editor in the plan (Web UI)
  5. Click Save.

Feedback

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