Report Builder

Create Tailored Reports Effortlessly with Jira Assistant's Dynamic Report Builder

Report Builder

"Report Builder" empowers users with technical proficiency to craft their own reports, spanning from simple to advanced. This module supports a range of functionalities, including input validation, JQL execution, data processing, and data representation, enabling tailored report creation.

Some of the prominent features supported by Report Builder include:

  • Parameters: Users can include parameters of various data types such as date, date range, text, numbers, etc. These parameters allow users to input values while generating the report.
  • JQL Execution: Users can execute one or more JQL queries in Jira, utilizing the retrieved data to generate comprehensive reports.
  • UI Components: Drag-and-drop various UI components like Tables, Images, and Charts onto the report, configuring them to display the processed data.
  • Table Functionality: The Table UI component supports the creation of column and row groupings based on records.
  • Custom Menus: Similar to Jira Assistant's gadgets, users can add custom menus to grids within the report.


Parameters play a pivotal role in user interaction, enabling input for the report. Parameters support multiple input forms, including text boxes, numeric inputs, dropdowns, autocompletes, date selections, boolean checkboxes, user groups, and even file selections.

Parameters can be set as mandatory or optional, with the option for default values that are automatically populated. When a parameter is added to a report, it can be utilized within expressions across the report. To incorporate parameters in expressions, employ the syntax Parameters.paramName.value, where "paramName" corresponds to the parameter's name.

For JQL datasets, parameters often need to be incorporated into the JQL. The following syntax is employed for this purpose:@Parameters.paramName.value$. As parameter values are accessible only during report generation, not during design, you can assign a default value that functions at both design and generation stages using@Parameters.paramName.value|someDefaultValue$.


Expressions play a pivotal role in customizing data appearance, conversion, and formatting within reports. Learn more about expressions.

Global Fields

Global fields encompass constant values that can be integrated into expressions across various components. These fields are divided into two categories: Report Fields and Report State:

Report Fields are inherent fields provided by Jira Assistant, mainly containing user configurations like date formats, which can be utilized for data formatting or validation.

Report States are user-defined fields added either as constant values or expressions derived at runtime. Users have the freedom to store various types of data in these fields. Report states can be integrated into expressions using the syntax ReportState.propName.


Datasets consist of collections of data stored as JavaScript objects. This data source can be employed by tables to organize data in a tabular format, including groups, and can also be used by expressions to extract specific values. Datasets can be sourced from various origins such as HTTP requests, files, expressions, JQL, etc.

A dataset might include row groups, column groups, variables, and data. Once a dataset is assigned to a specific group within the table, you can access the data within rows/columns under that group. You can use RowGroupto access row groups and similarly use ColGroup and Variableswithin expressions in group rows/columns.

Note: For more information, please refer to the expressions section. When using JQL datasets, parameters can also be integrated into your JQL queries. Refer to the parameters section for further details.

Report UI Components

Report items are the visual elements which is the core UI component of the report. You can drag and drop any report item to the display section of the report and customize it later.

Click here to know more about individual UI components currently supported by report builder.


Report builder allows the user to store some static files like images along with report so that those resources can be used while rendering of the report. This could be primarily useful to add banner images, or static data in CSV or JSON formats, etc.