essentials of ibm rational requirements composer, v3...importing requirements into a project you can...

© Copyright IBM Corporation 2010, 2011

Essentials of IBM Rational Requirements Composer, v3

Module 2: Creating requirements

2 © Copyright IBM Corporation 2010, 2011

Module overview

After completing this module, you should be able to:

Import requirements artifacts from external sources

Create and edit requirements artifacts

Create glossaries


Topics

> = Current topic

>Requirements

Creating requirements

artifacts

Editing requirements

artifacts

Glossaries


Levels of requirements

Use-case model

Vision

Supplementary Specifications

• Features

• Functional requirements

• Non-functional requirements (including

constraints)

• Use cases or user-story elaborations

Userperspective

Solution

space

UI specification

Systemperspective

Storyboard

• User interface

specification

• User interface

• StoryboardUI Sketch

High-level businessrequirements

,

• Business goals and objectives

• Business processes (as-is versus to-be)

• Stakeholder needs

• Glossary

• Business rulesGlossary

Businessperspective

Stakeholder needs

Business processes

Problem

space


Capturing business requirements

Rational Requirements Composer can help you elicit

and analyze business requirements

Existing requirements artifacts can be uploaded from different

sources to the Rational Requirements Composer repository

Rich-text documents capture structured and unstructured

information

– Stakeholder needs

– Business goals and objectives

– Business rules

– The vision document

Business process diagrams help you understand business

requirements


Requirements come from many sources

DB DB

Spreadsheets

Models

Documents

Folders

DataEmails

Images

Glossaries

Hyperlinks


Topics

> = Current topic

Requirements

> Creating requirements

artifacts


artifacts

Glossaries


Anatomy of an artifact

Where artifact is stored.

Use projects and folders

to organize artifacts.

The format specifies the

structure of the artifact

content.

Artifact types classify

requirements and related

artifacts and provide a

consistent set of

attributes for each

specific type.

Other artifact attributes.

Some attributes are

generated automatically.

Others can be edited.

Links represent

relationships between

artifacts.

Unique ID

Tags

Artifact content.

Title


Creating artifacts

In Rational Requirements Composer you can create artifacts several ways, including these methods:

Import artifacts from external sources

– Comma-separated values ( CSV) files

– Microsoft Word files (.doc and .docx files)

– Open Document (.odf) and Open Office (.odt) files

– Rich text (.rtf) files

Create new artifacts

– Create Artifact wizard

– One-click artifact creation

– Artifact templates

– OSLC-CLM actions

Use existing artifacts to create artifacts

– Copy artifacts

– Create similar artifacts

– Save a selection as new artifact and link or embed the artifact

– Create a new project by using a template that contains artifacts


Importing requirements into a project

You can import requirements that are captured in documents

and CSV files into a requirements project.

Imported data is converted to artifacts and can be edited.

In this example, requirements captured in a spreadsheet are

imported to a project.

Select the folder to upload the

requirements to, click the Edit

menu, and then click Import CSV.1

Click Browse, select the file,

confirm the folder, and click Finish.

2


Requirements artifacts created from imported CSV file

The data from the spreadsheet is imported.

Each row in the CSV file is converted to a

requirements artifact in the project.


Uploading artifacts

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.


Lab 2.1: Importing and uploading artifacts

Complete these tasks:

Import requirements from external

sources

Upload an artifact


Creating an artifact using the wizard

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.

2

Type a name for the artifact. Choose the

artifact type and format.

Indicate which folder to put the new

artifact in and apply tags. 3

4

Select this check box to

open and work with the

artifact.


Working with an artifact: 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.


Working with an artifact: Embedding artifacts

You can embed an artifact within

another artifact.

With these controls, you can get

information about, maximize, or

minimize the embedded artifact.


Working with an artifact: Extracting artifacts

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


Creating an artifact using the one-click create method

Create artifacts quickly with the one-

click create method. Then define the

artifact in the artifacts display table.

Click the menu arrow, and select

the artifact type to create. 1

Select One-Click Create. 2

Define the content, and set

attributes for the new artifact;

then click Save.

4

Click the Create Artifact button. 3


Creating an artifact using one-click create (continued)

Use the one-click create method to

create multiple artifacts quickly.

Click Create Artifact multiple

times to create multiple artifacts.

Use the formatting toolbar to

format text in the Primary

Text field.


Creating artifacts based on a template

Artifact templates facilitate artifact

creation and promote consistency.

When you create an artifact,

choose the artifact template from

the Template list.

Use the template to create your

artifact.2

1


Topics

> = Current topic

Requirements


artifacts

> Editing requirements

artifacts

Glossaries


Editing artifacts in the Artifact editor

Open an artifact to edit its content,

attributes, and links in the Artifact editor.

Click Edit to edit an artifact in the

Artifact editor.


Editing artifacts in the View All Artifacts table

Click the Edit menu icon, and

click Edit Artifact.1

Edit the artifact in the table. 2

When you are finished editing,

click the Save icon drop-down

arrow, and click Save Artifact.

3


Editing artifact attributes in the View All Artifacts table

Click the Edit menu icon, and

click Edit Attributes.1

Select attribute values, and then

click Save.2


Editing attributes for multiple artifacts

You can edit attributes or apply tags

to multiple artifacts.


Lab 2.2: Creating requirements artifacts

Complete these tasks:

Create requirements artifacts

Extract requirements from current

artifacts


Topics

> = Current topic

Requirements


artifacts


artifacts

> Glossaries


Glossaries

A glossary is a catalog of terms.

Use glossaries to achieve these goals: Create a common understanding of terms

Encourage the consistent use of terms

Explain unfamiliar terminology

Remove ambiguity

Initiate new team members to project terminology

Glossary terms are good input for analysis models

Glossaries can be organized by business functions or processes

You might create a glossary to: Understand the business environment better

Create a common terminology to enable more effective communication between the business and IT groups


Shared glossaries

With Rational Requirements Composer, you can: Maintain multiple glossaries to reduce organizational

confusion

– Enterprise, project, and client

– Business, technical, and industry-specific

Choose a glossary structure

– A glossary is a catalog of terms

– A term can be used in one or more glossaries• A term is related to other terms and can have associated acronyms

or abbreviations

• A term can have synonyms

• A term can have specified properties

Edit the glossary and terms

– Specify additional relationships to other glossaries and terms


Looking up a term

When you work in artifacts, you can look up

glossary terms from selected text in the artifact.

Select the text, and then click the

Lookup icon.


Creating a term from within an artifact

Select the text, and then click the

Create New Term icon.

1

2

You can create glossary terms from

within an artifact.


Creating a term (continued)

In Name, type the term.

Select Term in Artifact Type.

Select Text in Artifact Format.

Browse to locate the new term in

the Glossary directory.

Select Open Artifact.

Click Finish.

3


Creating a term (continued)

Type the term definition, and then

click Save or Done.4

The new term is listed in the

glossary directory.


Defining alternative spellings, status, and synonyms for a term

In Edit mode, you can specify

alternative spellings for the term

or set status.

And, you can define a synonym

for the term by creating a

Synonym link to another term

artifact.


Exporting and printing artifacts

You can export glossaries and other artifacts

to a PDF file, a Microsoft Word document,

and to a CSV file.

The JKE Business Recovery

Matters project glossary is

exported to a Word document.

Individual glossary terms as

they appear in the Word

document.


Lab 2.3: Working with glossaries

Complete these following tasks:

Create glossary terms

Export requirements artifacts


Review

Describe the levels of

requirements that a project might

have.

When would you upload versus

import a Word document?

What does it mean to embed an

artifact? Give an example of

when you might do that.

What does it mean to extract an

artifact? Give an example of

when you might do that.

Why build a project glossary?


Module summary

In this module you learned how to:

Import and upload requirements artifacts

Create requirements artifacts by using the Create

Artifact wizard and the one-click create function

Export requirements

Add content to requirements artifacts

Edit requirements attributes

Create glossaries