XML Parser Stage
The XML parser stage parses whole XML documents by default, but it can also be configured to parse only specific nodes without loading the entire document into memory. It can also split an XML document into multiple documents. XPATH-like expressions are used to select specific nodes to parse, such as /posts/row
or /posts/record
. Nested XML elements are flattened.
To create new documents from selected elements, configure rootPaths
.
Note
|
The XML Transformation index pipeline stage is deprecated in favor of this parser stage. |
Tip
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
XML stage-specific properties
Property | Description, Type |
---|---|
enabled
Enable this Parser Stage |
type: default value: ' |
errorHandling
Error Handling |
type: default value: ' enum: { ignore log fail mark } |
id
Parser ID |
type: default value: ' |
inheritMediaTypes
use default media types for this Parser Stage |
Indicates if parser stage should use the default media types. Unchecking this box means that ONLY the manually configured media types will be parsed by the parser and you then MUST provide at least one media type. type: default value: ' |
listHandling
XML List handling |
Create a single multivalued field containing all items, or a separate index-numbered field per list item? type: default value: ' enum: { multivalued index_numbered } |
maxSize
Maximum output size for each document |
Maximum number of XML characters, excluding extra whitespace, that will be processed from each source document node to produce an output document type: default value: ' |
mediaTypes
Media Types for this Parser Stage |
type: |
outputFieldPrefix
Prefix parsed fields with |
Fields extracted by this parser will be prefixed with this string. The remainder of the field name will be as detected in the stream type: maxLength: 20 pattern: ^$|^[A-Za-z_][A-Za-z0-9_\-\.]+$ |
pathPatterns
File names to parse |
Specify a file name or pattern that must be matched for this parser stage to run. Forward slashes ("/") are used to join names of files inside archives with the archive name. type: object attributes: { } |
rootPaths
Root paths |
Read XML elements that can be found on specified XML paths and parse them into separate documents type: default value: ' |
type
required |
type: default value: ' enum: { xml } |