IBM Rational Rhapsody Gateway Add On. DOORS Coupling Notes

Transcription

1 DOORS Coupling Notes

2

3 Rhapsody IBM Rational Rhapsody Gateway Add On DOORS Coupling Notes

4 License Agreement No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner. The information in this publication is subject to change without notice, and Dassault Systèmes and its affiliates assume no responsibility for any errors which may appear herein. No warranties, either expressed or implied, are made regarding Rhapsody software and its fitness for any particular purpose. Trademarks Reqtify is a registered trademark of Dassault Systèmes or its affiliates in the US and/or other countries. Rhapsody Gateway, IBM, the IBM logo, DOORS and Rhapsody are trademarks or registered trademarks of IBM Corporation. All other product or company names mentioned herein may be trademarks or registered trademarks of their respective owners. Copyright Dassault Systèmes. All rights reserved.

5 Contents Contents... 5 Introduction... 7 DOORS Analysis... 9 DOORS Versions Supported... 9 Rhapsody Gateway Elements Compared to DOORS Elements... 9 Section... 9 Macro-requirement Requirement Entity Reference Attribute Reference Attribute Link Text DOORS Collaboration Process Defining Rhapsody Gateway Requirements Importing Requirements from DOORS Selecting a DOORS module Intermediate XML File with DOORS Objects Module Tag Object Tag Attribute Tag Text Tag Picture Tag Out-link Tag In-Link Tag LinkAttribute Tag DOORS Types in Rhapsody Gateway DOORS Basic DOORS Advanced DOORS Full Hierarchy Customized Type Definition Capturing Links Capturing Reference Links Object Captured Twice DOORS Modules Samples Elevator Specs Module Elevator Specs Advanced Module Hierarchical Reqs Module

6 Contents Use of Shall for Reqs Connection Profiles Creating Profiles Using Profiles Exporting to DOORS Exporting Document to DOORS Setting DOORS Export Synchronizing the Document Navigating to DOORS Traceability and Links in DOORS Attributes Export Enumerated Attributes Export Specific and Generic Attributes Export Capturing Traceability Performed in DOORS Capturing Traceability Performed within Rhapsody Gateway Wizard to Import DOORS Modules Launching the DOORS Wizard Selection of the DOORS Module to Import Selection of a Base Type and Configuration Customization of Requirement Capture Selecting Links Additional Options Troubleshooting Changing DOORS Version Loading Progressively Modules Hierarchy DOORS Client Cannot Run DOORS Feature under Linux Missing Rhapsody Gateway Menu in DOORS Setting a DOORS Server DXL Error: Unknown Attribute Identifier Trouble

7 Introduction This technical note describes how to capture the traceability information of requirements from DOORS and how to create objects in the DOORS Database using Rhapsody Gateway. Some standard operations, such as DOORS module import, navigation or export to DOORS in the Rhapsody Gateway tool, require the DOORS tool to be installed. Refer to the Customization Guide and run the Coupling example for more information about what is described in this technical note. 7

8

9 DOORS Analysis This chapter describes how Rhapsody Gateway captures information items from DOORS and how those information items are analyzed to be used as requirements, attributes, text, and so on. This chapter covers the following topics: Getting the information items from DOORS. Configuring Rhapsody Gateway according to the Requirements definition in DOORS. Analyzing information to get the same definition in Rhapsody Gateway. DOORS Versions Supported Rhapsody Gateway supports DOORS versions from 7.x to 9.6. The DOORS 8.0 version is supported only if Patch 5 is installed. Rhapsody Gateway Elements Compared to DOORS Elements Rhapsody Gateway defines the following traceability elements. Section A section is a hierarchical file description element. The following are examples of sections: Heading levels in a Microsoft Word file Tabs in a Microsoft Excel spreadsheet UML packages, diagrams Modules, sub-modules and components of design models The tree composed by Rhapsody Gateway s sections is the same as the tree composed by the DOORS Object Headings with its hierarchy defined by its levels. 9

10 DOORS Analysis Macro-requirement A macro-requirement is a super-requirement that includes requirements and passes its properties onto those requirements. Any new element attached to a macro-requirement (attribute, text, or link other than coverage link) is also attached to the requirements and derived requirements contained within the macro-requirement. If the macro-requirement is directly referenced by a forward element, all of the requirements that it contains are considered as referenced by this element. DOORS does not directly include this concept. Instead, DOORS includes a hierarchy of objects, which can be used to decompose a requirement (a DOORS object defined as a requirement). There is no direct relationship between DOORS and Rhapsody Gateway models, but at the User level both solutions support requirements hierarchies. Requirement A requirement expresses either a need or constraints (technical constraints, costs, deadlines, and so on). The requirement is written either in natural language or as an expression which may be mathematical, geometric, computerized, and so on. DOORS includes objects that are defined as requirements, usually using dedicated DOORS attributes. Rhapsody Gateway captures these typed objects. Entity By defining an entity, the user defines an element that must cover (contain a reference to) a requirement. If a defined entity does not contain any reference, Rhapsody Gateway will display a warning message. This is quite an advanced notion used only in specific cases, for example to detect a dead code. An entity cannot be referenced itself. This notion does not directly exist in DOORS. However, entities can be compared to DOORS objects for which a DXL rule has been defined to verify that there is at least one out-link attached to the object. Reference A reference is the information indicating the coverage (implementation or verification) of a requirement. A reference points to a macro-requirement, requirement, or derived requirement. In Rhapsody Gateway, the reference can be defined either in a bottom-up direction, where the lower-level element covers the higher-level element, or in a top-down direction, where the higher-level element is covered by the lower-level element. 10

11 DOORS Analysis The references are the equivalent of DOORS in-links and out-links when these links are used to express requirements coverage. Attribute Attributes complete the requirement. The following are examples of attributes: Type of check test, observation, and so on. Category functional, operational Criticality low, high, and so on. Flexibility low, high Maturity source, analyzed, approved, and so on. Rhapsody Gateway allows you to define attributes to be analyzed in the project files and filters the display in accordance with these attributes. Rhapsody Gateway attributes are equivalent to DOORS attributes. Reference Attribute A reference attribute is added to a reference to define the type of coverage, such as partial coverage or provisional coverage. Rhapsody Gateway reference attributes are equivalent to DOORS Link attributes applied to coverage links. Link A link is reference information that does not concern coverage. The following are examples of links: Supported by Issued by Checked by Valid under Allocated to Result of Links are equivalent to DOORS in-links and out-links when these DOORS links have meanings other than requirements traceability. 11

12 DOORS Analysis Text Text is the wording of a traceability element. Rhapsody Gateway attaches the text to the element (section, requirement) detected immediately above it. Rhapsody Gateway text is equivalent to DOORS Object text. DOORS Collaboration Process Defining Rhapsody Gateway Requirements DOORS manages objects, but these elements are not exactly requirements. Some objects are considered to be requirements because of the addition of dedicated information. For example, an attribute like Requirement = True is seen as a requirement. This customization of DOORS objects has to be specified in Rhapsody Gateway in order to allow the capture of objects as requirements. See below for an example in a DOORS module: Importing Requirements from DOORS High level requirements can be captured from DOORS. Rhapsody Gateway can capture the following elements in a DOORS module: requirement IDs requirement texts attributes reference attributes sections 12

13 DOORS Analysis Define a Rhapsody Gateway project to import DOORS requirements, as shown in the following figure. Selecting a DOORS module The DOORS module to be analyzed is selected during the Project Configuration phase in Rhapsody Gateway, as follows: 1. In the Project Editor, insert a document then select a type of analysis based on DOORS. 2. Click File or Directory, then Browse. Rhapsody Gateway displays a selection window. 3. Provide a valid login information for DOORS then hit the [Enter] key or click the button. 4. Rhapsody Gateway displays a view of the DOORS database, allowing the selection of the formal module to be imported. Select the DOORS module. 13

14 DOORS Analysis 5. You can also specify a Profile, the Baseline you want to extract and the Server if it is not the default one. To specify a distant server, fill the field with <PortNumber>@<Machine>. See the Connection Profiles chapter to know how to create a profile. 6. Validate the dialog box contents by clicking OK. Click OK or Apply in the Rhapsody Gateway project editor to run the analysis. The requirements contained in the selected module are imported and displayed in the Rhapsody Gateway project workspace. The attributes are displayed underneath the requirements. Specific parameters of a DOORS based type When you select a type of analysis defined to capture information from DOORS (either a default type or a customized one), a Variable drop down list allows you to access some available variables that can be used for the parameters of a selected DOORS Module. The available parameters for a DOORS based type are the following: Profile This parameter specifies the profile to use for the connection if some are defined. Server This parameter specifies the server you want to consider. The value is specified in the selection dialog box. Baseline This parameter specifies the baseline you want to extract. The value is specified in the selection dialog box. Options allows accessing to a window presenting some DOORS options when clicking in the Value field. The Options pane contains the following parameters: Capture diagrams Importing DOORS images can be time-consuming. If images are not necessary, select Capture diagrams from the Variable drop- 14

15 DOORS Analysis down list and clear the option in the Value field. Only images inserted in the DOORS text (Insert > OLE Object) or inserted in objects (Insert > Picture) are taken into account. Extract only defined attributes Importing a DOORS module that has a large number of DXL attributes can be very time consuming, as DOORS will calculate the value of these attributes before providing them to Rhapsody Gateway. This option can be used to limit the communication between DOORS and Rhapsody Gateway, by extracting only the attributes defined in the type of analysis. For example, if an attribute Priority has been defined in the type, only Priority values will be extracted from DOORS. The other attributes contained in the module will not be extracted. With External links This parameter enables the conversion of external links from DOORS modules. A customized DOORS type needs to be created to capture the External links. In this XML type, you need to define a link or a reference which can capture for instance: With Table objects This parameter enables the DOORS tables to be extracted, so individual cells could be processed as requirements. Table objects are converted into XML. The XML tags look like: 15

16 DOORS Analysis With OLE RTF This option allows you to export OLE objects in RTF texts. Extract objects from This parameter specifies the subpart of the module DOORS that is to be extracted. An extraction criterion specified in the Value field enables you to extract only the desired objects. Once a parent object satisfies the requirements all the subobjects are extracted. The extraction expression follows the DXL regular expressions syntax which differs from the one used in Rhapsody Gateway (Refer to the DXL documentation). There are two different syntaxes: Extract according to DOORS Object ID: [=]RegExp Extract according to a specific attribute: Attribute=RegExp As an example, considering the following DOORS module with the ToExtract column: 16

17 DOORS Analysis If you enter ToExtract=^Yes$ regular expression in the Value box for the Extract objects from, all the branches which parent verifies this expression are extracted. The corresponding Rhapsody Gateway view is the following: Exclude objects This parameter specifies objects that must be excluded from the conversion result according to a particular DOORS attribute value. The syntax is Attribute=RegExp. Unlike the previous paremeter, the subobjects are not affected and they may be extracted even when the parent object is excluded. In consequence, the resulting hierarchy may differ from DOORS. With Rich Text This option gives you the possibility to get the rich text properties of a captured text, refer to the Traceability Elements > Text section of the User Guide documentation to know which rich text properties are supported. The text is displayed formatted in the Text area. Intermediate XML File with DOORS Objects Rhapsody Gateway creates an intermediate XML file called <document_name>.xml in the intermediate sub-directory of the project directory. The converter communicates with DOORS and builds an XML file with the obtained information. This file contains the descriptions of all the DOORS objects, along with their properties. The captured objects are provided by the type of analysis such as the definition of the expected requirements, attributes, etc. 17

18 DOORS Analysis 18

19 DOORS Analysis The intermediate file structure is always the same for all DOORS configurations. The following figure is a DOORS intermediate XML file extract. Note Attribute is an XML Tag (Attribute is the name of the XML tag and the DOORS term), name=" " is an XML attribute, value=" " is also an XML attribute (value is the name of the XML attribute) and in value="true", True is the XML value. The description of the tags used in the XML file are developed below. 19

20 DOORS Analysis Module Tag The Module tag depicts the elements of a DOORS module. It contains the set of the other tags listed below. Object Tag An Object tag must be generated for each DOORS object in the module. The object tag must define the following XML attributes: An id attribute containing the Object ID, A number attribute containing the hierarchical position in the DOORS module. An Object tag can contain another Object tag because elements can be nested. Attribute Tag An Attribute tag is generated for an attribute having a specific value. This Attribute tag defines the following XML attributes: A name attribute containing the DOORS Attribute Name, A value attribute containing the DOORS Attribute Value. For each object, all attributes are listed using the same syntax. Text Tag A Text tag is generated as soon as the Object Text contains some text. The Text tag contains the DOORS Object Text. Picture Tag A Picture tag is generated for an image located under the Object Text attribute. The Picture tag contains the binary in hexadecimal encoding. Out-link Tag An Out-link tag is generated for links going out of the current object. Out-links are extracted only when the type of analysis defines a reference capture. This Out-link tag defines the following XML attributes: A linkmodule attribute containing the name of the link module that defines the link. 20

21 DOORS Analysis A target attribute containing the target identifier Target Object which can be: Either the Element Guid or Element Identifier if the target object is exported, An identifier attribute, The DOORS Object ID when none of the above is applicable. A targetmodule attribute containing the module that defines the target object. In-Link Tag An In-link tag is generated for links coming to the current object. In-links are extracted only when the type of analysis defines an inverse reference capture, and when the source object is defined in an exported module. This In-link tag defines the following XML attributes: A linkmodule attribute containing the name of the link module that defines the link. A source attribute NameOfLinkModule containing the target identifier which can either be the Element Guid or Element Identifier. A sourcemodule attribute containing the module that defines the source object SourceObject. LinkAttribute Tag A LinkAttribute tag is generated if a DOORS link attribute type is declared and if a link attribute is defines on the link. This tag is inserted within a Out-link tag. Refer to Capturing Reference Links to have details. 21

22 DOORS Analysis DOORS Types in Rhapsody Gateway The DOORS coupling package provides few Rhapsody Gateway types for DOORS analysis: 22

23 DOORS Analysis DOORS Basic This type captures requirements from DOORS as follows: An object is a requirement if it has a DOORS attribute 'Requirement'=True The ObjectID is considered as the Requirement ID The intermediate file is in XML format. In the following module DOORS example, if you choose the DOORS ObjectID HL_Req_3 for the field Value, the extracted ObjectID in Rhapsody Gateway is HL_Req_3 and all its children i.e. HL_Req_20 and HL_Req_19. DOORS Advanced This type captures requirements from DOORS as follows: An object is a requirement if it has an attribute 'ObjectType'=Requirement The ObjectID is the value of an attribute 'ReqID' The intermediate file is in XML format. DOORS Full Hierarchy This type captures requirements from DOORS as follows : Every DOORS object is considered as requirement The whole hierarchy of the DOORS module is maintained The ObjectID is considered as the Requirement ID The Object Heading is captured as the Requirement Label when it is available The intermediate file is in XML format. 23

24 DOORS Analysis Customized Type Definition As DOORS manages objects and Rhapsody Gateway expects requirements, it is necessary to specify how objects can be captured as requirements in the XML file. This capture can be performed using the definition of Types of Analysis in a customized type. You can duplicate the provided type then customize it. Refer to the Customization Guide to learn more about this point. Note You can use the helpful information found in the DOORS example. This example contains several customized cases. With the DOORS type selected, fill in the following fields: Name Enter a name for the type, for example SRS DOORS Display Use this field to display a different name in the main window Convert tool Select DOORS XML Edit tool Select DOORS Extension Leave blank Comment Add comments about the type definition in this text area Each element of the type (Requirement, Attribute) has to be defined using the XML syntax allowing you to capture the relevant information in the intermediate file. 24

25 DOORS Analysis Refer to the Customization Guide for further information about the different fields. Note Using the Identifier format for high level requirements capture causes the link synchronization to fail when lower level requirements are exported to DOORS. Indeed, export to DOORS feature can no longer find the corresponding DOORS Objects once its identifier was altered by the identifier format. 25

26 DOORS Analysis Capturing Links In the provided DOORS types, the links are captured using the value "refers to" for the "linkmodule" Attribute. Frequently in DOORS module, link modules are named "DOORS link". To capture the DOORS links with specific name in Rhapsody Gateway, you need to use a customized DOORS type. If you are using a provided DOORS type, duplicate this type, otherwise modify the current type. To capture a specific link module, follow these steps: 1. In the customized type, create a new reference or modify an existing one. 2. Select the link. In the XML area, select the linkmodule element, its value is displayed in the Value field. 26

27 DOORS Analysis 3. Change the name of the linkmodule in the Value field. Apply the changes. 4. The customized type should be applied to the DOORS module to find the link modules this time. Capturing Reference Links To capture the DOORS link attributes as Rhapsody Gateway reference attributes, you need to use a customized DOORS type. To customize the type, follow these steps: 1. In the customized type, create a new reference attribute. 2. Customize your capture XML expression. 27

28 DOORS Analysis 3. Consult the intermediate file, it should contain the linkattribute tag inserted in an out-link tag. Such as for exemple: Object Captured Twice When we are capturing a requirements hierarchy, sometimes some unwanted objects are also captured. For instance, it happens when a text object contains a title and some text such as follows: Using the DOORS Basic on this example, for the HL_Req_2, the Title is captured twice: one time as a section title and one time as a requirement. We need to find a criterion to avoid the twice capture of the requirement. In order to, we will add a condition to capture only object that are not Requirement in the Section capture. If you are using a provided DOORS type, duplicate this type, otherwise modify the current type. To create a negative condition, follow these steps: 1. In the customized type, create a new attribute in the section part. 2. Assign the name 'Requirement' to this Attribute's name and 'True' to its value. 3. Right-click the new Attribute then select Negative to apply to this element. 4. The Section XML definition looks like the following one: 28

29 DOORS Analysis 5. Launch the analysis of your project. 29

30

31 DOORS Modules Samples The following examples come from the DoorsDemo example located in the directory examples\coupling\doors, which shows how to define a XML type of analysis in order to capture DOORS requirements. Elevator Specs Module This example uses the extraction according to DOORS Object ID. In this module: An object is a requirement if it has an attribute Requirement = True The Requirement ID is the ObjectID 31

32 DOORS Modules Samples In this case the intermediate file looks like: For the requirement capture, the XML element to be defined in the type of analysis is: Elevator Specs Advanced Module This example uses the extraction according to a specific attribute. In this module: An object is a requirement if it has an attribute ObjectType = Requirement The Requirement ID is the value of an attribute ReqID 32

33 DOORS Modules Samples In this case the intermediate file looks like: For the requirement capture, the XML element to be defined in the type of analysis is: Important In such cases, the requirement ID is not the DOORS ObjectID. Therefore, it is necessary to declare the name of the DOORS attribute containing the requirement ID. This will provide Rhapsody Gateway with the information, allowing you to find the DOORS objects for navigation and link creation. In this example we consider the ReqID attribute. If you use a different attribute, you also need to change the name of the requirement element. The default name of the requirement element in the Type is Requirement.ReqID (see below). Always use the syntax Requirement.<your attribute name> 33

34 DOORS Modules Samples Hierarchical Reqs Module This example uses the extraction according to a specific attribute. In this module: An object is a requirement if it has an attribute Requirement = True The Requirement ID is the value of an attribute ReqID Requirements are Level1 objects, and some of them have Level 2 requirements underneath In fact, this case is equivalent to the previous one in terms of XML element definition. In the framework of the tutorial, this type is used to demonstrate how requirements elements can be nested. Use of Shall for Reqs This example uses the extraction according to DOORS Object ID. In this module: There is no specific attribute to define a requirement An object is a requirement if its text contains the word shall followed by the requirement ID The Requirement ID is the ID FS-REQxx between parenthesis after shall 34

35 DOORS Modules Samples In this case the intermediate file looks like: For the requirement capture, the XML element to be defined in the type of analysis is: As a reminder on regular expressions: \( and \) mean the specific character ( and ) \d means one digit ; for one or several digits, use \d+ a string between ( ) is captured as a result: Results of (FS-REQ\d) will be FS- REQ1, FS-REQ2, etc. if such IDs exist. The Customization Guide presents the syntax of regular expressions that can be helpful for Rhapsody Gateway customization. 35

36

37 Connection Profiles Connection parameters can be defined to configure the servers you often connect to. You can define few connections profiles to easily change of DOORS connection. Creating Profiles Open the Connections tab of the Options dialog box to create a profile. To create a new DOORS profile, follow these steps: 1. Select DOORS in the Profile area. 2. Click the Add new profile button. A blank profile appears. 3. Complete the fields of the profile: Name Name the profile. Server Enter the address of the server to connect to. To specify a distant server, complete the field with <PortNumber>@<Machine>. Username required Select this check-box in your login policy is to use a user login. User Enter the login of the user. This field is available if Username required is selected. Password required Select this check-box in your policy is to use a password. Password Enter the user password. This field is available if Password required is checked. DOORS Client Select the DOORS Client version. 37

38 Connection Profiles Using Profiles The created profiles can be used in the dialog box which select a DOORS module at project creation, and in the DOORS Export dialog box. See the Selecting a DOORS module and Setting DOORS Export sections to visualize profile usage. 38

39 Exporting to DOORS Rhapsody Gateway uploads lower level information into DOORS with the traceability related to DOORS requirements. This can be accomplished with or without diagrams (obviously they need to be captured before exporting). During the Export of elements to DOORS, some traceability information is automatically created into DOORS: Modules containing elements captured from interfaced tools, Link Modules containing the traceability information. Exporting Document to DOORS To export a document to DOORS, it is necessary to configure export settings. 39

40 Exporting to DOORS Setting DOORS Export Select the low-level document to export then click the Export Document to DOORS option from the Rhapsody Gateway Tools menu. The following Export configuration dialog box is displayed: In the Selection tab of this window, following standard options in the form of lists, view, or fields are available: Source list displays the current model hierarchy. Select the parts of the hierarchy that are to be uploaded. Types list displays a hierarchic ordering of element types available in the source document type. Select the types that you want to upload. (i.e. the export content depends on the Keep children of filtered elements option). Exported link types are also displayed in this area. A contextual menu is available on a link type to choose the behavior of the link after the export between: Default Selecting this option, links are created as usual in a DOORS link module corresponding to the link or reference type name 40

41 Exporting to DOORS Single module Selecting this option, links are created in the DOORS link module specified in the dialog box provided clicking this menu item. Note It is recommended to delete the exiting link modules before modifying this option. Login fields If the target view is empty, enter a valid user name and password and click to display the DOORS database. Profile box Select a DOORS profile if some were defined in the Connections tab from Rhapsody Gateway Options. Refer to the Connection Profiles chapter for more details. Server field Enter a server name if you want to export created DOORS objects to another server. To specify a distant server, fill the field using <PortNumber>@<Machine> syntax. Target view Use this view to select a location in the DOORS database. Diagram images option Use this option if you want to have the images of the document to be taken into account in the exported module to DOORS. Note It is necessary to activate the image capture in the document prior to the export. Package layout option Use this option to choose how modules will be organized after the DOORS export. Only available when exporting a Rhapsody module into DOORS. Note Single module This is the regular behavior, only one module is created. One module per package Select this value if you want to split the original document into several DOORS modules. Consequently a project is selected instead of a module and one module is created for each package inside the project. One folder and module per package Select this value if you want to split the original document into several DOORS modules. Consequently a project is selected instead of a module and one folder module is created for each package inside the project to reflect the package structure of the model. One module per package and One folder module per package are only available if a Rhapsody model has been selected to be exported to DOORS. In the case of a Word or other document type to be exported to DOORS, this option is not available. 41

42 Exporting to DOORS New module field Enter a module name. The default name will be the name of the document defined in the Rhapsody Gateway project editor for the uploaded document. Prefix field Enter a prefix if you want the created DOORS objects to have a particular prefix. In the Options tab, advanced options are available, as shown below: Heading for requirements Use this option if you do not want to affect the DOORS objects heading of the exported requirements. Remove original heading numbers Use this option if you want to remove the numbering of the original document. Create views for exported modules Use this option to create a DOORS View which displays the exported attributes. This view is accessible from View > Manage View. It works only if DOORS runs in GUI mode. No attribute prefix Use this option if you want to import tags from Rhapsody into DOORS without the Tag prefix. Export link attributes Use this option if you want to export reference attributes into DOORS. Keep children of filtered elements Use this option if you want to export children objects of previously filtered elements (i.e. in the Types filter of the Selection tab). Do not maintain elements location This option is available when a model supporting the GUID identification is exported. Use this option if you want to launch successive exports without taking into account the parent-children relationship of the elements and without maintaining the elements position. 42

43 Exporting to DOORS New elements at the top of the module This option is available when Do not maintain elements location is selected. If this option is selected, the new elements created during the export are always created at the top of the module even if they are children or siblings of already exported objects. Remove in-links automatically Use this option to automatically remove inlinks before deleting exported elements linked to other elements. A warning message is displayed. Use cache Use this option if you want to store the conversion results of an exported module likely to be used again. As long as the module remains unchanged, the cache is re-used to spare the reloading of the module. Note The Use cache option can also be used to get a preview of the export, which allows the user to save time in case of further export. Note When the export is completed, the configuration is saved and it will be displayed by default in the export dialog box when reopened. Contextual Menu The target area of the Export window contains a contextual menu. Database View Use this option to display the tree of the target view centers on database point of view. Project View Use this option to display the tree of the target view centers on project point of view. Delete Use this option to delete a project when exporting to DOORS. Create Folder Use this option to create a folder when exporting to DOORS. Create Project Use this option to create a project when exporting to DOORS. Rename Use this option to rename a project or a folder when exporting to DOORS. 43

44 Exporting to DOORS Synchronizing the Document Follow these steps to perform the export: 1. Make sure everything is configured in the Export dialog box. 2. Click Export to begin the synchronization. Rhapsody Gateway communicates with DOORS in order to check what needs to be updated. An information window appears. If it is the first upload, you will have all the imported document elements presented as New elements. 3. Click Export to launch the upload of the information into the DOORS database. Use the Cancel option to close the window without any action in DOORS. Navigating to DOORS Once a document has been exported to DOORS, the feature Navigate to DOORS is available. To navigate to the documents or projects exported to DOORS, from Rhapsody Gateway select an exported element then right-click Navigate to DOORS. Traceability and Links in DOORS Rhapsody Gateway defines several ways to capture traceability information. One method uses References and Links in the type definition (see the Customization Guide and the User Guide). The traceability managed by Rhapsody Gateway is uploaded into DOORS by creating link modules. One link module is created in DOORS for each kind of Reference defined in Rhapsody Gateway for the type applied to the uploaded document. Rhapsody Gateway creates the following attributes for the imported DOORS module visible from the Columns and Attributes window: Element Guid (if the type manages Guid) Element Identifier Element Label Element Type 44

45 Exporting to DOORS These attributes are not supposed to be managed by the user; they are used by Rhapsody Gateway to manage objects. The text elements captured by Rhapsody Gateway are uploaded into DOORS as Object text and diagrams are also inserted as Object text. Important note The low level (uploaded) document is considered the master for low level information. A change in the DOORS Object text uploaded as text of a low level element will be erased by the next reload action and replaced by the new text element. The best practice is to make the modification in the tool used at low level, not in DOORS. Note User defined attributes can be added in this created DOORS module. Additional links can originate from or lead to this module as well and Rhapsody Gateway will not modify them. 45

46 Exporting to DOORS Rhapsody Gateway does not create empty modules, for instance, a user could have defined a reference element Implements in his type, but no Implements information is detected. In this case, the link module Implements will not be created (see the Capturing Links section). Note Links to external requirements in Rhapsody Gateway, are imported in DOORS as external links. Attributes Export All the Rhapsody Gateway attributes are created as DOORS attributes for the imported module. For each new attribute a new column is created. Enumerated Attributes Export Like other attributes, when enumerated values are declared in the Rhapsody Gateway attribute type, an enumerated attribute type are be created in DOORS. See Defining Attributes section in the Customization Guide to create these kind of attributes. Multi-values attributes from Rhapsody Gateway enumerated types, are also exported in DOORS. A specific column displays all the values. Do not forget to select Is Multiple check when defining the multi-values attributes. Note The export of multi-values attributes for non-enumerated types is not possible. Specific and Generic Attributes Export A generic attribute is an attribute, which captures both an attribute name label and a value identifier. Other attributes are named specific. If several specific attributes are captured from Rhapsody Gateway, only one attribute is created. This attribute is named <typename>. The behavior of a generic attribute export is different from the export of a specific attribute. Each instance of a generic attribute becomes a DOORS object attribute named <typename>:<label>. It is initialized with the value captured in the identifier field. Below is an example of a new attribute creation with typename=tag. 46

47 Exporting to DOORS Attributes are filled with the value captured for attributes by Rhapsody Gateway. Capturing Traceability Performed in DOORS If links are created inside DOORS, typically covering links (in-links), between a module and a lower-level document previously uploaded by Rhapsody Gateway, this traceability can be captured by Rhapsody Gateway if the applied type of analysis is defined to analyze these DOORS links. To capture this kind of links by the DOORS document type covered by the exported document, create an element which requires an inverse reference such as follows: 47

48 Exporting to DOORS Capturing Traceability Performed within Rhapsody Gateway Rhapsody Gateway allows you to create traceability links using the graphical view. Traceability links are created in DOORS when you select Export document to DOORS from the Tools menu. 48

49 Wizard to Import DOORS Modules The wizard allows the user to configure DOORS document capture step by step in order to make customizations. The wizard shows Previous and Next buttons to navigate throughout the different configuration steps, a Cancel button to cancel the configuration and a Finish button to validate the modifications. Launching the DOORS Wizard To launch the DOORS wizard, select the DOORS Wizard option in the File menu of the project editor: A new DOORS document will be inserted in the project editor. 49

50 Wizard to Import DOORS Modules This wizard can also be invoked on an existing DOORS document. In the project editor, select a DOORS document, right click and select the DOORS Wizard option in the contextual menu: Selection of the DOORS Module to Import Rhapsody Gateway displays the hierarchy of the DOORS database, allowing the selection of the module to be imported. To select the DOORS module to import: 1. Provide the DOORS login/password then click the button. 2. Select the DOORS module in the hierarchy of the DOORS database, as shown below: 50

51 Wizard to Import DOORS Modules 3. You can specify the Baseline you want to extract and the Server if it is not the default one. To specify a distant server, fill the field with <PortNumber>@<Machine>. 4. Click Next. The requirements contained in the selected module are imported and displayed in the Rhapsody Gateway project workspace. 51

52 Wizard to Import DOORS Modules Selection of a Base Type and Configuration The following Type Customization window is displayed: In the Type Customization window, fill in the following field to customize your DOORS type: Name enter the new document name. Select a DOORS Type in the drop down list, select the DOORS type and check the Type configuration option you want to apply: Use selected type to use the selected DOORS type directly. As a result, you will not be able to customize the Requirement Capture and Links Capture. The existing type configuration will be used. Configure selected type to update the selected DOORS type. In this case, requirement, attribute and reference types are destroyed and created from scratch by the Wizard. Create new type to use the DOORS type as a template for the creation of a new type. Note Types from library such as Doors Advanced or Doors Basic cannot be modified. In this case, the Configure selected type option is not available and the user has to select the Create new type option instead. Note New Type name Enter the new type name when creating a new type. There are two kinds of DOORS types configuration: 52

53 Wizard to Import DOORS Modules Doors Basic type uses the Object ID as identifier of requirement. This is the common configuration for DOORS capture. Doors Advanced type uses a particular attribute named ReqID as the identifier of requirement. You can use or customize this one when you do not want to use the DOORS Object ID as requirement identifier. Customization of Requirement Capture The following customization window displays the list of DOORS attributes to capture and allows the user to define the condition to capture a requirement: In the drop-down list of the Kind column, select the type to apply to the DOORS attributes, as follows: Ident: use the attribute as Requirement identifier. Label: use the attribute as Requirement label. Text: use the attribute as Requirement text. Present: check that attribute is present on the DOORS object being captured, a Condition can be provided to test the value of the attribute (regular expression). Absent: check that attribute with optional Condition is not defined on the DOORS object being captured. Attribute: create an Attribute type to capture the DOORS attribute in Rhapsody Gateway. Ignore: keep this choice when the DOORS attribute is not necessary for Rhapsody Gateway. 53

54 Wizard to Import DOORS Modules A new attribute type is created for each DOORS attribute having the Kind attribute. The present and absent conditions of the Requirement type is also applied to the attribute type created. For instance, an attribute type of the default DOORS Basic has the XML condition <Attribute name= Requirement value= True />. Three modes for conditions on attributes are available. The default mode is Expression for regular-expressions matching and is still interpreting special characters. The other modes are Contains string and Exact string. They automatically create appropriate regular-expressions in the generated DOORS XML type. Selecting Links The following customization window displays the list of the links modules containing the out-links of the selected module: A new cover link (also known as Reference) type is created for each DOORS link module selected. 54

55 Wizard to Import DOORS Modules Additional Options This following customization window displays conversion and capture settings to configure the DOORS documents: You can select one of the following options: Capture diagrams to capture pictures that are in-lined in the DOORS Object Text. Extract only defined attributes to save conversion time in order not to convert unused attributes by the DOORS type. 55

56

57 Troubleshooting The tasks in this section can help you solve the most common problems with DOORS usage. Changing DOORS Version If a user wants to change the version of the DOORS client, first he has to launch the other DOORS client version before launching the analysis. Loading Progressively Modules Hierarchy If a user wants to load DOORS modules as it goes along the modules hierarchy, he has to add the following lines in the.ini: [DOORS] ProgressiveHierarchyLoading=1 The DOORS client should also be launched. DOORS Client Cannot Run The user may encounter troubles during his conversion or navigation to DOORS modules. A message like the following one appears: Cannot run DOORS client! The possible cases for this trouble can be: the environment variable DOORS_SCRIPT does not exist and the following key is lacking in the register HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\{value}\LocalServ er32 where {value} is the default value located under: HKEY_CLASSES_ROOT\DOORS.Application\CLSID the environment variable DOORS_SCRIPT does not point to a DOORS client. 57

58 Troubleshooting To solve this problem ask your administrator to re-launch the DOORS client to update the register. DOORS Feature under Linux The environment variable DOORS_SCRIPT should exist and should point to the DOORS client executable to let activate the DOORS feature under Linux. Missing Rhapsody Gateway Menu in DOORS If the Rhapsody Gateway menu is not available from DOORS, an installation problem must have occurred. This problem can appear if DOORS is installed after Rhapsody Gateway. To solve the problem, there are two solutions: uninstall Rhapsody Gateway, and then install again Rhapsody Gateway manually set the following "String value" under the "Config" key in the registry: HKEY_LOCAL_MACHINE\SOFTWARE\Telelogic\DOORS\<DOORS Version>\Config => AddIns = <Your Rhapsody Directory>\Gateway\config\misc\DOORS\rg; Setting a DOORS Server The DOORS default server is stored in the registry at the following location: HKEY_LOCAL_MACHINE\SOFTWARE\Telelogic\DOORS\<DOORS Version>\Config => Data An easy way to change the DOORS Server is to set the DOORS_SERVER environment variable to define a new server path. Use the Rhapsody Gateway Options window to set the DOORS_SERVER variable. The server defined using this variable will be used instead of the default one. If the above proposal does not solve the problem or if you need help for other problems do not hesitate to contact the Support Team. 58

59 Troubleshooting DXL Error: Unknown Attribute This error can arise if a particular syntax for Requirement types name is used. In this case, the message DXL halted with run-time error is displayed, followed by a DXL Interaction dialog box. The suffix of the Requirement type name is used by Export to DOORS as the 'identifier attribute' to detect requirements. Consequently the syntax Prefix.Suffix for Requirement types name shall not be used if the Suffix does not aim at pointing out an attribute name. For more information, please refer to the 'Elevator Specs Advanced Module' example of this Coupling note. Identifier Trouble Using a multi-type document causes an identifier trouble due to a duplicate section identifiers. To solve the problem the flag SectionXIdentifyChildren=1 should be added in the types file. See Customizing Multi-Types from the Customization Guide. 59