...
...
SIL Excel Reporting Gadget
The main feature of the SIL Excel Reporting app is the ability to run SIL scripts using the reporting gadget and to export their result to an Excel file. The gadget can be installed in your Jira Dashboard after successfully installing the app is successfully installed.The process of installing and configuring the gadget is described below.
Configuration
The configuration screen is only available to Jira Administrators and System Administrators and allows them to manage the list of available reporting configurations. They can add and delete configurations, edit the parameters or change the security of a reporting configuration.
...
- Name - the name of the configuration
- Execution script - the script that is executed and which writes the Excel report file
Parameter script - an optional script that dynamically inserts advanced parameter fields on the configuration's run screen. If no parameter script is given, the user is able to add simple input fields for text parameters.
These components can be edited in the following screen, after choosing the gadget's edit option is chosen:
The gadget also offers the ability to restrict script usage to specific users or groups by choosing a security option:
Public
- Public - the script is available for any user
...
- Group - the script is available only if the currently logged in user is a member of the specified group (a group picker is displayed)
...
- User - the script is available only if the currently logged in user is the same as the specified one (a group picker is displayed)
...
- Project role - the script is available only if the currently logged in user is in a specific role on a specific project (a project picker is displayed)
After a configuration is successfully editingedited/creating a configurationcreated, you are able to select that configuration and run the associated script.
...
Simple text parameters can be added with a press of by clicking the Add Parameter button.
| Info | ||
|---|---|---|
| ||
To edit the actual scripts, please use the SIL SIL® Manager. |
For more information about the parameter script refer to the Input type routines section of the current documentation.
Usage
Let's assume you have the following parameter script:
...
The report execution script contains the following routine calls in order to retrieve the parameters' values:
...
Once you run the script, the program console will be is displayed
| Tip |
|---|
You can use the runnerLog routine to print info in the console as the program runs. Note that the console buffer is limited to 512 lines every ~0.5 sec and the console will is only display displayed the latest 512 lines. |