Versions Compared

Old Version 9

changes.mady.by.user Angelica Salazar

Saved on

compared with

New Version Current

changes.mady.by.user Angelica Salazar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Improved content

The template administration view allows you to manage your Word and Excel templates in R4J for later exports, there is no difference in the management for this types.
Since templates are globally available across all enabled projects the template administration view displays all uploaded templates.
This includes uploading new templates as well as changing and deleting existing templates.

To learn the template language, please see the User Guide for 

Overview

R4J supports Word and Excel files that serve as templates for exporting requirements - see Word Template based Export and Excel Template Based Export.

Info

If you encounter difficulties, please visit the Word Export FAQ page or feel free to get support!

Template Administration 

To go to the template administration view,

Log in as JIRA Administrator

Templates are uploaded and managed by the Jira Administrator.

You need the "Export Template Configuration" user permission to manage export templates. See Managing User Permissions.

Table of Contents
minLevel1
maxLevel7

Manage Export Templates

Select Requirements > Export Template

Configuration from the main navigation bar. InfoIf you can't find Export Template Configuration

Configuration from the

main

navigation bar

, you will find user access configuration for this by going to Add-on Administration > Permissions (Requirements for Jira). Set "Restrict User Access" to YES and configure permissions as intended.

The template administration view consists of a single table showing all uploaded templates.
For each template the following information is displayed: 

  • Template Name
    The name of the template that is used in selecting the template in other export functionality.

  • Description
    The description of the template to provide further details of the template contents for later use. The description is only visible in this view.

  • File Name
    The filename of the template used to upload or update a template file. The filename is only visible in this view.

  • Uploaded by
    The user who performed the last upload or update operation on the template. The "uploaded by" information is only visible in this view.

  • Uploaded at
    The timestamp of the last upload or update operation on the template. The "uploaded at" information is only visible in this view.

InfoUpload

. Existing templates are listed and can be edited or deleted.

To upload a new template, select the Add new template button and provide the file. After upload, the template will be available for the export operation.

The upload file size limit for export templates is based on

configured Attachments Size

the attachment size in Jira.

 To

 To configure this, go to Jira

settings > System > Advanced

Table of Contents

toc

settings > System > Advanced > Attachments.

Working with templates

Upload a new template

  1. Switch to the template administration view.
  2. Click on the Image RemovedAdd new template button to open the add template dialog.
  3. Enter a name and optionally a description providing further information about the template.
    Note that the names of templates have to be unique.
  4. Upload a template file by 
    1. either clicking the Add a file button and selecting a file from the browser
    2. or by dragging and dropping a file onto the button.
  5. Click Add to upload the template. 

Edit a template

  1. Switch to the template administration view.
  2. Within the table locate the template you want to edit.
  3. Click on the Image Removed icon for the template.
  4. Update the desired values and click Edit to save the changes.

Replace the file of an existing template

  1. Switch to the template administration view.
  2. Within the table locate the template you want to replace the template file for.
  3. Click on the Image Removed icon for the template.
  4. Upload a new template file by 
    1. either clicking the Add a file button and selecting a file from the browser
    2. or by dragging and dropping a file onto the button.
  5. Click Upload to replace the template file. 

Delete a template

  1. Switch to the template administration view.
  2. Within the table locate the template you want to delete.
  3. Click on the Image Removed icon for the template.
  4. Click Delete to confirm that you want to delete the template. 

File extensions

Listed below are file extensions that can be uploaded as an export template in R4J.

Word Format

.docx

Standard Word Document.docmWord Macro-Enabled Document .dotm Word Macro-Enabled Template.dotx Word TemplateExcel Format.xlsxStandard Excel Workbook.xlsmExcel Macro-Enabled Workbook.xltmExcel Macro-Enabled Template.xltxExcel Template

Template Properties

Template Name

The name of the template that is shown in selecting the template in the export operation.

Only the name of the template is provided in the export operation. The rest of the properties are only intended for the purpose of administration.

Description

Extra information about the template.

File Name

The file name of the template used to upload or update a template. The supported extensions are the following:

  • Word: .docx, .docm, .dotm, .dotx 

  • Excel: .xlsx, .xlsm, .xltm, .xltx

Uploaded by

The user who performed the last upload or update operation.

Uploaded at

The timestamp of the last upload or update operation.