Customizing the work item editor in the Eclipse client

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 are displayed on sections. The structure applies to both the Eclipse client and the web client.

About this task

An editor presentation is associated with a work item type. After you create or modify an editor presentation, you can use the Types and Attributes page to associate it with a work item type. If a work item type does not have its own editor presentation, it uses the default editor presentation that is defined for its type category.

You can reuse tabs and sections. If you reuse a tab or section that is shared with other editor presentations, any changes that you make to it are displayed in the other presentations. Instead of reusing a tab or section, you can create a duplicate tab or section. If you change a duplicate tab or section, the changes occur in the current editor presentation only.

Note: The work item type ID is used to distinguish one work item type from another.

Procedure

  1. Open the Editor Presentations page.
    1. In the Team Artifacts view of the Work Items perspective, right-click the project area and select Open.
    2. Click the Process Configuration tab.
    3. Expand Project Configuration > Configuration Data > Work Items, then click Editor Presentations.
  2. Define the editor presentation in a hierarchical manner. Define tabs first. Then, define the sections that are displayed on each tab. Finally, define the presentations that are displayed in each section.
    1. Define a tab.
      1. Click Add Tab. The Add Tab dialog box opens.
      2. In the Title field, enter the name to display on the tab in the work item editor.
      3. In the Layout field, select from one of the existing layouts.
      4. In the Tab section, to reuse 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.
      5. Click OK. The tab definition is saved.
    2. Add a section to the tab that you defined.
      1. Click Add Section.
      2. In the Title field, enter the name to display on the page in the work item editor.
      3. To reuse 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.
        Remember: Existing elements are shared content; any changes that you make to shared content are applied throughout the project.
      4. Click OK. The section definition is saved.
    3. Add a presentation to the section that you added.
      1. Select the section and click Add Presentation. You can define the presentation by using an attribute or a non-attribute.
        Note: If extended rich text is enabled for your application server, and you add an attribute presentation of Kind HTML, the full set of rich text toolbar icons appears in the work item field. For a list of rich text icons, see Creating work items. To enable extended rich text, set the Enable extended rich text presentation property to True on the Advanced Properties page. For details about setting advanced properties, see Configuring advanced properties.
        • Attributes: You can use the predefined attributes, or you can use custom attributes that you define in the Types and Attributes aspect editor. Select Attribute-based presentation and in the Attribute field, select an attribute to define the presentation. The attribute list contains only the available attributes that are not already added to some part of this editor presentation. If you want to display all attributes, including the ones that are already added to the current editor presentation, click the Filters button, and select Show already configured attributes. In the Kind field, select a definition for the presentation.
        • Non-attributes: You can also add a section that is not based on an attribute, such as Approvals, Quick Information, or References. Select Non-Attribute-based Presentation and in the Kind field, select a non-attribute to add to define the presentation. The following table describes the non-attributes.
          Non-attribute Description
          Approvals An Add Approval button, which users can click to assign approvals to specific users.
          Attachments A Choose File button, which users can click to browse to a file to add as an attachment to the work item.
          Code Review Summary A set of fields added to the Approvals editor presentation to enable users to conduct reviews of change sets that are associated with the work item. The Code Review Summary includes links to change sets and a place where users can record issues that they discover during their reviews.
          Discussion A section where users can enter comments.
          History A section that shows the history of changes, in chronological order, to the work item.
          Line Separator A line that you can use to organize fields in the editor presentation. If you supply a label, the line appears adjacent to the label.
          Links An Add Related button, which users can click to create a link to another work item. Users can also select the link type, such as Blocks, Depends On, and Duplicated By.
          Planned Time The Planned Start Date and Planned End Date fields. These fields are for use only with the Formal Project Management process template.
          Quick Information A section that contains links to objects that are listed on the Links page, such as attachments, subscribers, and related work items.
          Quick Information (Time Tracking) A section that contains data from time sheets. This is for use only with the Formal Project Management process template.
          References A section that displays links. In the IBM® Engineering Workflow Management client for Eclipse IDE, select the link type that you want to display. The section includes Add and Remove buttons for adding and removing links.
          Risk Matrix A matrix that is used to calculate the risk probability and impact. This is for use only with the Formal Project Management process template.
          Separator A line that you can use to organize fields in the editor presentation. If you supply a label, the line appears under the label.
          Static Rich Text A text entry. You can use bold and italics to format the text.
          Static Text A plain text entry.
          Team and Project Area The team area and project area that are associated with the work item category that the work item is filed against.
          Time Sheet Table A table that shows time sheet data. This is for use only with the Formal Project Management process template.
          Work Progress A bar that shows the percentage of work completed for the work item.
          Workflow Resolution A choice menu with the available values for resolving work items, such as Fixed and Duplicate.
          Workflow State A choice menu with the available states, such as New and Started, for the work item.
        Note: If you modify the work item editor, existing work items of the work item type that is associated with that editor are updated with the new presentations. However, if you add or modify attributes by using the Types and Attributes aspect editor, work items are not updated with those changes. In this case, you must manually synchronize the work items.
      2. 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.
      3. Optional: You can further configure certain presentations by adding properties. For example, you can add the read-only property by setting the Read Only field to true.
        As another example, for the Planned For presentation, you can customize or disable the warning message that is displayed when a user selects an iteration from a different timeline. The default editor presentation behavior for the Planned For presentation is that the iteration choices depend on the category that is selected for the Filed Against presentation. If a category is unassigned, the project area timeline is used. The editor presentation also allows users to select an iteration from a different timeline in the project area than the one that is associated with a category. If a user selects an iteration from a different timeline, a warning icon (warning icon) and associated message are displayed next to the field. You can customize or disable the warning message by using the Planned For presentation editor.
        1. On the Edit Presentations page, right-click the Planned For attribute and select Edit. The Edit Presentation dialog box opens.
        2. In the properties section, complete one of the following steps to edit the warning message property.
          • To customize the warning message, in the Warning Message field, type a customized warning message.

            Edit Presentation dialog box with the Warning Messagefield highlighted

          • To disable the warning message, select the Disable Warning Message check box.
        3. Click OK to save the customization. The Edit Presentation dialog box closes.
      4. To adjust the order of the tabs in the editor presentation, select a tab and click Move Up or Move Down.
  3. 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 the tabs of the work item editor.
  4. To configure a Quick Information section, add a Quick Information presentation. In the presentation definition, add a property that is 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.
  5. Click Save to save your changes.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki