This functionality requires the user to be logged in and, for this reason, is only available for Xray Document Generator On-Promise.


The snippet Custom Fields allows users to insert into the current document a list of custom fields that were created in your Jira instance and that will be loaded after the user's authentication. This set of snippets contains only simple snippets and are all contained in the same category, not divided by any section.


Custom fields will only be loaded if the currently logged-in user is a Jira Admin.

Apply custom fields

To insert custom fields to the current document, like in any other simple snippet, you just have to click on your desired custom field. The custom field will be inserted into the document with the following structure.

${Custom Field[ID]}

This structure is used in order to better identify custom fields and avoid different custom fields with the same name get their values confused when processed by Document Generator while exporting the template. This can be verified in Xray Document Generator On-Premise and Xray Document Generator Cloud documentation in the Custom Field section of the page.



To see the process of how to apply a custom field in a Word or Excel document, you can go to this page.

Table of Contents: