Versions Compared

Old Version 11

changes.mady.by.user Unknown User (mjvf)

Saved on

compared with

New Version 12

changes.mady.by.user Unknown User (mjvf)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

This is the second exercise of the Basic Level. The main goal of this exercise is to give you an idea of the tasks that you can perform when managing templates.

Beyond installing templates from the Template Store as demonstrated on the previous exercise, you can also create your own templates and upload them to your Jira instance.

Info
titleSupported template formats

Currently, Xporter for Jira supports templates with the .docx, .docm, .dotx, .dotm, .odt , .rtf, .xlsx and .xlsm extensions.


Navigate to Templates on the Xporter section page on Jira Administration and you'll see both templates you've installed in the previous exercise.

You have available the options to:

  • + Add, where you can add a new template; 
  • Edit, where you can change an existing template's name, description, file, scopes, output formats, break pages or include attachments;
  • Delete where you can delete an existing template;
  • Set as Default, where you can set that template as the default one to appear on the Xporter screens.

Info

If no Template is set as default, the one displayed on the Xporter screens will be the first listed in alphabetical order.

If you click the hyperlink text with template file name next, you'll automatically download the template file.

You'll notice that both templates have the tag Installed from store next to them since they were installed from the Template Store.
User-installed templates will have the Installed from file upload tag instead.

Exercises

Adding a New Template


Section
Column
width50%

In order to add a new template, you must first learn how to create your first template. To do so, follow Exercise 1 - How to get Issue data printed on document.

Once your template is created, on Templates, click the + Add button and a pop-over dialog will be displayed.

On the File entry, navigate to your template file and select Open. Some advanced (file-level) configurations will be available now like Output formats, Default format, Break Pages and Include Attachments.

The Scopes area will be filled with all the available contexts. Remove and add some of them again simply by selecting from the dropdown or the remove all with the clear button.

The create button will be disabled until we gave a name to our Template.

Name your template as you wish and click the Create button again, and you're done.

Note that its entry will have the Installed from file upload tag as well as Everywhere under the Active Scopes column.


Note

If either the template name or file name is the same as an already installed template, an Error message will be displayed when clicking the Create button.

Both of their names (template and file) should be unique.

If you try to add a template file with an unsupported extension, an Error message will be displayed informing you of the supported extensions.

Column
width50%

Editing a Template


Section
Column
width50%

Column
width50%

On your newly created template entry, click the Edit button on the Operations column, and a pop-over dialog will be displayed.

Input a Description to your template and click Update. Now, your template entry will have its description exhibited as well.

Info

You can change the Name, Description, Scopes, File and advanced options of your template when editing it.

This applies to both templates Installed from the store or Installed from a file upload.

Deleting a Template


Section
Column
width50%

On one of the template entries with the tag Installed from store next to them, click the Delete button on the Operations column.

A prompt dialog will be displayed asking if you're sure you want to delete the template. Click Confirm, and that template entry will be removed.

Column
width50%

Setting a Template as Default

On the entry of your created template, click Set as Default on the Operations column, and the Default label will be displayed next to that template entry.

Also, if you now try to export a single issue or a bulk of issues, your template will appear selected automatically on the template selector.

Info
titlePermission Schemes detail


If you have a Permission Scheme active, and your default template isn't included in it, then it won't be displayed on the template selector at all.

The one displayed on the Xporter screens will be the first available template of that Permission Scheme listed in alphabetical order.

Downloading one of your templates

If you want to download the template file of one of your templates, click the hyperlink with the template file name next to the Template entry or click Download on the Operations column.

The template file will be downloaded.


This Exercise is now complete. Proceed to Exercise 3 to learn how to use the Template Store.

Info

If you like this exercise, please leave a comment or a (thumbs up). Your feedback is very important to us.

Thank you in advance. Enjoy our product. (big grin)