Transcript
Page 1: Importing with ease july 2012

© 2012 IBM Corporation

Best Practices - Importing into DOORS

Jim Marsh [email protected] Client Technical Rep., Great West Business Unit, IBM Rational

DOORS Enlightenment Series – 7/6/2012

Page 2: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

2

Agenda

Means to import existing Requirements

Plain Text

Rich Text Format

MS Word Import

–Preparation before importing

Spread sheet Import

–Preparation before importing

Page 3: Importing with ease july 2012

© 2012 IBM Corporation

What are my options for importing?

Page 4: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Import your data and create documents

DOORS

ASCII

Spreadsheet

Microsoft Project

Tool Integrations*

FrameMaker

HTML

PowerPoint

Word

Outlook

Excel Microsoft

Word RTF

OLE

ASCII

Spreadsheet

Microsoft Project

Tool Integrations

Adobe® FrameMaker

Microsoft

Word

RTF Word

Print

Direct Entry

RIF (XML) RIF (XML)

Page 5: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Focus on:

Plain Text

Rich Text

Format - RTF

MS Word

Spreadsheet

–csv

Page 6: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Document import from plain text files

To import:

Click File Import Plain Text

Browse to file and Import.

The structure of the object

hierarchy and the values of the

object attributes are determined

by the structure and content of the

file.

Populate an empty module

Extend a populated module,

imported file is placed after the

current object

Page 7: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Document import from plain text files -- Continued

Decomposition Level:

None - create one new object and

import all the text into that object.

Paragraph - create objects for each

paragraph of text in the file.

– A block of text up to an empty line is

interpreted as a paragraph.

Sentence - create an object for each

sentence in the file.

– A block of text up to and including a

period is interpreted as a sentence.

Keyword - create an object after a

sentence that contains a keyword.

– When a keyword is parsed, the sentence

containing the keyword becomes the last

sentence in the object. A new object is

created for the next sentence.

Page 8: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Document import from rich text format

To import:

Click File Import Rich Text

Format

Browse to file and Import.

Map RTF styles to DOORS Styles

Page 9: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Export from MS Word to Rational DOORS

Todo’s before:

If Microsoft Word is installed when you install Rational DOORS, an

Export to DOORS toolbar is added to Microsoft Word.

Data is imported into the main column of a formal module.

– Headings and text are imported into the object heading and object text

attributes.

DOORS database explorer:

– open the folder or project where you want to import the Word document.

– specify the formal module where you want to import the data.

• If the module does not exist in the folder or project that is open, it is created

during the import. If the module exists you must confirm that you want the

data to be appended to the module. You must have create access to this

folder or project.

Page 10: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Export from MS Word to DOORS - continued

10

View in Outlining

Mode in MS Word

Page 11: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

MS Word Export -- Things to Note

Paragraphs in the Word document that have Outline levels 1 - 9 are imported as heading

objects.

You can choose to ignore section numbers in the Word headings.

Auto-numbered section numbers are always ignored.

Paragraphs that are formatted as body text in Microsoft Word are stored in the object text

attribute. Objects that contain paragraph text are created one level below the heading object.

OLE objects are imported and stored as OLE objects.

Tables are imported as Rational DOORS tables.

Bulleted lists are imported as Rational DOORS bulleted lists

Indented paragraphs in Word have identical indenting applied in Rational DOORS

All other styles are imported as object text.

Unicode and other international data are included in the import.

11

Page 12: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Export from MS Word to DOORS - continued

12

Page 13: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

Importing from a spreadsheet – CSV/TSV

Todo’s before import

Work from a copy of the spreadsheet

Column Headings become attributes

Ensure they are what you want

Speling?

Order doesn’t matter

“Requirements” = Object Text

Save as a .csv

Page 14: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

14

Use Existing Attributes or Create New

When importing, you can create new attributes based on the

data

DOORS csv/tsv import will guess the data type

– The data type can be changed on-the-fly during import

– Ensure data is respective of the data type desired.

• !! The importer doesn’t like it when this isn’t followed.

Attribute lists or enumerations

– Create the attributes before the import to ensure that the data uses

these

• !! Make sure the naming matches.

• Multi-select??

Do test imports as you go.

Page 15: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

15

Spreadsheet import - continued

Data items in a CSV or TSV file can have integer, real, date, or

string values.

Strings are typically contained within quotation marks, and can

contain commas, tabs, and line breaks. Quotation marks can

be imported if they are duplicated.

– For example, looking at the CSV file with a text editor, the string:

"This string has a comma, which is not imported and a quotation mark ""

too" is imported as:

This string has a comma which is not imported and a quotation mark "

too .

Page 16: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

16

Linked items

• If you have existing link numbers that associate to another

requirement spreadsheet.

• Import the linked attribute column – index of the associated

object.

• Link by attribute

Page 17: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

17

Linked items - continued

• Select the target module to link

to/from

• Select the link module to the link

• Select the Attribute that hold the

unique id from the target module

• Set the link direction

• Select the object set to be linked.

Page 18: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

18

What about PDF?

• No direct import from PDF

• Convert to MS Word

• Search the web for a converter – many exist

• Then Export normally from Word

Page 19: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

19

Question send to: Mark Kovich: [email protected]

Page 20: Importing with ease july 2012

© 2012 IBM Corporation

Software and Systems Engineering | Rational

20

© Copyright IBM Corporation 2008. All rights reserved. The information contained in these materials is provided for informational purposes only, and is provided AS IS without warranty of any kind, express or implied. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, these materials. Nothing contained in these materials is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software. References in these materials to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in these materials may change at any time at IBM’s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. IBM, the IBM logo, Rational, the Rational logo, and other IBM products and services are trademarks of the International Business Machines Corporation, in the United States, other countries or both. Other company, product, or service names may be trademarks or service marks of others.

Learn more at:

IBM Rational software

IBM Rational Software Delivery Platform

Process and portfolio management

Change and release management

Quality management

Architecture management

Rational trial downloads

Leading Innovation Web site

developerWorks Rational

IBM Rational TV

IBM Business Partners

IBM Rational Case Studies