Handling Comments in DX and ReqIF Files

Overview

This article explains whether comments are supported in Data Exchange (DX) and ReqIF files, and alternative ways to retain comment data when exchanging requirements.

1. Do Comments Transfer via DX or ReqIF?

✔ DX does NOT support comments.
✔ The ReqIF standard itself does not natively support comments unless stored as a field in an item.
✔ Comments will not be included in a ReqIF export/import unless explicitly mapped to a text field.

🚨 Implication:

• If comments exist in Jama, they will NOT be transferred when exporting via DX.

• If comments exist in DOORS, they will NOT appear in Jama after import.

2. Workarounds to Preserve Comments in ReqIF Transfers

🔹 Option 1: Convert Comments into a Custom Text Field

• If comments are essential, create a custom field in Jama/DOORS to store comment data.

• Before export, manually copy comments into this field so they are retained in the ReqIF file.

🔹 Option 2: Attach Comments as Related Items

• In Jama, link comments to the related requirement items using relationships.

• This method helps retain context but requires manual review post-import.

🔹 Option 3: Use a Report to Capture Comments Before Export

• Generate a report containing all comments before exporting via DX.

• This allows users to manually reconcile comments post-import.

3. Best Practices for Handling Comments in ReqIF Exchange

✅ If comments are important, map them to a dedicated field before exporting.
✅ Ensure all stakeholders understand that ReqIF does not support comments.
✅ Use linked references if maintaining discussion history is essential.
✅ Consider running an export report to retain a record of comments separately.

4. Conclusion

✔ Comments do NOT transfer via DX or ReqIF.
✔ If comments must be preserved, use a dedicated field before exporting.
✔ Consider linking comments as related items or running reports to retain discussion history.