reqview - import requirements document · html import from ms word 1. open document in ms word,...

19
[email protected] ReqView Import of Requirements Document version 2.0

Upload: others

Post on 12-Jul-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

[email protected]

ReqViewImport of Requirements Document

version 2.0

Page 2: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

Overview of Import Methods

HTML CSV ReqIF *

Tree hierarchy Yeshierarchy given by paragraph styles

Yeshierarchy given by

level attribute

Yes

Rich text format Yes No Yes

Images Yes No Yes

ID No Yes Yes

Custom attributes No Yes Yes

Traceability No No Planned

Import from MS Word MS Excel, DOORS DOORS

ReqView - Import of Requirements Document

© Eccam 2

* ReqIF is OMG standard for requirements exchange

Page 3: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

HTML Import from MS Word1. Open document in MS Word, remove title page,

table of content and other unwanted sections

2. Check that the document is correctly structured

– Headings become sections and paragraphs requirements

– Rich text (bold, italic, underlined, text color, sub/superscript) is preserved

– Tables, bulleted and numbered lists are appended to the preceding requirement

– Images are added as attachments in separate requirements

ReqView - Import of Requirements Document

© Eccam 3

Page 4: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

HTML Import from MS

Word

ReqView - Import of Requirements Document

© Eccam 4

Check document structure

Check document formatting

Page 5: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

HTML Import from MS Word3. Save Word document

ReqView - Import of Requirements Document

© Eccam 5

Choose Web page, Filtered

file type

CheckUse PNG as a

graphics format

Set document Encoding to

Unicode (UTF-8)

Page 6: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

HTML Import from MS Word4. Open ReqView and import HTML from File

menu Import HTML

ReqView - Import of Requirements Document

© Eccam 6

Choose HTML file exported

from MS Word

Choose all image

attachments

Page 7: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

HTML Import from MS Word

ReqView - Import of Requirements Document

© Eccam 7

Structure is preserved

Requirements gets unique ID

Rich text formatting is preserved

Read More >>

Page 8: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

CSV Import from Excel1. Open Excel file and organize it to at least

following columns: ID, Section, Description, Level

ReqView - Import of Requirements Document

© Eccam 8

Unique ID

Section name

Text requirement description

Level number

Page 9: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

CSV Import from Excel

2. Save Excel file as CSV (Comma delimited) (*.csv)

– Use UTF-8 encoding (Tools > Web Options > Encoding)

3. In ReqView choose File > Import CSV to import requirements Before, After or as Children of the selected object.

ReqView - Import of Requirements Document

© Eccam 9

Page 10: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

CSV Import from DOORS1. Open DOORS module and create a view with at

least Absolute Number, Object Heading, Object Textand Object Levelattributes

ReqView - Import of Requirements Document

© Eccam 10

Page 11: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

CSV Import from DOORS2. In File / Export / Spreadsheet menu open Export

Spreadsheet dialog

ReqView - Import of Requirements Document

© Eccam 11

Check to export attribute names

Choose comma as data separator

Choose UTF-8 encoding

Page 12: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

CSV Import from DOORS3. Create configuration file mapping DOORS

attributes to ReqView attributes

ReqView - Import of Requirements Document

© Eccam 12

{"name": "Test document","mapping" : [

{ "attribute": "id", "external": "Absolute Number"},{ "attribute": "heading", "external": "Object Heading"},{ "attribute": "text", "external": "Object Text"},{ "attribute": "level", "external": "Object Level"}

]}

Page 13: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

CSV Import from DOORS4. Convert CSV to ReqView by

Synchronizer specifying

– Given input CSV file

– Requested output ReqView file

– Prepared configuration file with attribute mapping

– Optional password

ReqView - Import of Requirements Document

© Eccam 13

synchronizer --import -f csv-i UserNeeds.csv -o UserNeeds.reqw-c UserNeeds.cfg -p password

Download Synchronizer

Page 14: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

ReqIF Import from DOORS1) Define custom attributes for export

– Discussion – text attribute for comments

– History – text attribute summarizing changes

– Status – enumeration of allowed status values,e.g. draft, accepted, rejected

ReqView - Import of Requirements Document

© Eccam 14

Page 15: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

ReqIF Import from DOORS2. Create ReqIF definition and export ReqIF file

ReqView - Import of Requirements Document

© Eccam 15

DOORS Next Gen

Page 16: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

ReqIF Import from DOORS3. Create configuration file mapping DOORS

attributes to ReqView attributes

ReqView - Import of Requirements Document

© Eccam 16

{"mapping" : [{ "attribute": "id", "external": "ReqIF.ForeignID"},{ "attribute": "heading", "external": "ReqIF.ChapterName"},{ "attribute": "text", "external": "ReqIF.Text"},{ "attribute": "discussion", "external": "ReqView_Discussion"},{ "attribute": "history", "external": "ReqView_History"},{ "attribute": "status", "external": "ReqView_Status"}

]}

Note: Names of ReqIF external names depends on DOORS version.

Page 17: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

ReqIF Import from DOORS4. Convert ReqIF to ReqView by

Synchronizer specifying

– Given input ReqIF file

– Requested output ReqView file

– Prepared configuration file with attribute mapping

– Optional password

ReqView - Import of Requirements Document

© Eccam 17

synchronizer --import -f reqif-i UserNeeds.xml -o UserNeeds.reqw-c UserNeeds.cfg -p password

Page 18: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

ReqIF Import from DOORS

ReqView - Import of Requirements Document

© Eccam 18

DOORS Next Gen ReqView Desktop

Read More >>

Page 19: ReqView - Import Requirements Document · HTML Import from MS Word 1. Open document in MS Word, remove title page, table of content and other unwanted sections 2. Check that the document

ReqView References• ReqView Homepage

https://www.reqview.com

• ReqView Desktop Online https://www.reqview.com/apps/desktop/ReqViewDesktop.html

• ReqView Desktop at Chrome Store https://chrome.google.com/webstore/detail/reqview-desktop/cmbnhmeabefpflildnahpbghcejkblin

• Support Site - online help, knowledge base and discussion forumhttp://support.reqview.com/solution/categories

ReqView - Import of Requirements Document

© Eccam 19