Checkpoint verifies some condition→, records the comparison, and fails the test instance if necessary. Along with Check→ it is a key function in writing monitors and test with TestPlan.

# Generic
Checkpoint condition

# Compare two numbers
Checkpoint numComp 13 = %Response://item[@value]%

When a checkpoint condition fails the current script and Logical Root→ will be marked as failed. The script does not normally continue beyond the failed checkpoint.

Options

For high-level monitors a few extra parameters are available to produce more meaningful error messages. If not specified standard messages will be generated from the condition being checked.

They can be added to the function call with the normal with→ syntax.

FailMsg and PassMsg

This allows a specific message to be written when the checkpoint fails or passes. This can often help a support person quickly understand the problem.

OmitLoc

Normally the location of the checkpoint will be recorded along with the checkpoint message. If this is not desired then OmitLoc can be set to true.

Checkpoint ! timeout %Timer% 10m with
  %FailMsg% I've waiting 10 minutes, but the page just didn't update correctly.
  %OmitLoc% true
end