Overview

The Xray Document Generator Add-Ins enable you to create or edit templates by providing the following functionalities in Word and Excel:

  • Snippets such as: Mappings, Iterations, Conditional, Functions, Xray Entities and Custom Fields;
  • Ability to open a template without leaving the Office platform from Template Store;
  • A validation tool that verifies and highlights incorrect syntax of keywords/fields.

After you open the add-ins, you will be able to use the following features:

FeatureDescription
SnippetsLists snippets from Document Generator that can be inserted to the current document as to aid the creation of an Document Generator Template
TemplatesRetrieve Document Generator Templates from the Template Store that can be opened in a new document without leaving the Office platform
ValidateVerify and validate the usage and structure of the keywords/fields of the current working document. Any possible validation error will be displayed in the Add-in window, highlighting them in red any sure incorrect template code and in yellow if there is an error which could possibly be a custom field

To see more details about each of these features, click on the feature link to be redirected to the corresponding page.





General Usage

The features represented in this section are available across the both Add-ins for Excel and Word and are complements to the main functionalities explained further down.


Select platform


The first time you open the Add-in you will be prompted to select the type of Jira instance you are using or desire to use. This choice will have some implications on the contents and functionalities available to you. The differences between which version can be seen here.

Once you've selected the platform, your choice will be saved. However if, for any reason, you want to change to another type of instance available in the Add-in, you can quickly open the "Select Platform" panel by selecting the "More" button that can be seen at the bottom of the add-in screen and selecting the "Switch Platform" option. Once a new platform has been selected the add-in will change some of its contents and functionalities.

User Authentication

Logging in will allow you retrieve information from your Jira instance in order to use it while building and validating your templates. You can easily login by clicking one of the multiple buttons that prompt you to login on the screen. After clicking a "Login" button a panel will be opened where you can insert information related to your Jira instance like:

  • Jira Instance URL
  • Your Jira credentials

Once successfully logged in, the add-in will retrieve only the necessary data for template building from your Jira instance, like the created custom snippets and issues queried by a JQL.


This functionality is only available in the On-Premise platforms of the add-in at the moment. However this feature is already in our Xray Document Generator Add-in roadmap.


More Options

The "More" button at the bottom of the Add-in, gives you quick access to the following actions:

  • Documentation: a new browser window will be opened linking you to this documentation
  • Support: the support page for the Add-in will be opened
  • Switch Platform: you will be able to switch the current platform
  • Logging out (if you are currently logged into a Jira On-Premise): it will log you out of the current Jira instance

Table of Contents: