Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions docs/user-guide/getting-started/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,20 @@ The process of converting data from a data source into a searchable format, incl

A collection of information (documents, articles, code, etc.) integrated into CodeMie to provide assistants with relevant context and knowledge. Data sources are converted into vector embeddings for semantic search and must be indexed before assistants can access them. Supported types include Git repositories, Confluence, Jira, Files, and Google Docs. Data sources have lifecycle statuses: Indexing, Active/Ready, Failed, and Pending.

### Default Integration

When a tool requires an integration and none is explicitly selected, CodeMie picks one automatically using the following priority order:

| Priority | Type | Visible to |
| -------- | --------------------------- | -------------------------------- |
| 1 | **User Integration** | You only, in the current project |
| 2 | **User Global Integration** | You only, across all projects |
| 3 | **Project Integration** | All project members |

If no matching integration is found at any level, the action requiring it will fail.

See [How the Default Integration Is Selected](../tools_integrations/integrations/#how-the-default-integration-is-selected).

---

## E
Expand Down Expand Up @@ -117,11 +131,13 @@ Native IDE extensions and plugins that bring CodeMie capabilities directly into

### Integration

A configured connection between the CodeMie platform and an external service or system. Integrations provide the credentials and settings needed for assistants to use tools. There are three types:
A configured connection between the CodeMie platform and an external service or system. Integrations store the credentials needed for assistants and tools to access third-party services. There are three types:

- **User Integration**: Personal configuration scoped to a specific project. Available only to the user who created it.
- **User Global Integration**: Personal integration with the **Global** toggle enabled. Available to the same user across all projects where they are onboarded.
- **Project Integration**: Shared configuration available to all project members. Can only be created by users with the `isAdmin` or `applications_admin` role.

- **User Integration**: Personal configuration available only to the individual user
- **User Global Integration**: Personal integration marked as global, available across all projects for the user
- **Project Integration**: Configuration available to all team members within a specific project (Admin-only)
See [Default Integration](#default-integration) for how CodeMie selects one automatically when none is explicitly chosen.

---

Expand Down
36 changes: 29 additions & 7 deletions docs/user-guide/tools_integrations/integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,40 @@ pagination_next: null

# Integrations

There are two general types of integrations: User, User Global Integration and Project. They are distinguished by the availability level. If the user does not explicitly select an integration, the system will automatically choose a default integration based on the following priority:
There are three types of integrations, distinguished by scope and who can create them. If you don't explicitly select an integration, CodeMie picks one automatically — see [How the Default Integration Is Selected](#how-the-default-integration-is-selected) below.

- **User**: Personalized configurations that are applied only to the current user. These integrations allow individual users to customize their own experience and interaction with the software or platform according to their personal preferences and requirements.

- **User Global Integration**: A personal integration marked as global (i.e., available across all projects for the user). This type allows users to reuse the same integration in multiple contexts.

- **Project**: Any changes or adjustments made to the Project will affect all members who are part of the project. The purpose of Project is to ensure a consistent environment or set of rules for everyone involved.
- **User Integration**: Personal configuration scoped to the current project. Available only to you.
- **User Global Integration**: Personal integration with the **Global** toggle enabled. Available to you across all projects where you are onboarded.
- **Project Integration**: Shared configuration available to all project members. Requires the `isAdmin` or `applications_admin` role.

:::note
This function is available for Admins roles only (Admin or Application Admin). Applications-admin can be requested by Support ticket.
To create a **Project Integration**, you need the `isAdmin` or `applications_admin` role. To request `applications_admin` access, submit a Support ticket.
:::

## How the Default Integration Is Selected

When a tool requires an integration and you haven't explicitly chosen one, CodeMie picks it automatically. **User Integration always takes priority over Project Integration.**

| Priority | Type | Created in | Visible to |
| -------- | --------------------------- | -------------------------------------------------------- | ------------------------------------------------- |
| 1 | **User Integration** | **User** tab, current project | You only, in this project |
| 2 | **User Global Integration** | **User** tab, **Global** toggle enabled | You only, in all projects where you are onboarded |
| 3 | **Project Integration** | **Project** tab (`isAdmin` or `applications_admin` only) | All project members |

If no matching integration is found at any level, the action requiring it will fail.

### When does this matter?

**One integration of a type** — it's always used automatically. Nothing to configure.

**Multiple integrations of the same type** — select the one you need when creating or editing an assistant. If you don't, the priority above applies.

### Tips

- Use **User Global Integration** if you use the same credentials across multiple projects — configure once, use everywhere.
- **Project Integration** acts as a shared fallback for team members who haven't set up their own.
- If a tool is using unexpected credentials, go to **Integrations → User** and check whether a User Integration is overriding the project-level one.

## Setting Up Integrations

1. In the AI/Run CodeMie main menu, click the **Integrations** tab:
Expand Down
Loading