Step-by-Step Guide: Fixing Broken OLE Links in ReqIF Files Before Importing to Jama Connect

Overview

This guide provides a step-by-step approach to resolving broken OLE (Object Linking and Embedding) links in ReqIF files before importing them into Jama Connect via DX. The goal is to ensure that attachments have proper file extensions and that Jama can correctly reference them.

Step 1: Identify Broken OLE Links in the ReqIF File

✔ Open the ReqIF file in a text editor (e.g., Notepad++, Visual Studio Code)
✔ Search for OLE Object references using the keyword:

php-template

CopyEdit

<EmbeddedObject>

✔ Look for any file paths or attachment references missing a file extension (e.g., .docx, .xlsx, .png).
✔ If an attachment is missing its extension, this will cause DX to fail the upload, leading to broken links.

Step 2: Verify Missing Files in the ReqIF Directory

✔ Locate the ReqIF attachment directory (usually a folder that accompanies the ReqIF XML).
✔ Check if any files have no extension or generic names (e.g., _5ece428d-e222-4061-a2ad-6538489f15fc_1).
✔ If necessary, open the file in a text editor or a universal file viewer (Hex Editor, Notepad++, File Viewer Plus) to identify the correct file type.

Step 3: Rename Files and Add Missing Extensions

✔ If a file lacks an extension, rename it to include the correct extension (e.g., _5ece428d-e222-4061-a2ad-6538489f15fc_1.docx).
✔ Cross-check the file type by:

• Right-click → Properties (Windows)

• file filename (Linux/Mac Terminal)

Step 4: Update the ReqIF File to Reference the Correct Attachment Names

✔ Open the ReqIF XML file and locate the <Object>, <EmbeddedObject>, or <AlternativeID> sections.
✔ Modify any incorrect file references to match the updated filenames with extensions.

✔ Example:
Before Fix (Missing File Extension)

xml

CopyEdit

<Object> <AlternativeID>_5ece428d-e222-4061-a2ad-6538489f15fc_1</AlternativeID> </Object>

After Fix (Corrected File Reference)

xml

CopyEdit

<Object> <AlternativeID>_5ece428d-e222-4061-a2ad-6538489f15fc_1.docx</AlternativeID> </Object>

Step 5: Validate the Updated ReqIF File

✔ Save the modified ReqIF XML and attachments.
✔ Use ReqIF Studio or another validation tool to ensure the file structure is intact.
✔ Open the ReqIF file in Jama Connect Interchange (JCI) or DX preview mode before full import.

Step 6: Re-Import the ReqIF File into Jama Connect

✔ If the ReqIF file is now properly structured, import it into Jama Connect via DX.
✔ If issues persist, review DX logs to identify any remaining attachment reference problems.

Best Practices to Prevent OLE Link Issues

✅ Ensure all attachments have file extensions before exporting from the source tool.
✅ Double-check ReqIF attachment references before importing to Jama.
✅ Use ReqIF Studio or DX preview mode to detect missing files early.
✅ If OLE files are unnecessary, consider deleting their links and using the preview image instead.

Conclusion

• Broken OLE links occur when DX attempts to upload files without extensions or incorrect references.

• Manually adding missing file extensions and updating the ReqIF XML fixes the issue.

• Using ReqIF Studio or JCI to validate imports helps prevent import failures.