Is it possible to trigger the XRAY Document Generator without using the UI?

Question

Hi all,

We are looking to bulk generate some documentation from our XRAY content. We have Document Generator templates that we can use to generate documentation from the UI, and would like to use these same templates to generate documentation on a larger scale, for example for all issues in a project.

Is it possible to script this using Groovy? Or is there some API to trigger Document Generator that we could use?

What does clicking the Document Generator button actually do? It doesn't open a specific hyperlink from what I can see.

Please let me know any thoughts or suggestions, thanks.

Samuel Holley · Answer

Hi @Stefan Salzl

Thank you for your reply. We don't have Xporter installed in our instance so unfortunately cannot try this

Stefan Salzl · Answer

Hi @Samuel Holley

Unfortunately I can´t test/verify this but just a gutfeeling:

xray Document Generator uses xPorter and xporter itself has a RestAPI. If you have xporter installed I would give it a shot. see the API documentation below:

https://confluence.getxray.app/display/public/XPORTER/REST+API

Best
Stefan

Laurie Sciutti · Answer

Hello @Samuel Holley ~ I don't believe this is available though I know users have asked for it before.  https://docs.getxray.app/display/XRAY/v2.0

I would recommend reaching out to the vendor:  https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2