> ## Documentation Index > Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt > Use this file to discover all available pages before exploring further. # XML > Parser stage configuration specifications export const schema = { "type": "object", "title": "XML", "description": "Parses XML content with support for document splitting via XPath root paths, attribute extraction, and nested element handling. Splits large XML files into multiple documents based on specified element paths and preserves hierarchical structure and attributes. Supports configurable output limits and list handling strategies for repeated XML elements.", "required": ["type"], "properties": { "id": { "type": "string", "title": "Parser ID", "default": "fe65e827-62ff-4bf0-a0ec-77e184f365c0" }, "label": { "type": "string", "title": "Label", "description": "Human-readable identifier displayed in the Fusion Admin UI, monitoring dashboards, and log messages. Use descriptive labels like `Parse Product PDFs` to aid debugging and team collaboration. Labels appear in performance metrics and error reports, making it easier to identify which stage failed.", "maxLength": 255 }, "enabled": { "type": "boolean", "title": "Enable this Parser Stage", "default": true, "description": "Controls whether this parser stage is active and available for use. When `false`, the stage is completely inactive regardless of other settings. When `true`, the stage runs according to its other configuration options." }, "mediaTypes": { "type": "array", "title": "Media Types to match", "description": "Specifies the media types this parser stage handles. Documents with a matching media type are routed to this stage for parsing. See `inheritMediaTypes` to combine this list with the stage's built-in defaults.", "items": { "type": "string", "pattern": "^[^\\/]+\\/[^\\/]+$", "format": "rfc2646" } }, "inheritMediaTypes": { "type": "boolean", "title": "Match default media types in this Parser Stage", "description": "Controls whether this stage combines its built-in default media types with those in `mediaTypes`. When `true`, both lists are merged. When `false`, only the `mediaTypes` list is used and must contain at least one entry. Set to `false` to override the default media types entirely.", "default": true }, "ignoredMediaTypes": { "type": "array", "title": "Media Types to ignore", "description": "Specifies media types this parser stage excludes from processing. Documents matching an ignored media type are skipped even if they match `mediaTypes`. Use this to carve out exceptions from a broadly matched media type set.", "items": { "type": "string", "pattern": "^[^\\/]+\\/[^\\/]+$", "format": "rfc2646" } }, "pathPatterns": { "type": "array", "title": "File names to parse", "description": "Restricts this parser stage to files whose names match the specified pattern. Use forward slashes (`/`) to join archive names with entry names when matching files inside archives. If no pattern is specified, the stage applies to all matching media types.", "items": { "type": "object", "properties": { "syntax": { "type": "string", "title": "Pattern type", "description": "glob uses bash shell-style wildcards and regex uses Java (PCRE-style) regex.", "enum": ["glob", "regex"], "default": "glob" }, "pattern": { "type": "string", "title": "File name or pattern", "description": "glob examples are \"z.txt\" or \"*.md\" or \"/a/*/b/f.txt\". regex examples are \"z.txt$\" or \".*\\.txt$\" or \"^/a/[^\\/]*/b/f.txt$\"." } } } }, "errorHandling": { "type": "string", "title": "Error Handling", "enum": ["ignore", "log", "fail", "mark"], "default": "mark" }, "outputFieldPrefix": { "type": "string", "title": "Prefix parsed fields with", "description": "Sets a string prefix applied to all fields extracted by this parser, useful for namespacing or avoiding field name collisions. For example, `tika_` produces fields like `tika_title` and `tika_author`. Leave empty to apply no prefix.", "maxLength": 20, "pattern": "^$|^[A-Za-z_][A-Za-z0-9_\\-\\.]+$" }, "rootPaths": { "type": "array", "title": "Root paths", "description": "Specifies XPath expressions that select which XML elements to extract as separate indexed documents. For example, `//item` creates a document for each `` element, and `/catalog/book` targets each book in a catalog. Each matched element and its children become an independent indexed document.", "default": ["/"], "items": { "type": "string" } }, "maxSize": { "type": "integer", "title": "Maximum output size for each document", "description": "Sets the maximum number of XML characters (excluding whitespace) to process from each element selected by `rootPaths`. Content beyond this limit is truncated for that document. Prevents memory issues when extracting large XML elements.", "default": 65536 }, "listHandling": { "type": "string", "title": "XML List handling", "description": "Determines how repeated XML elements with the same name are handled when mapped to document fields. Use `multivalued` to store all occurrences in a single multivalued field, or `index_numbered` to create separate fields with numeric suffixes such as `tag_0` and `tag_1`. Choose `multivalued` for standard indexing and `index_numbered` when downstream systems require discrete fields.", "enum": ["multivalued", "index_numbered"], "default": "multivalued", "hints": ["advanced"] }, "type": { "type": "string", "enum": ["xml"], "default": "xml" } }, "additionalProperties": false, "category": "Other", "categoryPriority": 1, "unsafe": false }; export const SchemaParamFields = ({schema}) => { const sanitize = str => { if (typeof str !== "string") return str; return str.replace(/^"(.*)"$/s, "$1").replace(/\\/g, "").replace(/"/g, "'"); }; const renderMd = str => { const s = sanitize(str); const text = (/[.!?]\)*$/).test(s) ? s : `${s}.`; return text.split(/(\*\*[^*]+\*\*|_[^_]+_|`[^`]+`)/g).map((part, i) => { if (part.startsWith("**")) return {part.slice(2, -2)}; if (part.startsWith("_")) return {part.slice(1, -1)}; if (part.startsWith("`")) return {part.slice(1, -1)}; return part; }); }; const {description, properties = {}, required: requiredProps = []} = schema; const visibleProps = useMemo(() => Object.entries(properties).filter(([, prop]) => !prop.hints?.includes("hidden")), [properties]); const renderProp = ([name, prop]) => { const isRequired = requiredProps.includes(name); const hasDefault = prop.default !== undefined; const rawDefault = prop.default; const hints = prop.hints || []; const isComplexDefault = hasDefault && (typeof rawDefault === "object" || typeof rawDefault === "string" && (rawDefault.length > 20 || rawDefault.includes('"'))); const postBadges = []; if (prop.title) { postBadges.push(<>API property: {name}); } const constraints = []; if (prop.minimum !== undefined && prop.maximum !== undefined) { constraints.push(`Range: ${prop.minimum} – ${prop.maximum}`); } else if (prop.minimum !== undefined) { constraints.push(`Min: ${prop.minimum}`); } else if (prop.maximum !== undefined) { constraints.push(`Max: ${prop.maximum}`); } if (prop.minLength !== undefined && prop.maxLength !== undefined) { constraints.push(`Length: ${prop.minLength} – ${prop.maxLength}`); } else if (prop.minLength !== undefined) { constraints.push(`Min length: ${prop.minLength}`); } else if (prop.maxLength !== undefined) { constraints.push(`Max length: ${prop.maxLength}`); } const fieldProps = { key: name, body: prop.title || name, type: prop.type, ...postBadges.length > 0 && ({ post: postBadges }), ...isRequired && ({ required: true }), ...!isComplexDefault && hasDefault ? { default: sanitize(String(rawDefault)) } : {} }; const isObject = prop.type === "object" && prop.properties; const isArrayOfObjects = prop.type === "array" && prop.items?.type === "object" && prop.items.properties; return {prop.description &&

{renderMd(prop.description)}

} {prop.enum &&

Allowed values: {prop.enum.map((v, i) => <>{i > 0 && ", "}{String(v)})}

} {constraints.length > 0 &&

{constraints.join(" · ")}

} {isComplexDefault &&

Default: 

              
                {JSON.stringify(rawDefault, null, 2)}
} {isArrayOfObjects && } {isObject && } ; }; return
{description &&

{renderMd(description)}

} {visibleProps.map(renderProp)}
; }; export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => { const [isLoaded, setIsLoaded] = useState(false); useEffect(() => { const timer = setTimeout(() => { setIsLoaded(true); }, 500); return () => clearTimeout(timer); }, []); return
{isLoaded && ` }} />} Powered by Lucidworks Agent Studio
; }; [localhost link]: http://localhost:3000/docs/lucidworks-search/09-developer-documentation/config-specs/parsers/xml-parser [mintlify link]: https://doc.lucidworks.com/docs/lucidworks-search/09-developer-documentation/config-specs/parsers/xml-parser [old doc.lw link]: https://doc.lucidworks.com/managed-fusion/5.9/71qx2j 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`. The XML Transformation index pipeline stage is deprecated in favor of this parser stage. 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.