innovaphone wiki - User contributions [en]

Reference15r1:General/Certificates

2026-02-23T08:40:07Z

Dmu: /* Related Article */

== Trust list ==
This list contains the certificates to be accepted for TLS secured connections (e.g. HTTPS, SIPS). You can add either individual endpoint certificates or a CA certificate if you want to accept all certificates issued by that CA.

{|
|valign=top nowrap=true|'''Remove:'''
| Remove the selected certificate.
|-
|valign=top nowrap=true|'''Clear:'''
| Remove all certificates from the trust list.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download a single certificate by clicking the PEM- or DER-link, respectively.
|-
|valign=top nowrap=true|'''Download all:'''
| Download the complete trustlist as a PEM-encoded text file. You can upload that file to another box.
|-
|valign=top nowrap=true|'''Upload:'''
| Select a local certificate file from your computer and press the Upload button to add it to the trust list. You can upload either DER- or PEM-encoded certifiates. PEM-files may contain multiple certificates.
|}

== Rejected certificates ==
This list contains the certificate chains that were rejected before, while trying to establish a secure TLS connection. This happens for example if the certificate is expired or neither the certificate nor any of the issuing CAs is trusted. If one of that certificates should be trusted for future connections you can select and add it to the trust list, directly.

An untrusted certificate chain which is missing the root certificate (the one that is self-signed) is shown as ''Unknown CA''. If the root is present, it is shown as ''Untrusted CA''. It is usually sufficient to add the root certificate to the trust list. However, in case of an ''Unknown CA'', you need to add the last intermediate certificate to the trust list in order to accept the certificate.

{|
|-
|valign=top nowrap=true|'''Trust:'''
| Add the selected certificates to the trust list and remove the corresponding chains from the rejected certificates.
|-
|valign=top nowrap=true|'''Clear:'''
| Discard all rejected certificate chains.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|}

== Certificate Validity ==
For certificates that have already expired or will expire in the near future, the PBX generates an alarm with the message "A certificate has expired or will expire soon".

Since version 12r2sr41, validity alarms are only generated if a matching certificate with longer validity has not already been installed.

== Device certificate ==
The device certificate can be used by remote TLS endpoints to authenticate the identity of the device. In general this is not a single certificate but a chain containing the device certificate and the certificates of the intermediate CAs up to the root CA. A TLS connection can only be established if the remote endpoint trusts at least one of that certificates.

{|
|valign=top nowrap=true|'''Trust:'''
| Add the selected certificates to the trust list.
|-
|valign=top nowrap=true|'''Clear:'''
| This button is only displayed if a certificate was installed by the user, before. Click this button to discard the current device certificate and restore the standard certificate.
|-
|valign=top nowrap=true|'''Renew:'''
| This button is only displayed if no certificate was installed by user, before. Click this button to renew the automatically generated standard certificate.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download a single certificate from the chain by clicking the PEM or DER-link, respectively.
|-
|valign=top nowrap=true|'''Create new:'''
| Click this link to create a new self-singed certificate or certificate request.
|-
|valign=top nowrap=true|'''Upload:'''
| Select a local certificate file and press the "Upload" button. You can upload a single certificate corresponding to the private key of a previously created certificate request in both PEM or DER-format. Instead of that you can upload a complete certificate chain containing the corresponding private key as a PEM-encoded text file, too (.pfx file format is OK). You can supply a password if the file is encrypted.
|}

== Application certificates ==
The application certificates are certificates for specific domains that are used by applications like SIP. The application uses the certificate that matches the own domain. So if you have a PBX with domain "example.com", SIP will fetch the certificate that has "example.com" as its common name.

{|
|valign=top nowrap=true|'''Trust:'''
| Add the selected certificates to the trust list.
|-
|valign=top nowrap=true|'''Remove:'''
| Deletes the selected application certificates from the box.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download a single certificate from the chain by clicking the PEM or DER-link, respectively.
|-
|valign=top nowrap=true|'''Create new:'''
| Click this link to create a new self-singed certificate or certificate request.
|-
|valign=top nowrap=true|'''Upload:'''
| Select a local certificate file and press the "Upload" button. You can upload a single certificate corresponding to the private key of a previously created certificate request in both PEM or DER-format. Instead of that you can upload a complete certificate chain containing the corresponding private key as a PEM-encoded text file, too.
|}

== Signing request ==
A certificate signing request contains a public key and an identity. While the correponding private key is kept secret, the request is being sent to a CA. It will issue an appropriate certificate for the public key after it verified the identity.

{|
|valign=top nowrap=true|'''Details:'''
| Click the name of the signing request to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download the signing request by clicking the PEM- or DER-link, respectively.
|-
|valign=top nowrap=true|'''Remove:'''
| Discard the current signing request and the corresponding private key. As an implication certificates for that key cannot be installed, any more.
|}

=== Uploading the response certificate from a CA ===
See section about device or application certificate upload.

== Related Article ==
[[Reference16r1:Certificate management]]

[[Reference14r2:Concept App Service Devices#Certificates configuration]]

Reference15r1:General/Certificates

2026-02-23T08:39:00Z

Dmu: /* Related Article */

== Trust list ==
This list contains the certificates to be accepted for TLS secured connections (e.g. HTTPS, SIPS). You can add either individual endpoint certificates or a CA certificate if you want to accept all certificates issued by that CA.

{|
|valign=top nowrap=true|'''Remove:'''
| Remove the selected certificate.
|-
|valign=top nowrap=true|'''Clear:'''
| Remove all certificates from the trust list.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download a single certificate by clicking the PEM- or DER-link, respectively.
|-
|valign=top nowrap=true|'''Download all:'''
| Download the complete trustlist as a PEM-encoded text file. You can upload that file to another box.
|-
|valign=top nowrap=true|'''Upload:'''
| Select a local certificate file from your computer and press the Upload button to add it to the trust list. You can upload either DER- or PEM-encoded certifiates. PEM-files may contain multiple certificates.
|}

== Rejected certificates ==
This list contains the certificate chains that were rejected before, while trying to establish a secure TLS connection. This happens for example if the certificate is expired or neither the certificate nor any of the issuing CAs is trusted. If one of that certificates should be trusted for future connections you can select and add it to the trust list, directly.

An untrusted certificate chain which is missing the root certificate (the one that is self-signed) is shown as ''Unknown CA''. If the root is present, it is shown as ''Untrusted CA''. It is usually sufficient to add the root certificate to the trust list. However, in case of an ''Unknown CA'', you need to add the last intermediate certificate to the trust list in order to accept the certificate.

{|
|-
|valign=top nowrap=true|'''Trust:'''
| Add the selected certificates to the trust list and remove the corresponding chains from the rejected certificates.
|-
|valign=top nowrap=true|'''Clear:'''
| Discard all rejected certificate chains.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|}

== Certificate Validity ==
For certificates that have already expired or will expire in the near future, the PBX generates an alarm with the message "A certificate has expired or will expire soon".

Since version 12r2sr41, validity alarms are only generated if a matching certificate with longer validity has not already been installed.

== Device certificate ==
The device certificate can be used by remote TLS endpoints to authenticate the identity of the device. In general this is not a single certificate but a chain containing the device certificate and the certificates of the intermediate CAs up to the root CA. A TLS connection can only be established if the remote endpoint trusts at least one of that certificates.

{|
|valign=top nowrap=true|'''Trust:'''
| Add the selected certificates to the trust list.
|-
|valign=top nowrap=true|'''Clear:'''
| This button is only displayed if a certificate was installed by the user, before. Click this button to discard the current device certificate and restore the standard certificate.
|-
|valign=top nowrap=true|'''Renew:'''
| This button is only displayed if no certificate was installed by user, before. Click this button to renew the automatically generated standard certificate.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download a single certificate from the chain by clicking the PEM or DER-link, respectively.
|-
|valign=top nowrap=true|'''Create new:'''
| Click this link to create a new self-singed certificate or certificate request.
|-
|valign=top nowrap=true|'''Upload:'''
| Select a local certificate file and press the "Upload" button. You can upload a single certificate corresponding to the private key of a previously created certificate request in both PEM or DER-format. Instead of that you can upload a complete certificate chain containing the corresponding private key as a PEM-encoded text file, too (.pfx file format is OK). You can supply a password if the file is encrypted.
|}

== Application certificates ==
The application certificates are certificates for specific domains that are used by applications like SIP. The application uses the certificate that matches the own domain. So if you have a PBX with domain "example.com", SIP will fetch the certificate that has "example.com" as its common name.

{|
|valign=top nowrap=true|'''Trust:'''
| Add the selected certificates to the trust list.
|-
|valign=top nowrap=true|'''Remove:'''
| Deletes the selected application certificates from the box.
|-
|valign=top nowrap=true|'''Details:'''
| Click the name of a certificate to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download a single certificate from the chain by clicking the PEM or DER-link, respectively.
|-
|valign=top nowrap=true|'''Create new:'''
| Click this link to create a new self-singed certificate or certificate request.
|-
|valign=top nowrap=true|'''Upload:'''
| Select a local certificate file and press the "Upload" button. You can upload a single certificate corresponding to the private key of a previously created certificate request in both PEM or DER-format. Instead of that you can upload a complete certificate chain containing the corresponding private key as a PEM-encoded text file, too.
|}

== Signing request ==
A certificate signing request contains a public key and an identity. While the correponding private key is kept secret, the request is being sent to a CA. It will issue an appropriate certificate for the public key after it verified the identity.

{|
|valign=top nowrap=true|'''Details:'''
| Click the name of the signing request to view its details.
|-
|valign=top nowrap=true|'''Download:'''
| Download the signing request by clicking the PEM- or DER-link, respectively.
|-
|valign=top nowrap=true|'''Remove:'''
| Discard the current signing request and the corresponding private key. As an implication certificates for that key cannot be installed, any more.
|}

=== Uploading the response certificate from a CA ===
See section about device or application certificate upload.

== Related Article ==
[[{{NAMESPACE}}:Certificate management|Reference15r1:Certificate management]]

[[Reference14r2:Concept App Service Devices#Certificates configuration]]

Reference15r1:Concept App Service Recordings

2025-11-17T09:26:26Z

Dmu: /* Known Problems */

[[Category:Concept App Service Recordings]]
[[Category:Concept|Apps]]

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png|/Usrrecord.png|/Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png|/Adminrecord.png|/Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto15r1:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== Download Action log ===
After clicking on "Action log" in RecordingsAdmin, it can be downloaded. This is done in a .zip archive containing a .pdf file with the performed actions for all recordings
* action_play (recording has been played)
* action_download (recording has been downloaded)
* action_delete (recording has been deleted)
* action permanent (recording has been protected against deletion)
* action_volatile (protection against deletion has been deactivated)
* action_timeout (recording has been deleted due to the scheduled deletion config)

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[#Scheduled deletion of old recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring WebDav credentials in RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Each user with access to a specific recording is also allowed to see the notes for this recording.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion. 
''The deletion will remove the database entry as well as the audio file from the file system completely, so no recovery will be possible.''

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3, V14r1 or V14r2 to V15r1 Recordings App ==
=== Compatibility ===
A V15r1 Recordings App can not be used in the V13r3, V14r1 or V14r2 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto15r1:RecordingsApp|HowtoV15r1: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== WebDav Access to Recordings not possible with newer Versions of WinSCP ===
When using newer versions of WinSCP, authentication to the WebDAV directory of recordings fails.
Workaround: An older version of WinSCP must be used. The last working version is WinSCP V6.3.7.

Reference14r2:MyApps Plugin for Virtual Desktops

2025-09-19T08:02:57Z

Dmu: /* Known issues */

[[Category:Concept|Apps]]
== Description ==
A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.
Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
Video suffers from the same limitations.
 
A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client.

== Applies To ==
* innovaphone PBX from version 14r2
* Client OS: Windows, Linux (Ubuntu 22 or 23, RangeeOS<ref>RangeeOS is listed due to a customer testimonial. No tests have been conducted by innovaphone. Tests were done using myapps 14r2sr3, RangeeOS Firmware 12.00 build 203 ff and Citrix Workspace 2311. (Workspace version 2402 & 2405 have a bug with USB redirection and 2408 is not starting reliably)</ref>, IGEL OS<ref>IGEL OS: available at [https://app.igel.com/myAppsPlugin/15.1.455+1 IGEL App Portal]</ref>) or MacOS operating systems
* Hypervisor OS: Citrix, Windows Terminal Server environments and VMWare Horizon<ref>VMWare Horizon OS is listed due to a customer testimonial. No tests have been conducted by innovaphone.</ref> 
<references/>

== Requirements ==
* innovaphone PBX
* innovaphone myApps V14r2
* innovaphone myApps Plugin V14r2
* Firmware V14r2 final

== Concept ==

The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:

* start or stop an audio/video device
* gathering of the ICE candidates
* connect to a remote peer with the ICE protocol
* start a ringing device
* rendering of video

But we now need a way of communicating between the myApps running at the terminal server and the myApps plugin running at the terminal client in order to carry out all these actions.

Main VDI Platforms (Citrix, Windows, VMware) provide a way of communicating between server and client through Virtual Channels:

https://support.citrix.com/article/CTX116890/citrix-ica-virtual-channels-overview

https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels

=== Call signaling ===

The VDI Plugin has no connection to the PBX. Signaling is still done at the terminal server by the myApps client.

== Configuration ==

'''Citrix Workspace app must first be installed on all platforms. This is necessary because the myApps plugin must copy a .dll (Windows) / .so (MacOS/Linux) into the Citrix installation directory. '''
 

=== Windows ===

The myApps Plugin .msi must be installed or deployed at the Thin-Client and does not require any configuration.

=== MacOS ===

Install the myAppsPlugin.dmg or .pkg at the Thin-Client and does not require any configuration.

=== Linux ===

Update your Linux PC first:

'''sudo apt-get update'''

Download latest Citrix Workspace App (Mar 7, 2024) for Debian and x86_64 platform:

'''https://www.citrix.com/downloads/workspace-app/linux/workspace-app-for-linux-latest.html'''

Citrix Workspace app needs '''libwebkit2gtk-4.0-37''' packet and this packet is not available in Ubuntu-24.04 version.

Install it at your Linux PC:

https://docs.citrix.com/en-us/citrix-workspace-app-for-linux/install.html

'''sudo apt install -f ./icaclient_<version>._amd64.deb'''

Install (or update) now the myApps Plugin:

'''sudo apt install -f ./myAppsPlugin.deb'''

Headset Buttons:

*Jabra: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-java.rules
**Add <code>ATTRS{idVendor}=="0b0e", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Epos: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-epos.rules
** Add <code>ATTRS{idVendor}=="1395", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Plantronics: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-plantronics.rules
** Add <code>ATTRS{idVendor}=="047f", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Snom: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-snom.rules
** Add <code>ATTRS{idVendor}=="251c", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Yealink: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-yealink.rules
** Add <code>ATTRS{idVendor}=="6993", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>

No additional configuration required.

=== Configuration on the Terminalserver ===
The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

User starts the VDI software (Citrix Workspace App or Windows Remotedesktop) needed to connect to a remote server.

This software automatically starts the myApps Plugin. No user action required.

The user starts myApps at the server for the Softphone App. myApps discovers that it is running in terminal server environment and will connect to the plugin which was already started by the VDI software.

The user does not need to have any knowledge about the myApps Plugin.

== Licensing ==

== Known issues ==
* Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client (only for the Windows Plugin)

* Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
**Video is displayed but with delay due to the rendering process.
**Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.
* When MyApps is used as a Citrix Published App, notification pop-ups cannot be displayed. This is because Citrix does not recognize the notifications as part of MyApps and therefore does not show them as part of the published app. If the full desktop is used in Citrix, the notifications function correctly.
* Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
* The MyApps Plugin for macOS supports only Citrix Workspace, the "Windows-App" from Microsoft is currently not supported
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client (only for the Windows Plugin)

==Troubleshooting==
If the problem still exists after trying the OS-specific hints below, open a support ticket and send a trace from the myApps client (remote) with App and Browser option. Please send also all myAppsPlugin-x.txt and myAppsRemote-x.txt trace files from the myApps-plugin on the local PC.

=== Troubleshooting Windows ===

If Citrix is used as a terminal server environment:

1) Citrix must be installed '''BEFORE''' the plugin

2) Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll

3) Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there.

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

4) In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

Dump files are in the trace folder c:\users\$user\Appdata\local\innovaphone\myAppsPlugin if client crash at start.

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

Computer\HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Default\AddIns\innovaphoneRemoteServicesSvc64

and check as "Name" the path of the .dll <--- c:\program files(x86)\iinnovaphone\myAppsPlugin\myAppsRemoteServiceSvc64.dll

check that the .dll exist in the mentioned direcotry and the plugin.

=== Troubleshooting Linux ===

'''Citrix Workspace App must be installed before the myAppsPlugin'''

Innovaphone Plugin is installed under /opt/innovaphone/'''myAppsPlugin''' and in /opt/Citrix/ICAClient/'''myAppsCitrixPlugin.so'''

myAppsCitrixPlugin.so library is called by the Citrix Workspace App and this library opens the myAppsPlugin.

There is a file in the Citrix installation called module.ini (/opt/Citrix/ICAClient/config/module.ini). Inside this file the myApps Citrix Plugin library is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with '''myAppsCitrixPlugin=On''' must exist and

Following directory '''/var/log/apps/myAppsPlugin/''' must also exist for the log files with write permission for everyone (drwxrwxrwx)

=== Troubleshooting MacOS ===

'''Citrix Workspace App must be installed before the myAppsPlugin'''

In /Library/Application Support/Citrix/PlugIns

must exist myAppsCitrixPlugin.plugin -> /Application/myappsPlugin.app/Contents/PlugIns/myapps_citrix_plugin.plugin

under:

/Users/.../Library/Application Support/Citrix Receiver

there is a file called Modules. Inside this file the myApps Plugin is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

both things are done during the installation. In case something is not working must check that the link to the plugin exists and that the modules file contains these entries.

And under /Users/.../Library/Containers/com.innovaphone.myapps-plugin-14r2/Data/Documents a log file is created: myAppsPlugin.txt

=== Troubleshooting Citrix ===
A Virtual Channel Policy must be added to the Registry at the '''Citrix Server''':

Create '''VCPolicies''' folder under '''HKLM/Software/Policies/Citrix''' if it does not exist.

Create '''VCPolicies''' folder under '''HKLM/Software/WOW6432Node/Policies/Citrix''' if it does not exist.

Create a REG_MULTI_SZ entry with the name '''VirtualChannelWhiteList'''. This entry must contain as value: '''INNOHDX,C:\Program Files (x86)\innovaphone\myApps\myApps.exe'''

== Related Articles ==

* https://wiki.innovaphone.com/index.php?title=Reference14r2:Concept_myApps
* https://wiki.innovaphone.com/index.php?title=Reference14r2:Concept_App_SoftphoneApp

Reference15r1:IP1202/IP1203 DECT System

2025-06-27T07:57:58Z

Dmu: /* Firmware update (manual configuration) */

This article describes the IP1202/IP1203 DECT system and provides further helpful information.

==Applies To==
This information applies to:
*IP1202, IP1202/4, IP1202/4s, IP1202e
*IP1203, IP1203/4, IP1203e
*IP64
*IP65
*Ascom d83
*Firmware Version 15

==Product Availability==
===IP-DECT base stations===
* '''[[Datasheet IP1203|IP1202/4s]]''': Singlecell DECT basestation, offering up to 4 concurrent DECT-channels. Minimum required firmware 13r1sr8.
* '''[[Datasheet IP1203|IP1203]]''': Multicell capable DECT basestation, offering up to 8 concurrent DECT-channels. Successor of IP1202.
* '''[[Datasheet IP1203|IP1203/4]]''': Multicell capable DECT basestation, offering up to 4 concurrent DECT-channels. Successor if IP1202/4.
* '''[[Datasheet IP1203|IP1203e]]''': Multicell capable DECT basestation, offering up to 8 concurrent DECT-channels, two external antenna connectors and two included dipole omni directional antennas. Successor of IP1202e.
===IP-DECT handsets===
Current innovaphone portfolio includes the following DECT devices (as of August 2022):
* '''[[Datasheet IP64|IP64]]''': Entry level handset. Successor of IP61. Labeled as DH6 in WinPDM & IP1203.
* '''[[Datasheet IP65|IP65]]''': Advanced level handset with messaging abilities. Successor of IP63. Labeled as DH7-M in WinPDM & IP1203.
* Ascom '''[[Datasheet d83|d83 Talker]]''': DECT phone for rough environments. Successor of d81. Labeled as d83-Talker in WinPDM & IP1203.
* Ascom '''[[Datasheet d83|d83 Messenger]]''': DECT phone for rough environments with messaging functionality. Labeled as d83-Messenger in WinPDM & IP1203.
* Ascom '''[[Datasheet d83|d83 Protector]]''': DECT phone for rough environments with alarming and messaging functionality. Labeled as d83-Protector in WinPDM & IP1203.

===IP-DECT Antennas===
{{IP-DECT External Antennas}}
For details about external antennas and their usage, refer to [[Reference:IP1202e DECT base station with external antennas|this article]].
===Base station housings===
{{IP-DECT Outdoor Housings}}
===Accessories===
* simple charger (50-00060-001) for both IP64 and IP65 (DC3-UAAA)
* simple charger (50-00083-019) for d83 (DC3-AAAD)
* programming device (50-00060-021) for both IP64 and IP65 for administration purposes via WinPDM (DP1-UAAA - same as for Wifi-device IP73, no Firmware Update for the device itself is required)
* programming device (50-00083-020) for Ascom d83 for administration purposes via WinPDM (DP1-AAAD)
Remarks:
* Chargers and programming devices are not part of the handset delivery and '''have to be ordered separately'''.
* Any previously available DECT devices are end-of-life and no more supported.
==Firmware==
Firmware for DECT-basestations (IP1202, IP1202e, IP1202/4, IP1202/4s, IP1203, IP1203e, IP1203/4), handsets (IP61, IP63, IP64, IP65) and WinPDM can be downloaded via the [https://store.innovaphone.com/release/134513/download.htm innovaphone AppStore].

IP1203x is supported by major firmware version 13 and higher. It can be operated together with IP1202 devices with the same V13 firmware version.

Starting with 15r1, the VARs flash space for IP1203 base stations [[ReleaseNotes15r1:Firmware#189353 - ip1203: increase VARs flash space|was increased]]. If you want to '''downgrade''' an IP1203 base station to prior 15r1 firmware, you have to download the current config, downgrade the IP1203 and upload the config afterward again.

==OTA (Over the Air) Features==
===Important===
If you have your IP120x radios already included in an Ascom Unite system, you can't use these features, since the unite module inside the IP120x configuration is used for the innovaphone OTA features also. 
So either you use a Unite system (which includes paramter configuration and firmware updates) or our OTA features.

A running call won't be affected by the firmware update and the handset will only restart, if the call is ended. But keep in mind, that the update progress will take much longer, since the resources of the IP120x are primary used for running calls.

===Devices App (recommended)===
* You can configure an update job to roll out handset updates: [[{{NAMESPACE}}:Concept_App_Service_Devices#DECT_handsets]].
* You can configure a DECT handset configuration to roll out handset configuration options: [[{{NAMESPACE}}:Concept_App_Service_Devices#DECT_handsets_2]].
* See [[{{NAMESPACE}}:Concept_App_Service_Devices#Supported_DECT_handsets | Supported DECT handsets]].

===Firmware update (manual configuration)===
Firmware of IP64, IP65 and Ascom d81 and d83 handsets can be updated via parameter definition on the dect master.

Upon registering of the handsets, they give the dect master their current firmware version information. If this version differs from the configured firmware version parameter, the base station on which the handset is registered on, starts a download of the firmware. 
After the download is completed, the handsets restarts automatically with the new firmware.

The following config lines need to be added to the IP120x configuration, to update all registered IP64 and IP65 handsets, for example to firmware 3.0.16:

<code>
!config change DEVMANBW /hs-param-url 
!config change DEVMANPP /firm-dh7 3.0.16 /firm-dh7-url http://<PATH to Webserver>/IP65/DH7-M_v3.0.16.bin /firm-dh6 3.0.16 /firm-dh6-url http://<PATH to Webserver>/IP64/DH6_v3.0.16.bin 
!config write 
!config activate 
!reset
</code>

====Explanation of the parameters====

'''''/hs-param-url''''' enables the over-the-air feature in the '''DEVMANBW''' module. The firmware parameters need to be configured in the '''DEVMANPP''' module.

'''''/firm-dh7''''' sets the firmware value for IP65 handsets to the wanted firmware version. If the handset already have that firmware, no update is executed. 
'''''/firm-dh7-url''''' URL where the firmware binary for IP65 handsets can be downloaded. 
'''''/firm-dh6''''' sets the firmware value for IP64 handsets to the wanted firmware version. If the handset already have that firmware, no update is executed. 
'''''/firm-dh6-url''''' URL where the firmware binary for IP64 handsets can be downloaded. 

====More information====
* Only the .bin files can be used as download. If you've downloaded the firmware via our store, it is in .pkg format and includes more data. You need to unpack the .pkg (for example via 7zip or WinRAR) to get the .bin file.
* For each handset, a separate download of the firmware will be executed. So if you have three IP65 handsets registered on the same IP120x, three downloads will be started.
** The DEVMANPP module in the master will limit it to max 10 downloads in parallel. There are also some limitations in the handset that will make sure that there are not more than 5 downloads per radio.
* If a handset is shut down or deregistered while the download is running, the download is cancelled and will be started again, the next time the handset is registered.

===Configuration of Handset parameters ===
'''Important:''' This Feature is available with firmware version '''4.3.2''' onwards for IP64 and IP65 Handsets.

IP64 and IP65 handsets can receive different configurations via a parameter .xml-file from the base station.

The following config lines need to be added to the IP120x configuration:

!config change DEVMANBW /hs-param-url http://<PATH to Webserver>/<parameter-file>.xml
!config write
!config activate

The base station will retrieve the parameter file on restart of the base itself or on the configured timeout value (default is 60 minutes). 
You can adjust the default timeout to a lower value, e.g. 1 minute, by adding the following config:

!config add DEVMANBW /cfg-poll-interval 1
!config write
!config activate

For the handsets to get the parameters, they need to be restarted. After connecting to the base station, the handsets will retrieve the parameters.

An example .xml-file can be downloaded [[index.php?title=Media:Parameter.zip|here]]. 
This file will set the following parameters on the handset:
* Language = German
* Date format = DD/MM/YYYY
* Voicemail number = 99

A list with all available parameters can be found [[index.php?title=Media:Parameter id.pdf|here]].

====Explanation of the parameter list====

Parameter id range 4-7 is for configuring the call menu options, which comes in pairs. So even numbers define the menu text and odd numbers the action (4 and 5, 6 and 7 etc.). Typically used for defining feature access codes.

==== Troubleshooting OTA ====
If the handset is not updated, please send us (support@innovaphone.com) a trace with following options:

'''All IPv4 TCP/UDP Traffic'''

'''All IPv4 TLS Traffic'''

Also enable further trace options, via commands on the base station:
!config add CUNITE /trace /module-trace verbose
!config add CUNITE FILEGET /trace /module-trace verbose
!config add DEVMANPP /trace /module-trace verbose
!config add DEVMANBW /trace /module-trace verbose
!config add MATP /trace /module-trace verbose
!config write
!reset

==Licensing==
innovaphone DECT devices are only operational with innovaphone PBX licenses. Operation without innovaphone PBX is not possible.

==Compatibility Statements==
IP1202 and IP1203 base stations are compatible to each other and can be used in mixed systems in V12 and V13 innovaphone PBX environments (with most recent FW version). When adding an IP1203 to an IP1202 installation, an update of the DECT devices to a V13 firmware is required (PBX can remain on V12 firmware).

===No Base Station and No Handset Compatibility===
The IP1202/IP1203-based IP-DECT solution is '''not compatible''' to IP1200 based IP-DECT solution.

The ''old'' DECT handset IP50, IP52, IP54, IP55, IP56 will '''not operate''' on ''new'' IP1202/IP1203-based IP-DECT system, since not only GAP compliance is required, but also CAP compliance (DECT external handover CAP-N.1).

The DECT handset '''must support GAP and CAP''' for operation on IP1202/IP1203 based DECT system.

The ''new'' DECT handsets IP61, IP63, IP64 and IP65 will '''not operate''' on ''old'' IP1200 based IP-DECT system.

The ''new'' DECT base stations IP1202/IP1203 and IP1202e/IP1203e '''can not be used''' to extend an existing ''old'' IP1200 based IP-DECT system.

=> This means '''NO HANDOVER''' between different systems (move with active call on a specific handset from an IP1200-system to an IP1202/IP1203-based-system or vice versa)

=> This means '''NO ROAMING''' between different systems (usage of a specific handset in a non-compatible IP-DECT system - see above)


=== Mixed Ascom/innovaphone Environments ===
It is generally not supported to mix Ascom (or any of their OEM-products) and innovaphone DECT products in a single installation, e.g.

* Combination of IP120x and Ascom IPBSx base stations is neither allowed nor supported
* Usage of IP61/IP63/IP64/IP65 with Ascom IPBSx based networks is not supported
* Usage of non-innovaphone handsets in IP120x based networks is not supported
* Usage of innovaphone firmware at Ascom devices (bases and/or handsets) is neither allowed nor supported
Exception: Operation of Ascom d8x in an IP1202/IP1203 environment is supported. 
Exception: Usage of IP61/IP63/IP64/IP65 with Ascom UNITE Alarm/Messaging Server is supported. Pay attention to special [[Reference13r3:Unite/|terms and conditions]] for usage.

===No Multicell License Required===

The Multicell License is obsolete for IP1202-based IP-DECT systems.

For IP1202/IP1203-based IP-DECT systems a SARI (Secondary Access Right Identity for DECT) certificate is required. The SARI activates an IP-DECT Master based on IP1202/IP1203. One single SARI certificate is required for a single IP-DECT system, regardless how many base stations are used. Also for IP-DECT systems with one single base station and single-cell base stations a SARI certificate is required. The SARI certificate is not an innovaphone license and only required to make sure the DECT Radio Fixed Part Identity used in the DECT system is worldwide unique one.

A Multicell License can not be converted to a SARI certificate (and there is also no need to do so).

'''Note''': Multicell capability does not apply to IP1202/4s. IP1202/4s is a single cell basestation without expansion capability for another base station. It does not offer handover and roaming capabilities.

===Certifications and Test Reports===
The innovaphone PBX was tested and certified by Ascom Wireless Solutions with Ascom IPBS based IP-DECT System, on which IP1202 is based (but is not the same product). A [[Index.php?title=Media:Innovaphone PBX and Ascom IP-DECT certified by Ascom.pdf&action=edit&redlink=1|Certificate]] and a [[Index.php?title=Media:Innovaphone and ascom DECT Report.pdf&action=edit&redlink=1|Test Report]] of this certification are available for download.

===Wired Headset Support for IP64/IP65===

The IP64 and IP65 DECT handsets offer a 4-pole 3.5mm phone jack for headset connection.

Following headsets are tested by the manufacturer:
* in-ear headset, incl. cable with phone jack - order no. 50-00060-29
* headset with mic on boom, quick disconnect - order no. 50-00060-30 (needs additional adapter for QD to 3.5mm phone jack - order no. 50-00060-032)

There's no technical support in case of issues for use of other headsets.

====3rd party products====
Partner reports successful testing of following products:
* Sennheiser 506090 CMB 01 CRTL - 4-pole 3.5mm adapter to connect Sennheiser headsets at IP64
* Apple iPhone Headset with 4-pole 3.5mm jack, Tested answer and disconnect by pressing button in headset cord.

Note though, that innovaphone gives no technical support in case of malfunction.

===Bluetooth Headset Support for IP63 / IP65===
IP63 and IP65 DECT handsets support handsfree and headset profiles for Bluetooth.

Following headsets are tested by the manufacturer - for some models restrictions have been reported to us (as of 11/20/18):
* Jabra EVOLVE 65 MS Stereo
* Jabra EVOLVE 75
* Jabra MOTION UC+ MS
* Jabra STEALTH
* Jabra SUPREME UC MS (audio not working correct on outgoing calls with various CTI clients)
* Peltor WS Headset XP (MT H7 WS5)
* Plantronics B825-M Voyager Focus
* Plantronics BackBeat GO 2
* Plantronics Blackwire 710
* Plantronics Explorer 500 Bluetooth Headset Black
* Plantronics ML20 (not for IP65)
* Plantronics M70
* Plantronics M90
* Plantronics Voyager 5200 BT Headset EU
* Plantronics Voyager Edge
* Plantronics Voyager Legend UC (audio not working correct on outgoing calls with various CTI clients)

== DECT In-Call Features ==
IP1202 and IP61/63/64/65 handsets offer In-Call features by R-Key handling accoring to [[Howto:How to use the R-key handling|this description]].

== 3PTY (3 party conference) ==
Starting with version 9 firmware, the IP1202 DECT system supports 3PTY (3 party conference) on DECT phones. However, be aware that this ''requires innovaphone CONF/SCNF interfaces'' as part of the system. Such CONF/SCNF interfaces may or may not be present on a gateway device running the PBX, depending on the model used. See [[Technical Data|respective gateway datasheets]] for ''voice/audio conference channels'' provided by the device. Note that the CONF/SCNF interface used does not need to be present in the PBX device, it can be provided by just any gateway platform available in the system. There are no conference channels available in the IP1202/IP1203 though.

For details about configuration please refer to [[Courseware:IT Plus - Conferencing and DECT#3-way DECT conference|the relevant training document]].

== Usage in non-EU countries ==
innovaphone DECT prodcuts of type IP1202x, IP1203x, IP64 and IP65 can technically be operated in most countries of the world, as the hardware supports all relevant DECT frequencies (software configurable).

However, the devices are approved in EU/EFTA states only! Use in other countries will probably be illegal thus.

== Test-SARI ==

DECT Systems are using a worldwide unique system identification (SARI) to be separated from each other.

For test and training purposes, innovaphone offers the following SARI:

31100422072149

This SARI is intended for use in test/training systems only!

'''Usage within productive systems is prohibited and not recommended.'''

If the SARI is changed, all handsets have to be subscribed again.

DECT systems which are near to each other and are using the same test-SARI, may disturb each other.

==DECT Service Codes==
===IP64===
*#34# - Displays the Device Info
*#06# - Displays the IPEI/IPDI
===IP65===
*#34# - Displays the Device Info
*#06# - Displays the IPEI/IPDI
*#77# - Site Survey Tool

==Admin Menu==
The handset has a hidden menu for system administrators. The Admin menu contains:
*Software and hardware information, IPEI/IPDI, and User ID
*DECT link and system information
*Site survey tool
*Fault logging
*Enhanced system menu with ability to alter protection
*Factory reset option

To activate the Admin Menu, enter the Call time screen via "Menu->Call list->Call time" and press <code>> * < < * <</code>

<code>> or <</code> means pressing the rocker key in the indicated direction ;-)

==Status indication LED==
The IP1202/IP1203 has one RGB LED to indicate its current status.

Each blink pattern is represented by a number of blocks where each block is 100 ms. Light grey blocks means that the LED is off. Whenever the indication is changed the new pattern always starts from the first block.

Following status are indicated:

* Idle/OK "Solid blue"
[[image:solidblue.png|solidblue.png/|/Solidblue.png]]

IP1202 operational and no traffic on the IP1202/IP1203.

* Starting up/ searching "100 ms blue, 100 ms off"
[[Image:100blue100off.png|100blue100off.png/|/100blue100off.png]]

The IP1202 is in start-up phase, e.g. waiting for parameters from PARI Master, or is searching for air synchronization.

* Active traffic "400 ms off, 2000 ms blue"
[[Image:400ms_off_200ms_blue.png|400ms_off_200ms_blue.png/|/400ms_off_200ms_blue.png]]

IP1202/IP1203 operational and traffic on the IP1202/IP1203.

* Fully occupied "400 ms red, 2000 ms blue"
[[Image:400ms_red_2000ms_blue.png|400ms_red_2000ms_blue.png/|/400ms_red_2000ms_blue.png]]

Fully occupied with speech traffic.

* Software download "400 ms blue, 600 ms off"
[[Image:400ms_blue_600ms_off.png|400ms_blue_600ms_off.png/|/400ms_blue_600ms_off.png]]

Firmware download in progress.

* Mini firmware "100 ms yellow, 100 ms off"
[[Image:100ms_yellow_100ms_off.png|100ms_yellow_100ms_off.png/|/100ms_yellow_100ms_off.png]]

The IP1202 is in mini firmware mode.

* TFTP mode "Solid yellow"
[[Image:solid_yellow.png|solid_yellow.png/|/Solid_yellow.png]]

TFTP mode.

*Error "100 ms red, 100 ms off"
[[Image:100ms_red_100ms_off.png|100ms_red_100ms_off.png/|/100ms_red_100ms_off.png]]

No Ethernet connection.

*Fatal error "Solid red"
[[Image:solid_red.png|solid_red.png/|/Solid_red.png]]

Fatal hardware error.

*Deployment: Good sync "2000 ms blue, 400 ms yellow"
[[Image:2000ms_blue_400ms_yellow.png|2000ms_blue_400ms_yellow.png/|/2000ms_blue_400ms_yellow.png]]

The IP1202/IP1203 is in deployment mode and has good air sync coverage.

*Deployment: Bad sync "400 ms blue, 600 ms off, 400 ms blue, 600 ms off, 400 ms yellow"
[[Image:bad_sync.png|bad_sync.png/|/Bad_sync.png]]

The IP1202/IP1203 is in deployment mode and does not have adequate air sync coverage.

*Deployment: No sync "2000 ms red, 400 ms yellow"
[[Image:2000ms_red_400ms_yellow.png|2000ms_red_400ms_yellow.png/|/2000ms_red_400ms_yellow.png]]

The IP1202/IP1203 is in deployment mode and has no air sync coverage

==Known Problems==
=== H.323/TLS Registrations ===
If you want to use H.323/TLS as Registration Protocol for the Dect-Handsets on an IP1202/IP1203, there are a few things to consider. Using the [[Reference13r1:PBX/Objects#Device Config Flags|''TLS only'']] Flag in the corresponding User Object will not work, because the CN (Common Name) of the IP1202/IP1203-Certificate doesn't match, with the Username and therefore the Registration at the PBX will fail.

If you still want to use a H.323/TLS Connection between IP1202 and PBX, you have to use other Mechanics to authenticate the DECT-Handsets. This can be done either by using the User Objects Password (not recommended) or activate the Flag [[Reference13r1:PBX/Objects#Device Config Flags|''PBX Pwd'']] at the corresponding User Object (recommended). You have to enable [[Reference11r1:DECT2/Config/Master|Registration with system password]] at the IP1202/IP1203

With this Setup, you have H.323/TLS based communication between the IP1202/IP1203 and your PBX and the user himself is authenticated via the [[Reference9:PBX/Config/Security#PBX password|PBX Password]].

=== incoming calls limited to number of radio/DSP channels ===
Each incoming call towards a radio base station (IP1202/IP1203 or IP1202/4,IP1203/4) allocates a DSP channel during the alert state.

If more DECT-handsets are subscribed to this base than DSP/radio channels are available, call setup will fail for surplus devices, and result in no audio (just noise).

Example: Call Broadcast to 5 DECT users subscribed in a IP1202/4,IP1203/4. One out of these 5 users will alert but without any DSP allocation (random). Answering such a call results in no audio for this user.

=== Blind Transfer ===
Internal ring tone after external call is blind-transferred to C, which does not save external
number in call list (per IPBS design)

=== No number resolution from local contacts ===
In case numbers of local contacts are not resolved in incoming call screen but in call list only, adjust display management settings via WinPDM:

[[image:dect_call_list.png|dect_call_list.png/|/Dect_call_list.png]]

=== Firmware Compatibility ===
Newer IP1202 hardware (such with product code ''IPBS2-M3A '', ''IPBS2-M4A '' or ''IPBS2-M5A'' on the back, introduced 2Q2015) need at least firmware V11r1 SR3 or V10 SR22. Older versions are not supported!

=== Choppy voice on handsets in noisy environments ===
If DECT handsets are used in noisy environments (e.g. industry), gaps in the voice can appear, the syllables appear to be dropped from time to time.

This is caused by the echo canceller on the radio (IP1202/IP1203) serving the connection for the DECT handset.

A config switch for noise optimised echo canceller mode can be used in this case for IP1202:

!config add MSP0 /ec-type 1

and for IP1203 a different command:

!config add SOFT-DSP0 /ec-type 1

This config switch should be distributed to the base stations serving the radio connections for the DECT handsets in noisy environments only.

The ''ec-type'' parameter can be configured with values ''0-2'', 2 being currently (12r2SR14) the default value.

According a report from a customer, setting the ec-type value to 0 (i.e. disable the echo canceller) at the base-stations in the noisy environment (and only there) helped. So if setting <code>ec-type 1</code> doesn't help, you can try <code>ec-type 0</code>.

===Phone book search of users with * or # is not possible===
The phone book search is realized via SMS messages. This protocol defines and works with digits only. Therefore, this function cannot be used by users who contain a * or # in their number. In other words, users who perform the phonebook search cannot use * or # in their number.

===Remarks===
For a successful registration to the PBX, it is mandatory that an entry with the user's ''Name'' as ''Hardware Id'' value exists in the ''Devices'' section of the PBX user.



==Related Articles==
*[[Datasheet_IP1203]]
*[[Datasheet_IP64]]
*[[Datasheet_IP65]]
*[[Datasheet_d83]]
*[[Reference:IP1202e DECT base station with external antennas]]
*[[Courseware:IT_Plus_-_IP-DECT]]
*[[Courseware:IT_Plus_-_Conferencing_and_DECT]]
*[[Howto:How_to_use_the_R-key_handling]]

Reference15r1:Concept App Service Recordings

2025-05-14T08:58:23Z

Dmu: /* Known Problems */

[[Category:Concept App Service Recordings]]
[[Category:Concept|Apps]]

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png|/Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png|/Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto15r1:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== Download Action log ===
After clicking on "Action log" in RecordingsAdmin, it can be downloaded. This is done in a .zip archive containing a .pdf file with the performed actions for all recordings
* action_play (recording has been played)
* action_download (recording has been downloaded)
* action_delete (recording has been deleted)
* action permanent (recording has been protected against deletion)
* action_volatile (protection against deletion has been deactivated)
* action_timeout (recording has been deleted due to the scheduled deletion config)

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[#Scheduled deletion of old recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring WebDav credentials in RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Each user with access to a specific recording is also allowed to see the notes for this recording.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion. 
''The deletion will remove the database entry as well as the audio file from the file system completely, so no recovery will be possible.''

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3, V14r1 or V14r2 to V15r1 Recordings App ==
=== Compatibility ===
A V15r1 Recordings App can not be used in the V13r3, V14r1 or V14r2 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto15r1:RecordingsApp|HowtoV15r1: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

Reference14r2:Concept App Service Recordings

2025-05-14T08:58:05Z

Dmu: /* Known Problems */

[[Category:Concept|Apps]]
== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V14r2xx
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* Reporting App

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png|/Usrrecord.png|/Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png|/Adminrecord.png|/Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels
* Filter records by name, by date
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information
* Protect against deleting or delete a recording

== PBX Manager Plugin ==

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App and configure the name of the PBX in the settings via upright option. Define here a WebDav-User and a WebDav-Password.
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/</code>''recording instance name''<code>/Files</code>
:on deskphones (Services/HTTP/Client: URL,User,Password; Phone/User-x/General: Record to (URL)), softphones(PBX/Config/MyApps:Recording-URL, -Username and -Password) or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== Access List ===
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto14r2:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

=== Deletion of recordings ===
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

== Call Information ==
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

== Call Recording Storage ==
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

== Licensing ==

An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

== Recording on Special Interfaces ==

* Trunk Interface/Gateway

The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.

* Waiting Queue

The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3 or V14r1 to V14r2 Recordings App ==

=== Compatibility ===

A V14r2 Recordings App can not be used in the V13r3 or V14r1 PBX and App Platform environment.

=== License Changes ===

Licensing is the same as version 14r1

=== Database Conversion ===

Databases from previous versions (13r3,14r1) will be converted automatically

=== Update App Object configuration ===

If upgrading from a previous version, the app object configuration in the PBX Manager must be invoked.
Each app object configuration must be selected and "Ok"-ed for the new interoperation with App Service
"Reports" to be set up. In detail these are: the websocket connection, the "reporting" app usage and the
usage of the "Admin" and "Services" API.

=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. In version 14r2, this is done in a zip archive containing the wave audio file and a .pdf file containing
the call information.

== WebDav Access ==
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[#Scheduled deletion of old recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto14r2:RecordingsApp#Configuring WebDav credentials in RecordingsAdmin|the respective documentation]].

== Encrypted Recordings ==
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next reecordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

== 4 Eyes Access ==

This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

== Notes ==
Due to a main rework of the Notes function, this is no longer available from version 14r2 sr5.
We are revising the function and expect to release it with version 15r1.

== Watermark ==
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Troubleshooting ==

=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:

*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports".
*In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto14r2:RecordingsApp|HowtoV14r2: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

Reference15r1:Concept App Service Recordings

2025-02-14T07:44:50Z

Dmu:

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

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto15r1:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== Download Action log ===
After clicking on "Action log" in RecordingsAdmin, it can be downloaded. This is done in a .zip archive containing a .pdf file with the performed actions for all recordings
* action_play (recording has been played)
* action_download (recording has been downloaded)
* action_delete (recording has been deleted)
* action permanent (recording has been protected against deletion)
* action_volatile (protection against deletion has been deactivated)
* action_timeout (recording has been deleted due to the scheduled deletion config)

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[Reference15r1:Concept_App_Service_Recordings#Scheduled_deletion_of_old_recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Each user with access to a specific recording is also allowed to see the notes for this recording.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3, V14r1 or V14r2 to V15r1 Recordings App ==
=== Compatibility ===
A V15r1 Recordings App can not be used in the V13r3, V14r1 or V14r2 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto15r1:RecordingsApp|HowtoV15r1: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== Separate app instance required per PBX ===
In a setup with several PBXs (master-slave), it is necessary to create a separate Recordings instance for each PBX in the AP Manager.
Currently, only one PBX name can be configured per Recordings instance. This results in a separate RecordingsAdmin and RecordingsUser app for the user for each PBX.

Reference15r1:Apps/PbxManager/App Recordings

2024-12-12T09:40:54Z

Dmu: Created page with "This PBX Manager Plugin contains 1 section: * Add, edit or delete RecordingsApp and RecordingsAdmin on the PBX. == Add an App == ; Name : The name displayed for the App Object. ; SIP : The sip from the App Object, which must be unique. ; TYPE : type of the app object, either User or Admin ; Delete Mode : Select if users on this object should be able to delete a recording directly, move it to the recycle bin or if users are not able to delete recordings ; Reporting :..."

This PBX Manager Plugin contains 1 section:
* Add, edit or delete RecordingsApp and RecordingsAdmin on the PBX.

== Add an App ==
; Name
: The name displayed for the App Object.

; SIP
: The sip from the App Object, which must be unique.

; TYPE
: type of the app object, either User or Admin

; Delete Mode
: Select if users on this object should be able to delete a recording directly, move it to the recycle bin or if users are not able to delete recordings

; Reporting
: Name of the reporting object recordings connect to get the call information

; Monitored Access
: Select a user (e.g. a supervisor). If a user is selected, this user needs to grant permission to any user who wants to access a recording in his RecordingsUser App.

; WaterMark
: Choose if watermarking is done or not

; Access list
: When configuring a USER recordings object, a table of 30 entries is shown where the users of this recordings object can be given access to other recordings on specific numbers
: besides their own. For details, see [[Howto15r1:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

Reference15r1:Concept App Service Recordings

2024-12-12T09:37:10Z

Dmu: /* Access List */

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

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto15r1:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== Download Action log ===
After clicking on "Action log" in RecordingsAdmin, it can be downloaded. This is done in a .zip archive containing a .pdf file with the performed actions for all recordings
* action_play (recording has been played)
* action_download (recording has been downloaded)
* action_delete (recording has been deleted)
* action permanent (recording has been protected against deletion)
* action_volatile (protection against deletion has been deactivated)
* action_timeout (recording has been deleted due to the scheduled deletion config)

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[Reference15r1:Concept_App_Service_Recordings#Scheduled_deletion_of_old_recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Pressing the "note" button again closes the window.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3 or V14r1 to V14r2 Recordings App ==
=== Compatibility ===
A V14r2 Recordings App can not be used in the V13r3 or V14r1 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto15r1:RecordingsApp|HowtoV15r1: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== Separate app instance required per PBX ===
In a setup with several PBXs (master-slave), it is necessary to create a separate Recordings instance for each PBX in the AP Manager.
Currently, only one PBX name can be configured per Recordings instance. This results in a separate RecordingsAdmin and RecordingsUser app for the user for each PBX.

Howto15r1:RecordingsApp

2024-12-12T09:34:24Z

Dmu:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
= Applies To =
This information applies to
* RecordingsApp V15r1

= More information =
This article describes how to set up the RecordingsApp.

= System Requirements =
* innovaphone PBX
* innovaphone AppPlatform
* RecordingsApp
* ReportingsApp
* App(innovaphone-recorder) licenses per User

= Configuration =
== Setting up the Instance in the AP Manager ==

Use the ''PBX Manager'' Plugin called "app installer" to download the ''Recordings'' App. It will automatically create an instance of the app on your AP.
You can configure the new ''Recordings'' App instance using the ''Recordings'' ''PBX Manager'' plugin.

== Configuration in the PBX Manager Plugin ==
In this step, it is mandatory to add two new objects to the PBX and grant the necessary licenses and permission to the templates to use the application.
In the PBX Manager navigate to AP Recordings, create two new objects and configure the templates.

===Adding objects using the Recordings Plugin===
[[Image:14r2_AP_Recordings-User.png|thumb|upright=1.0|right|PBX Manager User]]
[[Image:14r2_AP_Recordings-Admin.png|thumb|upright=1.0|right|PBX Manager Admin]]
*First, you'll need to add 2 new objects for the RecordingsApp to work.
**You need to add an object for '''"User"''' and one for '''"Admin"'''.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User, or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
***''Monitored Access'': Select a user (e.g. a supervisor). If a user is selected, this user needs to grant permission to any user who wants to access a recording in his RecordingsUser App.
***''WaterMark'': Select if Watermarking is done or not. If "YES" is selected, watermarking will be done for ALL recordings in the database, not only new recordings.
 
 
 
 
 

===Access list configuration through the Recordings Plugin===
*Access list is a User type of app that allows the access to other user's records. Access list is useful to scale the access rights of the system records.
**Here you need to add another object for the Access List.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
**''Access list'': Enter a number in each field. The number (e164) of the user who will use the application and the number (e164) for the user whose recordings will be accessed.
***''Wildcard for Access list'': An * can be entered instead of the number (e164). This gives you a user app with access to all recordings but not to the admin settings
'''<pre>Hint: Do not forget to give the access rights of the app to the users via the template configuration</pre>'''

== Configuring Templates ==
*You need to grant permissions and licenses for the app to work. You can use templates for this.
**Select the user template and grant the app permission and license.
**Select the admin template and grant the admin-app permission and also the license.
**Now users with either template can use the appropriate apps.

== Configuring the Recordings-App ==
[[Image:RecordingsAdmin-Config.png|thumb|upright=5.0|right|App Configuration]]
The only change that needs to be done here is configuring the PBX name inside the Admin-App, otherwise it won't correctly record the calls.
*Follow the steps inside the '''RecordingsAdmin''' - app
**After opening the app, you can open a sidebar-menu with the upper right menu button.
**Below you see the needed setting called '''"PBX name"'''. Here, you enter the name of the PBX.
 

== Configuring WebDav credentials in RecordingsAdmin ==
Starting from 14r1, WebDav credentials can be configured in RecordingsAdmin. With this credentials it is possible to get Access to the original .pcap Files.
In RecordingsAdmin, user and password can be configured.
'''Please note that all Devices which should be recorded, will need to authenticate if this is configured.'''

For Softphones, fill out the appropriate fields at ''Advanced-UI --> PBX --> Config --> myApps --> Recording Username / Recording Password''.

In order to not display the user and password to the end-user, you can hide the Record-to-URL by activating the hide setting at:
''Advanced-UI --> PBX --> Config --> myApps --> Recording URL in softphone app hidden''

For Hardphones and Gateways, you can also add the user and password to the URL or go to ''Advanced-UI --> Services --> HTTP --> Client'' and configure the Record-to-URL as Authenticated URL by using the previously configured user and password.
 
 
 
 
 
 
 
 
 
 
 

== Configuring CDR ==
[[Image:Recordings13r3_Object-Apps.png|thumb|upright=1.0|right|Checkboxes Apps]]
*The CDRs are fetched from the ReportsApp.
**Make sure that there is a correctly configured Reporting-Instance and that the pbx sends the CDRs into this instance.
**For the Recordings-Users, no Reporting-License is necessary.
**The correct Reporting-Instance should be selected in the '''apps''' tab in the Recordings-Object.
 

== Checking the Recordings-User-App object ==
[[Image:Recordings13r3_Object-App.png|thumb|upright=1.0|right|Checkboxes App]]
It could happen that '''Websocket''', '''Admin''' and '''Services''' aren't ticked in '''"Objects"''' , but this is necessary.
*To check this, you need to navigate to '''PBX - Objects'''
**Select the '''Recordings''' object and navigate to the '''App''' tab.
**All three above mentioned checkboxes should be ticked.
 
 
 
 
 
 

== Checking the Reporting-App object ==
You need to make sure, that '''Websocket''' is ticked in the '''App''' tab and that the object is '''connected''', otherwise, Recordings is not able to fetch any data from the App Service "Reports".
 
 
 

== Record-to-URL ==
The Record-to-URL is composed by the following information:
<nowiki>https://<App platform DNS>/<domain>/<instance name>/Files</nowiki>
'''Be aware: The Record-to-URL always has to be used case sensitive!'''

== VoIP-Interface / Softphone / Phone configuration ==
=== Configuring the VoIP-Interface through the Devices-Interface ===
[[Image:Recordings13r3_SIP-Interface.png|thumb|upright=5.0|right|SIP-Trunk]]
If you want all external calls to be recorded, then the SIP-Trunk needs to know the Record-to-URL, you inserted earlier too.
Also, the Media-Relay checkbox needs to be checked.
*Since you also want to record any call that goes through your SIP-trunk, you need to insert the Record-to-URL into the SIP.
**For this, you select the '''Gateway --> SIP''' tab.
***Make sure that the URL is configured correctly and also the Media-Relay is activated.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
=== Configuring the Softphones ===

'''Please note that the recordings-config for softphones is only available, if the softphone user has the correct licence App(innovaphone-recorder) assigned.'''
'''Also, the recordings-config distributed by the PBX will not take effect if the user has no license.'''

For the softphones, the Record-to-URL must be inserted via the SoftphoneApp - Burger Menu. In addition, you can configure whether to record automatically every call or whether to record only external calls.

==== Config distribution via PBX ====
The Record-to-URL can also be configured via the ''Advanced-UI --> PBX --> Config --> myApps''.

=== Configuring the Phones through the DevicesApp ===
[[Image:Recordings14r1_Expert-Config.png|thumb|upright=5.0|right|URL]]
* Go to Devices and select the proper Domain.
* Create within this Domain an additional Provisioning Category with a meaningful name like "Phones with Recording"
* Create within this Domain an additional Device Configuration from type [Phone] with a meaningful name like "Phone configuration for recording" and assign it to the Category "Phones with Recording".
* Add the Recording URL
* Create within this Domain an additional Device Configuration from the type [Expert configuration] with a meaningful name like "Record Transparent" and assign it to the Category "Phones with Recording"
* Add the following Expert Mode commands:

mod cmd PHONE/CONF-UI reg-edit-rec /cmd reg-edit-rec /id 0 /rec.mode transparent /rec.to p /rec.e164 /rec.h323 /op OK
config write
config activate
iresetn

* In the Devices Tab, select the desired IP Phone(s) and add these to the Category "Phones with Recording". Be aware, you can have only one Provisioning Category assigned, so de-assign the excisting one.
* Run the Expert Configuration.
The IP Phone will show shortly the message Software Update 1%.
After the change, check the changed configuration.
 
 
 
 
 
 

=== Configuring the Phones through the Advanced-UI ===
For the phones to actually start recording as soon as they make a call, you need to set up a few things. This is done in the phones Advanced-UI settings, for example by using Devices-App.

==== Setting up the Record-to-URL ====
[[Image:Recordings13r3_Phone-User.png|thumb|upright=5.0|right|URL]]
*To enable call recording, you need to set up the following values:
**At the Advanced-UI, select the '''"Phone"''' tab.
**Down below, you again need to insert a case-sensitive Record-to-URL into the field, which follows the following rule:
***'''https://app-platform/domain/recordings/Files'''
 
 
 
 
 
 
 
 
 
 
 

==== Setting up the Recording-Tab ====
[[Image:Recordings13r3_Phone-Recordings.png|thumb|upright=5.0|right|Recording-Tab]]
*To fully function, the following changes need to be made in the '''Recording-Tab'''
**''Mode:'' Transparent: This means that the call will be recorded instantly.
**''Recorder:'' HTTP Server
 
 
 
 
 
 
 
 

== Related Articles ==
http://wiki.innovaphone.com/index.php?title=Reference15r1:Concept_App_Service_Recordings

[[Category:Howto|{{PAGENAME}}]]

Reference15r1:Concept App Service Recordings

2024-12-12T09:33:03Z

Dmu: /* Related Articles */

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

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto14r2:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== Download Action log ===
After clicking on "Action log" in RecordingsAdmin, it can be downloaded. This is done in a .zip archive containing a .pdf file with the performed actions for all recordings
* action_play (recording has been played)
* action_download (recording has been downloaded)
* action_delete (recording has been deleted)
* action permanent (recording has been protected against deletion)
* action_volatile (protection against deletion has been deactivated)
* action_timeout (recording has been deleted due to the scheduled deletion config)

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[Reference15r1:Concept_App_Service_Recordings#Scheduled_deletion_of_old_recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Pressing the "note" button again closes the window.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3 or V14r1 to V14r2 Recordings App ==
=== Compatibility ===
A V14r2 Recordings App can not be used in the V13r3 or V14r1 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto15r1:RecordingsApp|HowtoV15r1: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== Separate app instance required per PBX ===
In a setup with several PBXs (master-slave), it is necessary to create a separate Recordings instance for each PBX in the AP Manager.
Currently, only one PBX name can be configured per Recordings instance. This results in a separate RecordingsAdmin and RecordingsUser app for the user for each PBX.

Howto15r1:RecordingsApp

2024-12-12T09:32:09Z

Dmu: Created page with "= Applies To = This information applies to * RecordingsApp V15r1 = More information = This article describes how to set up the RecordingsApp. = System Requirements = * innovaphone PBX * innovaphone AppPlatform * RecordingsApp * ReportingsApp * App(innovaphone-recorder) licenses per User = Configuration = == Setting up the Instance in the AP Manager == Use the ''PBX Manager'' Plugin called "app installer" to download the ''Recordings'' App. It will automatically creat..."

= Applies To =
This information applies to
* RecordingsApp V15r1

= More information =
This article describes how to set up the RecordingsApp.

= System Requirements =
* innovaphone PBX
* innovaphone AppPlatform
* RecordingsApp
* ReportingsApp
* App(innovaphone-recorder) licenses per User

= Configuration =
== Setting up the Instance in the AP Manager ==

Use the ''PBX Manager'' Plugin called "app installer" to download the ''Recordings'' App. It will automatically create an instance of the app on your AP.
You can configure the new ''Recordings'' App instance using the ''Recordings'' ''PBX Manager'' plugin.

== Configuration in the PBX Manager Plugin ==
In this step, it is mandatory to add two new objects to the PBX and grant the necessary licenses and permission to the templates to use the application.
In the PBX Manager navigate to AP Recordings, create two new objects and configure the templates.

===Adding objects using the Recordings Plugin===
[[Image:14r2_AP_Recordings-User.png|thumb|upright=1.0|right|PBX Manager User]]
[[Image:14r2_AP_Recordings-Admin.png|thumb|upright=1.0|right|PBX Manager Admin]]
*First, you'll need to add 2 new objects for the RecordingsApp to work.
**You need to add an object for '''"User"''' and one for '''"Admin"'''.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User, or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
***''Monitored Access'': Select a user (e.g. a supervisor). If a user is selected, this user needs to grant permission to any user who wants to access a recording in his RecordingsUser App.
***''WaterMark'': Select if Watermarking is done or not. If "YES" is selected, watermarking will be done for ALL recordings in the database, not only new recordings.
 
 
 
 
 

===Access list configuration through the Recordings Plugin===
*Access list is a User type of app that allows the access to other user's records. Access list is useful to scale the access rights of the system records.
**Here you need to add another object for the Access List.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
**''Access list'': Enter a number in each field. The number (e164) of the user who will use the application and the number (e164) for the user whose recordings will be accessed.
***''Wildcard for Access list'': An * can be entered instead of the number (e164). This gives you a user app with access to all recordings but not to the admin settings
'''<pre>Hint: Do not forget to give the access rights of the app to the users via the template configuration</pre>'''

== Configuring Templates ==
*You need to grant permissions and licenses for the app to work. You can use templates for this.
**Select the user template and grant the app permission and license.
**Select the admin template and grant the admin-app permission and also the license.
**Now users with either template can use the appropriate apps.

== Configuring the Recordings-App ==
[[Image:RecordingsAdmin-Config.png|thumb|upright=5.0|right|App Configuration]]
The only change that needs to be done here is configuring the PBX name inside the Admin-App, otherwise it won't correctly record the calls.
*Follow the steps inside the '''RecordingsAdmin''' - app
**After opening the app, you can open a sidebar-menu with the upper right menu button.
**Below you see the needed setting called '''"PBX name"'''. Here, you enter the name of the PBX.
 

== Configuring WebDav credentials in RecordingsAdmin ==
Starting from 14r1, WebDav credentials can be configured in RecordingsAdmin. With this credentials it is possible to get Access to the original .pcap Files.
In RecordingsAdmin, user and password can be configured.
'''Please note that all Devices which should be recorded, will need to authenticate if this is configured.'''

For Softphones, fill out the appropriate fields at ''Advanced-UI --> PBX --> Config --> myApps --> Recording Username / Recording Password''.

In order to not display the user and password to the end-user, you can hide the Record-to-URL by activating the hide setting at:
''Advanced-UI --> PBX --> Config --> myApps --> Recording URL in softphone app hidden''

For Hardphones and Gateways, you can also add the user and password to the URL or go to ''Advanced-UI --> Services --> HTTP --> Client'' and configure the Record-to-URL as Authenticated URL by using the previously configured user and password.
 
 
 
 
 
 
 
 
 
 
 

== Configuring CDR ==
[[Image:Recordings13r3_Object-Apps.png|thumb|upright=1.0|right|Checkboxes Apps]]
*The CDRs are fetched from the ReportsApp.
**Make sure that there is a correctly configured Reporting-Instance and that the pbx sends the CDRs into this instance.
**For the Recordings-Users, no Reporting-License is necessary.
**The correct Reporting-Instance should be selected in the '''apps''' tab in the Recordings-Object.
 

== Checking the Recordings-User-App object ==
[[Image:Recordings13r3_Object-App.png|thumb|upright=1.0|right|Checkboxes App]]
It could happen that '''Websocket''', '''Admin''' and '''Services''' aren't ticked in '''"Objects"''' , but this is necessary.
*To check this, you need to navigate to '''PBX - Objects'''
**Select the '''Recordings''' object and navigate to the '''App''' tab.
**All three above mentioned checkboxes should be ticked.
 
 
 
 
 
 

== Checking the Reporting-App object ==
You need to make sure, that '''Websocket''' is ticked in the '''App''' tab and that the object is '''connected''', otherwise, Recordings is not able to fetch any data from the App Service "Reports".
 
 
 

== Record-to-URL ==
The Record-to-URL is composed by the following information:
<nowiki>https://<App platform DNS>/<domain>/<instance name>/Files</nowiki>
'''Be aware: The Record-to-URL always has to be used case sensitive!'''

== VoIP-Interface / Softphone / Phone configuration ==
=== Configuring the VoIP-Interface through the Devices-Interface ===
[[Image:Recordings13r3_SIP-Interface.png|thumb|upright=5.0|right|SIP-Trunk]]
If you want all external calls to be recorded, then the SIP-Trunk needs to know the Record-to-URL, you inserted earlier too.
Also, the Media-Relay checkbox needs to be checked.
*Since you also want to record any call that goes through your SIP-trunk, you need to insert the Record-to-URL into the SIP.
**For this, you select the '''Gateway --> SIP''' tab.
***Make sure that the URL is configured correctly and also the Media-Relay is activated.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
=== Configuring the Softphones ===

'''Please note that the recordings-config for softphones is only available, if the softphone user has the correct licence App(innovaphone-recorder) assigned.'''
'''Also, the recordings-config distributed by the PBX will not take effect if the user has no license.'''

For the softphones, the Record-to-URL must be inserted via the SoftphoneApp - Burger Menu. In addition, you can configure whether to record automatically every call or whether to record only external calls.

==== Config distribution via PBX ====
The Record-to-URL can also be configured via the ''Advanced-UI --> PBX --> Config --> myApps''.

=== Configuring the Phones through the DevicesApp ===
[[Image:Recordings14r1_Expert-Config.png|thumb|upright=5.0|right|URL]]
* Go to Devices and select the proper Domain.
* Create within this Domain an additional Provisioning Category with a meaningful name like "Phones with Recording"
* Create within this Domain an additional Device Configuration from type [Phone] with a meaningful name like "Phone configuration for recording" and assign it to the Category "Phones with Recording".
* Add the Recording URL
* Create within this Domain an additional Device Configuration from the type [Expert configuration] with a meaningful name like "Record Transparent" and assign it to the Category "Phones with Recording"
* Add the following Expert Mode commands:

mod cmd PHONE/CONF-UI reg-edit-rec /cmd reg-edit-rec /id 0 /rec.mode transparent /rec.to p /rec.e164 /rec.h323 /op OK
config write
config activate
iresetn

* In the Devices Tab, select the desired IP Phone(s) and add these to the Category "Phones with Recording". Be aware, you can have only one Provisioning Category assigned, so de-assign the excisting one.
* Run the Expert Configuration.
The IP Phone will show shortly the message Software Update 1%.
After the change, check the changed configuration.
 
 
 
 
 
 

=== Configuring the Phones through the Advanced-UI ===
For the phones to actually start recording as soon as they make a call, you need to set up a few things. This is done in the phones Advanced-UI settings, for example by using Devices-App.

==== Setting up the Record-to-URL ====
[[Image:Recordings13r3_Phone-User.png|thumb|upright=5.0|right|URL]]
*To enable call recording, you need to set up the following values:
**At the Advanced-UI, select the '''"Phone"''' tab.
**Down below, you again need to insert a case-sensitive Record-to-URL into the field, which follows the following rule:
***'''https://app-platform/domain/recordings/Files'''
 
 
 
 
 
 
 
 
 
 
 

==== Setting up the Recording-Tab ====
[[Image:Recordings13r3_Phone-Recordings.png|thumb|upright=5.0|right|Recording-Tab]]
*To fully function, the following changes need to be made in the '''Recording-Tab'''
**''Mode:'' Transparent: This means that the call will be recorded instantly.
**''Recorder:'' HTTP Server
 
 
 
 
 
 
 
 

== Related Articles ==
http://wiki.innovaphone.com/index.php?title=Reference15r1:Concept_App_Service_Recordings

[[Category:Howto|{{PAGENAME}}]]

Reference15r1:Concept App Service Recordings

2024-12-12T08:51:42Z

Dmu: /* Functions / Features */

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

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto14r2:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== Download Action log ===
After clicking on "Action log" in RecordingsAdmin, it can be downloaded. This is done in a .zip archive containing a .pdf file with the performed actions for all recordings
* action_play (recording has been played)
* action_download (recording has been downloaded)
* action_delete (recording has been deleted)
* action permanent (recording has been protected against deletion)
* action_volatile (protection against deletion has been deactivated)
* action_timeout (recording has been deleted due to the scheduled deletion config)

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[Reference15r1:Concept_App_Service_Recordings#Scheduled_deletion_of_old_recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Pressing the "note" button again closes the window.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3 or V14r1 to V14r2 Recordings App ==
=== Compatibility ===
A V14r2 Recordings App can not be used in the V13r3 or V14r1 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto14r2:RecordingsApp|HowtoV14r2: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== Separate app instance required per PBX ===
In a setup with several PBXs (master-slave), it is necessary to create a separate Recordings instance for each PBX in the AP Manager.
Currently, only one PBX name can be configured per Recordings instance. This results in a separate RecordingsAdmin and RecordingsUser app for the user for each PBX.

Reference15r1:Concept App Service Recordings

2024-12-12T08:30:41Z

Dmu:

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

== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto14r2:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[Reference15r1:Concept_App_Service_Recordings#Scheduled_deletion_of_old_recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Pressing the "note" button again closes the window.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3 or V14r1 to V14r2 Recordings App ==
=== Compatibility ===
A V14r2 Recordings App can not be used in the V13r3 or V14r1 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto14r2:RecordingsApp|HowtoV14r2: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== Separate app instance required per PBX ===
In a setup with several PBXs (master-slave), it is necessary to create a separate Recordings instance for each PBX in the AP Manager.
Currently, only one PBX name can be configured per Recordings instance. This results in a separate RecordingsAdmin and RecordingsUser app for the user for each PBX.

Reference15r1:Concept App Service Recordings

2024-12-12T08:28:35Z

Dmu: Created page with "Produkteinführung Category:Techserv {{FIXME|reason=This article is still in progress and not finished not yet finished!}} Apps == Description == Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call. The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database. == Requirements == *..."

[[Category:Projekte Techserv|Produkteinführung]]
[[Category:Techserv]]
{{FIXME|reason=This article is still in progress and not finished not yet finished!}}
[[Category:Concept|Apps]]
== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1
* Recordings Apps
* App(innovaphone-recorder) licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* ReportsApp

== Apps ==

=== Recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Search for user specific recordings
* Play, Listen or Download the recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deleting or delete a recording

=== Recordings Admin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Download the activity protocol
* Search for recordings
* Play, Listen or Download a recording as a .zip file which contains the .WAV file and a .PDF with the call information, the activity protocol and the notes
* Protect against deletion or delete a recording
* Filter records by name, by date
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the CryptKey to encrypt the .pcap files in the database
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX Recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX Recordings Admin APP-Object with the PBX Manager Plugin.
* Assign Recordings Admin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign Recordings App to users who will use the Recordings App.
* Start Recordings Admin App, open the menu (upright) and configure
** Delete recordings after (days) (mandatory - default is 30 days)
** PBX name (mandatory)
** CryptKey (optional)
** WebDav user & WebDav password (both optional)
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:on deskphones, softphones or gateway interfaces.
:On innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.
:On innovaphone softphones, recordings config is only visible, if the user has the appropriate app(innovaphone-recorder) license.

=== PBX Manager Plugin ===

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

==== Deletion of recordings ====
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

==== Access List ====
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto14r2:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

== Functions / Features ==
=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. This is done in a .zip archive containing
* the wave audio file
* a .pdf file containing
** the call information
** the activity protocol
** the notes

=== WebDav Access ===
WebDav access allows accessing the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the RecordingsAdmin gui.

In conjunction with the [[Reference15r1:Concept_App_Service_Recordings#Scheduled_deletion_of_old_recordings|scheduled deletion of old recordings]], this can control the size of the application database used.

Note: When webdav access credentials are configured, the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto15r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|the respective documentation]].

=== Encrypted Recordings ===
Recordings can be stored encrypted when in the Recordings Admin App in the settings tab a crypt key is configured. Encryption happens as long as a crypt key is configured, if it is deleted
then the next recordings are stored unencrypted. The crypt key is linked to the recording, so if the user changes this key the previous key must be remembered to access previously stored recordings with that key.

=== 4 Eyes Access ===
This is an access mode where a user can only access the recordings when a "supervisor" is present and gives permission. The supervisor for access permission is configured in the recordings pbxmanager plugin. There, a dropdown list
"Monitor" consisting of all the users on the pbx is given to select the supervisor. If a supervisor is configured the users Recordings App, upon start, contacts the supervisor and asks for permission.

Note: The supervisor must be present during the whole user sessions. If the supervisor closes his Recordings App, all permissions given to the users are revoked

=== Notes ===
To each recording textual notes can be added. Pressing the "Note" button on the recording entry opens a window beneath the entry. Pressing the "note" button again closes the window.

=== Watermark ===
In order to guarantee the validity of a recording a watermark can be added. To enable watermarking it must be selected in the recordings pbxmanager plugin. Recordings that existed in the database prior to enabling the watermarking will also be marked. The validity of a recording can then be checked in the recordings admin app by pressing the "verify" button.

== Information ==
=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

=== Call Information ===
The call information are retrieved from App Service "Reports". It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this method, it is possible to provide detailed call flow information for each recording.

=== Call Recording Storage ===
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

=== Licensing ===
An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

=== Recording on Special Interfaces ===
* Trunk Interface/Gateway
The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.
* Waiting Queue
The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r3 or V14r1 to V14r2 Recordings App ==
=== Compatibility ===
A V14r2 Recordings App can not be used in the V13r3 or V14r1 PBX and App Platform environment.
=== License Changes ===
Licensing is the same as version 14r2
=== Database Conversion ===
Databases from previous versions (13r3,14r1,14r2) will be converted automatically

== Troubleshooting ==
=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:
*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports"
** WebSocket connection from App Object Reports should show ''connected''
**In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto14r2:RecordingsApp|HowtoV14r2: Recordings App configuration]]

== Known Problems ==
=== Destination number is not displayed correctly when overlap dialing is used ===

If overlap dialing is used on the hardwarephone, the destination number is only displayed in the RecordingApp with the first digit dialed instead of the full number. The SoftphoneApp does not dial using overlap dialing, therefore is not affected by this problem.
 
Workaround: Configure an enblock timeout of e.g. 3 seconds in the Phone/User[1-6] -> ''Enblock Dialing Timeout [s]'' at the hardwarephone for the corresponding user.

=== Separate app instance required per PBX ===
In a setup with several PBXs (master-slave), it is necessary to create a separate Recordings instance for each PBX in the AP Manager.
Currently, only one PBX name can be configured per Recordings instance. This results in a separate RecordingsAdmin and RecordingsUser app for the user for each PBX.

2024-07-17T09:49:36Z

Dmu:

This PBX Manager Plugin contains 1 section:
* Add, edit or delete RecordingsApp and RecordingsAdmin on the PBX.

== Add an App ==
; Name
: The name displayed for the App Object.

; SIP
: The sip from the App Object, which must be unique.

; TYPE
: type of the app object, either User or Admin

; Delete Mode
: Select if users on this object should be able to delete a recording directly, move it to the recycle bin or if users are not able to delete recordings

; Reporting
: Name of the reporting object recordings connect to get the call information

; Connect
: If a Connect app is selected, notes on the recorded calls can be stored in the Recordings app. If no Connect app is selected, the notes function is not available.

; Monitored Access
: Select a user (e.g. a supervisor). If a user is selected, this user needs to grant permission to any user who wants to access a recording in his RecordingsUser App.

; WaterMark
: Choose if watermarking is done or not

; Access list
: When configuring a USER recordings object, a table of 30 entries is shown where the users of this recordings object can be given access to other recordings on specific numbers
: besides their own.

2024-05-16T06:01:45Z

Dmu:

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

== Description ==

A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.
Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
Video suffers from the same limitations.
 
A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client.

== Applies To ==
* innovaphone PBX from version 14r1
* Windows, Linux (Ubuntu 22 or 23) or MacOS operating systems
* Citrix or Windows Terminal Server environments (VMWare is not available but it is planed for future versions)

== Requirements ==
* innovaphone PBX
* innovaphone myApps V14r1
* innovaphone myApps Plugin V14r1
* Firmware V14r1 final

== Concept ==

The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:

* start or stop an audio/video device
* gathering of the ICE candidates
* connect to a remote peer with the ICE protocol
* start a ringing device
* rendering of video

But we now need a way of communicating between the myApps running at the terminal server and the myApps plugin running at the terminal client in order to carry out all these actions.

Main VDI Platforms (Citrix, Windows, VMware) provide a way of communicating between server and client through Virtual Channels:

https://support.citrix.com/article/CTX116890/citrix-ica-virtual-channels-overview

https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels

== Configuration ==

'''Citrix Workspace app must first be installed on all platforms. This is necessary because the myApps plugin must copy a .dll (Windows) / .so (MacOS/Linux) into the Citrix installation directory. '''
 

=== Windows ===

The myApps Plugin .msi must be installed or deployed at the Thin-Client and does not require any configuration.

=== MacOS ===

Install the myAppsPlugin.dmg or .pkg at the Thin-Client and does not require any configuration.

=== Linux ===

Update your Linux PC first:

'''sudo apt-get update'''

Download latest Citrix Workspace App (Mar 7, 2024) for Debian and x86_64 platform:

'''https://www.citrix.com/downloads/workspace-app/linux/workspace-app-for-linux-latest.html'''

Citrix Workspace app needs '''libwebkit2gtk-4.0-37''' packet and this packet is not available in Ubuntu-24.04 version.

Install it at your Linux PC:

https://docs.citrix.com/es-es/citrix-workspace-app-for-linux/install.html

'''sudo apt install -f ./icaclient_<version>._amd64.deb'''

Install (or update) now the myApps Plugin:

'''sudo apt install -f ./myAppsPlugin.deb'''

No additional configuration required.

=== Configuration on the Terminalserver ===
The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

User starts the VDI software (Citrix Workspace App or Windows Remotedesktop) needed to connect to a remote server.

This software automatically starts the myApps Plugin. No user action required.

The user starts myApps at the server for the Softphone App. myApps discovers that it is running in terminal server environment and will connect to the plugin which was already started by the VDI software.

The user does not need to have any knowledge about the myApps Plugin.

== Licensing ==

== Known issues ==

* Headsets buttons in Linux.
**Jabra: Check '''udev rules''' in following document: https://developer.jabra.com/site/global/sdk/linux/getting-started.gsp

* Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client (only for the Windows Plugin)

* Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
**Video is displayed but with delay due to the rendering process.
**Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.

* Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client (only for the Windows Plugin)

==Troubleshooting==
If the problem still exists after trying the OS-specific hints below, open a support ticket and send a trace from the myApps client (remote) with App and Browser option. Please send also all myAppsPlugin-x.txt and myAppsRemote-x.txt trace files from the myApps-plugin on the local PC.

=== Troubleshooting Windows ===

If Citrix is used as a terminal server environment:

1) Citrix must be installed '''BEFORE''' the plugin

2) Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll

3) Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there.

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

4) In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

Dump files are in the trace folder c:\users\$user\Appdata\local\innovaphone\myAppsPlugin if client crash at start.

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

Computer\HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Default\AddIns\innovaphoneRemoteServicesSvc64

and check as "Name" the path of the .dll <--- c:\program files(x86)\iinnovaphone\myAppsPlugin\myAppsRemoteServiceSvc64.dll

check that the .dll exist in the mentioned direcotry and the plugin.

=== Troubleshooting Linux ===

'''Citrix Workspace App must be installed before the myAppsPlugin'''

Innovaphone Plugin is installed under /opt/innovaphone/'''myAppsPlugin''' and in /opt/Citrix/ICAClient/'''myAppsCitrixPlugin.so'''

myAppsCitrixPlugin.so library is called by the Citrix Workspace App and this library opens the myAppsPlugin.

There is a file in the Citrix installation called module.ini (/opt/Citrix/ICAClient/config/module.ini). Inside this file the myApps Citrix Plugin library is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with '''myAppsCitrixPlugin=On''' must exist and

Following directory '''/var/log/apps/myAppsPlugin/''' must also exist for the log files

=== Troubleshooting MacOS ===

'''Citrix Workspace App must be installed before the myAppsPlugin'''

In /Library/Application Support/Citrix/PlugIns

must exist myAppsCitrixPlugin.plugin -> /Application/myappsPlugin.app/Contents/PlugIns/myapps_citrix_plugin.plugin

under:

/Users/.../Library/Application Support/Citrix Receiver

there is a file called Modules. Inside this file the myApps Plugin is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

both things are done during the installation. In case something is not working must check that the link to the plugin exists and that the modules file contains these entries.

And under /Users/.../Library/Containers/com.innovaphone.myapps-plugin-14r1/Data/Documentsa log file is created: myAppsPlugin.txt

=== Troubleshooting Citrix ===
A Virtual Channel Policy must be added to the Registry at the '''Citrix Server''':

Create '''VCPolicies''' folder under '''HKLM/Software/Policies/Citrix''' if it does not exist.

Create a REG_MULTI_SZ entry with the name '''VirtualChannelWhiteList'''. This entry must contain as value: '''INNOHDX,C:\Program Files (x86)\innovaphone\myApps\myApps.exe'''

== Related Articles ==

* https://wiki.innovaphone.com/index.php?title=Reference14r2:Concept_myApps
* https://wiki.innovaphone.com/index.php?title=Reference14r2:Concept_App_SoftphoneApp

Reference14r1:MyApps Plugin for Virtual Desktops

2024-05-08T08:30:16Z

Dmu: /* Description */

Reference14r1:MyApps Plugin for Virtual Desktops

2024-05-08T08:29:31Z

Dmu:

[[Category:Concept|Apps]]

== Description ==

A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.

Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
 This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
 Video suffers from the same limitations.

Innovaphone provides a solution for this problem with the RCC-App but there are still some limitations:

- Admin must configure a Softphone and a RCC-App for the user.

- myApps must be installed at the terminal client for the Softphone App which the RCC-App will control and the user must log in at the terminal client too.

- Configuration of the Softphone (Call-Waiting, Video, ...) happens at the terminal client.

- Management of the audio devices takes place at the terminal client.

- RCC-App does not support video. The Softphone App does. If the user wants video, he starts or receives the call with the RCC-App but he must switch to the Softphone App.

- RCC-App does not support appSharing. User could share a local application with the Softphone App or even the local desktop in order to show the remote desktop.

A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client and to offer a solution for the limitations of the RCC-App.

== Applies To ==
* innovaphone PBX from version 14r1
* Windows or MacOS operating systems
* Citrix or Windows Terminal Server environments (VMWare is not available but it is planed for future versions)

== Requirements ==
* innovaphone PBX
* innovaphone myApps V14r1
* innovaphone myApps Plugin V14r1
* Firmware V14r1 final

== Concept ==

The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:

- start or stop an audio/video device

- gathering of the ICE candidates

- connect to a remote peer with the ICE protocol

- start a ringing device

- rendering of video

But we now need a way of communicating between the myApps running at the terminal server and the myApps plugin running at the terminal client in order to carry out all these actions.

Main VDI Platforms (Citrix, Windows, VMware) provide a way of communicating between server and client through Virtual Channels:

https://support.citrix.com/article/CTX116890/citrix-ica-virtual-channels-overview

https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels

== Configuration ==
'''Citrix Workspace app must first be installed on all platforms. This is necessary because the myApps plugin must copy a .dll (Windows) / .so (MacOS) into the Citrix installation directory. '''
 

=== Windows ===

The myApps Plugin .msi must be installed or deployed at the Thin-Client and does not require any configuration.

=== MacOS ===

Install the myAppsPlugin.dmg or .pkg at the Thin-Client and does not require any configuration.

=== Configuration on the Terminalserver ===
The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

User starts the VDI software (Citrix Workspace App or Windows Remotedesktop) needed to connect to a remote server.

This software automatically starts the myApps Plugin. No user action required.

The user starts myApps at the server for the Softphone App. myApps discovers that it is running in terminal server environment and will connect to the plugin which was already started by the VDI software.

The user does not need to have any knowledge about the myApps Plugin.

== Licensing ==

== Known issues ==

- Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client.

- Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
Video is displayed but with delay due to the rendering process.
 Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.

- Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client.

==Troubleshooting==
If the problem still exists after trying the OS-specific hints below, open a support ticket and send a trace from the myApps client (remote) with App,Browser option. Please send also all myAppsPlugin-x.txt and myAppsRemote-x.txt trace files from the myApps-plugin on the local PC.

=== Troubleshooting Windows===

If Citrix is used as a terminal server environment:

1) Citrix must be installed '''BEFORE''' the plugin

2) Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll

3) Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there.

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

4) In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

Dump files are in the trace folder c:\users\$user\Appdata\local\innovaphone\myAppsPlugin if client crash at start.

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

Computer\HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Default\AddIns\innovaphoneRemoteServicesSvc64

and check as "Name" the path of the .dll <--- c:\program files(x86)\iinnovaphone\myAppsPlugin\myAppsRemoteServiceSvc64.dll

check that the .dll exist in the mentioned direcotry and the plugin.

=== Troubleshooting MacOS===

'''Citrix Workspace App must be installed before the myAppsPlugin'''

In /Library/Application Support/Citrix/PlugIns

must exist myAppsCitrixPlugin.plugin -> /Application/myappsPlugin.app/Contents/PlugIns/myapps_citrix_plugin.plugin

under:

/Users/.../Library/Application Support/Citrix Receiver

there is a file called Modules. Inside this file the myApps Plugin is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

both things are done during the installation. In case something is not working must check that the link to the plugin exists and that the modules file contains these entries.

And under /Users/.../Library/Containers/com.innovaphone.myapps-plugin-14r1/Data/Documentsa log file is created: myAppsPlugin.txt

=== Troubleshooting Citrix===

A Virtual Channel Policy must be added to the Registry at the '''Citrix Server''':

- Create '''VCPolicies''' folder under '''HKLM/Software/Policies/Citrix''' if it does not exist.

- Create a REG_MULTI_SZ entry with the name '''VirtualChannelWhiteList'''. This entry must contain als value: '''INNOHDX,C:\Program Files (x86)\innovaphone\myApps\myApps.exe'''

== Related Articles ==

* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_myApps
* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_App_SoftphoneApp

Reference14r1:Concept App Service Recordings

2024-04-25T07:30:17Z

Dmu: /* Licensing */

[[Category:Concept|Apps]]
== Description ==
Recordings is an application running on the App platform which allows capturing the audio streams during a telephone call.
The user's phone can be configured to send bidirectional audio streams to the Recordings App and store them into the database.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform
* Firmware V14r1xx
* Recordings App
* Recordings App licenses (per User)
* Device with PCAP Recording Interface:
** innovaphone deskphones
** innovaphone SoftphoneApp
** innovaphone gateway interfaces
* Reporting App

== Apps ==

=== recordings ===
[[Image: Usrrecord.png]]

User version of the App allow you to:
* Access to the user specific records
* Access to the user specific logs
* Filter records by name, by date
* Play, Listen or Download the recording as a .WAV file
* Protect against deleting or delete a recording

=== recordingsadmin ===
[[Image:Adminrecord.png]]

Admin version of the app allow you to:
* Access to all records
* Access to all logs
* Set up the records auto deletion retention time in days
* Set the PBX name
* Set the WebDAV credentials for the Record-to-URL
* Set specific trace levels
* Filter records by name, by date
* Play, Listen or Download the recording as a .wav file
* Protect against deleting or delete a recording

== PBX Manager Plugin ==

With the Recordings PBX Manager Plugin, an App Object can be created, edited and deleted on the PBX.

== Configuration ==
* Download the Recordings App via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Recordings App on the App Platform Manager.
* Create a new PBX recordings APP-Object with the PBX Manager Plugin.
* Create a new PBX recordingsadmin APP-Object with the PBX Manager Plugin.
* Assign recordingsadmin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
* Assign recordings App to users who will use the Recordings App.
* Start recordingsadmin App and configure the name of the PBX in the settings via upright option
* assign Record to (URL) to recording devices/objects in format
: <code>http://</code>''ap.domain.tld''<code>/</code>''domain.tld''<code>/recordings/Files</code>
:at deskphones or gateway interfaces.
:At innovaphone deskphones, enable recording via Phone/User-X/Recording by setting ''Mode'' to <code>transparent</code> and ''Recorder'' to <code>HTTP Server</code>.

=== Access List ===
Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List, additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between team members or supervisor access to recordings of call agents are possible. 
For the configuration, see : [[Howto14r1:RecordingsApp#Access_list_configuration_through_the_Recordings_Plugin]]

=== Deletion of recordings ===
In the PBX Manager plugin, it can be configured how a deletion of a recording is processed. There are 3 modes selectable: "Recoverable", "Permanent" and "Denied". 
If "Recoverable" is selected, the users attached to this app object will transfer a recording to the recycle bin upon a delete operation, otherwise the recordings will be permanently deleted.
If "Denied" is selected, users are not able to delete a recording.

=== Scheduled deletion of old recordings ===
You can configure a time period between ''1 and 11000 days'' (in maximum round about 30 years), after which recordings are automatically removed. You can enter ''0 days'' here to disable the scheduled deletion.

== Call Information ==
A new method of acquiring the call information is implemented. It requires an installed and running App Service "Reports". "Reports" does not
need own licenses to be run with recordings. With this new method, it is possible to provide detailed call flow information for each recording.

== Call Recording Storage ==
If a 60 second Call with Codec G.711 is recorded, it will take approx. 1.5 MegaByte memory.

== Licensing ==

An appropriate license ''App(innovaphone-recorder)'' must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverable deleted after a 30 day grace period.
If the TTL has been configured in RecordingsAdmin to be less than 30 days, the grace period is also shortened accordingly.

== Recording on Special Interfaces ==

* Trunk Interface/Gateway

The Trunk Interface acts as a substitute for the user's phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call owns the recording and a license for this user is required.

* Waiting Queue

The user answering the call is the owner, a license for this user is required.

== Upgrade from V13r2 or V13r3 to V14r1 Recordings App ==

=== Compatibility ===

A V14r1 Recordings App can not be used in the V13r2 or V13r3 PBX and App Platform environment.

=== License Changes ===

Licensing is the same as version 13r3

=== Database Conversion ===

Databases from previous versions (13r1,13r2,13r3) will be converted automatically

=== Removing CDR slot on PBX ===

The CDR slot that was used by previous installations of recordings can be freed.

=== Update App Object configuration ===

If upgrading from a previous version, the app object configuration in the PBX Manager must be invoked.
Each app object configuration must be selected and "Ok"-ed for the new interoperation with App Service
"Reports" to be set up. In detail these are: the websocket connection, the "reporting" app usage and the
usage of the "Admin" and "Services" API.

=== Download recording ===

Once a recording is converted to .wav format, it can be downloaded. In version 14r1, this is done in a zip archive containing the wave audio file and a .csv file containing
the call information.

== WebDav Access ==
WebDav access allows to access the recordings database to download recordings in the original stored mode (pcap format). Clients such as WinSCP can be used for this purpose. In order to enable WebDav access credentials
(username, password) must be configured in the recordings admin gui.

Note: When webdav access credentials are configured the recording itself must be configured to use these credentials as well.
For information on how to configure authentication for the recording clients, see [[Howto14r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin]]

== Troubleshooting ==

=== Recordings App Service ===
The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. These settings are available via an additional Menu in the upper right corner of the Recordings Admin UI:

*Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
*Call Information - traces related to the CDR information
*Conversion - traces for conversion process from VoIP codecs to WAV
*License - traces for on licensing issues
*GUI - traces related to the user interface of the Recordings App
*Connections - traces related to connections between RecordingsApp and PBX

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message ''PBX Name missing'' will be displayed.

=== PBX Configuration ===
*WebSocket connection from App Object to the Recordings App should show ''connected''
*A correct configuration of the CDR interface is required for transmission of metadata to the App Service "Reports".
*In case the connection between recordings and App Service "Reports" is not successful, a red "broken link" and the message "Still initializing" is shown on top of the RecordingsAdmin and an entry in the event log will be added.

=== PCAP Recording Interfaces ===
*Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
*A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. <code>HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT <nowiki>http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap</nowiki></code>)

== Related Articles ==
[[Howto14r1:RecordingsApp|HowtoV14r1: Recordings App configuration]]

== Known Problems ==

Reference13r3:Concept App SoftphoneApp

2024-02-29T07:50:28Z

Dmu: /* General features (not call-related) */

[[Category:Concept|Apps]]
[[Category:Concept_App_SoftphoneApp]]

== Applies To ==

* innovaphone PBX from version 13r3
* myApps clients version 13r3

== Requirements ==

* innovaphone PBX
* myApps native client (Windows, MacOS, iOS or Android) or a Browser (Chrome, Firefox, ...)
* App(phone) and App(softphone) license per user.
* Port license per user having a registered softphone

== Compatibility ==

* Softphone App running in a myApps 13r3 native client is not compatible with a 13r2/13r1 PBX.

== Concept ==

=== Configuration ===

The Softphone App is directly loaded from the PBX either in a native client or in a brower.

For configuring the softphone app at a user object
# enable the app "softphone".
# activate the App(softphone) and App(phone) licenses.
# create a device for registration and configure "softphone" as the device app.

Additionally users can add a softphone and the corresponding device themselves using the Profile App, as long as (1.) and (2.) are already configured by the admin.

=== Standard App, Wake and Push mechanism ===

myApps client allows to define a default app for telephony.

If the Softphone App is defined as the default app, the PBX will wake the softphone if the user receives a call and the softphone is not running.

=== Technical Overview ===

==== Native client ====

If the softphone App is loaded in a native client, a signaling module establishes the registration to the PBX and handles signaling messages for the calls.

That means a running Web UI is not needed to establish a connection to the PBX and to start and receive calls. Main advantages of this solution are:
* Calls are signaled to the user even if the UI is not opened (important in mobile environment to present the call faster to the user)
* Calls are not terminated if the UI is closed

A first start of myApps triggers an automatic launch of the Softphone App (defined as Standard App) in order to get PBX url, app, hardware id and credentials for connecting to the PBX.

This information is stored locally in the operating system and is only accessible by the user (e.g. Windows Registry).

Following starts of myApps do not require to launch the Softphone since the signaling module is able to connect to the PBX with the stored information.

If the Softphone App is removed as standard app this data is deleted from the operating system. Therefore anytime a new Softphone App is defined as standard app it will be started automatically in order to get the information.

Once myApps is started the signaling module automatically opens a websocket connection to the PBX and registers to it. At this point the signaling module is able to receive calls (as mentioned before this is really important with mobile devices)

While the UI is still not running a native notification will be presented to the user in order to accept or reject the call. In the meantime the Softphone UI will be started since it is defined as standard app but the good point is that the user does not have to wait until the Softphone UI is fully loaded like it happened in 13r1 or 13r2 versions.

If the call is accepted before the Softphone UI runs it will only have audio. Video will be added later if the "Autostart video" setting is on.

When the Softphone UI is started it opens a websocket connection to the new signaling module in order to monitor the calls and to send user commands (terminate call, appSharing, view mode, mute, add/remove video, ...) to the module.

If the softphone interface is closed during a call, the calls are switched to audio and a new notification is displayed to be able to disconnect the call.

==== Browser ====

If the Softphone App is loaded in a browser, it uses the WebRTC technology.

The registration to the PBX and signaling is done in Javascript and therefore the Softphone UI needs to run in order to make and receive calls.

This solution does not offer some features which are provided by the native services.

== Features ==

Some functionalities are available even if the Softphone UI is not running and there are also differences between native clients and browsers

=== Softphone UI not running ===

{|
! style="text-align: left; font-weight: bold" | Feature

! style="text-align: left; font-weight: bold"| Availability
|-

| || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>

|-
| Audio calls only || ✔ || ✔ || ✔ || ✔ || ✗
|-
| Accept/reject incoming calls (using OS notification) || ✔ || ✔ || ✔ || ✔ || ✗
|-
| Disconnect calls (using OS notification) || ✔ || ✔ || ✔ || ✔ || ✗
|-
| Possibility to record calls [https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_myApps_platform_services#Recording Recording] || ✔ || ✔ || ✔ || ✔ || ✗

|}

Use cases:
* Smartphones: On the smartphones incoming calls (via Push) can be accepted, while the UI is still loading.
* Windows: Call is not disconnected when closing Softphone App inside myApps.

=== Additional features with Softphone UI ===

==== In-call feature ====

{|
! style="text-align: left; font-weight: bold" | Feature

! style="text-align: left; font-weight: bold"| Availability
|-

| || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>

|-
| Media: Multi-Video, application sharing, non-persistent chat
|| ✔ || ✔ || ✔ || ✔ || ✔
|-
| Call control: Hold, transfer, park, DTMF || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Local 3-party-conference || ✔ || ✔ || ✔ || ✔ || ✗
|-
| Additional conference control: Request to speak, list of participants || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Display recording state. Start / stop recording? || ✔ || ✔ || ✔ || ✔ || ✗
|-
| Call completion || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Hide own number, send number || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Start external application for call (automatic or manual) [https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_myApps_platform_services#Call_an_external_application_for_calls External Applications] || ✔ || ✗ || ✗ || ✔ || ✗
|-
| Detach video || ✔ || ✗ || ✗ || ✔ || ✗
|-
| Acoustic "Blubb" when joining a conference || ✔ || ✔ || ✔ || ✔ || ✔
|}

==== General features (not call-related) ====

{|
! style="text-align: left; font-weight: bold" | Feature
! style="text-align: left; font-weight: bold"| Availability
|-
| || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>
|-
| Favorites (profile picture, dialog monitoring, start call, start chat, pickup, transfer)
|| ✔ || ✔ || ✔ || ✔ || ✔
|-
| Call history (profile picture, start call, start chat, transfer) || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Search (profile picture, contact details, start call, start chat, transfer) || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Call forwardings (display and configuration) || ✔ || ✔ || ✔ || ✔ || ✔
|-
| Call waiting || ✔ || ✔ || ✔ || ✔ || ✔
|-
| New ringtones added in 13r3 || ✔ || ✔ || ✔ || ✔ || ✗
|}

=== Other features ===

Additionally Android Auto is now supported and we also did a general rework of the Softphone UI:
* Multi-video support in conferences (similar to Conference Web Access)
* Improved usability

== Known problems ==

== Related Articles ==

* [[Reference13r3:Concept_myApps_platform_services]]
* [[Reference13r3:Concept_myApps]]
* [[Reference13r3:Concept_Multi-Video-Conference]]
* [[Reference13r3:Concept_Softphone_Redundancy]]

File:Recordings14r1 Expert-Config.png

2024-02-19T08:36:53Z

Dmu: Dmu uploaded a new version of File:Recordings14r1 Expert-Config.png

Howto14r1:RecordingsApp

2024-02-19T07:45:34Z

Dmu:

= Applies To =
This information applies to
* RecordingsApp V14r1

= More information =
This article describes how to set up the RecordingsApp.

= System Requirements =
* innovaphone PBX
* innovaphone AppPlatform
* RecordingsApp
* ReportingsApp
* App(innovaphone-recorder) licenses per User

= Configuration =
== Setting up the Instance in the AP Manager ==

In order for the app to work, it must be downloaded. An instance must then be created and launched with the correct information, otherwise it won't work.

* In this step, you'll set up the instance of the RecordingsApp.
** To do this, you will need to download the app in the AP Manager plugin.
** Once you have installed the latest version, you will need to add a new instance.
** You need to fill in all the important information in the newly opened window.

== Configuration in the PBX Manager Plugin ==
In this step, it is mandatory to add two new objects to the PBX and grant the necessary licenses and permission to the templates to use the application.
In the PBX Manager navigate to AP Recordings, create two new objects and configure the templates.

===Adding objects using the Recordings Plugin===
[[Image:14r1_AP_Recordings-User.png|thumb|upright=1.0|right|PBX Manager User]]
[[Image:14r1_AP_Recordings-Admin.png|thumb|upright=1.0|right|PBX Manager Admin]]
*First, you'll need to add 2 new objects for the RecordingsApp to work.
**You need to add an object for '''"User"''' and one for '''"Admin"'''.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User, or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
 
 
 
 
 

===Access list configuration through the Recordings Plugin===
*Access list is a User type of app that allows the access to other user's records. Access list is useful to scale th access rights of the system records.
**Here you need to add another object for the Access List.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User, or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
**''Access list'': Enter a number in each field. The number (e164) of the user who will use the application and the number (e164) for the user whose recordings will be accessed.
'''<pre>Hint: Do not forget to give the access rights of the app to the users via the template configuration</pre>'''

== Configuring Templates ==
*You need to grant permissions and licenses for the app to work. You can use templates for this.
**Select the user template and grant the app permission and license.
**Select the admin template and grant the admin-app permission and also the license.
**Now users with either template can use the appropriate apps.

== Configuring the Recordings-App ==
[[Image:RecordingsAdmin-Config.png|thumb|upright=5.0|right|App Configuration]]
The only change that needs to be done here is configuring the PBX name inside the Admin-App, otherwise it won't correctly record the calls.
*Follow the steps inside the '''RecordingsAdmin''' - app
**After opening the app, you can open a sidebar-menu with the upper right menu button.
**Below you see the needed setting called '''"PBX name"'''. Here, you enter the name of the PBX.
 

== Configuring WebDav credentials in RecordingsAdmin ==
With 14r1, WebDav credentials can be configured in RecordingsAdmin. With this credentials it is possible to get Access to the original .pcap Files.
In RecordingsAdmin, user and password can be configured.
'''Please note that all Devices which should be recorded, will need to authenticate if this is configured.'''

For Softphones, fill out the appropriate fields at ''Advanced-UI --> PBX --> Config --> myApps --> Recording Username / Recording Password''.

In order to not display the user and password to the end-user, you can hide the Record-to-URL by activating the hide setting at:
''Advanced-UI --> PBX --> Config --> myApps --> Recording URL in softphone app hidden''

For Hardphones and Gateways, you can also add the user and password to the URL or go to ''Advanced-UI --> Services --> HTTP --> Client'' and configure the Record-to-URL as Authenticated URL by using the previously configured user and password.
 
 
 
 
 
 
 
 
 
 
 

== Configuring CDR ==
[[Image:Recordings13r3_Object-Apps.png|thumb|upright=1.0|right|Checkboxes Apps]]
*The CDRs are fetched from the ReportingsApp.
**Make sure that there is a correctly configured Reportings-Instance and that the pbx sends the CDRs into this instance.
**For the Recordings-Users, no Reportings-License is necessary.
**The correct Reportings-Instance should be selected in the '''apps''' tab in the Recordings-Object.
 

== Checking the Recordings-User-App object ==
[[Image:Recordings13r3_Object-App.png|thumb|upright=1.0|right|Checkboxes App]]
It could happen that '''Websocket''', '''Admin''' and '''Services''' aren't ticked in '''"Objects"''' , but this is necessary.
*To check this, you need to navigate to '''PBX - Objects'''
**Select the '''Recordings''' object and navigate to the '''App''' tab.
**All three above mentioned checkboxes should be ticked.
 
 
 
 
 
 

== Checking the Reporting-App object ==
You need to make sure, that '''Websocket''' is ticked in the '''App''' tab and that the object is '''connected''', otherwise, Recordings is not able to fetch any data from the App Service "Reports".
 
 
 

== Record-to-URL ==
The Record-to-URL is composed by the following information:
<nowiki>https://<App platform DNS>/<domain>/<instance name>/Files</nowiki>
'''Be aware: The Record-to-URL always has to be used case sensetive!'''

== VoIP-Interface / Softphone / Phone configuration ==
=== Configuring the VoIP-Interface through the Devices-Interface ===
[[Image:Recordings13r3_SIP-Interface.png|thumb|upright=5.0|right|SIP-Trunk]]
If you want all external calls to be recorded, then the SIP-Trunk needs to know the Record-to-URL, you inserted earlier too.
Also, the Media-Relay checkbox needs to be checked.
*Since you also want to record any call that goes through your SIP-trunk, you need to insert the Record-to-URL into the SIP.
**For this, you select the '''Gateway --> SIP''' tab.
***Make sure that the URL is configured correctly and also the Media-Relay is activated.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
=== Configuring the Softphones ===

'''Please note that the recordings-config for softphones is only available, if the softphone user has the correct licence App(innovaphone-recorder) assigned.'''
'''Also, the recordings-config distributed by the PBX will not take effect if the user has no license.'''

For the softphones, the Record-to-URL must be inserted via the SoftphoneApp - Burger Menu. In addition, you can configure whether to record automatically every call or whether to record only external calls.

==== Config distribution via PBX ====
The Record-to-URL can also be configured via the ''Advanced-UI --> PBX --> Config --> myApps''.

=== Configuring the Phones through the DevicesApp ===
[[Image:Recordings14r1_Expert-Config.png|thumb|upright=5.0|right|URL]]
* Go to Devices and select the proper Domain.
* Create within this Domain an additional Provisioning Category with a meaningful name like "Phones with Recording"
* Create within this Domain an additional Device Configuration from type [Phone] with a meaningful name like "Phone configuration for recording" and assign it to the Category "Phones with Recording".
* Add the Recording URL
* Create within this Domain an additional Device Configuration from the type [Expert configuration] with a meaningful name like "Record Transparant" and assign it to the Category "Phones with Recording"
* Add the following Expert Mode commands:

mod cmd PHONE/CONF-UI reg-edit-rec /cmd reg-edit-rec /id 0 /rec.mode transparent /rec.to p /rec.e164 /rec.h323 /op OK
config write
config activate
iresetn

* In the Devices Tab, select the desired IP Phone(s) and add these to the Category "Phones with Recording". Be aware, you can have only one Provisioning Category assigned, so de-assign the excisting one.
* Run the Expert Configuration.
The IP Phone will show shortly the message Software Update 1%.
After the change, check the changed configuration.
 
 
 
 
 
 

=== Configuring the Phones through the Advanced-UI ===
For the phones to actually start recording as soon as they make a call, you need to set up a few things. This is done in the phones Advanced-UI settings, for example by using Devices-App.

==== Setting up the Record-to-URL ====
[[Image:Recordings13r3_Phone-User.png|thumb|upright=5.0|right|URL]]
*To enable call recording, you need to set up the following values:
**At the Advanced-UI, select the '''"Phone"''' tab.
**Down below, you again need to insert a case-sensitive Record-to-URL into the field, which follows the following rule:
***'''https://app-platform/domain/recordings/Files'''
 
 
 
 
 
 
 
 
 
 
 

==== Setting up the Recording-Tab ====
[[Image:Recordings13r3_Phone-Recordings.png|thumb|upright=5.0|right|Recording-Tab]]
*To fully function, the following changes need to be made in the '''Recording-Tab'''
**''Mode:'' Transparent: This means that the call will be recorded instantly.
**''Recorder:'' HTTP Server
 
 
 
 
 
 
 
 

== Related Articles ==
http://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_App_Service_Recordings

[[Category:Howto|{{PAGENAME}}]]

File:Recordings14r1 Expert-Config.png

2024-02-19T07:44:21Z

Dmu:

Howto14r1:RecordingsApp

2024-02-19T07:43:57Z

Dmu: /* Configuring the Phones through the DevicesApp */

= Applies To =
This information applies to
* RecordingsApp V14r1

= More information =
This article describes how to set up the RecordingsApp.

= System Requirements =
* innovaphone PBX
* innovaphone AppPlatform
* RecordingsApp
* ReportingsApp
* App(innovaphone-recorder) licenses per User

= Configuration =
== Setting up the Instance in the AP Manager ==

In order for the app to work, it must be downloaded. An instance must then be created and launched with the correct information, otherwise it won't work.

* In this step, you'll set up the instance of the RecordingsApp.
** To do this, you will need to download the app in the AP Manager plugin.
** Once you have installed the latest version, you will need to add a new instance.
** You need to fill in all the important information in the newly opened window.

== Configuration in the PBX Manager Plugin ==
In this step, it is mandatory to add two new objects to the PBX and grant the necessary licenses and permission to the templates to use the application.
In the PBX Manager navigate to AP Recordings, create two new objects and configure the templates.

===Adding objects using the Recordings Plugin===
[[Image:14r1_AP_Recordings-User.png|thumb|upright=1.0|right|PBX Manager User]]
[[Image:14r1_AP_Recordings-Admin.png|thumb|upright=1.0|right|PBX Manager Admin]]
*First, you'll need to add 2 new objects for the RecordingsApp to work.
**You need to add an object for '''"User"''' and one for '''"Admin"'''.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User, or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
 
 
 
 
 

===Access list configuration through the Recordings Plugin===
*Access list is a User type of app that allows the access to other user's records. Access list is useful to scale th access rights of the system records.
**Here you need to add another object for the Access List.
**You have five fields to fill in.
***''Name'': This is the name of the application.
***''SIP'': This is the SIP entry for the object.
***''TYPE'': Here you can choose what type this object will be. (User, or admin)
***''Delete mode'': Here you can choose if you want to have a recycle bin or not, or if you want to deny users from being able to delete recordings.
***''Reporting'': Here you have to select the reporting instance that provides the call information.
**''Access list'': Enter a number in each field. The number (e164) of the user who will use the application and the number (e164) for the user whose recordings will be accessed.
'''<pre>Hint: Do not forget to give the access rights of the app to the users via the template configuration</pre>'''

== Configuring Templates ==
*You need to grant permissions and licenses for the app to work. You can use templates for this.
**Select the user template and grant the app permission and license.
**Select the admin template and grant the admin-app permission and also the license.
**Now users with either template can use the appropriate apps.

== Configuring the Recordings-App ==
[[Image:RecordingsAdmin-Config.png|thumb|upright=5.0|right|App Configuration]]
The only change that needs to be done here is configuring the PBX name inside the Admin-App, otherwise it won't correctly record the calls.
*Follow the steps inside the '''RecordingsAdmin''' - app
**After opening the app, you can open a sidebar-menu with the upper right menu button.
**Below you see the needed setting called '''"PBX name"'''. Here, you enter the name of the PBX.
 

== Configuring WebDav credentials in RecordingsAdmin ==
With 14r1, WebDav credentials can be configured in RecordingsAdmin. With this credentials it is possible to get Access to the original .pcap Files.
In RecordingsAdmin, user and password can be configured.
'''Please note that all Devices which should be recorded, will need to authenticate if this is configured.'''

For Softphones, fill out the appropriate fields at ''Advanced-UI --> PBX --> Config --> myApps --> Recording Username / Recording Password''.

In order to not display the user and password to the end-user, you can hide the Record-to-URL by activating the hide setting at:
''Advanced-UI --> PBX --> Config --> myApps --> Recording URL in softphone app hidden''

For Hardphones and Gateways, you can also add the user and password to the URL or go to ''Advanced-UI --> Services --> HTTP --> Client'' and configure the Record-to-URL as Authenticated URL by using the previously configured user and password.
 
 
 
 
 
 
 
 
 
 
 

== Configuring CDR ==
[[Image:Recordings13r3_Object-Apps.png|thumb|upright=1.0|right|Checkboxes Apps]]
*The CDRs are fetched from the ReportingsApp.
**Make sure that there is a correctly configured Reportings-Instance and that the pbx sends the CDRs into this instance.
**For the Recordings-Users, no Reportings-License is necessary.
**The correct Reportings-Instance should be selected in the '''apps''' tab in the Recordings-Object.
 

== Checking the Recordings-User-App object ==
[[Image:Recordings13r3_Object-App.png|thumb|upright=1.0|right|Checkboxes App]]
It could happen that '''Websocket''', '''Admin''' and '''Services''' aren't ticked in '''"Objects"''' , but this is necessary.
*To check this, you need to navigate to '''PBX - Objects'''
**Select the '''Recordings''' object and navigate to the '''App''' tab.
**All three above mentioned checkboxes should be ticked.
 
 
 
 
 
 

== Checking the Reporting-App object ==
You need to make sure, that '''Websocket''' is ticked in the '''App''' tab and that the object is '''connected''', otherwise, Recordings is not able to fetch any data from the App Service "Reports".
 
 
 

== Record-to-URL ==
The Record-to-URL is composed by the following information:
<nowiki>https://<App platform DNS>/<domain>/<instance name>/Files</nowiki>
'''Be aware: The Record-to-URL always has to be used case sensetive!'''

== VoIP-Interface / Softphone / Phone configuration ==
=== Configuring the VoIP-Interface through the Devices-Interface ===
[[Image:Recordings13r3_SIP-Interface.png|thumb|upright=5.0|right|SIP-Trunk]]
If you want all external calls to be recorded, then the SIP-Trunk needs to know the Record-to-URL, you inserted earlier too.
Also, the Media-Relay checkbox needs to be checked.
*Since you also want to record any call that goes through your SIP-trunk, you need to insert the Record-to-URL into the SIP.
**For this, you select the '''Gateway --> SIP''' tab.
***Make sure that the URL is configured correctly and also the Media-Relay is activated.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
=== Configuring the Softphones ===

'''Please note that the recordings-config for softphones is only available, if the softphone user has the correct licence App(innovaphone-recorder) assigned.'''
'''Also, the recordings-config distributed by the PBX will not take effect if the user has no license.'''

For the softphones, the Record-to-URL must be inserted via the SoftphoneApp - Burger Menu. In addition, you can configure whether to record automatically every call or whether to record only external calls.

==== Config distribution via PBX ====
The Record-to-URL can also be configured via the ''Advanced-UI --> PBX --> Config --> myApps''.

=== Configuring the Phones through the DevicesApp ===
[[Image:Recordings14r1_Expert-Config.png|thumb|upright=5.0|right|URL]]
* Go to Devices and select the proper Domain.
* Create within this Domain an additional Provisioning Category with a meaningful name like "Phones with Recording"
* Create within this Domain an additional Device Configuration from type [Phone] with a meaningful name like "Phone configuration for recording" and assign it to the Category "Phones with Recording".
* Add the Recording URL
* Create within this Domain an additional Device Configuration from the type [Expert configuration] with a meaningful name like "Record Transparant" and assign it to the Category "Phones with Recording"
* Add the following Expert Mode commands:

mod cmd PHONE/CONF-UI reg-edit-rec /cmd reg-edit-rec /id 0 /rec.mode transparent /rec.to p /rec.e164 /rec.h323 /op OK
config write
config activate
iresetn

* In the Devices Tab, select the desired IP Phone(s) and add these to the Category "Phones with Recording". Be aware, you can have only one Provisioning Category assigned, so de-assign the excisting one.
* Run the Expert Configuration.
The IP Phone will show shortly the message Software Update 1%.
After the change, check the changed configuration.

=== Configuring the Phones through the Advanced-UI ===
For the phones to actually start recording as soon as they make a call, you need to set up a few things. This is done in the phones Advanced-UI settings, for example by using Devices-App.

==== Setting up the Record-to-URL ====
[[Image:Recordings13r3_Phone-User.png|thumb|upright=5.0|right|URL]]
*To enable call recording, you need to set up the following values:
**At the Advanced-UI, select the '''"Phone"''' tab.
**Down below, you again need to insert a case-sensitive Record-to-URL into the field, which follows the following rule:
***'''https://app-platform/domain/recordings/Files'''
 
 
 
 
 
 
 
 
 
 
 

==== Setting up the Recording-Tab ====
[[Image:Recordings13r3_Phone-Recordings.png|thumb|upright=5.0|right|Recording-Tab]]
*To fully function, the following changes need to be made in the '''Recording-Tab'''
**''Mode:'' Transparent: This means that the call will be recorded instantly.
**''Recorder:'' HTTP Server
 
 
 
 
 
 
 
 

== Related Articles ==
http://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_App_Service_Recordings

[[Category:Howto|{{PAGENAME}}]]