Handling Equation Editor Attachments in ReqIF Exports with Data Exchange (DX)

Overview

This article addresses an issue encountered when exporting items with attachments created by an equation editor. The error occurs because DX attempts to read the file from a local disk instead of retrieving it from the server. This document provides insights into the cause, a known defect, and potential workarounds.

1. Issue Description

• Users experience a "file not found" exception when exporting items containing attachments created by an equation editor.

• The equation editor attachments differ from standard attachments because they are referenced in the ReqIF file but not properly located by DX.

• Normal attachments and embedded images export successfully; however, equation editor-generated files fail.

2. Root Cause Analysis

• DX tries to read the attachment from a local disk instead of referencing it correctly from the server.

• The attachment URL includes an extra suffix (e.g., "?dpi=96&cw=59&ch=38"), which may cause parsing issues.

• Some equation editor attachments are stored with MathML or specialized XML formatting that may not conform to expected image embedding methods.

3. Workarounds & Solutions

✅ Temporary Workarounds

• Manually remove the extra URL suffix (e.g., "?dpi=96&cw=59&ch=38") from the attachment reference before exporting.

• Verify whether the attachment URL correctly points to the cloud storage location (e.g., Jama cloud or local repository).

• If possible, re-save the attachment as a standard image file and reattach it before exporting.

🚧 Permanent Fix

• A defect has been logged: EES-EESD-425, indicating that DX needs better handling of equation editor-generated attachments.

• Future versions of DX may introduce improved processing to automatically strip URL suffixes and properly locate equation-generated files.

4. Best Practices for Users

✅ Verify attachment references: Before exporting, check that all attachments are correctly referenced in the ReqIF file.
✅ Use standard image formats: Where possible, convert equation editor attachments into PNG/JPG to ensure compatibility.
✅ Test exports on a subset of data: Run sample exports to identify any problematic attachments before full-scale exports.
✅ Keep DX updated: Ensure you are using the latest version of DX, as updates may include bug fixes related to attachment processing.

5. Conclusion

• The issue with equation editor attachments in ReqIF exports is a known defect.

• Removing unnecessary URL suffixes can temporarily resolve the problem.

• A permanent fix has been logged under EES-EESD-425 for future DX updates.

• Users should consider standardizing attachment formats and verifying file paths before exporting to prevent errors.