Data validations
Data validation allows you to define rules for your fields, including acceptable value ranges.
Validation Properties
If validate field is set in schema, validation rules will be applied to the field value.
The data type of the field is an array of maps, with expr and action defined.
The action will be evaluated when the expr returns true.
| Property | Type | Scripting Language | Description |
|---|---|---|---|
expr | string | CEL | An expression in CEL Script |
script | string | JavaScript | The JavaScript code to evaluate for validation |
action | string | - | allow or deny |
error_message | string | - | A string of error message to be returned when the validation fails |
Notes:
- The validation rules are evaluated in descending order
exprcannot access the fields provided throughsourceIdassociation
Examples
<span><span style="color: var(--shiki-color-text)">reportNumber </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> {</span></span> <span><span style="color: var(--shiki-color-text)"> type </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"integer"</span></span> <span><span style="color: var(--shiki-color-text)"> validate </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> [</span></span> <span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-comment)">// reportNumber value must be less than 100 or over 103</span></span> <span><span style="color: var(--shiki-color-text)"> {</span></span> <span><span style="color: var(--shiki-color-text)"> script </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"((value, data) => { return value >=100 && value <=103})(_value, _data)"</span></span> <span><span style="color: var(--shiki-color-text)"> action </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"deny"</span></span> <span><span style="color: var(--shiki-color-text)"> error_message </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"reportNumber value must be less than 100 or over 103"</span></span> <span><span style="color: var(--shiki-color-text)"> }</span></span> <span><span style="color: var(--shiki-color-text)"> ]</span></span> <span><span style="color: var(--shiki-color-text)">}</span></span> <span></span>
<span><span style="color: var(--shiki-color-text)">description </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> {</span></span> <span><span style="color: var(--shiki-color-text)"> type </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"string"</span></span> <span><span style="color: var(--shiki-color-text)"> description </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"Description of the product."</span></span> <span><span style="color: var(--shiki-color-text)"> validate </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> [{</span></span> <span><span style="color: var(--shiki-color-text)"> script </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"((value, data) => { return !(value.length < 40)})(_value, _data)"</span></span> <span><span style="color: var(--shiki-color-text)"> action </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"deny"</span></span> <span><span style="color: var(--shiki-color-text)"> error_message </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"Description length should be less than 40 characters."</span></span> <span><span style="color: var(--shiki-color-text)"> }]</span></span> <span><span style="color: var(--shiki-color-text)">}</span></span> <span></span>
<span><span style="color: var(--shiki-color-text)">itemStatus </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> {</span></span> <span><span style="color: var(--shiki-color-text)"> type </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"string"</span></span> <span><span style="color: var(--shiki-color-text)"> validate </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> [{</span></span> <span><span style="color: var(--shiki-color-text)"> script </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"((value, data) => { return Object.keys(user).length === 0 })(_value, _data)"</span></span> <span><span style="color: var(--shiki-color-text)"> action </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"deny"</span></span> <span><span style="color: var(--shiki-color-text)"> error_message </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"You must be logged in to create an item"</span></span> <span><span style="color: var(--shiki-color-text)"> }]</span></span> <span><span style="color: var(--shiki-color-text)">}</span></span> <span></span>
Example demonstrating how to use user attributes
<span><span style="color: var(--shiki-color-text)">itemCode </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> {</span></span> <span><span style="color: var(--shiki-color-text)"> type </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"string"</span></span> <span><span style="color: var(--shiki-color-text)"> validate </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> [{</span></span> <span><span style="color: var(--shiki-color-text)"> script </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"((value, data) => { return !user.attributes.includes(\"{ADMIN_ID}\") })(_value, _data)"</span></span> <span><span style="color: var(--shiki-color-text)"> action </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"deny"</span></span> <span><span style="color: var(--shiki-color-text)"> error_message </span><span style="color: var(--shiki-token-keyword)">=</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">"To create an item, you must be the Admin"</span></span> <span><span style="color: var(--shiki-color-text)"> }]</span></span> <span><span style="color: var(--shiki-color-text)">}</span></span> <span></span>
Accessible variables in expressions
You can use _value to refer to the current field value and _data to refer to the entire record.
| Variable | Description |
|---|---|
_value | This accesses its own field value. |
_data.{other_field_name} | Other fields can be accessed using the field name. ex. foo == 2 accesses foo field |
_data.{array_name}[{index}] | This accesses the array value. ex. arr[0] accesses the first value of arr |
_data.{associative_array_name}.{key_name} | This accesses associative array value. ex. dict.nestedValue accesses the dict associative array's nestedValue key value |
user | This accesses the user context. ex. user.id accesses the logged in user id and user.attributes acessess user's attributes which is an array of UUIDs that are configured in the AttributesFields in the Auth service |
Embedded functions in expressions
| Function | Description |
|---|---|
today() | returns today's date in String, with format YYYY-MM-DD. ex. today() => "2024-07-02" |
currentHHMM() | returns the current time in String, with format HH:MM. ex. "21:37" |
timeHH(int) | returns the hours in int from the provided time. ex. timeHH("1213") => 12 |
timeMM(int) | returns the minutes in int from the provided time. ex. timeMM("1213") => 13 |
startWith(string, string) | returns the Boolean value which is the result of string prefix match. ex. startWith("hello world", "hello") => true |
endWith(string, string) | returns the Boolean value which is the result of string suffix match. ex. endWith("hello world", "world") => true |
length(string) | returns the int which is the length of the string. ex. length("12345") => 5 |