# Extract

> Extract structured fields from documents using IXP extraction models.

The Extract node pulls structured fields out of a document (an invoice, receipt, form, or contract) using a UiPath Intelligent Xtraction and Processing (IXP) model, and returns the result for downstream nodes to act on. Use it when a step in your process needs typed data lifted out of an unstructured file.

## Add an Extract node

The Extract node runs an IXP extraction model. You can use a model that already exists, or create a new one in the node.

1. Select **+** on the handle of the node it follows, then select **Document > Extract**.
2. Select one of these options:
   - **Extract document** (Preview): adds a node with a new model, which you build and evaluate in the node.
   - **In this solution**: reuses the model of an Extract node in another workflow of the same solution.
   - **Published**: uses a deployed IXP model, such as one deployed from IXP or from the Extract node of another workflow. Each model appears as its own node. You need access to the place where the model is deployed.

![The Extract category of the Add node panel, with Extract document (Preview) and the Published group, which lists your deployed extraction models.](https://dev-assets.cms.uipath.com/assets/images/maestro-automate/add-node-extract-automate-4a60da05.webp)

Your administrator must turn on both **IXP** and **Document Understanding**, even when you only use IXP models. [Administration](administration.md) lists the services.

Building, evaluating, and deploying a model in the node is described in the IXP documentation:

- [Managing Extract nodes](/ixp/automation-cloud/latest/flow-user-guide/managing-extract-nodes)
- [Consuming models via Flow](/ixp/automation-cloud/latest/flow-user-guide/consuming-models-via-flow)

When the node runs, Maestro Automate sends the document to the model, the model digitizes and extracts it, and the structured result returns on the node's `output`. The node waits for the model to finish before continuing, so allow time for large documents.

## Configuration

Configure the Extract node in the properties panel after adding it to the canvas.

| Field | Required | Default | Description |
|---|---|---|---|
| **File** | Yes | None | The document to extract from. Bind it to a file produced earlier in the workflow, such as the output of a trigger or of an earlier node. |
| **Page range** | No | Empty | The pages to extract from, for example `1-5`. Leave it empty to process the whole document. |
| **Definition** | Not applicable | None | A summary of the node's model: its version and evaluation results, the annotated documents, and the fields it extracts. **Edit** opens the full view, where you set up the model and its fields. |

## Output

The Extract node returns its result at `$vars.<nodeId>.output`, with these keys:

- `version`
- `type`
- `result`
- `taxonomy`
- `metadata`

The fields inside `result` depend on the fields your model extracts. To see them, debug the workflow, open the node's expanded view, and check the **Output** column. It shows the output of the last run as **Schema**, **JSON**, or **Extraction result**. Before the node runs, the keys have no values. [Output](/ixp/automation-cloud/latest/flow-user-guide/managing-extract-nodes#output) in the IXP documentation describes the panel.

To test later nodes without running an extraction, change the mode of the **Output** column from **Live** to **Static mock**, a value you define, or **Generated**, a response that an LLM generates. [Output mocking](output-mocking.md) describes both.

## Error handling

On the **Error handling** tab, select **Enable error handling**. The node then has an error output handle. If the extraction fails, the run continues on the error path, and the error is at `$vars.<nodeId>.error`, with the `code`, `message`, `detail`, `category`, and `status` keys. [Error handling](error-handling.md) describes how to route on it.

## Notes

- **Published** lists the models that are deployed when you open the **Add node** panel. After you deploy a new model, open the panel again to see it.

## Next steps

- [Document processing](document-processing.md): how the document nodes work together.
- [Analyze files](analyze-files.md): extract data from a file step by step.
- [Community](community.md): ask questions and share workflows with other builders on the UiPath Forum.