ValidateXml
Description
Validates XML contained in a FlowFile. By default, the XML is contained in the FlowFile content. If the 'XML Source Attribute' property is set, the XML to be validated is contained in the specified attribute. It is not recommended to use attributes to hold large XML documents; doing so could adversely affect system performance. Full schema validation is performed if the processor is configured with the XSD schema details. Otherwise, the only validation performed is to ensure the XML syntax is correct and well-formed, e.g. all opening tags are properly closed.
Tags
schema, validation, xml, xsd
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Schema File | Schema File | The file path or URL to the XSD Schema file that is to be used for validation. If this property is blank, only XML syntax/structure will be validated. Supports Expression Language, using Environment variables. | ||
| XML Source Attribute | XML Source Attribute | The name of the attribute containing XML to be validated. If this property is blank, the FlowFile content will be validated. Supports Expression Language, using Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| invalid | FlowFiles that are not valid according to the specified schema or contain invalid XML are routed to this relationship |
| valid | FlowFiles that are successfully validated against the schema, if provided, or verified to be well-formed XML are routed to this relationship |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| validatexml.invalid.error | If the flow file is routed to the invalid relationship the attribute will contain the error message resulting from the validation failure. |
State Management
This component does not store state.
Restricted
| Required Permission | Explanation |
|---|---|
| reference remote resources | Schema configuration can reference resources over HTTP |
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
| Scope | Description |
|---|---|
| MEMORY | While this processor supports processing XML within attributes, it is strongly discouraged to hold large amounts of data in attributes. In general, attribute values should be as small as possible and hold no more than a couple hundred characters. |