Versions Compared

Key

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

Availability

This routine is available starting with Power Scripts™ 3.0.10 (server).

Syntax

runnerLog(message)

or

runnerLog(message, percent, action) 

or

runnerLog(message, treatAsHtml) - (since version 4.6.5)

or

runnerLog(message, treatAsHtml, percent) - (since version 4.6.5)

...

Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

runnerLog(message [, treatAsHtml], percent])
or runnerLog(message [, percent, action])

Package

Alias

Pkg Usage

Description

Excerpt
hiddentrue

Puts the 'message'

...

on the console of a runner gadget.

...

Puts the 'message' on the console of a runner gadget. The use of it has no effect in other places besides for the runner.

Note

Starting with Power Scripts™ for Jira 3.0.10 (server), the runnerLog routine can also render a progress bar by specifying the percent that you want to be set.

Note

The runnerLog routine can be called in the SIL Manager, but also in the Power Scripts SIL Runner Gadget.

Parameters

...

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

message

...

String

Yes

Specifies the message to be put on the runner console

percent

...

Number

No

Specifies the percent to be updated on the progress bar

action

...

String

No

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)

treatAsHtml

...

Boolean

No

Specifies either to show the message as a string, or treat it and render it in the browser as HTML code

...

.

...

Return

...

Type

String

Return value has no meaning and should be ignored.

Examples

Example

...

The scripts would look like this:

execution_script.sil
Code Block
date start_date = gadget_getDateValue(argv, "Start Date");
string tanks = gadget_getSingleValue(argv, "Tanks");
string infantry = gadget_getSingleValue(argv, "Infantry");
string rockets = gadget_getMultiValues(argv, "Rockets");
runnerLog("Preparing to start a war...", 0, "init_progressBar");
runnerLog("The war will start at this date: " + start_date, 10);
runnerLog("Building tanks...");
runnerLog("Built " + tanks + " tanks.", 30);
runnerLog("Gathering infantry...");
runnerLog("Gathered " + infantry + " brave men.", 60);
runnerLog("Fueling rockets...");
runnerLog(rockets + " ready.", 90);
runnerLog("Dispatching orders...", 100);
return "Good job! The world is now at war!";

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

...

Example 2

The following runnerLog routine call:

...

1

Code Block
runnerLog("Hello " + userFullName(currentUsername()) + ". How are you today?");

Returns: Hello John Smith. How are you today?

Example 2

Using HTML as output.

Code Block
runnerLog("<font color='red'>This is a red text!</font>", true);

Will print This is a red text in the runner log:

...

text! (text will be red)

See also

...

SIL™ Manager

...

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "basic_routine" and space = currentSpace ( )
labelsarray_routines