In this page

Version History
Release Notes
3.6.1
Bugfixes
Upgrading from 3.6.0
3.6.0
"Better Excel Plugin for Jira" is now called "Better Excel Exporter for Jira"!
Improved support for Jira Service Desk custom fields
Support for the Development Summary custom field type (branches, commits, pull requests)
More error-tolerant export of "non-officially-supported" custom field types
Limit for concurrent Excel renderings
Notable changes
Improvements
Bugfixes
Upgrading from 3.5.0
3.5.0
$componentManager removed from the rendering context
Upgrading from 3.4.2
3.4.2
Bugfixes
Upgrading from 3.4.1
3.4.1
Bugfixes
Upgrading from 3.4.0
3.4.0
Support for Tempo period- and user filters
Faster export of Tempo worklogs via pre-loading
Support for Time to SLA
Support for user properties
Improvements
Bugfixes
Upgrading from 3.3.0
3.3.0
Upgrading from 3.2.0
3.2.0
Support for Zephyr
Improvements
Bugfixes
Upgrading from 3.1.0
3.1.0
Upgrading from 3.0.0
3.0.0
Major performance improvements
New "Performance Tuning" page
New "Getting Started" page
Improvements
Upgrading from 2.6.0
2.6.0
Support for nFeed (by Valiantys)
Upgrading from 2.5.0
2.5.0
Support for the Insight asset management app (by Riada)
Bugfixes
Upgrading from 2.4.1
2.4.1
Upgrading from 2.4.0
2.4.0
Performance improvements for spreadsheets with many columns
Zero-config templates
New "repeating fields" templates
New calculated field type: "Excel parent key"
Improvements
Bugfixes
Also: Excel Automation Plugin 2.1.0 released!
Upgrading from 2.3.0
2.3.0
Upgrading from 2.2.0
2.2.0
View visibility
User interface integration with Jira Agile, Jira Service Desk and Tempo
Support for view contexts
New cell type: "link"
All default templates use the 1900 date system
Bugfixes
Upgrading from 2.1.0
2.1.0
Upgrading from 2.0.0
2.0.0
Built-in Groovy editor
Support for Visual Basic macros and macro-enabled workbooks
Auto-conversion for all date type fields
User export
View names in the "Export" drop-down in any language
Additional improvements
Upgrading from 1.3.0
1.3.0
Support for Jira Data Center
Support for Jira 6.2 - 7.0
Changes
Upgrading from 1.2.0
1.2.0
Calculated fields with or without custom fields
Upgrading from 1.1.0
Known and harmless issue: RuntimeException with XlsViewComparator
1.1.0
Powerful field value formatting
Calculated fields
Support for Jira Agile, Jira Service Desk and Tempo
Upgrading from 1.0.0
1.0.0

Version History

VersionDateNotes
3.6.113/10/2018Maintenance release.Release Notes & Upgrade GuideDownload
3.6.013/09/2018Better support for Jira Service Desk fields. Support for Development fields. Limit for concurrent renderings.Release Notes & Upgrade GuideDownload
3.5.016/07/2018Compatibility release for Jira 7.11.Release Notes & Upgrade GuideDownload
3.4.222/06/2018Maintenance release.Release Notes & Upgrade GuideDownload
3.4.103/05/2018Maintenance release.Release Notes & Upgrade GuideDownload
3.4.027/02/2018Support for Tempo period- and user filters. Tempo pre-loading. Support for Time to SLA.Release Notes & Upgrade GuideDownload
3.3.020/11/2017Compatibility release for Jira 7.6.Release Notes & Upgrade GuideDownload
3.2.002/10/2017Support for Zephyr.Release Notes & Upgrade GuideDownload
3.1.008/09/2017Compatibility release for Jira 7.5.Release Notes & Upgrade GuideDownload
3.0.001/08/2017Major performance improvements. "Performance Tuning" page.Release Notes & Upgrade GuideDownload
2.6.021/06/2017Support for nFeed.Release Notes & Upgrade GuideDownload
2.5.016/05/2017Support for the Insight asset management app.Release Notes & Upgrade GuideDownload
2.4.126/04/2017Important bugfix: Excel rendering randomly fails with classloading exceptions.Release Notes & Upgrade GuideDownload
2.4.003/03/2017Performance improvements. Zero-config templates. New "repeating fields" templates. New calculated field type: "Excel parent key".Release Notes & Upgrade GuideDownload
2.3.005/01/2017Compatibility release for Jira 7.3.Release Notes & Upgrade GuideDownload
2.2.016/12/2016Excel view visibility. UI integration with Jira Agile, Jira Service Desk and Tempo. "Link" cell type.Release Notes & Upgrade GuideDownload
2.1.029/08/2016Compatibility release for Jira 7.2.Release Notes & Upgrade GuideDownload
2.0.007/06/2016Groovy editor. Support for Visual Basic macros, date conversion, user exports.Release Notes & Upgrade GuideDownload
1.3.011/01/2016Jira Data Center support. Support for older Jira versions. MIME type and automation improvements.Release Notes & Upgrade GuideDownload
1.2.016/11/2015Compatibility release for Jira 7. Calculated fields with or without custom fields.Release Notes & Upgrade GuideDownload
1.1.011/09/2015Powerful field value formatting and calculated fields. Support for Jira Agile, Jira Service Desk and Tempo.Release Notes & Upgrade GuideDownload
1.0.018/11/2014Stable version with commercial support.Release Notes & Upgrade GuideDownload

Release Notes

3.6.1

This version is a maintenance release to be compatible with recent Zephyr versions and to fix column configuration problems when exporting saved filters.

Bugfixes
  • Fixed: Zephyr test steps are not rendered with issue-navigator-with-zephyr-test-steps.xlsx template.
  • Fixed: Zephyr test step results are not rendered with issue-navigator-with-zephyr-test-step-results.xlsx template.
  • Fixed: default column configuration is exported when saved filter is modified in Issue Navigator.
Upgrading from 3.6.0

You need to update two script files. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-excel-exporter-for-jira-3.6.1-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Better Excel Exporter).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. issue-navigator.groovy
    2. zephyr-tool.groovy
  5. Enjoy!

3.6.0

This version comes with better support for the Jira Service Desk fields, new support for the Development custom field type and more robust export for "non-officially-supported" custom fields. And, most visibly, the app got a more intuitive name!

"Better Excel Plugin for Jira" is now called "Better Excel Exporter for Jira"!

With this version, we made a slight adjustment in the app's name due to the following reasons:

  1. The new name captures the app's scope more precisely.
  2. The new name is better aligned with our companion app's name "Better PDF Exporter for Jira" (also renamed recently).
  3. The term "plugin" was replaced by Atlassian first with "add-on" and then with "app". We decided to get rid of this completely.

You may still see the old name popping up here and there, until we roll out the change everywhere. Thanks for the patience!

Improved support for Jira Service Desk custom fields

The script field-helper-tool.groovy was improved to work better with Service Desk data. To be precise, the new version supports:

  1. The new format of SLA fields
  2. "Organizations" custom field type
  3. "Satisfaction" custom field type

In our opinion, upgrading is a must-have if you are using Jira Service Desk.

Support for the Development Summary custom field type (branches, commits, pull requests)

From this app version, it is possible to export the "Development" custom field values (i.e the "Development Summary" custom field type) to Excel.

While this field gives a "one-word summary" view in the Issue Navigator screen, like "2 commits" or "merged", it gives more details in the Development panel, like separate counters and states for branches, commits and such. For Excel exports we chose a fairly compact format which is similar to the Development panel, but as always, it can be freely customized if necessary. By default, it will be exported like these examples:

  • "2 branches, 3 commits"
  • "2 branches, 3 commits, 1 merged pull request"
  • "2 branches, 3 commits, 1 open + 2 merged pull requests" (note that pull requests can have multiple states)
More error-tolerant export of "non-officially-supported" custom field types

The script field-helper.groovy always had a fallback mechanism to export those custom field values that are not "officially supported". It works by extracting the body text from the HTML fragments rendered from the values, which gives a surprisingly good approximation in most cases.

The problem was that it assumed that the HTML fragment can be processed as XML, i.e. that it is in the precise and well-formatted XHTML format. As it turned out, that's not always the case: there are several poorly written custom field implementations out there.

Therefore, we introduced a more error tolerant processing approach. It works as expected even if the custom field's HTML is broken (think of non-closed tags, missing quote characters around attribute values and such).

Limit for concurrent Excel renderings

Generating large Excel spreadsheets from a large number of issues can be resource intensive: it may use lots of CPU and lots of memory. Although both types of resource will be released immediately after the spreadsheet is rendered, it may temporarily put significant load on the Jira server. Plus, if you run multiple renderings in the same time (concurrently), their load adds up.

To help control the total load, it is possible to limit the number of parallel Excel renderings from this app version.

Learn more about limiting the number of concurrent renderings.

Notable changes
  • "All fields" type Excel views are not activated for the Issue Navigator context, by default. (You can, of course, turn those on any time.)
Improvements
  • Support for the Insight custom field type "Insight Object/s".
Bugfixes
  • Fixed: SLA values are exported as blank cells from more recent Jira Service Desk versions
  • Fixed: pivot tables are not rendered with the template zephyr-report.xlsx due to a broken named range reference
Upgrading from 3.5.0

Lots of work of have been done: most templates and scripts were updated. Follow the guide below to bring all your resources to the most current revision.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-excel-exporter-for-jira-3.6.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Better Excel Exporter).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. basic-issue-list-template.xlsx
    2. field-helper-tool.groovy
    3. issue-navigator.groovy
    4. issue-navigator.xlsx
    5. issue-navigator-with-comments.xlsx
    6. issue-navigator-with-history.xlsx
    7. issue-navigator-with-repeating-tempo-worklogs.xlsx
    8. issue-navigator-with-repeating-worklogs.xlsx
    9. issue-navigator-with-tempo-worklogs.xlsx
    10. issue-navigator-with-worklogs.xlsx
    11. issue-navigator-with-zephyr-test-executions.xlsx
    12. issue-navigator-with-zephyr-test-step-results.xlsx
    13. issue-navigator-with-zephyr-test-steps.xlsx
    14. user-export.groovy
    15. user-export.xlsx
    16. zephyr-report.xlsx
    17. zephyr-tool.groovy
  5. Enjoy!

3.5.0

This version is a compatibility release for the Jira 7.11 line.

$componentManager removed from the rendering context

The content object $componentManager is now removed from the rendering context. It has been deprecated in Jira core by Atlassian for a long time. It was being replaced by its modern equivalent $componentAccessor. This app version prepares for its complete removal in Jira core scheduled to the release of Jira 8.

Default templates and scripts are not using $componentManager, therefore those require no update.

Custom templates and scripts that use $componentManager should be updated to use $componentAccessor. The update should be straightforward, because from the template's or script's point of view, $componentAccessor provides a very similar interface as $componentManager does. Click to the above links to see the corresponding Javadoc pages.

Upgrading from 3.4.2

Upgrade the app JAR as usual, through the Universal Plugin Manager.

3.4.2

This version is a maintenance release to deliver UI related bugfixes.

Bugfixes
  • Fixed: "Export" menu in Jira Software boards cannot be opened due to a Javascript error in Jira 7.10.0+.
  • Fixed: "Export" menu is not visible on Service Desk queue screen with Jira Service Desk 3.10.0+.
Upgrading from 3.4.1

Upgrade the app JAR as usual, through the Universal Plugin Manager.

3.4.1

This version is a maintenance release to deliver a single bugfix.

Bugfixes
  • Fixed: "Sum values" may be unset for some pivot tables (resulting in blank pivot tables in some templates).
Upgrading from 3.4.0

You need to update some of the existing templates. It takes just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-3.4.1-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. insight-report.xlsx
    2. jira-agile-report.xlsx
    3. jira-service-desk-report.xlsx
    4. tempo-report.xlsx
    5. workflow-report.xlsx
    6. worklog-report.xlsx
  5. Enjoy!

3.4.0

This release brings valuable improvements to the popular Tempo to Excel export feature. It also introduces a new integration with the Time to SLA app. (Plus, as always, there are improvements here and there.)

Support for Tempo period- and user filters

The Tempo integration now filters worklogs to the time period you selected above the timesheet! (This was a super-popular feature request.)

We even went one step further. The integration also filters worklogs to the user, if you are looking at a single user's timesheet.

As a result, when exporting from the Timesheet screen you will get exactly those worklogs in the export that you see in the web interface.

Please note that in previous versions the app did not use any of these filtering criteria: if an issue was displayed in the timesheet, we exported all the worklogs on the issue, regardless who and when created that. If you want to return to that behaviour, you can easily turn off both filtering. Learn more about period filtering and user filtering.

Faster export of Tempo worklogs via pre-loading

In addition to "load worklogs for each issue separately", the Tempo integration script now supports a new strategy "pre-load worklogs for all issues". It performs much better for massive worklog exports from the Tempo Timesheet and other Tempo screens.

As it is also a subject for performance tuning, make sure you learn more about pre-loading.

Support for Time to SLA

Time to SLA is a popular choice to implement Service Level Agreements on Jira issues. Using this new integration you can export and report on SLA performance in Excel.

See some sample exports from Time to SLA and learn more about this integration.

Support for user properties

Jira can store extra pieces of information for user accounts in form of key-value pairs. These are called user properties.

Starting from this version, it is possible to export user properties to Excel. Learn more about this feature.

Improvements
  • Formatting is consistently set to "dd/mmm/yyyy" for date and "dd/mmm/yyyy hh:mm" for date-time values in all templates shipped with the app.
Bugfixes
  • Fixed: JIRA Service Desk SLA field values are not exported with more recent Service Desk versions.
Upgrading from 3.3.0

Several Excel templates and script files were updated in this release. You can take advantage of all the enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-3.4.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. basic-issue-list-template.xlsx
    2. created-vs-resolved-report.xlsx
    3. field-helper-tool.groovy
    4. issue-navigator-with-repeating-tempo-worklogs.xlsx
    5. issue-navigator-with-tempo-worklogs.xlsx
    6. tempo-tool.groovy
    7. user-export.groovy
    8. user-export.xlsx
    9. workflow-report.xlsx
    10. worklog-report.xlsx
    11. zephyr-report.xlsx
  5. Enjoy!

3.3.0

Compatibility release for the Jira 7.6 line.

Upgrading from 3.2.0

Just update your app using UPM (the app manager built in to Jira), that's all.

3.2.0

Support for Zephyr

Zephyr is the most popular test management solution for the Jira platform. From this Better Excel Plugin version, you can export Zephyr tests, test steps, test executions and test step results to Excel. Four templates are provided out of the box that solve the most typical Excel exporting and reporting use cases (and as always, can be customized!):

  1. Export the currently selected fields plus test steps (from the Issue Navigator to Excel)
  2. Export the currently selected fields plus test executions
  3. Export the currently selected fields plus test executions including detailed step results
  4. Zephyr report with various tables and charts (test results per version / cycle / tester, execution history over time, defects per test / execution, etc.)

See some sample exports from Zephyr and learn more about this integration.

Improvements
  • Default titles and default filenames are generated according to a slightly revised logic: "issue key" (for single issues), "search request name" (for saved filters with a name), "Excel view name (Jira title)" in this order of precedence.
Bugfixes
  • Fixed: character encoding in Tempo worklog comments (that use international characters) may break when exporting from Jira instances hosted on Windows
  • Fixed: "Reporter" column is empty when exporting with the created-vs-resolved-report.xlsx or insight-report.xlsx templates
Upgrading from 3.1.0

Several Excel templates and script files were introduced or updated in this release. You can take advantage of all the enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-3.2.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. created-vs-resolved-report.xlsx
    2. insight-report.xlsx
    3. issue-navigator-with-zephyr-test-executions.xlsx
    4. issue-navigator-with-zephyr-test-step-results.xlsx
    5. issue-navigator-with-zephyr-test-steps.xlsx
    6. tempo-tool.groovy
    7. zephyr-report.xlsx
    8. zephyr-tool.groovy
  5. Create the new Excel views that render the new templates:
    1. To create a new export option in the Export dropdown, go to Excel Views (in the left-side bar) and click Add a new view.
    2. Enter "Zephyr Executions (Curr. f.)" as name, check the Issue Navigator context option (at least), select the template file issue-navigator-with-zephyr-test-executions.xlsx and click submit. If you are not using Zephyr at all or don't want to activate the Zephyr related Excel views for now, then do not select any of the contexts. (It is possible to create views without any context selected, making them invisible for now, but also making it super-easy to activate them later.)
    3. The Excel view you created in the previous step will export the currently visible columns in Issue Navigator plus the test executions details added in the right. If you need an additional view which exports all issue fields plus the test executions (to a super-wide spreadsheet), then create another view with the same template, but with the name "Zephyr Executions (All f.)". (Note: if the view name contains the word "all", then all columns will be exported.)
  6. Repeat the previous step also with the following templates:
    1. issue-navigator-with-zephyr-test-step-results.xlsx (view name: "Zephyr Step Results (C. f.)" for current fields or "Zephyr Step Results (All f.)" for all fields)
    2. issue-navigator-with-zephyr-test-steps.xlsx (view name: "Zephyr Test Steps (Curr. f.)" for current fields or "Zephyr Test Steps (All f.)" for all fields)
    3. zephyr-report.xlsx (view name: "Zephyr (Excel)")
  7. If during the previous steps you haven't selected any context for any of the Zephyr related Excel views (i.e. you don't want to use the Zephyr integration at all), then you can skip this step. Otherwise, you need to configure the Zephyr API access: just see this guide.
  8. Enjoy!

3.1.0

Compatibility release for the Jira 7.5 line.

Upgrading from 3.0.0

Just update your app using UPM (the app manager built in to Jira), that's all.

3.0.0

Major performance improvements

This release focuses on performance.

While working on this, we ran hundreds and hundreds of profiling sessions to find the performance bottlenecks that make the export process long (CPU) and consume unjustified amount of resources (memory). We reworked the resource intensive and memory hungry operations in the app code and in the default templates. This results in faster and more stable Excel exports from this release.

OK, but how much faster? This is difficult to tell how much improvement you will see in your environment compared to previous versions, as it depends on many different factors. Primarily factors are the template complexity (general logic, embedded iterations, etc.), data size (number of issues, number of dynamic columns, etc.) and data variance (which affects auto-sizing). The overall improvement can be anything between negligible (for small under-a-second tables) to 500% (for large tables).

To enjoy the improvements:

  1. Upgrade the default templates and scripts (see the upgrade guide below)
  2. Review your own templates and scripts using our new "Performance Tuning" guide in case you want to improve those now or in the future (see next section)
New "Performance Tuning" page

Not only we improved the app and the default templates for better performance, we also compiled a page about what to do and what to avoid when developing custom templates for large scale of data. We will keep improving the Performance tuning page with our future findings, as well.

New "Getting Started" page

We added a "getting started" page to the app to save some reading for first time evaluators. As it may be useful even for more experienced users, it can also be visited via the link at AdministrationAdd-OnsGetting Started (under Excel Views).

Improvements
  • New tag parameter <mt:autosize whiteSpace="3.5"> can specify the cell padding to avoid "######" cells and unwanted text wrapping (both caused by narrow columns).
  • New tag parameters <mt:autosize columnLimit="15" rowLimit="5"> can drastically speed up auto-sizing by limiting the cell region to test for optimal column width and optimal row height.
  • New tag parameter <jt:forEach copyColumnWidthsRight="false"t> makes it faster to render horizontal iterations.
  • Blank cell coloring helps to verify if your templates are clean and tidy.
  • Cell-level logging can generate super-detailed logs for trouble-shooting (you will rarely need it, but it's there now).
Upgrading from 2.6.0

We made major updates on the Excel templates and the Groovy scripts. You can take advantage of all the performance improvements by precisely executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-3.0.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload each file (both .xlsx and .groovy files) one by one from the directory where the ZIP was extracted.
  5. Enjoy!

2.6.0

Support for nFeed (by Valiantys)

The nFeed app integrates external data sources (SQL databases, LDAP, Active Directory, REST APIs, Salesforce, CSV files, etc.) to Jira. From this version, Better Excel Plugin is tightly integrated with nFeed, allowing you to export all nFeed custom fields to Excel. More than data export, you can easily implement custom reporting and Business Intelligence on nFeed data.

See some sample exports from nFeed and learn more about this integration.

Upgrading from 2.5.0

One script file was updated in this release. You can take advantage of all the enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-2.6.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the field-helper-tool.groovy file from the directory where the ZIP was extracted.
  5. Enjoy!

2.5.0

Support for the Insight asset management app (by Riada)

Insight is the leading asset management app for Jira, that allows implementing CMDB, CRM, HR, ITSM or ITIL functionality on the Jira platform. From this release, Better Excel Plugin is tightly integrated with Insight, allowing you to export all Insight custom fields with the desired granularity (object keys, names, and attributes) to Excel. More than data export, you can easily implement custom reporting and Business Intelligence on Insight data.

See some sample exports from Insight and learn more about this integration.

Bugfixes
  • Fixed: Long issue keys like "VERYLONGPROJECTKEY-123" cannot be exported from agile boards (because of being shortened to "VERYLONG...-123")
Upgrading from 2.4.1

One script file was updated, plus one new Excel template and one new script were introduced in this release. You can take advantage of all the enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-2.5.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. field-helper-tool.groovy
    2. insight-report.xlsx
    3. insight-tool.groovy
  5. If you want to activate the Insight report template, then also:
    1. To create the new export option in the Export dropdown, go to Excel Views (in the left-side bar) and click Add a new view.
    2. Enter "Insight (Excel)" as name, check the Issue Navigator context option (at least), select the template file insight-report.xlsx and click submit.
    3. Configure the custom field ID in insight-report.xlsx. See this guide.
  6. Enjoy!

2.4.1

This version fixes the problem of the Excel rendering randomly failing with mysterious classloading related exceptions: NoClassDefFoundError: ZipPackagePropertiesMarshaller and ExceptionInInitializerError (caused by ClassCastException: PackagePropertiesMarshaller).

Root cause: when using the Better Excel Plugin app in an automation context, Automation Lite uses its own classloader to eagerly load and initialize an XML related class.

Fix: although the problem is not in the Better Excel Plugin side, we managed to develop a fix for this.

Upgrading from 2.4.0

Just update your app using UPM (the app manager built in to Jira), that's all.

2.4.0

This release comes with a large number of useful improvements, that include both popular feature requests and important bugfixes.

Performance improvements for spreadsheets with many columns

We made dynamic columns rendering faster, which primarily improves the performance the "issue-navigator*.xlsx" templates. Depending on the number of columns, the difference can be negligible (for 8 columns), significant (30-100% faster for 15 columns) or radical (up to 300-400% faster for hundreds of columns). Overall, the "wider" your spreadsheet, the bigger the difference.

Zero-config templates

We introduced convenience methods to the field-helper.groovy script that allows getting custom field values by the custom field name. We also updated the templates that rely on custom fields like "Account" (Tempo), "Sprint" (Jira Agile), "Time to resolution" (Jira Service Desk) to access those by name. The advantage is that these will work immediately, without requiring you to correctly set the custom field IDs prior to using the template.

Learn more about the new convenience methods in the Excel template customization tutorial.

New "repeating fields" templates

The repeating field version of the issue-navigator-with-worklogs.xlsx and issue-navigator-with-tempo-worklogs.xlsx templates are now available. Those help to transfer data directly from the Issue Navigator to external systems.

Learn more about the repeating field mode among the super-useful recipes.

New calculated field type: "Excel parent key"

This new calculated field can show the parent key for sub-tasks, either as plain text or as link.

Learn more about "Excel parent key" in the calculated fields section.

Improvements
Bugfixes
  • Fixed: Created, Updated, Resolution Date, Date Time Picker type custom fields and the datetime-valued calculated fields (Excel first comment date and Excel last comment date) ignore the timezone of the current user (note: Due Date and Date Picker type custom fields export pure dates (no time part and no timezones!) to be compatible with Jira)
  • Fixed: XLSM and XLS format export files are served with the XLSX files' MIME type, confusing Internet Explorer
  • Fixed: tempo-tool.groovy is using blank base URL, therefore cannot connect to the Tempo worklog servlet
  • Fixed: Formulas containing "<" cannot be parsed (workaround was: flip the formula and use ">")
  • Fixed: The created-vs-resolved-report.xlsx and worklog-report.xlsx templates use the TEXT() function produce month names, but the format string works reliably in English Excel versions only
  • Fixed: The workflow-report.groovy script should generate a time metric also for the last (current) status of each issue
Also: Excel Automation Plugin 2.1.0 released!

We hope you are already using the Excel Automation Plugin, our free app that allows integrating the Better Excel Plugin to automatic business processes. If you are, then remember to upgrade your Excel Automation Plugin to 2.1.0, its latest version released the same day as Better Excel Plugin 2.4.0. (We developed these two releases in parallel, make sure you leverage their integration!)

If you are not using that yet, make sure to give this a try! It will save you from lots of boring manual work by creating and distributing Excel reports automagically!

Learn more about the improvements in the Excel Automation Plugin 2.1.0 release notes.

Upgrading from 2.3.0

Several template and script files were updated in this release. You can take advantage of all the enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-2.4.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. basic-issue-list-template.xlsx
    2. created-vs-resolved-report.xlsx
    3. field-helper-tool.groovy
    4. issue-navigator-with-comments.xlsx
    5. issue-navigator-with-history.xlsx
    6. issue-navigator-with-repeating-tempo-worklogs.xlsx
    7. issue-navigator-with-repeating-worklogs.xlsx
    8. issue-navigator-with-tempo-worklogs.xlsx
    9. issue-navigator-with-worklogs.xlsx
    10. issue-navigator.groovy
    11. jira-agile-report.xlsx
    12. jira-service-desk-report.xlsx
    13. tempo-report.xlsx
    14. tempo-tool.groovy
    15. workflow-report.groovy
    16. worklog-report.xlsx
  5. Enjoy!

2.3.0

Compatibility release for Jira 7.3.

Upgrading from 2.2.0

Just update your app using UPM (the app manager built in to Jira), that's all.

2.2.0

This version enables to configure visibility rules for the Excel views, to show or hide them dynamically for user, groups and issues. Also, Better Excel Plugin now seamlessly integrates with the user interface of the most widely used Jira apps: Jira Agile, Jira Service Desk and Tempo. As for the templates, it generates hyperlinks for the Issue key and Summary columns, and it standardizes on using the 1900 date system.

View visibility

You can set up smart conditions for the Excel views. The availability of each view can be restricted to:

  • Certain groups
  • Certain users
  • Issues that match a given JQL expression (e.g. only display the "Timesheet (Excel)" export type for Task type closed issues)
User interface integration with Jira Agile, Jira Service Desk and Tempo

You can now export Excel spreadsheets directly from:

  • Jira Agile: backlog and Scrum/Kanban board views
  • Jira Service Desk: ticket queues
  • Tempo: timesheet, calendar, report and list views
Support for view contexts

Previous Better Excel Plugin versions used the concept of view types. From this version, we allow more fine-grained control over which screen in the UI a view should be available in:

You can set any combination of these so-called view contexts for each Excel view. Combining this with the optional restrictions (limit each view to certain users, to certain user groups, to certain issues), you can flexibly configure all your Export menus.

When you upgrade to this app version, your views will be migrated to the most intuitive contexts (see the table below). You may want to review those settings after the migration.

View type View contexts
Single issue only Single Issue View
Multiple issues only Issue Navigator
Jira Agile Backlog
Jira Agile Board
Jira Service Desk
Tempo Timesheet
Single and Multiple issues Single Issue View
Issue Navigator
Jira Agile Backlog
Jira Agile Board
Jira Service Desk
Tempo Timesheet
Disabled none

The new cell type called "link" was introduced to turn cells into clickable hyperlinks.

Having this new mechanism, we changed the cell type of the Issue key and Summary columns from plain text into links, when exported from the Issue Navigator. If you prefer the old non-link representation for some reason, you can return to that by modifying two configuration parameters in field-helper.groovy.

See this recipe for more information about exporting hyperlinks.

All default templates use the 1900 date system

The following template files were updated to use the 1900 date system in Excel:

  1. issue-navigator.xlsx
  2. issue-navigator-with-comments.xlsx
  3. issue-navigator-with-history.xlsx
  4. issue-navigator-with-tempo-worklogs.xlsx
  5. issue-navigator-with-worklogs.xlsx
  6. jira-service-desk-report.xlsx

(All other templates were already using the 1900 date system.)

Please note that templates using the 1904 date system were (and still are) working correctly, but you may face difficulties when copying data from 1904 based spreadsheets to 1900 based spreadsheets and vice versa. We decided to consistently use the 1900 date system in all our templates, as it offers better compatibility with spreadsheet tools.

Bugfixes
  • Fixed: Excel API (and Excel Automation for Jira) always generates files with the ".xlsx" extension even if the template is ".xls" or ".xlsm" type
  • Fixed: "All fields" type exports at single issues export only a subset of the fields
Upgrading from 2.1.0

Several template files were updated in this release. You can take advantage of all the enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-2.2.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. basic-issue-list-template.xlsx
    2. field-helper-tool.groovy
    3. issue-navigator.groovy
    4. issue-navigator-with-comments.xlsx
    5. issue-navigator-with-history.xlsx
    6. issue-navigator-with-tempo-worklogs.xlsx
    7. issue-navigator-with-worklogs.xlsx
    8. issue-navigator.xlsx
    9. jira-service-desk-report.xlsx
  5. Lean back and have a chocolate.

Two final notes about the upgrade:

  1. If you are also using our super-awesome Better PDF Exporter, we suggest to upgrade that to the 5.6.0 version (or newer) for best interoperability. That app and the Better Excel Plugin are using shared Export menus, and these two versions give you the best experience.
  2. You may eventually see a LinkageError written the Jira log when running Excel automations after the upgrade. See this troubleshooting item for the easy fix.

2.1.0

This version is simply a compatibility release for the Jira 7.2 line.

Upgrading from 2.0.0

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you want to use the app with Jira 7.2.

2.0.0

This release introduces several new features and minor enhancements, that significantly improve the overall experience of creating Excel reports from Jira. The primary driving force behind these improvements was the feedback we received from the user community during the last couple of months. (We take your requests seriously, so keep them coming!)

Built-in Groovy editor

A web-based Groovy editor was introduced, to ease making changes in the Groovy scripts that are executed during exports.

Support for Visual Basic macros and macro-enabled workbooks

Utilize VBA code to enhance your Excel exports with dynamic behavior (format, update, post-process content) and interactions (ex: display alerts).

Learn more in the Visual Basic macros tutorial.

Auto-conversion for all date type fields

All date type system fields (creation date, resolution date, etc.) and custom fields (date picker, date time picker) are automatically transformed to Excel's date representation (sequential serial numbers).
If you used Excel formulas for this conversion with previous app versions, don't forget to check the corresponding part of the upgrade guide.

User export

Use the new export option (disabled by default) to export all user account information from Jira to Excel, for every sort of maintenance and analysis purporses.

Learn more in the exporting Jira users to Excel tutorial.

View names in the "Export" drop-down in any language

View names can now contain alphanumeric characters from any language, from German to Japanese. This was previously limited to the English characters only. Finally, you can offer native language experience for your team.

Additional improvements
  • User-friendly warning message when trying to export more issues than the limit (1000, by default), instead of the non-intuitive "403 error" screen Jira offers by default
  • Correct file extension and MIME type returned for any XLSX, XLSM and XLS template (Internet Explorer will not get confused when facing inconsistent MIME types and file extensions anymore)
  • <mt:autosize> tag can resize rows only, columns only or both, giving you more flexibility in automatic layout optimization
  • Support for the "creator" field
  • Guide for users running non-English versions of Excel covers the differences between localized Excel versions in the context of the Better Excel Plugin (a must-read for anyone running one of those!)
Upgrading from 1.3.0

A new template was introduced to enable exporting user account information, and some existing templates and scripts were improved, too. You can take advantage of these enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-2.0.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. field-helper-tool.groovy
    2. user-export.xlsx
    3. user-export.groovy
    4. workflow-report.xlsx
    5. workflow-report.groovy
  5. To create the corresponding options in the Export dropdowns, go to Excel Views (in the left-side bar) and click Add a new view:
    1. Enter "Users (Excel)" as name, choose the desired type, select the template file user-export.xlsx and click submit.
  6. Go to Issue Navigator, open the Export menu and click the view created in the previous step for testing.
  7. When developing custom Excel templates in previous app versions, date and date-time values required formulas to convert the Java time representation to Excel's time representation. From 2.0.0 this will be automatically done for you by the fieldHelper tool, without using formulas. Therefore, when updating to 2.0.0, you should search and rewrite those formulas in your existing templates, following the instructions below. If you don't have any custom templates, you can skip this step.
    1. Check all your custom templates for expressions similar to this:
      ${fieldHelper.getFieldValue(issue, "customfield_10280")/1000.0/86400.0+25569}
    2. Check also for the null-tolerant version of that expression:
      ${fieldHelper.getFieldValue(issue, "customfield_10280") ? fieldHelper.getFieldValue(issue, "customfield_10280")/1000.0/86400.0+25569 : ""}
    3. Remove the formula part, and simplify that simply to:
      ${fieldHelper.getFieldValue(issue, "customfield_10280")
  8. Lean back and grab a cup of coffee.

1.3.0

Support for Jira Data Center

In a clustered Jira environment, all configuration including Excel templates, Groovy scripts and other resources are transparently replicated among the nodes by the add-on. When exporting, you can access any random node in the cluster to get your Excel spreadsheet.

Therefore, the add-on fully supports Jira enterprise deployments!

Support for Jira 6.2 - 7.0

We extended the range of compatible Jira versions to cover all modern Jira versions.

Changes
  • MIME type is changed to the standard "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", in order not to confuse your browser.
  • If the actor's username is mistyped in an automation rule's configuration, the add-on reports it as WARN in the log.
Upgrading from 1.2.0

Just update your app using UPM (the app manager built in to Jira), that's all.

1.2.0

This version is a compatibility release for the Jira 7 line, also maintaining compatibility with the Jira 6 line. The only functional change is that calculated fields can now be used without creating the corresponding "placeholder custom fields" (it was required in previous versions).

Calculated fields with or without custom fields

From this version, calculated fields can be used without the need to create a matching Jira custom field. Calculated fields are entirely virtual, not necessarily appearing in the Jira configuration, only in the Groovy script that implements them.

Note that you still need to create a Jira custom field for the calculated field, if you want to export that from Issue Navigator. In that context the column represented by the custom field is required for visibility and positioning of the calculated field.

Upgrading from 1.1.0

Only one Groovy script file has been updated for Jira 7.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-1.2.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the file field-helper-tool.groovy from the directory where the ZIP was extracted.
  5. Have some chocolate.

Known and harmless issue: RuntimeException with XlsViewComparator

During the upgrade the following exception may appear in your Jira log: java.lang.RuntimeException: com/midori/jira/plugin/betterexcel/model/XlsViewComparator.

You can safely ignore this. This is caused by a timing problem during the installation, but it has zero effect after being displayed only once, right after the app version upgrade.

1.1.0

This version focuses on bringing more data and better data from Jira to your Excel reports.

Powerful field value formatting

Transform the Jira values to the their best representation in Excel. "Best" can mean different things in different use cases, but this tool will be your best friend in general when briding between Jira fields and Excel cells.

Learn more in the user manual.

Calculated fields

Export fields, which are dynamically calculated during the export, to Excel. These can, for instance, return the issue's last comment, combine the value from multiple fields, connect to an external API, or do any custom computation.

Learn more in the user manual.

Support for Jira Agile, Jira Service Desk and Tempo

Export all data from these popular Jira apps to Excel, and create powerful reports from your sprints, user stories, tickets (Service Desk managed issues) and Tempo worklogs.

See the Integrations page for details.

Upgrading from 1.0.0

Several new templates were introduced, and some existing resources were improved, too. You can take advantage of these enhancements by executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-better-excel-plugin-1.1.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons Excel Templates (under Excel Views).
  4. Upload the following files from the directory where the ZIP was extracted:
    1. basic-issue-list-template.xlsx
    2. field-helper-tool.groovy
    3. issue-navigator.groovy
    4. issue-navigator.xlsx
    5. issue-navigator-with-comments.xlsx
    6. issue-navigator-with-history.xlsx
    7. issue-navigator-with-tempo-worklogs.xlsx
    8. issue-navigator-with-worklogs.xlsx
    9. jira-agile-report.xlsx
    10. jira-service-desk-report.xlsx
    11. tempo-report.xlsx
    12. tempo-tool.groovy
  5. To create the corresponding options in the Export dropdowns, go to Excel Views (in the left-side bar) and click Add a new view:
    1. Enter "Comments (All fields)" as name, select the type "All", select the template issue-navigator-with-comments.xlsx, and submit.
    2. Similarly, create "Comments (Current fields)" with the type "Multiple issues only" and issue-navigator-with-comments.xlsx.
    3. Create "Worklogs (All fields)" with the type "All" and issue-navigator-with-worklogs.xlsx.
    4. Create "Worklogs (Current fields)" with the type "Multiple issues only" and issue-navigator-with-worklogs.xlsx.
    5. Create "Tempo Worklogs (All fields)" with the type "Disabled" (or "All" if you are using Tempo) and issue-navigator-with-tempo-worklogs.xlsx.
    6. Create "Tempo Worklogs (Current f.)" with the type "Disabled" (or "Multiple issues only" if you are using Tempo) and issue-navigator-with-tempo-worklogs.xlsx.
    7. Create "History (All fields)" with the type "All" and issue-navigator-with-history.xlsx.
    8. Create "History (Current fields)" with the type "Multiple issues only" and issue-navigator-with-history.xlsx.
    9. Create "Jira Agile (Excel)" with the type "Disabled" (or "Multiple issues only" if you are using Jira Agile) and jira-agile-report.xlsx.
    10. Create "Jira Service Desk (Excel)" with the type "Disabled" (or "Multiple issues only" if you are using Jira Service Desk) and jira-service-desk-report.xlsx.
    11. Create "Tempo (Excel)" with the type "Disabled" (or "Multiple issues only" if you are using Tempo) and tempo-report.xlsx.
    12. Create "Basic Export (Excel)" with the type "Disabled" and basic-issue-list-template.xlsx.
  6. Go to Issue Navigator, open the Export menu and click each of the views created in the previous step for testing.
  7. Have some chocolate.

Upgrading to this version is necessary if you want more precise export of Jira custom fields, plus export of Jira Agile-, Jira Service Desk- and Tempo data.

1.0.0

After so many months in beta status, we are happy to announce that Better Excel Plugin for Jira is now ready for production use. Starting from this version, Midori offers its usual commercial support also for this product.