Data Exchange for Jama Connect – User Guide

Summary

Organizations using requirements management tools often need to exchange large sets of information with other business units or external organizations. To maintain data integrity, associated relationships and metadata about individual information items must persist across different tools during data exchange.

ReqIF (Requirements Interchange Format) is a standardized format designed to facilitate seamless data exchange between requirements management solutions.

Data Exchange for Jama Connect enables users to:

• Translate Jama Connect data into ReqIF format.
• Import ReqIF data back into Jama Connect.

Use Cases

1. Export from Jama Connect as Source (Archival)

Use Data Exchange to export requirements from Jama Connect for backup, archival, or reporting purposes.

2. Import to Jama Connect from Another Repository (Migration)

Use Data Exchange to migrate requirements data from other ReqIF-compliant tools into Jama Connect.

3. Jama Connect to Jama Connect Exchange

Supports data sharing between separate Jama Connect instances, particularly useful for:

• Organizations with isolated networks.
• Managing secure vs. non-secure requirements (e.g., ITAR compliance).

4. Begin or Continue Conversations

Facilitates ongoing round-trip exchanges of requirements between systems using standardized conversation threads.

Intended Uses

Jama Connect to ReqIF Data Exchange

Enhances collaboration with third-party tools by enabling ongoing ReqIF-based data exchanges.

Example:
An automotive components manufacturer imports customer-authored requirements from a different tool into Jama Connect. After review and updates, the requirements are exported back as ReqIF and sent to the customer. This back-and-forth process continues through the product lifecycle without redundant documentation.

Jama Connect to Jama Connect Data Exchange

Supports isolated Jama Connect environments or secure data management scenarios.

Examples:

• A government agency and its contractor exchange requirements via Data Exchange.
• A company moves data between secure and non-secure Jama Connect instances.

Migrations

Facilitates data migration from other ReqIF-compliant requirements management systems into Jama Connect.

Prerequisites

Recommended Hardware

• Multicore processor, 2 GHz or higher
• At least 4 GB of RAM
• Stable network connection

Software Requirements

• Oracle Java 8 (including JavaFX libraries)
• Operating System: Windows or macOS

Jama Connect Configuration

• Each ReqIF Spec Type Attribute imported must have a corresponding Jama Connect field.
• Data Exchange users must have read/write access to the relevant projects.

Licensing

• Obtain a valid license file from Jama Connect.
• Place the license in a folder named Util in the same directory as the .jar application.
• Required for command-line execution.

Launching Data Exchange

Graphical Method

• Double-click the .jar file.

Command Line Method

java -jar path/to/jar/DataExchange3.0.jar jama.properties

• Requires a .properties file defining execution settings.

Creating a Properties File

A .properties file allows automated, repeatable Data Exchange operations.

Example: jama.properties

# Connection Settings
jamaURL=https://<YOURDOMAIN>.jamacloud.com
username=USERNAME
password=PASSWORD

# Tool Configuration
specObjectLegacyIDConfiguration=DEFAULT
specificationLegacyIDConfiguration=DEFAULT
reverseRelationshipDirection=false
deliveryNote=true

# Import/Export Settings
exchangeType=IMPORT|EXPORT
isExchange=true
projectID=48
mappingFile=/PATH/TO/MAPPING/FILE.json
newConversationName=ConversationName

# Import
source=/PATH/TO/FILE.REQIF  OR /PATH/TO/FILE.REQIFZ
importRootIDType=PROJECT|ITEM
importRootID=1234

# Export
exportType=PROJECT|LOCATION|FILTER|BASELINE
exportRootID=1234
conversationID=_ABCDEF1234567890
useRootAsSpecification=false
outputLocation=/PATH/TO/OUTPUT/LOCATION
packageAsReqifz=true

Quick Start Guide

Example Export

1. Identify the project and location to export.
2. Launch Data Exchange and log in.
3. Select Export > Export Only.
4. Choose the project/location.
5. Create a mapping file (or use default).
6. Click Export to generate the ReqIF file.

Example Import

1. Launch Data Exchange and log in.
2. Select Import Only.
3. Choose the source .reqif or .reqifz file.
4. Select the project and location.
5. Create a mapping file.
6. Click Import.
7. Verify imported content in Jama Connect.

Mapping Generation

Required Fields

• Import: Source ReqIF file, Project, Location
• Export: Export From (source container), Project, Location

Mapping Rules

• Specifications: Components, Sets, or Folders must follow Jama Connect hierarchy.
• Spec-Relations: Map ReqIF relationships to corresponding Jama Connect relationship types.
• Enumerations: Map ReqIF enumeration values to Jama Connect Pick List options.
• Round Trip ID: Use a dedicated custom field for mapping ReqIF identifiers.

DOORS 9.6 Defaults

• Specification Name → ReqIF.name
• Specification Description → ReqIF.description
• Spec Object Name → ReqIF.chapterName
• Spec Object Description → ReqIF.text

Data Type Mapping

Import / Export Modes

Import-Only

• Does not preserve ReqIF identifiers.

Exchange

• Preserves ReqIF identifiers for round-trip data exchange.

Key Options

• Export as ReqIFZ
• Reverse Relationship Direction
• Remove HTML from Name or Text fields
• Use Project ID as Name if undefined
• Generate Import Report
• Filter Deleted Objects
• Enable Asynchronous Requests / Throttle Requests
• Recreate DOORS Project Module Hierarchy

Exchange via Conversation

• Conversations track back-and-forth data exchanges between systems.
• Data Exchange stores conversation metadata as a project attachment and on each item.
• Mapping files are saved in the conversation metadata to simplify repeated exchanges.

Round Trip: Jama Connect to Jama Connect

1. Export from Jama-A: Exchange mode, create conversation, select project/location, export ReqIF/ReqIFZ.
2. Import to Jama-B: Select the exported ReqIF, create a conversation, select the project/location, and import.
3. Export from Jama-B: Use the same conversation, export ReqIF/ReqIFZ.
4. Import back to Jama-A: Conversation metadata auto-populates, import ReqIF.

Jama Connect ↔ DOORS Data Exchange

Mapping: DOORS Modules → Jama Sets

1. Export from Jama Connect → ReqIF (Exchange)
2. Import into DOORS
3. Export from DOORS → ReqIF
4. Import into Jama Connect

Notes:

• Use mapping from the initial import when exporting back to DOORS to maintain module hierarchy and identifiers.

Attachments

• Data Exchange imports attachments included in ReqIF.
• Checks for existing files to avoid duplication.
• For DOORS: export OLE objects as RTF for compatibility.