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
10 changes: 4 additions & 6 deletions dataminer/Functions/DataMiner_Assistant/Assistant_DxM.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
uid: Assistant_DxM
keywords: DataMiner Copilot
---

# DataMiner Assistant DxM
Expand All @@ -8,18 +9,15 @@ The DataMiner Assistant module is available as a DxM ([DataMiner Extension Modul

The initial 1.0.0 version only supports the [natural language to GQI](xref:NL2GQI) feature. Starting from version 2.0.7, the [Document Intelligence](xref:docintel) feature is also supported.

More features, such as the [DataMiner Assistant app](xref:DataMinerAssistant), will be added soon.

> [!NOTE]
> Prior to version 2.0.0, the DxM is called "Copilot".
A [DataMiner Assistant app](xref:DataMinerAssistant) is also currently being developed. You can preview it in DataMiner upon request. In addition, a [DataMiner Assistant for Microsoft 365](xref:Assistant_M365) is available on the Microsoft Marketplace, which has similar features as the Assistant app but allows direct access from Microsoft Teams or Microsoft Copilot.

## Installation

DataMiner Assistant is currently not included in DataMiner upgrade packages and [needs to be deployed separately](xref:Managing_cloud-connected_nodes#deploying-a-dxm-on-a-dms-node).
DataMiner Assistant is currently not included in DataMiner upgrade packages and [needs to be deployed separately](xref:Managing_cloud-connected_nodes#deploying-a-dxm-on-a-dms-node).

Once it has been deployed, DataMiner Assistant gets upgraded when you install DataMiner upgrades from DataMiner 10.5.7/10.6.0 onwards.<!-- RN 42896 --> Starting from DataMiner 10.6.2/10.7.0, it is sufficient to install a web upgrade instead of a full DataMiner upgrade.<!-- RN 44291 -->

To upgrade to version 2.0.0 (where Copilot is renamed to DataMiner Assistant), you will need to install DataMiner Assistant manually, even if the Copilot DxM was already installed. After that, automatic upgrades will resume.
To upgrade to version 2.0.0 (which involves a name change of the DxM, as previously it was called "Copilot"), you will need to install DataMiner Assistant manually, even if the Copilot DxM was already installed. After that, automatic upgrades will resume.

For DataMiner Assistant to run correctly, the following **prerequisites** must be met:

Expand Down
56 changes: 56 additions & 0 deletions dataminer/Functions/DataMiner_Assistant/Assistant_M365.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
uid: Assistant_M365
---

# DataMiner Assistant for Microsoft 365

The DataMiner Assistant for Microsoft 365 allows you to access all the features from the [DataMiner Assistant app](xref:DataMinerAssistant) directly from Microsoft Teams or Microsoft Copilot. If you have the necessary permissions, you will be able to request information from your DataMiner System from any location, even without direct access to DataMiner.

![Welcome screen of the DataMiner Assistant agent in Microsoft Teams](~/dataminer/images/DataMinerAssistantM365.png)

## Prerequisites

- To interact with a DataMiner System via the DataMiner Assistant, the DataMiner System must be [connected to dataminer.services](xref:Connecting_your_DataMiner_System_to_the_cloud), and the following [DxMs](xref:DataMinerExtensionModules) must be installed:

- Assistant (version 2.3.16.41785 or higher)
- CloudGateway (version 3.1.0.0 or higher)

> [!TIP]
> See also: [Deploying a DxM on a DMS node](xref:Managing_cloud-connected_nodes#deploying-a-dxm-on-a-dms-node)

- To ensure that you have access to a DataMiner System from your Microsoft account, [your Microsoft account must be linked to your DataMiner account](xref:Linking_your_DataMiner_and_dataminer_services_account).

## Installation

You can download the DataMiner Assistant for Microsoft 365 directly from the [Microsoft Marketplace](https://marketplace.microsoft.com/en-us/product/WA200010613?tab=Overview), or you can deploy it from Microsoft Teams as follows:

1. In Teams, click the *Apps* button in the sidebar on the left.

1. In the filter box at the top, specify DataMiner Assistant.

<p><img src="~/dataminer/images/DataMinerAssistant_look_up_in_Teams.png" alt="Looking up DataMiner Assistant in Microsoft Teams" width="50%" /></p>

1. In the pop-up window, click *Add*.

<p><img src="~/dataminer/images/Assistant_installation_in_Teams.png" alt="Pop-up window to add DataMiner Assistant in Microsoft Teams" width="50%" /></p>

1. When DataMiner Assistant has successfully been added, either click *Open* to open it in a Teams chat, or click *Open with Copilot* to open it in a Copilot chat.

<p><img src="~/dataminer/images/Assistant_installed_window.png" alt="Pop-up window shown after successful installation of DataMiner Assistant in Teams" width="50%" /></p>

## Key features

You can ask the DataMiner Assistant any questions about DataMiner Systems you have access to, or questions about DataMiner in general. You can also interact with the Assistant in several other ways.

Below you can find a quick guide of typical ways to interact with the Assistant. This may help you in case you are not sure what to do, but it is by no means a restrictive list of commands as the Assistant will respond to many similar commands, even in other languages.

| Interaction | Result | Example user input |
|--|--|--|
| Ask for help | Displays a help card outlining everything the Assistant can do. | "help", "what can you do?" |
| System configuration | Guides you through selecting an organization and DataMiner System to work with. | "configure system", "switch system" |
| Get active system info | Shows the currently selected DataMiner System, including a link to open it in your browser. | "which system is active?", "show current system" |
| Get account info | Displays your signed-in account details and the currently selected system. |"who am I?", "show my account" |
| Authenticate | Starts the sign-in process to connect to your DataMiner account. | "sign in", "log in" |
| Sign out | Signs you out and disconnects from the active system. | "sign out", "log out" |
| Live system queries | Sends queries to the DataMiner Assistant for real-time data (e.g., alarms, elements, services) and provides links to the monitoring UI. | "show active alarms", "what services are running?" |
| Session reset | Prompts for confirmation, then clears the conversation history so you can start fresh while staying signed in. | "reset", "start over", "clear history" |
2 changes: 2 additions & 0 deletions dataminer/Functions/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ items:
topicUid: Assistant_Context
- name: Adding custom user context
topicUid: Assistant_UserContext
- name: DataMiner Assistant M365
topicUid: Assistant_M365
- name: Data privacy and security
topicUid: Assistant_DataPrivacySecurity
- name: Natural language to GQI
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dataminer/images/Assistant_installed_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added dataminer/images/DataMinerAssistantM365.png
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