Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This article covers an overview of how reporting works in the add-on app 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 Reporton the top navigation bar and also when you click Custom Report from the left Jira menucreate a report using a template or build one from scratch.

  • Type of Report: The add-on app 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 (info) symbol are explained in detail here.

Under certain field groups, click More to view the complete list of fields. This opens a dialog displaying all fields related to the selected field group.

Fields_more.jpgImage Added
  • 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

...

...

  • To save the report, click Save. The Save report dialog opens, and you can provide the name, category, and description.

    Save report dialog.jpgImage Added
  • After saving the report, you can edit the report name, category, and description further by clicking Edit ((blue star) ) next to the report name.

  • 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.

    ART_Report_Share.jpg

...

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

    ART_created_settingsdialog.jpg
  • 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