Lecture 3: Navigating the Requirements Management application: Web client

Essentials of IBM Rational DOORS Next Generation V4.01
Navigating the Requirements Management application: Web client 1© Copyright IBM Corporation 2013
Course materials may not be reproduced in whole or in part without the prior written permission of IBM.
© Copyright IBM Corporation 2013
Navigating the Requirements Management application:
Web client
Contents
Module overview -2
Logging in to the project repository -3
The All Projects page -4
The Home menu -5
The project dashboard -6
Project level Artifacts page -7
Basic layout in projects in the RM application -8
Rich hover information -13
Finding artifacts by using quick search -14
Editor examples -16
Artifact specific links -17
Comments about artifacts -18
Help: In context and in the
information center -19
Lab 1: Navigating the web client of the RM
application -20
Customize the columns in the artifacts table -21
Filtering artifacts -22
Finding artifacts -23
Views -24
Recently viewed artifacts -25
Commenting on artifacts -26
Lifecycle coverage and progress analysis -27
Viewing and modifying the personal dashboard -
28
Viewing the mini dashboard -29
Lab 2: Creating views at the project level -30
Lab 3: Commenting on artifacts and customizing
dashboards -31
Review -32
Module summary -33

2 © Copyright IBM Corporation 2013
Module overview
After you complete this module, you should be able to:
 Navigate the web client interface
 View requirement artifacts and information about them, both
at the project level and in modules
 Use filters to focus on relevant information
 Change display settings to reveal relevant details
 Quickly switch perspectives of the requirements information
by using views
 Use comments on artifacts to collaborate
 Use dashboards for lifecycle and progress analysis

Logging in to the project repository
URL: https://hostname:9443/rm/web/
To log in to the project
repository, you must have a
URL, user ID, and password.
The hostname is the fully qualified host name
of the server that your administrator provides.

The All Projects page
The All Projects page opens when you first log on.
This page lists the projects in the Requirements
Management (RM) application that you are a member of.
Project dashboard
Project artifacts
Project name
Jazz Team Server
From the All Projects page, you can open a
project dashboard or go directly to the
Artifacts page of the project.
You can access the All Projects page from
the Home menu, which is indicated by the
house icon .

The Home menu
Use the Home menu to navigate between
requirements projects.
In the context of the Rational solution for
Collaborative Lifecycle Management (CLM), you
can use the Home menu to access the Change
and Configuration Management (CCM) and
Quality Management (QM) project areas.

The project dashboard
Each project has a dashboard.
The dashboard is composed of widgets
that provide views into the project.
View requirements that are
linked to implementation plans.
See recent changes to
project artifacts.
Access pending reviews.
Read recent comments
about artifacts.
Go to other projects.
The project dashboard is composed of
widgets that provide high-level overviews of
artifacts and requirements that are scoped to a
specific project in the RM application .
The project dashboard can be modified only
by users who have administrative access to
the project.

Project level Artifacts page
Content pane:
Artifacts that match the
current filter criteria are
shown in the artifact list
Title
Display
settings
Sidebar:
Contains
information that is
relevant to the
level (in this case,
the project level)
Expand/Collapse
icon
Artifact attribute
1
3 2
Filter and
Navigation pane
4
At the project level, the Artifacts page is
divided into four sections:
1. Title
2. Sidebar
3. Content pane
4. Filter and Navigation pane
Filters determine what artifacts are displayed
in the content pane of the Artifacts page.
You can apply multiple filters at the same
time to see specific views of artifacts.
You can customize the columns that display
in the content pane by adding or
removing attribute and link columns.
You can save applied filters and displayed
information as views. You can use views
to quickly switch the perspective of your
data. Views can be personal or shared.
You can show or hide the sidebar and
navigation pane by clicking the
Expand/Collapse icon that is displayed
when you hover near the edge of those
panes .

Basic layout in projects in the RM application
Level and artifact specific information, buttons, and settings
SidebarContent paneFilter and
Navigation pane
Title
1
4 3 2
A basic layout persists in the RM
application and other IBM®
Rational® Jazz™ applications:
(1) Title section, the project- and
user-specific information is
displayed.
(2) In the “L” shaped, information
that is specific to the level you are in
is displayed . For example, at the
project level, you can get information
about recently modified artifacts,
reviews, and comments. At the
artifact level, you can get information
about the artifact’s attributes, links,
tags, and comments.
(3) The content pane contains the
core description of the artifact. At the
project level, all of the artifacts are
listed on the content pane . For a use-
case artifact, this area contains the
use-case. For a module, this area
displays hierarchically and logically
organized artifacts.
(4) Not all artifacts have a navigation
pane. For example, an artifact of the
text type does not have a navigation
pane. You can use the navigation
pane to filter ,add, or remove content.

Example: Project-level Artifacts page
Can you identify
the sections?

Example: Project-level Artifacts page with sections
Sidebar
Content
Filter /
Navigation pane
Title

When you navigate the project, take note …
Text artifact opened
from project
from module
Module artifact
Project level
ID and summary
of open artifact
Module from
where the artifact
was opened
Module-level
navigation
Project-level
navigation
The basic layout is the same at the
project level or in an artifact.
However, certain differences can help
you identify where you are in the
project.
For example, at the project level,
there is no artifact id and summary
below the Title. You also see folders
in the Navigation section.
Modules have a navigation section,
but no folders.
When artifact is opened from within a
module, you see it in the
breasdcrambs and in the sidebar
section

Can you spot the differences?
Differences:
•Breadcrumbs
•Menu options
•Sidebar
•Links
•Tags
•Comments
from project
from module
1 2
3
4
5
When an artifact is opened from the
project it looks different than when
opened from within a module.
Remember that the base artifact, may
be included in one or more modules.
The modules give the contained
artifacts scope, which means that any
tags, links, or comments will not be
part of the base artifact. However,
the base artifact comments, links and
tags, can be included in module.
[1] Breadcrumbs show the name of
the module
[2] Button to include base artifact’s
link, tags, and comments
[3] Window to show location of
artifact in the module
[4] module specific tags
[5] module specific comments and
links for the artifact

Rich hover information
Content
Attributes
Location
Base artifacts tags
Base artifacts links
In the Content pane, hover over an artifact ID to
view information about the artifact.
Artifact summary
Unique ID
Modules that this
artifact is a part of
Rich hovers are a great way to get quick
information about an artifact without leaving
the current context.
If you are working in a CLM project, you can
access rich hover information about artifacts
in other application project areas.

Finding artifacts by using quick search
To search for artifacts across
projects, type a full or partial
entry, or search by ID number.
• To further customize the
search, click More
Options.
Use an asterisk (*) as a
wildcard in the middle or end of
the search query.
Use the Quick Search field to search for artifacts by name
or primary text. You can find artifacts across projects in the
repository.
Use quick search to find artifacts in one
project or across all of the projects in the
same repository in the RM application . The
quick search feature supports full-text search
and searching by artifact number.
The quick search feature is useful in these
circumstances:
• When you know the number of your
artifact
• When you know some of the text in the
title, description, or body of the artifact
that you are looking for
• When you want to search across projects

Stay in context by using multiple browser tabs
As you move between dashboards, projects,
and artifacts to complete tasks, use multiple
browser tabs to avoid losing your context.
Open project pages and artifacts in
their own browser tabs to avoid losing
your current context .
To explore information that is
displayed in a rich hover, right-click
the title bar of the rich hover, and
then open the information in a new
tab.

Example of opening an artifact :business process diagram
Content pane:
Main content of
the artifact
The breadcrumbs shows the location of the
artifact and aids navigation. Tags
The sidebar contains an
overview of the
properties, attributes,
comments, and links. It
also identifies whether
the artifact is in modules,
collections, or reviews.
Artifact summary
Edit
You can gain more details about the
artifact when you open it.
To open artifacts, double-click the
artifact. The places where you can
open an artifact include, but are not
limited to ,these locations:
•A dashboard
•The Artifacts page
• Search results
•A module
• A collection
Each artifact editor follows the same
basic pattern for information, as the
one you saw at the project level.
The Edit button is in the upper-right
side of the application . After you
click Edit, the button is replaced with
the Save, Done, and Cancel buttons.
After you click the Edit button, you
can to edit the summary field,
content, and a few attributes of the
artifact.
You can also edit the content of the
artifact, with artifact specific toolbars,
such as rich text, use-case, and more .

Artifact specific links
Links establish relationships between
artifacts and enable traceability.
You can use traceability
through linking to perform
analysis. For example:
 Coverage analysis
 Impact analysis
 Progress analysis
Click a link to navigate to
the linked artifact.
Sidebar of artifact 122.
The artifact is open
After the artifact is open, you can use the
Links section in the sidebar to manage links
and navigate to linked artifacts. You can edit,
remove, filter, and sort the links in that
section.
Remember that an artifact can be opened
from the project level. When you open an
artifact at the project level, you open the base
artifact.
An artifact can be part of a module. Inside a
module, an artifact might have links,
comments, and tags that are module specific.
The links that you see might vary based on
where you opened the artifact.

Comments about artifacts
Team members can communicate about
artifacts that are being developed by
using comments.
The orange outline indicates
the element of the artifact
that the comment applies to.
In this case, the comment
applies to the entire artifact.
Comments are shown in the
Comments section of the
sidebar.
A comment is a textual discussion item that is
associated with an artifact or an element in an
artifact. Comments are an effective way for
team members to communicate and provide
feedback during artifact development.
Comments are displayed in these areas:
•In an open artifact, in the Comments section
of the sidebar
•On the Artifacts page at the project level, in
the Recent Comments section of the sidebar
•On your personal dashboard, in the Recent
Comments for Me section
You can comment on an artifact as a whole
and on specific elements in an artifact. In
rich-text artifacts, you can comment on the
whole document, a paragraph, or an item in a
list. Comments are available to all team
members who have access to the artifact.
Comments are threaded, can have priority,
and can be directed to one or more people.
You can filter the comments pane in the
sidebar. For example, you can show only the
comments that are not resolved.
If the comments are about artifacts in
embedded in a text artifact, you can highlight
all the embedded artifact that have
comments.

Help: In context and in the information center
In-context help provides
information about your
current location in the
application.
Click the Help icon to open
the information center.

Lab 1: Navigating the web client of the RM application
After you finish this lab, you should
be able to do these tasks :
– View requirements artifacts
– Locate artifacts
– Open an artifact
– Access the information center

Customize the columns in the artifacts table
Change column
display settings
Choose artifact
types and links
to display
1
2
Choose artifact
types and links
to display
3
Columns to
show
By changing the column display
settings, you can display attribute and
link information about the artifacts.

Filtering artifacts
Apply filters to display requirements
artifacts based on specific criteria.
You can filter by tag, attribute, or
folder.
You can combine filter criteria to
create targeted views of artifacts.
You can save filter and display
criteria as personal or shared views.
Indicates the filters that are applied
Clears the filter
You can use the filters on the project-level
Artifacts page to display artifacts based on
specific criteria.
You can filter by tags, artifacts, and folders.
You can also combine these filters to create
highly targeted views of artifacts.
When you select filters in multiple sections,
only the artifacts that match the criteria in
those sections are displayed.
You can create views of artifacts that have
specific filter criteria and a specific layout of
columns. Views can be personal or shared
with team members.
When you use filters, be sure that the filter
you want is the only one that is applied.

Example: Filter by Name
Boolean operation
used by search query
Use the Name attribute filter to
search for artifacts in the current
project by name, example: donor.
Use an asterisk (*) as a wildcard in
the middle or end of the search query.

Views
Views capture filter and column display options.
Shared and
private views
The applied
view is private
Saves a view
By creating a view, you can easily get
different perspectives of your data.

Recently viewed artifacts
View recently viewed artifacts from
the Artifacts menu.
The Artifacts menu displays a list of recently
viewed artifacts. To quickly navigate to
recently viewed artifacts, use this menu .
You can find similar information in the
sidebar.

Commenting on artifacts
You can direct the comment
to a particular team member
and set priority.
You can create a comment or
reply to a comment.
Reply to comment.
Open the artifact. In the sidebar, find the
comments section.
You can create a comment for an artifact
orreply to comments.
As mentioned previously, you can comment
on an artifact as a whole and on specific
elements in an artifact.
When you create a comment, you can direct
it to one or more users, in which case the
comment is displayed in each user’s
dashboard. If your server has e-mail
notifications set up, you receive an e-mail
when comments are directed to you.
When comments are directed to a person, the
person receives an email with the comment
and a link. When the recipient clicks the link,
a browser opens the related artifact and
shows that comment.
You can also set priority for a comment.
When the issue that is raised in the comment
is addressed, you can resolve the comment.

Lifecycle coverage and progress analysis
In the context of the Rational solution for CLM, you can
use links to analyze coverage and progress throughout
the project lifecycle.
Implemented by a plan or work
item in the CCM application
Validated by a test case in the
QM application
In the context of Collaborative
Lifecycle Management (CLM), links
enable you to analyze coverage and
progress throughout the project
lifecycle.
The above example, we see an artifact
which is linked to other artifacts
within the project, such are test cases,
implementation details, and
constraints.
This information can all be displayed
in columns within the project,
collections, or modules, allowing you
to review multiple artifacts at the
same time.

Viewing and modifying the personal dashboard
You can customize your
dashboard by moving, removing,
or adding widgets.
Use personal dashboards to create
customized views of project information.
Most widgets show results for all
projects, but you can add filters to
limit the results.
The personal dashboard is composed of
widgets that provide high-level overviews of
your projects and recently updated artifacts,
requirements, reviews, and comments. You
can add and remove widgets, or drag them to
another location on the dashboard. Most
widgets show the results for all projects that
you are a member of, but you can restrict the
scope to one project.
Your initial personal dashboard is created
automatically; however, you can also create
more personal dashboards.

Viewing the mini dashboard
To open the mini dashboard ,
click the vertical bar on the
far left.
To close the mini dashboard ,
click anywhere outside of the
mini dashboard.
To dock or undock the mini
dashboard, click the pin icon.
The mini dashboard is a small dashboard that
you can open from any page as you work. You
can add, modify, or remove widgets from this
dashboard .
In addition to personal dashboards, you can
access and customize a small dashboard
called the mini dashboard. You can open the
mini dashboard from any page in the web
client.
To open the mini dashboard, open the web
client and click the vertical bar in the far left .
To minimize the mini dashboard, click
anywhere outside of the dashboard.
When the mini dashboard is open, you can
add, modify, and remove widgets. These
widgets are the same widgets that you can
add to a project or personal dashboard.
To add widgets, click the Add Widget icon
in the mini dashboard. In the Add Widgets
window, select a widget. You can also add
widgets by dragging them from a personal
dashboard to the mini dashboard. While you
are dragging the widget, guide lines indicate
where the widget will be placed.
You can add an unlimited number of widgets
to the mini dashboard. However, a best
practice is to place higher-priority widgets or
frequently used widgets at the top. To
maximize the limited space in the mini
dashboard , you can collapse widgets and
limit the number of items that are included in
lists, such as query results and news feeds.

Lab 2: Creating views at the project level
When you finish this lab, you should
be able to do these tasks :
– Use filters to focus on artifacts
– Change the artifact information
displayed as columns
– Create a view at the project level
– Clear filters and views

Lab 3: Commenting on artifacts and customizing dashboards
When you finish this lab, you
should be able to do these tasks :
– Comment on artifacts
– Optional: Customize your
personal dashboard

Review
 What kind of information about an artifact
does the rich hover view provide?
 What kind of information can you access from
the right sidebar in these locations?
 The project
 The open artifact
 What information do you need to
know to use quick search?
 What kinds of information can you
view on the project dashboard?
 What information might be different for an
artifact depending on whether you open it
from the project level or a module?

Module summary
In this module, you learned to do these tasks :
 Navigate the RM application
 View requirements artifacts and information about them
 Filter requirements and create views
 Comment on requirements artifacts
 Customize a personal dashboard

Lecture 3: Navigating the Requirements Management application: Web client

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (19)

Similar to Lecture 3: Navigating the Requirements Management application: Web client

Similar to Lecture 3: Navigating the Requirements Management application: Web client (20)

More from IBM Rational software

More from IBM Rational software (20)

Recently uploaded

Recently uploaded (20)

Lecture 3: Navigating the Requirements Management application: Web client