EvaluateXQuery

EvaluateXQuery 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Evaluates one or more XQueries against the content of a FlowFile. The results of those XQueries are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. XQueries are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is 'flowfile-attribute'; otherwise, the property name is ignored). The value of the property must be a valid XQuery. If the XQuery returns more than one result, new attributes or FlowFiles (for Destinations of 'flowfile-attribute' or 'flowfile-content' respectively) will be created for each result (attributes will have a '.n' one-up number appended to the specified attribute name). If any provided XQuery returns a result, the FlowFile(s) will be routed to 'matched'. If no provided XQuery returns a result, the FlowFile will be routed to 'unmatched'. If the Destination is 'flowfile-attribute' and the XQueries matche nothing, no attributes will be applied to the FlowFile.
Tags: XML, XPath, XQuery, evaluate
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Destination
Indicates whether the results of the XQuery evaluation are written to the FlowFile content or a FlowFile attribute. If set to <flowfile-content>, only one XQuery may be specified and the property name is ignored. If set to <flowfile-attribute> and the XQuery returns more than one result, multiple attributes will be added to theFlowFile, each named with a '.n' one-up number appended to the specified attribute name
Display Name

Destination

Description

Indicates whether the results of the XQuery evaluation are written to the FlowFile content or a FlowFile attribute. If set to <flowfile-content>, only one XQuery may be specified and the property name is ignored. If set to <flowfile-attribute> and the XQuery returns more than one result, multiple attributes will be added to theFlowFile, each named with a '.n' one-up number appended to the specified attribute name

API Name

Destination

Default Value

flowfile-content

Allowable Values
- flowfile-content
- flowfile-attribute
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Output: Indent
Specifies whether the processor may add additional whitespace when outputting a result tree.

Display Name

Output: Indent

Description

Specifies whether the processor may add additional whitespace when outputting a result tree.

API Name

Output: Indent

Default Value

false

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Output: Method
Identifies the overall method that should be used for outputting a result tree.
Display Name

Output: Method

Description

Identifies the overall method that should be used for outputting a result tree.

API Name

Output: Method

Default Value

xml

Allowable Values
- xml
- html
- text
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Output: Omit XML Declaration
Specifies whether the processor should output an XML declaration when transforming a result tree.

Display Name

Output: Omit XML Declaration

Description

Specifies whether the processor should output an XML declaration when transforming a result tree.

API Name

Output: Omit XML Declaration

Default Value

false

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Allow DTD
Allow embedded Document Type Declaration in XML. This feature should be disabled to avoid XML entity expansion vulnerabilities.
Display Name

Allow DTD

Description

Allow embedded Document Type Declaration in XML. This feature should be disabled to avoid XML entity expansion vulnerabilities.

API Name

Validate DTD

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dynamic Properties

A FlowFile attribute(if <Destination> is set to 'flowfile-attribute'
If <Destination>='flowfile-attribute' then the FlowFile attribute is set to the result of the XQuery. If <Destination>='flowfile-content' then the FlowFile content is set to the result of the XQuery.

Name

A FlowFile attribute(if <Destination> is set to 'flowfile-attribute'

Description

If <Destination>='flowfile-attribute' then the FlowFile attribute is set to the result of the XQuery. If <Destination>='flowfile-content' then the FlowFile content is set to the result of the XQuery.

Value

An XQuery

Expression Language Scope

NONE

System Resource Considerations

Resource	Description
MEMORY	Processing requires reading the entire FlowFile into memory

Relationships

Name	Description
matched	FlowFiles are routed to this relationship when the XQuery is successfully evaluated and the FlowFile is modified as a result
unmatched	FlowFiles are routed to this relationship when the XQuery does not match the content of the FlowFile and the Destination is set to flowfile-content
failure	FlowFiles are routed to this relationship when the XQuery cannot be evaluated against the content of the FlowFile.

Writes Attributes

Name	Description
user-defined	This processor adds user-defined attributes if the <Destination> property is set to flowfile-attribute .