Create a work item to submit a defect, task, or other type
of work request.
About this task
You can customize the predefined layout of the work item
editor for the work item types that are provided with your process
template. For information about process templates, see
Working with process templates.
Procedure
- Click Work Items in the main menu,
and, in the Create Work Items section, select the type of work item
to create.
Alternatively, use the shortcut on the
Welcome
to Work Items page. Click
Create a work item,
select the project area, and then select the work item type.
Note: When
you use this shortcut, a work item is created with the default work
item type, which is determined by the project's process configuration.
For information about setting the default work item type, see
Setting the default work item type.
- On the Overview tab, enter or select
values for the following fields. Asterisks in the user interface identify
required fields.
Field |
Description |
Summary |
A brief headline that identifies the work item. |
Type |
The type of work item. Commonly available types include Defect,
Task, and Story. You can customize the project to include additional
types. |
Severity |
An indication of the impact of the work item, such as Minor,
Normal, Major, or Critical. |
Found In |
The release that the work item refers to. |
Filed Against |
A category that identifies the component or functional area
that the work item belongs to. For example, your project might have
GUI, Build, and Documentation categories. Each category is associated
with a team area; that team is responsible for responding to the work
item. If you are unsure of the category, click Guess Category . This
button suggests categories by using the text in the Summary and Description fields
to search for similar work items. |
Description |
A detailed description of the work item. For example, the
description for a defect might include a list of steps to follow to
reproduce the defect. |
Note: Uniform Naming Convention (UNC) path names are
not supported in the Description field and
the Comment fields in the Discussion section.
UNC is a Windows format for
specifying the location of resources.
Tip: - In the Summary and Description fields
and in a new Comment field in the Discussion
section, you can use various shortcuts to connect to artifacts, refer
to artifacts, and notify users.
- To refer to other Jazz™ artifacts,
you can use short notations. When you save the work item, these notations
become links to the artifacts.
- Specify the type of artifact and its ID. For example: work item
123, defect 25, attachment 982.
- Refer to artifacts in other work items. For example: task 50775,
comment 4.
You can also open a content assist dialog to select a work
item by pressing Ctrl+Space twice. A list of recent work items is
displayed. Either select a work item from the list, or select
More
work items to open the
Select Work Items dialog.
Press Ctrl+Space in the content assist dialog to toggle between displaying
a list of subscriber user IDs and recent work items. To display only
More
work items in the content assist dialog, enter @ in the
rich text editor.
Note: For Chinese, Japanese (Linux), and Korean (Linux), press Alt+/.
- To write to a team member in the Description field
or in a Comment field in the Discussion section,
enter the @ symbol followed by the user ID of the team member. To
find the ID of a user, you have several choices in the rich text editor:
- Click Insert user link.
- Open a content assist dialog by pressing Ctrl+Space. Then, select
a user from the list, or click More users to
open the Select User dialog.
After you save the work item, the team member receives a
notification in their email client as specified in their user profile.
An event is also displayed in the Project and Team Events widget on
the dashboard.
- You can insert links to URLs in the Description field
or in a Comment field in the Discussion section.
In the rich text editor, click Insert/Edit External Link and,
in the Insert External Link dialog, enter the URL.
- In the Discussion section, comments are displayed with the most
recent one first.
- On the Links tab, add attachments,
subscribers, and related work items.
- To attach a file, either drag it from another application (for
example, Windows Explore
or the desktop) to the Attachments section, or click the Drag
files to add them or click here to browse area to navigate
to the file location and select the file.
- To cancel the in-progress upload of an attachment, click Cancel.
- To download an attachment, click .
- To delete an attachment, click .
Thumbnails are displayed for image attachments. Preview support
is available for PDF and video attachments by clicking the associated
file attachment.
The default size limit for attachments is
50 MB. If you are a member of the JazzAdmins group, you can change
the size limit. Log in to the administrative web UI, click the Application tab,
click Advanced Properties, scroll to the Work
Item Component section, and edit the Maximum
Attachment Size setting.
- To take a screen capture and attach it, click .
The screen capture tool is a separate Java™ application
that requires Java Web Start
to run. The first time that you use the capture tool, it prompts
you to download a file that is named rtc_screencapture.jnlp.
You can then open the capture tool with Java Web
Start Launcher. Position the frame to the area that you want to capture.
Use the arrows on the sides of the frame to expand or reduce its size
to fit the area. Click to capture the area in the frame. You can use
the pencil, arrow, oval, rectangle, text, and color buttons to highlight
specific areas of the screen capture. Specify the graphics format
in which to save the image. In the Attach to section,
select the work item to which to attach the screen capture:
- To select the current work item, click Work Item <ID>.
- To create a new work item, click New Work Item and
follow the instructions in the Create Work Item wizard.
- To search for the work item, click Other Work Item to
open the Select Work Item dialog.
- To add subscribers, in the Subscribers section, click Add to
open the Select Users dialog. Enter part or all of a user's name;
then, in the Matching users list, select the
user and click OK. Subscribers receive email
notification whenever someone modifies the work item. When you create
a work item, you are added as a subscriber. To stop receiving notifications,
remove yourself as a subscriber by clicking the delete icon beside your
name.
Be conservative when you add subscribers because they receive
email notifications whenever the work item is changed.
- To link the work item to another work item in the same repository,
in the Links section, click the down arrow next to Add and
select the type of relationship to establish. For example, you can
establish a parent-child relationship between work items, mark a work
item as a duplicate of another work item, or indicate that one work
item is blocked by another work item. To link the work item to a child
work item, click Add Children. To link the
work item to a parent work item, click Set Parent.
- To link the work item to a work item in a different repository,
click the Add menu, select Related
Change Request, select the remote project area, and find
and add the work item. To link to work items in project areas on other Jazz Team Servers,
cross-repository communication must be configured and the project
areas must be linked. For more information, see Linking to work items on remote repositories.
- Use the Approvals tab to specify
one or more users who are responsible to approve the resolution of
a work item.
- Click the arrow next to the Add Approval button
and select the type of approval (Add Approval, Add
Review, Add Verification). You
might want to create different approval types, perhaps with different
due dates, for different users. For example, you might want to have
a lead developer review the proposed resolution, and a test engineer
validate the delivered fix. You can also use approvals
to remind team members to perform a common task. For example, you
might create a work item for developers to update the copyright year
in their files.
- Specify the user or users who are responsible to approve
the resolution by clicking Add Approver.
- Select a due date. Click to
open a calendar dialog and select a date and time; then, click OK.
You can also use approvals to remind team members to perform
a common task. For example, you might create a work item for developers
to update the copyright year in their files.
- Optional: If you are working in a project that
uses the Scrum process and you are creating a Story work item, you
can specify the acceptance criteria. Click the Acceptance tab.
In the Criteria of Acceptance field, enter
the criteria for the test team to use to verify that the Story work
item is complete.
- Click Save to save the work item.
What to do next
The work item is ready to be worked on. For information on
working on and resolving work items, see
Working on and resolving work items.