Modul 1 RRC

Rational Requirements Composer Course Module .

MODULE 1 : INTRODUCTION 1

OVERVIEW

ABOUT RATIONAL REQUIREMENTS COMPOSERRational Requirements Composer is a collaborative requirements tool:

Addresses the whole requirements lifecycleUsers elicit, define, elaborate, organize, and analyze requirements throughout the requirements lifecycle.

Works for the whole teamUsers access a common repository with a web client and use rich collaboration features that enable information transparency and team collaboration from any where in the world.

KEY CONCEPTSIn RRC, there are some concepts about requirements management. These concepts are described in this figure:

Artifact is a general term for an object (or simply document) in the repository. Requirements and requirements-related context requirements and related information that you manage in Rational Requirements Composer are stored as individual artifacts.

You can assign attribute values to requirements and other artifacts. Attributes can be used to track project status and organize artifacts by common properties such as owner, priority, risk.

Software Engineering Lab - Computer Science Department – Bogor Agricultural University 1

ArtifactsFolder structure Attributes

LinksTags

Project

Saved filters


Links create relationships between artifacts and enable you to track traceability. Use traceability to trace a project element to related project elements, especially those related to requirements. For example, traceability helps determine that a requirement is satisfied from inception through implementation and testing.

You can use tags and artifact attributes to filter artifacts in various ways. Folders help you organize requirements. Collections, attributes, tags, and filters also help

organize requirements.

LOGIN TO RRCTo access RRC, you have to visit RRC’s URL using a web browser (preferably Mozilla Firefox). In IPB, RRC is installed in Computer Science’s server and can be accessed using this address (don’t forget the HTTPS):

https://apps.cs.ipb.ac.id:9443

Please note: Due to some restrictions from DKSI, currently the server can be accessed only from intranet (IPB network only), so you can’t access it except you’re connected to IPB network.

Please use a sample user with username bob and password bob for this intro course. On the real project, username and password will be given to every student.

MAIN INTERFACEOnce you’re logged in, you will see the main interface of RRC. It is called Dashboard.


https://apps.cs.ipb.ac.id:9443/


The user dashboard is composed of "widgets" that provide high-level overviews of your projects and recently updated artifacts, requirements, reviews, and comments.

Widgets can be added, removed, or dragged to a new location on the dashboard. Most widgets show results for all projects that you are a member of, but you can restrict the scope to a single project. The dashboard also provides links to introductory information for the product.

Your initial user dashboard is created automatically; however, you can also create additional personal dashboards.

EXPLORINGOpen a project by selecting its name on the Dashboard.

In this course, “JKE Banking” is a sample project about banking provided to explore RRC features.

This is the artifact list page. Here, you can do filtering to see artifacts matching the filter.


You can customize your dashboard by moving, removing, or adding new widgets.

The dashboard is composed of “ widgets” that offer views into your projects.

Most widgets show results for all projects, but you can add filters to limit the results.

You can open a project two ways:Click the project name on the user dashboardClick the project name on the Projects menu


Filters determine what artifacts are displayed in the View All Artifacts table. You can apply multiple filters at the same time to see specific views of artifacts.

You can customize the columns in the View All Artifacts table to show in the project artifacts display table to create views of requirements artifacts.

You can show or hide the sidebar for artifacts. To show the sidebar, click the Show icon . To hide the sidebar, click the Hide icon.

Click or hover on an artifact to view its content and details.


Filtering

options

Project

folder structure

Artifacts that match the

current filter criteria

Sidebar


ARTIFACTS

CREATING ARTIFACTYou can create artifact in 3 ways:

1. CREATE USING DIALOG BOX

Artifact types come with defined sets of attributes. When you choose an artifact type, those attributes are associated with it.

You can choose a format for the artifact content. In general, artifact types can be based on these formats:

Text Collections Sketch UI Storyboards Part Use-Case Diagram Business Process Diagram Screen Flow Term

Use the text format for rich-text requirements content that can contain text, images, and embedded artifacts. This format is used for specific artifacts types, such as actors, use-case specifications, user stories, features, business goals, glossary terms, and others. Use the part format to define aspects of the user interface.


1

Click Create Artifact, or click the menu arrow, and select the type of artifact to create. If the type is not on the list, click More.

2Type a name for the artifact. Choose the artifact type and format.

Indicate which folder to put the new artifact in and apply tags.

34

Select this check box to open and work with the artifact.


2. UPLOADING EXTERNAL FILE

Uploaded file will be kept as is (for example: an uploaded DOC will be kept as DOC and not converted to RRC format, so you can’t edit it in RRC). To be able to edit it, you have to Import, not Upload.

3. IMPORTING EXTERNAL FILE

To import, choose “Import Document...” from the menu. Imported document will be converted to RRC artifact, so you can edit it in RRC.

EDITING ARTIFACTTo edit an artifact, open it first, and choose “Edit”.


You can upload files to a requirements project. Uploaded files are stored as wrapped resource artifacts—they are not converted or editable.

Select the folder you want to upload the document to, click the edit menu, and select Upload.

1

2

3

Browse for the file. The Mime Type will is populated based on the file type that you select.

Choose a name, and select an artifact type, in this case, Supporting Resource.

Pick a folder, and add tags.

Click Finish.


Then you will be presented by an editing area based on artifact type. If it is a text artifact, the editor will be a rich-text editing area. If it is a diagram artifact, the editor will be a diagram drawing area. If it is a UI sketch artifact, the editor will be a UI sketching area.

For text type artifact, the content area is a rich-text editor. You can begin creating or editing the artifact content.

Note: You can edit graphical artifacts in the Artifact editor only on Windows systems.

EXTRACTING ARTIFACTYou can extract new requirements artifacts from an existing artifact. You can choose to create a link in the current artifact to the new artifact. Or, you can choose to embed the new artifact in the current artifact.


Open an artifact to edit its content, attributes, and links in the Artifact editor.

Click Edit to edit an artifact in the Artifact editor.

Enter content here. Use the formatting and content tools on the menu bar.

Set values for the artifact attributes.

When finished, click Save or Done to close the Artifact editor.


Extracting and linking requirements can be helpful when you are decomposing a monolithic document into manageable requirements, or when transform meeting notes into managed requirements.

If you create the new artifact from the context menu, the new artifact takes on the artifact type of the current artifact. In the example on this slide, the current artifact is a feature artifact. Therefore, the context menu defines the type of the new artifact as “Feature.”

To create an artifact of a different type, extract the artifact by clicking the Save Selection as New Artifact and Link or Save Selection as New Artifact and Insert icons on the toolbar. These icons open the Create Artifact wizard, which prompts you to select the artifact type, location, and so on.

ORGANIZING ARTIFACTSUse folders to organize requirements artifacts into a logical structure.

Folders can represent artifact hierarchies or just provide an organizing structure for a project or program.


You can extract new requirements from existing requirements artifacts.

In the Artifact editor in edit mode, select the content to capture as a new requirement, and right-click. 1

From the menu, select to link or insert the new artifact. The new artifact will be the same type as the current requirement.

2


Folders provide a flexible organizing structure.

Team members with author or administrator privileges can:

Move artifacts between folders Move folders within the project Create new folders Rename folders Delete folders

Alternatively, you can use tags and collections for more advanced artifacts organization.

ARTIFACT LINKSA link represents a relationship between artifacts. Links are mechanisms for referring to related information.

You can create these links:

Link an artifact to another artifact



Link an element in an artifact to another artifact, a new artifact, an external resource, or an uploaded artifact


A link in an artifact

In the Artifact editor, links to or from the artifact are displayed in the Links section of the sidebar. Click a link to open the linked artifact.

On the Project Artifacts page, links are displayed in rich hover windows. Click a link to open the linked artifact.


To link artifacts, you can create links from the artifact editor


On the sidebar, click the arrow next to the Link icon, hover over Add link to artifact, and then select the link type.

1

2

You can add links to artifacts from the Artifact editor.

In edit mode, select the text or element to link, and then click the Link icon on the toolbar to link artifacts.

Or, you can link to other artifacts from text or elements in an artifact.

1

2


The link type determines the relationship between linked artifacts. For example, if you link artifact A to artifact B with link type of “Parent Of” (A is parent of B), then artifact B will be automatically linked to artifact A with link type of “Child Of” (B is child of A). This two-way relationship is automatically added, so you just have to link them once.

The scope of link can go from a sentence, paragraph, or the whole document to be linked to other artifact.


Choose the link type to establish from the list.

3

You can also select the text or element, right-click, and then click Create Link from the menu.

1

2


ARTIFACT HISTORY AND REVISIONIn the artifacts display page you can select to highlight recently modified artifacts. When you select this option, artifacts that were modified ‘today’ or ‘yesterday’ are highlighted in the display.

Being aware of recently modified artifacts can help you respond to and manage change.

There are other ways to see recent changes:

The recent changes widget on the dashboard The project sidebar recent changes pane

You can click the Open History icon to view the history of an artifact.


Have any of these features been modified recently? Click the

Highlight recently modified icon.

What was recently changed in this requirement artifact?

Click the Open History icon.


You can use the artifact history viewer to view the history of most artifacts.

By clicking the Show Previous Versions tab, you can view current or past versions of the artifact. You can expand the version to see details about the revisions.

Versions are represented by colored boxes. The darkest box, which represents the most recent version, is on the left, while the older, lighter shaded boxes are to the right of the darkest box.

You might have to restore an artifact to a previous version if changes were made that you do not want to retain.


A revision is created each time that you save an artifact.

View the revision history by clicking the Show Previous Revisions tab.

Each revision is represented by a revision icon.

You can view changes that were made over time.

You can restore previous versions.

Select the version to restore, and then click the Restore icon.

1

2


Note: When you delete an artifact, the artifact and its audit history are gone. The artifact and its history cannot be recovered.

The Show Change History tab presents a summary of all changes that were made to an artifact. By clicking this tab, you can see a more detailed history of changes that were made to an artifact.

ARTIFACT COMMENTS

You can create a new comment for an artifact. Or, you can reply to existing comments.

As mentioned previously, you can comment on an artifact as a whole and on specific elements in an artifact.


By showing the change history, you can see a detailed history of changes that were made to an artifact.

Click the date that you are interested in viewing, and then click Show changes.

You can direct the comment to a particular team member and set priority.

You can create a new comment for an artifact or reply to an existing comment.


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.

You can also set priority for a comment.

When the issue that is raised in the comment is addressed, you can resolve the comment.



ARTIFACT REPORT

REPORT TYPERational Requirements Composer comes with a set of predefined document-based reports that you can run.

Name Description

Use-Case Diagram Specification Shows organized requirements by use case diagram.

Requirements Specification Shows both functional requirements (for example, use- case) and non-functional requirements (for example, supplementary requirements).

Traceability Reports Show a requirement-centered view of links to work items that implement the requirement and test suites that validate the requirements.

Audit History Shows a history of changes to the selected artifacts.

Review and Approval Provides a detailed summary of the current state of the selected reviews and their associated artifacts.

An example of requirements specification report:



CREATING REPORTTo create report, you must set some filter to view artifact list.

Note: for this course, only Requirements Specification type is needed.


Filter the display of requirements artifacts in the project artifacts page, and then click the Generate a report document for this view icon.

The report is generated based on the requirements artifacts that are shown in this view.

Select the type of report, and then click Next. Add or remove

the artifacts to include in the report. Click Next.


After report generation completed, you can either download it or download it later (if you choose to save the report to project).


Enter a name for the report, and select a file type.

Customize the report to include information such as author, company, footer text, attributes, comments, or company logo, and then click Next.

Click Finish to generate the report.

You can save the report document as an artifact in the project. Select the Save report document to project check box, specify artifact type, folder, and tags, and then click Next.

Modul 1 RRC

Documents

Transcript of Modul 1 RRC