Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Xray Document Generator - embedding screenshots

Ashish Jain
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
May 11, 2026

Hello Atlassian Community,

1. Is there a way to configure the project-specific Document Generator template to render evidence screenshots as inline images rather than links?
2. What template syntax or variables should be used to achieve this? (e.g., something like an image rendering directive for TestRun evidence)
3. Are there any known limitations on the Xray Cloud version for embedding screenshots in Document Generator exports?

Up research, I came across to know that the Document Generator *can* embed evidence screenshots using conditional image rendering logic in the template. However, it is not clear how to replicate this in a Cloud/Enterprise project-specific template.

Any guidance, template examples, or pointers to documentation would be greatly appreciated!

1 answer

Suggest an answer

Log in or Sign up to answer
0 votes
Anwesha Pan
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Champions.
June 1, 2026

Hi @Ashish Jain  👋🏻

First of all, welcome to community! ✨

As per my understanding, you can configure your custom project-specific Document Generator template to embed evidence screenshots as inline images instead of links. Xray Document Generator relies on the Xporter syntax engine, which natively supports inline image rendering directives.

You can try the following:

  1. Force the Document Generator to render an evidence image inline, you must use the exclamation mark syntax notation (!{...}) combined with an explicit width/size modifier. 
    Refer this community post for more details.
  2. Yes, you are correct that Document Generator can embed evidence screenshots. To replicate this you will need to Download a Base Template --> Modify the code --> Upload via Project Settings.
    To learn more, you can refer this documentation with step by step instructions.

I hope this answers your question. 🙂

Thanks,
Anwesha

TAGS
AUG Leaders

Atlassian Community Events