innovaphone wiki - User contributions [en]

Reference16r1:Concept App Service IP

2026-04-28T12:31:22Z

Nfi:

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password must be set to "pwd" for Install and will be changed during the process.

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: http://app.domain.com/domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://app.domain.com/domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==
The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==
The installation process must be performed using a DNS name rather than an IP address. 
The URL must include the parameter ''?apdns="DNS from App Platform"'' in the path, for example: http://app.domain.com/domain.com/ip/install.htm?apdns=pbx.domain.com 
Starting with version 16r1 sr1, installation using an IP address is supported. 

However, it is generally recommended to use DNS for the installation.

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]

Reference16r1:Concept App Service IP

2026-04-28T11:53:42Z

Nfi:

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password must be set to "pwd" for Install and will be changed during the process.

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: http://dns/domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://dns/domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==
The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==
The installation process must be performed using a DNS name rather than an IP address. Starting with version 16r1 sr1, installation using an IP address is also supported. 
However, it is generally recommended to use DNS for the installation.

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]

Reference16r1:Concept innovaphone App Platform Container

2026-04-16T14:29:45Z

Nfi: /* Related Articles */

The innovaphone App Platform Container provides a myApps App Platform instance that includes the AP Manager, Webserver and PostgreSQL. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Applies To ==

* innovaphone App Platform Container

==Requirements==
* Host with docker on a x86_64 (amd64) platform
* innovaphone App Platform Container

==Concept==

The innovaphone App Platform Container provides the innovaphone App Platform for container environments (Open Container Initiative (OCI) format).

* The App Platform Manager and Webserver Apps are already integrated in the container and provide the already known functionality.
* Apps are installed, updated and managed as usual.
* The mount point will be used for the database, the App binaries and log files.

==Image Information==

This chapter provides details about the Docker image used for the innovaphone App Platform.

===Repository Details===

;Repository Host : registry.innovaphone.com
;Image Name : cloud/kubernetes/innovaphone-platform-instance

registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

===Tagging and Versioning===
The image is usually tagged with the build number according to innovaphone software releases:

;Latest Tag : Use the latest tag for pulling the most recent service release.

;Release Build Number : For production or version-specific deployments, use a specific build number as the tag (e.g., 130006).

Example:
docker pull registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

===Supported Architecture===
This Docker image supports the <code>linux/amd64</code> architecture.

===Image Reference===
An example of a full image reference using a specific release build number would be:
registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

==Ports==
This chapter outlines the various ports exposed by the container. The webserver ports are available immediately upon container startup, after start of the AP Manager and the Webserver, while the additional application ports become active after the app installation. In most cases, a one-to-one mapping is used, meaning the container port is mapped directly to the same host port unless otherwise specified.

===Ports < 1024===
On most docker hosts, a container won't be able to use ports below 1024, unless the container is started with higher privileges.
This shouldn't be neccessary anyways as all ports can be configured to higher ports.

===Webserver Ports===
;HTTP:
Container Port: 8080
Description: Used for accessing the built-in webserver immediately upon container startup.

;HTTPS:
Container Port: 8082
Description: Used for accessing the built-in webserver immediately upon container startup.

=== Additional Application Ports===
Following additional container ports are avilable depending on installed and configured applications:
;H323/TLS : 1300
;SIP : 5060
;SIPS : 5061
;LDAPS : 1636
;SMTP : 8025
;SMTPS : 8587
;STUN/TURN : 3478 UDP/TCP
'''Additional hint for Portmapping'''<syntaxhighlight lang="yaml" line="1">
docker run -d \
--name=innovaphone \
--restart unless-stopped \
-p 9090:8080 \ #Container Host Port (external) 9090:8080 Container Port
-p 9091:8082 \
-p 5060:5060 \
-p 5061:5061 \
-p 1300:1300 \
-p 1636:1636 \
-p 8025:8025 \
-p 8587:8587 \
-p 3478:3478 \
-p 3478:3478/udp \
-v /path/of/data/innovaphone:/mnt/data \ #in this path you will find Apps, DBs & Logs
#this path musst be used for backups!!
-e WEBSERVERPORTHTTP=8080 \
-e WEBSERVERPORTHTTPS=8082 \
-e LOG_FLAGS=7 \
-e LOG_SIZE=1048576 \
-e DNSIPV4=8.8.8.8 \
-e LIMIT_RAM=512 \ #Ram limit in MB
-e LIMIT_DISK=10 \ #disk size in GB
-e TZ=Europe/Berlin \
registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

</syntaxhighlight>

==Environment Variables (ENVs)==
This chapter outlines the key environment variables used to configure the behavior of the innovaphone App Platform Container. These variables allow you to customize logging, port settings, resource limits, and more during startup and runtime.

;LOG_FLAGS : Defines the integer representation for the trace flags of the AP Manager, according flags activated under the AP Manager / Diagnostics. See browser console message on Save button press (e.g. "logFlags":1 , if the "App" flag is activated).
LOG_FLAGS=7
;LOG_SIZE : Specifies the maximum size in bytes for logs before rotation or management actions occur. Default: 5242880.
LOG_SIZE=1048576
;WEBSERVERPORTHTTP : Sets the in-container HTTP port for the webserver. Default: 8080.
WEBSERVERPORTHTTP=8080
;WEBSERVERPORTHTTPS : Sets the in-container HTTPS port for the webserver. Default: 8082.
WEBSERVERPORTHTTPS=8443
;DNSIPV4 : Specifies the in-container DNS server IPv4 address for DNS resolution. Overrides the default container runtime DNS server.
DNSIPV4=8.8.8.8
;DNS_DOMAIN : The FQDN of the App Platform that can be used to access the app services. This optional parameter is used as a static DNS entry added to /etc/hosts. The destination IP address is the resolved IP address behind INTERNAL_DNS_DOMAIN or NAMESPACE.
DNS_DOMAIN=ap.example.com
;INTERNAL_DNS_DOMAIN : The internal FQDN of the App Platform. This FQDN is used to resolve the internal IP address of the App Platform, to be mapped from DNS_DOMAIN in /etc/hosts.
INTERNAL_DNS_DOMAIN=my-apps-deployment.my-namespace.svc.cluster.local
;NAMESPACE : The Kubernetes namespace used to build internal FQDN of the App Platform. Used with DNS_DOMAIN to map it to the IP address of ap.my-namespace.svc.cluster.local.
NAMESPACE=my-namespace
;LIMIT_RAM : Sets the RAM limit for the container, in MB, controlling how much memory it may consume. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_RAM=512
;LIMIT_DISK : Defines the disk space limit in GB for the container to manage storage consumption. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_DISK=10

==File limits==
Containers may have a default file limit per process, e.g. 1024 files. Depending on your installation and usage, this value is too small and you need to allow more, e.g. handing this in the docker run command:
--ulimit nofile=500000:500000

==Volumes and Mounts==
This container uses a dedicated internal mount path for the persistent data management across container restarts and updates.

===Internal Data Volume===
;Mount Path : <code>/mnt/data</code>
;Contents:
*Apps: Installed application binaries.
*Databases: PostgreSQL files.
*Logging: Log files for system and application events.

===Mounting===
To ensure that your data is preserved, map a host directory or Docker named volume to the container's /mnt/data path when running the container.
For example:
docker run -d -v /path/on/host:/mnt/data registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

This setup guarantees that your apps, associated data, databases, and logs persist independently of the container lifecycle.

==Entrypoint==
The container uses a fixed entrypoint:
ENTRYPOINT ["/entrypoint.sh"]

This script prepares the container and starts the AP Manager executable.

==Logging and Monitoring==
The log of the entrypoint.sh and of the AP manager is avilable as conatiner output. The installed applications store the ir log files under <code>/mnt/data/var/log/apps/</code>.

=== Unexpected high system load ===
If you encounter a high load, you need to verify whether the load is actually coming from your container. Docker containers always display the load of the physical host system.

It may be that the Docker host itself is also virtualized as an LXC container, and your Docker instances are running within it. In such a setup, the system load of the physical host is displayed because <code>/proc/loadavg</code> is not isolated per logical layer.

An increased load in the container therefore does not automatically mean that the container itself is the cause or that you have a problem at all. In short: To assess the load, you always need information (e.g., number of CPU cores or I/O information) from the physical host.

==Usage Example==
sudo docker run -d --ulimit nofile=500000:500000 --restart unless-stopped --name innovaphoneAP -p 9090:8080 -p 9091:8082 -e WEBSERVERPORTHTTP=8080 -e WEBSERVERPORTHTTPS=8082 -v $(pwd)/myapps/:/mnt/data registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

This command runs the container in detached mode with automatic restart. It names the container innovaphoneAP, maps host ports 9090 and 9091 to the container's HTTP and HTTPS ports, sets the webserver port environment variables, mounts a host directory to /mnt/data, and starts the AP Manager. After container start up the AP manager web UI is accessible via <code>http://localhost:9090</code> or <code>https://localhost:9091</code>.

== Related Articles ==
[https://wiki.innovaphone.com/index.php?title=Howto16r1:Step-by-Step_Docker_Compose_Container_Deployment Step-by-Step Docker Compose Container Deployment]

Reference16r1:Concept innovaphone App Platform Container

2026-04-16T14:28:21Z

Nfi:

File:Ap-container-stepbystep.png

2026-04-16T14:26:05Z

Nfi:

Ap-container-stepbystep.png

Howto16r1:Step-by-Step Docker Compose Container Deployment

2026-04-16T14:24:35Z

Nfi: Created page with " Docker Compose Container Deployment {{HOWTOMOD13r3 Translation Info}} <hr> This guide explains how to structure, configure, and run a container using Docker Compose. It also covers how to update the container image. File:Ap-container-stepbystep.png = Docker Compose: Step-by-Step Container Deployment = This article describes how to deploy and maintain an innovaphone container..."

[[Category:Step-by-Step|Docker Compose Container Deployment]]

{{HOWTOMOD13r3 Translation Info}}
<hr>
This guide explains how to structure, configure, and run a container using Docker Compose. It also covers how to update the container image.

[[File:Ap-container-stepbystep.png]]

= Docker Compose: Step-by-Step Container Deployment =

This article describes how to deploy and maintain an innovaphone container using Docker Compose.

=== Features ===

* Clear separation of configuration and deployment
* Centralized configuration using a ''.env'' file
* Persistent data storage via mounted volumes
* Easy updates by modifying the container image version

=== Limitations ===

* Each container should be placed in its own directory
* Changes to variables or image versions require restarting the container

== Requirements ==

* Docker installed and running
* Docker Compose installed
* Access to the required innovaphone container image
* Sufficient permissions to create directories and store persistent data

== Things to know before you begin ==

* It is recommended to create a dedicated directory for each container
* Each container setup requires at least two files:
** ''.env''
** ''docker-compose.yml''
* The ''.env'' file contains all configurable variables
* The ''docker-compose.yml'' file defines the container structure and behavior

== Configuration ==

=== Create container directory ===

Create a dedicated directory for the container config and container persistant data.

Example:
<nowiki>/dockerdata/apcontainer</nowiki>
<nowiki>/dockerdata/apcontainer/data</nowiki>

=== Set ownership ===

Set ownership for your user.

Example:
chown -R $USER:$USER /dockerdata/apcontainer

=== Create .env file ===

Define all required variables in the ''.env'' file.

<syntaxhighlight lang="bash">
WEBSERVERPORTHTTP=8080
WEBSERVERPORTHTTPS=8082
LOG_FLAGS=7
LOG_SIZE=1048576
DNSIPV4=8.8.8.8
LIMIT_RAM=512
LIMIT_DISK=10
TZ=Europe/Berlin

HOST_PORT_HTTP=9202
HOST_PORT_HTTPS=9203

DATA_PATH=/dockerdata/apcontainer/data
</syntaxhighlight>

==== Description of .env file variables ====

{| class="wikitable"
! Variable
! Description
|-
| WEBSERVERPORTHTTP
| Internal HTTP port of the container
|-
| WEBSERVERPORTHTTPS
| Internal HTTPS port of the container
|-
| LOG_FLAGS
| Logging level and options
|-
| LOG_SIZE
| Maximum size of log files
|-
| DNSIPV4
| DNS server used by the container
|-
| LIMIT_RAM
| RAM limit assigned to the container
|-
| LIMIT_DISK
| Disk space limit assigned to the container
|-
| TZ
| Time zone configuration
|-
| HOST_PORT_HTTP
| External HTTP port on the host
|-
| HOST_PORT_HTTPS
| External HTTPS port on the host
|-
| DATA_PATH
| Host path for persistent container data
|}

==== Optional port mappings ====

The following additional ports can be exposed if required by the application.

{| class="wikitable"
! Host Port
! Container Port
! Protocol
! Description
|-
| 9002
| 80
| TCP
| Standard HTTP (RP)
|-
| 9004
| 443
| TCP
| Standard HTTPS (RP)
|-
| 1300
| 1300
| TCP
| H323/TLS
|-
| 1500
| 5060
| TCP
| SIP
|-
| 1501
| 5061
| TCP
| SIP/TLS
|-
| 636
| 1636
| TCP
| LDAP/TLS
|-
| 8025
| 8025
| TCP
| SMTP
|-
| 8587
| 8587
| TCP
| SMTP/TLS
|-
| 3478
| 3478
| TCP/UDP
| STUN/TURN
|}
These ports are optional and only required depending on the recommended service.

To enable them, extend the ''ports'' section in the following ''docker-compose.yml'' file accordingly.

'''Warning:''' Each host port can only be used once on a host system. If a port is already in use by another container, the deployment will fail. Always verify port availability before starting the container.

=== Create docker-compose.yml ===

Define the container setup in the ''docker-compose.yml'' file.

<syntaxhighlight lang="yaml">
services:
apcontainer:
image: registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:140030
container_name: apcontainer
restart: unless-stopped

ports:
- "${HOST_PORT_HTTP}:${WEBSERVERPORTHTTP}"
- "${HOST_PORT_HTTPS}:${WEBSERVERPORTHTTPS}"

# Optional ports
- "9002:80"
- "9004:443"
- "1300:1300"
- "1500:5060"
- "1501:5061"
- "636:1636"
- "8025:8025"
- "8587:8587"
- "3478:3478/tcp"
- "3478:3478/udp"

volumes:
- ${DATA_PATH}:/mnt/data

environment:
WEBSERVERPORTHTTP: ${WEBSERVERPORTHTTP}
WEBSERVERPORTHTTPS: ${WEBSERVERPORTHTTPS}
LOG_FLAGS: ${LOG_FLAGS}
LOG_SIZE: ${LOG_SIZE}
DNSIPV4: ${DNSIPV4}
LIMIT_RAM: ${LIMIT_RAM}
LIMIT_DISK: ${LIMIT_DISK}
TZ: ${TZ}

ulimits:
nofile:
soft: 500000
hard: 500000
</syntaxhighlight>

=== Set permissions ===

Set permissions for folders and files

Example:
chmod 750 /dockerdata/apcontainer
chmod 640 /dockerdata/apcontainer/.env
chmod 644 /dockerdata/apcontainer/docker-compose.yml
chmod 770 /dockerdata/apcontainer/data

=== Start container ===

After creating both files, start the container with:

<syntaxhighlight lang="bash">
docker compose up -d
</syntaxhighlight>

== Image Update ==

To update the container, you can first check the available image tags in the registry:

<syntaxhighlight lang="bash">
curl -s https://registry.innovaphone.com/v2/cloud/kubernetes/innovaphone-platform-instance/tags/list
</syntaxhighlight>

Then modify the image version in the ''docker-compose.yml'' file.

Example:
<syntaxhighlight lang="yaml">
image: registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:140030
</syntaxhighlight>

Then recreate and start the container:

<syntaxhighlight lang="bash">
docker compose up -d
</syntaxhighlight>

== Verification ==

To verify the deployment, check the following:

* The container is running without errors
* The configured host ports are accessible
* The data directory defined in ''DATA_PATH'' is correctly mounted
* Environment variables are applied correctly

Example command:

<syntaxhighlight lang="bash">
docker compose ps
</syntaxhighlight>

== Troubleshooting ==

=== Container does not start ===

* Check container logs:
<syntaxhighlight lang="bash">
docker compose logs -f
</syntaxhighlight>
* Verify that all variables in the ''.env'' file are correctly defined
* Ensure the image name and version are valid and accessible
* Check for syntax errors in ''docker-compose.yml''

=== Ports are not accessible ===

* Verify that the configured host ports are not already in use:
<syntaxhighlight lang="bash">
netstat -tulnp | grep <PORT>
</syntaxhighlight>
* Ensure firewall rules allow access to the defined ports
* Confirm correct port mapping in ''docker-compose.yml''

=== Volume or data issues ===

* Check if the host directory defined in ''DATA_PATH'' exists
* Verify permissions of the directory:
<syntaxhighlight lang="bash">
ls -la /dockerdata/apcontainer/data
</syntaxhighlight>
* Ensure Docker has access rights to the directory

=== Configuration changes are not applied ===

* Restart the container after changes:
<syntaxhighlight lang="bash">
docker compose down
docker compose up -d
</syntaxhighlight>

=== Container exits unexpectedly ===

* Inspect logs for errors:
<syntaxhighlight lang="bash">
docker compose logs
</syntaxhighlight>
* Check system resource limits (RAM, disk)
* Verify ulimit settings are supported by the host system

== Related Articles ==
[https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_innovaphone_App_Platform_Container Reference16r1:Concept innovaphone App Platform Container]

Howto:PHP based Update Server V2

2026-04-02T10:08:23Z

Nfi: /* Using vars create */

==Applies To==
This information applies to

* all innovaphone devices
* web server running PHP 5 (e.g. Linux Application Platform)

All Versions prior to 13r1 (for 13r1 and later, see [[Reference13r1:Concept App Service Devices]] instead).

By default, the [[Reference10:Concept_Update_Server | Update Manager]] mechanism reads a file that corresponds to the device type (e.g. <code>update-ip222.htm</code>). While this makes sense (update scripts may vary by device type), it is sometimes tedious, as you have to edit a huge amount of files which typically are (at least partly) identical.

Here is a PHP script that can be used as an ''Update Server'' that allows you to simplify the handling of update scripts. It also includes a mechanism that makes sure that all devices always have the same firmware installed as a given ''master device'' has. Finally, it implements a straight forward configuration backup scheme.

This article describes version 2 of this update server (build 2006 and up). The previous version is described in [[Howto:PHP_based_Update_Server]]. The enhancements are
* Status user interface showing all known devices
* Ability to roll out custom device certificates
* Ability to provide configuration files to MTLS-authenticated devices only (e.g. in order to keep certain configuration settings secure)
* Hide configuration files from public read access

==More Information==
=== Requirements ===
The update server script requires a web server with working PHP 5.3 or higher platform. It has been tested with Apache and ligHTTPD (on a [[Reference10:Concept Linux Application Platform | Linux Application Platform]]). On IIS, neither the certificate roll-out nor the MTLS authentication or configuration backup works with IIS.

The platform running the PHP scripts must have a valid time setting!

PHP 8 is supported from build 2023.

Needed PHP extension: <code>mbstring, simplexml, soap</code>

=== Features ===
The update server can
* update all your devices with boot code and firmware that corresponds to the versions running on a reference device of your choice
* save backups of your devices configuration. Backups are saved only if the configuration changed since the last backup
* invoke your own update scripts depending on
** various phases (e.g. you can have ''staging'' scripts which are only executed once and normal scripts which are executed in normal operation later on)
** devices classes (e.g. you can have different scripts for phones and gateways)
** environments (e.g. you can have scripts for your internal devices and others for devices in home offices)
** the device serial number
* roll out customer specific device certificates
* roll out update scripts to devices only that have identified themselves with a valid device certificate (MTLS)
* maintain a list of devices in your installation along with some vital information about each individual device

=== Installation ===
==== On the Linux Application Platform ====
Here is how you would install it on the [[Reference10:Concept_Linux_Application_Platform|LAP]]. Some of the steps may not be necessary if you don't want to use all features.

On the ''Linux Application Platform'', you would
* open the LAP's file system using a SFTP client such as e.g. [https://winscp.net/eng/index.php WinSCP] (if you have not yet changed it, the default credentials will be <code>root/iplinux</code>, see [[Reference10:Concept_Linux_Application_Platform#Default_Credentials | Concept Linux Application Platform]]). Note that you must use SFTP rather than WebDAV, as WebDAV will not give access to the executable web server files
* create a new root directory underneath <code>/var/www/innovaphone/mtls</code>, e.g. <code>/var/www/innovaphone/mtls/update</code>
* download the complete file package of scripts and files [https://github.com/innovaphone/php-update-server here]
* copy all files and directories in to this new directory
** create your local config files. We will never overwrite these in further updates.
***Rename <code>config/user-config-sample.xml</code> to <code>config/user-config.xml</code>
***Rename <code>scripts/all-all-all-sample.txt</code> to <code>scripts/all-all-all.txt</code>
* change owner and group of all files and directories to <code>www-data</code>, change mode to 0600 for all files and 0700 for all directories (see [[#Migrating_from_build_2000_an_newer | below]] for how to do this with WinSCP)

* log in to the LAP's admin UI (if you have not yet changed it, the default credentials will be <code>admin/linux</code>, see [[Reference10:Concept_Linux_Application_Platform#Default_Credentials | Concept Linux Application Platform]]) and open its ''Administration/Web Server/Change web server properties and public access to the web/webdav'' configuration UI. Add the following paths to ''Public Web Paths'' (assuming your base directory is called <code>update</code>):
** <code>/mtls/update</code>
** <code>/mtls/update/web</code>
** <code>/mtls/update/admin</code>
** <code>/mtls/update/fw/</code> (note the trailing slash!)
: make sure that no other sub-directories of ''update'' are listed
: make sure you have no trailing '/' in any of these paths (except ''fw/')
: this will make sure the update server's admin user interface is not accessible to the public

At this point, you should be able to access the update server's admin user interface, e.g. <code>http://update.yourcompany.com/mtls/update/admin/admin.php</code>. However, the only thing you see is a login page. Please note that your browser should ask you for a password for this page (unless you already entered it before). Cookies must be enabled for the login page to work properly.

===== If you want to provide HTTPS Acess to the Update Server =====
For HTTPS access to the update server, you may want to install your own server certificate under ''Administration/Certificates/Current server certificate''. However, this is not strictly required (you will experience some warning messages when using your browser to access the update server, however, calling devices will work just fine).

===== If you want to setup MTLS-restricted Delivery of Update Scripts =====
If you think you have sensitive information in your update scripts, you should make sure to deliver such scripts to your own verified devices only. This can be done by authenticating calling devices with ''mutual TLS'' (MTLS). In this case, the calling device must use HTTPS to retrieve the update script and present a trusted client certificate that identifies itself as the calling device (that is, has the device serial as the certificate's ''common name'' (CN)).

For this feature, you need to ''Configure mutual TLS'' in the LAP's ''Administration/Web Server'' panel. Simply tick the ''Active'' check-mark and select an appropriate ''MTLS Port''. The port must not conflict with any other TCP port used on the LAP, so neither 80 nor 443 is a good choice. 444 is a good choice. Although it [http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?&page=8 is assigned to the snpp protocol] by IANA, it is not used by the LAP (and probably rarely used anyway).

If MTLS is already activated on your LAP, simply take note of the currently configured ''MTLS Port''.

 
Please note that MTLS access is ''not possible'' through a ''reverse proxy'' (RP). This is because the RP always will terminate the incoming TLS connection and establish its own to the target. Therefore, the client certificate presented to the target server is the RP's certificate, not the original clients certificate. In our context - where MTLS is used to verify the identity of the original caller - clients must not access the update server through an RP.

You can either expose your update server directly to the internet (and carefully think through the security implications) or create specific TCP port forwarding towards the update server in your NAT-router/firewall. In this case, we recommend to use non-standard HTTP and HTTPS ports on the NAT router (cause this will already keep most of the HTTP port scanners out there in the internet from functioning).

 
Also, you will need the public key of all the CAs you will trust. These must be configured in to the web server so it can trust the certificates your devices will present to it. See [[#Enforcing_Trust]] for details.

==== On an Apache Server running on the Windows Operating System ====
The update server will run on Apache too. However, as we did not test this setup thoroughly, we recommend to use the LAP's LigHTTPD instead.

* For hints on using MTLS on an Apache Web Server, see [[Reference10:Concept_Provisioning#Enforcing_mutual_TLS_on_Apache | Enforcing mutual TLS on Apache]]
* For hints on getting the ''innovaphone device certificate authority'' public keys (which you may or may not need), see [[Reference10:Concept_Provisioning#How_to_get_inno-dev-ca-certificate.crt | How to get inno-dev-ca-certificate.crt ]]

==== On Microsoft's IIS ====
We do not recommend to use IIS as
* it does not support PUT easily
* it is not compatible with the innovaphone device's MTLS implementation

===Update existing installation===

* download the [https://github.com/innovaphone/php-update-server new sources]
* copy all files and directories to your existing installation folder (overwrite existing files)
* change owner and group of all files and directories to www-data, change mode to 0600 for all files and 0700 for all directories

===Configuration===

If you intend to deliver your update scripts with MTLS (that is, with HTTPS and mutual certificate check)
* you will need to have the full name of your ''certificate Authority'' (CA) as it is noted as ''Common Name'' (CN) in your CA's certificate
* also, you will need a PEM version of your CA's public key (a ''PEM version'' of a certificate is a text file that begins with a line like <code>-----BEGIN CERTIFICATE-----</code>)

Also, you need to know the ''MTLS Port'' configured in your LAP (see [[#If_you_want_to_setup_MTLS-restricted_Delivery_of_Update_Scripts| If you want to setup MTLS-restricted Delivery of Update Scripts ]] above).

All tweakable parameters are set in <code>user-config.xml</code>. You may want to use an XML-capable editor such as notepad++, netbeans or Visual-Studio for editing. if your editor supports it, you benefit from the ''document type description'' (DTD) provided in <code>full-config.dtd</code>.

<syntaxhighlight lang="html5">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config SYSTEM "full-config.dtd">

<config debugmerge="false" debugcerts="false" debugscript="false">
</config>
</syntaxhighlight>

The attributes of the <code>config</code> tag control some aspects of debugging. For now, simply set all 3 to <code>"true"</code> instead of <code>"false"</code>. Do not forget to revert them back to <code>"false"</code> when everything runs smoothly, large log files will result if not.

==== Securing Access ====
To control access to the update server's data, you should set a login. This can be done in the ''master'' tag by specifying both ''user'' and ''password'':

<syntaxhighlight lang="html5">
<master ... user="myadmin" password="mysecret"/>
</syntaxhighlight>
Default username and password are admin/password.

==== Delivering Firmware and Boot Code ====
At this point, you can simulate a device by requesting an update script using an URL like <code>http://update.yourcompany.com/mtls/update/update.php?type=IP232&sn=00-90-33-00-00-00&hwid=IP232-00-00-00&ip=1.2.3.4</code> in your browser (please note that this URL should not ask you for a password). Most likely, your browser will wait a little while and then say something like:

...
# failed to use cached data (cache not current), retrieving info online
# cannot get PBX info: cannot access http://yourmasterdevice.youdomain.tld/CMD0/box_info.xml, reading cache
# cannot get cached PBX info: cannot access cache/master-info.xml - exit

This is because you did not yet specify the ''master device'' which always runs the reference firmware.

The idea here is that you have one innovaphone device in your system where the firmware is always manually updated. All other devices shall follow this reference firmware. The update server will deliver the firmware that runs on the master device to calling devices. For this to work, you need to set the ''info'' attribute of the [[#master|''master'']] tag and leave everything else ''as is''.

Remember that you do all your local configuration changes in <code>user-config.xml</code>.

As ''master'' is a first level tag, you can add it directly underneath the opening ''<config>'' tag. The only thing we need to define right now is the path to read the firmware information from your master device. Let's say your reference device has the IP address <code>172.16.0.10</code>, you end up with

<syntaxhighlight lang="html5">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config SYSTEM "full-config.dtd">

<config debugmerge="true" debugcerts="true" debugscript="true">
<master info="http://172.16.0.10/CMD0/box_info.xml" user="myadmin" password="mysecret"/>
</config>
</syntaxhighlight>
(you could use a DNS name instead of the IP address of course).
The ''info'' URL is used by the update server itself only, it is never used by devices requesting an update script.

When you refresh the page that simulates a device requesting an update script, the output should now change to something like

...
# failed to use cached data (cache not current), retrieving info online
# current firmware (unknown) does not match required firmware (130178)
...

This is to say that your master device runs firmware 130178 and the calling device does not (actually, as the calling client is simulated by your browser, it does not transmit its current firmware to the update server so it is ''(unknown)'').

In order to actually update the clients with firmware and boot code, the files must be made available to the calling client somehow. This is done by specifying an URL in the [[Reference10:Concept_Update_Server#Prot_command | prot ]] and [[Reference10:Concept_Update_Server#Boot_command | boot ]] commands sent to the calling device:

...
# current firmware (unknown) does not match required firmware (130178)
mod cmd UP0 prot http://update.yourcompany.com/mtls/update/fw/130178/ ser 130178
# current boot code (unknown) does not match required boot code (130112)
mod cmd UP0 boot http://update.yourcompany.com/mtls/update/fw/130112/ ser 130112
...

By default, the URL generated points to a sub-directory of your update server called ''fw'': <code>http://update.yourcompany.com/mtls/update/fw/130178/</code>. Note that this default URL expects sub-directories underneath the ''fw'' directory which correspond to the firmware and boot code build number. The file structure thus would be like

/var/www/innovaphone/mtls/update/fw
/130178
/ip232.bin
/130112
/boot232.bin

Note that the URL ends with a slash (<code>/</code>). This instructs the calling device to append the appropriate file name itself when retrieving the file (see [[Reference10:Concept_Update_Server#Prot_command | the prot command ]] for details).

However, you can also specify any other URL by setting the ''url'' attribute in the ''fwstorage'' tag of your <code>user-config.xml</code>. In this attribute, certain meta words will be replaced (see [[#fwstorage | the ''fwstorage'' tag ]] for details). The default setting for example is <code>fw/{build}/</code>.

You can disable firmware and boot code updates altogether by setting the ''info'' attribute in the ''master'' tag to an empty value.

==== Your own Update Script Files ====
The update server will deliver update scripts to calling devices which are synthesized from a number of ''update script snippets'' which you define yourself. The idea is that many devices share parts of their configuration while other parts are different. This depends on
* the device ''class'' (e.g. a phone or a gateway)
: the device class is automatically derived from its model. In fact, a single device may be in multiple classes. For example, an IP232 is in these classes: ''phone, pre_opus_phone, phone_newui'' which basically says that its a phone and has no OPUS codec yet but a "new" user interface (as opposed to the old one found e.g. on an IP110). A number of useful classes are pre-defined, but you can add your own in <code>user-config.xml</code>.
* the device's environment (e.g. ''home-office'', ''branch-office'')
: These reflect the fact that devices may need different configuration if they are in different locations (or environments). The update server does not know about a device's environment, which is why you need to configure it in to the devices update URL if you need this. By default, there is a single environment defined called ''default'', but of course, you can add your own
* phase
: configuring devices may need multiple phases to go through. If more than one phase is defined, the device will go through all phases sequentially, which is why a ''phase'' has a numerical ''seq'' attribute. Phases are went through in order of this attribute. When the device has reached the last phase, it will stay there. By default, there is only one phase called ''update''

You can define update script snippets for any combination of device, environment and phase. You do so simply by placing appropriate files in to the ''scripts'' directory on your update server.

Let's have a closer look at the web page we used to simulate a device calling for an update script before (<code>http://update.yourcompany.com/mtls/update/update.php?type=IP232&sn=00-90-33-00-00-00&hwid=IP232-00-00-00&ip=1.2.3.4</code>). It will show you all the possible files it would deliver to the device:

# possible files (from scripts):
# scripts/update-all-00_90_33_00_00_00.txt does not exist
# scripts/update-all-default.txt does not exist
# scripts/update-phone-00_90_33_00_00_00.txt does not exist
# scripts/update-phone-default.txt does not exist
# scripts/update-pre_opus_phone-00_90_33_00_00_00.txt does not exist
# scripts/update-pre_opus_phone-default.txt does not exist
# scripts/update-phone_newui-00_90_33_00_00_00.txt does not exist
# scripts/update-phone_newui-default.txt does not exist

The update script snippet files need to have proper names to define when they should be delivered. As you can see, they all start with <code>update-</code> which means that they apply to devices which are in the ''update'' phase. As by default there is only a single phase defined, all possible file names start with <code>update-</code>.

The next part here is either <code>phone-</code>, <code>pre_opus_phone-</code>, <code>phone_newui-</code> or <code>all-</code>. This is because the calling IP232 is in three classes, so all respective snippets will be delivered to it. ''all'' however is a wild-card. That is, such files will be delivered to all devices, no matter what class they are in. You may wonder why there was no ''all'' for the phase. This is because there is only a single phase defined. If there would be more, the ''all''-variation of the phase-part of the file name would be appear.

The third part finally is either <code>default</code> or <code>00_90_33_00_00_00</code> in our case. ''default'' is the name of the only ''environment'' that is defined by default. ''00_90_33_00_00_00'' is the device's serial number which is treated as an implicitly defined environment name. This allows you to deliver certain snippets to a single device only.

Now let's create an update script snippet that is delivered to all phones in the default environment when they are in the update phase. The file name (which looks like ''phase''<code>-</code>''class''<code>-</code>''environment''<code>.txt</code>) has to be <code>update-phone-default.txt</code> therefore. Just for an exercise, let us set the device name (as shown in the browser's title bar) to ''This is a Phone!''.
The command to do so is <code>config add CMD0 /name This+is+a+Phone%21</code>, so your file may look like this

# set the device name
config add CMD0 /name This+is+a+Phone%21

(btw: did you observe that config line arguments need to be url-encoded?). Now create the file and upload it in to the ''scripts'' directory of you update server. When you now refresh the page which simulates the device calling for an update script, you will see something like this:

...
# newest script (scripts/update-phone-default.txt) 11s old
# files being updated (scripts/update-phone-default.txt 11s old, waiting for at least 90s to expire)

When you update multiple script snippets, it is often undesirable that a device retrieves an inconsistent state of the scripts you are working on (e.g. if you already have saved one but not yet the other). To avoid this, the update server will look at the files modification dates and if one of those that needs to be delivered to the device is younger than 90 seconds, it will not send any of them at all.

So when you wait for the 90 seconds to pass and refresh the page again, you will see something like this:

# firmware build info cache is current
# phase: update, nextphase: , environment: default, type: IP232, classes: phone+pre_opus_phone+phone_newui
# possible files (from scripts):
...
# scripts/update-phone-default.txt 4.1 mins
...
# scripts/update-phone-default.txt
# { begin script 'scripts/update-phone-default.txt'
# set the device name
config add CMD0 /name This+is+a+Phone%21

# end script 'scripts/update-phone-default.txt' }

# trigger reset if required
config write
config activate
iresetn

As you can see, your snippet has been delivered by the update script. However, the update server has also added some trailing commands which write back the config to the devices flash memory (<code>config write</code>), activate it (<code>config activate</code>) and trigger a reset if needed (<code>iresetn</code>).

If there are multiple snippets available for a calling device, all of them are concatenated in the sequence shown in the header of the returned script (where the possible file names are listed)

==== Device Status ====
When you have a lot of devices which are served by the update server, you may want to have a list of these devices along with some useful information regarding each devices.

You can enable this by defining the ''status'' tag in your <code>user-config.xml</code>. So open the file and add the tag right next to the ''master'' tag you added before:

<syntaxhighlight lang="html5">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config SYSTEM "full-config.dtd">

<config>
<master info="http://172.16.0.10/CMD0/box_info.xml"/>
<status
dir="status"
/>
</config>
</syntaxhighlight>

When you have done so, please refresh the page that simulates your calling device and then open <code>http://update.yourcompany.com/mtls/update/admin/admin.php?mode=status</code>. You will now see a device list (well, a list with a single device, the one you simulated using your browser). The list will show some information regarding the devices that requested an update script lately. For more options, see [[#status]].

==== Device Backup ====
It is generally useful to have recent backups of all of your device configurations. The update server supports that if you enable it by defining the ''backup'' tag in your <code>user-config.xml</code>. Simply put it right next to the ''master'' or ''status'' tag you added before:

<syntaxhighlight lang="html5">
...
<backup
dir="backup"
/>
</syntaxhighlight>

If you have done so and then refresh the page that simulates your calling device, you will now see

...
# scripts/update-phone_newui-default.txt does not exist

mod cmd UP0 scfg http://update.yourcompany.com/mtls/update/update.php?mode=backup&hwid=#h&sn=#m

instead of

...
# scripts/update-phone_newui-default.txt does not exist

# Backups not enabled in config

When a client requests an update script the next time, this will initiate a configuration backup which is stored underneath the ''backup'' directory. For each device, a sub-directory is created and all backup files are stored therein. By default, the last 10 differing configuration backups are kept.

==== Controlling the Time-frames when Snippets are delivered ====
The update client built-in to innovaphone devices allows to restrict updates to certain time frames (e.g. only during the night). This can be controlled using the [[Reference10:Concept_Update_Server#Times_command | times ]] command.

You can configure the update server to use the time commands by setting the ''allow'' and ''initial'' attributes in the ''times'' tag in your <code>user-config.xml</code>.

<syntaxhighlight lang="html5">
<times
allow="22,23,0,1,2,3,4"
initial="1"/>
</syntaxhighlight>

If either the ''allow'' or ''initial'' attribute is present, the update script will contain a line like

...
# Restricted times
mod cmd UP1 times /allow 22,23,0,1,2,3,4 /initial 1

In the example above, all update script activity will occur only between 10pm and 5am (local device time). For more details, see [[Reference10:Concept_Update_Server#Times_command | Concept Update Server]]

==== Using and Enforcing HTTPS ====
Your devices can either use HTTP or HTTPS to access the update server. In normal operation, the update server will generate URLs (e.g. the URLs used to retrieve firmware or to backup configurations) for the same protocol.

However, you can enforce use of HTTPS by setting the ''forcehttps'' attribute in the [[Howto:PHP_based_Update_Server_V2#times | ''times'' ]] tag to <code>true</code>. If so, a device calling in with HTTP will be re-configured to use HTTPS:

...
# using HTTP and 'forcehttps' is set -> need to switch to HTTPS

# changed state query args: polling, phase
# new url=https://update.yourcompany.com/mtls/update/update.php?polling=5&phase=&type=#t&sn=#m&hwid=#h&ip=#i
...
(note that if you are using a non-standard port for HTTPS, you must define it using the ''httpsport'' attribute).

==== Delivering Custom Certificates ====
innovaphone devices come with pre-defined, trustworthy device certificates. However, all ''soft'' devices (such as the softwarephone, myPBX for Android/iOS or the IPVA) do not. Also, in many scenarios customers run their own ''public key infrastructure'' (PKI) and request their own certificates to be used instead of the pre-defined. This is why there is a need to roll-out custom certificates to devices.

The update server supports this task to an extend. It can
* check if a calling device has a proper certificate
* instruct a calling device without proper certificate to create a ''certificate signing request'' (CSR)
* download the CSR to the update server for easy access by the administrator
* upload a signed CSR to the device
* upload the public key(s) of the CA in to the device's trust list

In order to roll-out custom certificates with the update server, the administrator needs to
* run his own PKI (a.k.a. ''certificate authority'' (CA))
* monitor CSRs that appear in the update server's device list
* approve the request by manually submitting it to his own CA
* upload the signed CSR to the update server

Also, all devices must run ''V12r1 SR8'' or newer before the new certificate can be uploaded. Devices with older firmware will be updated automatically (see [[#Delivering_Firmware_and_Boot_Code]] above). However, the new firmware must be ''V12r1 SR8'' or later.

To learn how you can create proper device certificates with your own windows CA, see [[Howto:Creating custom Certificates using a Windows Certificate Authority]].

By default, custom certificates are turned off and you will see a note like

# certificates: either certificate handling or state tracking not enabled - not doing any certificate checking

in the delivered update script.

Custom certificates are turned on by adding a ''customcerts'' tag to your <code>user-config.xml</code>:

<syntaxhighlight lang="html5">
...
<customcerts
dir="certs"
/>
...
</syntaxhighlight>

The page that simulates your calling device will now include a line saying:

# certificates: we dont know anything about the current certificate state - not doing any certificate checking

In order to decide if or if not a calling device has a valid certificate, the device needs to send its current public key to the update server. This is done by enabling ''queries'' in your <code>user-config.xml</code>. ''Queries'' is a means to have the device submit certain information to the update server. In the update server's default configuration, two queries are defined but not enabled:

* the query ''certificates'' sends the current certificate state
* the query ''admin'' sends the current device name (as set in ''General/Admin'')

To enable a query, you must specify the class a calling device must be in in order to execute the query. This is done by adding an ''applies'' tag for the respective query in your configuration:

<syntaxhighlight lang="html5">
...
<queries>
<query id="admin">
<applies>*</applies>
</query>
<query id="certificates">
<applies>*</applies>
</query>
</queries>
...
</syntaxhighlight>

This basically says that both queries should be executed by devices of just any class. Unless you enable queries, your update script will include lines such as:

# no queries defined for any of callers classes: phone+pre_opus_phone+phone_newui

Once you have enabled them, you will see something like

...
# query 'certificates'
mod cmd UP0 scfg https://update.yourcompany.com/mtls/update/update.php?mode=query&sn=#m&id=certificates ser nop /always mod%20cmd%20X509%20xml-info
# query 'admin'
mod cmd UP0 scfg https://update.yourcompany.com/mtls/update/update.php?mode=query&sn=#m&id=admin ser nop /always mod%20cmd%20CMD0%20xml-info
...

You can display the data sent by a query in the device status display. To do so, you need to define one or more ''show'' tags as part of the respective ''query'' tag:

<syntaxhighlight lang="html5">
...
<query id="certificates">
<applies>*</applies>

<show title="Subject">/state/queries/certificates/info/servercert/certificate/@subject_cn</show>
<show title="Issuer">/state/queries/certificates/info/servercert/certificate/@issuer_cn</show>
</query>
...
</syntaxhighlight>

Two steps however are still missing:

* a) you need to tell the update server the names of all the CAs you consider trustworthy. This is done by listing their names in the ''CAname'' attribute of the ''customcerts'' tag:

<syntaxhighlight lang="html5">
...
<customcerts
dir="certs"
CAname="innovaphone Device Certification Authority,innovaphone Device Certification Authority 2,innovaphone-INNO-DC-W2K8-Zertifizierungsserver"
/>
...
</syntaxhighlight>

: The example shown defines that you will accept both of innovaphone's device certificate authorities and also your own CA called ''innovaphone-INNO-DC-W2K8-Zertifizierungsserver''. Devices with device certificates issued by one of these CAs will be left untouched. For all other devices (for example, any ''myPBX for Android/iOS'' device that has a self-signed certificate), the generation of a custom certificate will be initiated.

* And b) you need to provide the public key of your CA (so it can be uploaded to the calling device's trust list). You need to place the DER (not PEM) encoded public key in to a file called <code>certs/CAkey-01.cer</code> on your update server (if you want to upload the whole certificate chain, put all of the public keys in the chain in to separate additional files called <code>certs/CAkey-02.cer</code> and so forth.

For more details on how to approve certificate signing requests, see [[#Approving Certificate Signing Requests]] below.

==== Enforcing Trust ====
Update script snippets may include sensitive information which you do not want to disclose to the public. Even though you can force the use of HTTPS (see above), this still does not keep your data secure. After all, an attacker could simply request an update script from your update server using HTTPS. To secure your data, you need to make sure that snippets are only sent to devices which identify themselves using a trusted certificate with a correct ''common name'' (CN). This is done using ''mutual transport layer security'' (MTLS). Therefore, you need to configure MTLS in the LAP (see [[#If_you_want_to_setup_MTLS-restricted_Delivery_of_Update_Scripts | If you want to setup MTLS-restricted Delivery of Update Scripts]] above).

You can enable this by setting ''forcetrust'' to <code>true</code> and ''httpsport'' to the port configured as ''MTLS Port'' in your web server. This is done in the ''times'' tag of your <code>user-config.xml</code>.
<syntaxhighlight lang="html5">
<times
...
forcehttps="true"
httpsport="444"
forcetrust="true"
/>
</syntaxhighlight>
Please note that ''forcetrust'' does nothing unless ''forcehttps'' is also set!

If so, the update server will deliver update script snippets only to clients which identify themselves with a proper certificate. For this to work, you will need to add the public key of your certificate authority to your web server's list of trusted certificates.

When using the ''Linux Application Platform'' (LAP), you need to add the PEM-encoded public key of your certificate authority to the ''innovaphone-ca.pem'' file in <code>/home/root/ssl_cert</code>. When you have installed the LAP, this file will contain the PEM-encoded public keys of the 2 innovaphone device certificate authorities. You can simply add the public key of your CA to the end of this file:

-----BEGIN CERTIFICATE-----
...inno-ca public key...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...inno-ca2 public key...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
...your-ca public key...
-----END CERTIFICATE-----

You will need to restart the LigHTTPD then (most easily done by restarting the entire LAP (''Diagnose/Reset'') or by issuing the command <code>/etc/rc2.d/S02lighttpd restart</code> from the linux root command prompt). Finally, you must set the ''forcetrust'' attribute.
(Note that the ''innovaphone-ca.pem'' file may be overwritten when a new LAP version is installed. It is thus a good idea to keep a copy and check it after an upgrade).

When ''forcetrust'' is effective and the calling device does not use HTTPS, it will be reconfigured to do so:

# using HTTP and 'forcehttps' is set -> need to switch to HTTPS
...
# new url=https://update.yourcompany.com:444/update/update.php?polling=5&phase=&type=#t&sn=#m&hwid=#h&ip=#i&env=default

If the calling device uses HTTPS but sends no certificate, you will see a message like

# cannot verify CN with HTTPS: SSL_CLIENT_S_DN_CN not present - fix web server configuration or use MTLS-enabled port!

This is probably because it is using a non-MTLS enabled port for HTTPS (e.g. the standard port 443) although MTLS is configured for a different port.

If the calling device uses HTTPS and sends a certificate but the CN does not match the serial number of the device, you will see a message such as

# Device claims to be 'IP232-30-00-af' but identifies as 'CKL-CELSIUS-W10.innovaphone.sifi' by TLS

If the calling device uses HTTPS and sends a certificate but the certificate is not trusted because its issuer is not listed in ''innovaphone-ca.pem'' (see above), the connection will be refused

In all such cases, no snippet will be delivered. If the certificate is good, you will see a message like

# good certificate(CN='IP232-30-00-af')

followed by the appropriate snippets.

==== Using multiple Phases ====
When you configure multiple phases, all phases up to the final phase are stepped through and when all associated update script snippets for all phases are done, the device will ultimately stay in the final phase. This can be used e.g. to implement update script snippets which are executed once only when the device is initialized. Settings made in all but the last phase can later be overridden by the user or an administrator. The settings done in the update script settings for the final phase however are re-executed whenever one of your update script files for this phase changes.
The process of deploying some initial settings is often called ''staging''.

To enable staging, you therefore create a new phase that comes before the default phase (which is ''update''). Phases are sorted numerical by an attribute called ''seq''. As the default phase ''update'' is defined with ''seq=200'', your new staging phase must be defined with a lower seq value:

<syntaxhighlight lang="html5">
...
<phases>
<phase id="staging" seq="100"/>
</phases>
...
</syntaxhighlight>

When you define such a phase, there will be new possible update script snippet file names:

# phase: staging, nextphase: update, environment: default, type: IP232, classes: phone+pre_opus_phone+phone_newui
# possible files (from scripts):
# scripts/all-all-00_90_33_30_00_af.txt does not exist
# scripts/all-all-default.txt does not exist
# scripts/all-phone-00_90_33_30_00_af.txt does not exist
# scripts/all-phone-default.txt does not exist
# scripts/all-pre_opus_phone-00_90_33_30_00_af.txt does not exist
# scripts/all-pre_opus_phone-default.txt does not exist
# scripts/all-phone_newui-00_90_33_30_00_af.txt does not exist
# scripts/all-phone_newui-default.txt does not exist
# scripts/staging-all-00_90_33_30_00_af.txt does not exist
# scripts/staging-all-default.txt does not exist
# scripts/staging-phone-00_90_33_30_00_af.txt does not exist
# scripts/staging-phone-default.txt does not exist
# scripts/staging-pre_opus_phone-00_90_33_30_00_af.txt does not exist
# scripts/staging-pre_opus_phone-default.txt does not exist
# scripts/staging-phone_newui-00_90_33_30_00_af.txt does not exist
# scripts/staging-phone_newui-default.txt does not exist

First of all, there are new names for this particular phase. Furthermore, as we now have multiple phases, the new wild-card name ''all'' is possible.

An example for a staging script snippet might be a file called <code>staging-all-all.txt</code>:

# change admin password
config add CMD0 /user admin,my-admin-password
config activate
config rem CMD0 /user

This will set the admin password to <code>my-admin-password</code> during staging (it should be obvious that such staging should only be done in combination with [[#Enforcing_Trust|Enforcing Trust]], see above).

=== A complete <code>user-config.xml</code> Sample ===
Here is a complete sample of a configuration file.

<syntaxhighlight lang="html5">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config SYSTEM "full-config.dtd">

<config debugmerge="true">
<master info="http://172.16.0.10/CMD0/box_info.xml"/>
<status
dir="status"
missing="1000"
/>
<backup
dir="backup"
/>
<times
allow="22,23,0,1,2,3,4"
initial="1"
forcehttps="true"
httpsport="444"
forcetrust="true"
/>
<customcerts
dir="certs"
CAname="innovaphone Device Certification Authority,innovaphone Device Certification Authority 2"
CSRsan-dns-1="{name}.company.com"
CSRsan-dns-2="{hwid}.company.com"
CSRsan-dns-3="{rdns}"
CSRsan-ip-1="{realip}"
/>
<phases>
<phase id="staging" seq="100"/>
</phases>
<environments>
<environment id="intranet"/>
<environment id='sifi'>
<implies>intranet</implies>
</environment>
<environment id='berlin'>
<implies>intranet</implies>
</environment>
<environment id='verona'>
<implies>intranet</implies>
</environment>
<environment id='homeoffice'/>
<environment id='mobile'/>
</environments
<queries>
<query id="admin">
<applies>*</applies>
</query>
<query id="certificates">
<applies>*</applies>
<show title="Subject">/state/queries/certificates/info/servercert/certificate/@subject_cn</show>
<show title="Issuer">/state/queries/certificates/info/servercert/certificate/@issuer_cn</show>
</query>
</queries>
</config>
</syntaxhighlight>

=== Operation ===

==== Configuring and Debugging a real Device ====
To configure your device for use with the update server, you simply set <code>http://update.yourcompany.com/mtls/update/update.php</code> as ''Command File URL'' in ''Services/Update'' (you can optionally add a <code>?env=envname1,envname2</code> query argument if you want to set one or more specific environments for your device). The update server will re-configure the device later on so that it uses all the required query arguments.

Generally, there are the following methods to set the ''Command File URL''
* configure it manually using the admin GUI
* provide it to the device using DHCP (this will however not work for the softwarephone or ''myPBX for Android/iOS'')
* use the innovaphone provisioning service (see [[Reference10:Concept_Provisioning|Reference10:Concept Provisioning]] for details)

Once the ''Command File URL'' is set on the device, you can debug what the update client in the device does, using the normal trace mechanism. For this, you will want to open the ''Debug'' page (<code>http://x.x.x.x/debug.xml</code>) and set the ''Update/Polling'' and ''Update/Execution'' check-marks. When the update client queries the update server, you will see lines like

0:0826:465:5 - upd_poll: state IDLE -> RECV
0:0826:465:7 - IP.0 -> UPD-POLL.0 : SOCKET_GET_LOCAL_ADDR_RESULT(172.16.100.201,255.255.0.0,0,'',ANY)
0:0826:466:0 - IP.0 -> UPD-POLL.0 : SOCKET_GET_LOCAL_ADDR_RESULT(172.16.100.201,255.255.0.0,0,'',ANY)
0:0826:695:0 - upd_poll: state=RECV sent()
0:0826:752:0 - upd_poll: status 200 headercomplete=1 contentlength=0
0:0826:754:0 - upd_poll: recv_data(2199)
0:0826:754:1 - upd_poll: recv_data(0) EOF
0:0826:754:1 - upd_poll: GET EOF - state=RECV http-status=200 length=2199
0:0826:754:1 - upd_poll: do commands
0:0826:754:1 - upd_poll: state RECV -> EXEC

in the trace. Commands included in the update script will look like

0:0826:754:5 - script::get_line: >line(mod cmd UP0 scfg https://update.yourcompany.com/mtls/update/update.php?mode=backup&hwid=#h&sn=#m)
0:0826:754:5 - upd_poll: pass 'mod cmd UP0 /sync scfg https://update.yourcompany.com/mtls/update/update.php?mode=backup&hwid=#h&sn=#m')

Finally, you do not need to wait for the next time the device decides to contact the update server. Instead, you can force this by sending an <code>http://</code>''your-device-ip<code>/!mod cmd UP1 poll</code> to the device.

==== The Device Status Update Page ====
If status tracking is enabled (see [[#Device_Status | Device Status]] above), the update server will keep a list of devices it knows of. You can see this list by calling <code>http://update.yourcompany.com/mtls/update/admin/admin.php?mode=status</code>.

By default, the list will not be updated unless you refresh the page. However, if you set the ''refresh'' attribute in the ''status'' tag in your ''user-config.xml'' file to <code>60</code>, all entries in this list will be refreshed every 60 seconds (however, the list itself will not be reloaded, so to see new devices, you need to refresh the entire page). Devices that have not been seen for more than 7 days are shown in a different colour. Devices that have not been seen for longer than 90 days will be silently removed from the list.

===== Filtering =====
From build 2011, you can filter the devices shown using the ''device filter'' field in the ''Device'' column header. The filter string is matched against ip-address, serial number, type, name, phase, class, environment, firmware and bootcode. Also, you can filter by using the keywords ''present'' and ''missing'' (based on the ''missing'' attribute of the ''status'' tag in your configuration file). If one of these attributes match your filter expression, the device is shown.

A filter expression must match a complete ''word''. For example, if you filter by <code>16</code> this would match the ip-address <code>172.</code>16<code>.0.20</code> but it would not match <code>192.</code>16<code>8.0.1</code>.

If you specify multiple filter expressions (separated by white space), only devices which match all of the expressions will be shown. For example, if you filter by <code>172.16. ip222</code> this might match all IP222 in your 172.16.*.* network. Filter expressions are case insensitive.

==== Approving Certificate Signing Requests ====
When you use custom certificate roll-out, you will see a column ''Certificates'' in the device status list, showing the devices certificate status.

[[Image:PHP_based_Update_Server_V2_Device_Status.png]]

If a CSR has been created on the device, this will be available for download in the ''Files'' section of the ''Info'' column. You can submit the CSR to your CA and then upload the signed request (using the ''Upload'' button in the ''Files'' section of the ''Info'' column). The signed request will eventually be uploaded to the device then. On the device itself, the CSR is shown in ''General/Certificates''.

[[Image:PHP_based_Update_Server_V2_CSR.png]]

==== Certificate Errors ====
When a signed certificate request uploaded to the device can not be installed on the device, you will see a message like <code>Certificate upload error - certificate handling stopped</code> in the ''Certificates'' columns for the device. In this case, any further processing will be stopped. Most likely, the reason is that you uploaded the wrong file as signed certificate request (either not a signed certificate at all or a signed request for another device).

In this case
* remove any certificate request from the device
* remove the <code>X509/REQUESTERROR</code> from the device configuration (i.e. <code>vars del X509/REQUESTERROR</code>)
: these 2 steps can be easily done by resetting the device to factory defaults and then set the ''Update URL'' again
* remove any stored files for the device on the update server (shown in the ''Certificates'' column)

The normal process will start all over again then.

=== Migrating old PHP Update Server Installations ===
==== Migrating from build 2000 and newer ====
* Copy all files and folders, '''except''' the ''scripts'' and ''config'' folder, from the source to your destination
* make sure all files and directories have correct owner (''www-data''), group (''www-data'') and mode (''read''/''write'' plus ''execute'' for directories)
: for example, in WinSCP you can use the ''Properties (F9)'' dialogue on the installations root folder:
: [[Image:PHP based Update Server V2-WinSCP-Properties.png]]
* open the ''StatusPage'' and make sure you refresh all cached files in your browser (depending on your browser, this may happen with Ctrl-R or Ctrl-F5)

==== Migrating from build 1011 and older ====
To upgrade from the [http://download.innovaphone.com/ice/wiki-src/index.php?urloffset=php-update-server%2F&name=php-update-server+%28all+available+builds%29&reverselevel=0&maxbuilds=999&root=c%3A%2Finetpub%2Fwwwroot%2Fdownload%2Fice%2Fdownload%2Fp%2Fwiki-src%2Fphp-update-server%2F1010+%28PHP+based+Update+Server+final%29%2F.. old version (builds up to 1011)] of the PHP based update server (as described in [[Howto:PHP based Update Server]]), do the following

* diff your <code>config.xml</code> to the one originally shipped (you can download it at [http://download.innovaphone.com/ice/download/p/wiki-src/php-update-server/1011%20(PHP%20based%20Update%20Server%20final)/php-update-server-1011.zip download.innovaphone.com/ice/wiki-src])
: take note of all the changes you made to it
* install the new version of the update server to a different URL
* configure it according to your needs by modifying <code>user-config.xml</code>. Do not modify the new <code>config.xml</code>!
** apply all modifications you did to your old <code>config.xml</code> to your new <code>user-config.xml</code>
** if you have used a custom setting for fwstorage/@url, you need to change it a bit. Change for example <code>url="http://myfwserver.mycompany.com</code> to <code>http://myfwserver.mycompany.com/{build}/</code> (note the trailing slash!)
* copy all your update script snippet files from the old server (these are all the .txt files in the old server's root directory) to the <code>scripts</code> directory of your new server
* copy the complete <code>fw</code> tree from the old server to the <code>fw</code> directory of your new server
* thoroughly test your new installation with some test devices
* when satisfied, edit <code>update-migrate.php</code> and change the code as described in the comment inside the file
* copy <code>update-migrate.php</code> from the new installation to the old installation
* on one of the devices which are currently served by the old update server, change the ''Command File URL'' so that it points to <code>update-migrate.php</code> instead of <code>update.php</code>. Do not change anything else in the URL. So if it currently is set to e.g.
: <code>https://172.16.0.90/update/update.php?type=#t&env=sifi&polling=0&phase=update</code>, change it to
: <code>https://172.16.0.90/update/update-migrate.php?type=#t&env=sifi&polling=0&phase=update</code>
* verify that this device properly switches to your new installation
** the ''Command File URL'' is changed so that it points to the new installation
** the device shows up in the device status page of your new server

* rename <code>update.php</code> to <code>update-old.php</code> in your old update server
* rename <code>update-migrate.php</code> to <code>update.php</code> in your old update server
* verify that all of your devices start showing up in the new server's status page

=== Complete Parameter Reference ===
Note: attributes are marked with an ''at'' (<code>@</code>) prefix. So ''master/@info'' refers to the ''info'' attribute in the ''master'' tag.

The following tags and attributes are available in the <code>user-config.xml</code> file, their default values are configured in <code>config.xml</code> (which you should not modify):

==== master ====
Defines the reference device where the firmware and boot code information is taken from.
; master/@info : the URL to the device info data. Set it to an URL like <code>http://</code>''your-reference-device''<code>/CMD0/box_info.xml</code>. Please note that this device must not have the ''Password protect all HTTP pages'' set in ''Services/HTTP/Server''. If you use the literal <code>none</code>, the master device will not be queried
; master/@expire : the firmware info cache lifetime. The firmware information is cached in a file (to make sure this information is present even if the reference device is off-line). The cache will not be refreshed before the ''expire'' time (in seconds) is expired
; master/@cache : the cache file name. The web server must be able to write this file (see [[#Installation | ''Installation'' ]] above)
; master/@user : if non-empty, this is the user name required to access the update server's web ui
; master/@password : the password

From build 2009, you can control the firmware and bootcode version to use on update:
; master/@firmware : if set, it may be one of
:: <code>master</code> (default if not set) : the firmware version is derived from the master device
:: <code>none</code> : the firmware update is generally disabled
:: ''build-number'' : the firmware is set to a certain ''build-number'' regardless of the firmware running on the master device
; master/@bootcode: if set, it may be one of
:: <code>master</code> (default if not set) : the bootcode version is derived from the master device
:: <code>firmware</code> : the bootcode version is set to the firmware version. This may be useful if the master device has no bootcode (e.g. the ipva)
:: <code>none</code> : the bootcode update is generally disabled
:: ''build-number'' : the bootcode is set to a certain ''build-number'' regardless of the bootcode running on the master device

<syntaxhighlight lang="html5">
<master
info="http://172.16.0.10/CMD0/box_info.xml"
expire="3600"
cache="cache/master-info.xml"
user="myadmin"
password="mysecret"
firmware="4711"
bootcode="firmware"
/>
</syntaxhighlight>

==== master/applies ====
Available from build 2009.

Boot code and firmware updates are only executed by devices which match all of the given <applies> conditions. A condition is met if the device belongs to the class that is given as tag content. If the ''env'' attribute is set, the tag content is interpreted as an ''environment'' name which has to match.

; master/applies/@env : if this attribute exists, the tag content is compared with the environments the device is in. Otherwise, it is compared with the classes it is in
<syntaxhighlight lang="html5">
<master
info="http://172.16.0.10/CMD0/box_info.xml"
expire="3600"
cache="cache/master-info.xml"
user="myadmin"
password="mysecret"
firmware="4711"
bootcode="firmware">

<applies>phone</applies>
<applies env="">berlin</applies>
</master>
</syntaxhighlight>

==== fwstorage ====
Defines from where the device will retrieve the firmware files for updates.
; fwstorage/@url : defines the URL to retrieve the files from. In this URL, the following meta words will be replaced as follows:
:* <code>{build}</code> - the requested firmware or boot-code
:* <code>{model}</code> - the devices type (e.g. <code>IP232</code>). This is derived from the ''type'' query argument used in the update URL which is set to the value <code>#t</code> which in turn is expanded to the [[Reference10:Concept_Update_Server#Scfg_command|''device type'']] of the device requesting the update script
:* <code>{filetype}</code> - the type of the required file, either <code>boot</code> or <code>prot</code>
:* <code>{filename}</code> - (from build 2014) the boot code or firmware filename for the device in lower case. Required if you use the LAP as firmware storage and firmware files are falsely requested in uppercase letters (as URLs on the LAP are case sensitive and if the files are requested with upper case names, the original files with lowercase name are not found). This also allows you to use alternate firmware file names (such as e.g. <code>ip110-sip.bin</code>). See the ''filenames'' tag
Note that if the ''url'' ends with a slash (<code>/</code>), the calling device will automatically [[Reference10:Concept_Update_Server#Prot_command|append the name of the requested file]]. In this case, the file system the URL points to must therefore contain sub-directories for each firmware build which contain the corresponding firmware builds (e.g, ''fw/12345/ip232.bin''). If ''url'' is not an URL (as is the case for the default value <code>fw/{build}/</code>), it is treated as a sub-directory underneath the update server's root directory

<syntaxhighlight lang="html5">
<fwstorage url="fw/{build}/"/>
</syntaxhighlight>

===== Loading firmware files from innovaphone.com =====
You can also load firmware from the innovaphone.com web site. To do so, set ''url'' like so:

<syntaxhighlight lang="html5">
<fwstorage url="http://webbuild.innovaphone.com/{build}/"/>
</syntaxhighlight>

Please note that ''this is a voluntary service, no guarantee of availability, no service level agreement''.

[[User:Ckl|ckl]] 15:40, 21 February 2023 (CET) This service has been discontinued. You may consider using <code>https://store.innovaphone.com/release/download/{build}/</code> instead.

==== backup ====
Defines where backup files are kept.
; backup/@dir : the directory underneath the script directory where backups are stored
; backup/@nbackups : the number of different backup files kept
; backup/@scfg : the target URL for the scfg command. If this is not an url, it is interpreted relative to the script directory URL. You can add more options for the ''scfg'' command, like in <code>scfg="update.php?mode=backup&hwid=#h&sn=#m ser hourly /force 1"</code> (this example will make sure backups are attempted only once per hour, so as to reduce load on the server).

<syntaxhighlight lang="html5">
<backup
dir="backup"
nbackups="10"
scfg="update.php?mode=backup&hwid=#h&sn=#m"
/>
</syntaxhighlight>

==== status ====
Defines details regarding the state kept for a device requesting an update script.
; status/@dir : the directory the status files are kept in (e.g. <code>status</code>). Used as the name for a sub-directory underneath your install directory on your web server. You must make sure that files in this directory cannot be read by anyone without proper authentication, as such files may contain sensitive information.
; status/@expire : if set and not empty, devices which have not requested an update script will be removed from the inventory after ''n'' seconds. For example, ''expire="7776000"'' will forget about devices after 90 days with no contact
; status/@missing : devices are shown in a different colour (indicating that they are ''missing'') after ''n'' seconds. For example, ''missing="604800"'' will flag devices as missing after 7 days with no contact
; status/@refresh : if set and not empty and larger than zero, the admin user interface showing the known devices will refresh the status of all shown devices each ''n'' seconds
; status/@logkeep : number of seconds log messages for individual devices will be kept
; status/usehttpsdevlinks : if set to true, links to devices in the status page are created using the https:// scheme
<syntaxhighlight lang="html5">
<status
dir="status"
expire="7776000"
missing="200"
refresh="10"
logkeep="90"
usehttpsdevlinks="true"
/>
</syntaxhighlight>

==== times ====
Defines details regarding the delivery of update scripts to requesting devices.

; times/@dir : the directory the update scripts are stored in. For security reasons, you may want to make sure that files in this directory cannot be read without proper authentication.

These attributes define the arguments of the [[Reference10:Concept_Update_Server#Times_command | times command]]. If neither ''allow'' nor ''initial'' is set, no ''times'' command is used (that is, the update scripts will be processed at all times).
; times/@allow : the hours to be used in the ''times'' command (as in <code>mod cmd UP1 times /allow </code>''hours'')
; times/@initial
: the minutes to be used in the ''times'' command (as in <code>mod cmd UP1 times /initial </code>''minutes''). If you want to use initial staging of virgin devices ''forcestaging'' must be <code>true</code>.

Delivered update scripts can include a [[Reference10:Concept_Update_Server#Check_command | check command ]] if the ''check'' attribute is set to <code>true</code>. . In this case, the devices will executed the scripts again only when you have edited/changed them.
; times/@check : if set to true, update scripts will be executed once only (unless their contents change)

When editing a number of update scripts, it is often not desirable if one changed script is already executed before another is changed too. When the ''grace'' attribute is set to a positive value, no script at all is delivered to requesting devices unless ''n'' seconds have expired since the last edit. For example, setting ''grace'' to 90 gives you one and a half minute to finish all your edits.

; times/@grace : defines the number of seconds that must expire before update script changes take effect

The update server works in either ''fast'' or ''normal'' mode. In ''fast'' mode, update scripts have to be requested more frequently, for example to step through multiple staging phases faster. This is enforced by modifying the calling device's ''Interval'' setting in [[Reference11r1:Services/Update | ''Services/Update '']] and setting it to 1 in ''fast'' mode.

; times/@interval : polling interval in minutes for normal operation (that is, when all staging is done)
; times/@polling : when you are using multiple ''phases'' (e.g. ''staging'' and ''update''), this defines the number of seconds to wait before the device reads the scripts for the next phase (see [[Reference10:Concept_Update_Server#Provision_command | provision command]]) (please do not modify the default value)

In some installations it may be desired to deliver update scripts with HTTPS only or even only to calling devices which have identified themselves with a proper TLS certificate.

; times/@forcehttps : if set to <code>true</code>, update scripts will only be delivered if the device call in with HTTPS. If the device is ready to receive an update script and still calls in with HTTP only, its ''Command File URL'' will be re-configured to use HTTPS automatically.
; times/@httpsport : if you use a non-standard port for HTTPS access to update scripts, it can be defined here
; times/@httpsurlmod : if your HTTPS URL differs from the HTTP URL, you can specifiy a ''modifier''. It has the form <code>!</code>''pattern''<code>!</code>''replacement''<code>!</code> where ''pattern'' is a [http://docs.php.net/manual/en/pcre.pattern.php PHP PCRE pattern]. For example, <code>!mtls/!!i</code> will remove the string <code>mtls/</code> from the URL used by the device to create the HTTPS URL to use. The delimiter (in this case "!") can be changed according to your own wishes, the first character defines the delimiter. The "i" at the end ignores uppercase.

Note: If you want to change the hostname of your URL, you have to add the Port 444 to your hostname. The code should then look like this: <code>!hostname1:444/mtls/!hostname2:444/!i</code>.
; times/@forcetrust : if set to <code>true</code>, update scripts will only be delivered if the device call in with HTTPS and a valid and trusted client certificate that identifies itself as the devices it claims to be
; times/@forcestaging : before build 2009, the restrictions imposed by the times/@allow settings affected all update ''phases''. This however makes staging cumbersome, as you usually want to restrict normal configuration changes to off-working-hours. If it is <code>true</code>, the restriction will be applied only to the last phase (that is, the ''staging'' phases will execute immediately). Also, the final phase will be executed once by staged devices.
: Since build 2021 the standard value was changed to <code>true</code>.

<syntaxhighlight lang="html5">
<times
dir="scripts"
allow=""
initial=""
check="true"
polling="5"
interval="15"
grace="90"
forcehttps="true"
httpsport="444"
forcetrust="false"
httpsurlmod="!mtls/!!i"
forcestaging="true"
/>
</syntaxhighlight>

==== phases ====
Defines the scripting phases. In many installations, there are initializations which should be performed once only. This is known as the ''staging'' phase. Once this is done, the devices continue with the execution of the normal update scripts (this phase is known as ''update'' by default). In the (unlikely) event that you want more or less phases, you can add/remove ''phase'' tags.
==== phases/phase ====
; phases/phase/@id : the name for the phase
; phases/phase/@seq: the sequential number for the phase. Phases are stepped-through in the numeric order defined by their ''seq'' attribute.

By virtue of the ''seq'' attribute, you can insert phases in to the set of phases defined by default, which is
<syntaxhighlight lang="html5">
<phases>

<phase id="staging" seq="100"/>
<phase id="update" seq="200"/>
</phases>
</syntaxhighlight>
For example,
<syntaxhighlight lang="html5">
<phases>
<phase id="phase" seq="150"></phase>
</phases>
</syntaxhighlight>
will insert a custom phase ''myphase'' as second phase.

==== environments ====
Defines the distinguished environments. Devices can have zero or more ''environments'' associated. The environments a device is considered to be in must be passed as <code>?env=</code>''name1,name2,..'' URL query arg in the update url.

Update scripts for all environments listed will be applied.
First the environment scripts itself, then all implied environments in the same order as the ''implies'' tags are listed in the config.

The default config file defines the environments ''intern'' and ''homeoffice'' but you can define your own if you like.

==== environments/environment ====
; environments/environment/@id : the name for the environment

==== environments/environment/implies ====
Each ''environment'' may have a number of sub-tags of type ''implies''. It contains the ''id'' of another ''environment''. If a device is in an environment with an ''implies'' sub-tag, it is assumed that it is in the implied environment also.
<syntaxhighlight lang="html5">
<environments>
<environment id='hq'>
<implies>intranet</implies>
</environment>
<environment id='intranet'/>
<environment id='homeoffice'/>
</environments>
</syntaxhighlight>
The <code>implies</code> tag handles no recursion (therefore, in the above example, if ''intranet'' would have an implies, a device in environment ''hq'' would not inherit this implication. Instead, you must list it explicitly for the ''hq'' environment).

If multiple environments will be used they will be applied also in the same order as the ''environment'' tags are listed in the config.

;There are some special things to keep in mind when adding multiple environments in the ''env'' attribute and they use the ''implies'' tag in the config.
:- The first environment specified in the arg ''env'' will be processed as expected with all children.
:- Recursive ''implies'' from an environment added via ''implies'' is not performed. (No children's children)
:- Only the first environment which is specified in the ''env'' arg with implies is processed, all additional values in the arg ''env'' will be ignored.
:- If the environment in the arg ''env'' it is not the first value, then it must also use the ''implies'' config to implies itself. Otherwise only child are processed.

==== classes ====
Defines the available device classes. Devices of different classes (e.g. phones and gateways) can have different update scripts. The device class is derived from the <code>#t</code> (device type) query arg of the update script URL (which is why you must configure it in the update URL). By default, the classes ''phone'', ''opus_phone'', ''pre_opus_phone'', ''phone_oldui'', ''phone_newui'', ''mobile'', ''gw'', ''fxogw'', ''fxsgw'', ''brigw'', ''prigw'' are recognized (newer versions may include more and/or updated class definitions). Also, any device is considered to be member of a class that has the device type as class-name. For example, an IP112 is in a class called ''ip112''.

A given device can be in multiple classes and will execute all update scripts available for these classes.

==== classes/class ====
Each ''class'' has a number of sub-tags of type ''model''. It contains the value replaced for the <code>#t</code> query arg. The models listed belong to the class.
; classes/class/@id : the name of the class

<syntaxhighlight lang="html5">
<classes>
<class id="gw">
<model>ip0010</model>
...
</class>
<class id="phone">
<model>ip110</model>
<model>ip232</model>
...
</class>
<class id="phone_oldui">
<model>ip110</model>
...
</class>
<class id="phone_newui">
<model>ip232</model>
...
</class>
</classes>
</syntaxhighlight>

==== nobootdev ====
Device types listed here do not receive boot code updates.
===== nobootdev/model =====
Each model tag defines a device type that shall not receive boot code updates.

<syntaxhighlight lang="html5">
<nobootdev>
<model>ipva</model>
<model>ipvadec</model>
<model>swphone</model>
<model>mypbxa</model>
<model>mypbxi</model>
</nobootdev>
</syntaxhighlight>

==== nofirmdev ====
Device types listed here do not receive firmware updates.
===== nofirmdev/model =====
Each model tag defines a device type that shall not receive firmware updates.

<syntaxhighlight lang="html5">
<nofirmdev>
<model>swphone</model>
<model>mypbxi</model>
</nofirmdev>
</syntaxhighlight>

==== filenames ====
Available from build 2014. Allows you to define alternate firmware and boocode names for use with the <code>{filename}</code> replacement (see the ''fwstorage'' tag), if required.

===== filenames/model =====
Each model defines a set of alternative file names for a certain device type.
; filenames/model/@id : the (lowercase) device type identfier (e.g. <code>ip112</code>). If this matches the device type of the calling device, the alternate file names are replaced
; filenames/model/@prot: the alternate firmware file name
; filenames/model/@boot: the alternate boot file name
<syntaxhighlight lang="html5">
<filenames>
<model id="mypbxa" prot="mypbx.apk"/>
</filenames>
</syntaxhighlight>

defines the firmware file name <code>mypbx.apk</code> for the device type <code>mypbxa</code>.

==== stdargs ====
Better don't touch :-)

==== customcerts ====
innovaphone hardware devices come with a device specific, trust-able ''device certificate''. However, in many situations it is desirable to roll-out customer-created ''custom certificates'' to all devices. The update server can do this. This will replace the shipped devices certificates both on hardware devices (where all such certificates are derived from innovaphone's certificate authority) as well as on soft devices which run with a self.-signed certificate by default (such as the software-phone or ''myPBX for Android/iOS'').

; customcerts/@dir : the name of the directory underneath your installation directory which stores device certificates. you should make sure that this directory cannot be accessed without proper authentication
; customcerts/@CAkeys : a file name pattern (e.g. <code>CAkey*</code>). All files in ''customcerts/@dir'' which match the pattern must contain DER or PEM encoded public keys which form the ''certificate chain'' of your CA (usually it is only one and the public key of your CA). One key per file. The files, when sorted by name, must contain the CA key itself in the last file (any intermediate certificates, if any, in the other files in correct order)
; customcerts/@CAtype : must be <code>manual</code> currently
; customcerts/@CAname : a comma-separated list of CA names. Devices presenting a certificate signed by one of these CAs will be considered as having a valid certificate. Otherwise, they wil be instructed to create a ''certificate signing request'' (CSR) for subsequent submission to your CA
; customcerts/@CAnamesep : defines the name separator for ''customcerts/@CAname''. The default is '<code>,</code>' and you must change it to a different value if one of your CAs includes a comma in its name
; customcerts/@renew : if set and not 0, certificates are replaced by new ones ''n'' days before they expire
; customcerts/@CAwildcard : normally, the update server will accept a certificate only if its CN matches the device's serial number. However, sometimes, so-called ''wildcard certificates'' such as <code>*.innovaphone.com</code> are used on a device (e.g. on a PBX or on a ''reverse proxy''). If set, the update server will also accept a certificate that contains a CN which equals the value of ''customcerts/@CAwildcard''. Note that the CN must match literally. For example, if ''''customcerts/@CAwildcard'' is set to <code>*.innovaphone.com</code> a CN like <code>host.innovaphone.com</code> is not accepted

When the update server determines that a device calls in with an un-trusted or expired certificate, it will have it create a signing-request for a new certificate. The requested certificate properties can be defined:

; customcerts/@CSRkey : the key size, e.g. <code>2048-bit</code>. Note that we do not recommend keys larger than 2048 bit (see [[Reference7:Certificate_management#Certificate_Key_Length_and_CPU_Usage]] for details)
; customcerts/@CSRsignature : the signature algorithm, e.g. <code>SH256</code>
; customcerts/@CSRdn-cn : the CN (''common name'') part used for the DN
; customcerts/@CSRdn-ou : the OU (''organizational unit'') part used for the DN
; customcerts/@CSRdn-o : the O (''organization'') part used for the DN
; customcerts/@CSRdn-l : the L (''locality'') part used for the DN
; customcerts/@CSRdn-st : the ST (''state or province'') part used for the DN
; customcerts/@CSRdn-c : the C (''country'') part used for the DN (note: ''CSRdn'' for many CAs, must be a 2-letter ISO country code)
; customcerts/@CSRsan-dns-1 : the first of up to three DNS names
; customcerts/@CSRsan-ip-1 : the first of up to two IP addresses

Within the set of CSR attributes, the following meta-words will be replaced:

* <code>{realip}</code> : the real IP address of the device as reported in the <code>ip=#i</code> query argument
* <code>{ip}</code> : the IP address of the device as seen by the update server
* <code>{proxy}</code> : the IP address of the reverse proxy the device used to reach the update server
* <code>{sn}</code> : the serial number of the device as reported in the <code>sn=#m</code> query argument (e.g. <code>009033030df0</code>)
* <code>{hwid}</code> : the hardware-id of the device as reported in the <code>sn=#m</code> query argument (e.g. <code>IP1200-03-0d-f0</code>)
* <code>{name}</code> : the ''Device Name'' (set in ''General/Admin'') of the device
* <code>{rdns}</code> : the DNS name found in a reverse DNS lookup for the real-ip address reported by the device (see ''{realip}'') above

<syntaxhighlight lang="html5">
<customcerts
dir="certs"
CAkeys="CAkey*"
CAtype="manual"
CAname="innovaphone-INNO-DC-W2K8-Zertifizierungsserver"
CAnamesep=","
CAwildcard="*.innovaphone.com"
CSRkey="2048-bit"
CSRsignature="SH256"
CSRdn-cn="{hwid}"
CSRdn-ou=""
CSRdn-o=""
CSRdn-l=""
CSRdn-st=""
CSRdn-c=""
CSRsan-dns-1="{name}.company.com"
CSRsan-dns-2="{hwid}.company.com"
CSRsan-dns-3="{rdns}"
CSRsan-ip-1="{realip}"
CSRsan-ip-2=""
renew="90" />
</syntaxhighlight>

==== queries ====
If queries are defined and applicable for the calling device, it will be instructed to send certain information to the update server which will be stored in the device status file kept on the server. Each piece of such information is defined using a separate ''query'' tag.

; queries/@scfg : defines the URL used by the device to send the information. Normally not changed from the default

==== queries/query ====
Defines one piece of information to be submitted to the update server.

; queries/query/@id : a unique name for the query
; queries/query/@title : a title for this piece of information shown in the device status

<syntaxhighlight lang="html5">.

<query id="media" title="Media">
<cmd>mod cmd MEDIA xml-info</cmd>
<applies>*</applies>
<show title="NAT">concat(/state/queries/media/info/nat/@result, ' (', /state/queries/media/info/nat/@public-addr, ')')</show>
<show title="Server">concat('STUN: ', /state/queries/media/info/@stun, ' TURN: ', /state/queries/media/info/@turn, ' (', /state/queries/media/info/@turn-user, ')')</show>
</query>


<query id="registration" title="Registration">
<cmd>mod cmd PHONE/USER phone-regs /cmd phone-regs</cmd>
<applies>phone</applies>
<show title="State: User/Number">concat(/state/queries/registration/info/reg[@id = "0"]/@state, ': ' , /state/queries/registration/info/reg[@id = "0"]/@h323, '/', /state/queries/registration/info/reg[@id = "0"]/@e164)</show>
<show title="PBX/ID">concat(/state/queries/registration/info/reg[@id = "0"]/@gk-addr, '/', /state/queries/registration/info/reg[@id = "0"]/@gk-id)</show>
</query>
</syntaxhighlight>

==== queries/query/cmd ====
The content of this tag defines the command to be executed on the device which outputs the requested information. These are ''mod cmd''s typically.

<syntaxhighlight lang="html5">

<cmd>mod cmd X509 xml-info</cmd>
</syntaxhighlight>

See [[Howto:Effect_arbitrary_Configuration_Changes_using_a_HTTP_Command_Line_Client_or_from_an_Update#Using_the_Mechanism_for_Device_Status_Queries ]] for details on how to find out which commands to use.

==== queries/query/applies ====
Defined queries are only executed by devices which belong to the class that is given as tag content. If the ''env'' atribute is set, the tag content is interpreted as an ''environment'' name which has to match.

; queries/query/applies/@env : if this attribute exists, the tag content is compared with the environments the device is in. Otherwise, it is compared with the classes it is in (unfortunately, you can not combine both)
<syntaxhighlight lang="html5">

<applies>phone</applies>
</syntaxhighlight>

==== queries/query/show====
If one or more ''show'' tags are defined for the ''query'' tag, the data will be shown in the device status page. The values shown are defined by the tag content which is an XPath expression selecting the data from the device state. The XPath expression always begins with <code>/state/queries/</code>''query-id'' (as defined by the ''id'' attribute in the query tag).

; queries/query/show/@title : used as title when the values are displayed in the status page

<syntaxhighlight lang="html5">
<show title="NAT">concat(/state/queries/media/info/nat/@result, ' (', /state/queries/media/info/nat/@public-addr, ')')</show>
</syntaxhighlight>

== Hints for writing your update snippets ==
Writing update scripts is largely undocumented and sometimes tricky. Here are some general guidelines.

=== Using <code>config add/del</code> ===
Many setting are done using <code>config change</code> commands. So these are very useful in update scripts too.

The straight forward method to find out which commands you need is as follows:
* get a device of the type in question and do factory reset
* save the configuration to a file
* do the desired settings using the normal web admin UI
* save the resulting configuration to another file
* compare the saved files

Usually, you want to set only specific parts of the configuration line. For example, assume you want to set the default coder to ''OPUS-WB''. Your saved configuration line might look like

config change PHONE SIG /prot SH323 /gk-addr pbx.innovaphone.com /gk-id innovaphone.com /tones 0 /lcoder OPUS-WB,20, /coder OPUS-WB,20,k1

To set only the coder settings, you would set the relevant options with the <code>config add</code> command as follows:

config add PHONE SIG /lcoder OPUS-WB,20,
config add PHONE SIG /coder OPUS-WB,20,k1

You can also remove specific options, as in

config rem PHONE SIG /tones

which would remove the <code>/tones 0</code> from the configuration line for <code>PHONE SIG</code>.

Note that the PHP update server will add the

config write
config activate
iresetn

at the end of the delivered script automatically, so you do not need to do it yourself. In fact, it is not recommended to have any reset command in your snippets.

==== <code>config change</code> Lines with associated Passwords ====
Sometimes, there is a password associated with certain configurations. Consider the STUN/TURN configuration:

config change MEDIA /stun stun.innovaphone.com /turn turn.innovaphone.com /turn-user innovaphone /turn-pwd 2 /nat-detect 61

The TURN password, being sensitive, needs to be encrypted in your configuration. This is why it is stored as a ''VAR'', which provides encryption support (see below):

vars create MEDIA/TURN-PWD pc ....

Unfortunately, the relationship between an option and an associated VAR needs to be guessed. You can be sure that the module name in the <code>config change</code> matches the modules name in the <code>vars create</code> command. However, the variable name must be guessed.

You can also set the password in your script using the <code>vars create</code>, however, you may also consider using a <code>mod cmd</code> (see below) such as e.g.

mod cmd MEDIA form /cmd form /del %2Fstun-slow /stun stun.innovaphone.com /turn turn.innovaphone.com /turn-user innovaphone /turn-pwd my-turn-pw /nat-detect 61

=== Using <code>vars create</code> ===

Sometimes it makes sense to use <code>vars create</code> commands. The syntax is

<code> vars create </code>''<name> <flags> <value>''

A ''<name>'' is a module name followed by a variable name, optionally followed by an index. For example, a phone will store the currently selected main registration as <code>vars create PHONE/ACTIVE-USER p </code>''<index>''. So the module is <code>PHONE</code> and the variable name is <code>ACTIVE-USER</code>. When the variable is multi-valued, an index is added to the name. For example, the registration settings for all but the first registration are stored as indexed variable, as in <code>vars create PHONE/USER-REG/00001 p </code>''<settings>'', where <code>00001</code> is the index (registrations count from 0 in this case).

There are a number of flags which can be combined, the most prominent used in update scripts are:
; p : permanent. The var is stored in flash memory (you will almost always use this flag in update scripts)
; b : binary. The var value is binary. Its ''<value>'' is given as a bin2hex string
; c : crypted. The var value needs to be encrypted and the ''<value>'' given is crypted
; x : crypted, plain value. The var needs to be encrypted but the ''<value>'' is given as plain (that is, un-encrypted) text. This allows you to set an encrypted variable without encrypting the desired value

; l : log. Creates trace output whenever this VAR is modified

; n : no-reset. If the 'n' flag is given, setting the variable will not trigger the 'reset needed' condition. Whether or not setting a variable has an effect without a reset depends on the module using the variable. Unfortunately, there is no documentation on which variables this works for, and we do not intend to provide such documentation. In the end, you have to try it out.
; s : suppressed. Excludes the VAR from config download with standard password.

Please note that, unless the 'n' flag is given, using <code>vars create</code> will ''always'' set the internal ''reset needed condition'' in the device (regardless which ''<value>'' is set, even when the current value is set again). This means that a subsequent <code>resetn</code> or <code>iresetn</code> will always trigger a reset. So if you use it, make sure that you use the ''times/@check'' ([[#times | see above]]) to protect your script from re-executing the snippet (and thus rebooting the device) all the time.


=== Using <code>mod cmd</code> ===
See [[Howto:Effect arbitrary Configuration Changes using a HTTP Command Line Client or from an Update]] for a discussion of how to use <code>mod cmd</code> in update scripts.

== Writing your own Dynamic Scripting Code ==
NB: this feature is available from build 2020.

By default, the update server delivers update scripts which are composed from a number of static files (so-called ''snippets''). Sometimes it makes sense however, to create such snippets dynamically (e.g. based on a database lookup). Here is how to do this.

Dynamic scripting is implemented by a user-supplied custom <code>class CustomUpdateSnippet</code>. The code for this class must be placed in to the file <code>config/scripting.class.php</code>. As a starter, sample class code is available in <code>config/scripting.class-sample.php</code>.

<syntaxhighlight lang="php">
<?php

/**
* to provide your own runtime generated snippets, rename this file to 'scripting.class.php' and
* implement the member functions
* $property will have one member called
*/

class CustomUpdateSnippet extends UpdateSnippet {

/**
* snippet to deliver after standard text snippets
* @return array of string
*/
public function getPostSnippet() {
return parent::getPostSnippet();
}

/**
* snippet to deliver before standard text snippets
* @return array of strings
*/
public function getPreSnippet() {
return parent::getPreSnippet();
}

/**
* do we want to suppress the standard text snippets?
* @return boolean
*/
public function sendStandardSnippets() {
return parent::sendStandardSnippets();
}
}
?>
</syntaxhighlight>

The sample code overrides of the classes member functions just call the base classes which do nothing at all. So if you just copy the sample code into <code>scripting.class.php</code>, nothing will change. However, if <code>getPreSnippet()</code> returns an array of strings (the parent class function returns an empty array), each array member will be sent to the calling device ''before'' the standard snippets are sent. Likewise, if <code>getPostSnippet()</code> returns an array of strings (the parent class function returns an empty array), each array member will be sent to the calling device ''after'' the standard snippets are sent. If <code>sendStandardSnippets()</code> returns false, the standard snippets will not be sent.

To determine the dynamic snippets to send, the user-provided <code>class CustomUpdateSnippet</code> has access to the members of its base <code>class UpdateSnippet</code>, namely the <code>var $statexml</code> member. This member contains a <code>SimpleXMLElement</code> object with all state information available for the calling device.

Here is a sample state found in <code>$statexml</code> (as output by the <code>dump()</code> member function):

<syntaxhighlight lang="html5">
<?xml version="1.0"?>
<state seen="1522065435" requested="130774bootcode" phase="update">
<device sn="00-90-33-3e-0c-57" type="IP112" classes="phone, opus_phone, phone_newui, hstrace, ip112" ip="127.0.0.1" rp="false" phase="update"
environments="sifi, 172net" certstat="either certificate handling or state tracking not enabled - not doing any certificate checking" hwid="IP222-46-5c-77" realip="172.16.80.241" requestDownloaded="false"/>
<firmware requested="130986" requested-at="1522065435"/>
<bootcode requested-at="1522065435"/>
<config filename="scripts/all-all-all.txt" delivered="1522065426" version="1486559970"/>
</state>
</syntaxhighlight>

The most interesting elements in this XML are probably the attributes of the <code>state</code> and the <code>device</code> tags.

== Hints for using custom SSL Certificates ==

Using your own SSL certificates can be useful depending on the scenario.

We have two methods to accomplish this:

=== Standard scenario as described in this wiki article ===
The idea is that each certificate request is checked manually, edited and the UpdateServer is provided with the new device certificate.

=== Special scenario with automated certificate renewal ===
The idea is that every new/unknown (untrusted) device connects to the staging server. Here the device is released by manual checking/authorization by getting its first certificate. All further extensions can happen automatically afterwards.

'''Important: All important settings concerning file permissions, access and co must be used from the above article and are only skipped in this part!'''

We will create two Update-Server instances with the following configuration.

# Staging Server (HTTPS/443)
#*Put the sources in <code>/var/www/innovaphone/update</code>
#*Use your specific SSL configuration ''<customcerts>'' as described [[#customcerts | above]].
#*Use the following settings in the configuration of ''<times>'':
#*:<code>force https = "true"</code>
#*:<code>httpsport = "444"</code>
#*:<code>force trust = "true"</code>
#*:<code>httpsurlmod = "!update/i!!"</code>
#*Activate the query ''certificates'' as described [[#Delivering_Custom_Certificates | above]]
#*Configure the firmware update via the master tag as described [[#Delivering_Firmware_and_Boot_Code| above]]
#* '''Important''': Do not submit any further customer specific device configurations in the staging Server
# Final MTLS / 444 update server
#*Put the sources in <code>/var/www/innovaphone/mts</code>
#*Use your specific SSL configuration ''<customcerts>'' as described [[#customcerts | above]] with <code>renew = "x"</code>
#*Use the following settings in the configuration of ''<times>'':
#*:<code>force https = "true"</code>
#*:<code>httpsport = "444"</code>
#*:<code>force trust = "true"</code>
#*:<code>httpsurlmod = "!mtls/i!!"</code>
#*Activate the query ''certificates'' as described [[#Delivering_Custom_Certificates | above]]
#*Configure the firmware update via the master tag as described [[#Delivering_Firmware_and_Boot_Code | above]]
#*Store all customer specific device configurations

The meaning of the two different instances is:
*The staging server <code>https://[ip]/update/admin/admin.php</code> will generate the provisioning URLs for new devices.
*All new/unknown (untrusted) devices are only in the staging server.
**Here you can check the devices and provide them a valid certificate after check/authorization.
*With a valid certificate, the UpdateURL is automatically changed to the MTLS instance.
*As soon as a device connects via MTLS we trust this device and we can use an automatic extension of the certificates.
** Waiting CSR requests are in the configured folder ''certs'' in the notation <code>"[mac]-request.p10.pem"</code>
** If you operate your own CA, feel free to automate the reissue of the certificates via a sheduled Cronjob
*** Help for Linux: [[Howto:Creating_custom_Certificates_using_a_OpenSSL_Certificate_Authority]]
*** Help for Windows: [[Howto:Creating_custom_Certificates_using_a_Windows_Certificate_Authority]]
** If a signed certificate with the format <code>"[mac]-signedrequest.cer"</code> is placed in the certs folder, the certificate is automatically updated on the device.

== Optional Configurations on the Linux Application Platform ==
===Support for more Connections===
By default the LAP's web server lighttpd allows for 512 concurrent connections with 1024 open file descriptors. When you serve a huge number of devices with the update server, then this might be too low. You will see some devices not being able to contact the update server for a while. This should not be a real issue as the devices will retry. However, updating all devices may take long due to this.

In the lighttpd log (in <code>/var/log/lighttpd</code> on the LAP), you will see entries like this:

2017-10-16 13:45:18: (network_linux_sendfile.c.140) open failed: Too many open files
2017-10-16 13:45:18: (mod_fastcgi.c.3075) write failed: Too many open files 24
2017-10-16 13:45:18: (server.c.1434) [note] sockets disabled, out-of-fds
2017-10-16 16:23:25: (response.c.634) file not found ... or so: Too many open files /mtls/updatev2/web/innovaphone_logo_claim_fisch.png ->
2017-10-16 17:57:45: (server.c.1432) [note] sockets disabled, connection limit reached

If you experience such issues, proceed as follows:

* connect to the LAP with SFTP (e.g. using WinSCP)
* change directory to <code>/etc/lighttpd</code>
* edit <code>lighttpd.conf</code>
* search for the 2 lines which set <code>server.max-fds</code> and <code>server.max-connections</code>
* replace the standard values. We recommend to set the number of file descriptors to 4 times the number of requests when using the update server, e.g.
: old
:: server.max-fds = 1024
:: server.max-connections = 512
: new
:: server.max-fds = 8000
:: server.max-connections = 2000
* save the file
* restart linux (''Diagnostics/Reset/Reboot'')

Be sure to closely monitor the ''Diagnostics/Status'' page for a while after such configuration.

Also, when you update the LAP, you will have to re-do the changes (as always when you change something ''under the hood'').

=== Debug files rotation based on logrotate ===
If you have to debug during operation and a lot of devices access the PHP Update Server V2, you have to keep track of the debug files or automatically limit them. For this you can use logrotate on the innovaphone Linux AP. With logrotate you can apply time-based or size-based rules when files are packed and when they are deleted.
* open the LAP's file system using a SFTP client such as e.g. [https://winscp.net/eng/index.php WinSCP] (if you have not yet changed it, the default credentials will be <code>root/iplinux</code>, see [[Reference10:Concept_Linux_Application_Platform#Default_Credentials | Concept Linux Application Platform]]). Note that you must use SFTP rather than WebDAV, as WebDAV will not give access to the executable web server files.
* Under the path <code>/etc/logrotate.d</code> create a file e.g. <code>updateserver</code>.

<code>/etc/logrotate.d/updateserver</code>

In this file now enter the following content and save it.

<code>
/var/www/innovaphone/mtls/update/debug/*.txt {
size 5M
missingok
rotate 2
compress
delaycompress
notifempty
create 644 www-data www-data
}
</code>

This will include all *.txt files from the debug directory of the PHP Update Server V2 in the logrotate process of the operating system.

; size 5M : means every 5MB the file is rotated or zipped
; size 5k : means every 5kB the file is rotated or zipped
Alternatively, you can also rotate the file based on time
; daily : means that every day the file is rotated or zipped
; weekly : means that the file is rotated or zipped daily

; missingok : if a debug file does not exist, it will be ignored
; rotate n : files are removed before the last ones are deleted.
; compress : compresses the old debug files
; delaycompress : compresses the debug data only after it has been moved once
; notifempty : empty log files are not rotated
; create 644 www-data www-data : creates a new, empty debug file with appropriate permissions

== Update Server and Reverse Proxy ==
It is possible to implement access to the update server through a ''reverse proxy'' (RP). However, you have to keep some issues in mind:
* ''Mutual Transport Layer Security'' (MTLS) is not possible
: MTLS requires a direct TLS connection between the two parties. An RP however would terminate the TLS connection and entertain two independent connections to the parties. This breaks MTLS. If you want to use MTLS and serve external clients, you must therefore provide a direct access to the update server (that is an external IP address either directly or through port forwarding)
: see [[#If_you_want_to_setup_MTLS-restricted_Delivery_of_Update_Scripts]] for details
* When using the RP, you can choose to forward encrypted traffic (HTTPS) arriving from external to the update server using HTTP (unencrypted). The update server however eventually rewrites the update URL in the calling devices configuration. In order to do this, it determines the type of the internal connection. So if the connection from the RP to the update server is using HTTP, it would create a ''http://...'' URL. Otherwise it would create an ''https://..'' URL (also, it would be using the same port). This way, if the RP forwards requests to the update server with HTTP, the synthesized new URL for the calling client would use HTTP too, even though the original request was sent with HTTPS. This may or may not be what you want (as all of your clients would end up using non-encrypted traffic). Even worse, it might not work at all, if the RP does not accept HTTP for example.

== Related Articles ==
* [[Reference10:Concept_Update_Server]]
* [[Reference12r1:DHCP_client]]
* [[Reference10:Concept_Linux_Application_Platform]]
* [[Reference10:Concept_Provisioning]]
* [[Howto:PHP_based_Update_Server]] (old version)
* [[Howto:Creating_custom_Certificates_using_a_OpenSSL_Certificate_Authority]]
* [[Howto:Creating custom Certificates using a Windows Certificate Authority]]
* [[Howto:Effect arbitrary Configuration Changes using a HTTP Command Line Client or from an Update]]

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

Howto14r2:Step-by-Step Distribute a custom device certificate

2026-04-01T12:22:45Z

Nfi: /* Get VARS */

[[Category:Step-by-Step|Distribute a custom device certificate]]

{{HOWTOMOD13r3 Translation Info}}

This article describes a method to roll out a custom certificate to innovaphone devices.

[[image:device-certificate-overview.png]]

== Purpose ==
Some customers run their own public key infrastructure (PKI) and want to use their own certificate (eg a wildcard certificate like *.company.com). This way you can distribute this certificate to all innovaphone devices.

=== Features ===
* A convenient way to distribute a custom device certificate
* Reboot is not necessary

=== Limitations ===
* The length of the public key should not exceed 2048 bits. This is to limit the CPU consumption on our devices, see [[:Reference11r1:Certificate_management|Certificate management]] for details.

== Requirements ==
* Devices App
* Innovaphone PBX
* Firmware should be at least v14r2sr4
* You need a complete certificate chain containing the private key. We recommend to use a PEM encoded Text file [[:Reference11r1:Certificate_management#Uploading_a_certificate_chain_together_with_the_private_key|as explained here.]]
* Wireshark

== Things to know before you begin ==
* The certificate device configuration in your Devices app only maintains your trust list. As a result it will not distribute the device certificate.
* The pre-installed certificate signed by the Inno-CA remains in the Flash when you upload a new certificate. If you delete the new certificate, the pre-installed certificate will reappear.

== Configuration ==
=== Create Expert configuration ===
* Open your ''Devices'' App->''<your Domain>''-''>Device Configuration''-''>Define device configuration''->''Expert''
* Assign a ''Description'' e.g Device certificate
* Assign the provisioning category to this device configuration that should receive the new device certificate

[[image:device-certificate-1.png]]
=== Get VARS ===
* Open your Wireshark
* Drag and drop the PEM file into your Wireshark
* Your Wireshark will only display a few packets

[[image:device-certificate-2.png]]
* Click on the first packet
* Do a right click on the section starting with Certificate
* Select Copy and then Copy as Hex stream
* Create a first line in your Expert configuration starting with ''vars create X509/CERTIFICATE/00000 pbln'' and paste the Hex stream from wireshark to the end of the line

[[image:device-certificate-3.png]]

* Then repeat the same procedure for each certificate in the certificate chain, but increase the index by 1. e.g. ''vars create X509/CERTIFICATE/00001''

[[image:device-certificate-4.png]]

The private key has to be copied as well.
* Open the last packet in Wireshark and select the BER section. Copy the section as Hex stream as well.
* Create a line ''vars create X509/KEY pbxln'' and paste the Hex stream from the BER packet to the end of the line.

[[image:device-certificate-5.png]]

If no '''BER''' section is available, open the '''PRIVATE KEY''' packet instead. 
Expand the '''PrivateKeyInfo''' structure and locate the entry '''privateKey'''. 
Copy this section as a '''Hex stream''' as well, and use it in the same way as described above.

=== Finish Expert configuration ===
* The last line in our script is: ''mod cmd X509 /servercert-update''
* In the end the expert configuration should look like this:

[[image:device-certificate-6.png]]

*As soon as you save the configuration, the device certificate will be pushed.

== Verification ==
Look at the Advanced UI of the device. You should see a new Device certificate on General/Certificates
== Known issues ==
===High CPU load ===
We only recommend to use a certificate that uses 2048 bit public key length.

== Related Articles ==
*[[Courseware:IT_Advanced_-_09_Custom_certificates]]
*[[Reference11r1:Certificate_management]]

Reference16r1:Concept App Service IP

2026-04-01T07:21:49Z

Nfi: /* Create instance */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password must be set to "pwd" for Install and will be changed during the process.

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: https://domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==

The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Docker_Container]]

Howto16r1:Firmware Upgrade V15r1 V16r1

2026-03-31T14:40:03Z

Nfi: /* New Apps */

== Applies To ==
This information applies to:

* All 16r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 16r1, see [[Howto:Firmware Upgrade]]
== Licenses ==
In case of cloud or rental model, don't worry about licenses.

If the system is licensed on premise, you'll need to regenerate the license file for v16 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. 

=== TechAssist Upgrade Helper ===
* Before you start, make sure that all TechAssist tests (you will receive the required tests in the last update in the previous major version) labelled <code>Pre Upgrade: xy</code> are positive, if available
* When you are finished, make sure that all TechAssist tests (you will receive new tests with the upgrade) are positive

=== New TLS Profile ===
Please note that we have changed our TLS profiles ([[Reference16r1:IP4/General/TLS]]). The new ''Normal'' setting, which is the default value, now only allows TLS 1.3 and TLS 1.2.

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a upgrade, as the change will be visible/audible in the behaviour of the application/device.

* ''Nothing''

== Manual steps needed after upgrade ==
If the installer is not used for a new installation, some new default settings are not set. Please evaluate per app whether you want to configure the new default settings manually.

=== Connector for Microsoft 365 ===
If you plan to use the new '''Contact Search''' feature of the Connector for Microsoft 365, you need to perform two manual Steps:
# Create the '''microsoft365-api''' app object by using the Settings template
# Assign the '''microsoft365-api''' app object to every user who should be able to use the new Contact Search feature. (Of cause, you can use a template for that)
 
For a more detailed guide, please refer to the how-to article: [[Howto16r1:Configure Contact Search by Connector for Microsoft365#Creating the PBX app object using the PBX Manager Plugin]]

=== Remote Control ===
In order to use the Admin Configuration Panel of the Settings App – AP Remote Control, it is necessary to grant access to the '''admin''' API, available in the App tab of the Remote Control App object.

=== Working ===
For badge counts to work, the Working Manager app object must have '''Websocket''' and '''PbxSignal''' enabled.
For the Connect integration of the Working app, '''Websocket''', '''Services''' and '''Connect'''(in the Apps tab) must be enabled in the Working User app.

== New Apps ==
New Apps will not be installed automatically by the upgrade. The installation description of new apps is usually in the concept article. Please rate per app whether you want to install/use the new app and configure it manually.

* App Polls: [[Reference16r1:Concept App Polls]]
* App Service Conference Transcriptions [[Reference16r1:Concept_App_Service_myApps_Assistant]]
* App Service Connector for Whatsapp: [[Reference16r1:Concept_App_Service_Connector_for_Whatsapp]]
* App Conference Scaler: [[Reference16r1:Concept_Conference_Scaler_App]]
* App Service IP: [[Reference16r1:Concept App Service IP]]

== Removed ==
The following software is no longer included.

* IP110A (can still be used with 15r1 firmware on current PBX versions)
* IP240A (can still be used with 15r1 firmware on current PBX versions)
* CA on CF card feature

== Deprecated ==
The following software is based on legacy technology, with no further development and limited maintenance and support.

* ''Nothing''

== Previously deprecated and now no longer supported ==
The following software is based on legacy technology, with no further development and no more maintenance and support.

* ''Nothing''

==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto15r1:Firmware_Upgrade_V14r2_V15r1]]
[[Category:Howto|{{PAGENAME}}]]

Reference16r1:Concept App Service IP

2026-03-27T19:47:13Z

Nfi: /* Install Process */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX)

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: https://domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==

The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Docker_Container]]

Reference16r1:Concept innovaphone App Platform Container

2026-03-27T13:40:28Z

Nfi:

Datasheet App IP

2026-03-25T14:15:43Z

Nfi:

{{datasheet_header|innovaphone App IP|Virtual communication platform}}
<div class="datasheets-mehrspaltig">
[[Image:appip.png]]
===Firmware===
* Appliance operated with firmware version 16r1 or higher
* Requires innovaphone myApps Application Platform version 140011 or higher
===Interfaces===
* Uses network connectivity of innovaphone myApps Application Platform
* optional ISDN-connectivity with ISDN-capable innovaphone gateway
===Hardware===
Hardware independent; operated on top of innovaphone Application Platform

System requirements innovaphone Application Platform depend on used hardware

Soft Conferencing (without DSP) for up to 100 voice / conference channels G.711a/u-law

Channels for the innovaphone faxserver using T.38.

===virtual innovaphone PBX===
Executed as application in innovaphone Application Platform

===Use cases===
Hosting platform – several PBX using the same HW, customer separation

Seamless scalable – ranges from entry level platform for SMEs to large enterprises

Managed services

===Voice Codecs===
G.711 A-law / µ-law

{{Gateway_Firmware_Technische_Daten_EN|appip=false}}

{{Template:Leistungsmerkmale EN - Lizenzen Gateways}}

{{Template:CE-Decl_Gateways|Conformities|see separate information sheet}}
===Order Number IPAPP license (for each port license used): 02-00043-003===
</div>
{{Template:Datasheet_footer|EN}}

[[Category:Technical Data Gateways EN|{{PAGENAME}}]]

Datasheet App IP

2026-03-25T14:14:54Z

Nfi: /* Order Number IPAP license (for each port license used): 02-00043-003 */

{{datasheet_header|innovaphone APPIP|Virtual communication platform}}
<div class="datasheets-mehrspaltig">
[[Image:appip.png]]
===Firmware===
* Appliance operated with firmware version 16r1 or higher
* Requires innovaphone myApps Application Platform version 140011 or higher
===Interfaces===
* Uses network connectivity of innovaphone myApps Application Platform
* optional ISDN-connectivity with ISDN-capable innovaphone gateway
===Hardware===
Hardware independent; operated on top of innovaphone Application Platform

System requirements innovaphone Application Platform depend on used hardware

Soft Conferencing (without DSP) for up to 100 voice / conference channels G.711a/u-law

Channels for the innovaphone faxserver using T.38.

===virtual innovaphone PBX===
Executed as application in innovaphone Application Platform

===Use cases===
Hosting platform – several PBX using the same HW, customer separation

Seamless scalable – ranges from entry level platform for SMEs to large enterprises

Managed services

===Voice Codecs===
G.711 A-law / µ-law

{{Gateway_Firmware_Technische_Daten_EN|appip=false}}

{{Template:Leistungsmerkmale EN - Lizenzen Gateways}}

{{Template:CE-Decl_Gateways|Conformities|see separate information sheet}}
===Order Number IPAPP license (for each port license used): 02-00043-003===
</div>
{{Template:Datasheet_footer|EN}}

[[Category:Technical Data Gateways EN|{{PAGENAME}}]]

Reference16r1:Concept innovaphone App Platform Container

2026-03-25T14:00:09Z

Nfi:

{{FIXME|reason=Below described feature is experimental and not officially supported for use in productive environments.}}
The innovaphone App Platform Container provides a myApps App Platform instance that includes the AP Manager, Webserver and PostgreSQL. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Applies To ==

* innovaphone App Platform Container

==Requirements==
* Host with docker on a x86_64 (amd64) platform
* innovaphone App Platform Container

==Concept==

The innovaphone App Platform Container provides the innovaphone App Platform for container environments (Open Container Initiative (OCI) format).

* The App Platform Manager and Webserver Apps are already integrated in the container and provide the already known functionality.
* Apps are installed, updated and managed as usual.
* The mount point will be used for the database, the App binaries and log files.

==Image Information==

This chapter provides details about the Docker image used for the innovaphone App Platform.

===Repository Details===

;Repository Host : registry.innovaphone.com
;Image Name : cloud/kubernetes/innovaphone-platform-instance

registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

===Tagging and Versioning===
The image is usually tagged with the build number according to innovaphone software releases:

;Latest Tag : Use the latest tag for pulling the most recent service release.

;Release Build Number : For production or version-specific deployments, use a specific build number as the tag (e.g., 130006).

Example:
docker pull registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

===Supported Architecture===
This Docker image supports the <code>linux/amd64</code> architecture.

===Image Reference===
An example of a full image reference using a specific release build number would be:
registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

==Ports==
This chapter outlines the various ports exposed by the container. The webserver ports are available immediately upon container startup, after start of the AP Manager and the Webserver, while the additional application ports become active after the app installation. In most cases, a one-to-one mapping is used, meaning the container port is mapped directly to the same host port unless otherwise specified.

===Ports < 1024===
On most docker hosts, a container won't be able to use ports below 1024, unless the container is started with higher privileges.
This shouldn't be neccessary anyways as all ports can be configured to higher ports.

===Webserver Ports===
;HTTP:
Container Port: 8080
Description: Used for accessing the built-in webserver immediately upon container startup.

;HTTPS:
Container Port: 8082
Description: Used for accessing the built-in webserver immediately upon container startup.

=== Additional Application Ports===
Following additional container ports are avilable depending on installed and configured applications:
;H323/TLS : 1300
;SIP : 5060
;SIPS : 5061
;LDAPS : 1636
;SMTP : 8025
;SMTPS : 8587
;STUN/TURN : 3478 UDP/TCP
'''Additional hint for Portmapping'''<syntaxhighlight lang="yaml" line="1">
docker run -d \
--name=innovaphone \
--restart unless-stopped \
-p 9090:8080 \ #Container Host Port (external) 9090:8080 Container Port
-p 9091:8082 \
-p 5060:5060 \
-p 5061:5061 \
-p 1300:1300 \
-p 1636:1636 \
-p 8025:8025 \
-p 8587:8587 \
-p 3478:3478 \
-p 3478:3478/udp \
-v /path/of/data/innovaphone:/mnt/data \ #in this path you will find Apps, DBs & Logs
#this path musst be used for backups!!
-e WEBSERVERPORTHTTP=8080 \
-e WEBSERVERPORTHTTPS=8082 \
-e LOG_FLAGS=7 \
-e LOG_SIZE=1048576 \
-e DNSIPV4=8.8.8.8 \
-e LIMIT_RAM=512 \ #Ram limit in MB
-e LIMIT_DISK=10 \ #disk size in GB
-e TZ=Europe/Berlin \
registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

</syntaxhighlight>

==Environment Variables (ENVs)==
This chapter outlines the key environment variables used to configure the behavior of the innovaphone App Platform Container. These variables allow you to customize logging, port settings, resource limits, and more during startup and runtime.

;LOG_FLAGS : Defines the integer representation for the trace flags of the AP Manager, according flags activated under the AP Manager / Diagnostics. See browser console message on Save button press (e.g. "logFlags":1 , if the "App" flag is activated).
LOG_FLAGS=7
;LOG_SIZE : Specifies the maximum size in bytes for logs before rotation or management actions occur. Default: 5242880.
LOG_SIZE=1048576
;WEBSERVERPORTHTTP : Sets the in-container HTTP port for the webserver. Default: 8080.
WEBSERVERPORTHTTP=8080
;WEBSERVERPORTHTTPS : Sets the in-container HTTPS port for the webserver. Default: 8082.
WEBSERVERPORTHTTPS=8443
;DNSIPV4 : Specifies the in-container DNS server IPv4 address for DNS resolution. Overrides the default container runtime DNS server.
DNSIPV4=8.8.8.8
;DNS_DOMAIN : The FQDN of the App Platform that can be used to access the app services. This optional parameter is used as a static DNS entry added to /etc/hosts. The destination IP address is the resolved IP address behind INTERNAL_DNS_DOMAIN or NAMESPACE.
DNS_DOMAIN=ap.example.com
;INTERNAL_DNS_DOMAIN : The internal FQDN of the App Platform. This FQDN is used to resolve the internal IP address of the App Platform, to be mapped from DNS_DOMAIN in /etc/hosts.
INTERNAL_DNS_DOMAIN=my-apps-deployment.my-namespace.svc.cluster.local
;NAMESPACE : The Kubernetes namespace used to build internal FQDN of the App Platform. Used with DNS_DOMAIN to map it to the IP address of ap.my-namespace.svc.cluster.local.
NAMESPACE=my-namespace
;LIMIT_RAM : Sets the RAM limit for the container, in MB, controlling how much memory it may consume. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_RAM=512
;LIMIT_DISK : Defines the disk space limit in GB for the container to manage storage consumption. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_DISK=10

==File limits==
Containers may have a default file limit per process, e.g. 1024 files. Depending on your installation and usage, this value is too small and you need to allow more, e.g. handing this in the docker run command:
--ulimit nofile=500000:500000

==Volumes and Mounts==
This container uses a dedicated internal mount path for the persistent data management across container restarts and updates.

===Internal Data Volume===
;Mount Path : <code>/mnt/data</code>
;Contents:
*Apps: Installed application binaries.
*Databases: PostgreSQL files.
*Logging: Log files for system and application events.

===Mounting===
To ensure that your data is preserved, map a host directory or Docker named volume to the container's /mnt/data path when running the container.
For example:
docker run -d -v /path/on/host:/mnt/data registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

This setup guarantees that your apps, associated data, databases, and logs persist independently of the container lifecycle.

==Entrypoint==
The container uses a fixed entrypoint:
ENTRYPOINT ["/entrypoint.sh"]

This script prepares the container and starts the AP Manager executable.

==Logging and Monitoring==
The log of the entrypoint.sh and of the AP manager is avilable as conatiner output. The installed applications store the ir log files under <code>/mnt/data/var/log/apps/</code>.

=== Unexpected high system load ===
If you encounter a high load, you need to verify whether the load is actually coming from your container. Docker containers always display the load of the physical host system.

It may be that the Docker host itself is also virtualized as an LXC container, and your Docker instances are running within it. In such a setup, the system load of the physical host is displayed because <code>/proc/loadavg</code> is not isolated per logical layer.

An increased load in the container therefore does not automatically mean that the container itself is the cause or that you have a problem at all. In short: To assess the load, you always need information (e.g., number of CPU cores or I/O information) from the physical host.

==Usage Example==
sudo docker run -d --ulimit nofile=500000:500000 --restart unless-stopped --name innovaphoneAP -p 9090:8080 -p 9091:8082 -e WEBSERVERPORTHTTP=8080 -e WEBSERVERPORTHTTPS=8082 -v $(pwd)/myapps/:/mnt/data registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

This command runs the container in detached mode with automatic restart. It names the container innovaphoneAP, maps host ports 9090 and 9091 to the container's HTTP and HTTPS ports, sets the webserver port environment variables, mounts a host directory to /mnt/data, and starts the AP Manager. After container start up the AP manager web UI is accessible via <code>http://localhost:9090</code> or <code>https://localhost:9091</code>.

Reference16r1:Concept innovaphone App Platform Container

2026-03-17T13:34:28Z

Nfi: /* Additional Application Ports */

{{FIXME|reason=Below described feature is experimental and not officially supported for use in productive environments.}}
The innovaphone App Platform Docker container provides a myApps App Platform instance that includes the AP Manager, Webserver and PostgreSQL. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Applies To ==

* innovaphone App Platform Docker Container

==Requirements==
* Host with docker on a x86_64 (arm64) platform
* innovaphone App Platform Docker Container

==Concept==

The innovaphone App Platform Docker Container provides the innovaphone App Platform for docker environments.

* The App Platform Manager and Webserver Apps are already integrated in the container and provide the already known functionality.
* Apps are installed, updated and managed as usual.
* The mount point will be used for the database, the App binaries and log files.

==Image Information==

This chapter provides details about the Docker image used for the innovaphone App Platform.

===Repository Details===

;Repository Host : docker.innovaphone.com
;Image Name : cloud/kubernetes/innovaphone-platform-instance

docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

===Tagging and Versioning===
The image is usually tagged with the build number according to innovaphone software releases:

;Latest Tag : Use the latest tag for pulling the most recent service release.

;Release Build Number : For production or version-specific deployments, use a specific build number as the tag (e.g., 130006).

Example:
docker pull docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

===Supported Architecture===
This Docker image supports the <code>linux/amd64</code> architecture.

===Image Reference===
An example of a full image reference using a specific release build number would be:
docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

==Ports==
This chapter outlines the various ports exposed by the Docker container. The webserver ports are available immediately upon container startup, after start of the AP Manager and the Webserver, while the additional application ports become active after the app installation. In most cases, a one-to-one mapping is used, meaning the container port is mapped directly to the same host port unless otherwise specified.

===Ports < 1024===
On most docker hosts, a container won't be able to use ports below 1024, unless the container is started with higher privileges.
This shouldn't be neccessary anyways as all ports can be configured to higher ports.

===Webserver Ports===
;HTTP:
Container Port: 8080
Description: Used for accessing the built-in webserver immediately upon container startup.

;HTTPS:
Container Port: 8082
Description: Used for accessing the built-in webserver immediately upon container startup.

=== Additional Application Ports===
Following additional container ports are avilable depending on installed and configured applications:
;H323/TLS : 1300
;SIP : 5060
;SIPS : 5061
;LDAPS : 1636
;SMTP : 8025
;SMTPS : 8587
;STUN/TURN : 3478 UDP/TCP
'''Additional hint for Portmapping'''<syntaxhighlight lang="yaml" line="1">
docker run -d \
--name=innovaphone \
--restart unless-stopped \
-p 9090:8080 \ #Container Host Port (external) 9090:8080 Container Port
-p 9091:8082 \
-p 5060:5060 \
-p 5061:5061 \
-p 1300:1300 \
-p 1636:1636 \
-p 8025:8025 \
-p 8587:8587 \
-p 3478:3478 \
-p 3478:3478/udp \
-v /path/of/data/innovaphone:/mnt/data \ #in this path you will find Apps, DBs & Logs
#this path musst be used for backups!!
-e WEBSERVERPORTHTTP=8080 \
-e WEBSERVERPORTHTTPS=8082 \
-e LOG_FLAGS=7 \
-e LOG_SIZE=1048576 \
-e DNSIPV4=8.8.8.8 \
-e LIMIT_RAM=512 \ #Ram limit in MB
-e LIMIT_DISK=10 \ #disk size in GB
-e TZ=Europe/Berlin \
docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

</syntaxhighlight>

==Environment Variables (ENVs)==
This chapter outlines the key environment variables used to configure the behavior of the innovaphone App Platform Docker container. These variables allow you to customize logging, port settings, resource limits, and more during startup and runtime.

;LOG_FLAGS : Defines the integer representation for the trace flags of the AP Manager, according flags activated under the AP Manager / Diagnostics. See browser console message on Save button press (e.g. "logFlags":1 , if the "App" flag is activated).
LOG_FLAGS=7
;LOG_SIZE : Specifies the maximum size in bytes for logs before rotation or management actions occur. Default: 5242880.
LOG_SIZE=1048576
;WEBSERVERPORTHTTP : Sets the in-container HTTP port for the webserver. Default: 8080.
WEBSERVERPORTHTTP=8080
;WEBSERVERPORTHTTPS : Sets the in-container HTTPS port for the webserver. Default: 8082.
WEBSERVERPORTHTTPS=8443
;DNSIPV4 : Specifies the in-container DNS server IPv4 address for DNS resolution. Overrides the default container runtime DNS server.
DNSIPV4=8.8.8.8
;DNS_DOMAIN : The FQDN of the App Platform that can be used to access the app services. This optional parameter is used as a static DNS entry added to /etc/hosts. The destination IP address is the resolved IP address behind INTERNAL_DNS_DOMAIN or NAMESPACE.
DNS_DOMAIN=ap.example.com
;INTERNAL_DNS_DOMAIN : The internal FQDN of the App Platform. This FQDN is used to resolve the internal IP address of the App Platform, to be mapped from DNS_DOMAIN in /etc/hosts.
INTERNAL_DNS_DOMAIN=my-apps-deployment.my-namespace.svc.cluster.local
;NAMESPACE : The Kubernetes namespace used to build internal FQDN of the App Platform. Used with DNS_DOMAIN to map it to the IP address of ap.my-namespace.svc.cluster.local.
NAMESPACE=my-namespace
;LIMIT_RAM : Sets the RAM limit for the container, in MB, controlling how much memory it may consume. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_RAM=512
;LIMIT_DISK : Defines the disk space limit in GB for the container to manage storage consumption. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_DISK=10

==Volumes and Mounts==
This container uses a dedicated internal mount path for the persistent data management across container restarts and updates.

===Internal Data Volume===
;Mount Path : <code>/mnt/data</code>
;Contents:
*Apps: Installed application binaries.
*Databases: PostgreSQL files.
*Logging: Log files for system and application events.

===Mounting===
To ensure that your data is preserved, map a host directory or Docker named volume to the container's /mnt/data path when running the container.
For example:
docker run -d -v /path/on/host:/mnt/data docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

This setup guarantees that your apps, associated data, databases, and logs persist independently of the container lifecycle.

==Entrypoint==
The container uses a fixed entrypoint:
ENTRYPOINT ["/entrypoint.sh"]

This script prepares the container and starts the AP Manager executable.

==Logging and Monitoring==
The log of the entrypoint.sh and of the AP manager is avilable as conatiner output. The installed applications store the ir log files under <code>/mnt/data/var/log/apps/</code>.

==Usage Example==
sudo docker run -d --restart unless-stopped --name innovaphoneAP -p 9090:8080 -p 9091:8082 -e WEBSERVERPORTHTTP=8080 -e WEBSERVERPORTHTTPS=8082 -v $(pwd)/myapps/:/mnt/data docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

This command runs the container in detached mode with automatic restart. It names the container innovaphoneAP, maps host ports 9090 and 9091 to the container's HTTP and HTTPS ports, sets the webserver port environment variables, mounts a host directory to /mnt/data, and starts the AP Manager. After container start up the AP manager web UI is accessible via <code>http://localhost:9090</code> or <code>https://localhost:9091</code>.

Reference16r1:Concept innovaphone App Platform Container

2026-03-17T13:33:33Z

Nfi: /* Additional Application Ports */

{{FIXME|reason=Below described feature is experimental and not officially supported for use in productive environments.}}
The innovaphone App Platform Docker container provides a myApps App Platform instance that includes the AP Manager, Webserver and PostgreSQL. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Applies To ==

* innovaphone App Platform Docker Container

==Requirements==
* Host with docker on a x86_64 (arm64) platform
* innovaphone App Platform Docker Container

==Concept==

The innovaphone App Platform Docker Container provides the innovaphone App Platform for docker environments.

* The App Platform Manager and Webserver Apps are already integrated in the container and provide the already known functionality.
* Apps are installed, updated and managed as usual.
* The mount point will be used for the database, the App binaries and log files.

==Image Information==

This chapter provides details about the Docker image used for the innovaphone App Platform.

===Repository Details===

;Repository Host : docker.innovaphone.com
;Image Name : cloud/kubernetes/innovaphone-platform-instance

docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

===Tagging and Versioning===
The image is usually tagged with the build number according to innovaphone software releases:

;Latest Tag : Use the latest tag for pulling the most recent service release.

;Release Build Number : For production or version-specific deployments, use a specific build number as the tag (e.g., 130006).

Example:
docker pull docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

===Supported Architecture===
This Docker image supports the <code>linux/amd64</code> architecture.

===Image Reference===
An example of a full image reference using a specific release build number would be:
docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

==Ports==
This chapter outlines the various ports exposed by the Docker container. The webserver ports are available immediately upon container startup, after start of the AP Manager and the Webserver, while the additional application ports become active after the app installation. In most cases, a one-to-one mapping is used, meaning the container port is mapped directly to the same host port unless otherwise specified.

===Ports < 1024===
On most docker hosts, a container won't be able to use ports below 1024, unless the container is started with higher privileges.
This shouldn't be neccessary anyways as all ports can be configured to higher ports.

===Webserver Ports===
;HTTP:
Container Port: 8080
Description: Used for accessing the built-in webserver immediately upon container startup.

;HTTPS:
Container Port: 8082
Description: Used for accessing the built-in webserver immediately upon container startup.

=== Additional Application Ports===
Following additional container ports are avilable depending on installed and configured applications:
;H323/TLS : 1300
;SIP : 5060
;SIPS : 5061
;LDAPS : 1636
;SMTP : 8025
;SMTPS : 8587
;STUN/TURN : 3479 UDP/TCP
'''Additional hint for Portmapping'''<syntaxhighlight lang="yaml" line="1">
docker run -d \
--name=innovaphone \
--restart unless-stopped \
-p 9090:8080 \ #Container Host Port (external) 9090:8080 Container Port
-p 9091:8082 \
-p 5060:5060 \
-p 5061:5061 \
-p 1300:1300 \
-p 1636:1636 \
-p 8025:8025 \
-p 8587:8587 \
-p 3478:3478 \
-p 3478:3478/udp \
-v /path/of/data/innovaphone:/mnt/data \ #in this path you will find Apps, DBs & Logs
#this path musst be used for backups!!
-e WEBSERVERPORTHTTP=8080 \
-e WEBSERVERPORTHTTPS=8082 \
-e LOG_FLAGS=7 \
-e LOG_SIZE=1048576 \
-e DNSIPV4=8.8.8.8 \
-e LIMIT_RAM=512 \ #Ram limit in MB
-e LIMIT_DISK=10 \ #disk size in GB
-e TZ=Europe/Berlin \
docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

</syntaxhighlight>

==Environment Variables (ENVs)==
This chapter outlines the key environment variables used to configure the behavior of the innovaphone App Platform Docker container. These variables allow you to customize logging, port settings, resource limits, and more during startup and runtime.

;LOG_FLAGS : Defines the integer representation for the trace flags of the AP Manager, according flags activated under the AP Manager / Diagnostics. See browser console message on Save button press (e.g. "logFlags":1 , if the "App" flag is activated).
LOG_FLAGS=7
;LOG_SIZE : Specifies the maximum size in bytes for logs before rotation or management actions occur. Default: 5242880.
LOG_SIZE=1048576
;WEBSERVERPORTHTTP : Sets the in-container HTTP port for the webserver. Default: 8080.
WEBSERVERPORTHTTP=8080
;WEBSERVERPORTHTTPS : Sets the in-container HTTPS port for the webserver. Default: 8082.
WEBSERVERPORTHTTPS=8443
;DNSIPV4 : Specifies the in-container DNS server IPv4 address for DNS resolution. Overrides the default container runtime DNS server.
DNSIPV4=8.8.8.8
;DNS_DOMAIN : The FQDN of the App Platform that can be used to access the app services. This optional parameter is used as a static DNS entry added to /etc/hosts. The destination IP address is the resolved IP address behind INTERNAL_DNS_DOMAIN or NAMESPACE.
DNS_DOMAIN=ap.example.com
;INTERNAL_DNS_DOMAIN : The internal FQDN of the App Platform. This FQDN is used to resolve the internal IP address of the App Platform, to be mapped from DNS_DOMAIN in /etc/hosts.
INTERNAL_DNS_DOMAIN=my-apps-deployment.my-namespace.svc.cluster.local
;NAMESPACE : The Kubernetes namespace used to build internal FQDN of the App Platform. Used with DNS_DOMAIN to map it to the IP address of ap.my-namespace.svc.cluster.local.
NAMESPACE=my-namespace
;LIMIT_RAM : Sets the RAM limit for the container, in MB, controlling how much memory it may consume. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_RAM=512
;LIMIT_DISK : Defines the disk space limit in GB for the container to manage storage consumption. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_DISK=10

==Volumes and Mounts==
This container uses a dedicated internal mount path for the persistent data management across container restarts and updates.

===Internal Data Volume===
;Mount Path : <code>/mnt/data</code>
;Contents:
*Apps: Installed application binaries.
*Databases: PostgreSQL files.
*Logging: Log files for system and application events.

===Mounting===
To ensure that your data is preserved, map a host directory or Docker named volume to the container's /mnt/data path when running the container.
For example:
docker run -d -v /path/on/host:/mnt/data docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

This setup guarantees that your apps, associated data, databases, and logs persist independently of the container lifecycle.

==Entrypoint==
The container uses a fixed entrypoint:
ENTRYPOINT ["/entrypoint.sh"]

This script prepares the container and starts the AP Manager executable.

==Logging and Monitoring==
The log of the entrypoint.sh and of the AP manager is avilable as conatiner output. The installed applications store the ir log files under <code>/mnt/data/var/log/apps/</code>.

==Usage Example==
sudo docker run -d --restart unless-stopped --name innovaphoneAP -p 9090:8080 -p 9091:8082 -e WEBSERVERPORTHTTP=8080 -e WEBSERVERPORTHTTPS=8082 -v $(pwd)/myapps/:/mnt/data docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

This command runs the container in detached mode with automatic restart. It names the container innovaphoneAP, maps host ports 9090 and 9091 to the container's HTTP and HTTPS ports, sets the webserver port environment variables, mounts a host directory to /mnt/data, and starts the AP Manager. After container start up the AP manager web UI is accessible via <code>http://localhost:9090</code> or <code>https://localhost:9091</code>.

Reference16r1:Concept App Service IP

2026-03-16T12:51:37Z

Nfi:

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX)

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: https://domain.com/ip/install.htm

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==

The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Docker_Container]]

Reference16r1:Concept App Service IP

2026-03-16T12:48:47Z

Nfi:

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
Name = ip 
Domain = customer domain (system name of the PBX)

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==

The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Docker_Container]]

How to post a successful Mantis Request

2025-10-27T10:17:33Z

Nfi: /* Fileuploads */

==Applies to==
This article is written to make your request to innovaphone support or innovaphone presales more successful.

Furthermore you help us to improve our workflow for you

== General conditions ==
Before opening a support case, please make sure that you:
* please only use one request per case
* significant subject
* do not attach any office documents including macros (file-extension "x"). instead, use pdf formatted files
* we will '''not accept''' files sent to us over other filehosters
=== Support ===
* tested the [http://store.innovaphone.com/ newest available build] on all your innovaphone device your request is for
* add in every case the Config with standard user and password
* save logs always in a .txt file and attach it to the request. Please, never paste it in to body directly
* save traces in a .pcap file and attach it to the request. Do not use the text format (as obtained in ''Maintenance/Tracing/''{''trace(buffer)'' or ''trace(continuous)''}
* if you are not sure about which trace, please ask the innovaphone team which trace is useful for this request, make sure that all other not used trace are switched off
* if possible, clear the trace before reproducing and tracing the issue
* don't send traces/logs/configs without a decent description (who calls who at which time, what happens, what should happen)

== General information ==
=== Real time support Requests ===
If you know you will have a difficult installation ahead, you may want to let us know 5 workdays before with a detailed description. If so, we might be able to schedule a support person that is dedicated to your installation and may be called right away in case of problems (call the switchboard at +49 7031 73009 0 and ask for the support person assigned to your case).

=== Access to Case History ===
Access to the current case history is available from https://portal.innovaphone.com under ''Licences tab and then Support tab''.

=== Fileuploads ===
In some cases, there will bigger files that you have to send. You can upload the files with a special file upload page for your case.
You need a ''secret link'' to get access to this page. You will find the [[File:Mantis Request 1.png|mantis_request_1.png/|mantis_request_1.png/]] in the ticket status page available via the Support link in https://portal.innovaphone.com/my/innovaphone.myportal.htm under ''Licences tab and then Support tab''. This has the additional advantage that all tickets for your company are shown.

If you want to know more about the information available in the ticket status page, please read [[ Understanding the innovaphone trouble ticket status page]]. If you have no access to portal.innovaphone.com or to your ticket status page, you can ask in the mantis case for a generated link that will allow you to upload files to your case.

=== Understanding the state "closed" ===
An important realization is that the status ''closed'' is not a final status for us. This status is also used for tickets where there is no to-do for innovaphone Support or where we may be waiting for further data or feedback.

In this respect, please note that we naturally also process cases that were resolved and then later received a response from you.

The status ''closed'' is used for the following conditions

* The problem is solved and the case is closed
* We have not received any feedback for more than 3 days

Cases with the status ''closed'' can be reopened at any time by sending a reply by E-Mail.

* The case will then be automatically reopened with the respective supporter
* File attachments are still retained (these will be removed 3 months after closing)
* The case retains all information on priority level and co

'''This means: If a case was temporarily closed, this is not a disadvantage and we and we can continue to process the case at any time.'''

==E-Mail Interface==
Here are some formal hints for successful request:
* just text in the mail body. We do not support "embedded" pictures. If you need to send screenshots etc. send them as attachment
* no attachments with names ''<number><code>.</code>{<code>bmp</code>,<code>png</code>,<code>jpg</code>}'' or ''<code>image</code><number''><code>.</code>{<code>bmp</code>,<code>png</code>,<code>jpg</code>}''
* only the text of the current mail
* free from disclaimers

Here are some hints to attach successful traces/logs/configs:
* attachment must not be bigger than 4 MB, if you have a bigger one please pack it into a zip-file or a rar-file
** if you have to upload bigger files you will find the link to the fileupload in your [[#Access to Case History|case history]]

Here are the causes why we necessarily need the information in every new posted case:

@source source of supply (from which dealer, distributor did you purchase this product)
This information is important to determine who is the right partner to support you.

@customer end customer (where is this device in productive use?)
This information is exclusively used to group separate cases which belong to the same installation and thus shall considered as a whole.

If you have with this issue problems with data protection, you can give your customer an alias, but make sure that you have always the same alias for one customer.

===Valid TAGS===
See below a summary over all valid tags:

Tag Required* Description
---------------------------------------------------------------------------------------------------------
@aiglobal no possible values are: 0, 1, false, true (default is "false")
For faster processing and resolution, you can allow the use of AI services operated outside the EU in this case
@customer no end customer (project)
@source no source of supply
@phone no Reporters phone number
@cc no Additional CCs (separated by comma)
@email no Email to communicate with (if you write from a strange mail account,
you can set your company email address)
@name no Name of person to communicate with (if you write from a strange mail account)
@status no New State for Issue (for internal use)
@assign no Mantis user ID of Handler (for internal use)
@project no Project to assign case to (for internal use)
@summary no Description (for a extra short summery)
@sendalways no Acknowledge the receipt of each message - not only new cases
@sendnever no Never send ack messages - not even for new cases
@precedence no User defined priority (A, B, C)
* for submittal of new cases

Please note that email, status, assign are available for innovaphone employees only.

===Case Number===

Please make sure that all communication to a case contains the case number.

In the following you see the format for the example ticket number: 1234

Provide this number, ###1234###, with exactly this syntax in the subject line of your email to ensure that all information gets posted to the correct case.

The email address for all replies is always support@innovaphone.com or presales@innovaphone.com, never the personal account of innovaphone presales or support staff.

The best thing is always to use the reply function in your mailer.

=== Replying to a Case ===
To cut down on text size in our issue tracking database, original emails sent to the customer are removed from the customer replies. This is done by searching for a line like

~~+~~ Do NOT answer/change/comment below this line ~~+~~ Bitte nicht unterhalb dieser Zeile antworten ~~+~~

Everything below this line is removed. This means you must not put any comments or answers below this line, as it will not be received by us. If you need to quote the text you have received by us, then please copy and paste it to the top so it will be before the above mentioned line.

===Known Problems===
==== Embedded Pictures ====
'''You must not send emails with ''embedded pictures'' (pictures just pasted into the email body) as mantis will remove those'''. Instead, attach them as separate files.

==== Removal of Decoration ====
Our ticketing system will remove all pictures attached to the email which are considered ''decoration'' (such as logo companies etc.). The heuristic to detect such images is quite straight forward: all image (.png, .bmp, .jpg, .gif) files whose name start with a ''hexadecimal'' number (e.g <code>0001.png</code> or <code>b1.png</code> or <code>B1.png</code> but not <code>g1.png</code>) or with the word ''image'' followed by a hexadecimal number (e.g. <code>image01.gif</code>) are considered ''decoration''.

==== Embedded comments ====
Our ticketing system will do an effort to remove all text we sent to you in any response you send to us. The strategy is quite simple. When sending out an email to you, it will add a line like <code>~~+~~ Do NOT answer/change/comment below this line ~~+~~ Bitte nicht unterhalb dieser Zeile antworten ~~+~~</code> at the top of the text. When receiving email from you, it will remove any text after such line. In effect, all text we sent to you and returned to us in your response will be removed before storing your response in our database. So if you want to response with comments interspersed with our original text, you must first remove this line. Otherwise you simply put your response before this line.

==Web Interface==
The Interface is embedded in your Portal at https://portal.innovaphone.com/
=== Direct Access ===
You can access the interface directly via Browser or your own App-Object with the URL <code>https://mantis.innovaphone.com/create</code>.
;URL Parameters
:scheme: light (default), dark
:email: pre-filled E-Mail Address

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

How to post a successful Mantis Request

2025-10-27T10:17:09Z

Nfi:

==Applies to==
This article is written to make your request to innovaphone support or innovaphone presales more successful.

Furthermore you help us to improve our workflow for you

== General conditions ==
Before opening a support case, please make sure that you:
* please only use one request per case
* significant subject
* do not attach any office documents including macros (file-extension "x"). instead, use pdf formatted files
* we will '''not accept''' files sent to us over other filehosters
=== Support ===
* tested the [http://store.innovaphone.com/ newest available build] on all your innovaphone device your request is for
* add in every case the Config with standard user and password
* save logs always in a .txt file and attach it to the request. Please, never paste it in to body directly
* save traces in a .pcap file and attach it to the request. Do not use the text format (as obtained in ''Maintenance/Tracing/''{''trace(buffer)'' or ''trace(continuous)''}
* if you are not sure about which trace, please ask the innovaphone team which trace is useful for this request, make sure that all other not used trace are switched off
* if possible, clear the trace before reproducing and tracing the issue
* don't send traces/logs/configs without a decent description (who calls who at which time, what happens, what should happen)

== General information ==
=== Real time support Requests ===
If you know you will have a difficult installation ahead, you may want to let us know 5 workdays before with a detailed description. If so, we might be able to schedule a support person that is dedicated to your installation and may be called right away in case of problems (call the switchboard at +49 7031 73009 0 and ask for the support person assigned to your case).

=== Access to Case History ===
Access to the current case history is available from https://portal.innovaphone.com under ''Licences tab and then Support tab''.

=== Fileuploads ===
In some cases, there will bigger files that you have to send. You can upload the files with a special file upload page for your case.
You need a ''secret link'' to get access to this page. You will find the [[File:Mantis Request 1.png|Fileupload link|mantis_request_1.png/]] in the ticket status page available via the Support link in<nowiki/>https://portal.innovaphone.com/my/innovaphone.myportal.htm under ''Licences tab and then Support tab''. This has the additional advantage that all tickets for your company are shown.

If you want to know more about the information available in the ticket status page, please read [[ Understanding the innovaphone trouble ticket status page]]. If you have no access to portal.innovaphone.com or to your ticket status page, you can ask in the mantis case for a generated link that will allow you to upload files to your case.

=== Understanding the state "closed" ===
An important realization is that the status ''closed'' is not a final status for us. This status is also used for tickets where there is no to-do for innovaphone Support or where we may be waiting for further data or feedback.

In this respect, please note that we naturally also process cases that were resolved and then later received a response from you.

The status ''closed'' is used for the following conditions

* The problem is solved and the case is closed
* We have not received any feedback for more than 3 days

Cases with the status ''closed'' can be reopened at any time by sending a reply by E-Mail.

* The case will then be automatically reopened with the respective supporter
* File attachments are still retained (these will be removed 3 months after closing)
* The case retains all information on priority level and co

'''This means: If a case was temporarily closed, this is not a disadvantage and we and we can continue to process the case at any time.'''

==E-Mail Interface==
Here are some formal hints for successful request:
* just text in the mail body. We do not support "embedded" pictures. If you need to send screenshots etc. send them as attachment
* no attachments with names ''<number><code>.</code>{<code>bmp</code>,<code>png</code>,<code>jpg</code>}'' or ''<code>image</code><number''><code>.</code>{<code>bmp</code>,<code>png</code>,<code>jpg</code>}''
* only the text of the current mail
* free from disclaimers

Here are some hints to attach successful traces/logs/configs:
* attachment must not be bigger than 4 MB, if you have a bigger one please pack it into a zip-file or a rar-file
** if you have to upload bigger files you will find the link to the fileupload in your [[#Access to Case History|case history]]

Here are the causes why we necessarily need the information in every new posted case:

@source source of supply (from which dealer, distributor did you purchase this product)
This information is important to determine who is the right partner to support you.

@customer end customer (where is this device in productive use?)
This information is exclusively used to group separate cases which belong to the same installation and thus shall considered as a whole.

If you have with this issue problems with data protection, you can give your customer an alias, but make sure that you have always the same alias for one customer.

===Valid TAGS===
See below a summary over all valid tags:

Tag Required* Description
---------------------------------------------------------------------------------------------------------
@aiglobal no possible values are: 0, 1, false, true (default is "false")
For faster processing and resolution, you can allow the use of AI services operated outside the EU in this case
@customer no end customer (project)
@source no source of supply
@phone no Reporters phone number
@cc no Additional CCs (separated by comma)
@email no Email to communicate with (if you write from a strange mail account,
you can set your company email address)
@name no Name of person to communicate with (if you write from a strange mail account)
@status no New State for Issue (for internal use)
@assign no Mantis user ID of Handler (for internal use)
@project no Project to assign case to (for internal use)
@summary no Description (for a extra short summery)
@sendalways no Acknowledge the receipt of each message - not only new cases
@sendnever no Never send ack messages - not even for new cases
@precedence no User defined priority (A, B, C)
* for submittal of new cases

Please note that email, status, assign are available for innovaphone employees only.

===Case Number===

Please make sure that all communication to a case contains the case number.

In the following you see the format for the example ticket number: 1234

Provide this number, ###1234###, with exactly this syntax in the subject line of your email to ensure that all information gets posted to the correct case.

The email address for all replies is always support@innovaphone.com or presales@innovaphone.com, never the personal account of innovaphone presales or support staff.

The best thing is always to use the reply function in your mailer.

=== Replying to a Case ===
To cut down on text size in our issue tracking database, original emails sent to the customer are removed from the customer replies. This is done by searching for a line like

~~+~~ Do NOT answer/change/comment below this line ~~+~~ Bitte nicht unterhalb dieser Zeile antworten ~~+~~

Everything below this line is removed. This means you must not put any comments or answers below this line, as it will not be received by us. If you need to quote the text you have received by us, then please copy and paste it to the top so it will be before the above mentioned line.

===Known Problems===
==== Embedded Pictures ====
'''You must not send emails with ''embedded pictures'' (pictures just pasted into the email body) as mantis will remove those'''. Instead, attach them as separate files.

==== Removal of Decoration ====
Our ticketing system will remove all pictures attached to the email which are considered ''decoration'' (such as logo companies etc.). The heuristic to detect such images is quite straight forward: all image (.png, .bmp, .jpg, .gif) files whose name start with a ''hexadecimal'' number (e.g <code>0001.png</code> or <code>b1.png</code> or <code>B1.png</code> but not <code>g1.png</code>) or with the word ''image'' followed by a hexadecimal number (e.g. <code>image01.gif</code>) are considered ''decoration''.

==== Embedded comments ====
Our ticketing system will do an effort to remove all text we sent to you in any response you send to us. The strategy is quite simple. When sending out an email to you, it will add a line like <code>~~+~~ Do NOT answer/change/comment below this line ~~+~~ Bitte nicht unterhalb dieser Zeile antworten ~~+~~</code> at the top of the text. When receiving email from you, it will remove any text after such line. In effect, all text we sent to you and returned to us in your response will be removed before storing your response in our database. So if you want to response with comments interspersed with our original text, you must first remove this line. Otherwise you simply put your response before this line.

==Web Interface==
The Interface is embedded in your Portal at https://portal.innovaphone.com/
=== Direct Access ===
You can access the interface directly via Browser or your own App-Object with the URL <code>https://mantis.innovaphone.com/create</code>.
;URL Parameters
:scheme: light (default), dark
:email: pre-filled E-Mail Address

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

Main Page

2025-06-12T06:40:38Z

Nfi: Wrong protocol HTTP -> HTTPS

__NOTOC__

<div style="margin:0px; margin-right:10px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0em 1em;">
== Remote Support ==
[[Image: RemoteControl.png|left|50px|remotecontrol.png/|remotecontrol.png/]]
As Remote Support Tool, we use our own product [https://www.innovaphone.com/en/all-apps/apps-to-work-with/remote-control-app.html Remote Control]. innovaphone only carries out scheduled remote maintenance via our ticket system by prior consultation.

You will receive a support link from our support team, which you can use to download and install the necessary client.

After you have opened [https://store.innovaphone.com/alpha/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe the client], you can enter the support link and then join the session.

== Searching ==
Searching in wiki works, but is sometimes cumbersome. However, you can have Google do the job for you. Try [https://www.google.de/search?q=site%3Ainnovaphone.com+xml+documentation <code>site:innovaphone.com your search terms</code>] to search the innovaphone sites for matches!

If you still don't find what you are looking for, [mailto:presales@innovaphone.com drop us a message]
</div>


<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">



== Latest News ==

[[User:Cam&action=edit&redlink=1|Cam]] ([[User talk:Cam&action=edit&redlink=1|talk]]) 09:33, 9 June 2025 (CEST) [[Support:Firmware V15r1 product/15r1/firmware 1510490 (sr 3) available| Version 15r1 Service Release 3]] is now available from the [https://store.innovaphone.com/release/download.htm App Store].

[[User:Cam&action=edit&redlink=1|Cam]] ([[User talk:Cam&action=edit&redlink=1|talk]]) 09:33, 9 June 2025 (CEST) [[Support:Firmware V14r2 product/14r2/firmware 1420515 (sr 11) available| Version 14r2 Service Release 11]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Cam&action=edit&redlink=1|Cam]] ([[User talk:Cam&action=edit&redlink=1|talk]]) 09:33, 9 June 2025 (CEST) [[Support:Firmware V13r3 product/13r3/firmware 138026 (sr 28) available| Version 13r3 Service Release 28]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Tfu|Tfu]] ([[User talk:Tfu&action=edit&redlink=1|talk]]) 15:28, 13 March 2025 (CEST)
[[Support:Wireless Handset Firmware IP73 1012 (6.1.13) released| Wireless Handset Firmware IP73 1012 (6.1.13) released]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2) released| Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware D83 10002 (2.0.5) released| Wireless Handset Firmware D83 10002 (2.0.5)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 15:38, 6 February 2023 (CET)
[[Support:Wireless Handset Firmware IP62 3040621 (6.2.7) released| Wireless Handset Firmware IP62 3040621 (6.2.7)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 13:13, 6 February 2023 (CET)
[[Support:WinPDM Software 3130113 (4.1.8) released| WinPDM Software 3130113 (4.1.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 12:46, 16 June 2021 (CEST))
[[Support:TAPI Service Provider 8188 (hotfix21) available|TAPI Service Provider 8188 (hotfix21)]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 18:21, 12 October 2020 (CEST)
[[Support:Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8) released| Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 21:30, 27 March 2020 (CET)
[[Support:Wireless Handset Firmware and Management Software product/9.00/wireless 100037 (hotfix19) available| Wireless Package hotfix 19]] is now available from the [http://download.innovaphone.com/ice/9.00#wireless V9 download area].

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">

== New Articles ==

{{Special:Newestpages/all/20}}
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em; font-size:1">
== More innovaphone Ressources ==
* [http://www.innovaphone.com Home Page]
* [http://download.innovaphone.com Download Site ]
* [http://my.innovaphone.com my.innovaphone ]
* [http://mantis.innovaphone.com/ Ticketing System ]
</div>

Reference14r2:MyApps Plugin for Virtual Desktops

2025-06-03T09:39:40Z

Nfi:

[[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) 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.
 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:Apps/PbxManager/App Fax

2025-05-06T08:14:14Z

Nfi: /* SMTP configuration */

This page describes the PBX Settings Plugin of the Fax App.

The fax app service can be configured and user apps can be added, configured or deleted with this PBX Settings Plugin of the fax app. The app service provides user fax apps:
* with a personal account.
* with a group account.

The fax service applies the fax configuration like subscriber name of a fax object for fax calls to and from this fax object. Therefore each fax object must have access to a fax interface resource to send and receive fax calls. A fax interface should be registered to the first app object; further app objects can also use this fax interface if the first app object is configured as external resource in these app objects.

== App Service Configuration ==
=== Change configuration ===
* '''Delete fax jobs automatically''': Fax jobs of all users with a certain age in days can be automatically deleted by the system if configured.
* '''Send with high resolution''': The fax service tries to send with 400dpi if this is enabled. If the destination party does not support the high quality, the outgoing document is created again with a 200dpi resolution and the call is retried.

=== Default settings for mail notifications ===
* '''Incoming notification''': generate email on incoming fax
* '''Forwarding as PDF''': forward received fax as PDF attachment
* '''Transmission confirmation''': generate email on fax transmission
* '''Transmission report as PDF''': generate email with send report as PDF attachment
* '''Error notification''': generate email on errorneous fax transmission
* '''Language''': set email language. Supported values are ba, ca, cs, da, de, en, es, et, eu, fi, fr, hr, hu, it, lv, mk, nl, no, pl, pt, ro, rs, si, sv, th, tr; non-supported values are replaced by en.
* '''Timezone''': set email timezone according to [https://www.iana.org/time-zones IANA definitions]. For a better overview you may refer to [https://www.iplocate.com/de/resources/timezones/list-of-timezones this page].
Pre-set default for language and timezone are the administrator values.

=== SMTP server configuration ===
The email receiving for the Mail2Fax feature can be enabled and the authentication configured here:
* '''E-mail reception''': To be turned on.
* '''Domain''': Used to filter the recipient address of the received mails' address list. If not set, the configured app domain of the app service is used.
* '''User name''': The login name for the SMTP authentication.
* '''Password''': The password for the SMTP authentication.

=== SMTP configuration ===
Required data for outgoing emails:
* '''Host name''': Resolvable DNS name or an [https://datatracker.ietf.org/doc/html/rfc2821#section-4.1.3 IP address literal] of your app platform with the SMTP client (e.g. [123.255.37.2]). If the SMTP server (e.g. public SMTP server) is connected through a NAT router, a DNS name or an IP address is to be used which resolves to the NAT router's public IP.
* '''Server[:port]''': Resolvable DNS name or an IP address of the used SMTP server plus optional port separated by ':'.
* '''User name''': The login name of a valid user account at the SMTP server (recommended).
* '''Password''': The password of the SMTP user account (recommended).
* '''Sender address''': The email address of the sender in sent emails.
* '''Sender name''': The name of the sender in sent emails.
[https://sdk.innovaphone.com/13r2/sdk/common/interface/smtp.htm#Example Values according to SMTP integration]

=== HTTP API ===
* '''Key''': key for HTTP post command authentication. For details, refer to the [[{{NAMESPACE}}:Concept_App_Service_Fax#App_API|API concept]].

=== Customized texts ===
Options for text modifications of sent emails:
* For incoming documents
* For successfully sent documents
* For transmission errors

The email body is supposed to be a HTML-formatted text generated by e.g. an email program. The mail subject is plain text. Following placeholders can be used both within the subject and the body:
* $1: The long name of PBX user
* $2: The remote (contact) name, the remote number or anonymous
* $3: The remote number
* $4: The page count
* $5: The call count (only within the error mail)
* $6: The error cause (only within the error mail)
* $7: The error description (only within the error mail)

===== HTML email body example for a transmission confirmation email =====

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0;"/>
</head>
<body>
<<nowiki>h1>Fax: Transmission successful</h1>
Fax was successfully transmitted
Name of sender: $1
Name of recipent: $2
Number of recipent: $3
Sent pages: $4<</nowiki>/p>
</body>
</html>

=== Mail background logo ===
* '''Include picture''': add myApps background logo in all HTML mail bodies
* '''Custom picture''': Base64-encoded data-image for customized background logo

== Individual Fax App Configuration ==
Following items can be configured in a PBX Fax object (including fax group objects):

* '''Name''': Object long name
* '''SIP''': Object name. Allowed characters according to the [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.
* '''Number''': Object number to be prepended for fax calls.
* '''International fax number''': Printed in the headline of fax document. The user (send) number is added, but not the node number.
* '''Company name''': Printed in the headline of fax document.
* Email addresses: The email addresses of the PBX object. They can be used for email notifications of the app service.
=== FAX interface ===
Selection of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|fax-capable devices]] available in the system. For the interface search, the user needs access to the DevicesApi app.
* '''Device name''': Name of the device as defined in the Devices App
* '''Hardware ID''': Serial number (MAC) of a device
* '''Product''': innovaphone device model
* '''Available channels''': Amount of offered fax channels
* '''T.38 allowed''': T.38 codec for the fax transmission allowed
* '''Audio fax allowed''': Audio codecs (G.711) for the fax transmission allowed. Availability depends on the device type. Two DSP channels are needed for each used fax channel.
=== External resource ===
The H.323 name of another reachable PBX Fax-object as call destination, which provides a registration to an innovaphone FAX interface endpoint.
* For fax objects: This is only used if no fax interface is registered.
* For group fax objects: This is a '''mandatory''' option, and a fax object can be selected. You can also select another group fax object (which has selected a working fax object).
=== Node and PBX ===
The PBX and node configuration of the PBX object. Node numbers are considered for the calling party numbers.
=== Default Recipient ===
Faxes are received for this user or this fax group. If no personal fax number is appended, the number is not assigned or the assigned user has no fax license.
=== Header of fax pages ===
A header line preset for a language can be selected or the header line can be individually modified. Usable variables are listed [[{{NAMESPACE}}:Gateway/Interfaces#Headline|here]].
=== Configuration Templates ===
Select configuration templates to be applied for the fax app object

Howto:Community Platform

2025-01-20T11:17:38Z

Nfi: /* Which official channels are used? */

==What is the Community Platform==
We operate our own platform for all community activities at: https://community.innovaphone.com/

On the one hand, many functions are made available there for demo purposes, and on the other hand, we use the [https://community.innovaphone.com/PBX0/APPCLIENT/1410520/appclient.htm?app=connect Connect App] to stay in contact with partners and end customers, receive feedback and offer a platform for discussion and exchange.

==More Information==
===How can I get an account?===
Anyone can register an account [https://community.innovaphone.com/ here].

===What content is this platform used for?===
We will bring together our various services on this platform.

We currently use the community platform for the following services:
* Beta programs for new software versions
* Information on technical information, alerts and new releases (additionally to Twitter/X "innovaphone Tech")

=== Which official channels are used? ===
; XX Beta
: You will find a suitable channel for every official beta program. Example ''14r1 Beta'' or ''14r2 Beta''
; Tech-News
: Information on releases, new products, new wiki articles, and more
;Tech-Discussions
: Discussions about all technical related topics
;Training-Discussions
: Discussions about all training related topics
;Sales-Discussions
: Discussions about all sales related topics
;SDK-Discussions
: Discussions about all innovaphone Apps SDK related topics
;Ideas
: Suggestions related to upcoming versions
;Activités en France (Activities in France)
: Find all the communication about the different innovaphone activities in France

=== For a better overview - first line in the first post ===
To identify the topic of a post more quickly, we recommend the following procedure.

The first line of a new post should contain all relevant points.

This could look like this, for example:

Area e.g. #idea

Product e.g. #recordings

Topic e.g. second datastore
'''#idea #recordings second datastore'''

=== How to add and use a Channel? ===

{|
|
|-
| 1. Go to "Channels" 2. Click on a channel [[File:Channels.png|frameless|channels.png/]] ||     || 1. Click on the three dots 2. Click "Pin channel" [[File:Pin.png|frameless|pin.png/]]
|}

After that, you find the Channel in your "Home" and can read/post on this Channel easily. If you would like to be actively informed about new posts, you can also use the ""Follow function (under the Pin channel)

=== How can I be actively notified about new content? ===
You can be notified about new "followed content" in the Connect App via push on your smartphone and/or browser, or by e-mail. To do this, you can simply use the standard function in the Connect App.

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

Reference13r1:Concept App Service Yealink

2024-12-18T18:33:32Z

Nfi: /* Configuration */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access
* Interval for phone updates
* Timeserver and timezone
* Device Admin account credentials
* Media Relay option for the HW-ID
* SIP protocol (TCP or TLS)
* HTTP(S) protocol for provisioning access

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

[[File:RPS-account.png|alt=RPS account|thumb|rps-account.png/|rps-account.png/]]
Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:

* Your own RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access

* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
**Device Admin account credentials
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference13r1:Concept App Service Yealink

2024-12-18T18:31:33Z

Nfi: /* Configuration */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access
* Interval for phone updates
* Timeserver and timezone
* Device Admin account credentials
* Media Relay option for the HW-ID
* SIP protocol (TCP or TLS)
* HTTP(S) protocol for provisioning access

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

[[File:RPS-account.png|alt=RPS account|thumb|rps-account.png/|rps-account.png/]]
Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:

* Your own RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')

* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
**
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference13r1:Concept App Service Yealink

2024-12-18T18:30:37Z

Nfi: /* Apps */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access
* Interval for phone updates
* Timeserver and timezone
* Device Admin account credentials
* Media Relay option for the HW-ID
* SIP protocol (TCP or TLS)
* HTTP(S) protocol for provisioning access

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

[[File:RPS-account.png|alt=RPS account|thumb|rps-account.png/]]
Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:

* Your own RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')

* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference13r1:Concept App Service Yealink

2024-12-18T18:30:13Z

Nfi: /* Configuration */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
[[File:RPS-account.png|thumb|rps-account.png/|rps-account.png/]]

=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access
* Interval for phone updates
* Timeserver and timezone
* Device Admin account credentials
* Media Relay option for the HW-ID
* SIP protocol (TCP or TLS)
* HTTP(S) protocol for provisioning access

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

[[File:RPS-account.png|alt=RPS account|thumb]]
Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:

* Your own RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')

* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference13r1:Concept App Service Yealink

2024-12-18T18:25:21Z

Nfi: /* Yealink App (innovaphone-yealink) */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
[[File:RPS-account.png|thumb|rps-account.png/]]

=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access
* Interval for phone updates
* Timeserver and timezone
* Device Admin account credentials
* Media Relay option for the HW-ID
* SIP protocol (TCP or TLS)
* HTTP(S) protocol for provisioning access

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:
* Your own RPS account
* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference13r1:Concept App Service Yealink

2024-12-18T18:19:08Z

Nfi: /* Yealink App (innovaphone-yealink) */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
[[File:RPS-account.png|thumb]]

=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Interval for phone updates
* Timeserver and timezone
* SIP protocol (TCP or TLS)

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:
* Your own RPS account
* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

File:RPS-account.png

2024-12-18T18:18:29Z

Nfi:

RPS Account

Reference13r1:Concept App Service Yealink

2024-12-18T17:27:53Z

Nfi: /* Yealink App (innovaphone-yealink) */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Interval for phone updates
* Timeserver and timezone
* SIP protocol (TCP or TLS)

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:
* Your own RPS account
* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference13r1:Concept App Service Yealink

2024-12-18T17:27:18Z

Nfi: /* Yealink App (innovaphone-yealink) */

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. The default login credentials should only be used for testing purposes.)
* Interval for phone updates
* Timeserver and timezone
* SIP protocol (TCP or TLS)

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:
* Your own RPS account
* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|Provisioning App Workflow|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|RPS history tab|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|Devices tab|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|Trusted Certificates|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference14r2:Concept myApps platform services

2024-09-17T16:23:00Z

Nfi: /* Device handling */

[[Category:Concept|myApps]]

myApps platform services provide various operating system specific services which can be used by other ''Apps'' running in the [[{{NAMESPACE}}:Concept myApps|myApps client]]. Those services typically are not available in the browser's JavaScript environment and hence must be implemented in native platform code. Therefore, the platform services are installed as native executable on the respective platform.

When myApps is started in a web browser (and hence has no access to the platform services), some Apps will use [https://en.wikipedia.org/wiki/WebRTC WebRTC] services implemented by the browser instead. For ease of reference, features available in this scenario are also described here.

On windows, the platform services also come with their own web browser in which the myApps web App will be started then. This browser is based on google's [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium] open source software.
= Applies To =

* [[{{NAMESPACE}}:Concept myApps|myApps]]
* myApps for Windows
* myApps for macOS
* myApps for iOS
* myApps for Android

* myApps Web App (WebRTC)
version 14r2

=Features=
Not all features are available or required on all platforms.
{|
! style="text-align: left; font-weight: bold" | Feature

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

! 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 || manage local audio devices to record and playback audio conversations || ✔ || ✔ || ✔ || ✔ || ✔ (audio available but devices managed by web browser)
|-

| video || manage local displays and cameras to capture and render video live stream || ✔ || ✔ || ✔ || ✔ || ✔ (video available but devices managed by web browser)

|-

| ringer || manage local ringing device || ✔ || ✔ || ✔ || ✔ || ✔
|-

| application sharing

|-

|   presenter || share an application || ✔ || ✗ || ✔ || ✔ || ✔
|-

|   consumer || view an application shared by the peer || ✔ || ✔ || ✔ || ✔ || ✔

|-

| hot keys || capture key presses for quick invocation of phone apps (e.g. dial selected number) || ✔ || ✗ || ✗ || ✔ || ✗
|-
| tel: and sip: URI handler || intercept clicks on tel: and sip: links in web sites to invoke phone apps || ✔ || ✔ || ✔ || ✔ || ✗

|-
| user activity || set presence state according to user activity || ✔ || ✗ || ✗ || ✔ || ✔<ref>limited, see [[#User_activity|User activity]] below</ref>

|-

| docking || myApps can be docked persistently to the right or left edge of your screens || ✔ || ✗ || ✗ || ✗ || ✗

|-

| multi-windowing|| Apps can be launched in separate windows|| ✔ || ✗ || ✗ || ✔ || ✗

|-

| recording|| Calls can be recorded to recording app|| ✔ || ✔ || ✔ || ✔ || ✗

|-
| notifications || ||
|-
|   display notifications || display notifications with OS standard mechanism || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   push notifications || receive push notifications while myApps is not running || ✗ || ✔ || ✔ || ✔ || ✔<ref>The browser needs to be running in order to receive push notifications.</ref>
|-
|   chat and apps || display notifications for chat and other apps || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   calls || display notifications for incoming calls || ✔ || ✔ || ✔ || ✔ || ✗<ref>Call notifications are only displayed locally while the phone or softphone app is started.</ref>
|-

| phone book access || access local phone book || ✔ || ✔ || ✔ || ✔ || ✗
|-
| office presence provider || maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗ || ✗
|-

| external application start || start arbitrary external applications for calls || ✔ || ✗ || ✗ || ✔ || ✗

|-

| app proxy|| a caching proxy that provides app persistence || ✔ || ✔ || ✔ || ✔ || ✗

|-

| auto update || automatically updates myApps platform services to the same version the PBX has || ✔ || ✔ || ✗ || ✔ || ✔<ref>The then-current web app is always loaded from the PBX upon startup and hence up-to-date by definition</ref>
|-

| three party conference || initiate 3-pty-conference using Softphone-App || ✔ || ✔ || ✔ || ✔ || ✗

|-
| exclude VPN || disable use of VPN connections for audio/video/appsharing || ✔ || ✔ || ✔ || ✔ || ✗

|}

<references/>

=Requirements=
* innovaphone PBX 14r2 and up

== Hardware ==
Recommended hardware requirements
* Processor: Dual-core 2Ghz or higher
* RAM: 4 Gb

== myApps for Windows ==
* Windows 10 and up
* Windows Server 2016 and later versions

=== 32 & 64 bit Windows ===
* 32 bit Windows: install the myAppsSetup32.msi from the App Store
* 64 bit Windows: install the myAppsSetup.msi from the App Store
** the 64 bit variant still installs into Program Files (x86), as the main myApps.exe is still a 32bit application
** the 64 bit variant just contains an additional 64 bit binary for the outlook search

=== Windows N editions ===

Windows N editions are missing the ''Media Feature Pack'' which is pre installed on other Windows versions.

Please install the pack from [https://www.microsoft.com/en-us/software-download/mediafeaturepack Microsoft (Windows 10 pack)] before you install myApps. The installer will check if the file <code>C:\Windows\SysWOW64\mfplat.dll</code> exist on your system.

Make sure to install the correct pack depending on your Windows version! There are different packs for Windows 10 1703, 1803, 1809 and 32bit or 64bit etc.

NB: Sometimes the myApps installation will not work even though the media pack is already installed. This is because the installer has no read access to check if the package is already installed. If the above-mentioned file exists and the installer asks to install the Windows Media Feature Pack nevertheless, you have to start the myApps install with administrative rights.

=== Terminal Server environments ===

Audio driver was removed if myApps discovers that it is running in a terminal server environment like Citrix.

The audio driver is needed for the Softphone App but the Softphone App should not use an audio driver at the server side because the audio devices are plugged locally and there would be a delay sending and receiving audio data with the server.

If a customer wants to use the Softphone App at the server side he needs to make use of the myApps Plugin for virtual desktops solution:

[[{{NAMESPACE}}:MyApps_Plugin_for_Virtual_Desktops]]

== myApps for macOS ==
* macOS 10.13 or higher

== myApps for iOS ==
* iOS 12 or higher

== myApps for Android ==
* Android 6.0 or higher. Android 6.x may need an update of the Chrome browser.

= Licenses =
* No license needed for myApps platform services

= Overview =
myApps platform services is a native executable that is installed using the standard mechanisms on the respective operating system. It provides various advanced services which can be used by the myApps web client code as well as the Apps running in the myApps context.

Also, on Windows, the platform services come with their own, dedicated browser to run myApps in. This browser is based on [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium]. On iOS, macOS and Android, it is based upon native embedded web view facilities (such as WKWebView) instead.
== Components ==

=== RTP service for audio, video and data ===
The RTP service provides audio, video and data (app sharing) VoIP RTP endpoints (e.g. for softphones). It supports STUN, TURN, ICE, SRTP, DTLS. Note however that unlike WebRTC, these endpoints do not ''require'' ICE and DTLS. In other words, they can communicate also with non-compliant (i.e. older) VoIP devices.

Note that the available capabilities when not running the myApps platform services depend on the used browser's WebRTC implementation. See your browser documentation for details.

Apps can request RTP channels using the [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol]'s ''AllocChannel'' message.

===== RTP ports=====

{|

| audio || 50000 -> 50099

|-

| video || 50100 -> 50199

|-

| data || 50200 -> 50299

|}

The RTP service will enumerate all local interfaces and create local HOST candidates for ICE. There is an option however to disregard VPN interfaces (more precisely such interfaces with type of ''IF_TYPE_PPP'' or ''IF_TYPE_TUNNEL''). This can eliminate quality issues when RTP data is transmitted through TCP based VPN tunnels.

SRFLX and RELAY candidates are obtained using the STUN and TURN server configuration passed by the App (e.g the ''softphone'' App) as part of the ''AllocChannel'' request.
<code>{"mt":"AllocChannel","channel":"81429cba-396d-43de-8a76-ec020ba8796e","iceServers":[{"urls":"turn:myturn.domaincom:4077?transport=udp","username":"turnuser","credential":"pwd","credentialType":"password"},{"urls":"stun:mystun.domain.com:4077"}],"dn":"Foo Bar","type":"RemoteRtp","kind":"video"}</code>

===== Codecs =====

The installed myApps launchers provide codecs that can be used by softphone apps for media streams. When running in a web browser the codecs depend on the browser version and operating system. See the documentation of your browser for details.

The following codecs are supported:

{|
!style="text-align:left;width:100px;"|Codec
!style="width:100px"|Windows-Launcher
!style="width:100px"|Android
!style="width:100px"|iOS
!style="width:100px"|macOS
!style="width:100px"|Firefox (Browser)
!style="width:100px"|Chrome (Browser)
!style="width:100px"|Edge (Browser)
!style="width:100px"|Safari (Browser)
!style="width:100px"|Opera (Browser)
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Audio
|-
|G711A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G711u
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G722
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G729
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729B
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729AB
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|[https://caniuse.com/#search=Opus OPUS-NB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|[https://caniuse.com/#search=Opus OPUS-WB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Video
|-
|[https://caniuse.com/#search=VP8 VP8]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|-
|[https://caniuse.com/#search=VP9 VP9]
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|-
|[https://caniuse.com/#search=H264 H264]
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Application Sharing
|-
|Share
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|Watch
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|}

''* small presentation only'' 
''** only for 1:1 calls, not for conferences

===== Video capture =====

The default resolution for video capture is 1280x720 if available. Otherwise, 640x480, 352x288 or 320x240 will be used. The frame rate is 30 fps if available, otherwise 15 fps. The resulting average bandwidth could reach 1 Mbps.

===== Application sharing =====

Screen content will be transmitted by the presenter.

===== Device handling =====

The RTP service enumerates microphones, loudspeaker, cameras and ringing devices and notifies apps when devices come and go. It is up to the apps using the devices to store preferences.

The RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app. 

For this to work, the following vendor specific development kits are integrated in our myApps client, be ware that the SDK are updated within our Service release :

{| class="wikitable"
|-
! SDK Vendor !! Supported OS !! SDK Version !! innovaphone Service Release
|-
| Jabra|| MacOS || 1.12.2.0 || 13r3sr9
|-
||| Windows || 1.12.2.0 || 13r3sr10
|-
| Epos ''(formerly Sennheiser)'' || MacOS || 12.4.0.5478 || 14r1sr3
|-
||| Windows || n.a. - [[Support:13r3_sr10_MyApps_Windows_Client_-_Epos/Sennheiser-Headsets_require_installed_Epos-Connect_Software|to be installed separately]] || 13r3sr10
|-
| Poly ''(formerly Plantronics)'' || MacOS || 3.25.53799.37131 || 13r3sr9
|-
||| Windows || 3.25.53800.37131 || 13r3sr10
|-
| Yealink || MacOS || 3.1.1.20 || 14r1sr3
|-
||| Windows || 3.1.1.20 || 14r1sr3
|}

Notes:
* It is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI_Parameters_and_install_options | MSI parameters ]] below).

* Starting with V13r3sr10, the Epos-SDK needs to be installed separately using the Epos Connect software to ensure full compatibility between current Epos headset models and native myApps-Windows client. For details [[Support:13r3_sr10_MyApps_Windows_Client_-_Epos/Sennheiser-Headsets_require_installed_Epos-Connect_Software|refer to this article]].


===== Ring tones =====

Ring tones can be played. Apps can choose the tone from a pre-defined list of ring tones.

On Windows, custom ring tones can be uploaded as .mp3 files to the <code>ringtones</code> sub-directory of myApps' roaming directory (which usually is in <code>C:\Users\...\AppData\Roaming\innovaphone\myApps\ringtones</code>).

On Android, custom ring tones can be added to the system via Android settings.

On iOS, custom ring tones can be uploaded as .mp3 files to the <code>Ringtones</code> subdirectory of the myApps file share that is available in iTunes if the iPhone has been connected via USB.

On macOS, custom ring tones can be uploaded as .mp3 files to <code>~/Library/Containers/com.innovaphone.client-macos/Data/Documents/Ringtones</code>.

===== Debugging =====
For extended debugging, turn on the ''Audio'', ''Media'' and ''AppSharing'' traces in myApps.

=== Hot keys ===
On Windows and macOS systems, myApps platform services can listen for hot keys and invoke certain functions. Invocation is done by sending API messages to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI_elements | UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function. If you do not want to start the call with "Hotkey+Enter" because you would have to wait for the focus, the hotkey can also be pressed twice and the number is dialled directly.

; dial selected number : Initiates a call using the currently selected text as target.

: A ''PrepareCall'' message with the ''text'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":"mt":"PrepareCall","text":"13","adjust":true}}</code>

; accept call : Accepts a currently alerting call.

: A ''ConnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"ConnectCall"}}</code>

; reject/disconnect call : Rejects a currently alerting call or disconnects an active call.

: A ''DisconnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"DisconnectCall"}}</code>

=== URL Handler ===

On Windows systems, two URI-handler are installed with the myApps platform services. Windows will call up this URI handler when a user clicks on an appropriate link, for example in a web site.

The handler will the send an API message to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

; tel URI : call a number, e.g. <code>tel:4711</code>

: A ''PrepareCall'' message with the ''num'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","num":"4711","adjust":true}}</code>
; sip URI : call a SIP name, e.g. <code>sip:zkl@innovaphone.com</code>

: A ''PrepareCall'' message with the ''sip'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","sip":"zkl@innovaphone.com","adjust":true}}</code>
; im URI : start chat with SIP name, e.g. <code>im:zkl@innovaphone.com</code>

: A ''StartChat'' message with the ''sip'' argument set to the selected text will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm ''com.innovaphone.chat'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.chat","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartChat","sip":"zkl@innovaphone.com"}}</code>

On macOS systems myApps might be made the default application to handle tel URI e.g. <code>tel:4711</code> via Apple FaceTime. Open the "FaceTime" menu "Settings..." and select myApps as "Default for phone calls".

On iOS ''tel'' URIs are always dialed via GSM. Therefore myApps iOS also reacts to URI schemes ''com.innovaphone.tel'', ''com.innovaphone.sip'' and ''com.innovaphone.im'', e.g. <code><nowiki>com.innovaphone.tel:4711</nowiki></code>, <code><nowiki>com.innovaphone.sip:zkl@innovaphone.com</nowiki></code>, <code><nowiki>com.innovaphone.im:zkl@innovaphone.com</nowiki></code>.

=== User activity ===
On Windows and macOS systems, the myApps platform services can monitor user keyboard/mouse activity and change the user's presence state after a certain amount of inactivity. The timeout can be specified using the ''advanced settings'' user interface (see [[#UI_elements | UI elements]] below.

myApps will then send a [https://sdk.innovaphone.com/doc/appwebsocket/myApps.htm#SetUserActivity''SetUserActivity''] message to the PBX using the ''myApps'' protocol.

: <code>{"mt":"SetUserActivity","inactive":true}</code>

This will change the ''status'' property of the ''im:'' contact for the user's own presence and hence result in a presence update from the PBX to myApps

: <code>{"mt":"UpdateOwnPresence","presence":[{...},{"contact":"im:","activity":"","status":"closed"}]}</code>
The ''closed'' status is reflected in the grey status color when displaying a contact [[Image:myapps-inactive.png]].

On iOS and Android, the state is set to ''inactive'' as soon as the App is brought to background.
When myApps platform services are not available (i.e. when running the web application in a browser solely) a limited user activity monitoring is available: the state is set to active when the web page is not used for more than 5 minutes.

=== Recording ===

The new launcher offers the possibility to record the audio of incoming and outgoing calls. In order to activate that functionality the URL of the recording instance must be configured in either the PBX (PBX->myApps->Config: Recording URL) or the softphone App (Settings->Audio Recording (URL))

[[Image:PBX-Recording-Settings.png]] [[Image:Recording-Softphone-Settings.png]].

As long as that URL is configured the audio data of all calls are stored as pcap-files under that URL.
If the URL points to a CF device in the PBX, write access must be granted for that URL (PBX->Services->HTTP->Server:Public compact flash access) and if the URL points to the recording app, the files can be accessed via the recording app [[{{NAMESPACE}}:Concept_App_Service_Recordings|recording]].

Under PBX->myApps the administrator can set a certain default behaviour of the audio recording like whether or not the recording should start automatically at the beginning of the call (Recording by Default ON/OFF), only calls with external numbers should be recorded (Record external calls only) or whether or not the user should be able to start/stop the recording himself (Allow user incall recording control). Except for the last parameter these parameters can also be modified by the user in its softphone settings if the administrator doesn't set the FORCE flag.

If the user was allowed by the admin to control the recording a recording switch is active during the call when the "Media" Panel is opened. There the audio recording may be stopped and continued at will. A red recording notice is shown in the top right corner when the recording actually takes place.

[[Image:Recording-incall-switch.png]]

=== Notifications ===

The myApps platform services can use the OS specific notification mechanism (e.g. ''desktop notifications'' on Windows) to display messages (e.g. ''incoming new chat message'') to the user.

Note that the actual rendering of the notification is under control of the OS. Therefore, myApps must be allowed to show notifications and its appearance can be restricted by OS native settings.

==== Microsoft Windows Notifications ====

Microsoft Windows Server editions (2016, 2019, 2022) are just capable of showing a single ''IncomingCall'' notification at the same time (we couldn't find a workaround for this limitation). 
An ''IncomingCall'' notification is visible the whole time instead of being moved to the action center after a certain time. 
 
A notification about a missed call uses the ''IncomingCall'' type so that this notification is visible until the user returns. 
Due to the above limitation, on a new arriving call such a missed call notification is transformed to a default notification which will be moved to the action center automatically. 
 
On non server editions, you can have multiple IncomingCall notifications at the same time (so two parallel incoming calls will be indeed notified at the same time), but the missed call notification handling is the same on both platforms!

Thus there will be always just '''one''' missed call notification visible and previous missed calls can be found inside your action center!

To see myApps notifications, ensure:
* System -> Notifications
** enable notifications
** disable "Do not disturb" or allow myApps as priority application while "Do not disturb" is active
** enable notifications for myApps in the list of applications
* System -> Focus
** if a focus session is active and the "Do not disturb" is activated during a focus session, make sure that myApps is a priority application (see above)

==== macOS Notifications ====
Notifications are the same as on Windows.
The difference is, that for macOS, notifications need to be allowed in the system settings.
Go to Notifications - myApps, select Banner and enable all check marks.

=== Local phonebook access ===
'''Contact Search:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm ''com.innovaphone.search'' API]]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Search'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{"mt":"Search","type":"contact","search":"john doe"},"apiId":"com.innovaphone.search"}</code>
Search results are delivered as ''SearchInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>

'''Reverse Lookup:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.phonelookup/lib1_api_phonelookup.htm ''com.innovaphone.phonelookup'' API]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Lookup'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{ mt: "Lookup", prefixIntl: "000", prefixNtl: "00", prefixExt:"0", area: "7031", country: "49", lookup: "0004970311234567" },"apiId":"com.innovaphone.lookup"}</code>

Search results are delivered as ''LookupInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{mt: "LookupInfo", dn: "Jake Blues", contact: { telephonenumber: ["0004970311234567"], givenname: "Jake", sn: "Blues", company: "Blues Brothers" </code>

==== Windows ====
On Windows, the search and lookup are performed in all of the user's Outlook contact folders. As opposed to the search implemented in the ''Contacts'' and ''Users'' App, all items are returned which match any of the search words (i.e. searching for ''a b'' will return items matching either ''a'' or ''b'').

; searched properties : firstname, lastname
; returned properties : Following Outlook contact phone number properties are returned (if available):

:* OFFICE_TELEPHONE_NUMBER as ''telephonenumber''
:* OFFICE2_TELEPHONE_NUMBER as ''telephonenumber''
:* HOME_TELEPHONE_NUMBER as ''homephone''
:* HOME2_TELEPHONE_NUMBER as ''homephone''
:* MOBILE_TELEPHONE_NUMBER as ''mobile''
:* BUSINESS_FAX_NUMBER as ''facsimiletelephonenumber''
Note that contact information is cached in the search provider. Updated contacts may therefore become effective after a while only.
Outlook search will create its own trace file <code>myAppsOutlookSearch-</code>''date-time''<code>.txt</code> in the standard trace directory.

This search provider is always installed and can be disabled. There is no need (nor possibility) to enable it in the ''Apps'' tab of the PBX's user object. Also, no ''App'' object needs to be created for it.

==== Android/iOS ====
The search and lookup are performed in the contacts.

==== macOS ====
The search and lookup are performed in the contacts. If you wish to disable local contact lookup, go to system settings - Security & Privacy and disable the access to contacts for myapps.

=== Microsoft Office integration ===

The myApps platform services has a ''office presence provider'' that can provide the user's presence state to Office applications. See [[{{NAMESPACE}}:Concept_myApps_Office_Integration|myApps Office Integration]] for details.

This feature is installed by default. However, it can be disabled using the ''OFFICEPRESENCE'' MSI Parameter. Also, a check-mark is available in the setup dialog.

=== Call an external application for calls ===

Phone Apps (such as the phoneapp or softphone) can initiate the start of an external application when a new call appears (either incoming or outgoing). The actual spawning of the application is done by the myApps platform service. Also, the application properties (such as e.g. the executable's path) is configured in the myApps platform services (see [[#UI_elements|Advanced settings]] in the ''UI elements'' section below).

A number of arguments can be passed to the application by substituting $-variables in the ''Parameter'' field:

; $n : phone number as dialed (called party number for outgoing calls) or received (calling party number for incoming calls)

; $N : called or calling party number in ''national'' format (e.g. 07031730090)

; $I : called or calling party number in ''international'' format (e.g. +497031730090)

: note that both $N and $I only work if $n includes both subscriber number and area code (e.g. 07031730090). Otherwise they are equal to $n

; $d : display name of peer (if known)

; $u : URI name of the peer (if available eg with a federation call)

; $c : conference id

: this is a globally unique ID for this call and may be used to relate the call to the ''guid'' found in the CallInfo structure in the [http://wiki.innovaphone.com/index.php?title=Reference10:SOAP_API#CallInfo SOAP-API] and [http://sdk.innovaphone.com/doc/appwebsocket/RCC.htm RCC-API ]. Also, corresponding [[Reference10:Call_Detail_Record_CDR_PBX|CDRs]] can be related using the ''event'' tag's ''conf'' attribute.
The start of an external application can be requested using the ''com.innovaphone.externalapps'' API.

Some setup examples are [[Howto:Integrate_External_Apps_in_innovaphone_UC_clients|shown here]].

=== Push ===

Mobile operating systems usually inhibit network operation of apps which run in the background or are closed by the user. This is done in order to reduce battery consumption. Unfortunately, this also stops such apps to maintain a registration by regularly sending ''keep alive'' messages to a server (in our case to the PBX). As a result, myApps will be disconnected from the PBX. When the PBX determines that there is an event for the application which needs a response, it needs to wake up the app using a dedicated channel provided by the operating system. This mechanism is know as ''push''. When running on iOS or Android, myApps supports ''push''.

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to [[Course13:IT Connect - 10.1 Push Object | be configured in the PBX ]]. Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[{{NAMESPACE}}:Concept_Push_Notifications_for_iOS_and_Android]] for more details.

Also, helpful hints can be found in [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]].

=== App Proxy ===

myApps runs further ''Apps'' (such as e.g. the ''phoneapp'') as a web page in an IFRAME of the browser myApps is running in. The App's page code is loaded either from the PBX or from an ''application platform'' (AP). This however would mean that the App's IFRAME would remain empty (a dead white screen) when the PBX or AP is not available. To make sure the App can start-up anyway, the myApps platform services feature the so-called ''App Proxy''. This is a caching proxy that caches all the App code so it is available even in case of network failure. When myApps runs in the context of the platform services, Apps are therefore not loaded from the App source directly, but from the local App proxy.

The cached files are stored in the PCs local file system in the <code>C:\Users\...\AppData\Local\innovaphone\myApps\appproxy</path></code>. There is no configuration required. However, if myApps seems to run with outdated or corrupt cached copies of the App, you can safely delete the entire directory.

=== Auto update ===

On Windows and on macOS, the myApps platform services can auto-update themselves to a common version. This is controlled by the [[{{NAMESPACE}}:PBX/Config/myApps#Launcher_Software_Update | ''Launcher Software Update'' ]] settings under ''PBX/Config/myApps'' in the PBX.

When myApps is started or the user logs in or myApps needs to re-connect to the PBX, the platform services will use the [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client API] to learn the desired version (''launcherUpdateBuild'', which is part of the API's ''model''). If this differs from the current version, the platform services will try to download the respective new version.

<code>
{
"mt": "ApiUpdate",
"apis": {
"com.innovaphone.client": {
"@client": {
"title": "innovaphone myApps",
"model": {
"launcher": true,
"launcherUpdateBuild": "134906",
"appStoreUrl": "http://store.innovaphone.com/release/download/"
}
}
}
}
}</code>

The installation of the downloaded version is done by the ''innovaphonemyAppsUpdateService''. This service is installed and enabled during the initial installation of the myApps platform services. To disable auto-update, either leave the ''Launcher Software Update'' settings empty or set the service's start mode to ''disabled'' in the Windows ''services control panel''.

Note that on Windows the update service does not work on terminal servers. Administrators must do myApps base services updates using standard windows mechanisms.

Note that on macOS if myApps has been installed from the Apple Store it is assumed that auto update from the PBX is not desired and disabled therefore.

On Android/iOS/macOS updates can be downloaded from the respective app store.

The ''Devices'' app can not update software installed on Windows PCs directly. However, when the PBX is updated using an ''update job'' in the ''Devices'' App, the ''Launcher Software Update'' settings will be updated accordingly and hence the myApps base services will ultimately also be updated to the same version.

==== Auto update flow on Windows ====

* On start of myApps, myApps checks if an update is available and ready for installation
** if yes, the update is installed directly, without user interaction (a popup is shown during the installation)
** if not, myApps starts
* if an update is available while myApps is already running, an update notification will be shown which let's the user choose to install the update now or later (the notification will then popup again after one hour)

==UI elements ==
There are a few user interfaces provided by the platform services:
===tray-icon (Windows only) ===
::[[Image:myapps-tray.png]]
:Allows to
:* terminate myApps
:* toggle the ''autostart'' state
:* toggle the ''show in task bar'' state
:* open the trace folder
:
=== PBX connect form===
:: [[Image:myapps-connect.png]]
: Allows the user to specify the connect data for the PBX (i.e. IP address or DNS name)
:
=== Advanced settings===
::[[Image:myapps-settings0.png]]
::[[Image:myapps-settings.png]] [[Image:myapps-settings2.png]] [[Image:myapps-settings3.png]]

: Allows to modify various platform dependant settings (such as e.g. the hotkey selection on Windows)

== Interfaces ==
=== Provided APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm com.innovaphone.search] : access to local phone book entries by the [[#Local_phonebook_access|Local phonebook access]] component.
; [http://sdk.innovaphone.com/web1/com.innovaphone.launcher/com.innovaphone.launcher.htm com.innovaphone.launcher] : display of OS specific user notifications and receipt of related user actions
; com.innovaphone.notificationhandler : reports back click on a notification.
; com.innovaphone.externalapps : to start external applications, see [[#Call_an_external_application_for_calls |Call an external application for calls ]] above

=== Used APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm com.innovaphone.phone] : used to initiate new or manipulate existing calls by the [[#Hot_keys|Hot keys]] and [[#URL_handler|URL handler]] components.

; [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm com.innovaphone.chat] : used to start a new chat by the [[#URL_handler|URL handler]] component.

; [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client] : the model is used to learn the update settings, see [[#Auto_update|Auto update]] above

=== Protocols ===

; [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol] : used by apps to allocate RTP channels, see [[#RTP_service_for_audio.2C_video_and_data|RTP service for audio, video and data]] above

== Related App Services ==

none

== Known limitations ==
; Incoming call as banner on myApps for iOS : Since iOS 14 the iOS CallKit presents incoming calls as a banner leaving the original green answer button of myApps visible. Use only the blue button of the banner to accept the call or change iPhone Settings, App "Phone", "Incoming Calls" to "Full Screen" to hide the myApps user interface again during call answering.

; Call answer in speakerphone mode even with active Bluetooth headset on myApps for iOS : This causes unwanted speakerphone operation if the smartphone is used with a Bluetooth car audio system. The behaviour can be changed by selecting ''Bluetooth Headset'' in this setting:
:''iOS Settings->Accessibility->Touch->Call Audio Routing: Automatic / Bluetooth Headset / Speaker''
:''iOS Einstellungen->Bedienungshilfen->Tippen->Anrufaudioausgabe: Automatisch / Bluetooth-Headset / Lautsprecher''

; Windows Server 2016 (Windows 10 Build 1607) : windows just shows the first notification. Further notifications aren't displayed until the previous ones are removed from the notification center. Current windows builds do not show this behaviour anymore.

; Problems on Mac computers with Yealink USB headsets
: we have received reports that myApps quits unexpectedly on some Mac computers when a Yealink headset is plugged in. Unfortunately, we could not find out the cause yet. If you use Yealink USB headsets and have a similar issue, please open a support ticket and send myApps traces.

; Poly / Plantronics headset buttons only functional if myApps is started with Rosetta
: myApps macOS supports Apple M1/M2 hardware natively. However, the Poly / Plantronics headset SDK is only available for Intel platform and thus myApps needs to be started via Apple's Intel emulator Rosetta if a Poly / Plantronics headset is used. This is done with right-click on the myApps executable, ''Information'', ''Open with Rosetta''.

; Windows surface devices may not work correctly
: Chromium does not get touch keyboard events. USB Keyboards may not be recognized either.

= Installation =

== Windows ==

myApps platform services are installed on Windows using the .msi file found in the ''myApps Windows'' package from [https://store.innovaphone.com/release/download.htm store.innovaphone.com].

myApps can update itself automatically, see [[#Auto_update|Auto update]] above.

=== MSI Parameters and install options ===

The MSI installer of myApps for Windows supports the following parameters and can be edited with [https://docs.microsoft.com/en-us/windows/win32/msi/orca-exe Microsoft Orca]. You can add your parameters in the table ''property''.

; SERVER (REG_SZ): the PBX's server URL
; OFFICEPRESENCE (REG_DWORD): '''false''' to disable presence integration in Microsoft Office
: this is also available as a check-mark when running the install manually

; DISABLEHEADSETS (REG_DWORD): '''true''' to disable headsets support, see [[#Device_handling|Device handling]] above

; EXTERNALAPPS (REG_SZ): pre-define external applications, see [[#Call_an_external_application_for_calls|Call an external application for calls]] above
: e.g. <code>"{""externalApps"":[{""id"":0,""name"":""Wireshark"",""path"":""C:\\Program Files\\Wireshark\\Wireshark.exe"",""param"":""test $I""}]}"</code>

; FORCERESTART (REG_DWORD): '''true''' (or any string ...) kills myApps during the installation and restarts it for the currently logged in user, if it was running

; DISABLELOCALHOST (REG_DWORD): '''true''' to disable use of '''localhost''' string to access the local webserver. Use '''127.0.0.1''' instead

; EXCLUDEINTERFACES (REG_SZ): some VPN interfaces are not detected by Windows as IF_TYPE_PPP or IF_TYPE_TUNNEL and therefore the '''media outside VPN''' setting is not taking effect. With this option interfaces can be pre-defined that will not be used for media. Interfaces must be comma separated
: e.g. <code>EXCLUDEINTERFACES="172,192.168,10.10"</code>

Current settings are stored in the registry at <code>Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps</code> or at <code>Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\innovaphone\myApps</code>

Boolean values like OfficePresence are stored in registry entries with type REG_DWORD and values 1 or 0. 0 disables the setting and 1 enables it.

== iOS ==

myApps platform services are installed on iOS by loading ''innovaphone myApps'' from the ''App Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<code><plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist></code>

== macOS ==

myApps platform services might be installed directly from the Apple store. An installer package <code>myapps.pkg</code> and a disk image <code>myapps.dmg</code> is also available from the innovaphone app store. Install <code>myapps.pkg</code> by double-click on the file and follow the instructions of the installer. myApps becomes available in the Applications folder and can be opened by double-click. Or download and open <code>myapps.dmg</code> and double klick myApps. If desired integrate it into the app dock by right click, ''Options, Keep in the dock''.

If installed from the innovaphone app store, myApps can update itself automatically, see [[#Auto_update|Auto update]] above.

If installed from the Apple store, macOS notifies about updates on the Apple store. myApps [[#Auto_update|Auto update]] is disabled then.

If a clean-install of the client is necessary, the folder "/Users/username/Library/Containers/myapps" needs to be deleted. To be on the safe side also delete it from the trash bin.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<code><plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist></code>

=== Preferences ===

macOS supports preference settings that can be set via a shell command or via Mac remote management

<code>> defaults write com.innovaphone.client-ios-14r1 server "PBX-server-URL"</code>

The following parameters and can be set through this method:

; server: the PBX's server URL

=== Using Sennheiser headsets ===
If you use Sennheiser headsets, you should also install the then-current <code>DSEA_SDK_v</code>''version''<code>.pkg</code> package, after you installed the myApps client. Without that, audio will still work, but not the controls on the headset. You will need to keep that up-to-date yourself, as it is not updated by myApps's auto-update function.

== Android ==

myApps platform services are installed on Android by loading ''innovaphone myApps'' from the ''Play Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying a property "server" with string value "pbx.example.com" in the MDM.

= Configuration =

== Server configuration ==
When opening myApps for the first time, the user is prompted for the Server. Usually only the hostname (DNS host name or IP address) needs to be configured.

But there are more options for special PBX configurations.

; Non-standard HTTPS port
: If the PBX uses a non-standard HTTPS port, it must be appended to the host name separated by a colon (<code>:</code>).
: Example: <code>pbx.example.com:4444</code> (expands to <code>https://pbx.example.com:4444/PBX0/APPCLIENT/appclient.htm</code>)
; DynPBX module name
: If the PBX is a DynPBX, the module id must be appended to PBX0 separated - (<code>/</code>).
: Example: <code>pbx.example.com/PBX0-1</code> (expands to <code>https://pbx.example.com/PBX0-1/APPCLIENT/appclient.htm</code>)
; Softphone physical location
: If user defined physical location shall be used for softphone, you can append it using a parameter <code>#phys=</code>.
: Example: <code>pbx.example.com#phys=slave</code> (expands to <code>https://pbx.example.com/PBX0/APPCLIENT/appclient.htm#phys=slave</code>)

Example 1: PBX pbx.example.com with standard configuration
pbx.example.com

Example 2: PBX slave.example with DynPBX module ID 1, HTTPS port 4444 and physical location master
slave.example.com:4444/PBX0-1#phys=master

=== HTTP proxy support ===

myApps platform services do support operation via HTTP proxy now. If one or more proxies have been configured in the network settings of the operating system for the active network connection, HTTP CONNECT tunnels are established.

On Windows user name and password can be specified for the tunnel servers as generic credentials in the credentials manager (Anmeldeinformationsverwaltung). The name of the credentials must be the tunnel server hostname.

On Android user name and password can be specified through Android ''Settings, Accounts'' by adding a myApps ''HTTP Proxy Credentials'' account. The name of the account must be the tunnel server hostname.

== Platform specific settings ==
When myApps runs under the myApps platform services, it will show various platform specific settings as part of its ''burger menu'', so the user can set them. See ''Advanced settings'' in [[#UI_elements|UI elements]] above.

Some options can also be set globally for all myApps clients in the PBX's [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps ''Client Settings'']]
{|
! style="text-align: left; font-weight: bold" | Option

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

! style="text-align: left; font-weight: bold" | Where to set

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

| || || User menu || PBX ''Client Settings'' || Windows || iOS || Android || macOS

|-
| Autostart || Launch myApps on login || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Appear offline after || controls after which idle time a user is considered ''inactive''. See [[#User_activity|User activity]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|-

| Hotkeys || Hotkeys for call dial, accept, reject. See [[#Hot_keys|Hot keys]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Docking || Docking mode (left, right, none). See [[#???|??]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✗

|-

| Desktop notifications|| Turn on/off platform notifications. See [[#Notifications| Notifications]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| VPN || Disable VPN address for ICE candidate selection. See [[#RTP_ports| RTP ports]] above || ✔ ||✔ ||✔ || ✗ || ✔ || ✔

|-

| Show in taskbar|| Show myApps in the taskbar in addition to it's tray icon. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗

|-

| Log flags || turn on/off certain trace levels. See [[#Troubleshooting|Troubleshooting]] below. || ✔ ||✔ ||✔ || ✔ || ✔ || ✔

|-

| External applications || define the applications available for Apps to be started. See [[#Call_an_external_application_for_calls|Call an external application for calls]] above. || ✔ ||✗ ||✔ || ✗ || ✗ || ✔

|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗
|}
== Start parameters for Windows ==

On Windows, it is not possible to pass start parameters from the [https://www.chromium.org/developers Chromium documentation] to the myApps process.

== OS Settings for Windows ==
Windows settings can influence the display of ''Desktop notifications''. See [https://support.microsoft.com/en-us/help/4028678/windows-10-change-notification-settings Change notification settings in Windows 10] for details.

== OS settings for Android ==
; Events : The appearance of notifications can be controlled here.

; Call accounts : For proper incoming call signaling, the call account ''myApps'' needs to be enabled. Note that on Samsung smartphones the call account switch likely toggles back and a few tries may need to be done until it persists. Please double-check the state.

; Preferred Calling Account : Choose which calling account (myApps/SIM/..) should be used for outgoing calls initiated from within the native phone app / phone book.

; Background data, unlimited data usage : Grant background data use to enable ''myApps'' to connect to the PBX immediately on an incoming call.

; Overlaying : This setting is not needed if call account ''myApps'' has been enabled. Should there be a reason for not enabling call account ''myApps'', the permission for overlaying needs to be granted on Android 10 or higher for proper call signaling.

Note: If no SIM card is installed some Android smartphones exhibit a problem dialing from the smartphone contacts. The contacts app shows a choice ''Select SIM card for this call'' but all possible dialers are greyed out. In this case make myApps the default phone app in Android settings ''Apps, Default apps, Telephony''.

== OS settings for iOS ==
; Notifications : The appearance of notifications can be controlled in iOS ''Settings, myApps''.

== OS settings for macOS ==

; Notifications : The appearance of notifications can be controlled in macOS ''Preferences, Notifications, myApps''.

=Troubleshooting=

myApps platform services can write various traces for debugging. Trace can be turned on and off selectively in the [[#Advanced settings|Advanced settings]].

The following trace flags can be set:

(''Recommended trace options are: '''App, Browser, ICE, TURN, Signaling and Audio'''. Please do not activate other flags unless innovaphone support says otherwise'')

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

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

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

|-
| App||0x000000001|| logs from the App Service itself
|-
| DNS||0x000000008|| logs DNS requests and results
|-
| HTTP client||0x000000080|| http client logs
|-
| TLS||0x000000400|| TLS logs
|-
| TCP||0x000000800|| TCP logs
|-
| LDS||0x000001000|| local domain sockets
|-
| WebSocket client||0x000004000|| logs outgoing websocket connections
|-
| App WebSocket||0x000008000|| logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
|-
| UDP||0x000200000|| UDP logs
|-
| DTLS||0x000400000|| logs DTLS handshake and messages
|-
| Media||0x000800000|| logs media events
|-
| Media channel||0x001000000|| logs RTP/SCTP media connections
|-
| ICE||0x002000000|| logs ICE messages between peers
|-
| TURN||0x004000000|| logs TURN messages between peers
|-
| AppSharing||0x008000000|| logs AppSharing connection
|-
| Audio||0x010000000|| logs Audio connection and headset events
|-
| Video||0x020000000|| logs video connection and webcam events
|-
| Browser||0x040000000|| logs Chromium events
|-
| AppProxy||0x080000000|| logs requests which are proxied between the local webserver and the remote server
|-
| Webserver ||0x200000000|| enables webserver specific logs
|-
| Browser Console ||0x400000000|| logs browser console events
|-
| Signaling||0x800000000|| enables logs in the signaling module for debugging calls
|}
''code'' can be or'ed and used as value for the ''Log flags'' field in [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps/Client Settings]].

; Windows :On Windows, traces are written to the <code>C:\Users\[UserName]\AppData\Local\innovaphone\myApps</code> directory. If you start myApps with --log-size as parameter, you can define the maximum size of a log file (e.g. --log-size=100000000 would be 100MB for each file)

:* myApps-''date-time''.txt : main log file for the platform services

:* myAppsOutlookSearch-''date-time''.txt : log file for the Outlook phone book access

:* myAppsHookController-''date-time''.txt : log file for the hot-key interceptor (see [[#Hot_keys|Hot keys]])

; :myApps update installation traces are written to the <code>%windir%\temp\</code> directory.
:* myAppsInstall.txt: MSI installation file

; :myApps update service traces are written to the <code>%ALLUSERSPROFILE%\innovaphone\myAppsUpdateService</code> directory.
:* myAppsUpdateService-''date-time''.txt: myApps update service traces

;Android : traces can be sent by e-mail.

: also, an Android device might also be connected to a PC via an USB cable to get the traces. The files can be found in <code>Android/data/com.innovaphone.clientandroid/files</code>

; iOS : traces can be sent by e-mail.

; macOS : traces can be sent by e-mail.

: also, the files can be found in <code>~/Library/Containers/com.innovaphone.client-ios/Data/Documents/</code>. Press ''Alt+N'' followed by space to get tilde ''~''.

= Known Problems =
[[:Category:Problem_myApps_platform_services|Known Problems]]

= Related Articles =
* [[{{NAMESPACE}}:Concept_myApps]]
* [[{{NAMESPACE}}:Concept_myApps_Redundancy]]
* [[{{NAMESPACE}}:Concept_myApps_Office_Integration]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts]]
* [[{{NAMESPACE}}:Call_Detail_Record_CDR_PBX]]
* [[{{NAMESPACE}}:Concept Push Notifications for myPBX iOS and Android]]
* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]
* [[{{NAMESPACE}}:PBX/Config/myApps]]

[[Category:Concept_myApps_platform_services]]

Reference13r3:Gateway/GK/GW

2023-07-27T10:01:14Z

Nfi: Created page with "Below is an overview of all the gateway's configurable VoIP interfaces: * '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "Administration/Gateway/VOIP/Interface (VoIP interfaces)". * '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are co..."

Below is an overview of all the gateway's configurable VoIP interfaces:
* '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "[[#Interface_.28VoIP_Interfaces.29|Administration/Gateway/VOIP/Interface (VoIP interfaces)]]".
* '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are contained in the chapter entitled "[[#CGPN.2FCDPN_Mappings|Administration/Gateway/Interfaces/CGPN-CDPN Mappings]]" further up in the text.
* '''Registration:''' If a terminal has successfully registered with a gateway, then this is indicated in this column through specification of the IP address <Name of the VoIP interface:Call number:IP address>.

== Interface (VoIP Interfaces) ==
Clicking the relevant VoIP interface (GW1-12 <Name of the VoIP interface>) in the Interface column opens a popup page, on which the VoIP interfaces can be individually configured. Like the PBX objects, this popup page also contains standard entry fields that occur, more or less, in all VoIP interfaces.

These standard fields are:
* '''Name:''' The descriptive name of the VoIP interface.
* '''Disable:''' A checked check box disables the relevant VoIP interface.
* '''Protocol:''' The protocol to be used, that is, H.323 or SIP. Depending on which protocol is used, the set-up of the entry fields changes.
* '''Mode:''' Describes the mode of registration. Possible registration modes are:
# Gateway without Registration - Logs the VoIP interface (gateway) on to the configured gatekeeper without a registration.
# Register as Endpoint - Registers a VoIP terminal with the configured gatekeeper.
# Register as Gateway - Registers a VoIP gateway with the configured gatekeeper.
# Gatekeeper/Registrar - Is required for managing all gatekeeper registrations on a gateway.
# ENUM - Is used to register an ENUM connection with the relevant interface.
* '''Gatekeeper Address (primary):''' The primary Gatekeeper IP address at which the terminal or gateway is to register via the relevant interface. Only necessary for modes 2 and 3.
* '''Gatekeeper Address (secondary):''' The alternative gatekeeper IP address at which the terminal or gateway is to register via the relevant interface, if registration with the primary gatekeeper fails. Only necessary for modes 2 and 3 .
* '''Local Domain:''' Replaces the existing system/domain name (for H323 federation only).
* '''Mask:''' By specifying a network mask, incoming calls can be filtered. Specification of the network mask 255.255.0.0 therefore allows incoming calls on the relevant interface for terminals from the IP address range 192.168.0.0 - 192.168.255.255 .
* '''Gatekeeper Identifier:''' It is also sufficient to specify only the gatekeeper ID. Every gatekeeper in a network can be identified by means of its own gatekeeper ID, so that several gatekeepers can be operated in a network, with each terminal nevertheless identifying the correct gatekeeper by means of Gatekeeper Discovery (uses the multicast address 224.0.1.41).
* '''STUN SERVER:''' The STUN server name or IP address must be configured if this device has no public IP address while the SIP server is accessible under a public IP address. The value is given by the SIP provider or administrator (for example, stun.xten.com or 64.69.76.23). You can choose any STUN server; it does not necessarily have to correspond to the one of the SIP provider.
* '''Local Signalling Port:''' Signalling Port used by the Interface.
* '''SIP - Register as Gateway/Endpoint:'''
** '''Remote Domain (SIP Only):''' SIP Domain of the remote SIP Server to register (often equal to the SIP Proxy).
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination and it's set at Remote Domain.
* '''SIP - Gateway without Registration:'''
** '''Remote Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "FROM" field and removes it if match.
** '''Local Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "TO" field and removes it if match.
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (INVITE,etc) are to be sent to, this field it's mandatory.
** '''Filter Incoming Calls (SIP Only):''' Accept Incoming Call on this interface only if the domain part of the "To:" field SIP URI matches the ''Local Domain'' configured. If not accepted, the call may still be accepted by another interface

=== Authorization section ===
In the '''Authorization''' section, you can store a password for the VoIP interface.
* '''Password / Retype:''' The security of the registration can be raised by specifying a password (Password). The password must be confirmed (Retype).

=== Alias List section ===
In the '''Alias List''' section, you specify the call name (H.323) and the call number (E.164) of the relevant registration. For VoIP end points, you should define the assigned direct dialling number or MSN as the E.164 address, and the name as the H.323 name. For VoIP gateways it is sufficient to define the name.
* '''Name:''' The H.323 name.
* '''Number:''' The E.164 call number.

=== Coder Preferences section ===
The standard entry fields in the '''Coder Preferences''' section were already described in chapter "[[Reference:Administration/Gateway/Interfaces#Interface_.28ISDN.2C_SIP_.26_virtual_interfaces.29|Administration/Gateway/Interfaces/Interface (physical and virtual interfaces)]]".

=== Media Properties ===
The standard entry fields in the '''Media Properties''' section were already described [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]].

=== H.323 Interop Tweaks section ===
In addition to the standard fields, several advanced settings are available in the '''H.323 Interop Tweaks''' section. They are normally not necessary and are merely used to solve compatibility problems with some PBXs:
* '''No Faststart:''' The H.245 faststart procedure is enabled as standard. Outgoing calls are made with faststart, incoming calls with faststart are answered with faststart. A checked check box disables the H.245 faststart procedure. Outgoing calls are made without faststart, incoming calls with and without faststart are answered without faststart.
* '''No H.245 Tunneling:''' The H.245 tunneling procedure is enabled as standard. The voice data connection is negotiated in the TCP signalling connection*) already available. This can be advantageous in connection with NAT and firewalls.
A checked check box disables the H.245 tunneling procedure, meaning that a separate TCP connection is set up for this negotiation. This applies to the signalling connection leading out of the gatekeeper.
* '''Suppress HLC:''' A checked check box disables the transmission of HLC (High Layer Compatibility) information elements.
* '''Suppress FTY:''' A checked check box disables the transmission of FTY (Facility) information elements.
* '''Suppress Subaddress:''' A checked check box disables the transmission of Subaddress information elements.
*) From a technical viewpoint, the H.245 protocol does not establish its own TCP connection,
but shares the H.225 TCP connection.

=== SIP Interop Tweaks section ===
Miscellaneous interoperability options for SIP.
{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-
|valign=top nowrap=true|'''No Early Media'''
|Ignore any SDP answer received before final connect response. (Affects only outgoing SIP calls)
|-
|valign=top nowrap=true|'''No Inband Information on Error'''
|Controls interworking of Q.931 DISC message. If this option is set, DISC message is always interworked into BYE request.
|-
|valign=top nowrap=true|'''No Inband Disconnect'''
|TBD.
|-
|valign=top nowrap=true|'''No Remote Hold Signaling'''
|Disables interworking of "inactive" into RemoteHold (affects connected SIP calls only).
|-
|valign=top nowrap=true|'''Take Refer-To URI as Remote Target URI'''
|If enabled: When REFER is received and transfer is executed by the Gateway application and a new INVITE is sent, the Request-URI of this INVITE matches the URI that has been received in Refer-To header in REFER. 
If not enabled: The Request-URI of the outgoing INVITE is created by usual means. Userpart of the Request-URI usually contains the CDPN as provided by Gateway application.
|-
|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls . '''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header). '''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only. '''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number. '''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string. '''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id). '''CGPN in user part of URI''': Variable From-URI with actual calling party number. '''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number.
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262). '''Supported''': Supported as optional extension. '''Required''': Required as mandatory extension. '''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Microsoft Presence Format'''
|Enables special Microsoft Presence format/scheme, only used for SIP Federation with Lync 2013.
|}

== CGPN/CDPN Mappings ==
A detailed description may be found in the chapter entitled "[[Reference:Administration/Gateway/Interfaces#CGPN.2FCDPN_Mappings|Administration/Gateway/Interface/CGPN-CDPN Mappings]]".

Howto:Guidelines for Testing 3rd Party SIP Terminal Devices

2023-07-10T14:09:45Z

Nfi:

==Scope==

innovaphone supports use of 3rd party SIP devices connected to the innovaphone PBX. In fact, when connecting 3rd party devices, SIP (or SIPS) is the recommended protocol. We do not recommend to use H.323 for this purpose.

Although innovaphone usually does no 3rd party SIP device compatibility tests, vendors can do them on their own. Such tests may be documented in our wiki in so-called ''referral product'' pages. See ''What it means'' in [[Howto:What_is_a_"3rd_Party_Product"%3F#What_it_means | What is a "3rd Party Product"? ]] for more information on ''referral products''.

The 3rd-party-product-vendor or any appropriate partner are '''exclusively responsible''' for
* creation of any testplan
* definition of detailed teststeps
* regression testing upon new firmware releases
* up-to-date documentation of test results

== Things to consider ==
If you intend to test your device for innovaphone SIP compatibility, here are some notes you should consider

; STUN/TURN [[Reference13r3:Concept_Third_Party_Phones | No longer mandatory since 13r3]] : [https://en.wikipedia.org/wiki/STUN STUN] and [https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT TURN] are required. Although we do not strictly require 3rd party devices to support it, it is needed in cloud and ''anywhere workplace'' scenarios. Failing to support STUN/TURN limits use of the 3rd party device to LAN or VPN scenarios <ref name="mediarelay">As of V13r1, it is possible to enforce ''Media Relay'' for individual devices registered to the PBX. This fixes the issue. Due to the imposed CPU load it is recommended for a limited number of devices on a PBX , however</ref>
; ICE [[Reference13r3:Concept_Third_Party_Phones | No longer mandatory since 13r3]] : again, for cloud and ''anywhere workplace'' scenarios, we also use [https://en.wikipedia.org/wiki/Interactive_Connectivity_Establishment ICE] as the general mechanism to negotiate the best media connection between 2 devices. As ICE is the supported mechanism to use STUN/TURN, neither would be used properly if ICE is not implemented. For 3rd party devices without ICE support media relay on the PBX must be used, even if TURN is supported
; DTLS : we do support use of [https://en.wikipedia.org/wiki/Datagram_Transport_Layer_Security DTLS], which is an end-to-end media encryption scheme. Although we do not strictly require 3rd party devices to support it, it is needed for [https://en.wikipedia.org/wiki/WebRTC WebRTC] compatibility. 3rd party devices which fail to support it will not be able to talk to WebRTC compliant endpoints (i.e. Web Browsers) <ref name="mediarelay"/>
; TSIP : (also known as SIP over TCP). TCP based SIP (optionally encrypted with TLS) is required to route SIP requests through our ''reverse proxy''. Therefore, devices supporting SIP/UDP only will not work in such scenarios
; SIP Offer/Answer Model : with Reverse-Media-Negotiation. This is required for all devices which are registered to the PBX directly. So this is a requirement for all 3rd party phones at least
; DTMF : various features in the PBX are controlled via DTMF tones. Endpoints are required to send DTMF either using RFC 2976 (''SIP INFO'') or RFC 2833 (''RTP DTMF''). The PBX will not recognize in-band DTMF audio tones
; LDAP : the innovaphone infrastructure relies on [https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol LDAP] for access to directory data. Although 3rd parties my provide their own contact infrastructure, not supporting LDAP results in an inconsistent user experience
; CTI : can be tested using a myApps, myPBX, SOAP or TAPI
:* Initiate outgoing call (automatic call with no manual intervention, update of called party, correct call direction in call list)
:* Answer incoming call
:* Hold/Retrieve
:* Transfer

For more information regarding implemented RFCs, see [[Reference:Supported SIP Features and List of RFC's]]

; Notes : <references/>

==Creation of a 3rd-party-product article==
Test results and other informational data concerning the 3rd-pty-product have to be put into the innovaphone wiki according to following standardized format.

* Login to innovaphone wiki
* Open this instruction in the first browser tab
* Open a second browser tab/window and paste the following URL into it

http://wiki.innovaphone.com/index.php?title=Howto:productname_-_companyname_-_3rd_Party_Product&action=edit

* Replace the terms "productname" and "companyname" by your data
* Confirm your input by pressing Enter
* A new empty wiki page titled with the given URL is generated and opened in editor mode
* Copy the text content from the box below and paste it completely into the empty wiki-page

<syntaxhighlight lang="text">

[[Image:CompanyLogo.png||200px|right]]

==Product Name==


CompanyName [https://www.linktoproductpage.com ProductName]

==Certification Status==



==Category==





==Vendor==



[[Image:CompanyLogo.png|150px]]

==Description==














==Functions==





==innovaphone CTI ready==



==innovaphone Reverse Proxy ready==



==innovaphone WebRTC ready==



==Supported Codecs==


==DTMF Support==



==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==



==Support LDAP Phonebook==



==Version==




Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==





==Summary==



==Contact==



{|
| CompanyName
|-
| ContactName
|-
| Street
|-
| ZIP City
|-
| Tel:
|-
| Mobile:
|-
| Mail: [mailto:contactname@companyname contactname@companyname]
|}

For any questions please refer to [https://www.vendor.tld/contact our contact page].
</syntaxhighlight>

* Start editing according to the comments given
* DO NOT edit any comment content! This may be subject of change by innovaphone after your work is done!
* DON'T forget to SAVE!
* Upload appropriate files/images indicated by a red link
* Inform your innovaphone contact when finished
* innovaphone will set the correct product category and grant referral status upon successful document check

Reference13r3:Concept App Service Working

2023-04-21T07:23:29Z

Nfi:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working) to start/stop time tracking and an admin app (Working Admin) to view working hours for all users.
== Applies To ==

* innovaphone PBX from version 13r3

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myAPPS
* Firmware V13r3 sr4

==Concept==

The innovaphone Service Working App is an app for tracking working hours.
There is an user app (Working) to start/stop time tracking (clock style) or add entries manually. This entries must be confirmed to be displayed on the admin app and once they are confirmed they cannot be edited anymore. There is also an admin app (Working Admin) to display the working time information for all users and where the configuration settings can be changed.
The app is designed to help employees and employeres to easily track working hours.

==How it works==

The first time a user starts the Working App on myApps a new entry is created in the database for this user, based on the "Name" of this user, which will be used to store all the working hours entries, vacation days, sick days and national holidays. Entering the working hours is a two step task, because after defining the start/stop time it is also necessary to "confirm/submit" these hours as correct, after the confirmation is done the user can't change them anymore and they will be displayed on the admin app.

In the Working Admin App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. The app adds a red mark when an user does not fulfill the working hours regulation. Here the settings for the periodic emails can be configured and also if the user is allowed or not to confirm the working hours that do no fulfill the regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png]]
This is an app, where the user can enter the working hours. This can be done by clicking on the start/stop button. The user have also a calendar view to add, edit or delete working hours.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎]]
This is an admin app, where an administrator (i.e. Human Resources) can see the users' working hours. Periodic reports are generated with a list of users who do not comply with the hours restrictions. Several settings like the working hours per week and the number of working days per week can be configured per user and they are set to 40 hours and 5 days by default.

Also some config items can be edited on the hamburguer menu:

* Email address for reports (ie. Human Resources email)
* Interval for the reports (in weeks, 0 means disabled)
* SMTP settings (server, username, password and client hostname)
* Enable/disable restrictions to submit working hours:
**Allow to confirm working hours on Sundays
**Allow to confirm working hours on vacation days,national holidays or sick leave
**Allow to confirm working hours without the required break times.
**Allow to confirm working hours that exceed the daily maximum (10 hours)
**Allow to confirm working hours that do not respect the daily rest period
**Allow to confirm working hours that exceed the maximum on the last 24 weeks

Parameters:
;workingadmin: the name of the working admin app.

== PBX Manager Plugins ==

=== Working ===

With the Working plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Install the Working App via App Store to the App Platform.
* Create a instance on the Working App Service on the App Platform Manager.
* Create a new PBX Object for the Working and Working Admin Apps with the PBX Manager Plugin.
* Assign the Working App (to normal users) and Working Admin App (to administration for example Human Resources) by selecting the config template that should include the App.
* Set configuration settings on the "burger" menu of the Working Admin App (ie SMTP Server, Reports Interval in weeks, special permissions).

==Troubleshooting==
Trace flags for App on App Platform:

*App
*App Database
*App Websocket

Trace flags for myAPPS Client:

*Browser Console

==Known issues==

==Related Articles==

Howto:Snom IP phones - Snom - 3rd Party Product

2023-03-30T19:08:04Z

Nfi: /* Certification Status */

[[Image:Snom logo gray 60.jpg|350px|right]]

==Product name==


Snom [https://service.snom.com/display/wiki/Desk+Phones VoIP Deskphones]

==Certification Status==

{{Template:Compat_Status_referral_terminals|manufacturername=Snom Technology GmbH|certificationdate=in February 2023}}

==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==




[[Image:Snom logo gray 60.jpg|250px]]

About us 

Founded in 1997 and headquartered in Berlin, Germany, Snom is a German multinational corporation that manufactures the world’s first and leading brand of professional and enterprise VoIP telephones.

==Description==
<table>
<tr>
<td colspan="5">Desk phones</td>
</tr>
<tr>
<td>D315 [[Image:Snom_d315_180x160.png‎|180px]]</td>
<td>D335 [[Image:Snom_d335_180x160.png‎‎‎|180px]]</td>
<td>D385 [[Image:Snom_d385_180x160.png‎|180px]]</td>
<td>D713 [[Image:Snom_d713_180x160.png|180px]]</td>
<td>D717 [[Image:Snom_d717_180x160.png‎|180px]]</td>
</tr>
<tr>
<td>
- 3.2" 300x100 pixel Hi-Res graphical display 
- 5 programmable function keys with red LEDs 
- 4 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D315 datasheet [https://service.snom.com/download/attachments/17370025/snom_D315_datasheet_en_1-1-1.pdf?version=1&modificationDate=1556009668153&api=v2]</td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D335 datasheet
[https://service.snom.com/download/attachments/17370025/snom_D335_datasheet_en_1-0-0.pdf?version=9&modificationDate=1571915926325&api=v2]</td>
<td>
- 4.3" 480x272 pixel Hi-Res TFT-color display 
- 12/48 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
 D385 datasheet 
[https://service.snom.com/download/attachments/17370025/snom_D385_datasheet_en_1-0-0.pdf?version=1&modificationDate=1556009676425&api=v2]</td>
<td>
- 2.8" 320x240 pixel Hi-Res TFT-color display 
- 4 programmable function keys with multicolor LEDs 
- 6 Sip Identites 
- 2x Gigabit Switch 
- PoE-Class 3
 
D713 datasheet 
[https://service.snom.com/pages/viewpage.action?pageId=96960609]</td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 5 programmable function keys with red LEDs 
- 6 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
 D717 datasheet 
[https://service.snom.com/download/attachments/17370025/snom_D717_datasheet_en_1-2-0.pdf?version=1&modificationDate=1571915760919&api=v2]</td>
</tr>
<tr>
<td>D735 [[Image:Snom_d735_180x160.png‎|180px]]</td>
<td>D785 [[Image:Snom_d785_180x160.png‎‎|180px]]</td>
<td>D862 [[Image:Snom_d862_180x160.png‎|210px]]</td>
<td>D865 [[Image:Snom_d865_180x160.png‎‎|210px]]</td>

</tr>
<tr>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D735 datasheet [https://service.snom.com/download/attachments/17370025/snom_D735_datasheet_en_1-4-0.pdf?version=1&modificationDate=1571915768754&api=v2] </td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D785 datasheet [https://service.snom.com/download/attachments/17370025/snom_D785_datasheet_en_2-2-0.pdf?version=1&modificationDate=1571915775378&api=v2] </td>
<td>
- 5" High-resolution TFT-colour display 1280 x 720 pixels / 16:9 
- 8 programmable function keys with multicolor LEDs 
- 8 Sip Identites
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
D862 datasheet [https://service.snom.com/display/wiki/D862+Datasheet+-+EN]</td>
<td>
- 5" High-resolution TFT-colour display 1280 x 720 pixels / 16:9 
- 10 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
D865 datasheet [https://service.snom.com/display/wiki/D865+Datasheet+-+EN] </td>
</tr>
<tr>
<td>M110 [[Image:Snom_M110_88x160.png‎‎|160px]]</td>
<td>M430 [[Image:Snom_M430_180x160.png‎‎‎|170px]]</td>
<td>M900 [[Image:Snom_M900_180x160.png|100px]]</td>
<td>M900 Outdoors [[Image:Snom M900 outdoors 180x160.png‎|150px]]</td>

</tr>
<tr>
<td>
- DECT Single-Cell Base station + handset 
- 10 Sip Identites 
- 10 Handsets 
- 6 Simultaneous calls 
- Compatible handsets M10 SC 
- PoE-Class 2
 
M110 datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-sc-serie/snom-m110-sc-bundle/] </td>
<td>
- DECT Single-Cell Base station + handset 
- 20 Sip Identites 
- 20 Handsets 
- 10 Simultaneous calls 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M430 datasheet [https://www.snom.com/en/products/cordless-phones/m-series/snom-m430/] </td>
<td>
- DECT Multi-Cell with up to 1,000 bases in a cluster 
- Up to 4,000 handsets in a cluster 
- 8 NB, 4 WB calls per M900 base 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M900 datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-serie/snom-m900/]</td>
<td>
- Outdoors DECT Multi-Cell with up to 1,000 bases in a cluster 
- Up to 4,000 handsets in a cluster 
- 8 NB, 4 WB calls per M900 base 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M900 outdoors datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-serie/snom-m900-outdoor/] </td>
</tr>
</table>

==Functions==




* Initiate outgoing call = yes
* Answer incoming call = yes
* Hold/Retrieve = yes
* Transfer = yes
* Call waiting = yes
* Do not disturb = yes
* Call Conference = yes ([https://service.snom.com/display/wiki/Ad-Hoc+Conference+-+V10 Snom - Ad-Hoc Conference])
* Call Park = yes
* Voice Messages Center
* Call Forward and divert = yes
* Intercom (HS to HS) = yes
* Called, calling, and connected party information = yes
* Missed-call notification = yes
* 1-touch speed dial = yes
* Redial = yes
* Zero touch provisioning, management, configuration and remote debugging = yes with SRAPS ( [https://service.snom.com/display/wiki/SRAPS See more informations here])
* SIP NATPR
* Background Upgrades = yes
* Dynamic Search of Network Based Directory = yes
* BLF = yes

==innovaphone CTI ready==
* Initiate outgoing call (automatic call with no manual intervention, update of called party, correct call direction in call list) = yes
* Hold/Retrieve = yes
* Transfer = yes

==innovaphone Reverse Proxy ready==

* STUN = yes
* TURN = No ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* ICE = No ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* SIP/TCP = yes
* SIP/TLS = yes

==innovaphone WebRTC ready==

* Codec G.711 yes
* Codec OPUS yes
* DTLS encryption no ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])

==Supported Codecs==

* G.722 = yes
* G.711 A-law = yes
* G.711 y-law = yes
* G.723.1 = yes
* G.729A = yes
* Opus = yes
==DTMF Support==


* SIP v1 (RFC2543), v2 (RFC3261)
* DTMF: In-band, Out-of-band(RFC 2833) and SIP INFO
==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==

* Supports RFC3261 Digest Authentication Scheme (Section 22.4)
==Support LDAP Phonebook==

* Support LDAP Phonebook = yes

* LDAP Configuration in Snom D3xx,D7xx and D8xx series.

Create LDAP Function Key example:

Go to Snom phone web user interface.

Setup->Function Keys->configure desired key for LDAP.

In Example below we chose P1 Key for LDAP.

[[Image:LDAP_Fkey.jpg|1000px]]

Example view from D713 Snom phone:

[[Image:LDAP_Fkey_D713.jpg|200px]]

LDAP Configuration with innovaphone cloud configuration TLS

Go to phone web interface Setup->Advanced->Network->LDAP (section)

[[Image:LDAP_TLS.jpg‎]]

Configuration:

ldap_search_filter=(|(sn=*%*)(cn=*%*))

ldap_number_filter=dn=%

ldap_search_filter_during_call=(|(sn=*%*)(cn=*%*))

ldap_number_filter_during_call=dn=%

ldap_server=00000-pbx.innovaphone.com

ldap_port=636

ldap_base=cn=PBX0

ldap_username=00000_your_pbx_number-pbx.innovaphone.com\ldap-test

ldap_password= your password

ldap_name_attributes=dn cn sn

ldap_number_attributes=e164

ldap_display_name=%dn

ldap_over_tls=on

ldap_sort_mode=client

LDAP local innovaphone installation - no encryption

[[Image:LDAP_local_small.jpg]]

Configuration:

ldap_search_filter=(|(sn=*%*)(cn=*%*))

ldap_number_filter=dn=%

ldap_search_filter_during_call=(|(sn=*%*)(cn=*%*))

ldap_number_filter_during_call=dn=%

ldap_server=192.168.0.111

ldap_port=389

ldap_base=cn=PBX0

ldap_username=your_local_domain\ldap-test

ldap_password= your password

ldap_name_attributes=dn cn sn

ldap_number_attributes=e164

ldap_display_name=%dn

ldap_over_tls=off

ldap_sort_mode=client

* LDAP Configuration in Snom M400 and M900 series cloud installation with TLS 

[[Image:LDAP_M900_small.jpg|500px]]

Configuration in .xml format:

<ldap_username>00000-pbx.innovaphone.com\ldap-test</ldap_username>

<ldap_search_filter>(|(e164=%*)(cn=%*))</ldap_search_filter>

<ldap_home_number>e164</ldap_home_number>

<ldap_mobile_number>mobile</ldap_mobile_number>

<ldap_work_number>telephoneNumber</ldap_work_number>

<ldap_name_attributes>cn</ldap_name_attributes>

<ldap_number_attributes>telephoneNumber mobile e164</ldap_number_attributes>

<ldap_password>**********</ldap_password>

<ldap_port>636</ldap_port>

<ldap_base>cn=PBX0</ldap_base>

<ldap_server>00000-pbx.innovaphone.com</ldap_server>

<ldap_sort_attribute>0</ldap_sort_attribute>

<ldap_tls>on</ldap_tls>

<ldap_use_ext_nbr_to_ldap_bind>disabled</ldap_use_ext_nbr_to_ldap_bind>

<ldap_virtual_lists>off</ldap_virtual_lists>

* LDAP Configuration in Snom M400 and M900 local installation (IP811) 

[[Image:LDAP_M900_loacl.jpg‎]]

Configuration in .xml format:

<ldap_username>snomlocalpbx\ldap-test</ldap_username>

<ldap_search_filter>(|(e164=%*)(cn=%*))</ldap_search_filter>

<ldap_home_number>e164</ldap_home_number>

<ldap_mobile_number>mobile</ldap_mobile_number>

<ldap_work_number>telephoneNumber</ldap_work_number>

<ldap_name_attributes>cn</ldap_name_attributes>

<ldap_number_attributes>telephoneNumber mobile e164</ldap_number_attributes>

<ldap_password>**********</ldap_password>

<ldap_port>636</ldap_port>

<ldap_base>cn=PBX0</ldap_base>

<ldap_server>192.168.0.111</ldap_server>

<ldap_sort_attribute>0</ldap_sort_attribute>

<ldap_tls>off</ldap_tls>

<ldap_use_ext_nbr_to_ldap_bind>disabled</ldap_use_ext_nbr_to_ldap_bind>

<ldap_virtual_lists>off</ldap_virtual_lists>

.
For further informations please refer to this [https://service.snom.com/display/wiki/LDAP+Directory LDAP Directory configuration guide]

==Version==




Product versions used for interop testing: / Produktversionen, die für Interop-Tests verwendet werden:

* '''Snom D315''' FW: 10.1.25.0
* '''Snom D345''' FW: 10.1.25.0
* '''Snom D715''' FW: 10.1.141.13
* '''Snom D735''' FW: 10.1.141.13
* '''Snom D785''' FW: 10.1.141.13
* '''Snom D862''' FW: 10.1.141.13
* '''Snom D865''' FW: 10.1.141.13
* '''Snom M100''' FW: M100KLE-1.0.5.2-0 Handsets: M10KLE-1.4.5.12-0
* '''Snom M400''' FW: 650 B2 Handsets: 650 B2
* '''Snom M900''' FW: 650 B2 Handsets: 650 B2

* '''Innovaphone IP811''' FW:13r3 final IPVA[13.7758]
* '''Innovaphone cloud''' FW:13r3 final IPVA[13.7758]

== Konfiguration (German) ==

===Informationen zum PBX-System===
Die hier verwendete PBX ist eine innovaphone IP811. Die Angaben sind jedoch auf die weiteren innovaphone Modelle übertragbar.

Für die Sprachübertragung zwischen den VoIP-Komponenten wird das Protokoll SIP verwendet.




=== PBX Teilnehmer ===


[[Image:innovaphone ip811 pbx General new user en sm.jpg]]
[[Image:Snom_WUI_Identity_Innovaphone_sm_de.jpg]]

'''Hier gilt es ein paar Dinge zu beachten:'''

* Das Feld Number enthält die Telefonnummer. Diese tragen sie auch genau so im Webinterface (WUI) Ihres Snom Telefons ein unter "'''Identität 1'''" im Feld Account.
* Das Feld Passwort ist das gleiche das sie im Webinterface (WUI) Ihres Snom Telefons benötigen.

=== Konfiguration der SNOM Telefone ===

'''Bitte stellen Sie sicher, dass Ihr Telefon korrekt angeschlossen ist.'''

* Zuerst packen Sie Ihr Snom Phone aus und stellen Sie es auf den Tisch.
* Verwenden Sie dazu das beiliegende Netzwerkkabel und verbinden Sie die Buchse "'''Net'''" Ihres Telefons mit Ihrem Netzwerk-Switch.
* Um Ihr Snom Phone mit Strom zu versorgen, benötigen Sie entweder einen Netzwerk-Switch mit "'''POE'''" (Power over Ethernet) oder ein geeignetes Snom-Netzteil.
(in der Regel 5V - Keine Garantie für Schäden bei Verwendung eines externen Netzteils).

'''Bitte überprüfen Sie vorab, ob auf Ihrem Telefon die neueste stabile Firmware-Version installiert ist.'''

* Bitte besuchen sie hierfür unser Snom Service Hub: [https://service.snom.com/display/wiki/Firmware+Update+Center Firmware Update Center]

'''Snom Web-Benutzeroberfläche'''

* Da die automatische Bereitstellung von der innovaphone PBX nicht unterstützt wird, muss das Snom Telefon über seine Web-Benutzeroberfläche (WUI) eingerichtet werden.
* Um auf das Telefon zuzugreifen, geben Sie die IP-Adresse Ihres Telefons in Ihren Internet-Browser ein (z.B. http: //192.168.1.100).
* Um die IP-Adresse Ihres Telefons herauszufinden, drücken Sie die Konfigurationstaste (Zahnradsymbol) -> "'''Informationen'''" -> "'''Systeminformationen'''".

=== Snom Identität konfigurieren ===

Wählen Sie zunächst den Menüpunkt "'''Identität 1'''" auf der linken Seite und geben Sie die Benutzer-ID und das Passwort ein, die Sie in die innovaphone PBX eingegeben haben.

* '''Angezeigter Name''': testphone1
* '''Nutzerkennung''': 100 (Rufnummer)
* '''Passwort''': 123 (wie in der innovaphone vergeben)
* '''Registrar''': 192.168.100.250 (IP der innovaphone)

Klicken sie unten auf "'''übernehmen'''".

[[Image:innovaphone ip811 identity Login de.jpg]]

'''Ihr Snom Telefon ist nun erfolgreich an der innovaphone PBX registriert''' und kann Anrufe tätigen und entgegennehmen.




== Configuration (English) ==

===Information about the PBX system===
The PBX used here is an innovaphone IP811. However, the specifications are transferable to the other innovaphone models.

The SIP protocol is used for voice transmission between the VoIP components.

=== PBX User / Extension ===

[[Image:innovaphone ip811 pbx General new user en sm.jpg]]
[[Image:Snom WUI Identity innovaphone sm en.jpg]]

'''There are a few things to consider here:'''

* The "'''Number'''" field contains the telephone number. This same number is used in the "'''Account Field'''" in the web interface (WUI) of your snom phone under "'''Identity 1'''".
* Please provide a strong enough password for the account.

=== Configuration of the Snom phone ===

'''Please make sure your phone is set up correctly.'''

* First of all, unpack your Snom Phone and put it on the table.
* To connect it use the enclosednetwork cable and connect the "'''Net'''" socket of your telephone to your network switch.
* To get power for your Snom Phone either a network switch with "'''POE'''" (Power over Ethernet) or a suitable Snom power supply unit
(usually 5V - No guarantee for damage when using an external power supply).

'''Please check in advance that your phone has the latest stable firmware version installed.'''

* Have a look on our Snom Wiki: [http://wiki.snom.com/Firmware Snom Firmware Guide]

'''Enter Snom Webinterface'''

Since auto provisioning is not supported by the innovaphone PBX, the Snom Phone needs to be set up using its web user interface (WUI).
To access the phone, type the IP address of your phone into your internet browser (e.g. http: //192.168.1.100).
To find out the IP address of your phone press the Configuration key (gear wheel symbol) -> "'''Information'''" -> "'''System information'''".

=== Register a SIP account ===

First select the " '''Identity 1''' " menu item on the left-hand side and enter the user ID and password you entered into the innovaphone PBX.

* '''Displayname:''' testphone1
* '''Account:''' 100 (telephone number)
* '''Password:''' 123 (as assigned in the innovaphone)
* '''Registrar:''' 192.168.100.250 (IP Adress of the innovaphone)

Click on "'''apply''' " below.

[[Image:innovaphone ip811 identity Login en.jpg]]

'''The phone configuration is now complete.''' Your Snom phone is now successfully registered on the innovaphone PBX and can make and receive calls.

==Contact Details==

{|
| Company Name: || Snom Technology GmbH
|-
| Street: || Wittestraße 30 G
|-
| ZIP/City: || 13509 Berlin
|-
| Country: || Germany
|-
| Phone: || +49 30 39833-0
|-
| Fax: || +49 30 39833-111
|-
| Mail: || [mailto:officemanagement@snom.com officemanagement@snom.com]
|-
| Internet: || [https://www.snom.com Snom Technology GmbH]
|-
| Contact: || [https://www.snom.com/de/kontakt/ Snom contact]
|-
| Support: || [https://service.snom.com Snom Service Hub]
|}

Howto13r3:ATCOM IP Phones - ATCOM - 3rd Party Product

2023-03-22T14:46:33Z

Nfi: /* innovaphone Reverse Proxy ready */

[[Image:atcom_logo.png||270px|right]]

==Product Name==


*'''ATCOM Gigabit IP phone'''
*ATCOM D26
*ATCOM D38
*ATCOM A26
*ATCOM A48
*ATCOM A68
*'''ATCOM 100M IP phone'''
*ATCOM D20
*ATCOM D21
*ATCOM D32
*ATCOM D33
*ATCOM A20
*ATCOM A21
*ATCOM A41
*'''ATCOM Wi-Fi IP phone'''
*ATCOM A20W/A20WAC
*ATCOM A41W
*ATCOM A48W/A48WAC
*ATCOM A68W/A68WAC
*ATCOM A2SW
*ATCOM D2SW
*'''ATCOM 4G SIP/VoLTE phone'''
*ATCOM A68LTE
*ATCOM A20LTE
*ATCOM A2SV-PW
*ATCOM D2SV-PW
[https://www.atcom.cn/html/yingwenban/Product/Gigabit_IP/ ATCOM IP phones]

==Certification Status==

{{Template:Compat_Status_referral_terminals|manufacturername=ATCOM Technology Co. LTD.|certificationdate=in November 2022}}

==Category==

[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:atcom_logo.png|270px]]

ATCOM is a state certified high-tech enterprise in China. It is one of the earliest companies engaged in VoIP Industry in China. It has 13 years of experience in R&D, manufacturing and technical service of IP telephone and related IP voice terminals. Its products are sold in more than 100 countries, providing high-quality products and services for millions of users.

==Description==




<table>
<tr>
<td colspan="5">IP phones</td>
</tr>
<tr>
<td>D21 [[Image:D2Xlogo.png‎]]</td>
<td>D26 [[Image:D2Xlogo.png‎]]</td>
<td>D38 [[Image:D3Xlogo.png‎]]</td>
</tr>
<td>
- 128*64 graphic of backlight LCD 
- 6 SIP accounts 
- Multi-Scene feature 
- 13 programmable keys 
- 2 line keys 
- PoE-Class 2 
[https://www.atcom.cn/uploads/soft/190709/D2X-datasheet-EN.pdf D21 datasheet]</td>
<td>
- 128*64 graphic of backlight LCD 
- 6 SIP accounts 
- Multi-Scene feature 
- 13 programmable keys 
- 2x Gigabit port 
- PoE-Class 2 
[https://www.atcom.cn/uploads/soft/190709/D2X-datasheet-EN.pdf D26 datasheet]</td>
<td>
- 2.4”TFT LCD, 320*240 pixel 
- 6 SIP accounts 
- 2x Gigabit Switch port 
- 13 programmable keys 
- 3 line keys 
- PoE-Class 2 
[https://www.atcom.cn/uploads/soft/190709/D3X-datasheet-EN.pdf D38 datasheet]</td>
</table>

==Functions==




* Initiate outgoing call = yes
* Answer incoming call = yes
* Hold/Retrieve = yes
* Transfer = yes
* Conference yes
* Call waiting = yes
* Do not disturb = yes
* Call Conference = yes
* Call Park = yes
* Voice Messages Center = yes
* Call Forward and divert = yes
* Intercom = yes
* Dialed/Received/Missed/Forwarded call (400 total) = yes
* Missed-call notification = yes
* 1-touch speed dial = yes
* Redial = yes
* Zero touch provisioning, management, configuration and remote debugging = yes
* SIP yes
* Local Directory(up to 1000 total), remote xml phonebook, and LDAP = yes
* Call Center Headsets modeyes
* BLF = yes
* SRTP = yes
* DND = yes
* Peer to peer call = yes

==innovaphone CTI ready==



==innovaphone Reverse Proxy ready==


* STUN yes
* TURN no ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* ICE no ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* SIP/TCP yes
* SIP/TLS1.0,TLS1.1,TLS1.2 yes

==innovaphone WebRTC ready==



==Supported Codecs==

* G.722 yes
* G.711 A-law yes
* G.711 y-law yes
* G.729A/B/AB yes
* Opus yes

==DTMF Support==


* SIP v1 (RFC2543), v2 (RFC3261)
* DTMF: In-band, Out-of-band(RFC 2833) and SIP INFO

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==


* Supports RFC3261 Digest Authentication Scheme (Section 22.4) yes

==Support LDAP Phonebook==


* Support LDAP Phonebook yes
For further informations please refer to this [http://test.atcom.cn/atcom/UserManual/ATCOM%20LDAP%20user%20manual.pdf LDAP Directory configuration guide] 
[[Image:Ldap.png]]

==Version==




Product versions used for interop testing:

* '''ATCOM D21&D26''' FW：V2.8.6.d5cb1
* '''ATCOM D38''' FW:V2.8.6.d5cb1

* '''innovaphone''' V13r3 beta4
* '''[http://download.atcom.cn/Report/Atcom-D26.pdf ATCOM Test report]

==Configuration==





=== Register a SIP account ===

First login to the phone webpage, then choose the Account1, 

* '''Displayname:''' testphone1 
* '''Register name:''' 6001(telephone number) 
* '''User name:''' 6001(telephone number) 
* '''Password:''' 123 (as assigned in the innovaphone) 
* '''SIP server:''' 172.16.0.100 (IP Adress of the innovaphone) 
* '''Port:''' 5060(the default port)
* '''Transport Type:''' UDP/TCP/TLS1.0,TLS1.1,TLS1.2
Click on "'''Confirm''' " below. 
[[Image:Register.png]] 
'''The phone configuration is now complete.''' Your ATCOM phone is now successfully registered on the innovaphone PBX and can make and receive calls. 

==Summary==



==Contact==



{|
| Company Name: || ATCOM Technology co.,LTD.
|-
| Street: || Building A, STECH park, No. 73 Liuxiancun Road, Xili Street, Nanshan District
|-
| ZIP/City: || Shenzhen, Guangzhou
|-
| Country: || China
|-
| Phone: || +86075583018618
|-
| Fax: || +86075583018618
|-
| Mail: || [mailto:support@atcom.com.cn support@atcom.cn]
|-
| Internet: || [https://www.atcom.cn www.atcom.cn]
|-
|}

Howto:Snom IP phones - Snom - 3rd Party Product

2023-03-22T14:44:03Z

Nfi: /* innovaphone WebRTC ready */

[[Image:Snom logo gray 60.jpg|350px|right]]

==Product name==


Snom [https://service.snom.com/display/wiki/Desk+Phones VoIP Deskphones]

==Certification Status==
{{Template:Compat_Status_referral_product_new}}

==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==




[[Image:Snom logo gray 60.jpg|250px]]

About us 

Founded in 1997 and headquartered in Berlin, Germany, Snom is a German multinational corporation that manufactures the world’s first and leading brand of professional and enterprise VoIP telephones.

==Description==
<table>
<tr>
<td colspan="5">Desk phones</td>
</tr>
<tr>
<td>D315 [[Image:Snom_d315_180x160.png‎|180px]]</td>
<td>D335 [[Image:Snom_d335_180x160.png‎‎‎|180px]]</td>
<td>D385 [[Image:Snom_d385_180x160.png‎|180px]]</td>
<td>D713 [[Image:Snom_d713_180x160.png|180px]]</td>
<td>D717 [[Image:Snom_d717_180x160.png‎|180px]]</td>
</tr>
<tr>
<td>
- 3.2" 300x100 pixel Hi-Res graphical display 
- 5 programmable function keys with red LEDs 
- 4 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D315 datasheet [https://service.snom.com/download/attachments/17370025/snom_D315_datasheet_en_1-1-1.pdf?version=1&modificationDate=1556009668153&api=v2]</td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D335 datasheet
[https://service.snom.com/download/attachments/17370025/snom_D335_datasheet_en_1-0-0.pdf?version=9&modificationDate=1571915926325&api=v2]</td>
<td>
- 4.3" 480x272 pixel Hi-Res TFT-color display 
- 12/48 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
 D385 datasheet 
[https://service.snom.com/download/attachments/17370025/snom_D385_datasheet_en_1-0-0.pdf?version=1&modificationDate=1556009676425&api=v2]</td>
<td>
- 2.8" 320x240 pixel Hi-Res TFT-color display 
- 4 programmable function keys with multicolor LEDs 
- 6 Sip Identites 
- 2x Gigabit Switch 
- PoE-Class 3
 
D713 datasheet 
[https://service.snom.com/pages/viewpage.action?pageId=96960609]</td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 5 programmable function keys with red LEDs 
- 6 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
 D717 datasheet 
[https://service.snom.com/download/attachments/17370025/snom_D717_datasheet_en_1-2-0.pdf?version=1&modificationDate=1571915760919&api=v2]</td>
</tr>
<tr>
<td>D735 [[Image:Snom_d735_180x160.png‎|180px]]</td>
<td>D785 [[Image:Snom_d785_180x160.png‎‎|180px]]</td>
<td>D862 [[Image:Snom_d862_180x160.png‎|210px]]</td>
<td>D865 [[Image:Snom_d865_180x160.png‎‎|210px]]</td>

</tr>
<tr>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D735 datasheet [https://service.snom.com/download/attachments/17370025/snom_D735_datasheet_en_1-4-0.pdf?version=1&modificationDate=1571915768754&api=v2] </td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D785 datasheet [https://service.snom.com/download/attachments/17370025/snom_D785_datasheet_en_2-2-0.pdf?version=1&modificationDate=1571915775378&api=v2] </td>
<td>
- 5" High-resolution TFT-colour display 1280 x 720 pixels / 16:9 
- 8 programmable function keys with multicolor LEDs 
- 8 Sip Identites
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
D862 datasheet [https://service.snom.com/display/wiki/D862+Datasheet+-+EN]</td>
<td>
- 5" High-resolution TFT-colour display 1280 x 720 pixels / 16:9 
- 10 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
D865 datasheet [https://service.snom.com/display/wiki/D865+Datasheet+-+EN] </td>
</tr>
<tr>
<td>M110 [[Image:Snom_M110_88x160.png‎‎|160px]]</td>
<td>M430 [[Image:Snom_M430_180x160.png‎‎‎|170px]]</td>
<td>M900 [[Image:Snom_M900_180x160.png|100px]]</td>
<td>M900 Outdoors [[Image:Snom M900 outdoors 180x160.png‎|150px]]</td>

</tr>
<tr>
<td>
- DECT Single-Cell Base station + handset 
- 10 Sip Identites 
- 10 Handsets 
- 6 Simultaneous calls 
- Compatible handsets M10 SC 
- PoE-Class 2
 
M110 datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-sc-serie/snom-m110-sc-bundle/] </td>
<td>
- DECT Single-Cell Base station + handset 
- 20 Sip Identites 
- 20 Handsets 
- 10 Simultaneous calls 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M430 datasheet [https://www.snom.com/en/products/cordless-phones/m-series/snom-m430/] </td>
<td>
- DECT Multi-Cell with up to 1,000 bases in a cluster 
- Up to 4,000 handsets in a cluster 
- 8 NB, 4 WB calls per M900 base 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M900 datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-serie/snom-m900/]</td>
<td>
- Outdoors DECT Multi-Cell with up to 1,000 bases in a cluster 
- Up to 4,000 handsets in a cluster 
- 8 NB, 4 WB calls per M900 base 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M900 outdoors datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-serie/snom-m900-outdoor/] </td>
</tr>
</table>

==Functions==




* Initiate outgoing call = yes
* Answer incoming call = yes
* Hold/Retrieve = yes
* Transfer = yes
* Call waiting = yes
* Do not disturb = yes
* Call Conference = yes ([https://service.snom.com/display/wiki/Ad-Hoc+Conference+-+V10 Snom - Ad-Hoc Conference])
* Call Park = yes
* Voice Messages Center
* Call Forward and divert = yes
* Intercom (HS to HS) = yes
* Called, calling, and connected party information = yes
* Missed-call notification = yes
* 1-touch speed dial = yes
* Redial = yes
* Zero touch provisioning, management, configuration and remote debugging = yes with SRAPS ( [https://service.snom.com/display/wiki/SRAPS See more informations here])
* SIP NATPR
* Background Upgrades = yes
* Dynamic Search of Network Based Directory = yes
* BLF = yes

==innovaphone CTI ready==
* Initiate outgoing call (automatic call with no manual intervention, update of called party, correct call direction in call list) = yes
* Hold/Retrieve = yes
* Transfer = yes

==innovaphone Reverse Proxy ready==

* STUN = yes
* TURN = No ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* ICE = No ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* SIP/TCP = yes
* SIP/TLS = yes

==innovaphone WebRTC ready==

* Codec G.711 yes
* Codec OPUS yes
* DTLS encryption no ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])

==Supported Codecs==

* G.722 = yes
* G.711 A-law = yes
* G.711 y-law = yes
* G.723.1 = yes
* G.729A = yes
* Opus = yes
==DTMF Support==


* SIP v1 (RFC2543), v2 (RFC3261)
* DTMF: In-band, Out-of-band(RFC 2833) and SIP INFO
==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==

* Supports RFC3261 Digest Authentication Scheme (Section 22.4)
==Support LDAP Phonebook==

* Support LDAP Phonebook = yes

For further informations please refer to this [https://service.snom.com/display/wiki/LDAP+Directory LDAP Directory configuration guide]

[[Image:Screenshot-ldap1.png‎]]

==Version==




Product versions used for interop testing: / Produktversionen, die für Interop-Tests verwendet werden:

* '''Snom D315''' FW: 10.1.25.0
* '''Snom D345''' FW: 10.1.25.0
* '''Snom D715''' FW: 10.1.141.13
* '''Snom D735''' FW: 10.1.141.13
* '''Snom D785''' FW: 10.1.141.13
* '''Snom D862''' FW: 10.1.141.13
* '''Snom D865''' FW: 10.1.141.13
* '''Snom M100''' FW: M100KLE-1.0.5.2-0 Handsets: M10KLE-1.4.5.12-0
* '''Snom M400''' FW: 650 B2 Handsets: 650 B2
* '''Snom M900''' FW: 650 B2 Handsets: 650 B2

* '''Innovaphone IP811''' FW:13r3 final IPVA[13.7758]
* '''Innovaphone cloud''' FW:13r3 final IPVA[13.7758]

== Konfiguration (German) ==

===Informationen zum PBX-System===
Die hier verwendete PBX ist eine innovaphone IP811. Die Angaben sind jedoch auf die weiteren innovaphone Modelle übertragbar.

Für die Sprachübertragung zwischen den VoIP-Komponenten wird das Protokoll SIP verwendet.




=== PBX Teilnehmer ===


[[Image:innovaphone ip811 pbx General new user en sm.jpg]]
[[Image:Snom_WUI_Identity_Innovaphone_sm_de.jpg]]

'''Hier gilt es ein paar Dinge zu beachten:'''

* Das Feld Number enthält die Telefonnummer. Diese tragen sie auch genau so im Webinterface (WUI) Ihres Snom Telefons ein unter "'''Identität 1'''" im Feld Account.
* Das Feld Passwort ist das gleiche das sie im Webinterface (WUI) Ihres Snom Telefons benötigen.

=== Konfiguration der SNOM Telefone ===

'''Bitte stellen Sie sicher, dass Ihr Telefon korrekt angeschlossen ist.'''

* Zuerst packen Sie Ihr Snom Phone aus und stellen Sie es auf den Tisch.
* Verwenden Sie dazu das beiliegende Netzwerkkabel und verbinden Sie die Buchse "'''Net'''" Ihres Telefons mit Ihrem Netzwerk-Switch.
* Um Ihr Snom Phone mit Strom zu versorgen, benötigen Sie entweder einen Netzwerk-Switch mit "'''POE'''" (Power over Ethernet) oder ein geeignetes Snom-Netzteil.
(in der Regel 5V - Keine Garantie für Schäden bei Verwendung eines externen Netzteils).

'''Bitte überprüfen Sie vorab, ob auf Ihrem Telefon die neueste stabile Firmware-Version installiert ist.'''

* Bitte besuchen sie hierfür unser Snom Service Hub: [https://service.snom.com/display/wiki/Firmware+Update+Center Firmware Update Center]

'''Snom Web-Benutzeroberfläche'''

* Da die automatische Bereitstellung von der innovaphone PBX nicht unterstützt wird, muss das Snom Telefon über seine Web-Benutzeroberfläche (WUI) eingerichtet werden.
* Um auf das Telefon zuzugreifen, geben Sie die IP-Adresse Ihres Telefons in Ihren Internet-Browser ein (z.B. http: //192.168.1.100).
* Um die IP-Adresse Ihres Telefons herauszufinden, drücken Sie die Konfigurationstaste (Zahnradsymbol) -> "'''Informationen'''" -> "'''Systeminformationen'''".

=== Snom Identität konfigurieren ===

Wählen Sie zunächst den Menüpunkt "'''Identität 1'''" auf der linken Seite und geben Sie die Benutzer-ID und das Passwort ein, die Sie in die innovaphone PBX eingegeben haben.

* '''Angezeigter Name''': testphone1
* '''Nutzerkennung''': 100 (Rufnummer)
* '''Passwort''': 123 (wie in der innovaphone vergeben)
* '''Registrar''': 192.168.100.250 (IP der innovaphone)

Klicken sie unten auf "'''übernehmen'''".

[[Image:innovaphone ip811 identity Login de.jpg]]

'''Ihr Snom Telefon ist nun erfolgreich an der innovaphone PBX registriert''' und kann Anrufe tätigen und entgegennehmen.




== Configuration (English) ==

===Information about the PBX system===
The PBX used here is an innovaphone IP811. However, the specifications are transferable to the other innovaphone models.

The SIP protocol is used for voice transmission between the VoIP components.

=== PBX User / Extension ===

[[Image:innovaphone ip811 pbx General new user en sm.jpg]]
[[Image:Snom WUI Identity innovaphone sm en.jpg]]

'''There are a few things to consider here:'''

* The "'''Number'''" field contains the telephone number. This same number is used in the "'''Account Field'''" in the web interface (WUI) of your snom phone under "'''Identity 1'''".
* Please provide a strong enough password for the account.

=== Configuration of the Snom phone ===

'''Please make sure your phone is set up correctly.'''

* First of all, unpack your Snom Phone and put it on the table.
* To connect it use the enclosednetwork cable and connect the "'''Net'''" socket of your telephone to your network switch.
* To get power for your Snom Phone either a network switch with "'''POE'''" (Power over Ethernet) or a suitable Snom power supply unit
(usually 5V - No guarantee for damage when using an external power supply).

'''Please check in advance that your phone has the latest stable firmware version installed.'''

* Have a look on our Snom Wiki: [http://wiki.snom.com/Firmware Snom Firmware Guide]

'''Enter Snom Webinterface'''

Since auto provisioning is not supported by the innovaphone PBX, the Snom Phone needs to be set up using its web user interface (WUI).
To access the phone, type the IP address of your phone into your internet browser (e.g. http: //192.168.1.100).
To find out the IP address of your phone press the Configuration key (gear wheel symbol) -> "'''Information'''" -> "'''System information'''".

=== Register a SIP account ===

First select the " '''Identity 1''' " menu item on the left-hand side and enter the user ID and password you entered into the innovaphone PBX.

* '''Displayname:''' testphone1
* '''Account:''' 100 (telephone number)
* '''Password:''' 123 (as assigned in the innovaphone)
* '''Registrar:''' 192.168.100.250 (IP Adress of the innovaphone)

Click on "'''apply''' " below.

[[Image:innovaphone ip811 identity Login en.jpg]]

'''The phone configuration is now complete.''' Your Snom phone is now successfully registered on the innovaphone PBX and can make and receive calls.

==Contact Details==

{|
| Company Name: || Snom Technology GmbH
|-
| Street: || Wittestraße 30 G
|-
| ZIP/City: || 13509 Berlin
|-
| Country: || Germany
|-
| Phone: || +49 30 39833-0
|-
| Fax: || +49 30 39833-111
|-
| Mail: || [mailto:officemanagement@snom.com officemanagement@snom.com]
|-
| Internet: || [https://www.snom.com Snom Technology GmbH]
|-
| Contact: || [https://www.snom.com/de/kontakt/ Snom contact]
|-
| Support: || [https://service.snom.com Snom Service Hub]
|}

Howto:Snom IP phones - Snom - 3rd Party Product

2023-03-22T13:23:31Z

Nfi: /* innovaphone Reverse Proxy ready */

[[Image:Snom logo gray 60.jpg|350px|right]]

==Product name==


Snom [https://service.snom.com/display/wiki/Desk+Phones VoIP Deskphones]

==Certification Status==
{{Template:Compat_Status_referral_product_new}}

==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==




[[Image:Snom logo gray 60.jpg|250px]]

About us 

Founded in 1997 and headquartered in Berlin, Germany, Snom is a German multinational corporation that manufactures the world’s first and leading brand of professional and enterprise VoIP telephones.

==Description==
<table>
<tr>
<td colspan="5">Desk phones</td>
</tr>
<tr>
<td>D315 [[Image:Snom_d315_180x160.png‎|180px]]</td>
<td>D335 [[Image:Snom_d335_180x160.png‎‎‎|180px]]</td>
<td>D385 [[Image:Snom_d385_180x160.png‎|180px]]</td>
<td>D713 [[Image:Snom_d713_180x160.png|180px]]</td>
<td>D717 [[Image:Snom_d717_180x160.png‎|180px]]</td>
</tr>
<tr>
<td>
- 3.2" 300x100 pixel Hi-Res graphical display 
- 5 programmable function keys with red LEDs 
- 4 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D315 datasheet [https://service.snom.com/download/attachments/17370025/snom_D315_datasheet_en_1-1-1.pdf?version=1&modificationDate=1556009668153&api=v2]</td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D335 datasheet
[https://service.snom.com/download/attachments/17370025/snom_D335_datasheet_en_1-0-0.pdf?version=9&modificationDate=1571915926325&api=v2]</td>
<td>
- 4.3" 480x272 pixel Hi-Res TFT-color display 
- 12/48 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
 D385 datasheet 
[https://service.snom.com/download/attachments/17370025/snom_D385_datasheet_en_1-0-0.pdf?version=1&modificationDate=1556009676425&api=v2]</td>
<td>
- 2.8" 320x240 pixel Hi-Res TFT-color display 
- 4 programmable function keys with multicolor LEDs 
- 6 Sip Identites 
- 2x Gigabit Switch 
- PoE-Class 3
 
D713 datasheet 
[https://service.snom.com/pages/viewpage.action?pageId=96960609]</td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 5 programmable function keys with red LEDs 
- 6 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
 D717 datasheet 
[https://service.snom.com/download/attachments/17370025/snom_D717_datasheet_en_1-2-0.pdf?version=1&modificationDate=1571915760919&api=v2]</td>
</tr>
<tr>
<td>D735 [[Image:Snom_d735_180x160.png‎|180px]]</td>
<td>D785 [[Image:Snom_d785_180x160.png‎‎|180px]]</td>
<td>D862 [[Image:Snom_d862_180x160.png‎|210px]]</td>
<td>D865 [[Image:Snom_d865_180x160.png‎‎|210px]]</td>

</tr>
<tr>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D735 datasheet [https://service.snom.com/download/attachments/17370025/snom_D735_datasheet_en_1-4-0.pdf?version=1&modificationDate=1571915768754&api=v2] </td>
<td>
- 2.7" 320x240 pixel Hi-Res TFT-color display 
- 8/32 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 2
 
D785 datasheet [https://service.snom.com/download/attachments/17370025/snom_D785_datasheet_en_2-2-0.pdf?version=1&modificationDate=1571915775378&api=v2] </td>
<td>
- 5" High-resolution TFT-colour display 1280 x 720 pixels / 16:9 
- 8 programmable function keys with multicolor LEDs 
- 8 Sip Identites
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
D862 datasheet [https://service.snom.com/display/wiki/D862+Datasheet+-+EN]</td>
<td>
- 5" High-resolution TFT-colour display 1280 x 720 pixels / 16:9 
- 10 programmable function keys with multicolor LEDs 
- 12 Sip Identites 
- 2x Gigabit Switch 
- USB Support 
- PoE-Class 3
 
D865 datasheet [https://service.snom.com/display/wiki/D865+Datasheet+-+EN] </td>
</tr>
<tr>
<td>M110 [[Image:Snom_M110_88x160.png‎‎|160px]]</td>
<td>M430 [[Image:Snom_M430_180x160.png‎‎‎|170px]]</td>
<td>M900 [[Image:Snom_M900_180x160.png|100px]]</td>
<td>M900 Outdoors [[Image:Snom M900 outdoors 180x160.png‎|150px]]</td>

</tr>
<tr>
<td>
- DECT Single-Cell Base station + handset 
- 10 Sip Identites 
- 10 Handsets 
- 6 Simultaneous calls 
- Compatible handsets M10 SC 
- PoE-Class 2
 
M110 datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-sc-serie/snom-m110-sc-bundle/] </td>
<td>
- DECT Single-Cell Base station + handset 
- 20 Sip Identites 
- 20 Handsets 
- 10 Simultaneous calls 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M430 datasheet [https://www.snom.com/en/products/cordless-phones/m-series/snom-m430/] </td>
<td>
- DECT Multi-Cell with up to 1,000 bases in a cluster 
- Up to 4,000 handsets in a cluster 
- 8 NB, 4 WB calls per M900 base 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M900 datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-serie/snom-m900/]</td>
<td>
- Outdoors DECT Multi-Cell with up to 1,000 bases in a cluster 
- Up to 4,000 handsets in a cluster 
- 8 NB, 4 WB calls per M900 base 
- Compatible handsets M25,M30,M65,M85,M70,M80,M90 
- PoE-Class 2
 
M900 outdoors datasheet [https://www.snom.com/produkte/schnurlos-telefone/m-serie/snom-m900-outdoor/] </td>
</tr>
</table>

==Functions==




* Initiate outgoing call = yes
* Answer incoming call = yes
* Hold/Retrieve = yes
* Transfer = yes
* Call waiting = yes
* Do not disturb = yes
* Call Conference = yes ([https://service.snom.com/display/wiki/Ad-Hoc+Conference+-+V10 Snom - Ad-Hoc Conference])
* Call Park = yes
* Voice Messages Center
* Call Forward and divert = yes
* Intercom (HS to HS) = yes
* Called, calling, and connected party information = yes
* Missed-call notification = yes
* 1-touch speed dial = yes
* Redial = yes
* Zero touch provisioning, management, configuration and remote debugging = yes with SRAPS ( [https://service.snom.com/display/wiki/SRAPS See more informations here])
* SIP NATPR
* Background Upgrades = yes
* Dynamic Search of Network Based Directory = yes
* BLF = yes

==innovaphone CTI ready==
* Initiate outgoing call (automatic call with no manual intervention, update of called party, correct call direction in call list) = yes
* Hold/Retrieve = yes
* Transfer = yes

==innovaphone Reverse Proxy ready==

* STUN = yes
* TURN = No ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* ICE = No ([https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Third_Party_Phones not needed with 13r3])
* SIP/TCP = yes
* SIP/TLS = yes

==innovaphone WebRTC ready==


==Supported Codecs==

* G.722 = yes
* G.711 A-law = yes
* G.711 y-law = yes
* G.723.1 = yes
* G.729A = yes
* Opus = yes
==DTMF Support==


* SIP v1 (RFC2543), v2 (RFC3261)
* DTMF: In-band, Out-of-band(RFC 2833) and SIP INFO
==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==

* Supports RFC3261 Digest Authentication Scheme (Section 22.4)
==Support LDAP Phonebook==

* Support LDAP Phonebook = yes

For further informations please refer to this [https://service.snom.com/display/wiki/LDAP+Directory LDAP Directory configuration guide]

[[Image:Screenshot-ldap1.png‎]]

==Version==




Product versions used for interop testing: / Produktversionen, die für Interop-Tests verwendet werden:

* '''Snom D315''' FW: 10.1.25.0
* '''Snom D345''' FW: 10.1.25.0
* '''Snom D715''' FW: 10.1.141.13
* '''Snom D735''' FW: 10.1.141.13
* '''Snom D785''' FW: 10.1.141.13
* '''Snom D862''' FW: 10.1.141.13
* '''Snom D865''' FW: 10.1.141.13
* '''Snom M100''' FW: M100KLE-1.0.5.2-0 Handsets: M10KLE-1.4.5.12-0
* '''Snom M400''' FW: 650 B2 Handsets: 650 B2
* '''Snom M900''' FW: 650 B2 Handsets: 650 B2

* '''Innovaphone IP811''' FW:13r3 final IPVA[13.7758]
* '''Innovaphone cloud''' FW:13r3 final IPVA[13.7758]

== Konfiguration (German) ==

===Informationen zum PBX-System===
Die hier verwendete PBX ist eine innovaphone IP811. Die Angaben sind jedoch auf die weiteren innovaphone Modelle übertragbar.

Für die Sprachübertragung zwischen den VoIP-Komponenten wird das Protokoll SIP verwendet.




=== PBX Teilnehmer ===


[[Image:innovaphone ip811 pbx General new user en sm.jpg]]
[[Image:Snom_WUI_Identity_Innovaphone_sm_de.jpg]]

'''Hier gilt es ein paar Dinge zu beachten:'''

* Das Feld Number enthält die Telefonnummer. Diese tragen sie auch genau so im Webinterface (WUI) Ihres Snom Telefons ein unter "'''Identität 1'''" im Feld Account.
* Das Feld Passwort ist das gleiche das sie im Webinterface (WUI) Ihres Snom Telefons benötigen.

=== Konfiguration der SNOM Telefone ===

'''Bitte stellen Sie sicher, dass Ihr Telefon korrekt angeschlossen ist.'''

* Zuerst packen Sie Ihr Snom Phone aus und stellen Sie es auf den Tisch.
* Verwenden Sie dazu das beiliegende Netzwerkkabel und verbinden Sie die Buchse "'''Net'''" Ihres Telefons mit Ihrem Netzwerk-Switch.
* Um Ihr Snom Phone mit Strom zu versorgen, benötigen Sie entweder einen Netzwerk-Switch mit "'''POE'''" (Power over Ethernet) oder ein geeignetes Snom-Netzteil.
(in der Regel 5V - Keine Garantie für Schäden bei Verwendung eines externen Netzteils).

'''Bitte überprüfen Sie vorab, ob auf Ihrem Telefon die neueste stabile Firmware-Version installiert ist.'''

* Bitte besuchen sie hierfür unser Snom Service Hub: [https://service.snom.com/display/wiki/Firmware+Update+Center Firmware Update Center]

'''Snom Web-Benutzeroberfläche'''

* Da die automatische Bereitstellung von der innovaphone PBX nicht unterstützt wird, muss das Snom Telefon über seine Web-Benutzeroberfläche (WUI) eingerichtet werden.
* Um auf das Telefon zuzugreifen, geben Sie die IP-Adresse Ihres Telefons in Ihren Internet-Browser ein (z.B. http: //192.168.1.100).
* Um die IP-Adresse Ihres Telefons herauszufinden, drücken Sie die Konfigurationstaste (Zahnradsymbol) -> "'''Informationen'''" -> "'''Systeminformationen'''".

=== Snom Identität konfigurieren ===

Wählen Sie zunächst den Menüpunkt "'''Identität 1'''" auf der linken Seite und geben Sie die Benutzer-ID und das Passwort ein, die Sie in die innovaphone PBX eingegeben haben.

* '''Angezeigter Name''': testphone1
* '''Nutzerkennung''': 100 (Rufnummer)
* '''Passwort''': 123 (wie in der innovaphone vergeben)
* '''Registrar''': 192.168.100.250 (IP der innovaphone)

Klicken sie unten auf "'''übernehmen'''".

[[Image:innovaphone ip811 identity Login de.jpg]]

'''Ihr Snom Telefon ist nun erfolgreich an der innovaphone PBX registriert''' und kann Anrufe tätigen und entgegennehmen.




== Configuration (English) ==

===Information about the PBX system===
The PBX used here is an innovaphone IP811. However, the specifications are transferable to the other innovaphone models.

The SIP protocol is used for voice transmission between the VoIP components.

=== PBX User / Extension ===

[[Image:innovaphone ip811 pbx General new user en sm.jpg]]
[[Image:Snom WUI Identity innovaphone sm en.jpg]]

'''There are a few things to consider here:'''

* The "'''Number'''" field contains the telephone number. This same number is used in the "'''Account Field'''" in the web interface (WUI) of your snom phone under "'''Identity 1'''".
* Please provide a strong enough password for the account.

=== Configuration of the Snom phone ===

'''Please make sure your phone is set up correctly.'''

* First of all, unpack your Snom Phone and put it on the table.
* To connect it use the enclosednetwork cable and connect the "'''Net'''" socket of your telephone to your network switch.
* To get power for your Snom Phone either a network switch with "'''POE'''" (Power over Ethernet) or a suitable Snom power supply unit
(usually 5V - No guarantee for damage when using an external power supply).

'''Please check in advance that your phone has the latest stable firmware version installed.'''

* Have a look on our Snom Wiki: [http://wiki.snom.com/Firmware Snom Firmware Guide]

'''Enter Snom Webinterface'''

Since auto provisioning is not supported by the innovaphone PBX, the Snom Phone needs to be set up using its web user interface (WUI).
To access the phone, type the IP address of your phone into your internet browser (e.g. http: //192.168.1.100).
To find out the IP address of your phone press the Configuration key (gear wheel symbol) -> "'''Information'''" -> "'''System information'''".

=== Register a SIP account ===

First select the " '''Identity 1''' " menu item on the left-hand side and enter the user ID and password you entered into the innovaphone PBX.

* '''Displayname:''' testphone1
* '''Account:''' 100 (telephone number)
* '''Password:''' 123 (as assigned in the innovaphone)
* '''Registrar:''' 192.168.100.250 (IP Adress of the innovaphone)

Click on "'''apply''' " below.

[[Image:innovaphone ip811 identity Login en.jpg]]

'''The phone configuration is now complete.''' Your Snom phone is now successfully registered on the innovaphone PBX and can make and receive calls.

==Contact Details==

{|
| Company Name: || Snom Technology GmbH
|-
| Street: || Wittestraße 30 G
|-
| ZIP/City: || 13509 Berlin
|-
| Country: || Germany
|-
| Phone: || +49 30 39833-0
|-
| Fax: || +49 30 39833-111
|-
| Mail: || [mailto:officemanagement@snom.com officemanagement@snom.com]
|-
| Internet: || [https://www.snom.com Snom Technology GmbH]
|-
| Contact: || [https://www.snom.com/de/kontakt/ Snom contact]
|-
| Support: || [https://service.snom.com Snom Service Hub]
|}

Reference13r3:Concept App Service Contacts

2023-03-16T06:49:55Z

Nfi: /* Features */

[[Category:Concept|Apps]]
= Applies To =
* App Contacts version 13r3

= Overview =
The App Service Contacts is an App Service which can be installed on an innovaphone App Platform. It is used for information retrieval of a database of contact entries, as well as maintaining personal contact books.

Inside Contacts, personal and general entries can be searched (forward lookup) or be used to resolve incoming numbers to their respective name (reverse lookup).

= Features =
*Import: Semicolon (;) separated CSV file
*Database for contact entries: A user interface for retrieval purposes is available.
*API: Search API for other apps
*Edit Functionality: Contact entries are editable.
*Personal Address Book: Every user can maintain one or more personal address books.
*Access Right Management: Owners can maintain access privileges for single users or even groups of users, in order to control visibility of an address book.

= Requirements =
innovaphone PBX and App Platform from on version 13r3.
==Upgrade Considerations==
As always, don't forget to backup an existing App Platform in prior. This 13r3 App Contacts does alter the underlying database scheme.
;13r3 App on 13r1 App Platform, 13r1 PBX:Doesn't work. This 13r3 Contacts App does not work on an 13r1 Application Platform/Environment.
;13r3 App on 13r2 App Platform, 13r2 PBX:The 13r3 Contacts App works with the restriction, that the reverse lookup for private address books doesn't work. For full feature set, also upgrade the App Platform and PBX to 13r3.

=Apps=
=== Contacts App (innovaphone-contacts) ===
The regular app
=== Contacts Admin App (innovaphone-contacts-admin) ===
Features a menu (top-right) to manually upload a CSV file
=== Contacts Search API (innovaphone-contacts-searchapi) ===
This hidden app rovides a search API to other apps, e.g. for the Phone App

= Concept =
General contact entries and entries for personal directories are stored within the same database. With the table '''acl''' which is acting as an access control list, restricted views and edit rights for personal directories can be granted.

This way, only the owner of a personal directory (and granted user or groups) can see the content.

==Number handling==
In principle, two versions of a phone number are always stored in the contacts database.
;Original Number
:This is the unchanged number imported by the user. This version includes all decorative characters, spaces, etc. (eg. +49-(7031) 730090)
;Formatted number
:A filter is applied to the original number before saving to remove all non-dialable characters. (This means that only <code>0-9,+,*,#</code> remain after that) This formatted version of the call number is saved in addition to the data set. (eg. +497031730090)

If a number is searched for (reverse lookup), the cleaned version is searched for. Thus, it does not matter which decorative characters or formats are imported.
If an entry is displayed to the user, the originally entered call number (incl. decoration characters) is displayed.

It is therefore best practice to import only international format numbers (Decorations can be imported as they will be removed anyway), as the PBX always converts the number into the international format for a reverse lookup, if the [[Reference13r1:Concept_Number_Adjustments_%28Dialing_Location%29 |dialing location]] was configured correct.

==Assign unique IDs for contacts entries==
It is recommended to upload CSV files with an additional column ''extAnchor''. The column extAnchor allows to identify individual entries uniquely and independent of renaming operations. The column ''extAnchor'' is supposed to contain an external unique database id, alike a guid. If ''extAnchor'' was provided the import procedure will perform an UPDATE of previously existing entries, instead of deleting and re-INSERTing the entries. Entries pinned on home are going to remain functional.

==List of Attributes==
The list of currently available attributes for a contacts entry follows:
;extAnchor
: unique id identifying the entry within the database
;givenname
:First name
;sn
:Surname/Family name
;company
:Corporation
;displayname
:Name to be displayed
;email
:e.g. ''example@example.com''
;telephonenumber
:Internationalized land-line telephone number, e.g.'' +49 7031 730090''
;mobile
:Internationalized mobile telephone number
;homephone
:Internationalized home phone number
;facsimiletelephonenumber
:Internationalized fax number
;city
:City/Town, e.g. ''Milano''
;street
;postalcode
;state
:Federal state, e.g. some US states: ''Ca, Wa, Fl''
;country
:e.g. ''Deutschland, Italia''
;privatecity
:Home address
;privatestreet
;privatepostalcode
;privatestate
;privatecountry
;title
:Academic title
;position
:Position within company, department
;department
;description
:Common description
;roomnumber
;info
:Common info
;url
:Company URL
;sip
:Dialable SIP address

==List of Text-Indexable Attributes==
Attributes to be considered for the full-text index
*cn
*sn
*givenname
*company
*displayname
*info
*city
*street
*postalcode
*country
*state
*private_city
*private_street
*private_postalcode
*private_country
*private_state
*title
*position
*department
*description
*roomnumber
*sip

==Built-in LDAP Server==
The App incorporates a proprietary LDAP server functionality. The purpose of the LDAP server functionality is to service innovaphone LDAP clients, such as desk phones.
The LDAP server only supports a proprietary search by means of a meta attribute<ref>Meta attribute: Here an attribute with a special meaning and that is non-physical, not existing within the database</ref>, whereby LDAP is just utilized as a transport vehicle for a user's search input one-to-one.
*E.g. a user searching for ''John Doe innovaphone''
**Possible user input ''jo do inno''
**Resulting LDAP filter ''(metaSearchText=jo do inno)''

'''Important:'''<br\>
Note, that access to restricted/personal phone books requires the proprietary scheme within the LDAP client, mentioned above.<br\>
Currently, this is available in the innovaphone IP phone LDAP clients from 13r3 on, but not on 3rd party devices nor our DECT gateways (IP120x). On these clients, only contact data in unrestricted phone books is searched.

===Sample Phone Configuration, innovaphone===
Phone/User-X/Directories/External LDAP Server
;Enable: Active
;Use TLS: Active
;Server: <host adddress of App Platform>
;Port: <can be left empty>
;Username,Pw: <Credentials for LDAP Bind operation>
;Search Base: ''dc=entries''
;Mode: <can be left on "basic">
;Object Filter: <leave empty>
;Sort Results: Inactive
;Name Attributes: ''givenName,sn,company''
;Number Attributes: <can be left empty>
;H323 ID Attribute:'' sip''
;Detail Attributes: ''title,company,street,postalCode,city,country,email,url''
;Meta Name Attribute: ''metaSearchText''
;Meta Number Attribute: ''metaSearchNumber''

= Personal Address Book Details =
With version 13r3 it is now possible, to add, editing and delete contacts. It is also possible to create and maintain personal address book(s), as well as share them with other users or whole user groups.

Only user/groups with sufficient rights, will be able to see other address books. An Access control list (acl) is used, to control these rights.

Groups correspond to PBX-groups. The Contacts App gets to know only active PBX-group memberships.

By default, only the user who created an address book, is able to see the content.

==Maintain a Personal Address Book==
;Creating a Personal Address Book
Click on the burger menu in the top right corner inside the Contacts-App, and there on the '''"Directories"'''. Now click on the '''"+"'''-Symbol, choose a suitable name and confirm your name via '''"Save"''' button. A new address book is created.
;Adding a new contact
Click on the '''"+"'''-Symbol in the top right corner inside the Contacts-App and select an address book, where you want the contact to be stored in. Now fill in the contact information (the fields ''"name"'' and ''"last name"'' '''have to be filled''') and save it via '''"Save"'''-button.
;Editing an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, click on the entry you want to edit and after your change, save it via '''"Save"'''-button on the bottom.
;Delete an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, and on the '''"trashcan"'''-symbol at the top. After confirmation, the entry is deleted.

==Sharing of Address Book==
;Share globally
*Either remove all rules from a personal directory. Such a configuration corresponds to pre-13r3 capabilities. Up to 13r2 there weren't any visibility rules available.
*Or make every PBX user an active member of a group e.g. "everybody" and add a directory rule for that group "everybody".

;Share with single user(s)
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"User"''' as type. In the input field, you can enter and therefore filter for all available users. Select the user, whom you want to give access and select either if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''.

;Share with a group
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"Group"''' as type. In the input field, you can enter and therefore filter for all available PBX groups. Also select, if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''-button.

;Revoke of granted rights
You can also revoke previous granted rights by just clicking on the user/group at the access control list, and click on the '''trashcan''' symbol. Now submit your change with another click on '''Ok'''-button.

==Upload a new Directory==
The Contacts Admin App allows uploading a CSV file as known from the 13r2 version ('''Hamburger/Import'''). In the course of an upload operation, a new directory will be created. The newly assigned directory name will be the name of the CSV file.
After uploading, the visibility setting of the new directory should be administrated as stated before under [[#Sharing_of_Address_Book|Sharing of Address Book]]

==Terminology==
;ACL: Access control list. Refers the database table ''acl'' and rows/entries therein.
;Directory: Refers the database table ''dbs'' and rows/entries therein. All contact entries referencing a ''dbs''-row make up the content of a directory.
;Address Book: Synonymous with ''Directory''
;Contacts Admin: A user utilizing the Contacts Admin App (via App URL, ending with ../innovaphone-contacts-admin)
;Directory Admin: A user entitled the admin right for a directory. Either by user-wise or by group-wise ACL entry.
;Directory User/Viewer: A user entitled the viewing right for a directory. Either by user-wise or by group-wise ACL entry.

==Database Changes==
Three tables realize the functionality for personal directories.
*Table '''dbs'''. Each row represents a directory. Two new columns ''displayname, sip'' where added.
**'''displayname''' Name display.
**'''sip''' Creator's sip name, if available.
*Table '''acl'''.New table acting as access control list. Each row references a directory as listed by table ''dbs'' and is going to grant view- and admin-right to a specific user or group.
**'''dbsid''' Reference into table dbs.
**'''name''' The name of a user or a group.
**'''acltype''' A numeric value: user(0), group(1)
**'''admin''' Granting edit right: admin(true), non-admin(false)
*Table '''entries'''. Each row within this pre-exisisting table represents a contact entry. The column ''dbsid'' informs about whether an entry belongs to a specific directory.<code type="sql">
#Excerpt for an additional directory ''Persönliches Verzeichnis: mst'' with one contact entry.

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri | displayname | sip
----+------------------------------------------------------+--------------------------------+-----
7 | file:///4eaae395-9971-40fb-9a05-dfae1d023f12?sip=mst | Persönliches Verzeichnis: mst | mst # Specification for directory ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from acl"
id | dbsid | name | acltype | admin
----+-------+------+---------+-------
5 | 7 | mst | 0 | t #user 'mst' can view and edit directory with dbsid=7 ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select sn,givenname,company,id,dbsid from entries where dbsid=7"
sn | givenname | company | id | dbsid
----------+-----------+--------------+-------+-------
Duck | Dagobert | Duck Corp. | 51394 | 7 # main table entries contains 1 entry belonging to ('Persönliches Verzeichnis: mst')

</code>

==Reverse Number Lookup for Personal Directories==
Queries into directories are access-checked by looking-up and enforcing ACL-rules. The information on whose name is being queried and which group memberships are taking effect is needed for this process.

Websocket connections to the Contacts App service carry those infos within the SDK method ''AppWebsocketConnectComplete()''.
LDAP connections pass this information within a proprietary LDAP control together with an LDAP searchRequest message.

The PBX's centralized Reverse Lookup service (see ''PBX/Config/General/Reverse Lookup URL'') does support this mechanism. That is, for every LDAP searchRequest the affected user's name and active group memberships are going to be sent towards the Contacts App's LDAP server.

See also [[Reference13r1:Concept_Reverse_Lookup|concept article on reverse lookup]].

=Upload Data by HTTP Post=
A CSV file can be uploaded by means of an HTTP POST request.
The following powershell script aims to demonstrate this procedure with the help of CURL<ref>For a windows distribution: e.g.: https://curl.haxx.se/download.html </ref><ref>CURL is recommended(rather required), because it supports the simple POST mechanism with an initial tentative POST with the data length of 0, in order to get through the authentication phase</ref>
The required user and password content corresponds to the configuration underneath '''PBX Manager/AP Contacts/Configuration/User(HTTP Post)''' and '''Password(HTTP Post)'''
<code type="powershell">
# csv.ps1
# Sample powershell script demonstrating how to HTTP POST a CSV file towards the Contacts App service.
# .\bin\curl must be present, e.g. from https://curl.haxx.se/download.html
# Examples:
# powershell -ExecutionPolicy Bypass -Command .\csv.ps1 -Dest 172.16.18.215 -File ".\myContacts.utf8" -User "contacts01" -Pw "pwd01" -Url "/example.com/contacts01/post/myContacts.utf8?op=csv"

param(
[Parameter(Mandatory=$false, HelpMessage="Destination host")]
[string]$Dest,
[Parameter(Mandatory=$false, HelpMessage="Name of file to be POSTed")]
[string]$File,
[Parameter(Mandatory=$false, HelpMessage="Authentication: User")]
[string]$User,
[Parameter(Mandatory=$false, HelpMessage="Authentication: Password")]
[string]$Pw,
[Parameter(Mandatory=$false, HelpMessage="URL, e.g.: /example.com/contacts01/post/myContacts.csv?op=csv&xml-stats=true")]
[string]$Url
)

Add-Type -AssemblyName System.Web

$Uri = "http://" + $Dest + $Url

function UploadToContacts {
# Ensure file's there and has content
if (!(Test-Path -Path $File)) {
echo $File+" not downloaded!"
exit 1
}
$lines = 0
Get-Content $File |%{ $lines++ }
echo "Lines of $File=$lines"
if($lines -le 2) {
echo "No Data to upload!"
exit 1
}

$auth = "${User}:${Pw}"

echo "POSTing towards $Uri"
.\bin\curl "--digest" -s -S --trace-time -u $auth -i -H "Content-Type:application/octet-stream" -X POST --data-binary "@${File}" "${Uri}"
echo "POSTed towards $Dest"
}

$timeStart = Get-Date
echo "===Begin: ${timeStart} ==="
UploadToContacts
$timeEnd = Get-Date
echo "===End: ${timeEnd} ==="
echo ""
</code>
== The URL ==
The first part of the URL (''example.com/contacts01'') is the ''Webserver path'' configured for the ''Contacts'' instance in the ''App Platform Manager''. It must be followed by the literal <code>post</code>. The last part (''myContacts.csv'') can be chosen freely.

Note that the last part of the URL used to post the file (''myContacts.csv'' in the example above) needs to be chose carefully. ''Contacts'' will remember this name as source for each of the uploaded entries. When the file is posted again (that is, when a new POST using this last URL part is done), ''Contacts'' will first delete all existing entries previously uploaded with this name and then add the new ones.

=Troubleshooting=
To collect debugging data, activate the '''''App''''' and App '''''WebSocket''''' trace options at the contacts instance on the App Platform Manager. Now reproduce the issue and save the logfile.

==Manually Deleting an uploaded File==
If multiple files or multiple versions of a CSV file were uploaded, it might not be clear how to delete an old data set. Here is an example for how to accomplish a deletion of a particular data set related to an imported CSV file:
*2 Files were previously imported
**''allcontacts.csv''
**''brs%20testimport.csv''
*The file ''brs%20testimport.csv'' shall be deleted
*Hints
**Within the Contacts database, the table ''dbs'' contains the names of files once imported.
**The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<code type="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#Command 'psql'. Printing the table 'dbs'. Contains 2 file names.
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri
----+----------------------
1 | allcontacts.csv
5 | brs%20testimport.csv
(2 rows)

#Delete the file "brs%20testimport.csv" via its table-ID 5.
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from dbs where id=5"
DELETE 1

#Printing the table 'dbs'. Contains 1 file name.
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri
----+-----------------
1 | allcontacts.csv
(1 row)

root@app-platform|/mnt/sda2/home/admin>

</code>

==Manually Deleting all Contacts==
Sometimes it may become necessary to delete all contacts from the database. This task can be accomplished by simply deleting the main table ''entries''. The deletion will cascade from there into all sub-tables.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<code type="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
94
(1 row)

#Delete
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from entries *"
DELETE 94

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
0
(1 row)
</code>

==Manually Exporting all Contacts==
Sometimes it may become necessary to export all contacts from the database.
This task can be accomplished by reading the main table ''entries'', separate attributes by ; and store the result in a given csv-file.
The csv-file has to be located in a separate folder with appropriate access rights.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<code type="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#create new folder export and grant access rights
root@app-platform|/mnt/sda2/home/admin> mkdir export
root@app-platform|/mnt/sda2/home/admin> chmod 777 export

#Retrieve all database entries, separate them by ; and store in file
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "copy entries to '/mnt/sda2/home/admin/export/contacts.csv' delimiter ';' CSV HEADER"

</code>

The generated csv-file can be downloaded by use of an sftp-client (e.g. WinSCP) and login to the AP with admin credentials.



= Known Issues =
* [[Support:Contacts_on_HomeScreen_can%27t_be_open_after_modification_on_ContactsAPP | Contacts on HomeScreen can't be open after modification on ContactsAPP]]
* [[Support:Contacts_Upload_Fails_From_Within_myApps_Launcher | Contacts Upload Fails From Within myApps Launcher]]
* [[Support:Forward_search_shows_no_result | Forward Search shows "no result"]]
== DECT Phones Cannot Access Personal Directories ==
DECT gateways do not support the mechanism required to query into directories with restricted access rules. Hence, DECT mobile phones cannot search into such directories.

== No automatic ACL update on name changes ==
If a users h323 name is changed, all ACL entries in address books, to which the user has rights, also need to be changed manually, since there is no automatic update between the PBX and the address books.

= Related =
<references/>

Howto13r3:Firmware Upgrade V13r2 V13r3

2023-01-27T06:35:54Z

Nfi: /* Shared AP/Several PBX'es */

{{FIXME|reason=This article is still work in progress}}
== Applies To ==
This information applies to:

* All 13r3 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 13r3, see [[Howto:Firmware Upgrade]]

== Migration Policy ==
Here is how you upgrade a system to 13r3 from 13r2. For hints on upgrading a system to 13r2 see [[Howto:V13_Firmware_Upgrade_V13r1_V13r2]].

=== Single AP/Single PBX===
* Create a new update job in devices and select 13r3 as major version

===Shared AP/Several PBX'es===
We generally recommend to upgrade the entire system (endpoints, PBXs, AP) in ''one shot''.

If this is not possible for any reason, the recommended sequence is:
# update the master PBX
# update the slave PBX and all its endpoints location by location
# update the App Platform to the latest build
# update all Apps
# perform the configuration changes described below

Note that during the update time frame, some App data such as Reporting and Recording may be incomplete.

We recommend to review all the configuration changes described below before you begin the update.

== Configuration Changes ==
In 13r3 we have introduced some new features which are automatically configured if you use the installer to setup your new 13r3 from scratch. If you upgrade an existing installation, you have to configure the following settings manually.

=== Default SRTP key exchange value in device configuration of Phones/Interfaces ===
Before v13r3, the default value for SRTP key exchange was SDES-DTLS - with v13r3 it changes to the more secure DTLS-SDES. Therefore innovaphone devices now use DTLS instead - if the called endpoint has this preference. To make sure the more secure key exchange is used, we recommend adjusting the ''SRTP key exchange setting'' in the Devices App, ''Device Configuration'' for ''[Phone]'' and ''[Analog phone/fax]''. An exception to this recommendation is if you are using old phone models (IP110A, IP240A) or gateway models (IP24, IP22) in your setup - as these may have CPU performance issues in the connection setup phase. In that case, use '''SDES-DTLS''' as value for the ''SRTP key exchange'' for all devices, not only for the old phone models.

===Group Fax===
The fax object has to be configured as external resource of a group fax object in 13r3. It is therefore '''mandatory''' to assign the fax object as an external resource to all group fax objects after the upgrade.

Also, with 13r3, group faxes can have their own international fax number and company name, so you should fill in these fields, or else the fax header will be empty.

===Contacts App | User drop-down menu for sharing address books===
With 13r3, personal address books can be created and shared with users/groups. To have a search and drop-down menu in the sharing step, you have to activate the "Admin" option at the "ContactsApi" app object (tab "App") over the Advanced UI. Otherwise, no results will be shown, and you have to enter the correct h323 name of a user.

===Improved Conference Rooms===
* The ''Web Access allowed'' checkbox in the conference app has to be set in order to access the Conference Web Access UI.
: To be able create HTTP links for external participants, the conferencing App is required.
* Update the [[Reference13r3:PBX/Objects/Conference/Announcement_types#Sample_Announcement_Files | announcements]] for your conference rooms, to include also the ''Web Access announcements''.
* it is recommended to use a second Turn-Server listening on TCP port 443 as a fallback option for external conference participants, with local firewalls not allowing access to your standard Turn-server. Configure this second Turn-Server in [[Reference13r3:IP4/General/STUN#TURN_Extern | IP4/General/STUN -> Turn Extern]] [[User:Sga|Sga]] TBD: info zu inno Turn Fallback server
* 13r3 adds a search-API for the Conference Rooms, allowing users to search for Conference room names from their Phone, Softphone or RCC App. Each conference object provides its own search API which is named like ''<Name-of-conference-object>.search'' and access to it can be granted using the App-Section of a PBX-object. The PBX-Manager Plugin for Conferences offers also an option to add the rights for all conference rooms and their search-APIs to the Config-User and/or Config-Admin template.

=== NTLM/OAuth===
13r3 introduces OAuth2 Windows Authentication for myApps. If your are currently using NTLM/Netlogon for authentication, you might want to consider upgrading it OAuth2, since this authentication mechanisms is more secure. See [[Reference13r3:Concept OAuth2 Windows Authentication]] for details.
In 13r3 only Microsoft AD FS is supported as OpenID Server.

===HTTP-Proxy===
13r3 introduces [[Reference13r3:Concept_myApps_platform_services#HTTP_proxy_support | HTTP-Proxy]] support for myApps. Now, myApps follows by default the OS-settings regarding HTTP-Proxy. This might affect existing setups when updating from 13r2 to 13r3. We recommend to check before a 13r3 update if an HTTP-Proxy is used and if so, test before the update for interop problems between myApps and the used HTTP-Proxy.

===Physical Location===
The Softphone App supports in 13r3 the determination of the Physical Location. Similar to an IP-Phone, this is determined automatically based on HTTP-Redirects of the myApps PBX-login process. If you use PBX-objects with activated "Local" option (often this is a Trunk Line object), the determined physical location might lead to a different behavior when calling these objects. If this leads to unwanted call flows, you can either adjust the initial myApps registration PBX or configure the Physical location manually at the Softphone.

== Application Platform and its applications ==
===App Platform image===

It is not mandatory but recommended to [[Reference13r3:Concept_App_Platform#Update_of_the_App_Platform_itself | update the App Platform image]] to the latest version to receive a newer kernel and updated Linux packages.

===Recordings App===
Please follow the procedure described in the [[Reference13r3:Concept_App_Service_Recordings#Upgrade_from_V13r2_to_V13r3_Recordings_App | Recordings App concept article]].

===Reports App===
The Reports App will improve missed calls queries by adding a new database index during the first start after an update. Depending on the size of the reporting database, this database adjustment can take some minutes and results also in high CPU-load and missed CDRs during that time.

=== App Service Queues, Switchboard App ===
To allow monitoring of all queues by all switchboard users, configure a group (e.g. with the name ''queues'') in the PBX and assign it as '''Static''' to all Waiting Queues used by the Switchboard App and assign it also as '''Static''' and '''Active''' to all Switchboard Users.

===Apps new in 13r3===
New Apps will not be installed automatically by the 13r2 to 13r3 upgrade. The installation description of new 13r3 apps is usually in the concept article. New apps are:
* [[Reference13r3:Concept_App_Service_Connector_for_kuando®#Configuration | Connector for kuando®]]
* [[Reference13r3:Concept_App_Service_Connector_for_Microsoft_365 | innovaphone myApps Connector for Microsoft 365]]

== Changes visible to end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a 13r3 upgrade, as the change will be visible/audible in the behaviour of the application/device.
===Rework of Phone & Softphone UI===
Several feature and UI improvements, see 'Features' in [[Reference13r3:Concept_App_SoftphoneApp#Features | Reference13r3:Concept App SoftphoneApp ]] and [[Reference13r3:Concept Multi-Video-Conference]].

===CallForwarding in Profile App===
Added configuration option on call diversions: call forwardings depending on ''myApps online'' and ''Presence'' state. This can be switched on or off by the user in the Profile App.

===Focus App===
The "App focus" can be used to define a default app for the user. It is started and shown automatically when myApps is loaded. When closing other apps, the app is shown instead of the home screen. Users can activate (default) or deactivate the Focus function in their myApps Client settings (hamburger menu). See 'Features' in [[Reference13r3:Concept_myApps#Features | Reference13r3:Concept myApps]]

===Pin Apps===
Apps can be pinned to the main window. Pinned apps are always running and can't be closed. They are also started automatically when the myApps client is loaded. This setting is locally stored per-client. So you can pin different apps on your computer and your smartphone. See 'Features' in [[Reference13r3:Concept_myApps#Features | Reference13r3:Concept myApps]]

=== Fax App ===
The [[Reference13r3:Concept_App_Service_Fax#Mail_Configuration | Mail Configuration]] section of the Fax App offers in 13r3 additional options:
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF
* Error notifications for outgoing fax jobs

==Hardware Restrictions==
For a list of devices with no/restricted support in 13r3, see the [[Howto:Firmware_Upgrade#Version_13r3 | Firmware Upgrade article]].

==Known Problems==

===Boolean App===
Following the update to 13r3, it is not possible to edit Boolean Apps using the myApps client (except when using the myApps client in a web browser). To resolve this issue, you will need to delete the approxy folder for all users who use the boolean app. You can locate this folder in the following directory: %USERPROFILE%\AppData\Local\innovaphone\myApps.
Reload or restart myApps afterwards.

===Current major issues that will be fixed with upcoming 13r3SR1 release===
* [[Support:PBX_13r3_final_trap_with_Unknown_Registrations | PBX 13r3 Final trap with Unknown Registrations]]
* [[Support:13r3final_App_Platform_-_SMTP_delivery_may_fail_due_to_IPv6_DNS_results | 13r3final App Platform - SMTP delivery may fail due to IPv6 DNS results]]
* [[Support:13r3final PBX randomly does not execute CFU | 13r3final PBX randomly does not execute CFU]]

More info on other 13r3 SR1 changes can be found in the [[Reference13r3:Release_Notes_Firmware#13r3_Service_Release_1 | Release Notes]].

== Resources Considerations ==
New firmware always has more features which in turn requires more resources. Growing firmware will thus consume both more flash and RAM for sure. A given system configuration will run flawlessly after a firmware largely only if there is still enough memory left after boot.

Standard configurations which are according [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported | the specs ]] will run on all supported hardware. However, unusual configurations may not. It is a good idea to examine both flash and RAM memory left on high load situations in your existing configuration to see if there is enough resources left for an upgrade. Please find details in [[Reference:Device Health Check]].

=== RAM ===
As a rough rule of thumb, a 13r3 release will consume the same amount of RAM compared to a v13r2 firmware.

=== Flash Memory ===
As a rough rule of thumb, a v13r3 release will consume ~ 0.5 MB flash more compared to a v13r2 firmware.

New firmware comes with new code for new features which consumes more flash memory for the firmware image. For this reason, devices may run out of flash memory during upgrade to v13r3. Here is the recommended procedure for upgrade on such devices:

* save entire configuration
* reset to factory defaults
* load saved configuration (this will reorganize the flash memory usage)
* upgrade to new firmware

When there is still not enough flash memory available to store the new firmware (Web GUI ends up in a ''Firmwareupdate failed:no space'' / Update client end in a ''Error 0x00130001 Major FLASHMAN0 no space'' event) please open a support case with your current configuration file.

=== Conferences ===
Since Conferences now use [[Reference13r3:Concept_Multi-Video-Conference | multiple video streams]] to display each conference participant (in 13r1 & 13r2 only the video stream of the speaker was shown), the number of concurrent video streams used in a single conference increased. Please review this [[Reference13r3:Concept_Multi-Video-Conference#Bandwidth_Consideration | bandwidth considerations]]. As a result, a device hosting a multivideo conference on its CONF or SCNF interface has a higher CPU load in 13r3 than in 13r2.

[[Image:13r3_conference_bandwidth.png|700px|Estimated Conference bandwidth requirements]]

The graph shows the bandwidth needed for a device running the CONF interface to participate in a conference. The values shown are for when all participants are in gallery mode (which is the worst case scenario) and in fullscreen presentation mode (which is the best case scenario). In general, the actual bandwidth needed will fall somewhere between these two extremes. To calculate the CPU requirements for the device, you can use the following formula: CPU% = Bandwidth (in Mbps) / x, where x is 0.42 for a xx10 device, 0.56 for a xx11 device, and 3.6 for a xx13 device. For example, if you are hosting a conference with 10 participants on a xx11 device in gallery mode, the upstream and downstream bandwidth would be 25 Mbps. Using the formula, you can calculate the CPU requirements as follows: CPU% = 25 Mbps / 0.56 = 44.64%. This means that the device should have at least 45% free CPU capacity to handle the conference.

From the client's perspective, the worst case values for upstream bandwidth (when presenting) would be 1 Mbps, and for downstream bandwidth (when in a gallery mode conference with 20 participants) would be 5 Mbps.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
*[[Support:PBX_V13r3_Final_trap_with_Unkown_Registrations]]

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

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-12-22T15:09:46Z

Nfi: /* RTP Range Configuration */

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server is not part of this article (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

This is not part of this Step by Step article: If you already have a TURN server in use, you can enable the TURN setting and have not configured a '''Firewall public IP''' in your PBX. You need to configure the '''TURN Public Address''' in your TURN server settings. In this case, you would route the RTP traffic to the TURN server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on the PBX (or the TURN server, depending on whether the TURN flag is active). Please go to IP4/General/Settings on your device PBX (or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Calling a Voicemail has no audio, while calling a conference there is no audio after the PIN is dialed.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-12-20T17:05:17Z

Nfi: /* Configuration of the PBX */

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server is not part of this article (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

This is not part of this Step by Step article: If you already have a TURN server in use, you can enable the TURN setting and have not configured a '''Firewall public IP''' in your PBX. You need to configure the '''TURN Public Address''' in your TURN server settings. In this case, you would route the RTP traffic to the TURN server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Calling a Voicemail has no audio, while calling a conference there is no audio after the PIN is dialed.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-12-20T15:31:22Z

Nfi: /* Requirements */

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server is not part of this article (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

If you already have a TURN server in use, you can enable the TURN setting and have not configured a firewall public IP. In this case, you would route the RTP traffic to the TURN server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Calling a Voicemail has no audio, while calling a conference there is no audio after the PIN is dialed.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-12-20T15:23:13Z

Nfi: /* Limitations */

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

If you already have a TURN server in use, you can enable the TURN setting and have not configured a firewall public IP. In this case, you would route the RTP traffic to the TURN server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Calling a Voicemail has no audio, while calling a conference there is no audio after the PIN is dialed.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-12-20T15:22:55Z

Nfi: /* Known issues */

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

=== Limitations ===

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

If you already have a TURN server in use, you can enable the TURN setting and have not configured a firewall public IP. In this case, you would route the RTP traffic to the TURN server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Calling a Voicemail has no audio, while calling a conference there is no audio after the PIN is dialed.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]