JSON Validator

Usage

For an input message provided in JSON format, the JSON Validator checks the validity according to a JSON schema which must be available via an URI or stored within the JSON Validator.

If the input message is valid, it is passed as output message to the subsequent module of the JSON Validator.

Otherwise, the output message contains a Validation section with error messages and an element with the original input message.

You can use the error branch to handle validation errors, refer to Using Modules as Error Branches.

Depending on the JSON schema size and the location where the file can be accessed, the JSON Validator module can have a negative impact on the INUBIT Process Engine’s performance.

To minimize this impact, you should save the schema locally instead of making it available via a Web server or an external address (such as HTTP or FTP).

Prerequisites

A JSON schema is available in the INUBIT Repository or has been added to the JSON Validator.

Refer to RFC 4627

Dialog JSON Validator Properties

This dialog offers the following options:

Use external JSON Schema
- URI
  
  To specify the location of a JSON schema, e.g. a file on a remote server or in the INUBIT Repository.
  - Activate the URI checkbox and enter the name of a file on a remote server.
  - Activate the URI checkbox and click the button to choose a file previously saved to the INUBIT Repository.
    
    Click the icon to test the URI. If the URI is correct and can be resolved, an information window opens. Otherwise, an error message is displayed.
Static file

To specify a schema file saved on the file system or a file server.
- Click the icon to open the schema file and add it to the JSON Validator.
  
  During the upload, the schema file itself is validated.
  
  If the schema file could be uploaded successfully, two additional read-only fields are added below displaying the file size and the data type.
- Click the icon to remove the schema file.
- Click the icon to save the schema file previously added to the JSON Validator to the file system.
Further settings
- Use error branch as output for validation errors
  
  Activate this checkbox to use the error branch if the validation fails, refer to Using Modules as Error Branches.