ValidateJson

ValidateJson 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Validates the contents of FlowFiles against a configurable JSON Schema. See json-schema.org for specification standards. This Processor does not support input containing multiple JSON objects, such as newline-delimited JSON. If the input FlowFile contains newline-delimited JSON, only the first line will be validated.
Tags: JSON, schema, validation
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

JSON Schema
A URL or file path to the JSON schema or the actual JSON schema content
Display Name

JSON Schema

Description

A URL or file path to the JSON schema or the actual JSON schema content

API Name

JSON Schema

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [SCHEMA_CONTENT_PROPERTY]
JSON Schema Registry
Specifies the Controller Service to use for the JSON Schema Registry
Display Name

JSON Schema Registry

Description

Specifies the Controller Service to use for the JSON Schema Registry

API Name

JSON Schema Registry

Service Interface

org.apache.nifi.schemaregistry.services.JsonSchemaRegistry

Service Implementations

org.apache.nifi.schemaregistry.services.StandardJsonSchemaRegistry

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [SCHEMA_NAME_PROPERTY]
JSON Schema Version
The JSON schema specification
Display Name

JSON Schema Version

Description

The JSON schema specification

API Name

JSON Schema Version

Default Value

DRAFT_2020_12

Allowable Values
- Draft 4
- Draft 6
- Draft 7
- Draft 2019-09
- Draft 2020-12
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [SCHEMA_CONTENT_PROPERTY]
Schema Access Strategy
Specifies how to obtain the schema that is to be used for interpreting the data.
Display Name

Schema Access Strategy

Description

Specifies how to obtain the schema that is to be used for interpreting the data.

API Name

Schema Access Strategy

Default Value

SCHEMA_CONTENT_PROPERTY

Allowable Values
- Schema Name Property
- JSON Schema Property
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Name
Specifies the name of the schema to lookup in the Schema Registry property
Display Name

Schema Name

Description

Specifies the name of the schema to lookup in the Schema Registry property

API Name

Schema Name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [SCHEMA_NAME_PROPERTY]

System Resource Considerations

Resource	Description
MEMORY	Validating JSON requires reading FlowFile content into memory

Restrictions

Required Permission	Explanation
reference remote resources	Schema configuration can reference resources over HTTP

Relationships

Name	Description
valid	FlowFiles that are successfully validated against the schema are routed to this relationship
invalid	FlowFiles that are not valid according to the specified schema are routed to this relationship
failure	FlowFiles that cannot be read as JSON are routed to this relationship

Writes Attributes

Name	Description
json.validation.errors	If the flow file is routed to the invalid relationship , this attribute will contain the error message resulting from the validation failure.