Versions Compared

Key

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


Info
titleAvailability

This routine is available starting with Power Scripts 3.0.10


Syntax

runnerLog(message)

or

runnerLog(message, percent, action)(starting with Power Scripts 3.0.10) 

Description

Puts the message 'message' on the console of a runner gadget. This is a special routine making sense only in Power Scripts for Jira/SIL Excel Reporting and only for the runner. The use of it has no effect whatever besides for the runner.

Note

Starting with Power Scripts for Jira 3.0.10, runnerLog routine can also render a progress bar by specifying the percent we want to be set.


Parameters

ParameterTypeRequiredDescription
messagestringYesSpecifies the message to be put on the runner console
percentnumberNoSpecifies the percent to be updated on the progress bar
actionstringNo

Specifies the action to be executed (so far, the only action

considered is init_progressBar - to initialize the progress bar;

everything else will be ignored)

Return type

string, can be always ignored


Example

The scripts would look like below:

...

In this case, using the new runnerLog routine, when the script execution is done, the runner will look like this:

 

See also