DOORS® Connector User Guide

DOORS Connector User Guide
DOORS
Connector
User Guide
®
ii
DOORS Connector User Guide
Copyright © 2009-2015 Vitech Corporation. All rights reserved.
No part of this document may be reproduced in any form, including, but not limited to, photocopying,
translating into another language, or storage in a data retrieval system, without prior written consent of
Vitech Corporation.
Restricted Rights Legend
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)
(1) (ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7013.
Vitech Corporation
2270 Kraft Drive, Suite 1600
Blacksburg, Virginia 24060
540.951.3322 FAX: 540.951.8222
Customer Support: [email protected]
www.vitechcorp.com
is a trademark of Vitech Corporation and refers to all products in the CORE software
product family.
Other product names mentioned herein are used for identification purposes only, and may be trademarks
of their respective companies.
Publication Date: June 2015
ii
DOORS Connector User Guide
TABLE OF CONTENTS
PREFACE ..................................................................................................................................................... 1
TRANSFERRING REQUIREMENTS FROM DOORS INTO CORE............................................................. 2
Setting up DOORS for Exporting Requirements to CORE ....................................................................... 2
Viewing Requirements in DOORS ......................................................................................................... 2
Exporting Requirements from DOORS .................................................................................................. 3
Importing Requirement information into CORE ........................................................................................ 4
CORE Schema Modification .................................................................................................................. 4
Setting up the CORE Project for DOORS Requirement Import............................................................. 6
Importing the DOORS Information ......................................................................................................... 7
TRANSFERRING REQUIREMENTS FROM CORE INTO DOORS........................................................... 13
Setting up CORE to Export Requirements ............................................................................................. 13
Packaging information in CORE for transfer to DOORS ..................................................................... 13
Exporting Requirements from CORE using Paragraph Number ......................................................... 14
Setting up DOORS to import requirements from CORE ........................................................................ 15
Adding attributes to the DOORS database .......................................................................................... 15
UPDATING REQUIREMENTS BETWEEN DOORS AND CORE .............................................................. 19
iii
DOORS Connector User Guide
TABLE OF FIGURES
Figure 1 - Typical DOORS Database Structure and View ............................................................................ 2
Figure 2 - DOORS Database View for Import into CORE ............................................................................ 3
Figure 3 - Exporting from DOORS ................................................................................................................ 3
Figure 4 - DOORS CSV Export Selections ................................................................................................... 4
Figure 5 - Importing the DOORS Connector Schema Modifications into CORE .......................................... 5
Figure 6 - Creating a Package for Containing DOORS Requirements ......................................................... 6
Figure 7 - Import from DOORS command in CORE ..................................................................................... 7
Figure 8 - Selecting the DOORS CSV file for Import into CORE .................................................................. 7
Figure 9 - Selecting the Package in CORE, Step 1 of 4 ............................................................................... 8
Figure 10 - Selecting Requirement Format in CSV, Step 2 of 4 ................................................................... 8
Figure 11 - Table Definition, Step 3 of 4 ....................................................................................................... 9
Figure 12 - Warning from CORE ................................................................................................................... 9
Figure 13 - DOORS Import Wizard, Step 4 of 4.......................................................................................... 10
Figure 14 - Requirements in CORE with Alphabetic Sort Block ................................................................. 11
Figure 15 - Display of Imported DOORS Requirements in CORE .............................................................. 12
Figure 16 - Packaging requirements in CORE for transfer ......................................................................... 13
Figure 17 - Exporting to DOORS from CORE............................................................................................. 14
Figure 18 - Adding Attributes in DOORS .................................................................................................... 16
Figure 19 - Importing the csv File into DOORS .......................................................................................... 17
Figure 20 - CORE Requirement Information in DOORS following import .................................................. 18
Figure 21 - DOORS Standard View of Requirement set ............................................................................ 18
iv
DOORS Connector User Guide
CUSTOMER RESOURCE OPTIONS
Supporting users throughout their entire journey of learning MBSE is central to Vitech’s mission. For users
looking for additional resources outside of this document, please refer to the links below. Alternatively, all
links may be found at www.vitechcorp.com/resources.
Webinars
Screencasts
A Primer for Model-Based
Systems Engineering
Webinar archive with over 40
hours of premium industry and
tool-specific content.
Short videos to guide users
through installation and usage of
Vitech software.
Our free eBook and our most
popular resource for new and
experienced practitioners alike.
Help Files
Technical Papers
Searchable online access to
Vitech software help files.
Library of technical and white
papers for download, authored
by Vitech systems engineers.
MySupport
Knowledge Base, Exclusive
Webinars and Screencasts, Chat
Support, Documents, Download
Archive, etc.
Our team has also created resources libraries customized for your experience level:
All Resources
Advanced
Beginner
IT / Sys Admin
Intermediate
Student
v
DOORS Connector User Guide
THIS PAGE INTENTIONALLY BLANK
vi
DOORS Connector User Guide
PREFACE
This guide describes the steps to be taken to extract requirement information from IBM® Rational® DOORS®
and import this requirement information into CORE™.
This guide provides step-by-step processes for:
1.
Extracting requirement information from DOORS in a format to allow importing into CORE.
2.
Importing requirement information into the CORE toolset.
Using the steps and guidance provided in this document, CORE users are able to utilize both DOORS and
CORE to support system design and development. Three situations are described in the second half of this
guide:
1.
Using DOORS as the initial requirement source. In this situation, the initial requirements for a
project have been provided in DOORS. The development team must import these requirements
into CORE and do the system design in CORE.
2.
Using CORE for system design and exporting the requirements to DOORS for the use by other
organizations and teams. In this situation, the systems engineering team conducts system analysis
in CORE. When the team is ready to publish system requirements, a baseline is set in CORE and
the requirements are exported to DOORS.
3.
Transferring information between DOORS and CORE in an ongoing system design and
development effort. In this situation, different parts of the systems engineering team conducts
system analysis in CORE, but a DOORS requirement database will also be utilized for
communicating system design information and for informing the overall design repository in CORE.
In this scenario, the information in DOORS and CORE is passed back and forth between the
products.
After reviewing this guide, contact Vitech Customer Support if you need additional assistance. Our Support
Team is available Monday-Friday 9am-6pm Eastern with extended hours available upon appointment.
For installation or general product support
[email protected]
+1 540.951.3999
To submit a license request
[email protected]
For information on systems engineering and CORE training
Visit our website at www.vitechcorp.com
or contact your Account Executive
+1 540.951.3322
[email protected]
1
DOORS Connector User Guide
TRANSFERRING REQUIREMENTS FROM DOORS INTO CORE
This section discusses the process of taking requirements existing in DOORS and exporting these
requirements to CORE for the first time. The section discusses how to set up the information in DOORS for
export, how to set up CORE for first time import of the requirement information, and how to import the
requirement information into CORE.
Setting up DOORS for Exporting Requirements to CORE
The ability to move information between DOORS and CORE depends on understanding the relationship
between the elements and attributes in DOORS and CORE. Requirements are displayed and viewed
differently in the two toolsets. Therefore, how the information is displayed in DOORS and the relationship
of that information to CORE attributes is crucial to manipulating the data in the two toolsets. We will look at
how to view requirements in DOORS and how to export data from DOORS in a format and construct that
allow for easy import into CORE.
Viewing Requirements in DOORS
Figure 1 provides an example of the DOORS requirement database as it is normally displayed. This view
facilitates viewing the DOORS database in a format similar to what is provided by a DOORS-generated
requirement document.
Figure 1 - Typical DOORS Database Structure and View
2
DOORS Connector User Guide
Exporting Requirements from DOORS
Prior to exporting the requirements for importing into CORE, the DOORS user should modify the view of
the DOORS repository to the format shown in Figure 2. For the initial import into the CORE design repository
the information required from the DOORS database is: ID; Object Heading, Object Number, Object Text,
and Last Modified On date.
Figure 2 - DOORS Database View for Import into CORE
The export of information from DOORS to a CSV file type is accomplished in DOORS by selecting File >
Export > Spreadsheet… as shown in Figure 3 (below).
Figure 3 - Exporting from DOORS
3
DOORS Connector User Guide
In DOORS, make the selections for the DOORS export as shown in the following figure (Figure 4).
Figure 4 - DOORS CSV Export Selections
Importing Requirement information into CORE
Before DOORS requirement information can be imported into CORE, parts of the CORE schema must be
modified to accommodate crucial attributes used in DOORS for requirement management. Not only is this
information and schema modification needed on initial import of the DOORS requirement data, these
attributes will be updated if / when the requirement set is moved between the two toolsets whenever an
ongoing exchange is used in a design and development project.
CORE Schema Modification
Before importing the requirement information from DOORS into CORE, the CORE schema has to be
modified to accommodate the data. In order to accomplish this the user should import the schema
modifications using the “DOORSConnectorSchema.xml” file which is located in the
CORE 9/Data/Extensions folder. The following process should be used to do this:
1. In the desired project, select File > Import > CORE Data File…
2. Navigate to the Data/Extensions folder and select the file named “DOORSConnectorSchema.xml”
and click the OPEN button.
4
DOORS Connector User Guide
3. Walk through the XML Import Wizard and Import the DOORS Connector Schema into your existing
project. The screen shots shown in the following diagram (Figure 5) below walk through this
process.
Figure 5 - Importing the DOORS Connector Schema Modifications into CORE
When importing information into CORE, the DOORS attributes of ID, Object Heading, Object Number,
Object Text, and Last Modified On fields will be transferred into CORE. This schema change adds a number
of attributes to certain classes in CORE to hold the DOORS information. The attributes added to CORE
include: DOORS Object ID, DOORS Object Heading, DOORS Object Number, and DOORS Last Modified
to the COMPONENT, FUNCTION, INTERFACE, LINK, and REQUIREMENT classes in CORE. Table 1
provides a cross-reference between DOORS and CORE attributes once the schema modification is
completed.
Table 1 Relationship between DOORS and CORE Attributes
Original
DOORS
Attribute…
…becomes the listed
CORE Attribute
NOTE
Object ID
DOORS Object ID
This attribute is added to the CORE schema when the
“DOORSConnectorSchema” is imported into a project.
Object Heading
DOORS Object Heading
This attribute created in CORE by aliasing the existing
Paragraph
Title
attribute
when
the
“DOORSConnectorSchema” is imported into a project.
Object Number
DOORS Object Number
This attribute is added to the CORE schema when the
“DOORSConnectorSchema” is imported into a project.
5
DOORS Connector User Guide
Object Text
Description
The Object Text information from DOORS is placed in
the existing Description attribute in CORE.
Last Modified
DOORS Last Modified
This attribute is added to the CORE schema when the
“DOORSConnectorSchema” is imported into a project.
Setting up the CORE Project for DOORS Requirement Import
Now that the CORE project schema is set to receive requirements from DOORS, the user needs to create
a package in CORE which will be the container for the requirements coming from DOORS. This is done by
creating an element under the PACKAGES item in the project explorer tree view. Additional packages
should be created each time so that each DOORS document is contained inside of a package for easier
selection and viewing.
Figure 6 - Creating a Package for Containing DOORS Requirements
6
DOORS Connector User Guide
Importing the DOORS Information
The DOORS CSV file created previously can now be imported into CORE. In CORE, select File > Import >
from DOORS…
Figure 7 - Import from DOORS command in CORE
CORE will now step through a series of import options for manipulating the information from the DOORS
.csv file.
First, navigate to and select the CSV file created from DOORS.
Figure 8 - Selecting the DOORS CSV file for Import into CORE
Next, select the package created for containing the requirements.
7
DOORS Connector User Guide
Figure 9 - Selecting the Package in CORE, Step 1 of 4
The next option allows the user to specify if the requirements coming from DOORS will reside in the
REQUIREMENT class or if there is sufficient information available for the requirements to reside in multiple
classes in CORE. In following the STRATA™ Methodology, requirements could be located throughout the
model. For instance, they can be found in the leaf-level COMPONENT, FUNCTION, INTERFACE, and/or
LINK classes as well as the REQUIREMENT class. This allows a richness in design while not duplicating
information. On initial import of requirements from DOORS the presumption is that the first option
(Requirements only) will be selected.
Figure 10 - Selecting Requirement Format in CSV, Step 2 of 4
After selecting which format the requirements in the CSV file take, the user is given a chance to view and
modify the table definition for the information contained in the CSV file. The “First Row Value” column lists
the column heading that is in the file. This allows the user to check that the information is going to be
imported into the correct database location. Modifications to the table can be made and saved for future
imports.
8
DOORS Connector User Guide
Figure 11 - Table Definition, Step 3 of 4
A singular table definition is used for the initial and subsequent imports of requirements from DOORS. To
allow for renaming of the requirement element in DOORS, the table definition contains a row for the CORE
unique ID and name. CORE gives a warning message (see Figure 12) prior to proceeding to let the user
know that upon import, if CORE finds an element with the unique ID and the name does not match, the
element will be renamed to the information in the file. For initial import the name and unique ID are blank
so a new element will be created and given a default name, Requirement_###.
Figure 12 - Warning from CORE
9
DOORS Connector User Guide
After the table is reviewed and correct, the next screen shows options for processing the file and postprocessing the results.

Includes Header Row: This option allows for the first row in the CSV file to be discarded upon
import. The default is Yes.

Ignore Empty Attributes / Parameters: This option determines what to do if a column in the row is
blank. If No is selected, when CORE encounters a blank entry in the row, processing of that row
will be stopped and an error returned. If Yes is selected, a blank entry in the row will skip that
column entry and the row will continue to be processed. The default is Yes.

Clear Existing Targets / Relationships: When adding relationships and targets from a CSV file, the
user has the option to clear the relationships and targets that are currently residing in the database.
This allows for a restructuring of data outside of CORE. The default is No.

Rebuild Hierarchy based upon DOORS Object Number: In DOORS, the object number implies an
ordering and parent/child relation between requirements. This import option allows for CORE to set
the parent/child relationships based on the numbering used in DOORS. The default is Yes.
Figure 13 - DOORS Import Wizard, Step 4 of 4
When the requirements are first imported in CORE, CORE generates a unique CORE Name for each
requirement by assign a default name in the format of Requirement_###. This can be seen in the
database by selecting the “Alphabetic” Sort Block.
10
DOORS Connector User Guide
Figure 14 - Requirements in CORE with Alphabetic Sort Block
11
DOORS Connector User Guide
The requirements can be viewed in a different order by using the SORT feature at the bottom of the
Elements pane. Figure 13 shows a set of imported requirements sorted by the DOORS Object Number.
Figure 15 - Display of Imported DOORS Requirements in CORE
12
DOORS Connector User Guide
TRANSFERRING REQUIREMENTS FROM CORE INTO DOORS
This section discusses the process of taking requirements existing in CORE and exporting these
requirements to DOORS for the first time. This section discusses how to set up the information in CORE
for export, how to set up DOORS for first time import of the requirement information, and how to import the
requirement information into DOORS.
Setting up CORE to Export Requirements
As discussed in the prior section on moving requirements from DOORS into CORE, we need to understand
the relationship between the elements and attributes of the two toolsets as this is key to making the transfer
of information work.
In CORE, the first thing to do is to extend the CORE schema using the process discussed in the section
entitled CORE Schema Modification using the “DOORSConnectorSchema.xml” file. Starting by extending
the schema will preserve the ability to transfer requirements back and forth between CORE and DOORS
through the project lifecycle. This way, if any information in DOORS needs to be returned to CORE for
analysis, the CORE database is set up to facilitate this transfer.
Packaging information in CORE for transfer to DOORS
The elements of the CORE repository that need to be transferred to DOORS should be placed in one
Package in the CORE design Repository. To accomplish this complete the following steps:
a. Create a new folder with a unique name under the Package Class
b. With the folder selected in the elements pane, double click the “packages” relations selection. This
will open the relations dialog box.
c.
Navigate to the appropriate “Target Class” and/or folder in the Target Classes pane (upper lefthand corner of the dialog box); then select target(s) from the Possible Targets pane (lower lefthand corner of the dialog box) and “Add” them to the Targets window on the right hand side of the
dialog box using the Add button.
d. When all the targets have been selected, click on the OK button to establish the relations. (Notice
that all of the relations have been created to relate the Package folder to the individual entities.)
An example of Requirements packaged in CORE for export into DOORS is provided below.
Figure 16 - Packaging requirements in CORE for transfer
13
DOORS Connector User Guide
Exporting Requirements from CORE using Paragraph Number
In CORE the user can conduct an export from CORE using the File -> Export -> to DOORS menu selection.
In Step 1. Select the package where the requirements have been placed.
In Step 2. Select YES to do the export for the first time using the CORE Paragraph number.
In Step 3. Select and load the Stored Definition file entitled “DOORS (by Paragraph Number).
Save the csv file export to a location where you can retrieve it for import into DOORS once DOORS is
opened and all the modifications have been made as discussed in the next couple of sections.
Figure 17 - Exporting to DOORS from CORE
14
DOORS Connector User Guide
Setting up DOORS to import requirements from CORE
In order to capture all of the information from CORE in the DOORS database, we need to add attributes
to DOORS to accept the information.
Table 2 Setting up DOORS to import Requirements from CORE
…becomes the added
DOORS Attribute of:
DOORS Attribute Type:
doorsObjectID
Object Identifier
String
paragraphTitle
Object Heading
String
paragraphNumber
Object Number
String
Description
Object Text
Text
Element ID
CORE ID
String
Class Alias
CORE Class
String
CORE
name…
Attribute
String
Element
CORE Name
Note: this will be in the format:
“CORE Package Name, ‘:’, CORE Element Name
Based On
Based On
Text*
Refines
Refines
Text*
Specified by
Specified by
Text*
Allocated
Components
Allocated Components
Text*
* Text fields are formatted as: “CORE Package Name, ‘:’, CORE Element Name
Red Text items are added to the indicated toolset
Adding attributes to the DOORS database
Open a formal module and add the attributes to the DOORS module in the order indicated from top to
bottom from Table 2 (shown above).
Adding attributes in DOORS is accomplished by selecting Edit -> Attributes to get to the DOORS Columns
and Attribute dialog box.
Select the Attributes tab, then select the “New” button to add a new attribute to the project.
15
DOORS Connector User Guide
Figure 18 - Adding Attributes in DOORS
Once the attributes have been added, order the attributes in the same order in the csv file extracted from
CORE, this will set you up to import the data into DOORS.
16
DOORS Connector User Guide
Importing CORE requirements into DOORS
In DOORS, you can now select File -> Import -> Spreadsheet and make the appropriate selection to
import the csv file.
Figure 19 - Importing the csv File into DOORSOnce imported, the DOORS module information will
look similar to the following screen shot:
17
DOORS Connector User Guide
Figure 20 - CORE Requirement Information in DOORS following import
This information can be modified to a traditional DOORS view as shown in the following screen shot:
Figure 21 - DOORS Standard View of Requirement set
18
DOORS Connector User Guide
UPDATING REQUIREMENTS BETWEEN DOORS AND CORE
The first two sections of this guide provide the concepts and steps necessary to set up the respective tool
sets to transfer information from one toolset to another. Once each toolset (DOORS and CORE) have been
extended to accept the unique information from the other toolset, information changes in one tool can be
exported and then imported into the other tool.
The key to moving information back and forth between DOORS and CORE is understanding the unique
identifier attribute for any item in each database. In CORE, the key element in the database to index
individual items is the Element ID (aliased as CORE ID in the DOORS database). In DOORS, the key
element in the database to index individual items is the Object Identifier (aliased as doorsObjectID in the
CORE database).
For configuration control of individual entities, each database also has an attribute to identify the Last
Modified On date. In CORE, this is the modificationStamp (aliased as Last Modified, which appears at the
bottom of the Secondary property page). In DOORS, this is the Last Modified On attribute in the database.
Moving data between the two databases is managed through several generic steps:
a. selecting the information you want to transfer in the originating toolset
b. creating and selecting an export definition file from the originating toolset
c.
importing the csv file into the receiving toolset by mapping the information in the csv export into
the corresponding attributes in the receiving toolset
The engineering design team needs to consider which toolset will be the authoritative source of requirement
information; in other words, which toolset will be used to communicate the system design information for
stakeholders and suppliers. Whichever toolset becomes the authoritative source, that toolset should be
used to baseline information.
For example, if the systems engineering team is going to conduct system analysis in CORE, but DOORS
will serve as the authoritative requirement repository. In this case, the design team needs to consider that
in CORE, system design changes will be reflected in the COMPONENT, FUNCTION, INTERFACE, and/or
LINK classes as well at the REQUIREMENT class. In addition, changes to each of these CORE Classes
need to be captured and reflected at revisions in the DOORS database.
19
Vitech Corporation
2270 Kraft Drive, Suite 1600
Blacksburg, Virginia 24060
540.951.3322 FAX: 540.951.8222
Customer Support: [email protected]
www.vitechcorp.com