Handling ReqIF Attachments (HTML & SVG) in Jama Connect & DX

Overview

This article addresses issues related to importing ReqIF attachments into Jama Connect via Data Exchange (DX). The discussion highlights common errors when handling HTML and SVG file extensions, security concerns, and potential workarounds.

1. Understanding the Attachment Import Issue

• Problem: ReqIF files from ReqMan reference SVG file types, but the actual attachments have an .html extension.

• Error Message:

  vbnet

  CopyEdit

  ERROR | Unable to upload ReqIF attachment … File extension .html isn't supported

• Cause:

  • Jama Connect has a whitelist for allowed file extensions in attachments.

  • By default, .html and .svg files are not permitted due to security concerns.

  • The ReqIF file references SVGs, but the actual attachments are .html, creating an inconsistency.

2. Security & File Type Restrictions in Jama Connect

• SVG files pose a security risk because they can contain executable scripts.

• HTML attachments are blocked by default in Jama Connect but may be added to the allowed list via a Support Ticket (if Cloud-hosted).

• Even if HTML is enabled, Jama Connect will not render the file but provide a download link instead.

3. Workarounds & Best Practices

✔ Enabling HTML Attachments (if necessary)

• HTML file support can be enabled in Jama Connect settings (for on-prem users) or via a Support Ticket (for Cloud users).

✔ Resolving ReqIF File Mismatch

• The ReqIF file should reference the correct file type.

• If attachments are HTML but the ReqIF references SVG, this mismatch must be corrected before import.

✔ Using the “Export SVG as PNG” Option in ReqMan

• If the ReqIF tool (e.g., ReqMan) allows exporting SVGs as PNG, this can resolve file type issues.

• The client should retry the export with this switch enabled.

4. Key Takeaways

• Jama Connect blocks .html and .svg attachments by default for security reasons.

• HTML support can be enabled via a Support Ticket, but files will only be downloadable, not rendered.

• Mismatched file references in ReqIF (SVG vs. HTML) can cause import failures and must be corrected at the source.

• ReqIF tools like ReqMan may provide export settings (e.g., 'Export SVG as PNG') to prevent compatibility issues.

Conclusion

When importing ReqIF files into Jama Connect via DX, it is critical to ensure:

1. File extensions match their references in the ReqIF file.

2. Security restrictions on attachments are considered before attempting an import.

3. Alternative export settings (e.g., SVG to PNG) are used when necessary.

This structured approach prevents import failures and ensures seamless attachment handling in Jama Connect.