Skip to main content Skip to complementary content

CondValidateReport

Conditionally reports on a validation result.

The CondValidateReport function is used to report some kind of validation problem, for example if a value is not within certain limits. It can be called in any type of expression. The report is done to the results of the execution of the map, which is shown through the GUI or can be accessed using the runtime API.

This function is typically used as the root of a validation expression to provide richer reporting of a validation problem. A validation expression accepts a Boolean value, if true, the validation succeeds and nothing is reported, if false, the validation fails.

Arguments

Condition Specify the condition for the validation to succeed. If it is true, the function does nothing. If it is false, the function reports a validation result. The value of this condition is also returned as the value of this function.
Data Specify the data to be associated with the validation report. These are reported as name/value pairs in the validation report.

For example, if you use a map element in this argument, the report will return the name of the element and its value.

You can set a name and value using the Property function.

Properties

Message Enter a message describing the validation issue.
Severity Select the severity of the validation issue which is either informational, warning, or error.
Number Enter a number that identifies the validation issue.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!