Versions Compared

Key

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

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.The process of installing and configuring the gadget is described below.

...

  • Name - the name of the configuration
  • Execution script - the script that will be is executed and which will write writes the Excel report file
  • Parameter script - an optional script that will dynamically insert inserts advanced parameter fields on the configuration's run screen. If no parameter script is given, the user will be is able to add simple input fields for text parameters.


...

          Public - the script will be is available for any user

          Group - the script will be is available only if the currently logged in user is a member of the specified group (will display a group picker is displayed)

          User - the script will be is available only if the currently logged in user is the same as the specified one (will display a user group picker is displayed)

  Project role - the script will is available only if the currently logged in user is in a specific role on a specific project (will display a project picker is displayed)


After successfully editing/creating a configuration, you will be are able to select that configuration an and run the associated script.

...

For a configuration having no parameter script we will have the following appearanceit will look like this:

Simple text parameters can be added with a press of the Add Parameter button.

...

For more information about the parameter script refer to the Input type routines section of the current documentation.

Usage

Let's assume we you have the following parameter script:

...

The report execution script will contain contains the following routine calls in order to retrieve the parameters' values:

Code Block
titleExecution script (I)
string templateFile = gadget_getSingleValue(argv, "Template file");
string sheetName = gadget_getSingleValue(argv, "Sheet name");
date startDate = gadget_getDateValue(argv, "Start Date");

We will You use these values further in the execution script for setting up the template and worksheet:

...

Once you run the script, the program console will be 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 only display the latest 512 lines.

...