The purpose of the ReqIF Comments plugin (SWExtension.ReqifRoundtripImporter) is to enable importing comments and supplier feedback on exported requirements, using the ReqIF format, back into SystemWeaver without altering the original Requirements. For more information about ReqIF, visit the ReqIF website. This article describes the workflow as well as provides an example meta model and the configuration for the extension. 


Prerequisites

Below are the prerequisites for both a successful comments workflow and for configuration.

  • The original file has been exported from SystemWeaver
  • The IDENTIFIER attributes of the file have remained intact. (ReqIF standard requirement)
  • The IDENTIFIER attributes of the file are based on AncestorHandles (ReqIF standard requirement, life time identifiers)
  • You must have the Architect role to configure the extension view.


Workflow Description

Below is a principal workflow description. First, a ReqIF file is produced from SystemWeaver . It is supposed to have additional attributes as placeholders for the types of comments that suppliers are expected to enter. This file is sent to a supplier. The supplier imports the ReqIF file in their environment, reviews the contents of the ReqIF file and enters the comments. Then the file is exported and sent back to SystemWeaver for import. 



Configuration of Extension View

Below is an example meta model to support the extension. 


Example Meta Model

Corresponding Configuration for the Plugin


<Configs>
  <Config>
    <CommentItemType>1RSYN</CommentItemType>
    <SpecificationItemType>CX04</SpecificationItemType>
    <SpecificationPartType>1ITEM</SpecificationPartType>
    <OriginalPartType>1LINK</OriginalPartType>
    <SynchronizedPartType>1SYN</SynchronizedPartType>
    <SpecificationToContentSidsToFollow>CP06;CP08;CP07</SpecificationToContentSidsToFollow>
    <MappingConfigItemTypeSid>CX03</MappingConfigItemTypeSid>
    <MappingConfigAttributeTypeSid>XMXM</MappingConfigAttributeTypeSid>  
  </Config>
</Configs>



The content of the configuration is explained below:

CommentItemType: The SID of the Item type that will hold the Specification and the comments. A Specification can be any type of Item.

SpecificationItemType: The SID of the Item type that will activate the view and the Item type that the Comment Item will be pointing to with the SpecificationPartType.

SpecificationPartType: The SID of the Part type that points from the Comment Item type to the Specification Item type.

OriginalPartType: The SID of the Part type that points from the Comment Item to the first version of an Item with a comment. This Part type exists for the sake of consistency since ReqIF does not support the concept of versions in the same way that SystemWeaver does. ReqIF works with lifetime ID:s that are meant to be stable over time, just like SystemWeaver's AncestorHandles.

SynchronizedPartType: The SID of the Part type that points from the Comment Item to an Item with a comment that is found in the Specification that the Comment import is performed on.

SpecificationToContentSidsToFollow:  A comma separated list of the part SID:s to be followed from the Specification Item type down to where the Items with comments are found.

MappingConfigItemTypeSid: The SID of the Item Type that contains the Mapping configuration.

MappingConfigAttributeSid: The SID of the Attribute Type that contains the Mapping configuration.


Setting up the mapping of ReqIF attribute types to SystemWeaver attribute types is performed in the plugin itself.


Configuration is set in Configure the explorer in the swExplorer client. When you set the configuration, you will want to check the Active box to ensure that system users can access the ReqIF Comments view in the swExplorer client.