HTML Reports
- Jonathan Muse
- Shane Smith
The HTML reports give you a lot of possibilities and flexibility. You can generate and customize any type of report with the help of the SIL™ Template language . Basically, as its name suggests, you are building your report based on a html template and injecting your data using Simple Issue Language™ (SIL) syntax.
Configuring SIL Reporting Gadget
First you need to add the SIL Reporting Gadget to your dashboard. To do that, click Add new gadget. In the Add new gadget dialog, click Load all gadgets. Search for the SIL Reporting Gadget and add it to your dashboard.
To see more instructions about adding a gadget to your dashboard see Atlassian documentation.
The configuration screen is only available to Jira Administrators and System Administrators.
To configure the gadget you have to select the SIL™ script file and add the default values for the parameters used in the selected script.
The parameters will be passed into the program using the argv variable. The values will be available using a construct like argv["parameter_name"] or argv[position]. For the above example, the project can be retrieved using argv["project"] or argv[0].
First the gadget will run with the default values for the parameters, if the values for those parameters were specified in the gadget configuration.
Once you save the gadget configuration, the report will be displayed.
The template script needs to have the ".tpl" extension in order for the report to be executed correctly.
If you want to return information about another project without having to configure the gadget, all you have to do is add a field for the project using one of the functions for creating fields from gadget functions. After that you will be able to set parameter in the parameter section and run the report with the new value.
