How to change templates used to export to Excel from the Issue Navigator
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
The information on this page relates to customizations in JIRA Applications. Consequently, Atlassian Support cannot guarantee the provision of any support for the steps described on this page as customizations are not covered under Atlassian Support Offerings. Please be aware that this material is provided for your information only and that you use it at your own risk.
Also, please be aware that customizations done by directly modifying files are not included in the upgrade process. These modifications will need to be reapplied manually on the upgraded instance.
Customisations to Velocity templates or other JIRA files are not included in the scope of Atlassian Support.
Solution
Deploying Velocity Templates without a Restart
In a development instance, you can play with picking up velocity file changes without a restart.
From <jira-install>/atlassian-jira/WEB-INF/classes/velocity.properties:
Change class.resource.loader.cache from true to false
Uncomment (remove the # sign) from
#velocimacro.library.autoreload=trueto
velocimacro.library.autoreload=true
Keep in mind that the next time you upgrade JIRA – or need a new installation for any reason – you will have to manually copy any changes you have made to the JSPs or tempates into the new installation of JIRA. If the JSPs or templates have changed in the newer version, you will have to port your customization into them.
Changing templates used to export issues to Excel
When exporting a set of issues to Excel, customisation to the layout templates are controlled in Velocity files. Velocity templates for the export formats are defined in file /atlassian-jira/WEB-INF/classes/system-issueviews-plugin.xml. The following files in particular define the Excel views:
$JIRA_INSTALL/atlassian-jira/WEB-INF/classes/templates/plugins/searchrequestviews/searchrequest-excel-header.vm
$JIRA_INSTALL/atlassian-jira/WEB-INF/classes/templates/plugins/searchrequestviews/searchrequest-excel-footer.vm
$JIRA_INSTALL/atlassian-jira/WEB-INF/classes/templates/plugins/searchrequestviews/searchrequest-description-header.vm
Please refer to Microsoft® Office HTML and XML Reference for further information on the syntax of the template contents.
Was this helpful?