# Omni

Euno's Omni integration supports auto-discovery of the following Omni resources:

* Omni accounts (organizations)
* Omni folders
* Omni models (semantic layer containers for views and topics)
* Omni views and topics
* Omni dimensions and measures
* Omni workbooks
* Omni queries (tabs in workbooks)
* Omni dashboards
* Lineage to source tables and models
* Users (when "Observe users" is enabled)
* User groups (when "Observe groups" is enabled)

{% hint style="info" %}
**Usage data**: To observe usage (impressions, views) on Omni workbooks and dashboards, you must also set up the [Omni Usage integration](https://docs.euno.ai/sources/business-intelligence/omni-integration/omni-usage-setup). It is a separate push integration that receives usage data from your Omni instance.
{% endhint %}

## Setting up Omni integration

### Overview

Omni is an analytics and business intelligence platform that enables users to explore, analyze, and visualize data directly in their cloud data warehouse. In Omni, data is organized into *workbooks* (with query tabs), *dashboards*, and *models*. Models contain views and topics that provide a semantic layer over your data warehouse tables.

To discover Omni resources, Euno connects to the Omni API using Organization API keys. The integration automatically discovers your Omni organization structure, including folders, models, workbooks, and their lineage to underlying data warehouse tables.

### Step 1: Create Omni API Credentials

#### Generate Organization API Key

1. Log in to your Omni instance as an **Organization Admin**
2. Navigate to **Settings** → **API Keys** → **Organization keys**
3. Click **Generate new key**
4. In the modal, enter a descriptive name for the API key (e.g., "Euno Integration")
5. Click **Generate**
6. Copy the key immediately. **Note**: API keys are only displayed once when created.

{% hint style="warning" %}
**Important**: The API key is only shown once. Store it securely—you won't be able to retrieve it again.
{% endhint %}

For more details, see [Omni API authentication](https://docs.omni.co/api/authentication#creating-organization-api-keys).

### Step 2: Configure New Omni Source in Euno

#### Access the Sources Page

1. Go to the **Sources** page in Euno.
2. Click on **Add New Source** and select **Omni** from the list of supported platforms.

#### General Configuration

Asterisk (\*) means a mandatory field.

| Configuration | Description                                                                                                       |
| ------------- | ----------------------------------------------------------------------------------------------------------------- |
| Name\*        | Enter a name for your Omni source (e.g., "Omni - Analytics")                                                      |
| Instance\*    | Your Omni instance subdomain. For example, if your Omni URL is `https://mycompany.omniapp.co`, enter `mycompany`. |
| API Key\*     | The Organization API key from Step 1                                                                              |

### Step 3: Schedule

* Enable the Schedule option.
* Choose:
  1. **Weekly**: Set specific days and times.
  2. **Hourly**: Define the interval in hours (e.g., every 8 hours).

{% hint style="info" %}
**Recommended**: Schedule Omni integration to run daily or every 12 hours to keep workbook lineage and metadata up to date.
{% endhint %}

### Step 4: Resource Cleanup

To keep your data relevant and free of outdated resources, Euno provides automatic **resource cleanup** options. These settings determine when a resource should be removed if it is no longer detected by a source integration. For a detailed explanation on Euno's cleanup strategies, see: [Resource Sponsorship in Euno](https://docs.euno.ai/developer-reference/technical-concepts/resource-sponsorship-and-cleanup-in-euno).

* **Immediate Cleanup**: Remove resources not detected in the most recent successful source integration run.
* **No Cleanup**: Keep all resources indefinitely, even if they are no longer detected.

### Step 5: Advanced Settings (Optional)

Click on the '**Advanced**' section to display these additional configurations.

| Configuration      | Description                                                                                                                                                                       |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Observe users**  | When enabled, Euno will observe users from Omni via the SCIM API. Users are discovered from `GET /scim/v2/users`. Requires an Organization API key.                               |
| **Observe groups** | When enabled, Euno will observe user groups from Omni via the SCIM API and their memberships. Groups are discovered from `GET /scim/v2/groups`. Requires an Organization API key. |

For additional information regarding Users & Groups see [Users as a Resource](https://docs.euno.ai/developer-reference/technical-concepts/users-as-a-resource).

### Step 6: Save Configuration

Click the **Test & Save** button to complete the setup. Euno will:

1. Validate the instance URL is accessible
2. Authenticate using the provided API key
3. Verify access to the Omni organization
4. Save the configuration if all validations pass

If the test fails, review the error message and verify your API key and instance subdomain are correct.