> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alumio.com/llms.txt
> Use this file to discover all available pages before exploring further.
# XML
> Read a stream as XML data.
export const FormField = ({property, label, required = false, diType, uiPatterns, children}) => {
const patterns = Array.isArray(uiPatterns) ? uiPatterns : uiPatterns ? [uiPatterns] : [];
return
{label}
{required ? 'Required' : 'Optional'}
{children}
{diType || patterns.length > 0 ?
{diType ? <>
See the {diType} reference.{' '}
: null}
{patterns.length > 0 ? <>
Accepts a pattern.
: null}
: null}
;
};
Reads an incoming stream of XML, such as a downloaded file or an API response, and turns it into items your integration can work with. Use this when the data you receive is XML. You can read the whole document at once, which is simplest for normal-sized files, or read it incrementally, which lets you process very large files element by element without loading everything into memory.
This documentation describes: [Schema](/schemas/stream-deserializer/xml)
## Fields
Choose how the file is read. **Whole file (for smaller files)** loads the entire document and then processes it, and lets you set a Pattern to items. **Incremental (for large files)** streams through the document element by element so a very large file never has to fit in memory, and lets you set a Path to incrementally read over instead. Defaults to Whole file.
Shown when the read method is Whole file. A dot-notated path to the list inside the parsed XML that holds the items you want to process, so each item becomes a separate entity. For example, use `products.product` to read each `` from `...`. Leave it empty to treat the whole document as a single item. Do not add `*`; the system steps through the list for you.
Shown when the read method is Incremental. The element names that lead to the items you want to stream over, one per row. For example, for `` enter `products`, then `product`.
When on (the default), values that look like numbers are turned into numbers, so `"-034"` becomes `-34`. Turn it off to keep every value exactly as written in the XML.
Turn this on when the incoming data uses a character encoding other than UTF-8, so accented and special characters come through correctly. It reveals two more settings: the encoding the data is currently in, and how to handle characters that cannot be converted.
Shown when the input is not UTF-8. The character encoding the incoming data is currently in. Choose from UTF-16, ISO-8859-1, or Windows-1252.
Shown when the input is not UTF-8. What to do with characters that have no UTF-8 equivalent: NONE keeps them as-is, IGNORE drops them, and TRANSLIT replaces them with the closest available character.
## Sample data
This format reads an incoming stream, so it is selected on a step that fetches a file or a response (for example reading a file from a folder) rather than run on data you already have. The example below shows the XML it reads and the items it produces with the settings listed.
| Field | Value |
| - | - |
| Read method | Whole file |
| Pattern to items | `products.product` |
| Automatically convert value's types | On |
Input (the XML in the stream):
```xml theme={null}
A134B219
```
Output (one item per matched element, with numeric values converted):
```json theme={null}
{ "sku": "A1", "price": 34 }
{ "sku": "B2", "price": 19 }
```
```json Configuration theme={null}
{
"prototype": "xml",
"parameters": {
"readMethod": "wholeFile",
"pattern": "products.product",
"xmlTypeCastAttributes": true
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.