The Document Generator feature is available on:



Issue Detail Screen

You can create documents directly from the Issue detail screen by clicking on  Xray Document Generator button available on tools section.


After clicking on it, a dialog is shown with the following fields:

  • Templates
  • Output Formats


Templates are grouped by global and project templates. Each template has its own output formats pre-defined.

Once you have selected the template, you have to select the desired output format.


Having choose the template and the output format, now you can generate your document by clicking on Export button, otherwise, we can close the dialog by clicking on Close button.

Once the generation process is finished you can get your document by clicking on Download button. If you want to generate another document you just have to click on Back button or leave the dialog by closing it.


Issue Navigator Screen

You can create documents directly from the Issue Navigator screen by clicking on the Xray Document Generator button available on tools sections as shown in the image below.

Regarding the template selection and the output format is exactly the same as explained above on Single issue details. There is only one diference here, the Break Type, where you can define if you want or not a page break on word documents.

The values available for this field, are:


Break TypeExpected behaviour
ComponentsIf the component is different from the previous issue processed, then a new page break will be added.
IssuesA page break is added for each issue processed.
Issue TypesIf the issue type is different from the previous issue processed, then a new page break will be added.
ProjectIf the project is different from the previous issue processed, then a new page break will be added.
NeverNo page break will be added.


The Export process is exactly the same as mentioned above, so you just have to click on Export and when it's finished, click on Download to get the document.




  • No labels