FieldCheck parameters
field : [string] (default:
'') Name of field to check. The * name is a special case. Is used to check for extra fields. In this case you must have a rule for each allowed field name and then a rule containing * as name. The severity_missing is applied if the component contains extra fields.regex : [string] (default:
'') Regular expression to match the field content. Note that technically we do a search, not a match.regexp : Alias for regex.
exclude_filter: [string | list(string)] (default:'_null') Name of the filter to exclude components from processing.numeric_condition: [string] (default:'none') (choices: “>”, “>=”, “<”, “<=”, “=”, “none”) Convert the group 1 of the regular expression to a number and apply this operation to the numeric_reference value.numeric_reference: [number] (default:0) Value to compare using numeric_condition.severity: [string] (default:'error') (choices: “error”, “warning”, “info”, “skip”, “continue”) Default severity applied to various situations. The error will stop execution.
The warning and info will generate a message and continue with the rest of the tests.
In the skip case we jump to the next component.
Use continue to just skip this test and apply the rest.severity_fail_condition: [string] (default:'default') (choices: “error”, “warning”, “info”, “skip”, “continue”, “default”) What to do when the numeric_condition isn’t met. Default means to use the severity option.severity_missing: [string] (default:'continue') (choices: “error”, “warning”, “info”, “skip”, “continue”, “default”) What to do if the field isn’t defined. Default means to use the severity option.severity_no_match: [string] (default:'default') (choices: “error”, “warning”, “info”, “skip”, “continue”, “default”) What to do when the regex doesn’t match. Default means to use the severity option.severity_no_number: [string] (default:'default') (choices: “error”, “warning”, “info”, “skip”, “continue”, “default”) What to do if we don’t get a number for a numeric_condition. Default means to use the severity option.