Including process guidance in the work item editor

Edit online

You can customize the work item editor to include a link to process guidance, such as the process description, to help users learn about the work item type. When you hover over such a link, a preview of the guidance provided by the link target is displayed.

About this task

To add links in work items to process guidance, add a Static Rich Text editor presentation to a section of the work item editor. You can add links to process guidance from within a project area or a process template. To add links to process guidance from within a process template, use the IBM® Engineering Workflow Management client for Eclipse IDE. You use a pop-up editor to insert links and format text in bold or italic font.

In addition to linking to the process description for the process that your team uses, such as Scrum or Formal Project Management Process, you might want to link to a sample work item so that users can see how to complete the fields of a work item of this type.

Procedure

  1. Open the Editor Presentations page:
    1. Navigate to the project area in the administrative web interface. See Logging in for project administrators and team leads.
    2. Click Work Items.
    3. Click Editor Presentations.
  2. 2. In the Choose the Editor Presentation field, select the editor for the work item type to which you want to add links to process guidance.
  3. Select the section to which you want to add the presentation.
    For example, the following figure highlights the Details section on the Overview tab.
  4. Add the presentation
    1. Click the Add Presentation icon Add Presentation icon.
    2. Select Non-Attribute-based Presentation.
    3. In the Kind field, select Static Rich Text.
    4. In the rich text editor, enter the text that you want to appear in the editor, select the text, then click the Create Link icon, Create Link icon.
    5. In the Link Properties window, enter the URL of the target process guidance, as shown in the following figure.
    6. In the Target field, specify whether to open the link in the same window or a new window, and click Set.
    7. Click OK.
  5. You can drag the new presentation to where you want it to appear in the section. For example, for guidance about work item types, you might want the link appear directly under the Type field.
  6. To save your changes to the project area, click Save.

Results

Work items of the work item type that uses the editor presentation to which you added the Static Rich Text presentation now include that Static Rich Text presentation. For existing work items that are open in the client, you need to refresh the browser to see the change. You can click the links to navigate to process guidance or sample work items. As the following figure shows, when you hover over a link, a preview of the target is displayed.