innovaphone wiki - User contributions [en]

Reference16r1:Concept App Connect

2026-04-28T11:13:33Z

Msu: /* Chat Features */

[[Category:Concept|Apps]]

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat or connect license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== Documents App ===
The Documents App can be integrated inside connect, to share documents, presentations etc. with other users. 
For more information, see [[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]

[[image:connect_post_documents.png]]

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]
* [[#Archiving|Archiving]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location).
If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Apps/PbxManager/App Messages

2026-04-28T11:11:28Z

Msu:

With the Messages PBX-Settings plugin, the needed app objects for all connected apps can be created and configured.
In addition, the creeated app objects can be assigned to specific config templates, if any exist.

== Add an app object ==
you can choose between "Connect" (for the Connect App) and "Api" (for the Messages Api).

;name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

If config templates exist, they will be listed with a checkbox.
The app object will be assigned to the config templates if a checkbox is checked.
Also, the administrator and moderator mode can be assigned to config templates.

For the Connect App an checkbox is available to make the App available for public access as a shared service

Reference16r1:Concept Chat

2026-04-28T11:11:22Z

Msu:

[[Category:Concept|Chat]]
=== Features without license ===
'''Important:''' 
Chat is only supported with the Chat App provided by the PBX, which only supports volatile chat, meaning the Chat messages are not stored. 
 
Features without license include the following: 
;Volatile chat: Chat to other users, if these other users are online and respond to the incoming chat call
;Emojis: Some emojis can be selected to be included in the message. The emojis are sent as standard Unicode characters

=== With a Chat or Connect license ===
If a Chat or Connect license is available, Chat can be integrated into a [[Reference16r1:Concept_App_Connect#Chat|Connect App]]. A Chat tab can then be found in the top navigation of the Connect App. 
In parallel, the Chat icon will open only the Chat tab of the Connect App in particular. 

== Technical Details ==

=== Client APIs ===

The client uses published PBX APIs to provide the service.

;PbxSignal: This is the API for signaling using Websocket/Json protocol. The Chat App uses the flag 'NO_MEDIA_CALL' when doing the register, so that no media call is sent to the Chat App. To mark a call as instant messaging call the facility 'im_setup' is used. Messages are transfered with the facility 'im_message'
;PbxMessages: This API provides access to an external Messages App Service. If a chat licenses is assigned to the user, the Chat App established a Session on the PbxMessages API.

=== API of Messages App Service ===

The PBX Objekt Messages establishes a AppWebsocket connection to the external Messages App Service. Documeneted messages on this connection are used for the additional services.

=== File Attachments ===

To attach a files to a chat message, the client uses a method 'CreateFileBuffer' of 'PbxMessages' to create a temporariy buffer for a file in the Messages App Service. The file is sent via HTTP POST to this buffer and a URL to the file is included in the im_message facility. The recepient of the message can read the file from this buffer, if online while the message was sent. After the message was sent, the file attachments are copied into permanent buffers on the sender and on the received side. To access these buffers other URLs then the URLs for the temporariy buffers are used.

=== Text Format ===

The texts are sent as plain HTML coded as UTF-8. Plain HTML means that no attributes for HTML elements may be used. This is enforced by the PBX to make sure no malicious content can be sent. The styling of the HTML is up to the receiver of the message.

== Tracing and logging ==
The following trace flags can be activated at [[{{NAMESPACE}}:Maintenance/Diagnostics/Tracing | Maintenance/Diagnostics/Tracing]].

;PBX: communication between the PBX and the myApps client

;HTTP->Servlets: WebSocket communication between PBX and myAPPS client and also App Service. To enable this trace flag it's necessary to go to the debug.xml page.

Additionally, you can enable the following trace flags at the myApps client.
;App
: general information from the APP
;Browser Console
: information from the client/browser side.

In case we use the additional features with license, there is an APP called "Messages" at APP Platform and we can enable the following trace flags for the instance "messages".
;App
: general information from the APP Messages
;Database
: information from APP database.
;App Websocket
: information from APP to PBX regarding websocket.
;Signalling
: information of signalling between App Messages to PBX

Reference16r1:Concept App Service Messages

2026-04-28T11:11:17Z

Msu:

[[Category:Concept|Messages]]

The App Service Messages provides the persistent storage of Chat and microblogging messages as available with the [[Reference15r1:Concept_Chat|premium chat]] and the social tool called [[Reference15r1:Concept App Connect|Connect App]], which can be used for organization internal communication.

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
Provides Database function for other Apps like the Connect App, or the Premium Chat App.

== Requirements ==
* innovaphone AppPlatform with valid NTP settings
* innovaphone myApps

== Apps ==

=== Connect App (including permium chat)===

The Connect App is a microblogging user interface using the database of the Messages App Service: 
[[Reference16r1:Concept App Connect]]

== Configuration ==

==== PBX Settings Plugin ====
After creating the instance for the Messages App Service in the Application Platform, all further configuration is depending on the App which should be configured. 
For example, the configuration of the Connect App is described in the corresponding concept article: 
[[Reference16r1:Concept App Connect#Configuration]]

==== Search App ====
For the search app to search inside connect, the following requirements must be met:
* the user need access to the ''"messages-api"'' app (at best, this would be deployed via the config user template)
* the connect app object need access to the ''"messages-api"''

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==
[[Reference16r1:Concept App Connect]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-04-28T11:11:11Z

Msu:

[[Category:Concept|Apps]]

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== Documents App ===
The Documents App can be integrated inside connect, to share documents, presentations etc. with other users. 
For more information, see [[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]

[[image:connect_post_documents.png]]

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]
* [[#Archiving|Archiving]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location).
If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Service Documents

2026-04-28T11:09:32Z

Msu:

[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==
The Documents App is a file storage app that is organized into individual directories and checks user permissions. In this version, it only provides a plugin app for other apps.

== Features ==

* File storage plugin app
* Organized in directories
* User permission checks
* Convenient local editing of files with the myApp Client for Windows

== Requirements ==

* innovaphone myApps
* innovaphone AppPlatform
* UCC license
* An app that uses the Documents plugin app, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]
* An app for checking user permissions, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]

== Apps ==

* Plugin app only

== Licensing ==

* UCC license required for each user

== Configuration ==

==== Settings Plugin ====
An PBX app object is required that is permitted for users. The app object must have access to the Connect app.

==== Connect integration ====
The user must have access to the hidden Documents app.

== Documents in Connect ==
Via the Includes icon, the Documents App can be used inside a connect post.
Now, the wanted documents can be either uploaded via the "'''+'''"-Button or via drag & drop.

[[image:documents_in_connect_1.png]]

In the following image you can find explanations for the usage of documents in connect.

[[image:documents_in_connect_2.png]]

'''1.''' If a connect post has documens attached, you will see the Includes icon.
'''2.''' The modification date indicates, when the last change of the attached file was made.
'''3.''' Clicking on the three dots will give you the option to '''delete''', '''rename''' or '''download''' the attachment.
'''4.''' Clicking on the plugin symbol will show you a list of all attachments in a discussion on the top of connect. This makes it easier to find needed documents in a large discussion. To close this list, you have to click on the "'''X'''" in the right corner.

== Troubleshooting ==

==== App Service Log ====
* App
* App WebSocket
* Files

== Related Articles ==
[[Reference16r1:Concept_App_Connect]]

Reference16r1:Concept App Service Documents

2026-04-20T14:29:35Z

Msu: /* Documents in Connect */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==
The Documents App is a file storage app that is organized into individual directories and checks user permissions. In this version, it only provides a plugin app for other apps.

== Features ==

* File storage plugin app
* Organized in directories
* User permission checks
* Convenient local editing of files with the myApp Client for Windows

== Requirements ==

* innovaphone myApps
* innovaphone AppPlatform
* UCC license
* An app that uses the Documents plugin app, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]
* An app for checking user permissions, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]

== Apps ==

* Plugin app only

== Licensing ==

* UCC license required for each user

== Configuration ==

==== Settings Plugin ====
An PBX app object is required that is permitted for users. The app object must have access to the Connect app.

==== Connect integration ====
The user must have access to the hidden Documents app.

== Documents in Connect ==
Via the Includes icon, the Documents App can be used inside a connect post.
Now, the wanted documents can be either uploaded via the "'''+'''"-Button or via drag & drop.

[[image:documents_in_connect_1.png]]

In the following image you can find explanations for the usage of documents in connect.

[[image:documents_in_connect_2.png]]

'''1.''' If a connect post has documens attached, you will see the Includes icon.
'''2.''' The modification date indicates, when the last change of the attached file was made.
'''3.''' Clicking on the three dots will give you the option to '''delete''', '''rename''' or '''download''' the attachment.
'''4.''' Clicking on the plugin symbol will show you a list of all attachments in a discussion on the top of connect. This makes it easier to find needed documents in a large discussion. To close this list, you have to click on the "'''X'''" in the right corner.

== Troubleshooting ==

==== App Service Log ====
* App
* App WebSocket
* Files

== Related Articles ==
[[Reference16r1:Concept_App_Connect]]

Reference16r1:Concept App Service Documents

2026-04-20T14:23:04Z

Msu: /* Documents in Connect */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

* innovaphone PBX from version 16r1

== Overview ==
The Documents App is a file storage app that is organized into individual directories and checks user permissions. In this version, it only provides a plugin app for other apps.

== Features ==

* File storage plugin app
* Organized in directories
* User permission checks
* Convenient local editing of files with the myApp Client for Windows

== Requirements ==

* innovaphone myApps
* innovaphone AppPlatform
* UCC license
* An app that uses the Documents plugin app, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]
* An app for checking user permissions, e.g. innovaphone [[Reference16r1:Concept App Connect|Connect App]]

== Apps ==

* Plugin app only

== Licensing ==

* UCC license required for each user

== Configuration ==

==== Settings Plugin ====
An PBX app object is required that is permitted for users. The app object must have access to the Connect app.

==== Connect integration ====
The user must have access to the hidden Documents app.

== Documents in Connect ==
Via the plugin icon, the Documents App can be used inside a connect post.
Now, the wanted documents can be either uploaded via the "'''+'''"-Button or via drag & drop.

[[image:documents_in_connect_1.png]]

In the following image you can find explanations for the usage of documents in connect.

[[image:documents_in_connect_2.png]]

'''1.''' If a connect post has documens attached, you will see the plugin symbol.
'''2.''' The modification date indicates, when the last change of the attached file was made.
'''3.''' Clicking on the three dots will give you the option to '''delete''', '''rename''' or '''download''' the attachment.
'''4.''' Clicking on the plugin symbol will show you a list of all attachments in a discussion on the top of connect. This makes it easier to find needed documents in a large discussion. To close this list, you have to click on the "'''X'''" in the right corner.

== Troubleshooting ==

==== App Service Log ====
* App
* App WebSocket
* Files

== Related Articles ==
[[Reference16r1:Concept_App_Connect]]

File:Documents in connect 2.png

2026-04-20T13:40:28Z

Msu:

File:Documents in connect 1.png

2026-04-20T13:40:04Z

Msu:

Reference16r1:Concept App Connect

2026-04-17T14:26:12Z

Msu:

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== Documents App ===
The Documents App can be integrated inside connect, to share documents, presentations etc. with other users. 
For more information, see [[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]

[[image:connect_post_documents.png]]

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]
* [[#Archiving|Archiving]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location).
If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Service Documents

2026-04-17T14:23:21Z

Msu: /* Documents in Connect */

Reference16r1:Concept App Service Documents

2026-04-17T14:22:54Z

Msu:

Reference16r1:Concept App Connect

2026-04-17T14:21:16Z

Msu: /* Documents App */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

[[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== Documents App ===
The Documents App can be integrated inside connect, to share documents, presentations etc. with other users. 
For more information, see [[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]

[[image:connect_post_documents.png]]

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]
* [[#Archiving|Archiving]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location).
If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

File:Connect post documents.png

2026-04-17T14:20:59Z

Msu: Msu uploaded a new version of File:Connect post documents.png

File:Connect post documents.png

2026-04-17T14:18:37Z

Msu:

Reference16r1:Concept App Connect

2026-04-17T14:18:04Z

Msu: /* The Stream */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

[[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== Documents App ===
The Documents App can be integrated inside connect, to share documents, presentations etc. with other users. 
For more information, see [[Reference16r1:Concept_App_Service_Documents|the corresponding concept article]]

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]
* [[#Archiving|Archiving]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location).
If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-04-17T12:07:58Z

Msu: /* Configuration */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]
* [[#Archiving|Archiving]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location).
If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-04-17T12:02:08Z

Msu: /* Configuration */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

===== Archiving =====
Attachments from messages of different/all connect zones or even from chat can be archived, which reduces the size of the Messages App database, where everything is stored.
This helps to avoid a large volume of data in the database, since the attachments are stored external. A large volume of data in the database is particularly time-consuming when it comes to backups.

Users can still access the attachments as normal, at least as long as they haven’t been permanently deleted from the storage.

The archiving configuration can be found by Connect Administrators in the menu at '''Archiving'''.
[[image:connect_archiving.png]]

Clicking '''+''' adds a new archiving job.
[[image:connect_archiving_settings.png]]
======Settings for an archiving job======
'''Zone:''' Select individual zones, or if left blank, “all zones including chat”
'''Before Date:''' The date up to which attachments should be archived
'''Delete after archiving:''' Causes the attachments to be deleted from the Connect database. This means you can no longer edit them within Connect. You can only open them (Connect accesses the new storage location). If you permanently delete them from this storage location, you will of course no longer be able to open them in Connect either.
'''Storage type:''' currently only WebDAV
'''URL:''' Storage location
'''User/Key and Password/Secret:''' Authorization for storage
'''Execution:''' Date of execution, or interval for execution if applicable. If you select the interval, the date specified above is adjusted. So if it is one month prior to the first execution date, everything older than one month will also be deleted during the next execution.

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

File:Connect archiving settings.png

2026-04-17T12:01:30Z

Msu: Msu uploaded a new version of File:Connect archiving settings.png

File:Connect archiving settings.png

2026-04-17T11:58:23Z

Msu:

File:Connect archiving.png

2026-04-17T11:53:36Z

Msu:

Reference16r1:Concept App Service Documents

2026-03-27T10:17:44Z

Msu: /* Requirements */

Reference16r1:Concept App Service Documents

2026-03-20T10:10:32Z

Msu:

Reference16r1:Concept App Service Documents

2026-03-20T10:09:37Z

Msu: /* Requirements */

Reference16r1:Concept App Connect

2026-03-20T10:07:50Z

Msu:

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-03-20T10:06:54Z

Msu: /* connect admin-service mode */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services&action=edit&redlink=1|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-03-20T10:06:29Z

Msu: /* Features */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services&action=edit&redlink=1|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects&action=edit&redlink=1|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-03-20T09:59:18Z

Msu: /* Features */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services&action=edit&redlink=1|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept App Polls|Polls App]]
* Archiving attachments
* File Storage via [[Reference16r1:Concept App Service Documents|Documents App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services&action=edit&redlink=1|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects&action=edit&redlink=1|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference9:Concept USB Headset

2026-03-13T15:43:05Z

Msu: /* Yealink (Vendor ID 0x6993) */

[[Category:Concept9|{{PAGENAME}}]]
[[Category:3rdParty Headsets|{{PAGENAME}}]]

The IP102, IP112, IP222, IP222A, IP232 and IP270 telephones provide USB ports. This document lists supported USB headsets and describes how to install, configure and use these headsets on the mentioned phones.

For myApps, please refer to the myApps platform service article, [[Reference16r1:Concept myApps platform services#Device handling|section Device handling]]. 
For the former SoftwarePhone (end of support), please refer to the SoftwarePhone concept article, [[Reference12r2:Concept Softwarephone#Supported USB headsets|section supported USB Headsets]]. 
For IP63/IP65, please refer to the IP1202 concept article, [[Reference15r1:IP1202/IP1203 DECT System#Bluetooth Headset Support for IP63 / IP65|section Bluetooth Headset Support for IP63/IP65]]. 

==Applies To==
This information applies to
*IP112, IP222, IP232 Firmware V9hotfix7 and later
*IP270 firmware 16r1final and later

'''Note:''' USB Headsets supported by the '''innovaphone SoftwarePhone''' can be found [http://wiki.innovaphone.com/index.php?title=Reference9:Concept_USB_Headset_For_SoftwarePhone here].

==More Information==

===Disclaimer===
Only the devices listed here have been tested or will be tested by innovaphone AG, therefore only these headsets are supported by us. But nevertheless you could not be sure, every device with the same label or the same part number will work in the same way, because of different product codes or modified firmware. So it is recommended to test the headset before buying.

It is also a good idea, to install the software attached to the headset on the PC and first connect the device to the PC to update the firmware and to pick out the specifications before using the headset with the phone.

===Installation===
Follow the vendor setup directions for using the headset with a PC but connect the USB plug of the headset to an USB slot of above mentioned innovaphone desk phone models.
There is no need to install any vendor provided PC software.

Some headsets are designed to be connected both to a telephone via DHSG, AEI or a similar protocol and to a PC via USB.
In this case you must also set up the headset for use with a PC, sometimes a special keypress is required to fix this setting.

===Configuration===
An USB headset is detected and automatically enabled as soon as it is connected to one of the phones a USB ports.

Enabling the headset has the following effects:
* a headset icon is displayed in the phone status line
* a normal inbound call is indicated by a ring tone in the headset (if this is supported by the headset)
* an automatically connected inbound call ((announcement, broadcast) is connected to the headset (not to the speaker as usual)
* a call initiated by pressing the ''Redial'' key while browsing a call list or a directory is connected to the headset
* a call initiated by pressing the ''Redial'' in indirect dialling mode is connected to the headset

Before V9hotfix9 it's was necessary to enable the headset explicitely at the telephone either by setting "Menu/Phone Setup/Headset: On" or by a ''Headset'' function key with ''Mode: Enable''. This is obsolete now.

===Call Control===
The IP2x2 telephones don't provide a hardware key to control the headset but if required a ''Headset'' function key with ''Mode: Control'' can be defined to setup/accept calls via headset directly on the telephone.
Headset call control can be performed in different ways:
* by the ''Talk'' key on the headsets base station
* by the ''Talk'' key on the headset itself
* by the ''Headset:Control'' function key
* by the ''Redial'' key (outbound calls only)

Some headsets require that all call control is performed by a ''Talk'' key, otherwise the media connection between base and headset gets lost.
Call control by a ''Talk'' key works only if the headset is known to the firmware!

Before V9hotfix9 setting up outbound calls via a ''Talk'' key was disabled and had to be to be enabled via the WEB interface by checking "Phone/Preferences/Start Outbound Call on Electronic Hook Switch (EHS) Signal". This is obsolete now.

====Outbound Calls====
* enter a number and press ''Redial''
* select an entry in a call list or a directory and press ''Redial''
* press a ''Talk'' key and enter the number (if this function is enabled)
* press the ''Headset:Control'' function key and enter the number

To drop the call press a ''Talk'' key, the ''Disconnect'' key or the ''Headset:Control'' function key.

====Inbound Calls====
To accept an inbound call press a ''Talk'' key or the ''Headset:Control'' function key.
To drop the call press a ''Talk'' key, the ''Disconnect'' or the the ''Headset:Control'' function key.

===Headset Volume Control===
====Speaker Volume====
Usually the headset provides it's own speaker volume control and this should be preferred.
The phone volume control keys can be used (range 1 (min to the left) to 10 (max to the right) when the range of the headset volume control is not sufficient. However, be aware that higher values can result in signal distortions (clipping) to the headset which creates bad quality. Use the phone's headset volume control only to compensate for exceptional low volume callers, the general headset volume should always be adjusted in the headset with the phone's headset control set to a middle value (i.e. 5).

====Microphone Volume====

Usually there is no need to change the phones default gain for the headset microphone signal.
But there are rare cases where the microphone signal is too strong or even more rarely too weak.
In this cases the gain can be changed by config commands entered in the browser address line:

config add AC-DSP0 HEADSET /InputGain ''gain''
config activate
config write

''gain'' values from 1 to 63 can be configured (1/2 dB steps). A value of 32 means 0dB, lower values mean attenuation, higher values amplification.
The default value is 40 i.e. 8dB amplification.

====Microphone Mute====
Usually the headset provides it's own ''Mute'' button and this should be preferred.
The phones ''Mute'' function is independent of the headset function, i.e. a headset muted via its own button can be unmuted only via this buton but not at the phone.

==Known Problems==
Monitor Mode does not work with USB headsets, i.e. the telephone speaker cannot switched on in addition to the headset.

==Supported Headsets==

===Abbreviations===

PN = Part Number as printed on the package (P/N: or PN: or Part No or ...)

ID = USB procuct id as read from the device (idProduct)

YES = feature tested and fully operational

NO = feature not supported by innovaphone

N/A = device does not provide functionality

===Gigaset (Vendor ID 0x1e85)===
====Wireless====
====='''ION - DECT Handset/Speaker (S30852-H2970-R101, ID 0x111d)'''=====
(from v11r2sr63, v12r2sr58, v13r1sr43, v13r2sr17) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 
YES1 Tap on Call Key 
YES2 Tap on End-Call Key 
 

===Jabra / GN Netcom (Vendor ID 0x0b0e)===
====Wireless====
Jabra Link 14201-30 (ID 0x0925) connects the headsets DHSG ports with the USB interface of the telephone
====='''GN 9350e (PN 9356-607-401, ID 0x9350)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | NO
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
NO1The media channel between base and headset can be activated/deactivated only by the headset or the base but not by the phone 
End of Sales 30.06.2013, End of Life 30.06.2015 for EMEA und APAC
 

====='''Pro 9450'''=====
Pro 9450 (PN 9450-25-507-101, ID 0x1021) 
Pro 9450 Duo EMA (PN 9450-29-707-101, ID 0x1022) 
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 5
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES 2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 4
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 1
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A 7
|-
|}
 

====='''Pro 9460 (PN 9460-25-707-101/9460-29-707-101 ID 0x1041/0x1043'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 6
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A 7
|-
|}
 

====='''Pro 9470 (PN 9470-26-904-101, ID 0x1042)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 6
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A 7
|-
|}
 

====='''GO 6470 (PN 6470-15-207-501, ID 0x1003,0x1004, Firmware 4.5.17)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 6
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A 7
|-
|}
 

====='''Pro 920 (PN 920-25-508-1)'''=====
connected with '''Jabra Link 14201-30''' to '''DHSG''' port 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
|}
 
====='''Pro 930 (PN 930-25-509-101, ID 0x1016, 0x1017)'''=====
(ID 0x1016 since V9hotfix12, ID 0x1017 since V9hotfix24) 
The Talk-Button works only with the device ''Softphone'' setting ''Other''. 
This can be configured in the Jabra Control Center under 
''Advanced View/Softphone(PC)/Target Softphone for outgoing calls/Softphone'' 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A
|-
|}
 

====='''Pro 935 BT'''=====
PN 935-15-509-201 200614 Version A, ID 0x1037 (Alpha3 - For Evaluation only) 
PN 935-15-509-201 261114 Version A, ID 0x1037 
(since V9hotfix35) 
A double tap on the headset talk button when phone is idle does not work as expected.
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | NO
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 1
|-
|}
 

====='''GO 660 (PN 5078-228-209, ID 0x0320)'''=====
The Jabra GO 660 Bluetooth headset system consists of the Jabra EXTREME™ headset 
and the Jabra LINK 320 USB Bluetooth adapter. 
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
|-
|}
 

====='''SUPREME UC / MOTION UC'''=====
SUPREME UC (PN 5078-230-310) 
The Jabra SUPREME UC Bluetooth headset system consists of the Jabra SUPREME™ headset (tested firmware version 2.5.2) 
and the Jabra LINK 360 USB Bluetooth adapter, ID 0xa346. 
MOTION UC (PN 6640-906-140) 
The Jabra MOTION UC Bluetooth headset system consists of the Jabra MOTION headset (tested firmware version 1.36.2) 
and the Jabra LINK 360 USB Bluetooth adapter, ID 0xa346 (tested firmware version 1.14.0). 
(since V9hotfix13) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
 

====='''GO 6430 (PN 6430-17-20-201, ID 0xa342, Firmware 5.4.17)'''=====
The Jabra GO 6430 Bluetooth headset system consists of the Jabra GO 6430 headset 
and the Jabra LINK 350 USB Bluetooth adapter. 
(since V9hotfix13) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
 

====='''EVOLVE 65 UC & Link 360'''=====
The Jabra EVOLVE 65 UC Stereo Bluetooth headset package (PN 6599-829-409 - 10/04/15 Version A - Stereo UC & Link 360) 
consists of the Jabra EVOLVE 65 UC Stereo headset (ID 0x030b, tested firmware version 1.5.6) 
and the Jabra LINK 360 USB Bluetooth adapter(ID 0xa346, tested firmware version 1.2.2). 
The Jabra EVOLVE 65 UC Stereo headset can also be used as a plain corded USB headset without key control. 
(since v9hotfix43/v10sr17) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 
====='''EVOLVE 65 SE/TE & Link 390'''=====
The Jabra EVOLVE 65 SE/TE + Link 390 Bluetooth headset packages consist of a 
headset, a Jabra Link 390 USB Bluetooth adapter and an optional charging station. 
A Link 390 (ID 0x2e51, firmware version 1.3.0) was tested, 
a Link 390 (ID 0x2e50, firmware version 1.0.0) was reported but not tested yet. 
(since v13r3sr21/v14r1sr9/v14r2sr4) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 

====='''EVOLVE2 65/75 UC & Link 380a'''=====
The Jabra EVOLVE2 65 UC Stereo Bluetooth headset package (PN 26599-989-999 - Version A - Jabra Evolve2 65 Link 380a) 
consists of the Jabra Evolve2 65 UC Stereo headset (tested firmware version 2.7.7) 
and the Jabra Link 380a USB Bluetooth adapter(ID 0xa346/0x447, tested firmware version 1.12.4). 
The Jabra EVOLVE2 65 UC Stereo headset can also be used as a plain corded USB headset without key control. 
(since - 11r2sr60, 12r2sr54, 13r1sr38, 13r2sr11) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 

====='''EVOLVE 75 UC & Link 370'''=====
The Jabra EVOLVE 75 UC Stereo Bluetooth headset package (PN 7599-838-199 - 02/10/17 Version A - Headset & Charging Stand & Link 370) 
consists of the Jabra EVOLVE 75 UC Stereo headset (ID ?, tested firmware version 1.12.0) 
and the Jabra LINK 370 USB Bluetooth adapter(ID 0x245d, tested firmware version 1.14.0). 
(since v10sr44/v11r2sr26/v12r1sr10/v12r2final) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 

====='''ENGAGE 55 & Link 400'''=====
The Jabra ENGAGE 55 headset package (PN: 9553-410-111 - W15M Version A, Mono, USB-A, UC, EMEA/APAC) 
consists of the Link 400 USB/DECT adapter (tested firmware version 1.0.9) and a Mono headset. 
The headset can also be used as a plain wired USB audio headset at a PC. 
(since v12r2sr56, v13r1sr41, v13r2sr14) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES 
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 

====='''Engage 65 (PN 9559-553-111, ID 0x111a,0x1121,0x1122 Firmware 1.8.4)'''=====

==== '''Engage 65 SE (PN 9653-553-111, ID 0x1146,0x1147,0x1148,0x114e,0x114f,0x1150,0x1151 Firmware 1.8.5)''' ====
To use a Jabra Link 14201-30 (ID 0x0925) to connect the Desk Phone (DHSG) port of the base to the USB interface of the phone 
''Automatic hook lifter type detection=Off'' and ''Electronic hook lifter=DHSG'' must be configured at the base with the ''Jabra Direct'' utilty.<br\>
(since V12r2sr14) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
|}
 

====='''Engage 75 (PN 9556-583-111, ID 0x1113/0x1114, Firmware 1.8.4/0.0.0)'''=====
To connect the Engage 75 base to a phone the USB phone port should be preferred. 
Alternatively a Jabra Link 14201-30 may be used (see Engage 65 above for settings and functions).

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" | USB phone port
! align="center" style="background:#f0f0f0;" colspan="3" | USB PC port
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES 8
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES 8
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
|}
 

==== '''Engage 75 SE (PN 9656-583-111, ID 0x1140,0x1141,0x1142,0x1143,0x1143,0x114a,0x114b,0x114c,0x114d,0x114e)''' ====
'''Attention'''! To connect the Engage 75 SE base to phone a Jabra Link 14201-30 '''should''' be used! 
Connections to phone via the USB phone port don't work stable.
 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
|}
 

YES 1 Double Tap 
YES 2 Long Press (hold 1-2 seconds) 
YES 3 Touch Red Handset Icon 
N/A 4 Double Tap - not supported by DHSG 
N/A 5 Press (hold 1-2 seconds) - not supported by DHSG 
N/A 6 Not transfered to the Phone 
N/A 7 Not available via Touch Screen Menu 
YES 8 Touch Green Handset Icon 

====Corded====
====='''Link 260 (PN: 260-09 ID 2319)'''=====
(since xxx)

====='''BIZ 2300 USB'''=====
BIZ 2300 USB UC Mono (PN 2393-829-109 ID 0x2301) 
(since v10sr6 / v9hotfix32) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Press Flash button when there is a connected and a waiting call 
 

====='''BIZ 2400 USB'''=====
BIZ 2400 USB Mono (PN 2496-829-104, ID 0x2400) 
BIZ 2400 MS USB Mono (PN 2496-823-104, ID 0x2401) 
BIZ 2400 USB Duo (PN 2499-829-104, ID 0x91c) 
BIZ 2400 USB OC (PN 2499-823-104, ID 0x090a) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
====='''BIZ 2400 II USB'''=====
BIZ 2400 II Duo USB (PN 2499-829-209 - 06/01/16 Version A - ID 0x2452, tested firmware version 1.1.2) 
(since v10sr32, v11r2sr10) 
BIZ 2400 II Duo USB UC - (PN 2499-829-309 Version A - ID 0x2322) 
BIZ 2400 II Mono USB UC - (PN 2496-829-309 - Version A - ID 0x2321) 
(since v10sr36, v11r2sr16, v12r1sr1) 
BIZ 2400 II Mono USB BT - (PN 2469-829-209 Version A - ID 0x2451 
BIZ 2400 II Mono USB - (PN ... - ID 0x2450) 
(since v11r2sr34, v12r1sr18, v12r2sr10) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
 

====='''LINK 280 (PN 280-09, ID 0x0910)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
====='''SPEAK 410/510/710/750/810'''=====
Jabra SPEAK 710 Beta (PN 7710-209 17/07/17 Version A, ID 0x2475) 
Jabra SPEAK 710 (PN 7710-409 01/12/17 Version A, ID 0x2475) 
Jabra SPEAK 710 MS (tested by customer, ID 0x2476) 
(since v11r2sr29, v12r1sr13, v12r2sr3) 
Jabra SPEAK 750 UC (ID 0x24b1 - PN 7700-409 - W06L Version: A - Jabra Speak 750 - UC USB/BT & Link370) 
(since v12r2sr44, v13r1sr26) 
Jabra SPEAK 810 (evaluation sample, ID 0x2454) 
(since v10sr32, v11r2sr10) 
Jabra SPEAK 810 (ID 0x2456) 
(since v11r2sr17, v12r1sr2) 
Jabra SPEAK 510 UC (PN 7510-209, ID 0x0410,0x0412) 
(since V9hotfix24) 
Jabra Speak 510 mit Bluetooth Dongle Link 360 (PN 7510-409 - "refer info from partner") 
Jabra SPEAK 410 (PN 7410-209, ID 0x0420) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|}
 
====='''SPEAK2 55/75'''=====
Jabra SPEAK2 55 - P/N: 2755-209 W51N Jabra Speak2 55 UC - ID 0xae6c 
Jabra SPEAK2 75 - P/N: 2775-419 W17N Jabra Speak2 75 UC - ID 0x24ef - Link 380a - ID 0x24c7 
(since v13r3sr19, v14r1sr7, v14r2sr2)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|}
 
YES1 Double Tap 

====='''UC VOICE 550 / 750'''=====
Jabra UC VOICE 550 Mono (PN 5593-829-209, ID 0x0031) 
Jabra UC VOICE 550 Duo (PN 5599-829-209, ID 0x0030) 
(since V9hotfix12) 
Jabra UC VOICE 750 MS Duo (PN 7599-823-109, ID 0x0752) 
(since V9hotfix24) 
'''Please Note''': Headsets with '''Version A''' printed on the package have IDs different to the non-A versions even if the part numbers do not differ. 
Jabra UC VOICE 550 Mono (PN 5593-829-209 02/26/13 Version A, ID 0x034b) 
Jabra UC VOICE 550 Duo (PN 5599-829-209 06/12/13 Version A, ID 0x0349) 
Jabra UC VOICE 550 MS Duo (PN 5599-823-109 02/26/13 Version A - optimized for Lync, ID 0348) 
Jabra UC VOICE 750 Mono Drk (PN 7593-829-409 28/08/13 Version A, ID 034f) 
Jabra UC VOICE 750 MS Duo Drk (PN 7599-823-309 28/08/13 Version A - optimized for Lync, ID 034c) 
(since V10 SR5 / V9 hotfix 31) 
Jabra UC VOICE 750 MS Duo Drk (PN 7599-829-409 29/12/14 Version A, ID 034d) 
(since V10 SR15 / V9 hotfix 41) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 


====='''EVOLVE 20/30/40/80, EVOLVE2 40/50'''=====
Jabra EVOLVE 40 MS Stereo - (PN 6399-823-109 - 10/04/15 Version A - ID 0x0305, tested firmware version 1.2.0) 
Jabra Evolve 40 MS Duo USB NC - (PN unknown - ID 0x0307, tested firmware version 1.2.0 
Jabra EVOLVE 80 UC Stereo - (PN 7899-829-209 - 04/02/15 Version A - ID 0x0306, tested firmware version 1.1.6) 
(since v9hotfix43/v10sr17) 
Jabra EVOLVE 20 MS Mono - (ID 0x0302, tested firmware version 1.1.7) 
(since v9hotfix55/v10sr33/v11r2sr12/v12r1) 
Jabra EVOLVE 20 UC Mono - (ID 0x0301, tested firmware version 2.0.0) 
Jabra EVOLVE 20 UC Stereo - (ID 0x0303, tested firmware version 2.0.0) 
(since v11r2sr19/v12r1sr2) 
Jabra EVOLVE 20 MS Stereo - (ID 0x0300, tested firmware version 1.1.7) 
(since v11r2sr27/v12r1sr11) 
Jabra EVOLVE 30 II Mono UC - (PN 5393-829-309 - 07/03/17 Version A - ID 0x0312, tested firmware version 1.0.4) 
Jabra EVOLVE 30 II Stereo MS - (PN 5399-823-309 - 16/03/17 Version A - ID 0x0315, tested firmware version 1.0.4) 
(since v11r2sr20/v12r1sr4) 
Jabra EVOLVE 30 II Stereo UC - (ID 0x0313, not tested, dongle identical to Mono version) 
Jabra EVOLVE 30 II Mono MS - (ID 0x0314, not tested, dongle identical to Stereo version) 
(since v11r2sr23/v12r1sr7) 
Jabra EVOLVE 40 UC Mono - (PN 6393-829-209 - 05/11/16 Version B - ID 0308) 
(since v10sr43/v11r2sr25/v12r1sr9) 
Jabra EVOLVE2 40 (ID 0x0e41 P/N: 24089-989-999 - W50K Version: A - Jabra Evolve2 40 - USB-A, UC Stereo, ID 0x0e41, fw version 1.1.9) 
(since v12r2sr44, v13r1sr26) 
Jabra EVOLVE2 50 - P/N:25089-989-999 - W170 Version: Jabra Evolve2 50 / USB A UC Stereo, ID 0x2505

(since v13r3sr19, v14r1sr7, v14r2sr2) Attention: current versions of Jabra Evolve 50 can be used as plain audio devices only, calls cannot be answered/ended at headset
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
 

YES1 Double Tap 
YES2 Press (hold 1-2 seconds) 
 

====='''Engage2 40 SE Mono/Stereo'''=====
P/N:24189-989-999 - W28N Version: A - USB A UC Stereo / ID=0x2e41 release=0111 
P/N:24189-889-999 - W28N Version: A - USB A UC Mono / ID=0x2e43 release=0111 
(since v13r3sr16/v14r1sr4) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
|}
 

YES1 Press (hold 1-2 seconds) 

====='''Engage 50 MS/UC Mono/Stereo & Engage Link, Engage 50 II Stereo & Engage II Link '''=====
The product ID seen at the USB interface depends on the headset connected to the Engage Link. 
Only one variant was tested because all variants behave identical at the USB interface. 
Jabra Engage 50, Stereo, Headband w. USB-C (P/N: 9099-610-189 18/01/19 Version: A 
Jabra Engage LINK USB-A,MS - P/N: 50-119, 12/12/18 Version: A, ID 0x4002 
Further product IDs: 0x4001(MS/Mono), 0x4003(UC/Mono), 0x4004(UC/Stereo) 
(since v11r2sr43/v12r2sr22) 
Jabra Engage 50 II - P/N: 9099-299-2219 / W180 Version B / Jabra Engage 50 II / 50 II Link, Stereo USB A UC / ID0x0x4051 
No further product IDs known so far. 
(since v13r3sr19/v14r1sr7/v14r2sr2) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Toggle between active and held call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1 
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 

YES1 Double Tap 
YES2 Press (hold 1-2 seconds) 

===Plantronics/Poly/HP (Vendor ID 0x047f) ===

====Wireless====

To connect the phone USB port to the EHS (Electronic Hook Switch) port of a Plantronics 
wireless base station (Savi 700 series and others) the following EHS adapters can be used: 
* APU-70 (PN 83 018-01, ID 0x0410)
* APU-72 (PN 202578-01, ID 0x0410)
* APU-75 (PN 202678-01, ID 0xaf08)
* APU-75 (PN 202678-02, ID 0xaf0c)

Attention: there are two versions of the APU-72 but only one (the initial) version works correctly with our phones. 
Because both versions come with the same ID it cannot be guaranteed that an APU-72 works as expected. 
Thus the APU-75 should be preferred.

'''[Note]: Below statement concerning APU-76 compatability was created by a 3rd-party author. innovaphone is not responsible for the content and has not performed any tests.'''

* APU-76 don't work correctly, with a workaround you can set it to an APU-75
** Phones appear to work on whitelist of supported devices. It is possible to map unsupported device (APU-76) to a working one (APU-75) by adding following lines:
** !config add KEYS0 /hid-map 047f:af0b=047f:af08
** !config write
** !config activate
** Reattach USB to make it work, don't need to reboot phone. Above commands work by telling it to treat a connected APU-76 as if it were an APU-75.

====='''Voyager PRO UC / Legend UC'''=====
Voyager Legend UC (PN 87670-02) 
(since V9hotfix24) 
Voyager PRO UC v2 (PN 38885-02) 
Open phone line on target phone from headset supported since V9hotfix24 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Call back last call
| style="text-align:center" | YES
| style="text-align:center" | NO
| style="text-align:center" | N/A
|-
| Initiate phones voice dialling
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
| Reconnect lost connection
| style="text-align:center" | N/A
| style="text-align:center" | not tested
| style="text-align:center" | N/A
|-
|}
 
====='''VOYAGER FOCUS UC BT (Headset + BT600 USB/BT Adapter)'''=====
VOYAGER FOCUS UC BT Headset 8825,WW (PN 202652-01) 
(since V10sr30, V11r2sr8) 
Poly BT600 USB/BT Adapter (PN 204880-01/85Q81A,2025, ID 0x02EE/0x02EF) 
Attention: must be paired to a headset before use at phone! 
(since V14r2sr15, V15r1sr7) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Call back last call
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Initiate phones voice dialling
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
|}
 

====='''VOYAGER 5200 / 8200 UC BT (Headset + BT600 USB/BT Adapter)'''=====
VOYAGER 5200 UC BT Headset 
(since v10sr36, v11r2sr16, v12r1sr1) 
VOYAGER 8200 UC BT Headset 
(since v11r2sr36 / v12r1sr20 / v12r2sr12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Call back last call
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Initiate phones voice dialling
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
|}
 

===== '''Any headset connected to the BT700 USB/BT Adapter'''=====
Not supported (does not function as a standard USB HID/Audio device).

====='''Savi W430'''=====
Headset connected via Plantronics D100 USB/DECT adapter (ID 0xab01) 
(since V9hotfix12) 
Attention! Since V9hotfix23 only D100 adapters with a firmware Version greater or equal 0118 will work correctly. 
In case of problems use Plantronics Update Manager to update your D100 adapters to the latest firmware version. 
Attention! D100-A adapters have the same signature as the original D100 adapters but work differently. 
They will work only when the workaround under (Known Problems/Plantronics D100-A ID=ab01) has been applied. 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | N/A
|-
|}
 

====='''Savi W440A (PN 83359-02)'''=====
Headset connected via Plantronics D100 USB/DECT adapter (ID 0xab01) 
Attention! Since V9hotfix23 only D100 adapters with a firmware Version greater or equal 0118 will work correctly. 
In case of problems use Plantronics Update Manager to update your D100 adapters to the latest firmware version. 
Attention! D100-A adapters have the same signature as the original D100 adapters but work differently. 
They will work only when the [[#Plantronics D100-A ID.3Dab01|workaround below]] has been applied. 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Flash between calls
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
|}
 

====='''Savi W740 / W745'''=====
Savi 740 (PN 83542-12, ID 0xac01/0xac11) 
Savi 745 (PN 86507-03, ID 0xac01) 
(since V9hotfix14) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Plantronics APU-70 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 1
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | NO 2
| style="text-align:center" | N/A
|-
|}
N/A1 Press volume up or down at least 1,5 seconds (not supported by DHSG) 
NO2 Press volume up or down at least 1,5 seconds (not passed to the phone) 
 

====='''Savi 8210 / 8220 / 8240'''=====
Savi 8210 (PN 207309-12, ID 0xac22/0xac2b) 
Savi 8220 (PN 207325-12, ID 0xac20/0xac29) 
Savi 8240 (PN 211819-02, ID 0xac2b) 
(since v11r2sr47/v12r2sr29/v13r1sr7) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Plantronics APU-72 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 1
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A
|-
|}
N/A1 not supported by DHSG 
YES2 Press Talk button for about 2 seconds until a beep is heard 
 

====='''Calisto 620 (PN 86700-02)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | NO 1
|-
|}
NO1 Mute button present but did not work on tested sample 
 

====='''Calisto P835 (PN 85335-03)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Answer incoming call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| End current call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Volume
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Mute
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Flash between calls
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
|}
 

====Corded====
====='''DA 45 / DA45 with EncorePro HW301N'''=====
DA 45 PN 77559-42 ID 0xaa05 
(DA45 Firmware Version 90 supported since V9hotfix24)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Long press on Talk button when there is a connected and a waiting call 
 
====='''DA70 with EncorePro HW540'''=====
DA70 PN 201851-02 ID af00 
(supported since v11r2sr17, v12r1sr2) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
|}
 

====='''DA80 / DA90 with EncorePro HW540'''=====
DA80 PN 201852-02 ID af01 
DA80 PN 201853-02 ID af02 
(supported since v11r2sr17, v12r1sr2) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Long press on Talk button when there is a connected and a waiting call 
 

====='''Blackwire C320 / C520 / C325.1 / C5210 / C5220 '''=====
Blackwire C320 (PN 85619-02, ID 0xc00f) 
(since V9hotfix23) 
Blackwire C520 (PN 88861-01, ID 0xc017) 
(since V9hotfix24) 
Blackwire C325.1 (PN 204446-02 ID 0xc03a) 
(since v10sr44/v11r2sr26/v12r1sr10) 
Blackwire C5210 (PN 207577-01, ID 0xc054) 
Blackwire C5220 (PN 207576-01, ID 0xc053) 
(since v11r2sr36 / v12r1sr20 / v12r2sr12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Press Talk button for at least 2 seconds when there is a connected and a waiting call 
 

====='''Blackwire C420 (PN 82632-05 ID 0xaa14)'''=====
(since V9hotfix24)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Press Talk button for at least 2 seconds when there is a connected and a waiting call 
 

====='''Blackwire C435 (PN 85800-05, ID 0xaa12,0xc04e)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

====='''Blackwire C620 (PN 81965-42 ID 0xaa00)'''=====
(since V9hotfix24)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Press Talk button for at least 2 seconds when there is a connected and a waiting call 
 

====='''Blackwire C720 (PN 87670-02, ID 0x010a)'''=====
(since V9hotfix23) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Answer incoming call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| End current call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Volume
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Mute
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
|}
 

====='''Calisto P420 USB Speakerphone (PN 82136-02 ID 0xd101)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

====='''Calisto P7200 USB/Bluetooth Speakerphone (PN 207913-01 ID 0x1200)'''=====
(since V12r2sr16) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

===Sennheiser/Epos (Vendor ID 0x1395) ===

====Wireless====
The EHS port of the headset base can be connected to the USB port of the telephone with
* Sennheiser CEHS-CI 02 (Prod. Code 504533, ID 0x0925)
* EPOS CEHS-CI 02 II (Art.-No 1000747, ID 0x029e)
====='''DW Office (PN 504300, ID 0x740a)'''=====
====='''DW Office ML (PN 504454, ID 0x740a)'''=====
====='''DW Pro 1 (PN 504304, ID 0x740a)'''=====
====='''DW Pro 1 ML (PN 504458, ID 0x740a)'''=====
====='''DW Pro 2 (PN 504308, ID 0x740a)'''=====
====='''DW Pro 2 ML (PN 504462, ID 0x740a)'''=====
(since V9hotfix13) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |CEHS-CI 02 to EHS port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
| Redial last number 
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A
|-
|}
 
YES1 Long press on Talk button when there is a connected and a waiting call 
YES2 Long press on Talk button when phone is idle 

====='''DW 10 USB (PN 506412, ID 0x740a)'''=====
====='''DW 10 USB ML (PN 506416, ID 0x740a)'''=====
(since xxx)
====='''EPOS SDW 5033 Art.No 1001016 | Model SCDB3/SCDH3 | FW 2.2.31 ID 0x00bb)'''=====

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Redial last number 
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
|}
 

====='''Presence UC ML - Headset + USB-Bluetooth dongle BTD 800 USB for Lync (PN 504575, ID 0x002d)'''=====

====='''Presence UC - Headset + USB-Bluetooth dongle BTD 800 USB (PN 504576, ID 0x002d)'''=====
(since v10sr6 / v9hotfix32) 

====='''MB Pro2 UC - Headset + USB-Bluetooth dongle BTD 800 USB (PN 506045, ID 0x002d)'''=====

====='''MB Pro2 UC ML - Headset + USB-Bluetooth dongle BTD 800 USB for Lync (PN 506046, ID 0x002d)'''=====
(since v10sr34 / v11r2sr13 

====='''MB 660 UC - Headset + USB-Bluetooth dongle BTD 800 USB (PN 506???, ID 0x002d)'''=====

====='''MB 660 MS - Headset + USB-Bluetooth dongle BTD 800 USB for Lync (PN 506???, ID 0x002d)'''=====

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | NO1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES3
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | YES4
|-
|}
 
NO1 Long press on Talk button (1 sec) is not reported to phone when there is a connected call 
YES2 Long press on Talk button (1 sec) when phone is ringing 
YES3 Double tap on Talk button when there is a connected and a waiting call 
YES3 Double tap on Talk button when phone is idle 
 

====='''SP 30 + BT Speakerphone with Dongle (PN 508346, Dongle - BTD 800 USB for Lync ID=008e)'''=====
(since v11r2sr44, v12r2sr25, v13r1sr3) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES3
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | YES4
|-
|}
 

YES1 Press Onhook (red) button when phone is ringing 
YES2 Double tap on Offhook (green) button 
YES3 Double tap on Offhook (green) button when there is a connected and a waiting call 
YES4 Double tap on Offhook (green) button when phone is idle 
 

====='''EPOS IMPACT 1060T ANC - BT Headset with EPOS BTD 800 III Dongle (Art. No. 1001163, Headset ID=0186 | Dongle ID=0189)'''=====
(since v13r2sr24, v14r1sr11, v14r2sr7) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES3
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 
YES1 Press Talk button 2 seconds when phone is ringing 
YES2 Double tap on Talk button 
YES3 Double tap on Talk button when there is a connected and a waiting call 
 

====Corded====

====='''UUSB8 (PN 504004, ID 0x0008)'''=====
(since V9hotfix13) 
====='''USB-ED CC 01 (PN 506478, ID 0x0051)'''=====
====='''USB-ED CC 01 MS (PN 506479, ID 0x0058)'''=====
(since v11r2sr36 / v12r1sr20 / v12r2sr12) 

====='''SC 45/75 USB CTRL (PN 507084/507087 ID 0x0061/0x0061)'''=====

====='''SC 45/75 USB MS (PN 507083/507086 ID 0x0060/0x0060)'''=====
====='''SC 260 USB CTRL(PN 504406 ID 0x0029)'''=====
(since v11r2sr33 / v12r1sr17 / v12r2sr8) 

====='''SC 30/60 USB CTRL (PN 504548/504548 ID 0x0034/0x0035)'''=====

====='''SC 30/60 USB ML (PN 504546/504547 ID 0x0032/0x0033)'''=====

====='''SC 40/70 USB CTRL (PN 506500/506504, ID 0x005b/0x005c)'''=====

====='''SC 40/70 USB MS (PN 506498/506502, ID 0x005a/0x005a)'''=====

====='''SC 230/260 USB Ctrl II (PN 506480/506481, ID 0x004d/0x004e)'''=====

====='''SC 230/260 USB MS II (PN 506482/506483, ID 0x004f/0x0050)'''=====

====='''SC 660/630 USB CTRL (PN 504555/..., ID 0x0039)'''=====
====='''SC 660/630 USB ML (PN 504553/..., ID 0x0037)'''=====
(since v10sr34 / v11r2sr13) 
====='''SC 660 ANC USB (PN 508311/..., ID 0x0082)'''=====
(since v11r2sr44, v12r2sr25, v13r1sr3) 

====='''SC 630 USB CTRL (PN 504554, ID 0x0038)'''=====
(since v10sr43 / v11r2sr25 / v12r1sr9) 

====='''SC 635/665 USB (PN 504554, ID 0x006b)'''=====
(since v11r2sr36 / v12r1sr20 / v12r2sr12) 
====='''SC 130 USB (PN 508314, ID 0x0083)'''=====
====='''SC 130 USB-C (PN 508353, ID 0x0083)'''=====
====='''SC 160 USB (PN 508315, ID 0x0084)'''=====
====='''SC 160 USB-C (PN 508354, ID 0x0084)'''=====
====='''SC 135 USB (PN 508316, ID 0x0085)'''=====
====='''SC 135 USB-C (PN 508355, ID 0x0085)'''=====
====='''SC 165 USB (PN 508317, ID 0x0085)'''=====
====='''SC 165 USB-C (PN 508356, ID 0x0085)'''=====
(since v11r2sr44, v12r2sr25, v13r1sr3) 

===== '''EPOS IMPACT 460T Art. No. 1001253 | Model DSWH1 | FW 42 ID=0781''' =====
(since v13r3sr24, v14r1sr11, v14r2sr7) 
===== '''EPOS IMPACT 460 | Art. No. 1001251 | Model DSWH1 | FW 42 ID=0783''' =====
===== '''EPOS IMPACT 100 | Art. No. 1001421 | Model DSWH10 | FW 46 ID=0785''' =====
(since v13rsr30/v14r2sr13/v15r1sr5)

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES3
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | YES4
|-
|}
 
YES1 Press Talk button when phone is ringing 
YES2 Double tap Talk button 
YES3 Double tap Talk button when there is a connected and a waiting call 
YES4 Double tap Talk button button when phone is idle 
 

====='''SP 10 Speakerphone for PC (PN 506047 ID 0x0042)'''=====
====='''SP 10 ML Speakerphone for Lync (PN 506048, ID 0x0043)'''=====
(since v12r2sr7) 
====='''SP 20 Speakerphone for PC (PN 506049 ID 0x003f)'''=====
====='''SP 20 ML Speakerphone for Lync (PN 506050, ID 0x0041)'''=====
(since v10sr34, v11r2sr13) 
====='''SP 30 + BT Speakerphone with Dongle (PN 508346, ID 0x006d)'''=====
(since v11r2sr44, v12r2sr25, v13r1sr3) 

====='''SP 220 UC Dual Speakerphone UC / mobile (PN 507210, ID 0x0066)'''=====
====='''SP 220 MS Dual Speakerphone MS Certified (PN 507211, ID 0x0067)'''=====
(since xxx) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES3
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | YES4
|-
|}
 
YES1 Press Onhook (red) button when phone is ringing 
YES2 Double tap on Offhook (green) button 
YES3 Double tap on Offhook (green) button when there is a connected and a waiting call 
YES4 Double tap on Offhook (green) button when phone is idle 
 

====='''Team Connect Wireless Conference System (PN 506686/..., ID 0x1400)'''=====
(since v10sr47, v11r2sr29, v12r1sr13, v12r2sr3) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | NO
|-
|}
 
YES1 Tap on USB icon 
YES2 Long press on USB icon (2 sec) 
 
====='''EPOS IMPACT 760T (Art. No. ? Model ?, ID=0x019f)'''=====
====='''EPOS IMPACT 860T ANC (Art.No. 1001177 - Model DSWH7 FW1.1.127 ID=018e'''=====
(since v13r3sr16/v14r1sr4)

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
|}
 
YES1 Long Press (1-2 seconds) 
YES2 Double tap 
 
 

===Snom (Vendor ID 0x251c)===
====Corded====
====='''A330M (Mono), A330D (Stereo) (PN: 00004598 V1.0 R1A 2022, ID 0x01fd)'''=====
(from v11r2sr63, v12r2sr58, v13r1sr43, v13r2sr17) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

=====''' C300 Personal Conference Speakerphone (PN: 00004584 V1.4.05 R2A2022, ID 0x0192)'''=====
(from v11r2sr63, v12r2sr58, v13r1sr43, v13r2sr17) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2 
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
YES1 Tap Call Key 
YES2 Press Call Key >= 2 seconds 
 

===Yealink (Vendor ID 0x6993)===
====Corded====
====='''UH34 (ID 0xb04c)'''=====
====='''UH36 (ID 0xb028)'''=====
====='''UH37 (ID 0xb20a)'''=====
====='''UH38 (ID 0xb206)'''=====
(from v13r3sr13 - update headset firmware before use, see https://wiki.innovaphone.com/index.php?title=Howto:Yealink_Headset_-_Yealink_-_3rd_Party_Product) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
YES1 Tap Call Key 
YES2 Double Tap Call Key 

====Wireless====
====='''WH62 (ID 0xb017)'''=====
Currently only the WH62 variant with base station is supported 
but NOT the WH62 Portable UC with WDD60 DECT Dongle (Firmware version 19.430.0.30). 
The dongle is detected but doesn't work like other WDD60 dongles with identical product ID! 

====='''WH63 (ID 0xb048)'''=====
====='''WH63 Portable - WDD60 DECT Dongle (ID 0xb120)'''=====

====='''WH64 Dual UC - WHB640 DECT Base USB-C (ID 0xb122)'''=====
====='''WH66 (ID 0xb02b)'''=====
supported only at IP222/232/222A

====='''WH67 (ID 0xb04a)'''=====
supported only at IP222/232/222A

====='''BH71 Workstation (ID 0xb07e)'''=====
====='''BH71 Workstation Pro - BT51 Bluetooth Dongle (ID 0xb204)'''=====
====='''BH72 (ID 0xb038)'''=====
====='''BH74 UC - BT51 Bluetooth Dongle USB-C (ID 0xb204)'''=====

====='''BH76 (ID 0xb03a)'''=====
(from v13r3sr12 - update headset firmware before use, see https://wiki.innovaphone.com/index.php?title=Howto:Yealink_Headset_-_Yealink_-_3rd_Party_Product) 
====='''BH76 Plus Teams - BT51 Bluetooth Dongle USB-C (ID 0xb204)'''=====

====='''BH70 (ID 0xb03a)'''=====
(from v13r3sr17, v14r2sr5 - update BH70 and BT51 firmware before use) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
YES1 Tap Call Key 
YES2 Double Tap Call Key 

==Unsupported Headsets==
Sometimes new headsets are relased which are very similar to one of the already supported headsets. But if the signature (vendor/product) of the headset is unknown to the firmware the call control functions of the headset are without effect.

Unsupported corded headsets may be used then as plain audio devices where call control is solely performed by the phone but wireless headsets usually will not work this way.

===Phone configuration adaptation===
If recommend by support or the manufacturer the signature of such an unsupported headset can be mapped to the signature of an already supported headset of similar properties by either

config add KEYS0 /hid-map <map>[,<map>]...
config write
config activate

or (IP222, IP232 only)

vars create KEYS0/HID-MAP p <map>[,<map>]...

The mapping is applied the next time the headset is plugged in, a reboot is not required. 
 
The format of a '''<map>''' is

vendor:product=vendor:product

The first '''vendor:product''' tuple is the signature of an unsupported headset,
the second tuple is the signature of an already supported headset.
 
''vendor'' and ''product'' are plain 4 digit hex numbers without a "0x" prefix, up to 6 maps can be specified separated by a comma.
 
If there is for example a new Jabra headset with ID a34a which is very similar to the ''Jabra SUPREME UC'' with ID a346 '''<map>''' would be

0b0e:a34a=0b0e:a346

where ''0b0e'' ist the Jabra vendor ID.

* An Example how to detect the correct ID:

If we know a Jabra Speak 510 with ID 0420 and the ID of the unsupported device is xxxx the correct command would be

config add KEYS0 /hid-map 0b0e:xxxx=0b0e:0420

or

vars create KEYS0/HID-MAP p 0b0e:xxxx=0b0e:0420

=== Product & VendorID discovery ===

How to find xxxx? Either

* Connect the unrecognized usb device, in the phone admin-ui at Maintenance/Diagnostics/Command enter<pre>!mod cmd USB-HOST port</pre>This will result in a info-string containing values for vendorID and productID
or
* Unplug Headset, Clear trace buffer, Plug Headset, take a trace, look for a line like<pre>USB-DEVICE vendor=0b0e 'Jabra' product=xxxx 'Jabra Speak 510' release=0118</pre>

=== Known Problems ===

===='''Jabra EVOLVE 20'''====
*The product ID 0303 is not built in the driver and a mapping to ID 0302 seemed to fail, this happens if Jabra Control Center have the following option: "Target Softphone for outgoing calls: Softphones supported by Jabra PC Suite". We should change this to "Auto-detect" to work properly.

[[Image:Jabra_control_center.png|/Jabra_control_center.png|jabra_control_center.png/]]

===='''Plantronics D100-A ID=ab01'''====
*This signature is identical to the D100 signature but the D100-A does not accept the vendor requests. Thus a pseudo device with ID d64a was defined to permit mapping of the D110-A to this pseudo device via:

!config add KEYS0 /hid-map 047f:ab01=047f:d64a
!config write
!config activate

Beware: to make an old D100 working again on this phone the hack must be undone via

!config rem KEYS0 /hid-map
!config write
!config activate

==3rd Party Tested Headsets ==

These are reports we received from customers. We provide those "as is" (that is, we did not verify the data and this is in no way a promise that such headsets would work).

{{Template:3rd Party Input}}

====='''Jabra Pro 935 BT (Manufacturer ID 0x0b0e Product ID 0x1038 release firmware version 1.0.4)'''=====
The only difference to the version tested by innovaphone seems to be the prodoct id. 
The mapping is included in firmware since v12r2sr44, v13r1sr26 

====='''Jabra Pro 930 Duo (PN 930-29-509-101, Manufacturer ID 0x0b0e Product ID 0x1016 Firmware 2.30.0)'''=====
The only difference to the version tested by innovaphone seems to be the headset (Duo vs Mono). 
The mapping is already included in firmware (see above) 

====='''EPOS EXPAND SP 30 + BT Speakerphone with Dongle (Art.No. 1000223, Manufacturer ID 0x1395 Product ID 0x0381)'''=====
Apart from the different product ID it seems to be identical to the former Sennheiser SP 30 product. 
The mapping is included in firmware since 11r2sr54, 12r1sr42, 12r2sr43, 13r1sr26 

=== Jabra BIZ 2300 USB Duo ===
A Jabra BIZ 2300 USB Duo with ID 0xc024 was reported to work with the settings provided for the BIZ 2300 USB UC Mono 
This mapping is included in firmware since v9hotfix43/v10sr17 

=== Plantronics Blackwire C310 / C320 ===
The following headsets were reported to work with the settings provided for the Blackwire C320 PN 85619-02, ID 0xc00f: 
Blackwire C320 - Binaural - Firmware H4.HM, ID 0xc024) 
Blackwire C310 - Monaural - Firmware E4.GM, ID 0xc022) 
Blackwire C310 - Monaural - Firmware L3.GK, ID 0xc00e) 
These mappings are included in firmware since v9hotfix43/v10sr17 

=== Plantronics Blackwire C520 ID 0xc01b ===

vars create KEYS0/HID-MAP p 047f:c01b=047f:c017

Test results: none

=== Jabra speak 510 MS with part number 7510-109 ===

vars create KEYS0/HID-MAP p 0b0e:0422=0b0e:0420

Test results

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}

=== Jabra link 230 (USB to QD) with part number 230-09 (0b0e:2315) ===
works with:
vars create KEYS0/HID-MAP p 0b0e:2315=0b0e:9350

Test results

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
|-
|-
| unplug-action
| style="text-align:center" | YES
|-
|}

=== Jabra link 230 (USB to QD) with Type BIZ 2400 (0b0e:090e) ===
works with:
vars create KEYS0/HID-MAP p 0b0e:090e=0b0e:0910

Test results

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
|-
|-
| unplug-action
| style="text-align:center" | YES
|-
|}

Reference16r1:Concept App Service Documents

2026-03-13T15:13:18Z

Msu: /* Troubleshooting */

Reference16r1:Apps/PbxManager/App Documents

2026-03-13T12:18:37Z

Msu:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
This page describes the PBX Settings Plugin of the Documents App.

The app is only available as a plugin app and is not visible to users as a standalone app.

This app must be allowed for both users and other app services.

== Individual Documents App Configuration ==
Following items can be configured in a PBX App object:

* '''Name''': Object long name
* '''SIP''': Object name. Allowed characters according to the [[Reference15r1:PBX/Objects#General_Object_Properties | general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.

=== App permissions ===
Allowed apps for the Documents service which provides the com.innovaphone.tagging API for checking user permissions.

=== Configuration Templates ===
Select configuration templates to be applied for the Documents app object.

Reference16r1:Concept App Connect

2026-03-09T14:26:50Z

Msu: /* Features */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]
* Archiving attachments

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2026-03-09T14:26:03Z

Msu: /* Configuration */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Apps/PbxManager/Documents

2026-02-27T15:35:21Z

Msu: Created page with "{{FIXME|reason=This product is in the beta phase and is not yet finished}} <Beschreibung hier einfügen> == Add an app object == ==Related Articles=="

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
<Beschreibung hier einfügen>

== Add an app object ==

==Related Articles==

Reference16r1:Concept App Service Documents

2026-02-27T15:23:54Z

Msu:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

== Overview ==

== Features ==

== Requirements ==

== Apps ==

== Licensing ==

== Technical Overview ==

== Technical Concept ==

==== Additional Information ====

== Configuration ==

==== PBX Manager Plugin ====

== Troubleshooting ==

== Known Issues ==

== Related Articles ==

Reference16r1:Concept App Service Documents

2026-02-27T15:21:42Z

Msu: Created page with "{{FIXME|reason=This product is in the beta phase and is not yet finished}} Apps  == Applies To == == Overview == == Features == == Requirements == == Apps == == Technical Overview == == Technical Concept == ==== Additional Information ==== == Configuration == ==== PBX Manager Plugin ==== == Troubleshooting == == Known Issues == == Related Articles =="

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
[[Category:Concept|Apps]]

== Applies To ==

== Overview ==

== Features ==

== Requirements ==

== Apps ==

== Technical Overview ==

== Technical Concept ==

==== Additional Information ====

== Configuration ==

==== PBX Manager Plugin ====

== Troubleshooting ==

== Known Issues ==

== Related Articles ==

Reference15r1:Concept App Service Fax

2025-10-23T13:37:03Z

Msu: /* Known Issues */

[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 15r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax#Default_settings_for_mail_notifications|Centralized setup]] of mailing notifications
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a [[{{NAMESPACE}}:Gateway/Interfaces#FAX_interface|FAX interface]]
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png|concept_fax.png/]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements| licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The fax service has a built-in SMTP server, which is needed for Mail2Fax. Here, you activate the mail reception for the fax service, enter the fax domain and configure the credentials for the authentication against the SMTP server. The mails can contain a subject and body for the cover page, and '''one PDF document can be appended as attachment'''. No cover page is added if both the subject and the mail content are empty. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charsets are UTF-8 and ISO 8859-1 (Latin 1).

As of 14r2 the SMTP server only listens on port 25. STARTTLS is possible.

For the Fax service to receive the mails in the first place, the mailserver needs to forward mails for the fax-domain to the APs IP address.

An example for an Exchange configuration can be found [[Howto14r2:Fax App - Mail2Fax with Exchange 2019|here]]

Starting with 16r1 you also can configure OAuth2 Authentications. You can have a look into our HowTo Article for assistance: [[Howto16r1:Configure OAuth2 E-Mail]]

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document to be sent can be uploaded with the HTTP post command. The arguments within the HTTP URL sets the data of the new fax job. The job is created in the context of a user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the URL:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact (must be url-encoded).
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created (must be url-encoded).
* cover-page-content: The content of an optional cover page if should be created (must be url-encoded).
* cover-page-content-html: If set to true, the cover page content is in HTML.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

Here an example:

curl -X POST "http://AP-DNS-name/DOMAIN/fax/?api-key=1234&user-sip=vgr&contact-number=00049703173009&cover-page-subject=Hello%20World&app-object=fax" -T testfax.pdf

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*Smtp
*TLS
*TCP
*DB files
-> Since these options creates huge logs, please just enable for tracing a current problem and deactivate afterward

== Known Issues ==
* '''Important:''' If using Mail2Fax, only '''ONE''' PDF attachment is allowed and can be handled by the Fax service. If multiple attachments are added the first PDF is used and all other attachments like more PDFs, pictures etc. are ignored.
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [https://class.innovaphone.com/moodle2/course/view.php?id=1705&topic=0#section-2 the book about fax application setup] as part of our IT Plus Training.
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App
* [[Howto: Mail2Fax with Exchange 2019]]

Reference15r1:Concept App Service Contacts

2025-10-22T12:33:09Z

Msu: /* Known Issues */

[[Category:Concept|Apps]]
= Applies To =
* App Contacts version 15r1

= Overview =
The App Service Contacts is an App Service which can be installed on an innovaphone App Platform. It is used for information retrieval of a database of contact entries, as well as maintaining personal contact books.

Inside Contacts, personal and general entries can be searched (forward lookup) or be used to resolve incoming numbers to their respective name (reverse lookup).

= Features =
*Import: Semicolon (;) separated CSV file
*Database for contact entries: A user interface for retrieval purposes is available.
*API: Search API and Lookup API for other apps
*Edit Functionality: Contact entries are editable.
*Personal Address Book: Every user can maintain one or more personal address books.
*Access Right Management: Owners can maintain access privileges for single users or even groups of users, in order to control visibility of an address book.
*Contacts can be added by means of a button '''Softphone/Call List/<entry>/"Add Contact"'''
*buttons '''Hamburger/Directories/<directory>/Import,Export''' allow for CSV-download and -upload respectively.
*Presence updates: Useful in federation scenarios. For displayed and currently visible contact entries, presence monitoring calls are placed, in order to display availablity status. Underlying resources are going to be freed immediately for entries scrolled out of visibility.
== 15r1 Features ==
Features added to the version 15r1
;User-Interface improvements
The UI was adapted to the new round corner layout of myApps. The layout was also improved for mobile devices.
;Import, export of vCard Files
A button was added '''Details/Share/vCard''' allowing to export contacts as vCard files which can be imported in third party software like outlook, thunderbird and many more.

Import of vCard files can be achieved by drag&drop into the contacts app.

;New start screen
When the app is opened and new start screen informs users of the capabilities of the app.

= Requirements =
innovaphone PBX and App Platform from on version 13r3 - version 15r1 is recommended.
==Upgrade Considerations==
From 14r2 to 15r1 no special upgrade scenarios need to be considered as the database structure remains the same. 
On the other hand, if you are upgrading from <14r2, please consider the corresponding [[Reference14r2:Concept_App_Service_Contacts#Upgrade_Considerations|upgrade considerations]].

=Apps=
=== Contacts App (innovaphone-contacts) ===
The regular app
=== Contacts Admin App (innovaphone-contacts-admin) ===
Features a menu (top-right) to manually upload a CSV file
=== Contacts Search API (innovaphone-contacts-searchapi) ===
This hidden app rovides a search API and a lookup API to other apps, e.g. for the Phone App

= Concept =
General contact entries and entries for personal directories are stored within the same database. With the table '''acl''' which is acting as an access control list, restricted views and edit rights for personal directories can be granted.

This way, only the owner of a personal directory (and granted user or groups) can see the content.

==Number handling==
In principle, two versions of a phone number are always stored in the contacts database.
;Original Number
:This is the unchanged number imported by the user. This version includes all decorative characters, spaces, etc. (eg. +49-(7031) 730090)
;Formatted number
:A filter is applied to the original number before saving to remove all non-dialable characters. (This means that only <code>0-9,+,*,#</code> remain after that) This formatted version of the call number is saved in addition to the data set. (eg. +497031730090)

If a number is searched for (reverse lookup), the cleaned version is searched for. Thus, it does not matter which decorative characters or formats are imported.
If an entry is displayed to the user, the originally entered call number (incl. decoration characters) is displayed.

It is therefore best practice to import only international format numbers (Decorations can be imported as they will be removed anyway), as the PBX always converts the number into the international format for a reverse lookup, if the [[Reference13r1:Concept Number Adjustments (Dialing Location)|dialing location]] was configured correct.

==Assign unique IDs for contacts entries==
It is recommended to upload CSV files with an additional column ''extAnchor''. The column extAnchor allows to identify individual entries uniquely and independent of renaming operations. The column ''extAnchor'' is supposed to contain an external unique database id, alike a guid. If ''extAnchor'' was provided the import procedure will perform an UPDATE of previously existing entries, instead of deleting and re-INSERTing the entries. Entries pinned on home are going to remain functional.

==List of Attributes==
The list of currently available attributes for a contacts entry follows:
;extAnchor
: unique id identifying the entry within the database
;givenname
:First name
;sn
:Surname/Family name
;company
:Corporation
;displayname
:Name to be displayed
;email
:e.g. ''example@example.com''
;telephonenumber
:Internationalized land-line telephone number, e.g.'' +49 7031 730090''
;mobile
:Internationalized mobile telephone number
;homephone
:Internationalized home phone number
;facsimiletelephonenumber
:Internationalized fax number
;city
:City/Town, e.g. ''Milano''
;street
;postalcode
;state
:Federal state, e.g. some US states: ''Ca, Wa, Fl''
;country
:e.g. ''Deutschland, Italia''
;privatecity
:Home address
;privatestreet
;privatepostalcode
;privatestate
;privatecountry
;title
:Academic title
;position
:Position within company, department
;department
;description
:Common description
;roomnumber
;info
:Common info
;url
:Company URL
;sip
:Dialable SIP address
;uuid
:A constant universal unique id as string. Internally assigned during entry creation.

==List of Text-Indexable Attributes==
Attributes to be considered for the full-text index
*cn
*sn
*givenname
*company
*displayname
*city
*street
*postalcode
*country
*state
*private_city
*private_street
*private_postalcode
*private_country
*private_state
*title
*position
*department
*description
*roomnumber
*sip

==Built-in LDAP Server==
The App incorporates a proprietary LDAP server functionality. The purpose of the LDAP server functionality is to service innovaphone LDAP clients, such as desk phones.
The LDAP server only supports a proprietary search by means of a meta attribute<ref>Meta attribute: Here an attribute with a special meaning and that is non-physical, not existing within the database</ref>, whereby LDAP is just utilized as a transport vehicle for a user's search input one-to-one.
*E.g. a user searching for ''John Doe innovaphone''
**Possible user input ''jo do inno''
**Resulting LDAP filter ''(metaSearchText=jo do inno)''

'''Important:'''

Note, that access to restricted/personal phone books requires the proprietary scheme within the LDAP client, mentioned above.

Currently, this is available in the innovaphone IP phone LDAP clients from 13r3 on, but not on 3rd party devices nor our DECT gateways (IP120x) or Wifi Phone IP73. On these clients, only contact data in unrestricted phone books is searched.

===Sample Phone Configuration, innovaphone===
Phone/User-X/Directories/External LDAP Server
;Enable: Active
;Use TLS: Active
;Server: <host adddress of App Platform>
;Port: <can be left empty>
;Username,Pw: <Credentials for LDAP Bind operation>
;Search Base: ''dc=entries''
;Mode: <can be left on "basic">
;Object Filter: <leave empty>
;Sort Results: Inactive
;Name Attributes: ''givenName,sn,company''
;Number Attributes: <can be left empty>
;H323 ID Attribute:'' sip''
;Detail Attributes: ''title,company,street,postalCode,city,country,email,url''
;Meta Name Attribute: ''metaSearchText''
;Meta Number Attribute: ''metaSearchNumber''

= Personal Address Book Details =
Contact entries can be added, edited and deleted. It is also possible to create and maintain personal address book(s), as well as share them with other users or whole user groups.

Only user/groups with sufficient rights, will be able to see other address books. An Access control list (acl) is used, to control these rights.

Groups correspond to PBX-groups. The Contacts App gets to know only active PBX-group memberships.

By default, only the user who created an address book, is able to see the content.

==Maintain a Personal Address Book==
;Creating a Personal Address Book
:Click on '''+Contact''' and proceed. If no directory existed before, one will be automatically created by the name pattern '''Personal Directory: <user's short name>'''.
:Or click on the burger menu in the top right corner inside the Contacts-App, and there on the '''"Directories"'''. Now click on the '''"+"'''-Symbol, choose a suitable name and confirm your name via '''"Save"''' button. A new address book is created.
;Adding a new contact
Click on the '''"+"'''-Symbol in the top right corner inside the Contacts-App and select an address book, where you want the contact to be stored in. Per default, the last opened directory is displayed there as target (saved in contacts.lastUsedDirIndex in LocalStorage). Ideally, this was/is the global directory. 
If a different one was deliberately selected (regardless of whether you enter anything or not), this will be displayed at the top as the default the next time it is opened. 
Now fill in the contact information (the fields ''"name"'' and ''"last name"'' '''have to be filled''') and save it via '''"Save"'''-button. 
;Editing an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, click on the entry you want to edit and after your change, save it via '''"Save"'''-button on the bottom.
;Delete an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, and on the '''"trashcan"'''-symbol at the top. After confirmation, the entry is deleted.

==Sharing of Address Book==
;Share globally
*Either remove all rules from a personal directory. Such a configuration corresponds to pre-13r3 capabilities. Up to 13r2 there weren't any visibility rules available.
*Or make every PBX user an active member of a group e.g. "everybody" and add a directory rule for that group "everybody".

;Share with single user(s)
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"User"''' as type. In the input field, you can enter and therefore filter for all available users. Select the user, whom you want to give access and select either if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''.

;Share with a group
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"Group"''' as type. In the input field, you can enter and therefore filter for all available PBX groups. Also select, if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''-button.

;Revoke of granted rights
You can also revoke previous granted rights by just clicking on the user/group at the access control list, and click on the '''trashcan''' symbol. Now submit your change with another click on '''Ok'''-button.

==Upload a new Directory==
The Contacts Admin App allows uploading a CSV file as known from the 13r2 version ('''Hamburger/Import'''). In the course of an upload operation, a new directory will be created. The newly assigned directory name will be the name of the CSV file.
After uploading, the visibility setting of the new directory should be administrated as stated before under [[#Sharing of Address Book|Sharing of Address Book]]

==Terminology==
;ACL: Access control list. Refers the database table ''acl'' and rows/entries therein.
;Directory: Refers the database table ''dbs'' and rows/entries therein. All contact entries referencing a ''dbs''-row make up the content of a directory.
;Address Book: Synonymous with ''Directory''
;Contacts Admin: A user utilizing the Contacts Admin App (via App URL, ending with ../innovaphone-contacts-admin)
;Directory Admin: A user entitled the admin right for a directory. Either by user-wise or by group-wise ACL entry.
;Directory User/Viewer: A user entitled the viewing right for a directory. Either by user-wise or by group-wise ACL entry.

==Database Changes==
Three tables realize the functionality for personal directories.
*Table '''dbs'''. Each row represents a directory. Two new columns ''displayname, sip'' where added.
**'''displayname''' Name display.
**'''sip''' Creator's sip name, if available.
*Table '''acl'''.New table acting as access control list. Each row references a directory as listed by table ''dbs'' and is going to grant view- and admin-right to a specific user or group.
**'''dbsid''' Reference into table dbs.
**'''name''' The name of a user or a group.
**'''acltype''' A numeric value: user(0), group(1)
**'''admin''' Granting edit right: admin(true), non-admin(false)
*Table '''entries'''. Each row within this pre-exisisting table represents a contact entry. The column ''dbsid'' informs about whether an entry belongs to a specific directory.

<pre>
#Excerpt for an additional directory ''Persönliches Verzeichnis: mst'' with one contact entry.

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri | displayname | sip
----+------------------------------------------------------+--------------------------------+-----
7 | file:///4eaae395-9971-40fb-9a05-dfae1d023f12?sip=mst | Persönliches Verzeichnis: mst | mst # Specification for directory ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from acl"
id | dbsid | name | acltype | admin
----+-------+------+---------+-------
5 | 7 | mst | 0 | t #user 'mst' can view and edit directory with dbsid=7 ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select sn,givenname,company,id,dbsid from entries where dbsid=7"
sn | givenname | company | id | dbsid
----------+-----------+--------------+-------+-------
Duck | Dagobert | Duck Corp. | 51394 | 7 # main table entries contains 1 entry belonging to ('Persönliches Verzeichnis: mst')

</pre>

==Reverse Number Lookup for Personal Directories==
Queries into directories are access-checked by looking-up and enforcing ACL-rules. The information on whose name is being queried and which group memberships are taking effect is needed for this process.

Websocket connections to the Contacts App service carry those infos within the SDK method ''AppWebsocketConnectComplete()''.
LDAP connections pass this information within a proprietary LDAP control together with an LDAP searchRequest message.

The PBX's centralized Reverse Lookup service (see ''PBX/Config/General/Reverse Lookup URL'') does support this mechanism. That is, for every LDAP searchRequest the affected user's name and active group memberships are going to be sent towards the Contacts App's LDAP server.

See also [[{{NAMESPACE}}:Concept_Reverse_Lookup|concept article on reverse lookup]].

=Upload Data by HTTP Post=
A CSV file can be uploaded by means of an HTTP POST request.
The following powershell script aims to demonstrate this procedure with the help of CURL<ref>For a windows distribution: e.g.: https://curl.haxx.se/download.html </ref><ref>CURL is recommended(rather required), because it supports the simple POST mechanism with an initial tentative POST with the data length of 0, in order to get through the authentication phase</ref>
The required user and password content corresponds to the configuration underneath '''PBX Manager/AP Contacts/Configuration/User(HTTP Post)''' and '''Password(HTTP Post)'''
<syntaxhighlight lang="powershell">
# csv.ps1
# Sample powershell script demonstrating how to HTTP POST a CSV file towards the Contacts App service.
# .\bin\curl must be present, e.g. from https://curl.haxx.se/download.html
# Examples:
# powershell -ExecutionPolicy Bypass -Command .\csv.ps1 -Dest 172.16.18.215 -File ".\myContacts.utf8" -User "contacts01" -Pw "pwd01" -Url "/example.com/contacts01/post/myContacts.utf8?op=csv"

param(
[Parameter(Mandatory=$false, HelpMessage="Destination host")]
[string]$Dest,
[Parameter(Mandatory=$false, HelpMessage="Name of file to be POSTed")]
[string]$File,
[Parameter(Mandatory=$false, HelpMessage="Authentication: User")]
[string]$User,
[Parameter(Mandatory=$false, HelpMessage="Authentication: Password")]
[string]$Pw,
[Parameter(Mandatory=$false, HelpMessage="URL, e.g.: /example.com/contacts01/post/myContacts.csv?op=csv&xml-stats=true")]
[string]$Url
)

Add-Type -AssemblyName System.Web

$Uri = "http://" + $Dest + $Url

function UploadToContacts {
# Ensure file's there and has content
if (!(Test-Path -Path $File)) {
echo $File+" not downloaded!"
exit 1
}
$lines = 0
Get-Content $File |%{ $lines++ }
echo "Lines of $File=$lines"
if($lines -le 2) {
echo "No Data to upload!"
exit 1
}

$auth = "${User}:${Pw}"

echo "POSTing towards $Uri"
.\bin\curl "--digest" -s -S --trace-time -u $auth -i -H "Content-Type:application/octet-stream" -X POST --data-binary "@${File}" "${Uri}"
echo "POSTed towards $Dest"
}

$timeStart = Get-Date
echo "===Begin: ${timeStart} ==="
UploadToContacts
$timeEnd = Get-Date
echo "===End: ${timeEnd} ==="
echo ""
</syntaxhighlight>
== The URL ==
The first part of the URL (''example.com/contacts01'') is the ''Webserver path'' configured for the ''Contacts'' instance in the ''App Platform Manager''. It must be followed by the literal <code>post</code>. The last part (''myContacts.csv'') can be chosen freely.

Note that the last part of the URL used to post the file (''myContacts.csv'' in the example above) needs to be chose carefully. ''Contacts'' will remember this name as source for each of the uploaded entries. When the file is posted again (that is, when a new POST using this last URL part is done), ''Contacts'' will first delete all existing entries previously uploaded with this name and then add the new ones.

=Troubleshooting=
To collect debugging data, activate the '''''App''''' and '''''App WebSocket''''' trace options at the contacts instance on the App Platform Manager. Now reproduce the issue and save the logfile.

==Manually Deleting an uploaded File==
A directory is deleteable by clicking '''Hamburger/Directories/<directory>/Delete(Symbol: Trash-Can)''' and a progressing through the confirmation dialog afterwards.

==Manually Deleting all Contacts==
Sometimes it may become necessary to delete all contacts from the database. This task can be accomplished by simply deleting the main table ''entries''. The deletion will cascade from there into all sub-tables.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<syntaxhighlight lang="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
94
(1 row)

#Delete
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from entries *"
DELETE 94

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
0
(1 row)
</syntaxhighlight>



= Known Issues =
* [[Support:Contacts on HomeScreen can't be open after modification on ContactsAPP| Contacts on HomeScreen can't be open after modification on ContactsAPP]]
* [[Support:Contacts Upload Fails From Within myApps Launcher| Contacts Upload Fails From Within myApps Launcher]]
* [[Support:Forward search shows no result| Forward Search shows "no result"]]
== DECT Phones and IP101/IP102/IP240(A) Cannot Access Personal Directories ==
DECT gateways and IP101/IP102/IP240(A) Phones do not support the mechanism required to query into directories with restricted access rules. Hence, DECT mobile phones and IP101/IP102/IP240(A) cannot search into such directories.

== The PBX Quick Dial object Cannot Access Personal Directories ==
The PBX Quick Dial do not support the mechanism required to query into directories with restricted access rules. Hence the Quick Dial object cannot search into such directories.

== No automatic ACL update on name changes ==
If a users h323 name is changed, all ACL entries in address books, to which the user has rights, also need to be changed manually, since there is no automatic update between the PBX and the address books.

== Search for numbers in name-fields not possible ==
A search with phonenumber related characters only (0-9, *, #, -, ( and )) will result in a search in the number-fields only.
Workaround: If you want to be able to search for (eg) customer IDs, you can add this number prepended with (eg) an 'n' into one of the text-indexable fields. Then a search can be done if you also prepend the number with 'n'.

== Restrictions for searches with special characters ==
If a contact has a name with a hyphen symbol ( - ) and only one letter after it, the contact cannot be found by name.
Example Contact name: '''Test-A'''
Can be found via '''''Test''''' or '''''Test-''''', but '''not''' via '''''Test-A'''''.

If you edit the contact and add another letter after the ''A'' (e.g., '''''Ab''''', so that it becomes ''Test-Ab''), the contact can be found by searching for ''Test-A''.
So if only '''one''' letter follows the hyphen/underscore/dot (special characters in general), you get this behavior.

= Related =
<references/>

Reference16r1:Concept App Connect

2025-10-21T13:58:34Z

Msu: /* Hashtags */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 
'''Important:''' Hashtags can consist of any character except . : ; , < & ' # ) ( and white space. If a hashtag shall include one of these characters, you must enclose it in quotation marks, such as in #"Test tag".

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

''OAuth2'': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference13r3:Concept App Service Fax

2025-10-17T13:22:26Z

Msu: /* Known Issues */

[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 13r3

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* The Fax app can forward the received [[Reference13r3:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[Reference13r3:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* If you enter a number in the input field and click on it, this number will be stored inside the fax database as a contact. Currently, these contacts can't be deleted, so be aware to not click and thus save wrong numbers.
** This behavior has changed in 14r1: If a contact no longer has any jobs, it is deleted at night. Deleted jobs are removed after two weeks, only then is a contact empty.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Courseware:IT_Plus_-_Fax | IT Connect Training]].
* [[Reference13r3:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Concept App Service Fax

2025-10-17T13:22:17Z

Msu: /* Known Issues */

[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 14r2

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a [[{{NAMESPACE}}:Gateway/Interfaces#FAX_interface|FAX interface]]
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png|concept_fax.png/]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements| licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The fax service has a built-in SMTP server, which is needed for Mail2Fax. Here, you activate the mail reception for the fax service, enter the fax domain and configure the credentials for the authentication against the SMTP server. The mails can contain a subject and body for the cover page, and '''one PDF document can be appended as attachment'''. No cover page is added if both the subject and the mail content are empty. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charsets are UTF-8 and ISO 8859-1 (Latin 1).

As of 14r2 the SMTP server only listens on port 25. STARTTLS is possible.

For the Fax service to receive the mails in the first place, the mailserver needs to forward mails for the fax-domain to the APs IP address.

An example for an Exchange configuration can be found [[Howto14r2:Fax App - Mail2Fax with Exchange 2019|here]]

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document to be sent can be uploaded with the HTTP post command. The arguments within the HTTP URL sets the data of the new fax job. The job is created in the context of a user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the URL:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact (must be url-encoded).
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created (must be url-encoded).
* cover-page-content: The content of an optional cover page if should be created (must be url-encoded).
* cover-page-content-html: If set to true, the cover page content is in HTML.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

Here an example:

curl -X POST "http://AP-DNS-name/DOMAIN/fax/?api-key=1234&user-sip=vgr&contact-number=00049703173009&cover-page-subject=Hello%20World&app-object=fax" -T testfax.pdf

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*Smtp
*TLS
*TCP
*DB files
-> Since these options creates huge logs, please just enable for tracing a current problem and deactivate afterward

== Known Issues ==
* '''Important:''' If using Mail2Fax, only '''ONE''' PDF attachment is allowed and can be handled by the Fax service. If multiple attachments are added to an E-Mail, the Faxservice will get in a broken status.
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [https://class.innovaphone.com/moodle2/course/view.php?id=1705&topic=0#section-2 the book about fax application setup] as part of our IT Plus Training.
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App
* [[Howto: Mail2Fax with Exchange 2019]]

Reference15r1:Concept App Service Fax

2025-10-17T13:22:05Z

Msu: /* Known Issues */

[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 15r1

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax#Default_settings_for_mail_notifications|Centralized setup]] of mailing notifications
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a [[{{NAMESPACE}}:Gateway/Interfaces#FAX_interface|FAX interface]]
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png|concept_fax.png/]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements| licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The fax service has a built-in SMTP server, which is needed for Mail2Fax. Here, you activate the mail reception for the fax service, enter the fax domain and configure the credentials for the authentication against the SMTP server. The mails can contain a subject and body for the cover page, and '''one PDF document can be appended as attachment'''. No cover page is added if both the subject and the mail content are empty. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charsets are UTF-8 and ISO 8859-1 (Latin 1).

As of 14r2 the SMTP server only listens on port 25. STARTTLS is possible.

For the Fax service to receive the mails in the first place, the mailserver needs to forward mails for the fax-domain to the APs IP address.

An example for an Exchange configuration can be found [[Howto14r2:Fax App - Mail2Fax with Exchange 2019|here]]

Starting with 16r1 you also can configure OAuth2 Authentications. You can have a look into our HowTo Article for assistance: [[Howto16r1:Configure OAuth2 E-Mail]]

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document to be sent can be uploaded with the HTTP post command. The arguments within the HTTP URL sets the data of the new fax job. The job is created in the context of a user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the URL:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact (must be url-encoded).
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created (must be url-encoded).
* cover-page-content: The content of an optional cover page if should be created (must be url-encoded).
* cover-page-content-html: If set to true, the cover page content is in HTML.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

Here an example:

curl -X POST "http://AP-DNS-name/DOMAIN/fax/?api-key=1234&user-sip=vgr&contact-number=00049703173009&cover-page-subject=Hello%20World&app-object=fax" -T testfax.pdf

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*Browser
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*Smtp
*TLS
*TCP
*DB files
-> Since these options creates huge logs, please just enable for tracing a current problem and deactivate afterward

== Known Issues ==
* '''Important:''' If using Mail2Fax, only '''ONE''' PDF attachment is allowed and can be handled by the Fax service. If multiple attachments are added to an E-Mail, the Faxservice will get in a broken status.
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [https://class.innovaphone.com/moodle2/course/view.php?id=1705&topic=0#section-2 the book about fax application setup] as part of our IT Plus Training.
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App
* [[Howto: Mail2Fax with Exchange 2019]]

Reference16r1:Concept App Connect

2025-10-02T11:25:50Z

Msu: /* Chat */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference16r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2025-10-02T09:12:38Z

Msu: /* Chat Features */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference14r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.
** '''Only''' in Browser Mode, since h264 is not implemented in the used Chromium on the native client and the iPhone App

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2025-10-01T12:51:08Z

Msu: /* Chat */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The integrated [[Reference14r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2025-10-01T12:49:15Z

Msu: /* Features */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via [[Reference16r1:Concept_App_Polls|Polls App]]

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The newly integrated [[Reference14r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept App Connect

2025-10-01T11:14:25Z

Msu: /* Chat Features */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via "Polls" app

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The newly integrated [[Reference14r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;Reactions: React with likes and emojis to chat messages
;Direct Answering: Send a direct answer to a specific message
;Forwarding: Forward chat messages to other chat user/groups
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]

Reference16r1:Concept Chat

2025-10-01T10:11:09Z

Msu:

[[Category:Concept|Chat]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

=== Features without license ===
'''Important:''' 
Chat is only supported with the Chat App provided by the PBX, which only supports volatile chat, meaning the Chat messages are not stored. 
 
Features without license include the following: 
;Volatile chat: Chat to other users, if these other users are online and respond to the incoming chat call
;Emojis: Some emojis can be selected to be included in the message. The emojis are sent as standard Unicode characters

=== With a Chat or Connect license ===
If a Chat or Connect license is available, Chat can be integrated into a [[Reference16r1:Concept_App_Connect#Chat|Connect App]]. A Chat tab can then be found in the top navigation of the Connect App. 
In parallel, the Chat icon will open only the Chat tab of the Connect App in particular. 

== Technical Details ==

=== Client APIs ===

The client uses published PBX APIs to provide the service.

;PbxSignal: This is the API for signaling using Websocket/Json protocol. The Chat App uses the flag 'NO_MEDIA_CALL' when doing the register, so that no media call is sent to the Chat App. To mark a call as instant messaging call the facility 'im_setup' is used. Messages are transfered with the facility 'im_message'
;PbxMessages: This API provides access to an external Messages App Service. If a chat licenses is assigned to the user, the Chat App established a Session on the PbxMessages API.

=== API of Messages App Service ===

The PBX Objekt Messages establishes a AppWebsocket connection to the external Messages App Service. Documeneted messages on this connection are used for the additional services.

=== File Attachments ===

To attach a files to a chat message, the client uses a method 'CreateFileBuffer' of 'PbxMessages' to create a temporariy buffer for a file in the Messages App Service. The file is sent via HTTP POST to this buffer and a URL to the file is included in the im_message facility. The recepient of the message can read the file from this buffer, if online while the message was sent. After the message was sent, the file attachments are copied into permanent buffers on the sender and on the received side. To access these buffers other URLs then the URLs for the temporariy buffers are used.

=== Text Format ===

The texts are sent as plain HTML coded as UTF-8. Plain HTML means that no attributes for HTML elements may be used. This is enforced by the PBX to make sure no malicious content can be sent. The styling of the HTML is up to the receiver of the message.

== Tracing and logging ==
The following trace flags can be activated at [[{{NAMESPACE}}:Maintenance/Diagnostics/Tracing | Maintenance/Diagnostics/Tracing]].

;PBX: communication between the PBX and the myApps client

;HTTP->Servlets: WebSocket communication between PBX and myAPPS client and also App Service. To enable this trace flag it's necessary to go to the debug.xml page.

Additionally, you can enable the following trace flags at the myApps client.
;App
: general information from the APP
;Browser Console
: information from the client/browser side.

In case we use the additional features with license, there is an APP called "Messages" at APP Platform and we can enable the following trace flags for the instance "messages".
;App
: general information from the APP Messages
;Database
: information from APP database.
;App Websocket
: information from APP to PBX regarding websocket.
;Signalling
: information of signalling between App Messages to PBX

Reference16r1:Concept App Connect

2025-10-01T08:10:48Z

Msu: /* Feed */

[[Category:Concept|Apps]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

The Connect app is a social intranet tool, which can be used for organization internal collaboration and is part of the [[Reference16r1:Concept App Service Messages|App Service Messages]].

== Applies To ==
* innovaphone PBX from version 16r1

== Features ==
* Post Messages, Reply to Messages
* Integrated Chat
* File Attachments
* Emojis
* Visibility of Messages organized in Zones
* Feed for Messages addressed to you
* Badge Counts for Feed and Chat
* Private Zone
* Search in Messages, with many filter Options
* Like Posts
* Hashtags
* Definition of Channels, based on Zones and hashtags
* Follow (users, Zones, Hashtags, Discussions, Channels)
* Direct/private Posts
* Address Groups or all Users
* Notifications via email or Push Notifications
* Integrated Help
* Translations, automatically or based on Messages
* Welcome Messages
* User Management (set inactive, anonymize, …)
* Different Roles (user, moderator, administrator)
* UC Integration (Presence, initiate calls, initiate Chats)
* [[Reference16r1:Apps/PbxManager/Shared Services|Shared services integration]]
* Onboarding for new Connect users with a guided tour
* Surveys in Connect via "Polls" app

== Requirements ==
* innovaphone AppPlatform with a running Messages app and valid ntp settings
* innovaphone myApps
* Connect app license for each PBX user, who should use connect

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers feed, your personal home area, search, chat and more. On the central is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

For each button and icon in the UI, an [[#Integrated Help|Integrated Help]] can be used for better understanding of the corresponding function.

=== Feed ===

In your feed, you will see messages that are specific to you. These can be @ mentions or comments on posts that you follow or to which you have replied.

The feed is seperated into thre lists:
* Inbox
* Noted
* Checked

'''Inbox:''' all pending notifications for you. If your inbox is empty, a placeholder is shown, that there is no current notification. '''Noted:''' all notifications you marked as noted. '''Checked:''' all previously checked notifications

If you click on a notification in your feed, in the stream the message in the corresponding thread will be opened. Also you have three symbols under each notification: 
* star - the noticitation is marked as noted, so you can check it later
* speech bubble with checkmark - all notifications in your feed from the same thread, will be marked as checked
* checked - the particular notification will be marked as checked

=== Home ===

Here you can customize your personal home area with pinned channels, zones and hashtags. 
If there are new and unread meessages inside a pinned channel, zone or followed hashtag since your last visit, a number will be displayed, which indicate unread messages. 
Due to performance reasons, it can happen, that a dot-symbol is shown. If you click on a channel/hashtag/zone, the exact number of unread messages will be displayed.

=== Full text search ===

For all words in the message bodies, an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words, two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

=== Chat ===
The newly integrated [[Reference14r1:Concept Chat#Additional Features with license|persistent chat]] feature.
The old separate chat app won't be developed any further and new features and fixes will only be integrated in the connect chat.

If you're having problems with chat after install, make sure that the "Impersonation" option is activated at the connect app object. You find the option at the "App" tab and then at "Grant access to APIs".

To open chat in connect via the old chat icon, enter the app name, which should use app at the [[Reference16r1:PBX/Config/Chat|corresponding field]] on the PBX.

==== General information ====
Instant Messaging is a standard functionality of the innovaphone PBX. The messages are sent using instant messages calls with standard SIP method or proprietary H.323/H.450 facilities. The connect app provides a user interface for chat.
The PBX itself only provides the instant messaging calls and forwarding of the messages. No storing of the messages is provided.

To add additional functionality to chat like storing of chats, group chats or file attachments, the PBX provides an API with the Messages App Object, so that this functionality can be added by an additional App Service. Access to this functionality is also provided to the connect app by an API. Chat can detect the presence of this API. The use of this API must be enabled by a license.

For more technical details, see [[Reference16r1:Concept Chat|here]].

==== Chat Features ====

If the user has a chat license, additional features are available, which need the external Messages service:

;Storing of Chats: No need to the destination of a chat to be online. The message can be sent and read asynchronously
;Badge Count: A badge count is displayed for unread messages. To clear the badge count, the chats containing new messages must be opened
;Group Chats: Groups can be defined and messages sent to these groups. The own chat groups can be seen in the burger menu at "Chat Groups"
;File Attachments:
*File attachments can be added to chat messages. Sending of attachments can be prevented using the [[{{NAMESPACE}}:PBX/Config/General#Common|option "Chat no Attachments"]].: 
*When an attachment is downloaded, the user gets feedback that the download has been started and cannot start it again for 5 seconds. This prevents the user from clicking on it again and again because he might think it won't work. 
*If the attachment is a video (at the moment recognized by the file name extension .mp4, .avi, .mov, or .wmf), the videocam be played directly in connect and doesn't have to be downloaded first.

==== The Badge Count ====

The badge count on the chat tab inside connect is used to indicate the number of unread incoming chat messages. A chat message is considered read if the chat discussion is already open and the input field for a new message has the focus when the chat message arrives or if the chat discussion is opened. If a discussion inside the chat tab is opened, all messages of this discussion are considered read. If the chat tab is opened, but the discussion with unread messages is not opened, the badge count will not be reset to make sure this message is not overlooked.
These rules result in the following sequences, when a chat message arrives:
;Chat tab closed: The chat tab is loaded (if connect is set as default chat app) and a badge count is set. When the chat tab in connect is opened, a badge count is displayed at the respective discussion. The badge count is cleared when the chat tab and the respective discussion inside the chat app is opened.
;The chat tab is opened with a different discussion: A badge count is set at the chat tab and at the respective discussion. The badge count is cleared when the discussion is opened.
;The chat tab is opened with the same discussion, but message input does not have focus: Badge Count is set at the chat tab and at the discussion. The badge count is reset as soon as the message input gets the focus
;The chat tab is opened with the same discussion and message input has focus: No badge count is set
;Chat message is read on a different device: Badge count is reset on chat tab and on the respective discussion

=== More ===
==== Channels ====
Lists all available channels. These can be selected and pinned on the home screen. 
Also new channels can be created.

===== Channel customizing =====
A Channel can be customized with a name, banner and a description. The image for the banner should be at least 1412 x 68 pixels in size so that it does not look pixelated on Full HD screens (preferably even twice as large for higher resolutions).

 But beware: The banner images are currently automatically cropped or duplicated depending on the available screen space (no matter how large the image is), which means that images are cut off (depending on the device on which the user sees the image). This is why color gradients or graphic seamless patterns work best. Text, photos of people or objects are therefore not recommended. However, landscape images (such as typical Windows backgrounds) seems to be fine.

==== Zones ====

Each App within the PBX, that has access to connect defines a zone within messages, named as the App Object. This way, each App has its private zone within Messages, so that a channel maybe defined especially for messages from this App. 
The access to these zones is defined by the access to the Apps. In addition, subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone, it can be defined separately which users or groups of users have access. The groups defined in the PBX are used for this purpose.

==== Tags ====
Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid across zones. There are mechanisms to filter messages based on tags

==== User ====
List of all available connect user.

==== Groups ====
List of all available connect groups, which are active groups inside the PBX.

==== Following ====
List of hashtags, which the user follows and therefore get notifications in his feed.

==== Noted ====
All overall messages you marked as noted (not including noted messages in your feed).

==== Connect Tour ====
New users can familiarize themselves with Connect and its features through a guided tour of the app. A small tutorial with simple "tasks" that reflect real-world usage, similar to an introductory tutorial in a video game or certain apps. 

== The Stream ==

The central part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted, tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel, it appears as read in all matching channels. 

The display of messages is organized in discussions. Initially, only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted in response to other messages. When a response is posted, it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identify to which message the response was posted, a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

If [[#Chat|chat]] is used, the central part is also used by chat for the chat messages. The list of available chats is listed on the left side, where the feed in connect is placed.

=== Integrated Help ===
In the top right corner is a question mark (?) visible. If clicked, question marks appear all over the UI. If you click on one of them, a popup with an explanation appears of what these sections are for.

To deactivate the integrated help, just click on the question mark in the upper right corner again.

=== myApps Assistant App ===
The myApps Assistant App can be integrated inside connect, to access a remote large language model (LLM). 
For more information, see [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_myApps_Assistant the corresponding concept article]

[[image:connect_button_assistant.png|connect_button_assistant.png/|connect_button_assistant.png/]]

=== Direct/Group Messages ===
To address a user directly, simply write a message a add an ''@<username>''. You will also get a list of users you can address to select from, after just writing an ''@''. If you've selected the user, just press enter. After the message is sent, the user will get a notification in his feed, and by clicking on that, connect will directly jump to that specific message. 
'''Important:'''So that a user can be tagged, the user has to open the Connect app at least once.

To address a whole group of users, you have to write ''@@'' and then select the listed group. The list of groups is the list of groups, which exist inside the PBX. The groups need the "active" option activated in the users' configuration, so it can be addressed. 
After sending the message, all users who are members of the tagged group, will get a notification in their feed inside Connect.

To address all connect users at once, simply add ''@@'' without selecting a group. 
This message will address all connect users.

=== Likes ===

User can add likes to messages. The likes are displayed in the notification area of the UI

=== E-Mail Notifications ===

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Configuration ==

==== PBX Settings Plugin ====
*open the PBX Settings plugin for the Messages app
*click on "add App"
*select "Connect"
*enter an appropriate (Long)Name and SIP name ("Connect" and "connect" for example)
*choose the config templates, which should distribute the app to the user, as well as grant administrator and moderator mode
*click on "OK"

The app object is now created in the PBX and automatically connected to the Messages app instance.

'''Important:''' If the app object for connect was created manually, make sure, to activate the following options in the ''App'' tab: '''Websocket''', '''PbxSignal''', '''PbxApi''' and '''Impersonation''' (for Chat)

==== Connect Admin-Mode ====
A user who has access to the admin mode of connect has the ability to set additional options in the burger menu:
* [[#Manage users|Manage users]]
* [[#Manage Groups|Manage groups]]
* [[#Zones 2|Zones]]
* [[Reference16r1:Apps/PbxManager/Shared Services|Federation Domains]]
* [[#E-Mail configuration|E-Mail configuration]]

To get the admin access mode, a user simply needs to get the ''connect~admin'' app granted in the user object.

[[image:connect_admin_mode.png|connect_admin_mode.png/|connect_admin_mode.png/]]

==== Connect Moderator-Mode ====
A user who has access to the moderator mode of connect has the ability to set additional options in the burger menu:
* [[#Hashtags|Hashtags]]
* [[#Welcome post|Welcome post]]
* [[#Manage users|Manage users]] (read only)
* [[#Manage groups|Manage groups]] (read only)

To get the moderator mode, a user simply needs to get the ''connect~moderator'' app granted in the user object.

[[image:connect_moderator_mode.png|connect_moderator_mode.png/|connect_moderator_mode.png/]]

==== connect admin-service mode ====
Used by other apps to be able to post to connect. For example, the [[Reference16r1:Concept App Service Projects|Projects App]].

Needs to be activated at the connect app object, and the app object which should post to connect.

==== Options in detail ====

===== Hashtags =====
Hashtags can be renamed and corrected. 
By doing this, all occurrences are changed. (This can lead to many feed entries, since all affected posts are edited) 
You can also combine two hashtags by renaming one to the same value as the other. 

[[image:Connect_moderator_hashtags_overview.png|thumb|none|300px|connect_moderator_hashtags_overview.png/|connect_moderator_hashtags_overview.png/]]
[[image:Connect_moderator_hashtags_detail.png|thumb|none|300px|connect_moderator_hashtags_detail.png/|connect_moderator_hashtags_detail.png/]]

===== Welcome post =====
Moderators can create automated private welcome posts with useful information for new users. These posts are sent as private messages to help users get started.

===== Manage users =====
All PBX users with configured access to the connect app can open it up. 
Inside the Connct app users are created, after they accessed it once. 
 
If users are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''groups'''. So if a group is deleted in the PBX, the group needs to be disabled in connect.
===== Manage groups =====
Groups can be defined in the PBX, which can then be used in connect to address multiple users at once. You must use @@<groupname> to do this. The user receiving such a message must be an active member of this group.

If groups are deleted in the PBX, they also need to be deactivated in connect or else, they still can be addressed. (only possible in connect '''admin mode''') 
-> the same applies to '''users'''. So if a user is deleted in the PBX, the user needs to be disabled in connect.

===== Zones =====
An administrator can define a zone that is only visible to a certain number of people. A good example of such a zone would be Human Resources or Management.

To create it, open ''Access Rights'' in the burger menu and click the + button. Configure a name and SIPid for this zone. While the name can be chosen freely, the SIPid must have a specific syntax. The SIPid must start with the Connect object name, followed by a question mark and then a short identifier. 
So for a "Human Ressources" Zone, the syntax could be: '''connect?human-ressources''' 
Please note that the normal rules for SIPid's apply here. A simple rule of thumb is to use only A-Z, a-z, 0-9, and . (period) and - (hyphen). However, the name must not start with a . (dot). Although it is not strictly required, we recommend not using uppercase letters.

[[image:connect_zones.png|connect_zones.png/|connect_zones.png/]]

After creating a zone, you can assign the zone to users or groups.

===== E-Mail configuration =====
For Connect to send E-Mails to tagged users/groups, you have to enter valid SMTP settings here.

'''Example:'''

[[image:connect_smtp_settings.png|connect_smtp_settings.png/|connect_smtp_settings.png/]]

''Client'': this entry will create a clickable link in the received mail, where after clicking, myApps will automatically open the conversation in the Connect app

''App URL'': This will create a web link, which jump to the conversation in your default browser

== Troubleshooting ==
==== App Service Log ====
*App WebSocket
*Database

== Related Articles ==

[[Reference16r1:Concept App Service Messages]] 
[[Reference16r1:Concept Chat]] 
[[Reference16r1:Apps/PbxManager/App Messages]]