"Report Builder" can be used by users with some technical knowledge to develop their own report. Using report builder module, almost any kind of simple to advanced reports can be developed. It supports getting various type of input from users, adding validation on input parameters, execute one or more JQL using the input parameters and get data from Jira, process the data in a way you would use it and display it as report.
Some of the features supported by Report Builder are as follows.
- Parameters with different datatypes like date, daterange, text, numbers, etc. can be add and user can input the value at the time of generating the report
- One or more JQL query can be executed in Jira and data can be used to generate report.
- One or more UI components like Table, Images, Charts, etc., can be dragged and dropped to report and configure it to represent the data.
- Table UI component allows you to create column and row grouping based on records.
- You can also add custom menus to grid similar to how gadgets in Jira Assistant contains it.
Parameters are the primary way through which users interact with report to provide input to the report. Parameters support input through multiple type of form fields like textbox / masked text or numeric input through textbox, selection of items through dropdown or autocomplete, date or date range selection through calendar, boolean value checkbox, user groups, and selection of file as well.
Parameter can be mandatory or non mandatory and can have default values as well which would be automatically populated. If a parameter is added to a report, then it can be used in any expressions within the report. To use a parameter in expressions use Parameters.paramName.value. The "paramName" would be name of the parameter you provide while creating the parameter.
Most of the times, while you add JQL datasets, you may need to use report parameter values in JQL. Hence you would be able to use parameters as well in JQL instead of hardcoded values. To use parameters in JQL use the following syntax:@Parameters.paramName.value$. As parameter values are always available only while running the report and not at design time while you create a report / adding dataset, you may need to provide default value for parameter along with JQL which would be used used at design time and while report generation, value provided by user is used. To provide default value along with parameter use the following syntax: @Parameters.paramName.value|someDefaultValue$.
Expressions can be used to customize the appearance and convert / format the data the way you would like it to appear in reports. Please click here to know more about expressions
Global fields are some of the constant values which can be used in expressions of any components. These fields are further classified as Report fields and Report state:
Report fields are built-in fields provided by Jira Assistant which would primarily contain the user configurations like date formats, etc which can be used to format data or for other validations.
Report states are user defined fields added by users either as a constant value or can be expressions which is derived at runtime. It is up to the user what kind of data is stored in these fields. These fields can be used in any other expressions. Report states can be used in expressions using the following syntax: ReportState.propName.
Dataset may contain, row groups, column groups, variables and data. Once you assign a dataset to a specific group under the table, you will be able to access those data from within the rows / columns under that group. To access the row group you may use RowGroup and similarly you can use ColGroupand Variables from within the expressions inside the group rows / columns.
Note:To know more about it, please visit expressions. While using JQL dataset, you may also make use of parameters in your JQL. Refer parameters section to know more.
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.