Home

Welcome to the Assurance Validations wiki! Here you'll find resources to help you understand and write validations for your Assurance sessions!

Frequently Asked Questions

What is a validation?
A single function with the intent to validate one thing and one thing only. Each function receives the events in an Assurance session. You can write functions to validate your client configuration, event conditions, tests and use cases.

How do I write a validation?
See Writing a Validation Function.

How can I test a validation?
See Using the Validation Editor.

Are there some examples of validations?
See the index.js files in the plugins directory.

What do the Assurance events look like?
You can get a good sense of what events look like by viewing events in the Raw Event section of the Events view in your Assurance session. You can also try Using the Validation Editor and console.log(events) and open your browser's developer console. Additionally, you can look at our Assurance Toolkit library. This project has several of common schemas and helper functions for some of our common event structures. You can also review the top level structure of events in the Event Definitions page.

Where do the validation results go?
The Assurance UI will load validations into an iFrame and collect the results for each function. The results are then published to all views via the receiveValidation API. This is how the Validation Summary view collects and displays the results of validations. Each view can implement the API and choose to display validation results relevant to its context.

Can I turn off validations?
Yes. See Validation Settings.