Manual:Extension/ChatIntegration: Difference between revisions

Latest revision as of 10:34, 18 November 2025

ChatIntegration is available from BlueSpice 5.2. This extension has multiple prerequesites before it is available to users in a wiki.

Overview

Users can interact with the wiki directly from their preferred chat client. Currently, the following chat clients are supported:

MS Teams
RocketChat
Slack

If you do not see the BlueSpice chatbot in any of these applications, your wiki does not have the chat integration available yet.

Adding your chat client username to the wiki

Before you can interact with the wiki chatbot in your chat client that is connected to your wiki, you need to provide your username for that application in your wiki user profile.

To add your chat client username to your wiki profile:

Click the Profile link in your user menu.
"Profile" link
Click Edit profile data.
Enter the username for any of the available chat clients (might differ from screenshot).
Chat client usernames
Save the page.

Once your username is available in the wiki, you can switch to your communication client and communicate with the wiki bot user.

Locating your Slack username

Slack usually only shows your display name on the interface. To find your actual Slack username:

Click the "three dots"-menu in your user profile.
Click Account settings.
Finding your Slack username
Scroll to the end of the Account settings page where you should see your username.

MS Teams

Log into your MS Teams account.

To interact with the BlueSpice Chatbot:

Click the BlueSpice Chatbot icon in the app bar.
Type any prompt related to the content in your BlueSpice wiki in the corresponding field.

Slack

To interact with the BlueSpice chatbot:

Click the BlueSpice Chatbot icon in the app bar.
Type any prompt related to the content in your BlueSpice wiki in the corresponding field.

RocketChat

Share a page via chat (MS Teams)

The wiki can be configured to show a Share via chat link in the page tools. Clicking this link opens the MS Teams chat window with a chat message that includes a link to the current page. Which chat is opened from this link has to be configured on the server. There is no GUI for this configuration available.

Notice: The share-via-chat function is currently only available for MS Teams.

Notifications

You can set your notifications preferences to send notifications to a chat channel.

Go to Special:Enhanced_Preferences.
Select the menu item Notifications.
Create or edit a subscription set.
Select the chat clients you want to receive notifications from.

Frequency of notifications If you don't receive the expected notifications, make sure to check your setting for frequency of notifications. By default, it is set to "daily".

Configuration

The following configurations can be made directly in the configuration manager:

Communication

A wiki administrator needs to add the service provider license in the section Communication for extension ChatIntegration.

Skinning

Show "share via chat" action: Activates the share link in the page tools.

Technical Reference: ChatIntegration

PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end

@@ Line 1: / Line 1: @@
-{{BSVersion|bsvFrom=5.2|bsvFeature=ChatBot|info=This extension has multiple prerequesites before it is available to users in a wiki.}}
+{{DISPLAYTITLE:Chat integration (MS Teams, RocketChat, Slack)}}
+{{BSVersion|bsvFrom=5.2|bsvFeature=ChatIntegration|info=This extension has multiple prerequesites before it is available to users in a wiki.}}
-== Starting a conversation ==
+== Overview ==
-If the chatbot is enabled in the wiki,  the interface provides a chat assistant that can answer questions related to your wiki. Click the Chat button at the end of the page to open the chat.
+Users can interact with the wiki directly from their preferred chat client. Currently, the following chat clients are supported:
-[[File:chatbot button.png|alt=Chatbot button|center|thumb|134x134px|Opening the chat window]]
-== The chat window ==
+* MS Teams
-[[File:Chatbot window.png|alt=Introduction page of the BlueSpice user manual with an open chat window.|center|thumb|750x750px|Chatbot window]]The chat window has the following main features:
+* RocketChat
-* '''(1) Buttons to resize or close the chat:'''
+* Slack
-** ''resize chat:'' The size of the chat window has 3 different settings.
-** ''minimize chat:'' The chat window is hidden, but not closed... Clicking on the chat button again restores the current session.
-** ''close chat and delete chat history:''  The chat window is closed and the chat history of the session is deleted.
-* '''(2)  Question with timestamp:''' Once a conversation has been started by sending it from the message prompt area, the question appears with a timestamp in the chat window.
-* Answer to the question with the following elements:
-** '''(3)  the answer text'''
-** '''(4)  resources:''' the page references that were used as a data source
-** '''(5)  buttons to copy the answe'''r to the clipboard or to save it as a wiki page (as a subpage of the current user's user profile page, e.g. <code>User:WikiSysop/Bot/...</code>)
-* '''(6)  Suggested follow-up questions'''
-* '''(7) Message prompt area'''
-== Search integration ==
+If you do not see the ''BlueSpice chatbot'' in any of these applications, your wiki does not have the chat integration available yet.
-When a user types in a search term and switches to the [[Manual:Extension/BlueSpiceExtendedSearch|search center]], the search results are preceded by a summary from the chatbot.
-== Excluding pages as a data source ==
+== Adding your chat client username to the wiki ==
+Before you can interact with the wiki chatbot in your chat client that is connected to your wiki, you need to provide your username for that application in your wiki user profile.
-'''To exclude a page as a data source for the chatbot:'''
+'''To add your chat client username to your wiki profile:'''
-# '''Click''' the ''Options'' menu  in the visual editor toolbar.[[File:VE page options menu item.png|alt=Options menu of VisualEditor|center|thumb|150x150px|Page options menu]]
+# '''Click''' the ''Profile'' link in your user menu.[[File:User menu profile link.png|alt=Opne user menu with Profile-link highlighted|center|thumb|550x550px|"Profile" link]]
-# '''Click''' ''Advanced settings''.
+# '''Click''' ''Edit profile data''.
-# '''Click''' ''No, do not index'' after the label ''Can be indexed for ChatBot'', users can check this requirement in the visual editor toolbar under Options > Advanced options.
+# '''Enter''' the username for any of the available chat clients (might differ from screenshot).[[File:user profile chat integration usernames.png|alt=User profile data in edit mode|center|thumb|550x550px|Chat client usernames]]
+# '''Save''' the page.
+Once your username is available in the wiki, you can switch to your communication client and communicate with the wiki bot user.
+=== Locating your Slack username ===
+Slack usually only shows your display name on the interface. To find your actual Slack username:
-This adds the behavior switch <code>__NO_RAG_EXPORT__</code> to the page source.
+# '''Click''' the "three dots"-menu <code>{{Icon|bi bi-three-dots-vertical|||}}</code> in your user profile.
-== Configuration manager ==
+# '''Click''' ''Account settings''.[[File:slack account settings.png|center|thumb|300x300px|Finding your Slack username]]
-An administrator can configure the name of the bot that is shown at the beginning of the chat window  in the [[Manual:Extension/BlueSpiceConfigManager|Config Manager]] under extension ''ChatBot''.
+# '''Scroll''' to the end of the ''Account settings'' page where you should see your username.
+== MS Teams ==
+Log into your ''MS Teams'' account.
+[[File:bluespice chatbot ms teams.png|alt=Teams chat window for BlueSpice chatbot|center|thumb|550x550px|BlueSpice chatbot in MS Teams]]
+'''To interact with the BlueSpice Chatbot:'''
+# '''Click''' the ''BlueSpice Chatbot'' icon in the app bar.
+# '''Type''' any prompt related to the content in your BlueSpice wiki in the corresponding field.
+== Slack ==
+'''To interact with the BlueSpice chatbot:'''
+# '''Click''' the ''BlueSpice Chatbot'' icon in the app bar.
+# '''Type''' any prompt related to the content in your BlueSpice wiki in the corresponding field.
+== RocketChat ==
+== Share a page via chat (MS Teams) ==
+The wiki can be configured to show a ''Share via chat'' link in the page tools. Clicking this link opens the MS Teams chat window with a chat message that includes a link to the current page.
+Which chat is opened from this link has to be configured on the server. There is no GUI for this configuration available.
+[[File:Chat integration share link.png|alt=Activated link with open MS Teams chat share window.|center|thumb|550x550px|"Share via" chat link]]
+{{Textbox|boxtype=note|header=Notice:|text=The share-via-chat function is currently only available for MS Teams.|icon=yes}}
+== Notifications ==
+You can set your notifications preferences to send [[Manual:Extension/NotifyMe|notifications]] to a chat channel.
+# '''Go''' to ''Special:Enhanced_Preferences.''
+# '''Select''' the menu item ''Notifications''.
+# '''Create or edit''' a subscription set.
+# '''Select''' the chat clients you want to receive notifications from.
+{{Textbox|boxtype=important|header=Frequency of notifications|text=If you don't receive the expected notifications, make sure to check your setting for frequency of notifications. By default, it is set to "daily".|icon=yes}}
+== Configuration ==
+The following configurations can be made directly in the configuration manager:
+=== Communication ===
+A wiki administrator needs to add the service provider license in the section ''Communication'' for extension ''ChatIntegration''.
+=== Skinning ===
+* '''Show "share via chat" action:''' Activates the share link in the page tools.