Statements

trace

trace prints the zero or more comma-separated parameters that you pass it to the audit log. Administrator- and Developer-level users can access the audit log on the Backoffice site on the Dev console>Log screen. To display a trace message, click on the more button in the Info column of a workflow script entry on the log screen.

statementSample.rfs
trace "Hang on to your hat, here we go!";

Figure 304. The trace message displayed in the task log

Block statement

Use curly braces {} to group zero or more statements together into a block. The statements inside a block will be executed in sequential order.

Note that curly braces can also instantiate map literals.

The workflow script language is lexically scoped, and a block defines a scoping boundary. Variables that you declare inside a block will be accessible only inside the originating block and its nested blocks, but not outside it.

The body of a workflow script must be a single block of statements.

The statements inside a block need to be separated by semi-colons (;).

statementSample.rfs

{
  trace "This is the parent block";
  {
    trace "A child block with a trace statement,
          and a variable";
    var foo ="bar";
  }
  trace "The variable is not available
        outside the originating block";
  /* This would throw a
  'Reference to undefined variable...' exception at runtime
  trace foo; */
}

Value assignment

Use the assignment operator - a single equal sign (=) - to set the value stored in a new or existing variable, assign a new value to a key in a map or an item in a list.

statementSample.rfs

var a = map.New(); // variable assignment
trace a;
a.SetAt("sampleKey", "Your value here");
trace a.sampleKey;
a.sampleKey = "New value here."; // value re-assignment
trace a.sampleKey;
a = list.New(); // variable re-assignment
trace a; // the variable a now points to a list

{}
"Your value here."
"New value here."
[]

Figure 305. The trace message output of the script above

foreach

Using the foreach statement, you can start a loop to iterate over items in a list, and execute a specific statement on each of them.

foreach (var iterator-name in list-name) statement-to-execute;

Parameter	Description
iterator-name (required)	The name of the iterator variable for the loop.
list-name (required)	Name of the list that the loop iterates over.
statement-to-execute (required)	The statement or block of statements to execute for each item in the loop.

The script below adds up the numbers from 1 to 5.

statementSample.rfs

var numbers = [1, 2, 3, 4, 5];
var sum = 0;
foreach (var number in numbers) sum = sum + number;
trace sum; // 15

for

Using the for statement, you can start a loop that executes a statement until a preset condition is met.

for(var iterator-initialization; condition; iterator-statement) loop-body;

Parameter	Description
iterator-initialization (required)	A variable assignment expression to declare and initilaize a counter variable for the loop.
condition (required)	A `bool` value expression that is evaluated before each loop iteration. The statement parameter is executed only if it evaluates to `true`.
iterator-statement (required)	A statement evaluated at the end of each loop iteration.
loop-body (required)	A statement or block of statements that is executed in each iteration as long as the condition parameter evaluates to `true`.

The sample below will trace the numbers from 1 to 10 to the console.

statementSample.rfs
for(var i = 1; i <= 10; i = i + 1) trace i;

Figure 306. The trace message output of the script above

continue and break

Both of these statements are allowed only inside for and foreach statements.

When the execution environment hits the continue statement in a loop statement, it stops the execution of the statements in the loop's current iteration, and continues with the loop's next iteration.

statementSample.rfs

for( var i = 1; i <= 10; i = i + 1 )
  {
    if(i == 3) continue;
    trace "Your number is ", i;
  }

"Your number is ", 1
"Your number is ", 2
"Your number is ", 4
"Your number is ", 5
"Your number is ", 6
"Your number is ", 7
"Your number is ", 8
"Your number is ", 9
"Your number is ", 10

Figure 307. The loop ignores the iteration where the continue condition is met

When the execution environment hits the break statement in a loop statement, it stops the execution of the loop's current iteration, and skips any further iterations. Execution continues with the first statement after the loop.

statementSample.rfs

for( var i = 1; i <= 10; i = i + 1 )
  {
    if(i == 3) break;
    trace "Your number is ", i;
  }
trace "Here we are, after the loop.";

"Your number is ", 1
"Your number is ", 2
"Here we are, after the loop."

Figure 308. The loop ignores every iteration including and after the one where the break condition is met

if

Use the if statement to have a specific statement execute only if a preset condition is met. You can have a second statement be executed if the preset condition evaluates to false, or set up a series of conditions and associate a different statement with each one.

if (condition) statement(else statement)?;

Parameter	Description
condition (required)	A `bool` value expression that determines whether the statement parameter following it is executed or not.
statement (required)	A statement or block of statements that is executed only if the condition parameter evaluates to `true`.

The sample below will trace an exclamation only if the user enters a number below 5 in the myNumber numberbox.

dummy.fls.xml

...
<numberbox id="myNumber"
  numberFormat='{decimalSeparator: "."}'
  label="Enter a number"
  float="false"/>

statementSample.rfs

var myNumber = form.myNumber.number;
if (myNumber < 5) trace "OMG number!";

The script below will trace a different string to the console if the earlier condition is not met.

dummy.fls.xml

...
<numberbox id="myNumber"
  numberFormat='{decimalSeparator: "."}'
  label="Enter a number"
  float="false"/>

statementSample.rfs

var myNumber = form.myNumber.number;
...
if (myNumber < 5) trace "OMG number!";
else trace "So amount!";

The script below will trace one of three statements to the console depending on the user input.

statementSample.rfs

var myNumber = form.myNumber.number;
...
if(myNumber > 0 && myNumber < 5) trace "OMG number!";
else if(myNumber > 6 && myNumber < 10) trace "So amount!";
else trace "Such much!";

Developer Documentation

Language basics