Skip to content
4 changes: 4 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -6160,6 +6160,7 @@
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/teams-and-users/add-team",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/teams-and-users/invite-users",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/teams-and-users/add-users",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/teams-and-users/user-details",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/teams-and-users/change-team-type"
]
},
Expand All @@ -6172,6 +6173,8 @@
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/roles-policies/use-cases"
]
},
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/profile/index",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/applications/index",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/cli-ingestion-with-basic-auth",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/data-retention",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/reindexing-search",
Expand All @@ -6180,6 +6183,7 @@
"pages": [
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/index",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/theme-and-branding",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/app-mode",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/email",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/login-configuration",
"v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/health-check",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3135,9 +3135,18 @@
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/pipeline/tableau-pipeline/yaml</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/applications</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/data-retention</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/app-mode</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/profile</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/sso</loc>
</url>
Expand Down Expand Up @@ -3165,6 +3174,9 @@
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/sso/saml</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/teams-and-users/user-details</loc>
</url>
<url>
<loc>https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/context-center/ai-context</loc>
</url>
Expand Down
90 changes: 90 additions & 0 deletions v2.1.x-SNAPSHOT/how-to-guides/admin-guide/applications/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: Manage Applications
description: "Install and manage OpenMetadata applications from Settings. Browse the marketplace, install an application, review its runs, and disable, restore, or uninstall it."
sidebarTitle: Applications
---

# Manage Applications

Admins install and manage OpenMetadata applications from **Settings** > **Applications**. Only admins see **Applications** and the marketplace.

<Note>
This page describes AI mode, where **Settings** opens as a modal. For more information, see [Profile Menu and Settings](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/profile).
</Note>

To open the page, click the **Profile** icon, select **Settings**, and then click **Applications** in the **Features** group.

## Installed Applications

The page lists your installed applications.

- Turn on **Show Disabled** to list disabled applications instead. The heading changes from **Installed Applications** to **Disabled Applications**.
- Click **Browse Apps** to open the **Marketplace**.

<img src="/public/images/how-to-guides/admin-guide/applications/installed-list.png" alt="Applications page listing installed applications with Show Disabled and Browse Apps" />

<img src="/public/images/how-to-guides/admin-guide/applications/installed-list-show-disabled.png" alt="Applications page with Show Disabled turned on, listing a disabled application" />

## Install an Application

1. Click **Browse Apps** and select an application. The application page shows an **Overview** and its **Details**.

<img src="/public/images/how-to-guides/admin-guide/applications/marketplace-app-page.png" alt="Marketplace page for an application with the Install button and the Overview section" />

2. Click **Install**.
3. Complete the wizard steps. The buttons in the footer change with each step:
- **Details**: Review the authorization screen, which lists what the application can access, such as **All Metadata**. The footer has **Cancel** and **Next**.
- **Configure**: Fill in the application settings. The footer has **Back** and **Next**.
- **Schedule**: Choose how the application runs. The footer has **Back** and **Install**.

<img src="/public/images/how-to-guides/admin-guide/applications/install-wizard-details.png" alt="Install wizard Details step with the authorization screen and the Cancel and Next buttons" />

<img src="/public/images/how-to-guides/admin-guide/applications/install-wizard-configure.png" alt="Install wizard Configure step with application settings, the Show Hint switch, and the Back and Next buttons" />

On the **Schedule** step, select one of the following:

- **Schedule**: Runs the application repeatedly. Select a **Frequency**, then set the **Day** (for weekly runs) and the **Time**. The available frequencies depend on the application, for example **Hourly**, **Daily**, **Weekly**, **Monthly**, or **Custom**. A summary line shows when the next runs happen.
- **On Demand**: Runs the application once, when you start it.

<img src="/public/images/how-to-guides/admin-guide/applications/install-wizard-schedule.png" alt="Install wizard Schedule step with Schedule and On Demand options, Frequency, and Time" />

OpenMetadata skips **Configure** when the application has no configuration form or does not allow configuration. If the configuration form fails to load, OpenMetadata shows "No application schema found for" followed by the application name.

## Application Details

Select an installed application to open its details.

<img src="/public/images/how-to-guides/admin-guide/applications/app-detail-schedule.png" alt="Application details page with the header, the Schedule, Configuration, and Recent Runs tabs, and the Edit and Run now buttons" />

- **Header**: Shows **Installed** with a relative time, "Developed by" with the developer name, and **Visit developer website** when a website exists.
- **Tabs**:
- **Schedule**: Set when the application runs. This tab is hidden for applications without a schedule.
- It shows the schedule type and interval, with **Edit** and **Run now** buttons.
- A table lists each run with its run time, type, who triggered it, duration, and status, and links to the logs and configuration.
- **Configuration**: Edit the application settings. It appears only for applications that have a configuration form and allow configuration. When none is available, the page shows **No Configuration**.
- **Recent Runs**: Review past runs.
- **Live Indexing**: Appears only for the Search Indexing application.
- **Show Hint**: On the **Configuration** tab, turn on **Show Hint** to display field hints.

## Disable, Restore, or Uninstall

Use the three-dot menu in the application header.

- **Disable**: Turns the application off. A disabled application moves to the **Disabled Applications** list.
- **Restore**: Appears instead of **Disable** for a disabled application. It turns the application back on.
- **Uninstall**: Removes the application. It is not offered for system applications.

Each action asks you to confirm.

<img src="/public/images/how-to-guides/admin-guide/applications/app-manage-menu.png" alt="Manage menu with Disable and Uninstall" />

An application with no schedule, configuration, or runs shows only the header and **No Configuration**.

## Permissions

Actions on an application depend on your permissions.

- **Delete**: Shows the three-dot menu.
- **EditAll**: Allows edits to the schedule and configuration.
- **Trigger**: Allows **Run now**.
- **Deploy**: Allows deploying the application.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ After you change a setting, click **Save**. Click **Reset** to discard your chan
Use **App Mode** to choose the experience users of this persona see when they open the app and haven't picked an app mode themselves. A user's own app mode choice takes priority over the persona setting.

- **No default**: Uses the organization default.
- **Classic**: Uses the standard catalog experience.
- **Classic** (deprecated): Uses the standard catalog experience. For more information, see [Default App Mode](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/app-mode).
- **AI**: Starts in the AI assistant.

### Default Landing Page

Expand Down Expand Up @@ -128,6 +129,18 @@ The following widgets are available:
For a **data scientist**, the KPIs widget may be removed, while prioritizing Yours and Followed and Team Activity.
A **data engineer** might add the Pipeline Status widget, while a **data steward** might include widgets focused on data governance, such as Domains and Data Products.

## Full-Page Editor

In AI mode, customizing the **Home Page** and the entity pages under **Governance** and **Data Assets** opens a full-page editor. The other categories open in the modal.

- The breadcrumb starts at **Settings** > **Personas** and shows the persona and the page you are editing.
- The header has **Add Widgets**, **Reset**, and **Save**, and a close icon to leave the editor.
- If you exit with unsaved changes, an **Unsaved changes** prompt asks whether to save or discard them. Click **Save changes** or **Discard**. If you have no unsaved changes, you leave without a prompt.

<img src="/public/images/how-to-guides/admin-guide/customize-fullpage.png" alt="Full-page Customize Home Page editor with Add Widgets, Reset, and Save in the header" />

<img src="/public/images/how-to-guides/admin-guide/unsaved-changes-dialog.png" alt="Unsaved changes dialog with Discard and Save changes buttons" />

## Customize Glossary Pages

The **Review** tab, where reviewers decide on glossary term proposals, is a customizable tab of the **Glossary** page. For a persona, rename, move, or hide it.
Expand Down Expand Up @@ -159,6 +172,8 @@ Users can switch between different personas without logging out or reconfiguring
### Setting a Default Persona:
Users can set a **default persona**, so the system displays the layout and settings relevant to that role every time they log in.

Admins can also make a persona the organization default. Open the persona in **Settings** > **Personas** and click **Set as Default** in the page header. To undo it, click **Remove Default**. For more information, see [Manage a Persona](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/persona-landing-page-customization/defining-persona#manage-a-persona).

## Use Case Examples:

### 1. Data Engineer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,28 @@ In OpenMetadata, a **persona** represents an organization's specific role or fun
<img src="/public/images/how-to-guides/admin-guide/persona-users-tab.png" alt="Users tab of a persona with the Add User button" />

<img src="/public/images/how-to-guides/admin-guide/persona-add-users.png" alt="Add Users form with the Users field and the Cancel and Save buttons" />

## Manage a Persona

Select a persona in **Settings** > **Personas** to open its detail page. Only admins see **Personas**. The page header and tabs offer the following actions.

<img src="/public/images/how-to-guides/admin-guide/persona-detail-header.png" alt="Persona detail page with copy link, rename, Set as Default, and delete in the header, and the Customize UI and Users tabs" />

- **Copy URL**: Click the copy icon next to the title to copy a link to the persona. OpenMetadata confirms with "Link copied to clipboard".
- **Rename**: Click the pencil icon to change the display name. This needs the EditDescription permission.
- **Edit the description**: Edit the text under **Description**, and then save it.
- **Set as Default** or **Remove Default**: Click the button in the header to make this persona the organization default, or to remove that status. This needs the EditAll permission.
- **Delete**: Click the delete icon and confirm. This needs the EditAll or Delete permission.

<img src="/public/images/how-to-guides/admin-guide/persona/persona-remove-default.png" alt="Persona page header showing the Remove Default button for the default persona" />

<Note>
**Set as Default** is a button in the page header in AI mode. In Classic mode, open the **⋮** menu on the persona page and select **Set as Default** instead. Only one persona can be the default. Setting a new default removes the previous one for all users.
</Note>

### Users Tab

The **Users** tab lists the users assigned to the persona, with their teams and roles.

- Click **Add User**, select the users in the **Users** field, and click **Save**.
- Use the remove action in a row to take a user out of the persona.
47 changes: 47 additions & 0 deletions v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/app-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Default App Mode
description: Choose the default app experience, Classic or AI, that users land in until they pick one themselves, and learn that Classic mode is deprecated.
sidebarTitle: Default App Mode
---

# Default App Mode

OpenMetadata has two app experiences:

- **Classic**
- **AI**

Each user can switch between them. **Default App Mode** sets the experience users land in until they have made that choice themselves.

<Warning>
Classic mode is deprecated. It will be removed in an upcoming release, and AI mode will then be the only interface. Organizations and personas still set to **Classic** move to AI automatically. OpenMetadata has not announced a removal date.
</Warning>

## How to Configure

This setting requires Admin access.

1. Navigate to **Settings** > **Preferences** > **Default App Mode**. In AI mode, open **Settings** from the profile menu and select **Platform Settings** > **Default App Mode**.
2. Choose one of the following options:
- **No default**: OpenMetadata doesn't set an organization default.
- **Classic** (marked **Deprecated**): Users without a personal or persona-level mode land in the Classic experience. Under this option, OpenMetadata shows the hint "Classic mode retires in an upcoming release. Organizations and personas still set to Classic will move to AI automatically." A **Read the release notes** link follows the hint.
- **AI**: Users without a personal or persona-level mode land in the AI experience.
3. Click **Save**.

<img src="/public/images/how-to-guides/admin-guide/preferences/default-app-mode-classic.png" alt="Edit Default App Mode with No default, Classic marked Deprecated with its hint, and AI" />

## Which Mode a User Lands In

OpenMetadata uses the first of these that is set:

1. **The user's own choice**: Saved for each user when they switch modes.
2. **The persona's app mode**: Set for each persona. For more information, see [App Mode](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/persona-landing-page-customization/customizable-landing-page#app-mode).
3. **This default**: The mode you set on this page.

Because the user's own choice comes first, this default never forces a mode on anyone.

## What Users See

Users see **Deprecated** next to **Classic** in the interface switcher. Hovering over it shows a "Classic mode is being retired" card that explains the change and links to the release notes. The card says that after Classic is removed, AI mode will be the only interface, and that users can switch now and keep their settings.

<img src="/public/images/how-to-guides/admin-guide/preferences/classic-deprecation-hover-card.png" alt="Switch Interface menu with the Classic mode is being retired card" />
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Navigate to **Settings** > **Preferences**.

<img src="/public/images/how-to-guides/admin-guide/preferences/access-preference.png" alt="Navigate to Settings > Preferences" />

Every item under Preferences requires **Admin** access. Non-admin users don't see the Preferences menu at all, so if a teammate reports they can't find these settings, that's expected unless they've been made an admin.
Every platform-wide item on this page requires **Admin** access. Non-admin users don't see these settings, so if a teammate reports they can't find them, that's expected unless they've been made an admin. Each user's personal **Preferences** under **Account** (Theme, Compact Sidebar, and Language) are separate and available to everyone.

## What's in Preferences

Expand All @@ -40,5 +40,6 @@ The table below lists every setting under Preferences, in the order it appears i
| **OpenMetadata URL** | Sets the base URL used to build links inside outgoing emails | Keeps every link in a notification email pointing at the right instance | [Email](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/email#openmetadata-url) |
| **Data Asset Rules** | Sets platform-wide metadata validation rules assets must satisfy | Enforces metadata quality standards across every asset automatically | [Data Asset Rules](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/data-asset-rules) |
| **Learning Resources** | Sets in-product learning content shown to end users | Surfaces onboarding material to new users without them having to go looking for it | [Learning Resources](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/learning-resources) |
| **Default App Mode** | Sets whether users land in Classic or AI mode until they choose one | Controls the first experience new users see, and shows that Classic mode is deprecated | [Default App Mode](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/app-mode) |

Custom Logo and Theme aren't separate settings. They're two panels on the same **Theme** page in the product. For more information about customizing your logo, favicon, and color palette, see [Theme and Branding](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/preferences/theme-and-branding).
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Theme and Custom Logo are organization-wide settings that require Admin access.

Changes here apply instantly for every user on the instance once they refresh the page.

<Note>
This page covers the organization-wide logo and colors that admins set. Each user also picks **Light**, **Dark**, or **System** for themselves in **Settings** > **Preferences** (under **Account**) > **Theme**. That choice applies in AI mode only. Classic mode always uses the light theme, and OpenMetadata keeps the choice for when the user returns to AI mode. For more information, see [Profile Menu and Settings](/v2.1.x-SNAPSHOT/how-to-guides/admin-guide/profile#your-preferences).
</Note>

## How to Access

1. Navigate to **Settings** > **Preferences**.
Expand Down
Loading
Loading