List of Steps

Basic

Log a message

Raises a message event with the message parameter.

Verify

Evaluates the condition parameter. If it is false, a verification failure event is raised.

Wait Until

Waits until the condition parameter is true.

Optional parameters:

  • Max duration - the maximum amount of time to wait (in milliseconds)
  • Re-check frequency - the amount of time between checks
  • Fail on timeout - if true, the step completes with a failure
  • Failure message - the message to report on failure

Wait for N Seconds

Waits for duration seconds.

Conditionals & Looping

If

Executes the child steps if condition is true

Else If

Executes the child steps if condition is true AND if the previous if (or else if) block(s) were not executed.

This step will fail if not used after an if or else if step.

Else

Executes the child steps if the previous if (or else if) block(s) were not executed.

This step will fail if not used after an if or else if step.

While

Executes the child steps repeatedly as long as condition is true. The condition is evaluated prior to executing the child steps.

Repeat Until

Executes the child steps repeatedly until condition is true. The condition is evaluated after executing the child steps - which means the child steps will always execute at least once.

Repeat N times

Executes the child steps count times.

Optional parameters:

  • Counter varname - name of the variable to store the repeat count in. The counters starts at 1.

Structure

Function

Calls the function with id function id.

Optional parameters:

  • Return variable (optional) - name of the variable to store the result returned from the function.
  • Parameters (optional) - a set of name/value pairs to pass to the function.

Group

Executes child steps once. This step does not otherwise affect the execution of the steps - it is intended to help organize and/or document the steps.

Group (scoped)

Much like the Group step, except that the steps run in a new scope, which means they cannot access variables defined in the parent (however, it can access variables defined in project, task and task suite contexts).

Macro

Calls the macro with id macro name.

Return

Returns from a macro or function. MUST be used in a macro or function. Will fail when used directly in a task.

Optional parameters:

  • Return value - a value to return to the calling step (ignored if in a macro).

Variables

Increment Variable

Increments the value of the Name parameter. If the value of the Name parameter is not a number, this step will fail.

Optional parameters:

  • Amount - how much to increment by. Default is 1.

Set Variable

Sets the value of the Name parameter to Value.