Handling Attachments in ReqIF Exports from Jama Connect

Overview

This article clarifies how attachments in RichText fields behave when exported via ReqIF in Jama Connect, including best practices to ensure attachments appear correctly in exported documents.

1. Does ReqIF Only Export Attachments Embedded in RichText?

✔ Yes, ReqIF only exports attachments that are embedded within RichText fields.
✔ Plain text fields referencing an attachment (e.g., via an HTML <img> tag) will NOT include attachments in the ReqIF export.

2. Common Errors & Their Causes

A. Failure to Export Attachments in RichText Fields

✔ Error Message:

vbnet

CopyEdit

ERROR: c.j.d.t.a.r.s.ReqIFSerializer - Failed to output Richtext content for f... Cause: For input string: "v"

✔ Possible Cause:

• The attachment URL contains an unexpected /v/ in the filename, which may break DX’s parsing logic.

• The filename structure may not match ReqIF's expected format.

B. UI Inserted Attachments vs. Manually Added URLs

✔ Attachments added via the Jama UI should not include /v/ in the attachment URL.
✔ Manually inserted URLs might fail if they don’t follow the expected ReqIF structure.

3. Best Practices for Ensuring Attachments Export Correctly in ReqIF

✅ Use RichText fields for embedding attachments.
✅ Ensure attachment URLs follow Jama’s expected format:

• Correct format:

  bash

  CopyEdit

  https://nvidia.jamacloud.com/attachment/548573/ba9ce81272b14c1a49

• Avoid using URLs with unexpected slashes (/v/ inside the filename).
  ✅ Test by inserting an image via the UI rather than manually typing an <img> tag in HTML.
  ✅ Verify attachment rendering in Jama’s UI before exporting to ReqIF.

4. Conclusion

• Attachments must be in a RichText field to be included in ReqIF exports.

• Plain text fields referencing attachments (e.g., via <img> tags) will not work.

• Ensure attachment URLs are correctly formatted to avoid export failures.

• If an attachment does not appear in the ReqIF export, verify URL structure and use UI-inserted attachments.