innovaphone wiki - User contributions [en]

Reference15r1:Concept App Service Fax

2026-10-14T13:07:21Z

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
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*SMTP
*TLS
*TCP
*DB files

As these options generate extensive logs, please '''only enable them to track a current problem and disable them again afterwards'''.

== Known Issues ==
* When using Mail2Fax the Display Name used for the Fax will be the FaxAPP Instance/GroupFax Instance configured in the user Object that have the matching email, if no FaxAPP Instances/GroupFax Instances are configured then a random one available in the system will be used for the Display Name.
* 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.
* Fax Fallback from T.38 to G.711 passthrough (AudioFax) is not supported by FaxAPP when a SIP Trunk with media-relay is used, which is often the case. The solution in such a scenario is to disable T.38 on the SIP Interface with media-relay and only use Audio-Fax.
** Also if the provider does not support T.38, disable T.38 globally, i.e. on every interface in the call flow, so that the fax is sent as audio-fax (G.711a) from the start.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [[Courseware:IT_Plus_-_Fax|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

2026-10-01T14:38:44Z

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
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*SMTP
*TLS
*TCP
*DB files

As these options generate extensive logs, please '''only enable them to track a current problem and disable them again afterwards'''.

== Known Issues ==
* When using Mail2Fax the Display Name used for the Fax will be the FaxAPP Instance/GroupFax Instance configured in the user Object that have the matching email, if no FaxAPP Instances/GroupFax Instances are configured then a random one available in the system will be used for the Display Name.
* 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.
* Fax Fallback from T.38 to G.711 passthrough (AudioFax) is not supported by FaxAPP when a SIP Trunk with media-relay is used, which is often the case. The solution in such a scenario is to disable T.38 on the SIP Interface with media-relay and only use Audio-Fax.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [[Courseware:IT_Plus_-_Fax|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]]

Howto16r1:Configure OAuth2 E-Mail

2026-07-23T13:17:09Z

Msu: /* Related Articles */

The innovaphone PBX and apps can be configured to send E-Mails for various subjects and purposes. Major E-Mail providers intent to discontinue the username/password authentication schemes in favour of OAuth2. PBX and Apps version 16r1 does support OAuth2 authentication for SMTP. Here is a step by step guide how to set up OAuth2 support in Microsoft 365 through the Azure Portal and how to set it up on a Google Gmail account in the Google Cloud Console.

== General Information ==
Most of the large email providers offer the possibility to define an app that is allowed to gain access of a certain scope like SMTP. 
It assigns a Client ID / Client Secret. 
 
Authorization for sending from the mail account needs to be given one time either: 
* By providing resource owner username/password. Sending this to the token endpoint results in an access token and long term refresh token.
* By interactive authorization via a popup dialogue that is loaded from the authorization endpoint. After the credentials are verified, the dialogue redirects to the redirect URI with an authorization code that is traded to an access token and refresh token.
 
The access token is sent for authentication in SMTP. It needs regular refresh, which will be done automatically.

=== Modes ===

* '''Exchange''': Microsoft, with interactive authorization
* '''Microsoft 365''': Microsoft, without interactive authorization (Resource owner and password has to be filled)
* '''Gmail''': Google, with interactive authorization
* '''Google Service Account''': Google, without interactive authorization (Client e-mail, Private Key ID and Private Key of the service account must be provided)
* '''Client secret post''': Generic configuration where all parameters of the client secret post OAuth2 flow can be set.
* '''Private key jwt''': Generic configuration where all parameters of the private key jwt OAuth2 flow can be set.

=== Example Redirect URIs ===

* '''PBX''': <nowiki>https://example-pbx.domain.com/OAUTH2-CLIENT/auth.htm</nowiki>
* '''Reporting''': <nowiki>https://example-ap.domain.com/domain.com/reporting/auth.htm</nowiki>
* '''Fax''': <nowiki>https://example-ap.domain.com/domain.com/</nowiki>'''F'''ax/auth.htm
* '''Users''': <nowiki>https://example-ap.domain.com/domain.com/usersapp/auth.htm</nowiki>
* '''Connect''': <nowiki>https://example-ap.domain.com/domain.com/messages/auth.htm</nowiki>
* '''AP Manager''': <nowiki>https://example-ap.domain.com/manager/auth.htm</nowiki>

== Microsoft 365 ==
=== Azure Portal ===
Log in to Microsoft Azure Portal (https://portal.azure.com) and go to Microsoft Entra ID.
[[File:AzureMicrosoftEntraID.png|none|thumb|600x600px|/AzureMicrosoftEntraID.png|/AzureMicrosoftEntraID.png]]
Add a new app registration to create client credentials.
[[File:AzureAddAppRegistration.png|none|thumb|600x600px|/AzureAddAppRegistration.png|/AzureAddAppRegistration.png]]
Register the application and maybe already fill in the redirect URI for Web based application type to path OAUTH2-CLIENT/auth.htm at the PBX.
[[File:AzureRegisterAnApplication.png|none|thumb|600x600px|/AzureRegisterAnApplication.png|/AzureRegisterAnApplication.png]]
App registration is complete. Client ID and tenant needs to be configured at the PBX and every app that will be sending e-mails.
[[File:AzureApp.png|none|thumb|600x600px|/AzureApp.png|/AzureApp.png]]
Create a client secret. Note that expiry is limited to no longer than 2 years. The client secret must be renewed before expiry and the new secret configured and interactive authorisation carried out again to ensure continuous operation.
[[File:AzureAddClientSecret.png|none|thumb|600x600px|/AzureAddClientSecret.png|/AzureAddClientSecret.png]]
Copy the client secret. It also needs to be configured at the PBX and every app that will be sending e-mails.
[[File:AzureCopyClientSecret.png|none|thumb|600x600px|/AzureCopyClientSecret.png|/AzureCopyClientSecret.png]]
Add permissions located in APIs my organization uses.
[[File:AzureAddApiPermissionMyOrganization.png|none|thumb|600x600px|/AzureAddApiPermissionMyOrganization.png|/AzureAddApiPermissionMyOrganization.png]]
More precisely located in Office 365 Exchange Online.
[[File:AzureAddApiPermissionExchange.png|none|thumb|600x600px|/AzureAddApiPermissionExchange.png|/AzureAddApiPermissionExchange.png]]
And there in the application permissions.
[[File:AzureAddApiExchangeApplication.png|none|thumb|600x600px|/AzureAddApiExchangeApplication.png|/AzureAddApiExchangeApplication.png]]
Namely SMTP Mail.Send.
[[File:AzureAddApiSendMailAsUser.png|none|thumb|600x600px|/AzureAddApiSendMailAsUser.png|/AzureAddApiSendMailAsUser.png]]
Grant admin permission for Mail.Send.
[[File:AzureGrantApiPermissions.png|none|thumb|600x600px|/AzureGrantApiPermissions.png|/AzureGrantApiPermissions.png]]
API permissions are now granted.
[[File:AzureApiPermissionsGranted.png|none|thumb|600x600px|/AzureApiPermissionsGranted.png|/AzureApiPermissionsGranted.png]]
Tell all redirect URIs that the PBX and the apps will be using during interactive authorization.
[[File:AzureRedirectUris.png|none|thumb|600x600px|/AzureRedirectUris.png|/AzureRedirectUris.png]]
Allow public client flows of OAuth2. Resource Owner Password Credentials Flow has the advantage that it doesn't need interactive authorization.
[[File:AzureAllowPublicClientFlows.png|none|thumb|600x600px|/AzureAllowPublicClientFlows.png|/AzureAllowPublicClientFlows.png]]

=== Microsoft 365 admin center ===
Log in to the Microsoft 365 admin center (https://admin.cloud.microsoft).
[[File:MS365AdminCenter.png|none|thumb|600x600px|/MS365AdminCenter.png|/MS365AdminCenter.png]]
Make sure that Microsoft 365 licenses are assigned to your user.
[[File:MS365UserLicenses.png|none|thumb|600x600px|/MS365UserLicenses.png|/MS365UserLicenses.png]]
Set your user active.
[[File:MS365ActiveUsers.png|none|thumb|600x600px|/MS365ActiveUsers.png|/MS365ActiveUsers.png]]
Locate the Mail tab of your user.
[[File:MS365UserEMail.png|none|thumb|600x600px|/MS365UserEMail.png|/MS365UserEMail.png]]
Allow authenticated SMTP.
[[File:MS365AuthenticatedSMTP.png|none|thumb|600x600px|/MS365AuthenticatedSMTP.png|/MS365AuthenticatedSMTP.png]]

=== PBX Example configuration ===
With this Microsoft setup the OAuth2 configuration for the resource owner password credentials flow can be filled in as follows.
[[File:OAuth2ResourceOwnerPasswordCredentials.png|none|thumb|600x600px|/OAuth2ResourceOwnerPasswordCredentials.png|/OAuth2ResourceOwnerPasswordCredentials.png]]
For interactive authorization this is the OAuth2 configuration. Authorize e-mail access one time and send a test mail to verify everything went well.
[[File:OAuth2InteractiveAuthorization.png|none|thumb|600x600px|/OAuth2InteractiveAuthorization.png|/OAuth2InteractiveAuthorization.png]]

== Gmail ==
=== Preparations ===
Login to the Google Cloud Console (https://console.cloud.google.com), select a project, New project.
[[File:GoogleSelectProject.png|none|thumb|600x600px|/GoogleSelectProject.png|/GoogleSelectProject.png]]
Create the project.
[[File:GoogleCreateProject.png|none|thumb|600x600px|/GoogleCreateProject.png|/GoogleCreateProject.png]]
Client credentials will be created in this project.
[[File:GoogleProjectCreated.png|none|thumb|600x600px|/GoogleProjectCreated.png|/GoogleProjectCreated.png]]
From the library specify the APIs needed to access.
[[File:GoogleApisServicesFromLibrary.png|none|thumb|600x600px|/GoogleApisServicesFromLibrary.png|/GoogleApisServicesFromLibrary.png]]
These are in the Gmail API.
[[File:GoogleApisServicesApiLibrary.png|none|thumb|600x600px|/GoogleApisServicesApiLibrary.png|/GoogleApisServicesApiLibrary.png]]
Choose the Gmail API and enable it.
[[File:GoogleGmailApis.png|none|thumb|600x600px|/GoogleGmailApis.png|/GoogleGmailApis.png]]
Credentials need to be created.
[[File:GoogleGmailApiAdded.png|none|thumb|600x600px|/GoogleGmailApiAdded.png|/GoogleGmailApiAdded.png]]
Invoke the help me choose wizard.
[[File:GoogleCreateCredentialsHelpMeChoose.png|none|thumb|600x600px|/GoogleCreateCredentialsHelpMeChoose.png|/GoogleCreateCredentialsHelpMeChoose.png]]
User data access is needed.
[[File:GoogleCredentialsUserData.png|none|thumb|600x600px|/GoogleCredentialsUserData.png|/GoogleCredentialsUserData.png]]
Configure the consent screen of the interactive authorization.
[[File:GoogleOAuthConsentScreen.png|none|thumb|600x600px|/GoogleOAuthConsentScreen.png|/GoogleOAuthConsentScreen.png]]
Specify the permissions that need to be authorized by the user.
[[File:GoogleOAuthScopes.png|none|thumb|600x600px|/GoogleOAuthScopes.png|/GoogleOAuthScopes.png]]
Its mail.google.com in general.
[[File:GoogleScopeMailGoogleCom.png|none|thumb|600x600px|/GoogleScopeMailGoogleCom.png|/GoogleScopeMailGoogleCom.png]]
And its to send email on the users behalf.
[[File:GoogleScopeAuthGmailSend.png|none|thumb|600x600px|/GoogleScopeAuthGmailSend.png|/GoogleScopeAuthGmailSend.png]]
These are the scopes needed.
[[File:GoogleScopes.png|none|thumb|600x600px|/GoogleScopes.png|/GoogleScopes.png]]
Ask client credentials for Web type application.
[[File:GoogleOAuthClientID.png|none|thumb|600x600px|/GoogleOAuthClientID.png|/GoogleOAuthClientID.png]]
Tell all redirect URIs that the PBX and the apps will be using during interactive authorization.
[[File:GoogleRedirectURIs.png|none|thumb|600x600px|/GoogleRedirectURIs.png|/GoogleRedirectURIs.png]]
Download the credentials. This json file contains all information for OAuth2 configuration.
[[File:GoogleClientCredentialsDownload.png|none|thumb|600x600px|/GoogleClientCredentialsDownload.png|/GoogleClientCredentialsDownload.png]]
Customize the OAuth consent screen
[[File:GoogleOAuthConsentScreenSettings.png|none|thumb|600x600px|/GoogleOAuthConsentScreenSettings.png|/GoogleOAuthConsentScreenSettings.png]]
Start the customization wizard.
[[File:GoogleConsentScreenWizard.png|none|thumb|600x600px|/GoogleConsentScreenWizard.png|/GoogleConsentScreenWizard.png]]
Choose which users may authorize.
[[File:GoogleAudienceExternal.png|none|thumb|600x600px|/GoogleAudienceExternal.png|/GoogleAudienceExternal.png]]
Google workspace users may choose internal audience. Users not in Google workspace proceed with external.
[[File:GoogleContactInformation.png|none|thumb|600x600px|/GoogleContactInformation.png|/GoogleContactInformation.png]]
Add a test user.
[[File:GoogleTestUserAdded.png|none|thumb|600x600px|/GoogleTestUserAdded.png|/GoogleTestUserAdded.png]]

=== PBX Example configuration ===
The OAuth2 parameters can be filled in with the information from the json file downloaded above. Authorize e-mail access one time and send a test mail to verify everything went well.
[[File:OAuth2InteractiveGmail.png|none|thumb|600x600px|/OAuth2InteractiveGmail.png|/OAuth2InteractiveGmail.png]]

== Generic ==

For other e-mail providers the client secret post OAuth2 flow may be configured in a generic way. Details need to be supplied by the e-mail provider.

For the Microsoft 365 setup above it would be as follows with Token endpoint ''<nowiki>https://login.microsoftonline.com/af326a34-169c-469e-946b-1ef57925306b/oauth2/v2.0/token</nowiki>'' Authorization URL ''<nowiki>https://login.microsoftonline.com/af326a34-169c-469e-946b-1ef57925306b/oauth2/v2.0/authorize?scope=https://outlook.office.com/SMTP.Send</nowiki> offline_access'' The configuration appends ''&response_type=code&prompt=consent&login_hint=...&redirect_uri=...&client_id=...'' automatically.[[File:OAuth2ClientSecretPost.png|none|thumb|600x600px|/OAuth2ClientSecretPost.png|/OAuth2ClientSecretPost.png]]
For the Gmail example above the generic confguration would be like this with Token endpoint ''<nowiki>https://oauth2.googleapis.com/token</nowiki>'' Authorization URL ''<nowiki>https://accounts.google.com/o/oauth2/auth?access_type=offline&scope=https://mail.google.com/</nowiki>'' The configuration appends ''&response_type=code&prompt=consent&login_hint=...&redirect_uri=...&client_id=...'' automatically.
[[File:OAith2ClientSecretPostGmail.png|none|thumb|600x600px|/OAith2ClientSecretPostGmail.png|/OAith2ClientSecretPostGmail.png]]
The private key jwt OAuth2 flow can be configured generically as well.[[File:OAuth2PrivateKeyJWT.png|none|thumb|600x600px|/OAuth2PrivateKeyJWT.png|/OAuth2PrivateKeyJWT.png]]

== Related Articles ==
* [[Reference16r1:PBX/Config/Authentication]]
* [[Reference16r1:Apps/PbxManager/Email]]
* [[Reference16r1:Concept App Connect#E-Mail configuration]]
* [[Reference15r1:Concept App Service Fax#Mail Configuration (SMTP Server)|Reference16r1:Concept App Service Fax#Mail Configuration (SMTP_Server)]]
* [[Reference16r1:Concept App Service Reports&action=edit&redlink=1#Configuration|Reference16r1:Concept App Service Reports#Configuration]]
* [[Reference16r1:Concept App Service Users#Users Admin App (innovaphone-usersadmin)]]
* [[Reference16r1:Concept App Platform#SMTP]]

Reference16r1:Concept myApps Go!

2026-06-02T14:47:02Z

Msu:

[[Category:Concept|myApps_go!]]

{{FIXME|reason=This product is not yet finished. Articles and content are subject to change until the official release.}}

== Overview ==
myApps Go! is a cloud-based evaluation environment that allows partners, customers and prospects to quickly experience innovaphone's business applications without requiring a full system installation.

Within a few clicks, users can create their own trial instance and explore the three core business applications '''[[Reference16r1:Concept_App_Connect|Connect]]''', '''[[Reference16r1:Concept_App_Service_Projects|Projects]]''' and '''[[Reference16r1:Concept_App_Service_Working|Working]]'''. The platform provides a preconfigured environment that enables immediate testing of communication, collaboration and workplace management features.

The goal of myApps Go! is to simplify onboarding and provide a practical introduction to the innovaphone ecosystem.

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

== Licensing ==
'''UCC license''' per User to use all [[Reference16r1:Concept_App_Connect#Features|Connect Features]]

== Requirements ==

== Features ==

== Installation ==
No software installation is required.

Users create a trial environment through the myApps Go! portal. After the provisioning process is completed, the instance becomes immediately available.
The environment contains the selected applications and predefined sample data where applicable.

New Users can also be created via the Users Settings Plugin.

== Apps ==
Connect
Working
Projects

== Technical Overview ==
myApps Go! provisions isolated cloud-based trial environments. Each trial instance contains the selected applications and the required backend services to provide a realistic user experience.

The provisioning process is automated and minimizes the administrative effort required to start evaluating the platform.

== Technical Concept ==
The platform is based on an automated provisioning workflow. When a user requests a trial instance, the required services, user accounts and application components are automatically deployed and configured.

The resulting environment is accessible through a web browser and provides immediate access to the selected applications.
Via a new Users Plugin in the Settings app, the administrator can create new users, to test the applications with.

By using preconfigured cloud resources, myApps Go! eliminates the need for manual installation and significantly reduces the time required to evaluate innovaphone solutions.

==== Additional Information ====
myApps Go! is intended as an evaluation and demonstration platform. While it provides a realistic representation of the available functionality, certain production-specific integrations and customization options may not be available within the trial environment.

== Troubleshooting ==
<tbd>

== Known Issues ==
<tbd>

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

Reference16r1:Concept myApps Go!

2026-06-02T14:36:26Z

Msu: /* Licensing */

Reference16r1:Concept myApps Go!

2026-06-02T14:31:40Z

Msu: /* Applies To */

Reference16r1:Concept myApps Go!

2026-06-02T14:30:58Z

Msu: /* Overview */

Reference16r1:Concept myApps Go!

2026-05-28T09:41:25Z

Msu: Created page with "myApps_go!  {{FIXME|reason=This product is not yet finished. Articles and content are subject to change until the official release.}} == Overview == == Applies To == == Licensing == == Requirements == == Features == == Installation == == Apps == == Technical Overview == == Technical Concept == ==== Additional Information ==== == Troubleshooting == == Known Issues == == Related Articles =="

[[Category:Concept|myApps_go!]]

{{FIXME|reason=This product is not yet finished. Articles and content are subject to change until the official release.}}

== Overview ==

== Applies To ==

== Licensing ==

== Requirements ==

== Features ==

== Installation ==

== Apps ==

== Technical Overview ==

== Technical Concept ==

==== Additional Information ====

== Troubleshooting ==

== Known Issues ==

== Related Articles ==

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]]