Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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.

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 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);

This is a red text! (text will be red)

See also

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