Summary

Edit checks which return false result in an error message being displayed to the user. By default this is the error message configured in this field on the edit check:

For more complex it checks it may be useful to display a more specific error message. This is possible using the customError

Using customErrorMessage from an Edit Check

This feature is available starting in ClinSpark 1.5.3. Customers can NOT use the customErrorMessage function in prior versions; the edit check will fail if attempted.

Please watch this walkthrough to see customErrorMessage in action:

Here is the example shown in the walkthrough:

var value = itemJson.item.value;

var ret = false;
if (value == 0) {
    // just display the default error message.
} else if (value == 1) {
    customErrorMessage("The value is 1, but needs to be at least 3!");
} else if (value == 2) {
    customErrorMessage("Still not quite large enough...");
} else if (value >= 3) {
    ret = true;
}
return ret;