Artemis doc updates #802
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| title: Digital Channels | ||
| --- | ||
|
|
||
| <Badge icon="arrow-left" color="gray">[Back to messaging or digital channels](/agent-platform/channels#messaging-or-digital)</Badge> | ||
|
|
||
| ## Set up Microsoft Teams | ||
|
|
||
| Integrate your agent into Microsoft Teams channels and chats through an Azure Bot registration. | ||
|
|
||
| <Note>Complete the Azure Bot setup before you begin — it produces the App ID, client secret, and tenant ID this connection needs.</Note> | ||
|
|
||
| <Steps> | ||
| <Step title="Complete Azure Bot Setup"> | ||
| 1. Go to [Azure Portal](https://portal.azure.com/) and navigate to **Azure Bot** > **Create**. | ||
| 2. In **Bot settings**, set **Messaging endpoint** to the webhook URL shown on the **Microsoft Teams Overview** page. | ||
| 3. Under **Configuration**, copy the **Microsoft App ID**. | ||
| 4. Go to **App Registrations** > find your bot > **Certificates & secrets** > create a **New client secret** and copy the value. | ||
| 5. Copy the **Directory (tenant) ID** from the **Overview** page. | ||
| 6. Go to **Channels** > add the **Microsoft Teams** channel. | ||
| 7. In the Teams app manifest, set `bots[0].supportsFiles` to `true`. | ||
|
|
||
| <Note>Attachment ingestion currently supports personal chat scope only.</Note> | ||
| </Step> | ||
|
|
||
| <Step title="Enter Connection Details in Artemis"> | ||
| To configure a Microsoft Teams channel, go to **Deployments** > **Channels** > **MESSAGING** > **Microsoft Teams** > **+ New** and complete the following steps in order. | ||
|
|
||
| On the **New Microsoft Teams Connection** page, provide the following fields. | ||
|
|
||
| | Field | Description | | ||
| | ----- | ----------- | | ||
| | **Display Name** | A label for the connection, e.g. `Microsoft Teams Production`. Up to 255 characters. | | ||
| | **Bot App ID** | The Microsoft App ID of your bot registration, e.g. your Microsoft App ID. Up to 255 characters. | | ||
| | **App ID** | Your Microsoft App ID. | | ||
| | **Client Secret** | The client secret value from your Azure bot registration. | | ||
| | **Azure Tenant ID** | The Directory (tenant) ID from the Azure Overview page. | | ||
| | **Environment** | Select an environment to follow its active deployment, or leave the default to use the working copy. | | ||
| | **Provider Verification Strength** | Controls how strictly the platform trusts the provider's identity assertions for session continuity and linking. **Weak** is the default. Choose **Strong** only for channels or providers whose identity assertions you trust for stronger continuity and linking decisions. | | ||
| | **Initial Status** | **Active** connections are usable immediately. **Inactive** connections stay saved but disabled until you activate them. | | ||
| </Step> | ||
| Select **Create**. | ||
|
|
||
| </Steps> | ||
|
|
||
| ### Manage an Existing Microsoft Teams Channel | ||
|
|
||
| Open a channel from **Deployments** > **Channels** > **MESSAGING** > **Microsoft Teams** shows four tabs: **Overview**, **Credentials**, **Configuration**, and **Deployment**. | ||
|
|
||
| <Tabs> | ||
| <Tab title="Overview"> | ||
| The **Connection Summary** shows these fields. | ||
|
|
||
| | Field | Description | | ||
| |-----------------|-----------------------------------| | ||
| | **Status** | for example: *Active* | | ||
| | **Created** | Timestamp the channel was created | | ||
| | **Updated** | Timestamp of the last change | | ||
| | **Environment** | for example: `staging` | | ||
| | **Source Type** | `Channel Connection` | | ||
| | **Source ID** | Unique channel identifier (UUID) | | ||
|
|
||
| Under **Setup Instructions**, the tab also shows the **Webhook URL** to set as the bot's messaging endpoint in Azure, and the **Bot App ID** for reference. | ||
| </Tab> | ||
|
|
||
| <Tab title="Credentials"> | ||
| Credentials are saved and encrypted after creation; the fields show placeholder text and accept new values only if you want to update them. | ||
|
|
||
| | Field | Description | | ||
| |----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Use Auth Profile** | Toggle on to authenticate through a saved Auth Profile instead of entering credentials manually. When enabled, select the profile from the dropdown in place of the fields below. | | ||
| | **App ID** | Your Microsoft App ID. Shown as *(saved — enter to update)*; leave blank to keep the current value. | | ||
| | **Client Secret** | The client secret from your Azure bot registration. Shown as *(saved — enter to update)*; leave blank to keep the current value. | | ||
| | **Azure Tenant ID** | The Directory (tenant) ID from the Azure Overview page. Shown as *(saved — enter to update)*; leave blank to keep the current value. | | ||
|
|
||
| Select **Save Credentials** to apply any changes. | ||
| </Tab> | ||
|
|
||
| <Tab title="Configuration"> | ||
| Under **General**, update the **Display Name** and **Provider Verification Strength** described in [Set up Microsoft Teams](#set-up-microsoft-teams) above. | ||
|
|
||
| Under **Microsoft Teams Settings**, the **Bot App ID** is shown for reference and cannot be changed after creation. | ||
|
|
||
| Select **Save Changes** to apply any changes. | ||
| </Tab> | ||
|
|
||
| <Tab title="Deployment"> | ||
| The tab collects these fields. | ||
|
|
||
| | Field | Description | | ||
| |-----------------------|---------------------------------------------------------------------------------------------------------------------| | ||
| | **Agent Version** | An **Environment** dropdown (for example: `Staging`) that selects which deployed version handles incoming messages. | | ||
| | **Active Deployment** | Shows the bound deployment version and when it was deployed. | | ||
|
|
||
| Select **Save Changes** after switching the environment/version. | ||
| </Tab> | ||
| </Tabs> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Later, add an overview of digital channels in both articles - here and in its parent article.