Uploaded image for project: 'Xray for Jira Cloud'
  1. Xray for Jira Cloud
  2. XRAYCLOUD-10826

Word cross-references not preserved in generated documents

    XporterXMLWordPrintable

Details

    • Bug
    • Status: Waiting Approval
    • Medium
    • Resolution: Unresolved
    • Xray Cloud 12.0.0
    • None
    • Document Generator
    • None
    • macOS 26.3, Google Chrome Version 145.0.7632.160 (Official Build) (arm64)

    Description

      Description

      When generating a Word document via Xray's Document Generator using a template that contains Word cross-reference (REF) fields, the generator renames the target bookmark by appending 0 to its name. As a result, the cross-reference cannot be resolved in the generated document, and displays _Error! Reference source not found. in place of the expected reference value.

      Pre-conditions

      • Xray Cloud instance with Document Generator enabled
      • A Test Plan with at least one Test added to it
      • A custom Word template containing A bookmark.
      • A REF cross-reference field elsewhere in the document pointing to that bookmark 

      How to reproduce

      1. Open the attached template Bookmark.docx and confirm the cross-reference correctly displays [1]
      2. In Xray Cloud, open a Test Plan that contains at least one Test
      3. Run the Document Generator on the Test Plan at the Issue Detail level using the attached template
      4. Download and open the generated document.
      5. Observe that it shows an error in place of the bookmark.

      Actual result/Attachments

                     

      Expected result

      The cross-reference should resolve to [1], to match the behavior in the original template. 

             

      Workaround

      Manually update the REF field in the template to anticipate the rename.

      Attachments

        1. image-2026-05-26-11-30-28-047.png
          186 kB
          Joshua Tesfaye
        2. image-2026-05-26-11-31-24-475.png
          179 kB
          Joshua Tesfaye
        3. image-2026-05-26-11-32-15-438.png
          431 kB
          Joshua Tesfaye
        4. image-2026-05-26-11-34-04-122.png
          180 kB
          Joshua Tesfaye
        5. image-2026-05-26-11-35-38-849.png
          425 kB
          Joshua Tesfaye
        6. image-2026-05-26-11-49-51-995.png
          571 kB
          Joshua Tesfaye
        7. Bookmark.docx
          35 kB
          Joshua Tesfaye

        Issue Links

          Activity

            People

              bernardo.cottim Bernardo Cottim
              joshua.tesfaye Joshua Tesfaye
              Votes:
              1 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: