In this page

Configuring app logging

In case of troubles, the most important is to increase the app's logging level so that it can write out more details about what it is doing.

To increase the logging level:

  1. Login to Jira as administrator.
  2. Go to Jira AdministrationSystemLogging and Profiling.
  3. Click Configure logging level for another package under Default Loggers.
  4. Enter "com.midori" to Package Name and choose "DEBUG" in Logging Level. (You can alternatively choose "TRACE", the most detailed logging level, but it may produce a very high number of log entries.)
  5. Click Add.
  6. Check if this new package was correctly added to the Default Loggers list.

Now execute the app function that you think fails, and check your Jira log to see the details.

If you can't understand the log lines, report what you have found to our support. We are there to help you.

Logging on cell level

Sometimes during troubleshooting you need see what is inserted to what cell and what beans are available in the rendering context at that moment.

In this case, just increase the logging level to "TRACE" (see above). With this, at each cell two entries will be added to the log, one before processing the cell and one after that:

Processing cell "Issue Navigator!A5" (issue=..., column=...) with old value: ... (beans: ...)

Cell "Issue Navigator!A5" set to new value: ...

Please note that if the output file is rendered to N cells, then this alone will produce 2*N log entries, obviously. Therefore this is strongly suggested to set the logging level back to at least "DEBUG" after cell level logging is not needed any longer.

Typical problems and their solutions

I cannot export more than 1000 issues in one turn.

To prevent overloading the server, Jira exposes a limit on the number of issues that can be exported in one go. The Better Excel Exporter fully obeys this limit.

The limit is set to 1000 by default, but can be overridden by editing the configuration settings in jira-config.properties:

  • jira.search.views.default.max This is the default soft limit. Soft means that this value will be automatically added as an URL parameter called tempMax to each export request. You can manually increase the default value by changing the URL in your browser's address bar, or even remove the tempMax request parameter from the URL. You cannot exceed the value defined by the next configuration setting this way.
  • jira.search.views.max.limit This is the absolute hard limit. You cannot set tempMax to values greater than this, as you will get a 403 HTTP error. However, you can grant some users the permission to even break this limit - see next setting!
  • jira.search.views.max.unlimited.group If you select a group here, any of its members can export an unlimited number of issues. Note that you still need to override the tempMax URL parameter by hand. Also be careful, as these users will be potentially generate huge load on the server.

For more detailed explanation of these settings, please consult the official Atlassian documentation.

I get "Cannot open PivotTable source file..." error when I open the exported Excel file.

This problem can happen when the export contains a pivot table or pivot chart. Pivot tables and pivot charts have a reference to the input named range. If this reference is prefixed with the template's(!) filename and the output filename is different (which is very likely), then the reference is broken in the output file. We noticed that Excel sometimes is trying to be smart and inserts that prefix in the background for whatever reason.

To solve this, follow these steps:

  1. Open your template in Excel.
  2. Go to FileInfo screen.
  3. Click the Allow this information to be saved in your file link under Inspect Workbook section.
  4. Click inside a pivot table.
  5. Select Pivot Table ToolsAnalyzeChange Data Source.
  6. If the Table/Range field contains the filename as prefix, remove that (e.g. change 'my-template.xlsx'!issues to issues).
  7. Repeat the previous steps for all pivot tables.
  8. Save the file.
  9. Upload the file to your templates in Jira.
  10. Try another export.

I get "java.lang.LinkageError: com/midori/jira/plugin/commons/util/RenderingResult" when Excel automation actions are executed.

This is a defect in Jira's OSGi class loading mechanism that should happen only on Jira 6.x, when you have multiple of our products installed. It should not occur in Jira 7.

To fix:

  1. Uninstall all the following Midori products (if you have them installed): Better PDF Exporter, Better PDF Automation, Better Excel Exporter, Better Excel Automation. (Disabling them is not sufficient!)
  2. Install the apps (only those that you had installed previously) strictly in this order:
    1. Better Excel Exporter
    2. Better Excel Automation
    3. Better PDF Exporter
    4. Better PDF Automation

Questions?

Ask us any time.