Reporting overview

Owned by Nisha Shantilal
Last updated: Jul 24, 2024
4 min read

With the Reports and Timesheets for Jira, powerful and insightful reports can be created in a variety of different formats to suit the needs of every type of Jira user.

This article covers an overview of how reporting works in the add-on and the available features. There are detailed articles on how to create each type of report at the end of this article.

The Designer interface (screenshot below) opens when you navigate to Quick Links > Custom Report on the top navigation bar and also when you click Custom Report from the left Jira menu.

  • Type of Report: The add-on is capable of creating multiple types of reports - List, Matrix, Time Tracking, Chart (Bar, Line, Pie), Hierarchy, Trend, etc. You can change the type by clicking on the Type drop-down. By default “List” is selected

  • Fields List: The fields list in the left panel has all the fields that can be added to the report. The search box on the top of the fields list allows user to search for a particular field by name. This list contains all standard Jira fields, custom Jira fields, calculated fields created using Reports and Timesheets for Jira app. The fields with a symbol are explained in detail here.

  • Issues Search: The designer interface provides “Issues search” filter which uses JQL query to limit the number of issues to be fetched and processed by the report. JQL can be provided by using any of the below methods

    • typed directly

    • pulled from existing Jira favorite filters (if any)

    • created using Appfire’s Custom filter widget

ART_CustomReport_Sections.jpg

  • Once the fields and filters have been added, clicking “Run” button would display the report results in the bottom right pane

  • More actions become available after the report results are displayed - View data, Export, and Share behind the report.

    ART_BarGraph.jpg

  • Share provides the option to Share publicly (Publish), Share internally, Print, Export, and Schedule updates.

When you create a new report, the Share options are disabled. They are enabled based on the actions below.

  • Once you Save the report, the following options are enabled:

    • Share internally

    • Schedule updates

  • Once you Save and Run the report, the following options are enabled:

    • Share publicly (Publish)

    • Print

    • Export

  •  

    • Share publicly (Publish): The report gets published, and a success message is displayed. Refer to Publishing a report.

    • Share internally: The Share report dialog opens. For more information, refer to Sharing reports with other Jira users.

    • Print: Opens the report in print mode.

    • Export: The report is saved in Excel format in the Downloads folder.

    • Schedule updates: This enables you to schedule saved reports so that they are delivered via email to specified recipients at a regular interval/frequency. Refer to Scheduling reports for automated delivery (subscriptions).

  • Field level filters and other settings can be set via the field settings dialog box, accessible via the cog icon on the field name

  • Multiple pages can be added to a report by clicking the “Add Page” button and each page can have it’s own settings accessible via “Page Settings” button

  • Page settings dialog box will differ based on the report type being created. A few examples of different page settings dialog box are shown below

Bar Report page settings dialog box

Line Report page settings dialog box

Links to different types of reports