Each supported data type in BRIX has its own value formats, which are described in the BRIX Public API documentation. To ensure that the information saved during business processes is correct, the data is validated to make sure it matches the required format and that all required fields are filled in.
System data validation applies in the following cases:
- When running scripts in business processes:
- In the Script activity.
- In a gateway, if transition routing uses a system variable calculated by a script.
- In a custom script process activity.
- When calling API methods used to:
- Start a business process.
- Change process instance context.
- Complete a task.
How validation errors are handled
If an invalid value is passed to a script or API method:
- In system versions 2026.4 through 2026.7, data is saved, and the error is logged in the processor service log.
- Starting with version 2026.8:
- For scripts, process instance execution terminates, and the error appears in Error monitor.
- For API methods, the action is not executed, and an error response is returned.
Data validation example
Suppose a customer order from an external system triggers a business process in BRIX via API. When processing the request, input data for the method call is validated. For example, if non-existent subtypes are specified for Phone number, Email, or Account fields:
- In system versions 2026.4 through 2026.7, the process starts, and a validation error is recorded in the processor service log.
- In version 2026.8 and later, the process does not start to prevent saving invalid data.
Troubleshooting validation errors
If data validation errors occur:
- Identify where invalid data is passed from for script execution or API method calls.
- Check that required fields are completed.
- Make sure all values use the correct format.