# Enrichment

## Overview

The Onum **Enrichment** feature allows you to upload tables and use them as **lookups** to enhance existing data by adding new information from external sources to your Pipelines.

{% embed url="<https://youtu.be/ftsXRP7ZrLI>" %}

Go to **Your Vault > Enrichment** to start creating your lookups.

You will see a general overview of all the lookups uploaded in your Tenant and the events generated, if there are any.&#x20;

### Custom vs default lookups

{% hint style="info" %}
Not all users will see the **Custom** and **Default** tabs because not all tenants contain automatically-uploaded lookups.
{% endhint %}

**Default** lookups are lookups that have been automatically provided to you by your administrator. In other words, lookups you did not create and upload yourself. You will not be able to download or delete these default lookups.&#x20;

However, if you wish to upload your own and modify them, these will be your **Custom** lookups.&#x20;

<figure><img src="/files/BfWKrw38fhIkNxdLBXK8" alt=""><figcaption></figcaption></figure>

Within each tab, the lookup card displays the following information:

* The **Key column** assigned to your lookup upon upload.
* The total number of columns it contains.
* The size of the lookup (in KB).
* When your lookup was last updated.
* The lookup version and any tags assigned to it. You can create these tags here, by clicking **Add tag** or the number that indicates the tags added. Press the `Enter` key to confirm the tag, then **Save**.

## How to use your lookups

You can use the Action **Lookup** in your Pipelines to enrich your information. There, you'll be able to select any of the lookups in your Tenant. To learn more about how to use the **Lookup** Action, go to [this article](/the-workspace/pipelines/actions/enrichment/lookup.md).

## Upload a lookup

Follow these steps to create a new lookup table:

{% stepper %}
{% step %}
Click the **New enrichment** button at the top right corner of the **Enrichment** area.
{% endstep %}

{% step %}
Enter a unique **Name** for your new lookup.
{% endstep %}

{% step %}
Optionally, add a **Description** and any **Tags** to identify your uploaded data easily.
{% endstep %}

{% step %}
Click to upload your file or drag it to add it. You can include a **Version description** for the first version of your lookup.
{% endstep %}

{% step %}
You'll see your lookup preview with the data types of each column. You can click the ellipsis button and select **Change type** if you want to modify any of your column types.

{% hint style="warning" %}
To avoid performance problems, note that you will only see a preview of the columns of your lookups so you can choose your key column.
{% endhint %}
{% endstep %}

{% step %}
Click the header of the column you want to set as key. The **key column** is the field in the lookup table that will be used to match the original data. Additional values will be added to the original table whenever there is a match between the key column values and the original table.
{% endstep %}

{% step %}
Choose if you want to use the first row as a header or not.
{% endstep %}

{% step %}
Click **Create** once you're done. You're lookup will appear as a card in the general view once it is processed.
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
Note that there's a file size limit of 3.91 GB.
{% endhint %}

### Upload a new lookup version

You can update a lookup to its newest version without deleting a previous one. To do it, simply click a lookup card and click the **Create version** button. Then, click **Update** to save any modifications.

{% hint style="warning" %}
Note that tables you upload as new versions must have the same columns as the previous ones, plus additional columns you may want to include. You can only change the data types of those new columns when you define a new version.
{% endhint %}

The last version you update will become the active one automatically. All versions are available to access via the version tree that appears in the lookup details. Click one to see details of the logs it contains.&#x20;

<figure><picture><source srcset="/files/DaWFhekRrsnFtms8ZhKD" media="(prefers-color-scheme: dark)"><img src="/files/HWjAbr7e5QovkbHNhSrF" alt=""></picture><figcaption></figcaption></figure>

## Manage your lookups

### Lookup statuses

You can see the status of your lookups in their details, checking the version tree. These are the available statuses:

<table><thead><tr><th width="170">Status</th><th>Description</th></tr></thead><tbody><tr><td><img src="/files/n6BoABMDv4NrswpTZiji" alt="" data-size="line"></td><td>The latest and active version of the lookup.</td></tr><tr><td><img src="/files/6pKOUx2Itus1VvyzPItF" alt="" data-size="line"></td><td>Previous lookup versions.</td></tr><tr><td><img src="/files/AM3GtY2vglECfoK2lteK" alt="" data-size="line"></td><td>Lookups with any processing errors. The lookup card version will appear in red when the lookup has any errors.</td></tr></tbody></table>

### Filter your lookups

You can add filters to narrow down the lookups you see in the list. Click the **+ Add filter** button and select the required filter type(s). You can filter by:

* **Name**: Select a **Condition** (**Contains**, **Equals**, or **Matches**) and a **Value** to filter lookups by their names.
* **Status**: Choose the required status(es) among the available ones in your lookups.

The filters applied will appear as tags at the top of the view.

{% hint style="warning" %}
Note that you can only add one filter of each type.
{% endhint %}

You can also choose to view only those lookups that have been assigned the desired tags. To filter by tags, click the **+ Tags** button, select the required tag(s), and click **Save**.

### Download a lookup

Click the ellipsis icon in a lookup card and select **Download CSV** to download the last version of the lookup as a CSV file. You'll receive an email with the **Download file** button once it is processed.

If you need to download a previous version of a lookup, access its details and click the **ellipsis icon > Download CSV** in the required lookup version to do it.

### Remove a lookup

To remove a lookup, click the ellipses icon in the card and select **Remove**.

{% hint style="warning" %}
If your lookup is in use, you can see where it is being used in the window that appears before deleting it. Pipelines with removed lookups will be paused automatically.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.onum.com/the-workspace/enrichment.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
