innovaphone wiki - User contributions [en]

Reference16r1:Concept App Service Working

2025-10-09T12:42:13Z

Mpu: Created page with "The Working App is used to record working hours and manage absences. The Working User app can be used to start/stop time tracking and create vacation requests. There is also an admin app (Working Manager) which allows users to view working hours and approve vacation requests. == Applies To == * innovaphone PBX from version 16r1 ==Requirements== * innovaphone PBX * innovaphone Application Platform * innovaphone myApps * Firmware V16r1 beta1 or higher * License “App(..."

The Working App is used to record working hours and manage absences. The Working User app can be used to start/stop time tracking and create vacation requests. There is also an admin app (Working Manager) which allows users to view working hours and approve vacation requests.

== Applies To ==

* innovaphone PBX from version 16r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V16r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an application for digital time and absence management.

It consists of two parts:

* '''Working User App''' – used by employees to track their working hours (via clock-in/clock-out or manual entries) and to manage absence requests such as vacation or leave. Time entries and vacation requests must be confirmed (=submitted) before they appear in the admin app. Once confirmed, they can no longer be edited.
* '''Working Manager App''' – used by administrators or managers to view and manage working time and absence information for all users. It also allows approval or rejection of vacation requests and provides access to configuration settings.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==
=== Working ===
===== Working time tracking and costume work types =====

* Work time account: Overview of the current work time balance
* Add pre-defined labels to working times

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group
* Enable/Disable verification by manager before submission to Human Resources

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====
=== Absences ===

==== vacation management ====

* Creating and approving vacation requests
* Define vacation rules in general and user-specific terms

==== holidays and sick days ====

* Entering sick days and public holidays

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).

* Rights
** Config groups 

== Import and export of existing tracked time and absences with the help of CSV ==
=== CSV export ===
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

=== CSV import ===
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference16r1:Apps/PbxManager/App Working

2025-10-01T09:24:55Z

Mpu:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}
This PBX Manager Plugin contains 2 section:
* Add, edit or delete Working App on the PBX.
* Configuration: Setting target Master PBX .

== Configuration ==
; PBX Name
: This field specifies the master PBX to ensure that searches and data replication are performed on the correct PBX

== Add an App ==
; <nowiki>Name: </nowiki>
: The name displayed for the App Object.

'''SIP:'''

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

'''Config templates:'''

: Select which config templates will allow to access the App Object.

== App objects ==
; Working User
: This is an app, where the user can enter the working hours, holidays, sick and vacation days

; Working Manager

:This is an app that allows you to monitor working times, there are two types of rights:

: - The Human Resources view where all working times can be viewed
: - The Manager view, where managers only see the working times of the associated group
; Working API
: This is a hidden app, where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

;Working Client API
: This is an app needed to provide the Working Client API, so that other apps can start/stop working times.

Reference16r1:Apps/PbxManager/App Working

2025-10-01T09:22:41Z

Mpu: Created page with "This PBX Manager Plugin contains 2 section: * Add, edit or delete Working App on the PBX. * Configuration: Setting target Master PBX . == Configuration == ; PBX Name : This field specifies the master PBX to ensure that searches and data replication are performed on the correct PBX == Add an App == ; <nowiki>Name: </nowiki> : The name displayed for the App Object. '''SIP:''' : The sip from the App Object, which must be unique '''Config templates:''' : Select which c..."

This PBX Manager Plugin contains 2 section:
* Add, edit or delete Working App on the PBX.
* Configuration: Setting target Master PBX .

== Configuration ==
; PBX Name
: This field specifies the master PBX to ensure that searches and data replication are performed on the correct PBX

== Add an App ==
; <nowiki>Name: </nowiki>
: The name displayed for the App Object.

'''SIP:'''

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

'''Config templates:'''

: Select which config templates will allow to access the App Object.

== App objects ==
; Working User
: This is an app, where the user can enter the working hours, holidays, sick and vacation days

; Working Manager

:This is an app that allows you to monitor working times, there are two types of rights:

: - The Human Resources view where all working times can be viewed
: - The Manager view, where managers only see the working times of the associated group
; Working API
: This is a hidden app, where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

;Working Client API
: This is an app needed to provide the Working Client API, so that other apps can start/stop working times.

Howto:How to IPxx13

2025-04-11T13:18:52Z

Mpu: /* Power supply */

[[Category:Howto]]
[[Category:Concept IPxx13]]

== Applies to ==
* IP0013
* IP6013
* V13+

== Brief ==

=== IP0013 ===
* VoIP-PBX and routing gateway including reverse proxy and SBC functionalities
* Orderno.: 01-00013-001

=== IP6013 ===
* VoIP-PBX and routing gateway for four ISDN-S2M interfaces plus Reverse Proxy and SBC functionalities
* Orderno.: 01-06013-001

== SSD ==

IPxx13 owns two internal slots for '''M.2 SSD'''.

Slot interface is '''NVMe''' - [https://en.wikipedia.org/wiki/NVM_Express non volatile memory express].

Slot formfactor is M.2 2242 M-Key - dimensioning 22mm*42mm.

Maximum power consumption per M.2 SSD is 2.5W.

SSD has to be plugged in outer slot SSD0. Use of secondary inner slot SSD1 is not supported.

innovaphone offers and supports M.2 SSD 512 GB with order no 03-00010-017.

Technical support in terms of investigation for other SSDs is not forseen.

Note: '''These information DO NOT APPLY to IPxx11 and IP11xx based mSATA SSDs!''' For information to those devices, refer to [[Howto:Tested mSata modules|this article]].

== Power supply ==

The devices mandatorily require Power over Ethernet+ supply according to IEEE 802.3at, Class 4 (PoE+) for operation.

Currently, innovaphone offers no POE+ injector.

We recommend the following PoE+ injectors:

* [https://docs.rs-online.com/c557/A700000010094578.pdf GP-103IT]

* [https://www.microchip.com/en-us/product/PD-9001GR/AT PD-9001GR/AT]

* LANCOM POE++ Injektor

== Firmware ==
Available in [https://store.innovaphone.com/release/download.htm official release store]

===IP0013===
Following firmware versions are available for the IP0013 gateway itself:
* V13r2: available via release store since V13r2sr10, build no 136337

===IP6013===
Following firmware versions are available for the IP6013 gateway itself:
* V13r1: available via release store since V13r1sr25, build no 132894
* V13r2: starting with 13r2final, build no 136094

=== Application Platform ===
The device hosts an 64-bit-ARM-processor which requires use of 64bit-architecture application platform.

Respective arm64-AP is available for 13r1 and 13r2 in offical release store.

== Use cases ==
IP0013 and IP6013 host 150 software conference channels for audio conferencing (since 13r3sr4, before 60).

IP6013 additionally hosts 60 hardware digital signal processors for support of PCM traffic via PRI interfaces, audio faxes and audio conferencing.

Cumulating hardware and software conference channels at IP6013 into a single room is not supported.

Use of features such as PBX-operation, PRI- and fax traffic, audio/video conferencing and Application Sharing influence the CPU load.

Exceeding the maximum CPU limit may lead to device outage.

innovaphone supports following use cases:

'''All-in-one-box'''
* operation of PBX-functionality
* IP0013: for conferencing use SCNF interface
* IP6013: use HW-DSPs for PCM-Audio and Fax only, for conferencing use CONF '''or''' SCNF interface only

'''Gateway only'''
* operation as gateway only '''without activated PBX functionality and no AP installed'''
* IP0013: use SCNF for conferencing
* IP6013: use PRI-interfaces and HW-DSPs for S2M-Audio and Fax and SCNF for conferencing, '''or''' in case of no PRI/FAX traffic, both CONF and SCNF can be used for conferencing

[[Howto:How to implement large PBXs|Herefore mentioned basic conditions]] apply at any time for all kind of configurations and usecases.

==Known Issues==
* IP6013: FAX interface will provide audio-fax capabilities starting with 13r1sr26

Howto:How to IPxx13

2025-04-11T13:17:20Z

Mpu: /* Power supply */

[[Category:Howto]]
[[Category:Concept IPxx13]]

== Applies to ==
* IP0013
* IP6013
* V13+

== Brief ==

=== IP0013 ===
* VoIP-PBX and routing gateway including reverse proxy and SBC functionalities
* Orderno.: 01-00013-001

=== IP6013 ===
* VoIP-PBX and routing gateway for four ISDN-S2M interfaces plus Reverse Proxy and SBC functionalities
* Orderno.: 01-06013-001

== SSD ==

IPxx13 owns two internal slots for '''M.2 SSD'''.

Slot interface is '''NVMe''' - [https://en.wikipedia.org/wiki/NVM_Express non volatile memory express].

Slot formfactor is M.2 2242 M-Key - dimensioning 22mm*42mm.

Maximum power consumption per M.2 SSD is 2.5W.

SSD has to be plugged in outer slot SSD0. Use of secondary inner slot SSD1 is not supported.

innovaphone offers and supports M.2 SSD 512 GB with order no 03-00010-017.

Technical support in terms of investigation for other SSDs is not forseen.

Note: '''These information DO NOT APPLY to IPxx11 and IP11xx based mSATA SSDs!''' For information to those devices, refer to [[Howto:Tested mSata modules|this article]].

== Power supply ==

The devices mandatorily require Power over Ethernet+ supply according to IEEE 802.3at, Class 4 (PoE+) for operation.

Currently, innovaphone offers no POE+ injector.

We recommend the following PoE+ injectors:

* <nowiki>https://docs.rs-online.com/c557/A700000010094578.pdf</nowiki> [^]

* <nowiki>https://www.microchip.com/en-us/product/PD-9001GR/AT</nowiki> [^]

* LANCOM POE++ Injektor

== Firmware ==
Available in [https://store.innovaphone.com/release/download.htm official release store]

===IP0013===
Following firmware versions are available for the IP0013 gateway itself:
* V13r2: available via release store since V13r2sr10, build no 136337

===IP6013===
Following firmware versions are available for the IP6013 gateway itself:
* V13r1: available via release store since V13r1sr25, build no 132894
* V13r2: starting with 13r2final, build no 136094

=== Application Platform ===
The device hosts an 64-bit-ARM-processor which requires use of 64bit-architecture application platform.

Respective arm64-AP is available for 13r1 and 13r2 in offical release store.

== Use cases ==
IP0013 and IP6013 host 150 software conference channels for audio conferencing (since 13r3sr4, before 60).

IP6013 additionally hosts 60 hardware digital signal processors for support of PCM traffic via PRI interfaces, audio faxes and audio conferencing.

Cumulating hardware and software conference channels at IP6013 into a single room is not supported.

Use of features such as PBX-operation, PRI- and fax traffic, audio/video conferencing and Application Sharing influence the CPU load.

Exceeding the maximum CPU limit may lead to device outage.

innovaphone supports following use cases:

'''All-in-one-box'''
* operation of PBX-functionality
* IP0013: for conferencing use SCNF interface
* IP6013: use HW-DSPs for PCM-Audio and Fax only, for conferencing use CONF '''or''' SCNF interface only

'''Gateway only'''
* operation as gateway only '''without activated PBX functionality and no AP installed'''
* IP0013: use SCNF for conferencing
* IP6013: use PRI-interfaces and HW-DSPs for S2M-Audio and Fax and SCNF for conferencing, '''or''' in case of no PRI/FAX traffic, both CONF and SCNF can be used for conferencing

[[Howto:How to implement large PBXs|Herefore mentioned basic conditions]] apply at any time for all kind of configurations and usecases.

==Known Issues==
* IP6013: FAX interface will provide audio-fax capabilities starting with 13r1sr26

Reference15r1:Concept App Service Working

2025-03-27T13:00:06Z

Mpu: /* Working time tracking and absences such as vacation/sick days and costume work types */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time tracking and absences such as vacation/sick days and costume work types =====

* Work time account: Overview of the current work time balance
* Add pre-defined labels to working times

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group
* Enable/Disable verification by manager before submission to Human Resources

===== Import and export of existing tracked time with the help of CSV =====

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).

* Rights
** Config groups 
== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-27T12:56:02Z

Mpu: /* innovaphone-working-manager */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time tracking and absences such as vacation/sick days and costume work types =====

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group
* Enable/Disable verification by manager before submission to Human Resources

===== Import and export of existing tracked time with the help of CSV =====

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).

* Rights
** Config groups 
== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-27T12:54:18Z

Mpu: /* innovaphone-working-manager */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time tracking and absences such as vacation/sick days and costume work types =====

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group
* Enable/Disable verification by manager before submission to Human Resources

===== Import and export of existing tracked time with the help of CSV =====

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-27T12:52:58Z

Mpu: /* Groups/Group rights */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time tracking and absences such as vacation/sick days and costume work types =====

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group
* Enable/Disable verification by manager before submission to Human Resources

===== Import and export of existing tracked time with the help of CSV =====

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-27T12:26:34Z

Mpu: /* Features */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time tracking and absences such as vacation/sick days and costume work types =====

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group

===== Import and export of existing tracked time with the help of CSV =====

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-27T12:26:08Z

Mpu: /* Features */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

===== Features =====

===== Working time tracking and absences such as vacation/sick days and costume work types =====

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group

===== Import and export of existing tracked time with the help of CSV =====

===== Archiving working times of deleted employees =====

===== User replication: New users appear once assigned the Working User App =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-25T14:04:49Z

Mpu: /* Features */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time tracking and absences such as vacation/sick days and costume work types =====

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group

===== Import and export of existing tracked time with the help of CSV =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-25T14:02:21Z

Mpu:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== -Working time tracking and absences such as vacation/sick days and costume work types =====

===== -Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== -Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group

===== -Import and export of existing tracked time with the help of CSV =====

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== CSV export ==
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

== CSV import ==
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-25T13:57:44Z

Mpu:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Features ==

===== Working time regulations =====

*Timeout to submit entries (days): max interval the user has to submit the working hours.
* Min break time after 6 hours: min break time if the user has worked more than 6 hours.
* Min break time after 9 hours: min break time if the user has worked more than 9 hours.
* Default working hours

===== Groups/Group rights =====

* Groups can be defined
* Only the managers of the groups can see the users on the group on the Working Manager App
* Working types only available for the users on the group can be configured
* Enable/disable restrictions to submit working hours for the users on the group

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

==== CSV export ====
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-25T13:48:34Z

Mpu:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

== Features ==

==== CSV export ====
The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Apps/PbxManager/App Working

2025-03-25T10:58:33Z

Mpu:

Reference15r1:Apps/PbxManager/App Working

2025-03-25T10:57:41Z

Mpu: /* App objects */

This PBX Manager Plugin contains 2 section:
* Add, edit or delete Working App on the PBX.
* Configuration: Setting target Master PBX .

== Configuration ==
; PBX Name
: This field specifies the master PBX to ensure that searches and data replication are performed on the correct PBX

== Add an App ==
; <nowiki>Name: </nowiki>
The name displayed for the App Object.

'''SIP:'''

The sip from the App Object, which must be unique

'''Config templates:'''

Select which config templates will allow to access the App Object.

== App objects ==
; Working User
: This is an app, where the user can enter the working hours, holidays, sick and vacation days

; Working Manager

:This is an app that allows you to monitor working times, there are two types of rights:

: - The Human Resources view where all working times can be viewed
: - The Manager view, where managers only see the working times of the associated group
; Working API
: This is a hidden app, where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

;Working Client API
: This is an app needed to provide the Working Client API, so that other apps can start/stop working times.

Reference15r1:Apps/PbxManager/App Working

2025-03-25T10:55:23Z

Mpu:

This PBX Manager Plugin contains 2 section:
* Add, edit or delete Working App on the PBX.
* Configuration: Setting target Master PBX .

== Configuration ==
; PBX Name
: This field specifies the master PBX to ensure that searches and data replication are performed on the correct PBX

== Add an App ==
; <nowiki>Name: </nowiki>
The name displayed for the App Object.

'''SIP:'''

The sip from the App Object, which must be unique

'''Config templates:'''

Select which config templates will allow to access the App Object.

== App objects ==
; Working User
: This is an app, where the user can enter the working hours, holidays, sick and vacation days

;Working Manager

This is an app that allows you to monitor working times, there are two types of rights:

* The Human Resources view where all working times can be viewed
* The Manager view, where managers only see the working times of the associated group
; Working API
: This is a hidden app, where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

;Working Client API
: This is an app needed to provide the Working Client API, so that other apps can start/stop working times.

Reference15r1:Concept App Service Working

2025-03-25T10:47:51Z

Mpu: /* Apps */

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

==== CSV export ====
'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Apps/PbxManager/App Working

2025-03-25T08:23:42Z

Mpu:

Reference15r1:Apps/PbxManager/App Working

2025-03-25T08:15:07Z

Mpu: Created page with "This PBX Manager Plugin contains 2 section: * Add, edit or delete Working App on the PBX. * Configuration: Target email for reporting, weekly interval, SMTP Server settings. == Configuration == ; Email for reports : The email address to receive weekly reports. ; Send reports every(weeks) : Interval in weeks for sending reports. 0 means disabled. ; SMTP Server : SMTP Server IP address or DNS name. ; Username : Username for the SMTP Server (if necessary). ; Password :..."

This PBX Manager Plugin contains 2 section:
* Add, edit or delete Working App on the PBX.
* Configuration: Target email for reporting, weekly interval, SMTP Server settings.

== Configuration ==
; Email for reports
: The email address to receive weekly reports.

; Send reports every(weeks)
: Interval in weeks for sending reports. 0 means disabled.

; SMTP Server
: SMTP Server IP address or DNS name.

; Username
: Username for the SMTP Server (if necessary).

; Password
: Password for the SMTP Server (if necessary).

; Client hostname
: Client hostname for SMTP Server (if necessary).

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

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

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-03-24T14:38:12Z

Mpu: /* Manual steps needed after upgrade */

{{FIXME|reason=This article is still in progress and not finished not yet finished!}}

== Applies To ==
This information applies to:

* All 15r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 15r1, 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 V15 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Here is how you upgrade a system from 14r2 to 15r1.

Before you begin, be sure that your whole installation is running the latest 14r2 service release. 

=== AP Upgrade to Image 130002 ===
* Please Upgrade as first your Application Platform to Image Version 130002. After that you can go ahead.

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

=== App Platform on CF card (IPxx10) ===
Make sure that no App Platform is installed on a CF card, as this function is removed with the update.
Migrate the App Platform to a gateway with SSD or as a virtual machine before the update.

== 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.

* '''myApps''': New UI design. In new installations users will see an intro video when logging in the first time.
* '''myApps iOS/Android''': You will find a new Version without the Major Version in the icon. Starting with V15, the client no longer needs to be replaced in the future.
* '''Phone App and Softphone App''': [[ReleaseNotes15r1:Firmware#192745 - Phone App and Softphone App: New UI design|New UI design]]
* '''Switchboard App''': See list of improvements in the [[Reference15r1:Concept App Service Queues#V15 Improvements|Concept App Service Queues Article]]
* '''Connect App''': New version with many new features. See list of improvements in the [[Reference15r1:Concept App Connect|connect article]].
* '''Chat App''': The chat app for persistent chat is now integrated in the connect app. More information in the [[Reference15r1:Concept App Connect#Chat|connect article]].
* '''Fax App settings plugin''': The admin can now set [[Reference15r1:Apps/PbxManager/App Fax#Default settings for mail notifications|default settings for mail notifications]] for the user specific/group fax app.

== 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.

=== myApps ===
* To configure an optional intro that is shown when user login the first time, see: [[Reference15r1:Concept_myApps#Onboarding]]

=== Techassist App ===
* You have to enable the API "PbxSignal" in the APP Objects "App" Tab

=== myApps iOS/Android ===
* You must install the new app without the major version in the icon. (Starting with V15, the client no longer needs to be replaced in future).
** iOS: https://apps.apple.com/us/app/innovaphone-myapps/id6739562892
** Android: https://play.google.com/store/apps/details?id=com.innovaphone.myapps

=== IPVA VMWare Fault Tolerance ===
* With 15r1 you can use again the VMWare Fault Tolerance Feature. If you want to re-enable this feature you have to [[Howto15r1:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance|setup a new IPVA-SCSI]] and export/import your configuration to the new machine.

=== Working App ===

* With 15r1, it is necessary to specify the master PBX in the Settings plugin under "Configuration"

== 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.

=== Projects App ===
* Concept Article: [[Reference15r1:Concept App Service Projects|Concept App Service Projects]]

=== Virtual Background App ===
* Concept Article: [[Reference15r1:Concept Virtual Background App|Concept Virtual Background App]]

=== Remote Control Client msi application for external participants ===
* Concept Article [[Reference15r1:Concept App Remote Control|Concept App Remote Control]]

=== Assistant App ===
* Concept Article [[Reference15r1:Concept App Service myApps Assistant#Assistant App|Concept Assistant App]]

== Good2Know ==

=== PBXManager ===
“PBX Manager” is now called “Settings”

=== Exchange Online calendar integration — Calendar App / Connector for Microsoft 365 ===
In the past, Microsoft has announced the end of support for Exchange Online EWS support in 2026:

https://techcommunity.microsoft.com/blog/exchange/retirement-of-exchange-web-services-in-exchange-online/3924440

Since the Calendar App uses EWS to synchronize calendar events from Exchange Online to the PBX, this feature will stop working from then on.

Microsoft suggests switching to the Graph API for this functionality and since we already have an app that works with the Graph API, we have extended the feature set of the Connector for Microsoft 365.

In addition to the initial functionality of synchronizing line states and presences bi-directionally between the Azure Portal (Teams) and the PBX, the Connector for Microsoft 365 can now also retrieve calendar events and integrate them into the PBX.

The Connector for Microsoft 365 requires a valid licence for each user.

The Exchange Online functionality of the Calendar App will no longer be enhanced or improved, but the current functionality will be included for as long as Microsoft continues to support EWS for Exchange Online.

The on-premise functionality is not affected by this and will remain in the Calendar App.

''As both apps integrate Exchange Online calendar events in the same way, it is not recommended or supported to use both calendar integrations at the same time.''

''However, you can use the Connector for Microsoft 365 for presence and line state synchronization and the Calendar App for calendar event integration.''

=== Federation ===
Beginning with 15r1 the certificate or CA of the certificate of the client device '''must''' be in the trust list of the RP/gateway or else, federation doesn't work anymore.

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

* running an App Platform on the CF card of an IPxx10 gateway (Removed, migrate to a gateway with an SSD or a Virtual Machine to run the App Platform)
* Audio codec software transcoding to G.729 removed on: IP11x, IP10x, myApps, DECT-Radios. Only the conversion to G.729 has been removed, not the playback of already converted g.729 audio files such as an MOH or voicemail announcements. These can still be played.

== 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. 
See: [[Howto14r2:Firmware_Upgrade_V14r1_V14r2#Deprecated]] 
We strongly recommend migrating to our successor products.

* iQM (innovaphone Queue Monitor) - Migrate to the [[Howto:Queueboard - MediaRunway - Partner App|Queueboard App]]. For existing innovaphone QueueMonitor licences, the corresponding MediaRunway Queueboard licences can be downloaded via portal.innovaphone.

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

== 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 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 15r1 release will consume the same amount of RAM compared to a v14r2 firmware.

=== Flash Memory ===
As a rough rule of thumb, a v15r1 release will consume ~ 64KB flash memory compared to a v14r2 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 v15r1. 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.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]
[[Category:Howto|{{PAGENAME}}]]

Reference15r1:Concept App Service Working

2025-03-21T13:23:58Z

Mpu:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.

== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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 manager App the list of the users' names is based on the "Display Name", if no DN is set then the "Name" will be used. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-manager ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), 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 day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

==== CSV export ====
'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingmanager: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingmanager / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingmanager~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-21T13:19:36Z

Mpu:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.
== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The Settings plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), 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 day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

==== CSV export ====
'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

Parameters:
;workingadmin: the name of the working admin app.

== Settings Plugins ==

=== Working ===

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

==Configuration==
* Install the Working App with the new AP app installer available in the Settings . ''Hint : after the installation done, close and open again the Settings to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the Settings Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingadmin / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingadmin~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-21T13:17:32Z

Mpu:

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.
== Applies To ==

* innovaphone PBX from version 15r1

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V15r1 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png|innovaphone-working.png/]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png|innovaphone-working-api.png/]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The PBX Manager plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎|innovaphone-working-admin.png/]]
This is an admin app (Working Manager), 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 day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

==== CSV export ====
'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

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 with the new AP app installer available in the PBX manager. ''Hint : after the installation done, close and open again the PBX Manager to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the PBX Manager Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingadmin / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingadmin~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference15r1:Concept App Service Working

2025-03-21T13:16:47Z

Mpu: Created page with "Apps The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users. == Applies To == * innovaphone PBX from version 14r2 ==Requirements== * innovaphone PBX * innovaphone Application Platform * innovaphone myApps * Firmware V14r2 beta1 or higher * License “App(innovaphone-working)” (order no. 02-00050-010) per applicati..."

[[Category:Concept|Apps]]
The Working App is an app for recording working hours. There is a user app (Working User) to start/stop time tracking and an admin app (Working Manager) to view working hours for all users.
== Applies To ==

* innovaphone PBX from version 14r2

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* innovaphone myApps
* Firmware V14r2 beta1 or higher
* License “App(innovaphone-working)” (order no. 02-00050-010) per application-user

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) 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 employers to easily track working hours in a digital manner.

==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. Once the users have opened the working app at least once, they will appear in the list of all users in the Working Manager App. The app adds a red mark when an user does not fulfill the working hours regulation.

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. 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-api ===
[[Image: Innovaphone-working-api.png]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

Parameters:
;Websocket: to set a websocket connection.
;Hidden: to configure the app as hidden.
;Admin: to get the app object name where to send the notifications.
;PbxApi: to send the notifications.

=== innovaphone-working-client-api ===
[[Image: Innovaphone-working-api.png]]
This is an app needed to provide the Working Client API, so that other apps can start/stop working times. The innovaphone-working-client-api app is also a hidden app. The PBX Manager plugin also sets the hidden function. This app should be granted to apps that use it, not to users.

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎]]
This is an admin app (Working Manager), 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 day can be configured per user and they are set to 8 hours from monday to friday by default.

Now "hr" must be entered as Mode on the app object on the PBX. With that now there are 2 workingmanager apps for the user-objects avaiable: 
workingmanager and 
workingmanager~hr. 
The administrator needs both.
* workingmanager: the managers on the group can only see the users on the group (no hamburger menu avaiable)
* workingmanager~hr: all the users can be seen there and all the configurations are available

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

* General settings
** Timeout to submit entries (days): max interval the user has to submit the working hours.
** Min break time after 6 hours: min break time if the user has worked more than 6 hours.
** Min break time after 9 hours: min break time if the user has worked more than 9 hours.
** Config working types: which can be selected on the dropdown for every working interval and are available for all users.

* No email reports are available on 14r2

* Default working hours: workings hours defined per day when a user opens the app for the first time, which can be modified per user on the Admin App (Working Manager).
** Monday
** Tuesday
** Wednesday
** Thursday
** Friday
** Saturday
** Sunday

* Rights
** Config groups
*** Groups can be defined
*** Only the managers of the groups can see the users on the group on the Working Manager App
*** Working types only available for the users on the group can be configured
*** Enable/disable restrictions to submit working hours for the users on the group

The users' data can be exported and imported on CSV format. There are some fixed fields that are available for the import and the export. There are also some other fields that are only displayed on the export file just as extra information, which are marked with (*).

==== CSV export ====
'''Users'''

The fields that come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that come with the CSV are the SIP, the start timestamp, the working hours, label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted), date, and the personal number.
&sip;&start;&duration;&label;&confirmed;&date;&p_number 
atlantis;1712181600000;8;hvacation;true;2024-04-04;0

'''Times'''

The fields that come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted), the display name, the personal number, the start date, the start time, the stop date, the stop time, the amount of hours and the label (if a type has been selected).
&sip;&start;&stop;&confirmed;&dn;&p_number;&start_date;&start_time;&stop_date;&stop_time;&hours;&label 
atlantis;1712651520199;1712651700199;true;Atlantis;0;2024-04-09;10:32:00.199+00:00;2024-04-09;10:35:00.199+00:00;0,1;

==== CSV import ====
'''Users'''

The fields that should come with the CSV are the SIP, GUID, domain, display name, the defined working hours per day and the personal number.
&sip;&guid;&domain;&dn;&monday;&tuesday;&wednesday;&thursday;&friday;&saturday;&sunday;&p_number 
atlantis;null;innovaphone.com;Atlantis;8;8;8;8;8;0;0;0

'''Absences'''

The fields that should come with the CSV are the SIP, the start timestamp, duration (the working hours), label ('''vacation''' for a vacation day, '''hvacation''' for a 1/2 day vacation, '''holiday''' for national holidays, '''sick''' for sick leave), confirmed (if the absence has been submitted) and date (if present timestamp will be ignored). The date must always have the english format, i.e. MM-DD-YYYY.
&sip;&start;&duration;&label;&confirmed;&date 
atlantis;1712181600000;8;hvacation;true;2024-04-04

'''Times'''

The fields that should come with the CSV are the SIP, the start timestamp, the stop timestamp, confirmed (if has been submitted).
&sip;&start;&stop;&confirmed 
atlantis;1712651520199;1712651700199;true

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 with the new AP app installer available in the PBX manager. ''Hint : after the installation done, close and open again the PBX Manager to refresh the list of the installed app (the coloured plug-in)''
* Create a new PBX Object for the Working User, Working Manager and Working API Apps with the PBX Manager Plugin.
* Assign the Working User (to normal users) and Working Manager App (to administration for example Human Resources) by selecting the config template that should include the App.
* Assign the Working API to all the users, so users can use the auto start/stop and push notifications.
* Assign license "App(innovaphone-working)" via config template or directly to all users using the APP.
* Open the object workingadmin / App / Modes: (insert here:) hr.
* Open the object Config Admin / Apps / workingadmin~hr (select).
* Set configuration settings on the "burger" menu of the Working Manager App (i.e. Reports Interval in weeks, groups and types configuration...).

==Troubleshooting==
Trace flags for App on App Platform:
*App
*App Database
*App Websocket

Trace flags for myApps Client:
*Browser Console

==Known issues==

==Related Articles==
* [https://sdk.innovaphone.com/14r2/web1/com.innovaphone.working/com.innovaphone.working.htm SDK Documentation - Working API]
* [https://sdk.innovaphone.com/14r2/doc/service/Working.htm SDK Documentation - Working Client API]

Reference14r2:Concept App Service Contacts

2025-02-11T08:38:46Z

Mpu: /* DECT Phones and IP101/IP102 Cannot Access Personal Directories */

[[Category:Concept|Apps]]
= Applies To =
* App Contacts version 14r2

= Overview =
The App Service Contacts is an App Service which can be installed on an innovaphone App Platform. It is used for information retrieval of a database of contact entries, as well as maintaining personal contact books.

Inside Contacts, personal and general entries can be searched (forward lookup) or be used to resolve incoming numbers to their respective name (reverse lookup).

= Features =
*Import: Semicolon (;) separated CSV file
*Database for contact entries: A user interface for retrieval purposes is available.
*API: Search API and Lookup API for other apps
*Edit Functionality: Contact entries are editable.
*Personal Address Book: Every user can maintain one or more personal address books.
*Access Right Management: Owners can maintain access privileges for single users or even groups of users, in order to control visibility of an address book.
== 14r2 Features ==
Features added to the version 14r2
;User-Interface improvements
: Contact entries retrieved are rendered in a condensed card representation. A '''Details'''-button expands and displays remaining contact information
;Presence Updates
:Useful in federation scenarios. For displayed and currently visible contact entries, presence monitoring calls are placed, in order to display availablity status. Underlying resources are going to be freed immediately for entries scrolled out of visibility.
;Fax button
:Placing a call to a fax number is going to start the fax application
;Adding Contacts from within the Softphone App or Call List App
:Contacts can be added by means of a button '''Softphone/Call List/<entry>/"Add Contact"'''
;Import, export for personal directories
New buttons '''Hamburger/Directories/<directory>/Import,Export''' allow for CSV-download and -upload respectively.

= Requirements =
innovaphone PBX and App Platform from on version 13r3 - version 14r2 is recommended.
==Upgrade Considerations==
From 13r3 to 14r2 no special upgrade scenarios need to be considered as the database structure remains the same. On the other hand, if the new com.innovaphone.contacts API will be used (which helps to add contacts from within the phone apps) and a manual update is performed then the Websocket Checkmark should be set on the PBX App Object.

For prior versions please consider the following:

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. The 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 and a lookup API to other apps, e.g. for the Phone App

= Concept =
General contact entries and entries for personal directories are stored within the same database. With the table '''acl''' which is acting as an access control list, restricted views and edit rights for personal directories can be granted.

This way, only the owner of a personal directory (and granted user or groups) can see the content.

==Number handling==
In principle, two versions of a phone number are always stored in the contacts database.
;Original Number
:This is the unchanged number imported by the user. This version includes all decorative characters, spaces, etc. (eg. +49-(7031) 730090)
;Formatted number
:A filter is applied to the original number before saving to remove all non-dialable characters. (This means that only <code>0-9,+,*,#</code> remain after that) This formatted version of the call number is saved in addition to the data set. (eg. +497031730090)

If a number is searched for (reverse lookup), the cleaned version is searched for. Thus, it does not matter which decorative characters or formats are imported.
If an entry is displayed to the user, the originally entered call number (incl. decoration characters) is displayed.

It is therefore best practice to import only international format numbers (Decorations can be imported as they will be removed anyway), as the PBX always converts the number into the international format for a reverse lookup, if the [[Reference13r1:Concept_Number_Adjustments_%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
;uuid
:A constant universal unique id as string. Internally assigned during entry creation.

==List of Text-Indexable Attributes==
Attributes to be considered for the full-text index
*cn
*sn
*givenname
*company
*displayname
*city
*street
*postalcode
*country
*state
*private_city
*private_street
*private_postalcode
*private_country
*private_state
*title
*position
*department
*description
*roomnumber
*sip

==Built-in LDAP Server==
The App incorporates a proprietary LDAP server functionality. The purpose of the LDAP server functionality is to service innovaphone LDAP clients, such as desk phones.
The LDAP server only supports a proprietary search by means of a meta attribute<ref>Meta attribute: Here an attribute with a special meaning and that is non-physical, not existing within the database</ref>, whereby LDAP is just utilized as a transport vehicle for a user's search input one-to-one.
*E.g. a user searching for ''John Doe innovaphone''
**Possible user input ''jo do inno''
**Resulting LDAP filter ''(metaSearchText=jo do inno)''

'''Important:'''

Note, that access to restricted/personal phone books requires the proprietary scheme within the LDAP client, mentioned above.

Currently, this is available in the innovaphone IP phone LDAP clients from 13r3 on, but not on 3rd party devices nor our DECT gateways (IP120x). On these clients, only contact data in unrestricted phone books is searched.

===Sample Phone Configuration, innovaphone===
Phone/User-X/Directories/External LDAP Server
;Enable: Active
;Use TLS: Active
;Server: <host adddress of App Platform>
;Port: <can be left empty>
;Username,Pw: <Credentials for LDAP Bind operation>
;Search Base: ''dc=entries''
;Mode: <can be left on "basic">
;Object Filter: <leave empty>
;Sort Results: Inactive
;Name Attributes: ''givenName,sn,company''
;Number Attributes: <can be left empty>
;H323 ID Attribute:'' sip''
;Detail Attributes: ''title,company,street,postalCode,city,country,email,url''
;Meta Name Attribute: ''metaSearchText''
;Meta Number Attribute: ''metaSearchNumber''

= Personal Address Book Details =
Contact entries can be added, edited and deleted. It is also possible to create and maintain personal address book(s), as well as share them with other users or whole user groups.

Only user/groups with sufficient rights, will be able to see other address books. An Access control list (acl) is used, to control these rights.

Groups correspond to PBX-groups. The Contacts App gets to know only active PBX-group memberships.

By default, only the user who created an address book, is able to see the content.

==Maintain a Personal Address Book==
;Creating a Personal Address Book
:Click on '''+Contact''' and proceed. If no directory existed before, one will be automatically created by the name pattern '''Personal Directory: <user's short name>'''.
:Or click on the burger menu in the top right corner inside the Contacts-App, and there on the '''"Directories"'''. Now click on the '''"+"'''-Symbol, choose a suitable name and confirm your name via '''"Save"''' button. A new address book is created.
;Adding a new contact
Click on the '''"+"'''-Symbol in the top right corner inside the Contacts-App and select an address book, where you want the contact to be stored in. Now fill in the contact information (the fields ''"name"'' and ''"last name"'' '''have to be filled''') and save it via '''"Save"'''-button.
;Editing an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, click on the entry you want to edit and after your change, save it via '''"Save"'''-button on the bottom.
;Delete an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, and on the '''"trashcan"'''-symbol at the top. After confirmation, the entry is deleted.

==Sharing of Address Book==
;Share globally
*Either remove all rules from a personal directory. Such a configuration corresponds to pre-13r3 capabilities. Up to 13r2 there weren't any visibility rules available.
*Or make every PBX user an active member of a group e.g. "everybody" and add a directory rule for that group "everybody".

;Share with single user(s)
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"User"''' as type. In the input field, you can enter and therefore filter for all available users. Select the user, whom you want to give access and select either if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''.

;Share with a group
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"Group"''' as type. In the input field, you can enter and therefore filter for all available PBX groups. Also select, if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''-button.

;Revoke of granted rights
You can also revoke previous granted rights by just clicking on the user/group at the access control list, and click on the '''trashcan''' symbol. Now submit your change with another click on '''Ok'''-button.

==Upload a new Directory==
The Contacts Admin App allows uploading a CSV file as known from the 13r2 version ('''Hamburger/Import'''). In the course of an upload operation, a new directory will be created. The newly assigned directory name will be the name of the CSV file.
After uploading, the visibility setting of the new directory should be administrated as stated before under [[#Sharing_of_Address_Book|Sharing of Address Book]]

==Terminology==
;ACL: Access control list. Refers the database table ''acl'' and rows/entries therein.
;Directory: Refers the database table ''dbs'' and rows/entries therein. All contact entries referencing a ''dbs''-row make up the content of a directory.
;Address Book: Synonymous with ''Directory''
;Contacts Admin: A user utilizing the Contacts Admin App (via App URL, ending with ../innovaphone-contacts-admin)
;Directory Admin: A user entitled the admin right for a directory. Either by user-wise or by group-wise ACL entry.
;Directory User/Viewer: A user entitled the viewing right for a directory. Either by user-wise or by group-wise ACL entry.

==Database Changes==
Three tables realize the functionality for personal directories.
*Table '''dbs'''. Each row represents a directory. Two new columns ''displayname, sip'' where added.
**'''displayname''' Name display.
**'''sip''' Creator's sip name, if available.
*Table '''acl'''.New table acting as access control list. Each row references a directory as listed by table ''dbs'' and is going to grant view- and admin-right to a specific user or group.
**'''dbsid''' Reference into table dbs.
**'''name''' The name of a user or a group.
**'''acltype''' A numeric value: user(0), group(1)
**'''admin''' Granting edit right: admin(true), non-admin(false)
*Table '''entries'''. Each row within this pre-exisisting table represents a contact entry. The column ''dbsid'' informs about whether an entry belongs to a specific directory.

<pre>
#Excerpt for an additional directory ''Persönliches Verzeichnis: mst'' with one contact entry.

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri | displayname | sip
----+------------------------------------------------------+--------------------------------+-----
7 | file:///4eaae395-9971-40fb-9a05-dfae1d023f12?sip=mst | Persönliches Verzeichnis: mst | mst # Specification for directory ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from acl"
id | dbsid | name | acltype | admin
----+-------+------+---------+-------
5 | 7 | mst | 0 | t #user 'mst' can view and edit directory with dbsid=7 ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select sn,givenname,company,id,dbsid from entries where dbsid=7"
sn | givenname | company | id | dbsid
----------+-----------+--------------+-------+-------
Duck | Dagobert | Duck Corp. | 51394 | 7 # main table entries contains 1 entry belonging to ('Persönliches Verzeichnis: mst')

</pre>

==Reverse Number Lookup for Personal Directories==
Queries into directories are access-checked by looking-up and enforcing ACL-rules. The information on whose name is being queried and which group memberships are taking effect is needed for this process.

Websocket connections to the Contacts App service carry those infos within the SDK method ''AppWebsocketConnectComplete()''.
LDAP connections pass this information within a proprietary LDAP control together with an LDAP searchRequest message.

The PBX's centralized Reverse Lookup service (see ''PBX/Config/General/Reverse Lookup URL'') does support this mechanism. That is, for every LDAP searchRequest the affected user's name and active group memberships are going to be sent towards the Contacts App's LDAP server.

See also [[{{NAMESPACE}}:Concept_Reverse_Lookup|concept article on reverse lookup]].

=Upload Data by HTTP Post=
A CSV file can be uploaded by means of an HTTP POST request.
The following powershell script aims to demonstrate this procedure with the help of CURL<ref>For a windows distribution: e.g.: https://curl.haxx.se/download.html </ref><ref>CURL is recommended(rather required), because it supports the simple POST mechanism with an initial tentative POST with the data length of 0, in order to get through the authentication phase</ref>
The required user and password content corresponds to the configuration underneath '''PBX Manager/AP Contacts/Configuration/User(HTTP Post)''' and '''Password(HTTP Post)'''
<syntaxhighlight lang="powershell">
# csv.ps1
# Sample powershell script demonstrating how to HTTP POST a CSV file towards the Contacts App service.
# .\bin\curl must be present, e.g. from https://curl.haxx.se/download.html
# Examples:
# powershell -ExecutionPolicy Bypass -Command .\csv.ps1 -Dest 172.16.18.215 -File ".\myContacts.utf8" -User "contacts01" -Pw "pwd01" -Url "/example.com/contacts01/post/myContacts.utf8?op=csv"

param(
[Parameter(Mandatory=$false, HelpMessage="Destination host")]
[string]$Dest,
[Parameter(Mandatory=$false, HelpMessage="Name of file to be POSTed")]
[string]$File,
[Parameter(Mandatory=$false, HelpMessage="Authentication: User")]
[string]$User,
[Parameter(Mandatory=$false, HelpMessage="Authentication: Password")]
[string]$Pw,
[Parameter(Mandatory=$false, HelpMessage="URL, e.g.: /example.com/contacts01/post/myContacts.csv?op=csv&xml-stats=true")]
[string]$Url
)

Add-Type -AssemblyName System.Web

$Uri = "http://" + $Dest + $Url

function UploadToContacts {
# Ensure file's there and has content
if (!(Test-Path -Path $File)) {
echo $File+" not downloaded!"
exit 1
}
$lines = 0
Get-Content $File |%{ $lines++ }
echo "Lines of $File=$lines"
if($lines -le 2) {
echo "No Data to upload!"
exit 1
}

$auth = "${User}:${Pw}"

echo "POSTing towards $Uri"
.\bin\curl "--digest" -s -S --trace-time -u $auth -i -H "Content-Type:application/octet-stream" -X POST --data-binary "@${File}" "${Uri}"
echo "POSTed towards $Dest"
}

$timeStart = Get-Date
echo "===Begin: ${timeStart} ==="
UploadToContacts
$timeEnd = Get-Date
echo "===End: ${timeEnd} ==="
echo ""
</syntaxhighlight>
== The URL ==
The first part of the URL (''example.com/contacts01'') is the ''Webserver path'' configured for the ''Contacts'' instance in the ''App Platform Manager''. It must be followed by the literal <code>post</code>. The last part (''myContacts.csv'') can be chosen freely.

Note that the last part of the URL used to post the file (''myContacts.csv'' in the example above) needs to be chose carefully. ''Contacts'' will remember this name as source for each of the uploaded entries. When the file is posted again (that is, when a new POST using this last URL part is done), ''Contacts'' will first delete all existing entries previously uploaded with this name and then add the new ones.

=Troubleshooting=
To collect debugging data, activate the '''''App''''' and '''''App WebSocket''''' trace options at the contacts instance on the App Platform Manager. Now reproduce the issue and save the logfile.

==Manually Deleting an uploaded File==
A directory is deleteable by clicking '''Hamburger/Directories/<directory>/Delete(Symbol: Trash-Can)''' and a progressing through the confirmation dialog afterwards.

==Manually Deleting all Contacts==
Sometimes it may become necessary to delete all contacts from the database. This task can be accomplished by simply deleting the main table ''entries''. The deletion will cascade from there into all sub-tables.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<syntaxhighlight lang="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
94
(1 row)

#Delete
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from entries *"
DELETE 94

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
0
(1 row)
</syntaxhighlight>



= Known Issues =
* [[Support:Contacts_on_HomeScreen_can%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 and IP101/IP102/IP240(A) Cannot Access Personal Directories ==
DECT gateways and IP101/IP102/IP240(A) Phones do not support the mechanism required to query into directories with restricted access rules. Hence, DECT mobile phones and IP101/IP102/IP240(A) cannot search into such directories.

== 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/>

Reference14r2:Concept myApps platform services

2025-01-27T14:45:58Z

Mpu: /* macOS */

[[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|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|pbx-recording-settings.png/]] [[Image:Recording-Softphone-Settings.png|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|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|Reference14r2: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|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|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|myapps-settings0.png/]]
::[[Image:myapps-settings.png|myapps-settings.png/]] [[Image:myapps-settings2.png|myapps-settings2.png/]] [[Image:myapps-settings3.png|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

=== Setting myApps as Default App for SIP-URLs ===
{| class="wikitable"
|defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add '{
LSHandlerURLScheme = sip;
LSHandlerRoleAll = "<CFBundleIdentifier>";
}'
|}
To find the “CFBundleIdentifier”, proceed as follows:

* In the Finder under “Applications”, search for the desired myApps client that you want to set as the default app.

* Right-click on “Show package contents” -> you will find the “CFBundleIdentifier” in the Info.plist file.

A restart of the MAC is required.

=== 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/11] for details.

=== Windows 11 ===

* Windows 11 has a feature "do not disturb". This hides notifications if enabled.
* Windows 11 has a feature "focus". This enables "do not disturb" and thus hides notifications too.
* Windows 11 has priority settings for notifications. Ensure that VoIP notifications for calls are allowed any maybe also include myApps as an App which is allowed to show notifications.

== 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|Reference14r2:Concept_myApps_Redundancy]]
* [[{{NAMESPACE}}:Concept_myApps_Office_Integration|Reference14r2:Concept_myApps_Office_Integration]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts|Reference14r2:Concept_myAPPs_Search_in_local-Outlook_Contacts]]
* [[{{NAMESPACE}}:Call_Detail_Record_CDR_PBX|Reference14r2:Call_Detail_Record_CDR_PBX]]
* [[{{NAMESPACE}}:Concept Push Notifications for myPBX iOS and Android|Reference14r2: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]]

Howto:Power Consumption

2025-01-06T14:27:42Z

Mpu: /* Use of extension modules */

==Supply via Power over Ethernet (PoE)==
===Power level===
The power consumption of PoE devices is separated into several classes for power sourcing equipment (PSE) and the powered device (PD).
{| border=1
|+
|Class
|Usage
|Power level PSE [W]
|Power level PD [W]
|-
|0
|default
|15,4
|0,44 - 12,95
|-
|1
|optional
|4
|0,44 - 3,84
|-
|2
|optional
|7
|3,84 - 6,49
|-
|3
|optional
|15,4
|6,49 - 12,95
|-
|4
|optional
|30
|12,95-25,5 W (802.3at/Typ 2)
|}

===Power level of innovaphone devices===
Gateways:
{| border=1
|+
|Device
|PoE-Class
|average total input power [mW]*
|max total input power [mW]*
|-
|IP22
|3
|3000
|4600
|-
|IP24
|3
|3600
|6800
|-
|IP28
|3
|4000
|12900
|-
|IP38
|1
|2800
|3800
|-
|IP302
|3
|3000
|4800
|-
|IP305
|2
|2900
|3000
|-
|IP800 up to HW201
|0
|
|
|-
|IP800 ex HW300
|3
|4700
|10500
|-
|IP2000
|3
|5900
|6500
|-
|IP6000
|3
|9800
|10000
|-
|IP1200
|0
|5000
|8000
|-
|IP1202/IP1203
|2
|
|5000
|-
|IP0010
|3
|8000
|12500
|-
|IP3010
|3
|8000
|12500
|-
|IP6010
|3
|8000
|12500
|-
|IP1060
|3
|8000
|12500
|-
|IP810
|3
|8000
|12500
|-
|IP311/IP411/IP811/IP29/IP0011
|3
|5000
|12500
|-
|IP1130/IP3011
|3
|8000
|12500
|-
|IP29-2/4/8
|3
|May vary in dependency of FXS usage.
|12500
|-
|IP29-20
|4
|May vary in dependency of FXS usage.
|25500
|-
|IP0013/IP6013
|4
|n.a.
|25500
|-
|}

Phones:
{| border=1
|+
|Device
|PoE-Class
|idle state [mW]****
|average total input power [mW]*
|max total input power [mW]*
|manufacturing check [mW]**
|-
|IP110
|1
|
|2500
|2700
|3500
|-
|IP200A
|1
|
|2900
|3200
|3500
|-
|IP230
|2
|
|2600
|2900
|3500
|-
|IP240
|2
|
|3100
|3800
|4000
|-
|IP150
|1
|
|2800
|3000
|3500
|-
|IP240-1000
|2
|
|4900
|5900
|6500
|-
|IP230-x
|extension module
|
|1000
|1000
|
|-
|IP241
|HW < 402 = 3
HW >= 402 = 2
|2400
|< 3500
|
|
|-
|IP222
|2
|2500
|4800***
|
|
|-
|IP232
|2
|2600
|4900***
|
|
|-
|IP111(A)
|1
|1400
|2000
|3800
|2500
|-
|IP112(A)
|2
|1800
|2100
|4000
|2500
|-
|IP101
|1
|
|
|2000
|
|-
|IP102
|2
|
|
|3500
|
|-
|}

*These values were averaged results from simulating normal and maximum use.
To have an official max total input power value please orientate on the upper limit of the associated PoE class.

**All devices leaving the manufacturing process are checked whether the cunsumption is under this value.

***LAN and PC interface connected with 1Gbit/s. 4xUSB connected (only IP2x2).

****LAN connected with 100Mbit/s. PC not connected. EEE active if supported. LCD light (idle state) == 0

Estimated worst case power consumption for operation of a 240-1000 with 3 IP230-X

5.9W +3*1W= 8.9W

Estimated worst case power consumption for operation of a 240 with 3 IP230-X

3.8W +3*1W= 6.8W

=== PoE Injector Capacity ===
PoE injector offered by innovaphone (order code 03-00010-231) fulfills the power demand PoE capable innovaphone devices need (generally 15W at PSE side). 
This is good for any device up to '''PoE class 3''' (not IP29-20 & IPxx13). 
Currently, innovaphone offers no POE+ injector.

==Supply via Power Supply Unit (PSU)==
Most of the innovaphone devices can be supplied by an external PSU (exception: IP800; IP2000; IP6000 with build in power supply).
All testreadings were determined by measuring the power consumption of the PSU. They are no official numbers. The following tables are showing different phone modes. All values in mW.
===12V PSU for phones===
Without using switch functionality (only LAN is connected 100Mbit/s):
{| border=1
|+
|Device
|Standby
|On-Hook
|Active (handsfree with max loudness)
|Ringing
|-
|IP110
|2900
|3000
|3400
|3000
|-
|IP200A
|3400
|3500
|3900
|3500
|-
|IP230
|3000
|3300
|3500
|3300
|-
|IP240
|3400
|3700
|3800
|3700
|-
|IP240-1000
|5200
|5500
|5700
|5500
|-
|IP241
|< 3500
|
|
|
|-
|IP222
|2500
|
|
|
|-
|IP232
|2600
|
|
|
|-
|}

Using switch functionality (PC + LAN is connected 100Mbit/s):
{| border=1
|+
|Device
|Standby
|On-Hook
|Active (handsfree with max loudness)
|Ringing
|-
|IP110
|3300
|3400
|3700
|3400
|-
|IP200A
|3900
|3900
|4400
|3900
|-
|IP230
|3400
|3600
|3800
|3600
|-
|IP240
|3800
|4100
|4200
|4100
|-
|IP240-1000
|7400
|7700
|7900
|7700
|-
|IP241
|4500***
|
|
|
|-
|IP222
|4200***
|
|
|
|-
|IP232
|4300***
|
|
|
|-
|}

====Use of extension modules====

* IP230/IP24x plus up to three IP230-X: a more efficient PSU is needed. Please use the 40V Gateway PSU or PoE injector from innovaphone (order no 03-00010-231)
* IP2x2 plus IP2x2x: same as above - a more efficient PSU is needed. Please use the 40V Gateway PSU or PoE injector from innovaphone (order no 03-00010-231)

===40V PSU for IP adapters and gateways===

Note as of May 2018: This product is End-of-life and no more offered by innovaphone.

The 40V PSU (order no. 03-00010-226) can be used for all gateways and adapters with small housing. In detail these are IP22, IP24, IP28, IP38, IP302 and IP305.

==Releated notes==
=== Heat output (BTU) ===
Sometimes we receive inquiries about the heat output (BTU - [https://en.wikipedia.org/wiki/British_thermal_unit British Thermal Unit]) of our devices.

innovaphone itself does not provide any information about this.

With afore mentioned power consumption values (! units are in mW) and corresponding converters (e.g. [https://umrechner.info/Kilowattstunde-BTU here]), the BTU can be calculated on your own responsibility.

Howto15r1:Firmware Upgrade V14r2 V15r1

2024-12-03T12:08:09Z

Mpu: /* Flash Memory */

Howto15r1:Firmware Upgrade V14r2 V15r1

2024-12-03T12:07:43Z

Mpu: /* RAM */

Howto15r1:Firmware Upgrade V14r2 V15r1

2024-12-03T12:07:31Z

Mpu: /* RAM */

Howto:Firmware Upgrade

2024-10-23T14:34:06Z

Mpu:

== Applies To ==
This information applies to:
* All innovaphone devices and software

== Firmware support policy ==

For currently supported firmware versions, please [[Support:Supported_innovaphone_versions|refer to this overview]].

== Firmware upgrade policy ==

When upgrading from a previous major version to a service release within a higher major version, it is mandatory to upgrade in stages.

For example, if you want to upgrade from 12r2 to 13r3, you must first upgrade from 12r2 to 13r1, then from 13r1 to 13r2 and then from 13r2 to 13r3, following the instructions listed for each major upgrade.

You will find a separate wiki article for each major step, which describes all the necessary adjustments required for the upgrade.

== Version 14r2 ==
Before you try to upgrade to Version 14r2, be sure to read [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]. For release notes, see [[ReleaseNotes14r2:Firmware]].
 With release of 14r2 we support firmware versions 14r2, 14r1, 13r3 and 12r2.

14r2 will not work with V13 licenses! You will need a license update thus in order to upgrade from 13r1/2/3 to 14r2.

Deprecated software in this and the following versions:
* App Platform running on CF card (migrate to hosting your App Platform on an SSD or virtualized)
* iQM (innovaphone Queue Monitor) (migrate to the [[Howto:Queueboard_-_MediaRunway_-_Partner_App|Queueboard App]])

No longer supported software in this and the following versions:
* Linux Application Platform (v10) (migrate to innovaphone App Platform)
* innovaphone Faxserver (v10) (migrate to Fax App)
* innovaphone Reporting (v10) (migrate to Reports App)
* innovaphone Exchange (v10) (migrate to Calendar App)
* Operator (v9) (migrate to Switchboard App)
* innovaphone Voice Recording 2014 (migrate to Recordings App)
* PBX Object External UC (use integrated presence feature or migrate to the new presence apps)

== Version 14r1 ==
Before you try to upgrade to Version 14r1, be sure to read [[Howto:V14 Firmware Upgrade V13r3 V14r1]]. For release notes, see [[ReleaseNotes14r1:Firmware]].
 With release of 14r1 we support firmware versions 14r1, 13r3 and 12r2.

14r1 will not work with V13 licenses! You will need a license update thus in order to upgrade from 13r1/2/3 to 14r1.

No longer supported hardware in this and the following versions:
* IP150 (can still be used with 13r2 firmware)

No longer supported software in this and the following versions:
* myPBX (removed, migrate to myApps)
* Widgets (removed, migrate to Contacts Widget App)
* WebRTC toolkit (removed, migrate to innovaphone SDK)
* Windows Softwarephone (removed, migrate to Softphone App)
* PBX Object Settings (removed, migrate to Profile App)
* PBX Object ICP (removed, use integrated presence feature instead)
* Service Call-Lists (removed, migrate to Reports App)

Deprecated software in this and the following versions:
* Linux Application Platform (v10) (migrate to innovaphone App Platform)
* innovaphone Faxserver (v10) (migrate to Fax App)
* innovaphone Reporting (v10) (migrate to Reports App)
* innovaphone Exchange (v10) (migrate to Calendar App)
* Operator (v9) (migrate to Switchboard App)
* innovaphone Voice Recording 2014 (migrate to Recordings App)
* PBX Object External UC (use integrated presence feature or migrate to the new presence apps)

== Version 13r3 ==

Before you try to upgrade to Version 13r3, be sure to read [[Howto:V13 Firmware Upgrade V13r2 V13r3]]. For release notes, see [[ReleaseNotes13r3:Firmware]].

No longer supported hardware in this and the following versions:
* IP150 (can still be used with 13r2 firmware)

== Version 13r2 ==

Before you try to upgrade to Version 13r2, be sure to read [[Howto:V13 Firmware Upgrade V13r1 V13r2]]. For release notes, see [[ReleaseNotes13r2:Firmware]].

No longer supported hardware in this and the following versions:
* IP150A

== Version 13r1 ==
Before you try to upgrade to Version 13r1, be sure to read [[Howto:Firmware Upgrade V12r2 V13r1]]. For release notes, see [[ReleaseNotes13r1:Firmware]].

13r1 will not work with V12 licenses! You will need a license update thus in order to upgrade from 12r1/12r2 to 13r1.

IP62 does not support RTCP-mux and is unsuitable for general use in 13r1 and later installations.

Note: For 13r1 use the new innovaphone App Platform. However the V10 Linux Application Platform and its applications are still supported for the time being.

Note: In 13r1 we introduced myApps and the innovaphone phone apps that replace myPBX. However myPBX is still supported for the time being.

== Version 12r2 ==
Before you try to upgrade to Version 12r2, be sure to read [[Howto:Firmware Upgrade V11r2 V12r1]] and [[Howto:Firmware Upgrade V12r1 V12r2]]. For release notes, see [[ReleaseNotes12r2:Firmware]].

12r2 will not work with V11 licenses! You will need a license update thus in order to upgrade from 11r1/2 to 12r2.

No longer supported hardware in this and the following versions:

* IP72

IP150 is still supported, but has some functions removed.

The following devices are still supported, but have the PBX function removed:
* IP38
* IP302
* IP305
* IP800
* IP2000
* IP6000

Note: use V10 Linux Application Platform and its applications for 12r2 installations!

== Version 12r1 ==
Before you try to upgrade to Version 12r1, be sure to read [[Howto:Firmware Upgrade V11r2 V12r1]]. For release notes, see [[ReleaseNotes12r1:Firmware]].

Note that in Version 12r1 there are no test licenses any more! They are replaced by the test mode, see [[Reference12r1:General/License]] for details.

12r1 will work not with V11 licenses! You will need a license update thus in order to upgrade from 11r1/2 to 12r1.

There is only limited hardware 12r1 support for
* IP200A
* IP230

Note: use V10 Linux Application Platform and its applications for 12r1 installations!

== Version 11r2 ==
Before you try to upgrade to Version 11r2, be sure to read [[Howto:Firmware_Upgrade_V11r1_V11r2]]. For release notes, see [[ReleaseNotes12r2:Firmware]].

Note that in Version 11r2 there are no test licenses any more! They are replaced by the test mode, see [[Reference11r2:General/License]] for details.

There is only limited hardware 11r2 support for
* IP200A
* IP230

Note: use V10 Linux Application Platform and its applications for 11r2 installations!

== Version 11r1 ==
Before you try to upgrade to Version 11r1, be sure to read [[Howto:Firmware_Upgrade_V10_V11r1]]. For release notes, see [[ReleaseNotes11r2:Firmware]].

Note that in Version 11r1 there are no test licenses any more! They are replaced by the test mode, see [[Reference11r1:General/License]] for details.

There is only limited 11r1 hardware support for
* IP110 (there are new models IP110'''A''' though with full support)
* IP200A
* IP230
* IP240 (there are new models IP240'''A''' though with full support)

Note: use V10 Linux Application Platform and its applications for 11r1 installations!

== Version 10 ==

No longer supported hardware in this and the following versions:
* IP600
* IP1500
* IP3000
* IP3000DD
* IP21
* IP400
* IP202
* IP200 (the old one, not IP200A, see label on the back)

== Important note regarding provisioning! ==
Starting with version 10, innovaphone devices connect automatically with http://config.innovaphone.com/init during commissioning or after restoring factory settings. This process serves to simplify provisioning. A connection is always established automatically to http://config.innovaphone.com/init. If you would like to avoid this procedure, the innovaphone device must be booted in an environment without a public internet connection. For more information about provisioning possibilities, see: [[Reference10:Concept_Provisioning]]. The following information is transmitted to innovaphone upon connection with http://config.innovaphone.com/init: The version and serial number of the device and the public IP address. This information is managed in accordance with innovaphone's data protection policy.

== Related Articles ==
* [[Support:Supported innovaphone versions]]

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

Howto:Firmware Upgrade

2024-10-23T14:32:55Z

Mpu:

== Applies To ==
This information applies to:
* All innovaphone devices and software

== Firmware support policy ==

For currently supported firmware versions, please [[Support:Supported_innovaphone_versions|refer to this overview]].

== Firmware upgrade policy ==

When upgrading from a previous major version to a service release within a higher major version, it is mandatory to upgrade in stages.

For example, if you want to upgrade from 12r2 to 13r3, you must first upgrade from 12r2 to 13r1, then from 13r1 to 13r2 and then from 13r2 to 13r3, following the instructions listed for each major upgrade.

You will find a separate wiki article for each major step, which describes all the necessary adjustments required for the upgrade.

== Version 14r2 ==
Before you try to upgrade to Version 14r2, be sure to read [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]. For release notes, see [[ReleaseNotes14r2:Firmware]].
 With release of 14r2 we support firmware versions 14r2, 14r1, 13r3 and 12r2.

14r2 will not work with V13 licenses! You will need a license update thus in order to upgrade from 13r1/2/3 to 14r2.

Deprecated software in this and the following versions:
* App Platform running on CF card (migrate to hosting your App Platform on an SSD or virtualized)
* iQM (innovaphone Queue Monitor) (migrate to the [[Howto:Queueboard_-_MediaRunway_-_Partner_App|Queueboard App]])

No longer supported software in this and the following versions:
* Linux Application Platform (v10) (migrate to innovaphone App Platform)
* innovaphone Faxserver (v10) (migrate to Fax App)
* innovaphone Reporting (v10) (migrate to Reports App)
* innovaphone Exchange (v10) (migrate to Calendar App)
* Operator (v9) (migrate to Switchboard App)
* innovaphone Voice Recording 2014 (migrate to Recordings App)
* PBX Object External UC (use integrated presence feature or migrate to the new presence apps)

== Version 14r1 ==
Before you try to upgrade to Version 14r1, be sure to read [[Howto:V14 Firmware Upgrade V13r3 V14r1]]. For release notes, see [[ReleaseNotes14r1:Firmware]].
 With release of 14r1 we support firmware versions 14r1, 13r3 and 12r2.

14r1 will not work with V13 licenses! You will need a license update thus in order to upgrade from 13r1/2/3 to 14r1.

No longer supported hardware in this and the following versions:
* IP150 (can still be used with 13r2 firmware)

No longer supported software in this and the following versions:
* myPBX (removed, migrate to myApps)
* Widgets (removed, migrate to Contacts Widget App)
* WebRTC toolkit (removed, migrate to innovaphone SDK)
* Windows Softwarephone (removed, migrate to Softphone App)
* PBX Object Settings (removed, migrate to Profile App)
* PBX Object ICP (removed, use integrated presence feature instead)
* Service Call-Lists (removed, migrate to Reports App)

Deprecated software in this and the following versions:
* Linux Application Platform (v10) (migrate to innovaphone App Platform)
* innovaphone Faxserver (v10) (migrate to Fax App)
* innovaphone Reporting (v10) (migrate to Reports App)
* innovaphone Exchange (v10) (migrate to Calendar App)
* Operator (v9) (migrate to Switchboard App)
* innovaphone Voice Recording 2014 (migrate to Recordings App)
* PBX Object External UC (use integrated presence feature or migrate to the new presence apps)

== Version 13r3 ==

Before you try to upgrade to Version 13r3, be sure to read [[Howto:V13 Firmware Upgrade V13r2 V13r3]]. For release notes, see [[ReleaseNotes13r3:Firmware]].

No longer supported hardware in this and the following versions:
* IP150 (can still be used with 13r2 firmware)

== Version 13r2 ==

Before you try to upgrade to Version 13r2, be sure to read [[Howto:V13 Firmware Upgrade V13r1 V13r2]]. For release notes, see [[ReleaseNotes13r2:Firmware]].

No longer supported hardware in this and the following versions:
* IP150A

== Version 13r1 ==
Before you try to upgrade to Version 13r1, be sure to read [[Howto:Firmware Upgrade V12r2 V13r1]]. For release notes, see [[ReleaseNotes13r1:Firmware]].

13r1 will not work with V12 licenses! You will need a license update thus in order to upgrade from 12r1/12r2 to 13r1.

IP62 does not support RTCP-mux and is unsuitable for general use in 13r1 and later installations.

Note: For 13r1 use the new innovaphone App Platform. However the V10 Linux Application Platform and its applications are still supported for the time being.

Note: In 13r1 we introduced myApps and the innovaphone phone apps that replace myPBX. However myPBX is still supported for the time being.

== Version 12r2 ==
Before you try to upgrade to Version 12r2, be sure to read [[Howto:Firmware Upgrade V11r2 V12r1]] and [[Howto:Firmware Upgrade V12r1 V12r2]]. For release notes, see [[ReleaseNotes12r2:Firmware]].

12r2 will not work with V11 licenses! You will need a license update thus in order to upgrade from 11r1/2 to 12r2.

No longer supported hardware in this and the following versions:

* IP72

IP150 is still supported, but has some functions removed.

The following devices are still supported, but have the PBX function removed:
* IP38
* IP302
* IP305
* IP800
* IP2000
* IP6000

Note: use V10 Linux Application Platform and its applications for 12r2 installations!

== Version 12r1 ==
Before you try to upgrade to Version 12r1, be sure to read [[Howto:Firmware Upgrade V11r2 V12r1]]. For release notes, see [[Reference12r1:Release Notes Firmware]].

Note that in Version 12r1 there are no test licenses any more! They are replaced by the test mode, see [[Reference12r1:General/License]] for details.

12r1 will work not with V11 licenses! You will need a license update thus in order to upgrade from 11r1/2 to 12r1.

There is only limited hardware 12r1 support for
* IP200A
* IP230

Note: use V10 Linux Application Platform and its applications for 12r1 installations!

== Version 11r2 ==
Before you try to upgrade to Version 11r2, be sure to read [[Howto:Firmware_Upgrade_V11r1_V11r2]]. For release notes, see [[ReleaseNotes12r2:Firmware]].

Note that in Version 11r2 there are no test licenses any more! They are replaced by the test mode, see [[Reference11r2:General/License]] for details.

There is only limited hardware 11r2 support for
* IP200A
* IP230

Note: use V10 Linux Application Platform and its applications for 11r2 installations!

== Version 11r1 ==
Before you try to upgrade to Version 11r1, be sure to read [[Howto:Firmware_Upgrade_V10_V11r1]]. For release notes, see [[ReleaseNotes11r2:Firmware]].

Note that in Version 11r1 there are no test licenses any more! They are replaced by the test mode, see [[Reference11r1:General/License]] for details.

There is only limited 11r1 hardware support for
* IP110 (there are new models IP110'''A''' though with full support)
* IP200A
* IP230
* IP240 (there are new models IP240'''A''' though with full support)

Note: use V10 Linux Application Platform and its applications for 11r1 installations!

== Version 10 ==

No longer supported hardware in this and the following versions:
* IP600
* IP1500
* IP3000
* IP3000DD
* IP21
* IP400
* IP202
* IP200 (the old one, not IP200A, see label on the back)

== Important note regarding provisioning! ==
Starting with version 10, innovaphone devices connect automatically with http://config.innovaphone.com/init during commissioning or after restoring factory settings. This process serves to simplify provisioning. A connection is always established automatically to http://config.innovaphone.com/init. If you would like to avoid this procedure, the innovaphone device must be booted in an environment without a public internet connection. For more information about provisioning possibilities, see: [[Reference10:Concept_Provisioning]]. The following information is transmitted to innovaphone upon connection with http://config.innovaphone.com/init: The version and serial number of the device and the public IP address. This information is managed in accordance with innovaphone's data protection policy.

== Related Articles ==
* [[Support:Supported innovaphone versions]]

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

Reference10:Concept SOAP API

2024-10-04T11:06:43Z

Mpu: Mpu moved page Reference14r2:Concept SOAP API to Reference10:Concept SOAP API without leaving a redirect

innovaphone®'s PBX web services, also known as SOAP API, while no longer actively extended, remains available and functional. A transition to WebSocket API, specifically the RCC API (https://sdk.innovaphone.com/13r3/doc/appwebsocket/RCC.htm), was introduced with version 13 firmware.

For ongoing development, we recommend utilizing [http://www.innovaphone.com/wsdl/pbx10_00.wsdl WSDL version 10 ''pbx10_00.wsdl''] (also available on the gateway <code>http://xx.xx.xx.xx/pbx10_00.wsdl</code>) in conjunction with this Wiki article. It's advisable to disregard the higher versions of WSDL for your development.

For upcoming developments the WebSocket API should be used, as it represents the current and future direction of our API development.

==Overview==

For an overview of the basic architecture, see the [[Reference:SOAP_API_%28pbx501.wsdl%29#Overview|corresponding chapter in the pbx501.wsdl related article]].

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

== Definition of PBX object (WSDL) ==
Within the SOAP framework there is a mechanism to formally decribe the definition of remote objects. This is done by so called WSDL (Web Service Description Language) files. This [[http://www.innovaphone.com/wsdl/pbx10_00.wsdl wsdl file]] defines the PBX web services described in this document.

NB: while you can access and retrieve the WSDL file through this URL on runtime of your application, we'd rather recommend to install a local copy with your application and use this on runtime. This way, your application will be immune against failures of www.innovaphone.com.

There is also an [[http://www.innovaphone.com/wsdl/pbx900.wsdl old version of the wsdl]] available which has less interface functions. This interface can still be accessed by legacy applications and is activated on the PBX by calling the '''Initialize''' Function with fewer arguments ('''Integer Initialize(string user, string appl, out key)'''). It should not be used for new develoments though.

=== SOAP URL ===
The SOAP service URI is '''/PBX0/user.soap''' for the standard PBX and '''/PBX-''id''/user.soap''' for a dynamic PBX (where ''id'' corresponds to the ''Id'' field in the [[Reference10:PBX/Dyn-PBXs]] configuration dialog). SOAP is accessible via plain HTTP or HTTPS, so valid URLs might be <code>http://172.16.0.1/PBX0/user.soap</code> or <code>https://172.16.0.1/PBX0-mydynpbxid/user.soap</code>.

==PBX Objects and Methods==

This section contains a language agnostic description of the PBX API’s object model. Despite of the fact that we are discussing an object model, the PBX API is in fact not an object oriented API. This is because SOAP itself is not really object oriented. In particular, there is no object creation, activation or lifetime concept. This is left up to the service designer. SOAP is more a message exchange mechanism than an object method invocation mechanism. This is reflected in the API structure.

Specifically, objects are represented through handles, which are integers. Objects are created and destroyed using dedicated methods and it’s the users responsibility to manage the lifetime of all objects.

The syntax shown here actually is no valid syntax in any existing language. Please refer to the various sample codes for working syntax.

===Session===

All PBX API methods are executed in the context of a session. A session is created using the '''initialize''' method and is identified by a handle. This handle must be provided to all subsequent method calls.

A session is owned by the PBX API user, i.e. there is no way to have access to a session of another application. Each session has a scope, which defines the view of the PBX the session user has. The scope determines the set of PBX registrations seen by the session.

Scopes are defined and configured in the PBX and are bound to particular PBX users. Thus, a session has a user attribute, which defines the scope. It includes all users which are members of groups '''user''' is active member of. If '''user''' is not an active member of any group, the scope is the user itself.

====Initialize(string user, string appl, bool $v, bool $v501, bool v700, bool v800, bool vx1000, out int key)====

To access the current web services implementation, '''v''', '''v501''', '''v700''', '''v800''' and '''vx10000''' must be present and set to '''true'''.
These parameters actually convey the wsdl version used by the client. Different versions of the interface use different parameter sets for the Initialize call. Applications should always use the wsdl version current at the time of writing the application.

The method creates a session. The session will have the user '''user'''’s scope ('''user''' is the ''Long Name'' of a PBX user). The session handle is returned and is 0 for failure and positive for a valid session handle. '''appl''' specifies the name of the calling application and is used for administrative purposes. The output parameter '''key''' is a random number associated to the session. It may be used in subsequent '''Echo''' operations.

When a session is created, '''UserInfo''' events for all PBX registrations in the scope can be received by the '''Poll''' function. Initially, one '''UserInfo''' per registration within the session’s scope is received (the list is terminated by a '''UserInfo''' with empty '''cn''' and may require multiple '''Poll''' calls to retrieve). Subsequently, '''UserInfo''' events are received when a registrations state changes.

The underlying transport session (HTTP) must authenticate itself either as '''user''' (using the users long name and PBX password) or as the admin user (using the gateway administrator account name and password) to perform an '''Initialize''' and any session related function. Note that if you use a PBX user account, the user needs to have at least ''Group/Call Forwards'' rights.

Note that the method to force the SOAP system you are using to authenticate to the PBX is entirely up to the system itself. Some systems even do not support authentication at all. If your SOAP implementation does not support digest authentication, make sure the gateway accepts basic authentication by setting the “''allow HTTP basic authentication''” in the “''General settings''”.

Note that although many HTTP connections may be used in a single session, at least one HTTP connection must remain open during the lifetime of the session. When the last connection disappears, the logical session is terminated after a short timeout. Some SOAP libraries may per default always close the HTTP connection and reconnect on subsequent SOAP calls, which will not work. The SOAP library should either be configured to keep at least one HTTP connection alive or, if this is not an option, the application should take care to always have a an active request pending (such as '''Poll''').

====Echo(integer session, integer key)====

Verifies a session. You need to supply the ''session'' identifier and ''key'' returned by a previous call to '''Initialize'''. Returns nonzero if successful.

====End(integer session)====

Terminates the session referenced by ''session''. No further events will be received.

====Integer Version(out string gkId, out string location, out string firmware, out string serial)====

Returns the version number of the WSDL file the PBX supports. The first released WSDL file had version number 500. The version described by this document has version number 501. Also delivers information about the connected PBX (in ''gkId'', ''location'', ''firmware'' and ''serial'').

====AnyInfo Poll(integer session)====

Returns pending events for the session referenced by ''session''. ''AnyInfo'' is a struct with four arrays as members: ''user'', ''call'', ''reg'' and ''info''. ''user'' is an array of type ''UserInfo'' and call is an array of type CallInfo. The other two arrays ''reg'' and ''info'' are currently not used.

After a successful '''Initialize()'' there will be a ''UserInfo'' event for each defined and visible user in the system. This allows the application to synchronize on the state of all visible users. The list will be terminated by an ''UserInfo'' event for a user with an empty ''cn'' which normally cannot happen since a user entry must have a cn.

===User===

A user represents a configured object within the PBX (a “PBX user”). The PBX API provides the '''UserInitialize''' method to obtain a handle to the user.

====UserInfo====
The user’s properties are stored in a ''UserInfo'' structure, which has the following elements:

*'''boolean active'''

true if the user exists. The only case where active can be false is when a user is moved out of the session context. This may happen if the users group assignment is changed or the user is deleted. A single UserInfo event will be posted with active set to false then.

*'''integer state'''

1 if the user is registered, 0 otherwise.

*'''integer channel'''

number of current calls.

*'''integer alert'''

number of alerting calls

*'''string type'''

the type of the users device. Currently defined are “'''ep'''” (it is an endpoint), “'''gw'''” (it is a gateway, for example a trunk line), “'''waiting'''” (a call queue) or “'''broadcast'''” (a group). Others may be defined over time.

*'''string guid'''

the users GUID. This is a globally unique identifier for the user.

*'''string cn'''

the common name of the user. This is what the PBX’s LDAP server recognizes as the CN of this user. The user’s name in the PBX configuration applet.

*'''string e164'''

the extension number the user is registered with.

*'''string h323'''

the alias the user is registered with.

*'''string dn'''

the users display name.

*'''string domain'''

the PBX domain if the Gatekeeper ID is used as domain

*'''boolean h323email'''

If true, the h323 name shall be used as primary email address when sending emails to this user.

*'''string email[]'''

email addresses of the user. If 'h323email' is not set, the first address in this list shall be used as primary email address when sending emails to this user.

*'''Group groups'''

An array of '''Group''' records (see below).

*'''Presence presence'''

An array of '''Presence''' records (see below).

*'''boolean cfg'''

If set to true indicates that the config of the user has changed

*'''string object'''

The type of the user object

*'''string loc'''

If the object described is not local to the PBX the '''UserInfo''' is sent from, the name of the location the object is homed in is given in this element. See '''LocationUrl''' to find out how to proceed further.

*'''string node'''

The node of the object.

*'''string nodenum'''

The object nodes node number (prefix).

*'''Info'''
An '''Info''' record describing various aspects of the user. The type of the information described in an individual '''Info''' record is determined by the value of its ''type'' member. Currently defined values for ''type'' are:

:*'''fake'''
: The value configured as 'Send Number'

*'''groups'''

The users group memberships are stored in a '''Group''' record which has the following elements:

:*'''string group'''

: the name of the group the user is a member of

:*'''bool active'''

: true if the user is an active member of the group

*'''presence'''

The users presence status is stored in a '''Presence''' record which has the following elements:

:*'''string status'''

: either '''open''' or '''closed'''

:*'''string activity'''

: The users current activity (optional)

:*'''string note'''

: The user provided additional note (optional)

====integer UserInitialize(integer session, string user, bool xfer, bool disc, string hw)====

Returns a handle to the named ''user'' (0 on failure). String <code>user</code> must be a Long Name(cn). Phone number(e164) is not supported. Use FindUser instead, to retrieve cn to specified e164 number.

Once a user handle is obtained with '''UserInitialize''', '''CallInfo''' events will be posted and retrieved via '''Poll''' for all calls related to the user. If '''xfer''' is set to '''true''', '''CallInfo''' events will also be posted for calls which are transferred away from '''user'''. Otherwise, such events will be posted only for the user handle which the call has been transferred to. Thus, without setting follow to true, an application will generally not be able to track calls after a transfer unless it has called '''UserInitialize''' for any PBX object a call may be transferred to and matches the new call on the transferred-to user via the '''conf''' information in the '''Info''' record of the new call (which will be identical to the '''conf''' information for the transferred call).

When '''xfer''' is set to '''true''', transferred calls will show up in the '''CallInfo''' records with a '''No''' element of type '''xfer''' that indicates the number the call has been transferred to.

When '''disc''' is set to '''true''', calls to phones of the monitored user are cleared only after the user hangs up the phone. This way it can be avoided that the SOAP application assumes the phone is free but is still off-hook. This only works with innovaphone H.323 endpoints since the Disconnect message used to do this is not defined in the SIP standard.

When a '''hw''' argument is provided only the device identified by this is monitored. Please note that a valid handle will be returned even if there is no matching device for '''user'''.

Also, the user handle can be used to create and control calls on behalf of the user.

====void UserEnd(integer user)====

Frees the handle ''user'' obtained with '''UserInitialize'''. No events will be posted for this user anymore.

====int SetPresence(inno:Presence presence, bool im, string contact, string guid, string h323)====

Sets the presence of a PBX user.

* '''presence''':
:* '''inno:PresenceStatus''': the status '''closed'''/'''open''' or empty
:* '''inno:PresenceActivity''': the activity like '''busy'''
:* string '''note''': the presence note
* '''im''': from im client?
* '''contact''': the presence contact like '''tel:''', '''calendar:'''...
* '''guid''': the user guid
* '''h323''': the h323 name of the user

You can use '''guid''' or '''h323''' to identify the user! If no guid is known, use '''*''' as guid value.
 
If the setting of the presence was ok, the method returns '''1'''. Otherwise '''0'''.

===Device===

For each User object multiple devices can be configured within the PBX. A device represents the physical endpoint used for calls (e.g. phones). Any registration to the PBX is associated to a configured device by the name/number used for the registration. Even thou it is possible that one configured device in the PBX accepts multiple registrations, it is recommened to configure the PBX in a way that there is one registration to a device. This way an application can control which physical endpoint is used for a call.

====Device[] Devices(int session, string user)====

This function returns an array of devices configured for a user identified by its cn (long name). The '''cfg''' flag in '''UserInfo''' is set when this information is changed. The structure 'Device' contains the following members:

{|
|valign=top nowrap=true|'''hw'''
|The Hardware Id used to identify the device. This string is used to associate any calls to devices.
|-
|valign=top nowrap=true|'''text'''
|A text configured as a description of the device. It can be used to be presented to the user for the user to select a device.
|}

===Call===
A call represents one leg of an existing call in the PBX.

====CallInfo====
The calls attributes are stored in a '''CallInfo''' structure, which has the following elements:

*'''int user'''

the user handle the call belongs to

*'''int call'''
the call handle

*'''int reg'''

currently unused

*'''bool active'''

'''true''' if the call exists, '''false''' if not. The only case where ''active'' can be '''false''' is when a call is terminated. A single '''CallInfo''' event will be posted with ''active'' set to '''false''' then

*'''integer state'''

A calls state. A bit field made up as follows:
{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+
| Value
| Mask
| Meaning
|-
| 1
| 0xF
| setup
|-
| 2 || 0xF || setup-ack
|-
| 3 || 0xF || call-proc
|-
| 4 || 0xF || Alert
|-
| 5 || 0xF || Connect
|-
| 6 || 0xF || disconnect sent
|-
| 7 || 0xF || disconnect received
|-
| 8 || 0xF || parked
|-
| 0 || 0x80 || inbound call
|-
| 128 || 0x80 || outbound call
|-
| 0 || 0x100 || active call
|-
| 256 || 0x100 || call on hold
|-
| 0 || 0x200 || active call
|-
| 512 || 0x200 || active call put on hold by peer
|}

Note that the PBX API is PBX-centric, not terminal centric. As such, it considers a call ''from'' the PBX ''to'' the terminal as ''outbound''.

Refer to the [[Howto:SOAP API PHP5 Sample Code#Working with Call States from CallInfo]] Article to learn how to work with the call state values.

*'''string msg'''
A textual representation of the signalling message causing this event. E.g. “'''x-setup'''”.

*'''No No'''

An array of '''No''' records (see below). This can include information about various peers related to the call itself. The type of the peer described in an individual '''No''' record is determined by the value of its '''type''' member. Currently defined values for '''type''' are:

:*'''peer'''

: The current remote end of the call (the local end is determined by the UserInfo identified through the user handle above)

:*'''leg2'''

: The last diverting user (if any)

:*'''leg2orig'''

: The 1st diverting user (if any, from on v9hf1)

:* '''leg1'''

: Indicates a call-forward/blind-xfer(?) to the calling end

:*'''ct'''

: The last user having transferred the call (if any)

:*'''parked-to'''

: The call was parked to the indicated endpoint. This is sent with the 'r-rel' message indicating the clearing of this call.

:*'''picking'''

: The call was picked by the indicated endpoint. Usually empty because sent with the new call which is created at the picking endpoint, but the fact that it is present indicates that this is a picked up call. The endpoint where this call is picked from is indicated with a ''ct'' No within the same call_info.
*'''Info info'''

An '''Info''' record describing various aspects of the call. The type of the information described in an individual '''Info''' record is determined by the value of its ''type'' member. Currently defined values for ''type'' are:

:*'''conf'''

: A string holding the ''conference id'' (a GUID) of the call the reported call leg (all legs of a certain call share the same ''conference id''). Also, CDRs for a call show this ''conference id'' (''ref'' for [[Reference:Call_Detail_Record_CDR|gateway CDRs]], ''conf'' in the ''<event>'' tag for [[Reference10:Concept_Call_Detail_Record_CDR_PBX|PBX CDRs]]).
:*'''cause'''

: The latest [[Reference:ISDN_Cause_Codes | cause code ]] which has been notified on the call

===== CallInfo for Boolean Objects =====
A ''Boolean'' will send a CallInfo event when it's status changes. From the indicated number, you can derive the status as follows:

00 - Auto-Off
01 - Auto-On
10 - Manual-Off
11 - Manual-On

====No Record====

Peer information is stored in a '''No''' record with the following elements:

*'''string type'''

the type of the peer described by the record

*'''string cn'''

the peer’s PBX’s objects common name (if any)

*'''string e164'''

the peer’s phone number

*'''string h323'''

the peer’s h323 alias

*'''string dn'''

the peer’s display name

====Info record====
Various information is stored in '''Info''' records with the following elements:

*'''string type'''

: the type of the information described by the record. The following values for ''type'' are used (although more may appear at any time):
:; conf : the call conference guid
:; cause : a cause code related to the call, see [[Reference:ISDN Cause Codes]]
:; uui : a user-user-info sent or received on the call. The UUI is conveyed in the ''vals'' member (see below). Note that from 13r3 upwards, the UUI conveyed is url-encoded.

*'''string vals'''

a string value associated with this information (if any, the ''type'' of the element determines if an '''Info''' element has a string or an integer value)

*'''integer vali'''

an integer value associated with this information (if any)

Note that the call related functions do not return a meaningful value. This is because the operations success is reflected in the subsequent CallInfo events.

====integer UserCall(integer user, string cn, string e164, string h323, int reg, InfoArray info, int rc, string srce164)====

Creates an outgoing call from the '''user''' (which is a handle obtained by a call to '''UserInitialize''') to the destination described by ''cn'', ''e164'' and ''h323''. The argument '''srce164''' may be used to override the calling party number (note that this overrides the callers extension, not the full calling party number). Arguments ''reg'' and ''info'' are currently ignored. The argument ''rc'' is usually 0, unless special behavior is required by using other [[Reference8:SOAP_API#Remote_Control_Facilities|Remote Control Facilities]]. Returns a handle to the call (0 on failure).

The called number (''e164'') is interpreted in the context of the user object the call is placed for (''user'').

From V8HF3 on, if the srce164 argument of UserCall starts with 'r' or 'R', the call is sent with CLIR (calling line identification restricted).

Depending on the nature of the device the user is registered with, the device may actually place the call or the PBX may place a call and once it is accepted, it places another call to the destination.

====UserConnect(integer call)====
Connects an existing ''call''. This forces the device the user is registered with to accept the call. It may then go into hands-free mode. Incapable (i.e. non-innovaphone) devices may simply ignore this call.

====UserTransfer (int acall, integer bcall)====
''acall'' and ''bcall'' are both calls a single user currently has active. This method will connect ''acall'' with ''bcall'', leaving the user without both calls.

====UserMediaTransfer (integer acall, integer bcall, boolean user, boolean peer)====

This function establishes a media connection between two parties currently active in a call independent of the signalling connection. ''acall'' and ''bcall'' are both active (connected) calls. If ''user'' is true, the user sides of the calls are connected together, if ''peer'' is set to true the peer sides of the calls are connected together. If neither ''user'' nor ''peer'' is set the calls are connected to their respective signalling peers.

====bool UserRedirect(integer call, string cn, string e164, string h323, InfoArray info, int rc)====
Places a call to the destination described by ''cn'', ''e164'' and ''h323'' and connects ''call'' to this destination. Argument ''info'' is currently ignored. ''rc'' can carry one of the remote control facilities listed in [[Reference:Remote Control Facility]] (see also [[{{NAMESPACE}}:Concept_SOAP_API#UserRc(integer_call,_integer_rc)|UserRc]] below).

Any call forwarding configured for the destination will be ignored. See [[Reference8:SOAP_API#bool_UserReroute.28integer_call.2C_string_cn.2C_string_e164.2C_string_h323.29|UserReroute()]] below.

Note: in 2009, the semantics of UserRedirect has accidentally been changed so that call forwarding will no longer be ignored. From 14r1 Service Release 4, the original behavior can be restored by specifying 999 as ''rc''.

====bool UserReroute(integer call, string cn, string e164, string h323)====
Performs a rerouting of the call. Call forwardings set for the destination will be obeyed.

Note: rerouting calls on a waiting queue or call broadcast object works only if the ''Execute Operator CFB/CFNR'' or ''Execute Group Member Diversions'' option is turned on.

====integer UserPickup(int user, string cn, integer call, string group, int reg, InfoArray info)====
Redirects a call such that it appears as a new call at ''user''. The call to be redirected can be specified by its ''call'' handle. Alternatively, calls can be picked up by a users ''cn'' or by a ''group'' name. If all parameters are null, an implicit pickup is done. The new call handle is returned. Arguments ''reg'' and ''info'' are currently ignored.

====UserClear(integer call, integer cause, InfoArray info)====
Disconnects the ''call'' providing ''cause'' as disconnect reason. For example the cause code ''26 non-selected user clearing'' could be used to disconnect the call immediately on local phone, so no disconnect tone is played.

Cause is coded as a 7bit integer according to the table found in [[Reference:ISDN Cause Codes]].
Argument ''info'' is currently ignored.

====UserCtComplete(integer call, string e164, string h323)====

Sends a notification to the device ''call'' is active on that the remote peer has changed to ''e164'' and ''h323''. This resembles the notification a device may receive if its remote peer transfers the call to the new destination. The device may update its display and/or call data accordingly. This call is often used to force the devices (i.e. telephones) display to show application specific data.

====UserHold(integer call, bool remote)====
Sets the call on hold. The device may or may not display the hold status. In any case, the media channel is disconnected until a UserRetrieve is called.

In ''V8 hotfix23'' an additional parameter '''remote''' was added. If set to '''true''', '''remote''' will force to play MOH only to remote user (who is being held), set to '''false''' maintains the default behaviour (MOH played on remote user and a dialing tone to local user (depending on the pbx firmware, versions prior to v11r2 will play music on hold)). To use this parameter the recent WSDL 8.00 file must be retrieved.

====UserRetrieve(integer call)====
Retrieves the ''call'' on hold. The device may or may not display the new status. In any case, the media channel is reconnected.

====integer UserPark(integer call, string cn, integer position)====
Parks the call at the PBX object '''cn''' and local user on postion '''position'''. A position of -1 means any position is allowed. The return value is the handle of the new call.

To unpark calls, use the returned call handle with the '''UserPickup()''' function.

The '''cn''' argument can be used to identify another object, where the call shall be parked to.

====UserDTMF(integer call, bool recv, string dtmf)====
Sends DTMF digits on behalf of the user. If '''recv''' is set to ''true'' the DTMF is sent to the local user.

====UserUUI(integer call, bool recv, string uui)====
Sends User-User_information on behalf of the user. If '''recv''' is set to ''true'' the uui is sent to the local user.

====UserInfo(integer call, bool recv, string cdpn, string key, string dsp)====
Sends INFO message on behalf of the user. If '''recv''' is set to ''true'' the INFO message is sent to the local user. This function can be used to send overlap dialing information.

====UserRc(integer call, integer rc)====
Sends remote control facility to an innovaphone IP phone. It will be ignored by 3rd-party endpoints.

A remote control facility can be sent to an innovaphone IP phone to activate additional call handling on the device.

The current set of remote control facility function codes actually depends on the firmware used on the telephone, not the WSDL version used for SOAP. The current set is documented in [[Reference:Remote Control Facility]].

This function can be used for example to establish a three-party conference on an innovaphone IP phone. For this use the function UserRc on an active call using the '''rc''' value 4, while a second call is on hold. See also the ''rc'' argument to [[#integer_UserCall.28integer_user.2C_string_cn.2C_string_e164.2C_string_h323.2C_int_reg.2C_InfoArray_info.2C_int_rc.2C_string_srce164.29|UserCall()]].

===Messaging===

====integer UserMessage(integer user, string e164, string h323, string msg, string src_e164, string src_h323 )====
Sends an message from the '''user''' (which is a handle obtained by a call to '''UserInitialize''') to the destination described by ''e164'' and ''h323''. The parameters ''src_e164'' and ''src_h323'' may be used to override the calling party's information, in order to present a different callback information to the recipient of the message. Returns a handle to the call (0 on failure), which can be used to track the delivery of the message. A event of type 'msg-sent' indicates the delivery of the message.

===Status Retrieval===

Instead of monitoring calls using the ''Poll'' mechanics, there are some functions to retrieve the current at a certain point in time.

====CallInfo[] Calls(integer session, string user)====
Returns an array of '''CallInfo''' records for the calls currently active at the registration defined by ''user''. Please note that this function may be called without having called '''UserInitialize ()''' before. Thus, the call handle information in the '''CallInfo''' records returned is meaningless.

====UserInfo[] FindUser(string v501, string v700, string v800, string vx1000, string cn, string h323, string e164, integer count, integer next, boolean nohide)====
Returns an array of at most ''count'' '''UserInfo''' records for the users matching ''cn'', ''h323'' or ''e164''. Only one of ''cn'', ''h323'' and ''e164'' may be specified, except that ''e164'' and ''cn'' may be specified. In this case the number in ''e164'' is interpreted in the Node of the user specified with ''cn''. The search string will be used as a starting point into the alphabetically sorted list of objects, that is, a search for “'''A'''” will yield entries starting with “'''A'''” but also – depending on ''count'' – the following entries. Neither search string may be empty. ''v501'', ''v700'', ''v800'' and ''vx1000'' must be set to a non-empty value. In case ''cn'' is set to the empty value, '''FindUser''' returns results starting from the first object in the PBX.

To call '''FindUser''', no session is required, however, you need a valid HTTP authentication.

Be aware that large values for ''count'' may fail and even crash the PBX. If you need to retrieve the whole user list, you should be using 20 as ''count'', provide the last ''cn'' retrieved as new start cn and loop until '''FindUser''' returns no more results, passing '''true''' as value for ''next'' for all but the first calls.

If the parameter ''nohide'' is true, all objects regardless if marked as ''Hide from LDAP'' or not are returned by the '''FindUser''' function.

====bool UserFindDestination(integer user, string e164, string h323, out UserInfo user)====
This function checks if a destination can be reached from a given user by either a given number or a given name. ''user'' is the user handle from which PBX user the searching is started through all PBX nodes up and down. ''e164'' is the number, ''h323'' is a name.

The function returns '''true''', if the number or name is incomplete, otherwise '''false'''. If a destination is found, a '''UserInfo''' ''user'' is delivered.

No session is required to call '''UserFindDestination''', however, you need a valid HTTP authentication.

====string License(integer session, string name)====
This function is for internal use only.

====string LocationUrl(string v501, string v700, string v800, string vx1000, string location, bool tls)====
Returns a string with the HTTP URL for the PBX named location to which a SOAP session can be created. Typically, ''location'' is retrieved from the ''vals'' element of an '''Info''' record with ''type'' '''loc''' in an '''UserInfo''' record.

''location'' needs to be specified as the '''h323''' attributes value of the PBX node '''UserInfo''' data you are interested in.

If ''tls'' is set to '''true''', a HTTPS URL is returned.

====string UserLocalNum(int user, string num)====
Converts a given number '''num''' into a number diallable from the location of a specific '''user'''. Useful in inter-node scenarios where a destination node number and -extension are known, but the required escape prefix digits are unknown.
;user:The id of the specified user
;num:The number to be localized into the spefified user's location
;result:The localized number, including escape prefixes

===Administration===
The SOAP interface can be used for administrational purposes also. This is done via the Admin call. All kinds of PBX objects can be created, read or modified.

====string Admin(string xml)====

Sends the administrational command ''xml'' to the PBX. The command is executed and any result is returned.

This command allows you to query and modify the PBX object configuration (e.g. to query and set a users call forwarding). The scope and format of the commands valid for ''xml'' is beyond the scope of this document, however, there is a [[Howto:Using the SOAP Admin Function | separate article on that ]].

To call '''Admin''', no session is required. However, you must be authenticated as an admin user on the underlying HTTP layer.

[[Howto:Using the SOAP Admin Function]]

==Typical design of a PBX SOAP Application==
Please refer to the [[Reference:SOAP_API_%28pbx501.wsdl%29#Typical_design_of_a_PBX_SOAP_Application|pbx501.wsdl]] article for a discussion of the typical design of a SOAP application.

==References==
* [http://www.innovaphone.com/wsdl/pbx10_00.wsdl Version10-wsdl].

Applications based on this wsdl will work with V10 PBX firmware (and up) only.

Applications written to the previous pbx501.wsdl, pbx700.wsdl and pbx900.wsdl will continue to work with V10 firmware.

For your reference the old version files are still available:
* [http://www.innovaphone.com/wsdl/pbx501.wsdl Version5-wsdl]
* [http://www.innovaphone.com/wsdl/pbx700.wsdl Version7-wsdl]
* [http://www.innovaphone.com/wsdl/pbx900.wsdl Version9-wsdl]

==Known Problems==
Please read [[Howto:Authentication in the SOAP interface]] in case you have problems to authenticate SOAP access.

==System Requirements==
The PBX SOAP API requires a working PBX.

To work with the PBX API in this version, you must run at least version 7.00 software on your PBX. Also, you must run at least version 5 software on the phones.

==Installation==
There is no specific installation required, as the PBX API is integral part of the PBX (although licenses are required to operate the PBX).

==Configuration==
To prepare an PBX for PBX API testing
*setup a separate PBX
*install current firmware (at least 8.00)
*configure the PBX as usually
*add an user object called '''API''' , define a ''password'' for this object
*create a new group (e.g. called '''all users'''), by adding a group tag to '''API''', make it ''active''
*add a similar group tag to all other test users
*call '''Initialize()''' and use '''API''' as user and '''API''' and its ''password'' as http credentials

==Known Issues==
We have reports that the PBX wsdl is incompatible to some of the contemporary SOAP platforms available in the market. Most notably, Silverlight and Java seem to be affected. These problems are fixed in the v11 implementation of the PBX SOAP interface ''pbx11_00.wsdl'' (available at [http://www.innovaphone.com/wsdl/pbx11_00.wsdl www.innovaphone.com/wsdl/pbx11_00.wsdl ]).

Note: This wdsl file is not available directly from the PBX (e.g. at <code>http://xx.xx.xx.xx/pbx11_00.wsdl</code>)

However, we have had indications that for Java, solutions are possible based on Apache Axis 1.4, Netbeans 6.8 or JAX-RPC.

The PBX does not expect the SOAP client to disconnect the session right after a UserCall. If this is the case (e.g. in a script which merely creates a call on behalf of a user and then terminates), it might happen that the outgoing call from the device will not be created correctly (a matter of timing). In this case, just wait for one second.

==Related Articles==
:[[Howto:Authentication in the SOAP interface]]
:[[Howto:Clear a call completely with SOAP using UserClear]]
:[[Howto:PBX SOAP Api C sample code]]
:[[Howto:SOAP Api VisualBasic.Net Sample Code]]
:[[Support:TAPI or other SOAP Application fails to function properly if PBX users have special characters in their long or short user name]]
:[[Howto:How to monitor configuration changes in the SOAP interface ]]
:[[Howto:SOAP with PHP5 ]]
:[[Howto:SOAP API Java Sample Code ]]
:[[Howto:Using the SOAP Admin Function]]

[http://wiki.innovaphone.com/index.php?search=soap Search for more articles about SOAP]

Reference10:Concept SOAP API

2024-10-04T11:06:07Z

Mpu: Mpu moved page Reference10:Concept SOAP API to Reference14r2:Concept SOAP API without leaving a redirect

Howto12r1:AlwinPro/Anna4 - Aurenz - 3rd Party Product

2024-09-25T12:04:50Z

Mpu: Mpu moved page Howto9:AlwinPro/Anna4 - Aurenz - 3rd Party Product to Howto12r1:AlwinPro/Anna4 - Aurenz - 3rd Party Product without leaving a redirect

[[Image:Logo_AlwinPro_UC-Edition_RGB-01.png‎ |200px|right]]
[[Image:UC-Analytics-logo-medium.png|200px|right]]

==Product Name==
=== AlwinPro UC-Edition - Call Accounting & Billing ===
All call data generated by the innovaphone is captured by AlwinPro UC-Edition. Additional to the costs for phone calls itself, costs for manpower, equipment (devices) and services can also be considered in the reports. AlwinPro UC-Edition is perfect for calculating internal costs or third-party billing. All data will be generated and processed with regard for data protection requirements. Use AlwinPro to identify saving potentials, or to turn your IT-department into a profit centre.

[https://www.aurenz.de/en/products/alwinpro-uc-edition.html/ Read more about AlwinPro UC-Edition]

=== UC-Analytics by aurenz - Call Analytics ===
Based on the call data generated in the innovaphone, UC-Analytics by aurenz offers a wide range of reporting options. User-friendly and easy to understand dashboards provide a deep insight into your corporate communications. Use the web frontend to display your personal dashboards with your favourite charts of corporate communication. Ensure your service quality and use the reports and analyses to optimize your processes. Peak time reports are excellent for planning resources. The UC-Analytics includes the Accounting Module AlwinPro UC-Edition.

[https://www.aurenz.de/en/products/uc-analytics.html Read more about UC-Analytics]

[[Image:WidgetVorlage_EN.jpg|600px]]

=== AlwinPro Hotel - Middleware Software for Front Office Systems ===
Connect your hotel front office system to the innovaphone and enable check-in, check-out through the front office system.

[http://wiki.innovaphone.com/index.php?title=Howto:AlwinPro_Hotel_-_Aurenz_-_3rd_Party_Product For more details see here:]

=== AlwinPro Care - Billing Solution for Hospitals ===
AlwinPro Care is the reliable and cost-saving option for today's requirements when it comes to billing of entertainment services in hospitals.

=== DynamicTeams - Monitoring and Self-Management of Call Queues and Hunt Groups ===
Agents of hunt groups or call queues can log themselves into and out of individual groups. the agents can see the presence status of the all the members of the group and can thus decide for themselves whether it is the right time to leave the group, for example. DynamicTeams also provides a list of lost calls to the agents and the possibility to track the call back actions.
In addition to the functional enhancements of hunt groups and waiting queues, DynamicTeams provides detailed monitoring. With meaningful dashboards, supervisors can keep an eye on reachability, group utilization, and call volume. It is also possible for supervisors to maintain the grops (adding/removing users as agents).
DynamicTeams can be loaded as MyApp-App and runs within the MyApp.

==Certification Status==






{{Template:Compat_Status_"referral_prod."|certificate=AlwinPro_Anna4_-_Aurenz_-_3rd_Party_Product_-_Desc-AlwinPro_Anna4-cert.pdf}}

Testing of this product has been finalized May , 2013.

Testing was done using the product versions mentioned below. Feature descriptions above may be part of later product versions.

==Category==
{{Category:3rdParty Billing}}
[[Category:3rdParty Billing|{{PAGENAME}}]]
[[Category:Referral Product|{{PAGENAME}}]]

==Functions==
* Call Analytics
* Call Billing
* Call Management
* PIN code solution for private calls
* PIN code solution for project calls

==Version==

* innovaphone PBX v9 HF 23:
AlwinPro/Anna4 Release 8.1 or later
* innovaphone PBX v11:
AlwinPro/Anna4 Release 8.4.01 Hf4 or later
* innovaphone PBX v12:
AlwinPro/Anna4 Release 9.3.06 or later

==Vendor==

[[Image:aurenzlogo.png]]

[http://www.aurenz.de/en/ Aurenz software & consulting]

==Description==

=== AlwinPro UC-Edition - Billing & Accounting ===
*Collection of data from the telephone systems
*Import function for digital invoices (mobile communication and landlines)
*All ICT costs taken into account (write-offs,fixed costs, maintenance costs etc.)
*Source-based allocation of ICT costs (e.g. LDAP connection, XIE connection)
*Allocation of various cost types: business, private, project, mobile phone costs
*Freely configurable reports
*Pin code solution for private calls
*Individual report display via:
**Email
**WebServer
**Printer
**Export possibilities (e.g. SAP, Navision)
**Various export formats (e.g. CSV, SEPA etc.)
*Relieve the IT department's workload through automatization
**Scheduling series
**Creation and sending of reports
**Data backup and deletion

=== UC-Analytics by aurenz - Call Analytics ===
*Collection of data from the telephone systems
*Analysis of telephone performance
*Lost/Busy calls
*Duration until call is answered
*Customer contact analysis
*Call statistics
*Trunk line utilization
*Analysis of internal calls
*Calls to an hunt groups/waiting queues
*Cost statistics
*Comparison of network carriers
*Reporting via Web
*Data export

=== AlwinPro Hotel ===
*Interface to most of the hotel management systems. AlwinPro Hotel is acting as middleware, controlling the TC system, TV and Internet guest access.

=== AlwinPro Care ===
*Integrated patient management
*Billing of patient entertainment such as TV, Internet and telephone (basic charges and consumption)
*HIS integration

=== DynamicTeams ===
*Add/Remove agents to/from a hunt group or call queue by the supervisor
*Agents can login/logout to/from a particular group
*Agents can see the presence status of the members of the group
*Call list and call back tracking
*MyApp integrated
*Dashboards for monitoring group status and call traffic

==Competitive Analysis==


=== AlwinPro UC-Edition===
AlwinPro collects all ICT costs and accurately assigns them to employees, departments and locations. Fixed costs, amortization costs and even work time costs can be collected, if desired. Additionally, business calls can be separated from private calls, whereby data privacy regulations are complied with, without infringing on anyone's privacy. With the AlwinPro module "XML Services" it is possible to initiate private calls by using PINs.

=== UC-Analytics by aurenz ===
The UC-Analytics shows you what time usually your customers calls, how often it rings without anyone answering and how often your team’s line is busy. This way you can plan customer satisfaction before the first ring of the phone.

==Summary==

This solution has been tested by the vendor.

[https://www.aurenz.de/en/products/uc-analytics.html UC-Analytics by aurenz on aurenz.de]

[https://www.aurenz.de/en/products/alwinpro-uc-edition.html AlwinPro UC-Edition on aurenz.de]

[https://aurenz.atlassian.net/wiki/spaces/WIKI/pages/885035/Innovaphone Link to innovaphone relevant documentation in aurenz Wiki]

==Pricing==


The license price depends on the amount of extensions that are involved.
Please contact [mailto:info@aurenz.de aurenz] for a specific price offer.

==Contact==


{|
| colspan=99 |
|-
| colspan=99 | aurenz GmbH
|-
| colspan=99 | Hans-Boeckler-Str. 29
|-
| colspan=99 | 73230, Kirchheim unter Teck
|-
| Tel: || +49 7021 73888 0
|-
| Fax: || +49 7021 73888 30
|-
| Mail: || [mailto:info@aurenz.de info@aurenz.de]
|}

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

Howto12r1:AlwinPro Care - Aurenz - 3rd Party Product

2024-09-25T12:04:19Z

Mpu: Mpu moved page Howto9:AlwinPro Care - Aurenz - 3rd Party Product to Howto12r1:AlwinPro Care - Aurenz - 3rd Party Product without leaving a redirect

[[Image:AlwinPro_Care_-_Aurenz_-_3rd_Party_Product_1.png|200px|right]]

==Product name==
=== AlwinPro Care - Billing Entertainment Services in Health Care Sector ===
AlwinPro Care is the flexible and economical solution for billing the patients‘ entertainment in hospitals and healthcare establishments. With a simple, intuitive interface entering the patient into AlwinPro Care becomes a minor matter. Whether directly connected with the hospital information system (HIS) or controlled with the chip card: Mistakes are avoided and precious work time is conserved when using AlwinPro Care. AlwinPro Care is using the innovaphone SOAP Interface to enable Check-In/Check-Out:
* changing class of Services
* Name Resolution
* virtual extensions (call routing).

[http://www.aurenz.de/en/software/alwinpro-care/for-management/ Read more about AlwinPro Care]

==Certification Status==






{{Template:Compat_Status_"referral_prod."|certificate=AlwinPro_Care_-_Aurenz_-_3rd_Party_Product_-_Desc-AlwinPro_Care-cert.pdf}}

Testing of this product has been finalized September, 2015.

Testing was done using the product versions mentioned below. Feature descriptions above may be part of later product versions.

==Category==
{{Category:3rdParty Billing}}
[[Category:3rdParty Billing|{{PAGENAME}}]]

[[Category:Referral Product|{{PAGENAME}}]]

{{Category:3rdParty Healthcare}}
[[Category:3rdParty Healthcare|{{PAGENAME}}]]

==Functions==
* Call Billing
* Call Management
* PIN code solution for private calls
* Call Analytics
* PBX Middleware
* FIAS Interface
* Check-In, Check-Out
* Wake-Up Calls
* Room Status Codes

==Version==

* innovaphone PBX v9 HF 23:
AlwinPro Care Release 8.1 or later
* innovaphone PBX v11:
AlwinPro Care Release 8.4.01 Hf4 or later
* innovaphone PBX v12:
AlwinPro Care Release 9.3.06 or later

==Vendor==

[[Image:aurenzlogo.png]]

[http://www.aurenz.de/en/ Aurenz software & consulting]

==Description==

=== AlwinPro Care - Billing Entertainment Services in Health Care Sector ===
AlwinPro Care is the reasonably priced solution for invoicing telephone, Internet and TV in the health care sector:

* Collection of data from the telephone systems
* Check-In/Check-Out (innovaphone SOAP Interface)
* Changing the Class of Services (innovaphone SOAP Interface)
* Patient Name Resolution (innovaphone SOAP Interface)
* Virtual Extensions, Call Routing (innovaphone SOAP Interface)
* Billing phone calls,
* Charging daily costs for phones, Internet Access and TV Services
* Enabling Internet guest accounts (Radius)
* Invoicing
* Pre-Paid or Post-Paid invoicing
* Automatic import of patient data from the hospital information system (HIS)
* or directly via the patient's insurance Card (chipcard reader)
* Customer-specific encrypted database
* Accounting journal/Cash report
* Compliance with the legal data privacy protection specifications, especially for data storage section 113a paragraph 2 of the German Telecommunications Act (§ 113a Abs. 2 TKG)
* Relieve IT department and administration
* Identification of patiants via the chip card or bar code
* Intuitive menu navigation
* Account balance announcement
* Telephone number transfer done by patient
* Pay machine support
* Complete scope of benefits of AlwinPro, the Controlling Software

==Competitive Analysis==


=== Alwin Pro Care ===
AlwinPro Care is the reasonably priced solution for invoicing telephone, Internet and TV in the health care and hotel sector.

'''Simplify Processes'''

Patient data is automatically imported via AlwinPro Care using the hospital information system (HIS) or the insurance card. The identification via bar code or chip card saves time and helps to avoid mistakes. If the patient is moved, AlwinPro Care locks the extension automatically and this also unburdens the IT department.

'''Independent Invoicing'''

"Check out" works just as easily. With a click the Patient receives a complete invoice. The invoice is settled either at the end of the stay or via the prepaid function. With this option a prepaid credit is used up over time. For tracking purposes, all receipts and invoices are archived in the system. It is also possible to export the invoices back to the HIS or the PMS.

'''Adapting instead of Limiting'''

AlwinPro Care can be smoothly integrated into your ICT environment and is individually configurable. Internal rates can be saved as well as instruction manuals. All forms and receipts are freely configurable and can be adapted to include your design.

==Summary==

This solution has been tested by the vendor.

[http://www.aurenz.de/fileadmin/user_upload/Downloads/Support/130527_Anschlussbeschreibung_Innovaphone_PBX_v9hf22_final.pdf Configuration description DE]

[http://www.aurenz.de/fileadmin/user_upload/Downloads/Support/130527_Anschlussbeschreibung_Innovaphone_PBX_v9hf22_final_EN.pdf Configuration description EN]

==Pricing==


The license price depends on the amount of extensions that are involved and the product configuration.
Please contact [mailto:info@aurenz.de aurenz] for a specific price offer.

==Contact==


{|
| colspan=99 |
|-
| colspan=99 | aurenz GmbH
|-
| colspan=99 | Hans-Boeckler-Str. 29
|-
| colspan=99 | 73230, Kirchheim unter Teck
|-
| Tel: || +49 7021 73888 0
|-
| Fax: || +49 7021 73888 30
|-
| Mail: || [mailto:info@aurenz.de info@aurenz.de]
|}

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

Howto12r1:AlwinPro Hotel - Aurenz - 3rd Party Product

2024-09-25T12:03:06Z

Mpu: Mpu moved page Howto:AlwinPro Hotel - Aurenz - 3rd Party Product to Howto12r1:AlwinPro Hotel - Aurenz - 3rd Party Product without leaving a redirect

[[Image:AlwinPro_Hotel_-_Aurenz_-_3rd_Party_Product_1.png|200px|right]]

==Product name==
=== AlwinPro Hotel - Billing Telephone Services in Hotel Sector ===
AlwinPro Hotels can be used as the Middleware in between the Hotel Management System and the innovaphone PBX. AlwinPro Hotel implements the Check-In/Check-Out procedure for the innovaphone PBX:
* changing class of Services
* Name Resolution
* Virtual Extensions (call routing).
* Room Status
* Wakup Calls
* FIAS Interface for PMS connectivity (e.g. Fidelio, Opera, Protel)

==Certification Status==






{{Template:Compat_Status_"referral_prod."|certificate=AlwinPro_Hotel_-_Aurenz_-_3rd_Party_Product_-_Desc-AlwinPro_Hotel-cert.pdf}}

Testing of this product has been finalized September, 2015.

Testing was done using the product versions mentioned below. Feature descriptions above may be part of later product versions.

==Category==
{{Category:3rdParty Billing}}
[[Category:3rdParty Billing|{{PAGENAME}}]]

[[Category:Referral Product|{{PAGENAME}}]]

{{Category:3rdParty Hotel}}
[[Category:3rdParty Hotel|{{PAGENAME}}]]

==Functions==
* Call Billing
* Call Management
* PIN code solution for private calls
* Call Analytics
* PBX Middleware
* FIAS Interface
* Check-In, Check-Out
* Wake-Up Calls
* Room Status Codes

==Version==

* innovaphone PBX v9 HF 23:
AlwinPro Hotel Release 8.1 or later
* innovaphone PBX v11:
AlwinPro Hotel Release 8.4.01 Hf4 or later
* innovaphone PBX v12:
AlwinPro Hotel Release 9.3.06 or later

==Vendor==

[[Image:aurenzlogo.png]]

[http://www.aurenz.de/en/ Aurenz software & consulting]

==Description==


=== AlwinPro Hotel - Billing Telephone Services in Hotel Sector ===
* changing class of Services
* Name Resolution
* Virtual Extensions (call routing).
* Room Status
* Wakup Calls
* FIAS Interface for PMS connectivity (e.g. Fidelio, Opera, Protel)

==Competitive Analysis==


=== AlwinPro Hotel ===
AlwinPro Hotel is the reasonably priced solution for invoicing telephone, Internet and TV in the hotel sector.

'''Simplify Processes'''

Patient data is automatically imported via AlwinPro Care using the hospital information system (HIS) or the insurance card. The identification via bar code or chip card saves time and helps to avoid mistakes. If the patient is moved, AlwinPro Care locks the extension automatically and this also unburdens the IT department.
AlwinPro Hotel gets the guest data direct from the Hotel Management Systems via the FIAS Interface.

'''Independent Invoicing'''

"Check out" works just as easily. With a click the guest receives a complete invoice. The invoice is settled either at the end of the stay or via the prepaid function. With this option a prepaid credit is used up over time. For tracking purposes, all receipts and invoices are archived in the system. It is also possible to export the invoices back to the HIS or the PMS.

'''Adapting instead of Limiting'''

AlwinPro Hotel can be smoothly integrated into your ICT environment and is individually configurable. Internal rates can be saved as well as instruction manuals. All forms and receipts are freely configurable and can be adapted to include your design.

==Summary==

This solution has been tested by the vendor.

[http://www.aurenz.de/fileadmin/user_upload/Downloads/Support/130527_Anschlussbeschreibung_Innovaphone_PBX_v9hf22_final.pdf Configuration description DE]

[http://www.aurenz.de/fileadmin/user_upload/Downloads/Support/130527_Anschlussbeschreibung_Innovaphone_PBX_v9hf22_final_EN.pdf Configuration description EN]

==Pricing==


The license price depends on the amount of extensions that are involved and the product configuration.
Please contact [mailto:info@aurenz.de aurenz] for a specific price offer.

==Contact==


{|
| colspan=99 |
|-
| colspan=99 | aurenz GmbH
|-
| colspan=99 | Hans-Boeckler-Str. 29
|-
| colspan=99 | 73230, Kirchheim unter Teck
|-
| Tel: || +49 7021 73888 0
|-
| Fax: || +49 7021 73888 30
|-
| Mail: || [mailto:info@aurenz.de info@aurenz.de]
|}

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

Howto12r1:AlwinPro Care - Aurenz - 3rd Party Product

2024-09-25T12:02:10Z

Mpu: Mpu moved page Howto:AlwinPro Care - Aurenz - 3rd Party Product to Howto9:AlwinPro Care - Aurenz - 3rd Party Product without leaving a redirect

Howto12r1:AlwinPro/Anna4 - Aurenz - 3rd Party Product

2024-09-25T12:00:30Z

Mpu: Mpu moved page Howto:AlwinPro/Anna4 - Aurenz - 3rd Party Product to Howto9:AlwinPro/Anna4 - Aurenz - 3rd Party Product without leaving a redirect

Howto10:All 4 You - audiomarketeers - 3rd Party Product

2024-09-25T11:58:35Z

Mpu: Mpu moved page Howto:All 4 You - audiomarketeers - 3rd Party Product to Howto10:All 4 You - audiomarketeers - 3rd Party Product without leaving a redirect

[[Image:Audiomarketeers Logo.png|right]]
==Product name==
audiomarketeers All 4 You
==Certification Status==
{{Template:Compat_Status_referral_product_new}}
==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Music_on_Hold}}
[[Category:3rdParty_Music_on_Hold|{{PAGENAME}}]]
==Applies To==
Die Implementierbarkeit von Telefonansagen ist ab Juni 2014 mit den nachfolgenden Innovaphone Versionen (Firmware) gegeben:
* V10sr10 und höher
* V11r2sr20 und höher
* V12r1sr1 und höher
* V12r2Beta5 und höher

==More Information==
===Definition===
Der Begriff Audio Marketing (Audio: lateinisch audire = hören, Marketing: lateinisch mercatus, Markt) beschreibt die Arbeit an dem akustischen Aspekt des Corporate Designs eines Unternehmens / einer Marke. Auch heutzutage wird dieser Bereich der Corporate Identity eines Unternehmens oftmals stiefmütterlich behandelt.
===Fakten/Statistik===
Zahlen belegen:
* 70% aller Anrufer die in einer Warteschleife ohne Musik sind beenden innerhalb von 60 Sek. den Anruf, wiederum 35 % davon rufen nicht erneut an.
* Werden Informationen in einer Warteschleife präsentiert bleiben Anrufer, im Schnitt bis, zu 3 Minuten länger in der Leitung.
* Stille in der Warteschleife führt zu Frustration und schnelle Beendigung des Telefonats.

Quelle: Anna Assad. [http://work.chron.com/importance-onhold-messages-4665.html "The Importance of On-Hold Messages"]. Houston Chronicle. Retrieved 14 February 2013.

===Anwendungsbereiche===
Zu den Anwendungsbereichen gehören: Telefon- und Handymailboxansagen. Radiospot Produktionen, Homepage- und Videovertonungen sowie individuelle Kompositionen wie: Soundlogos, Werbe Jingles und Corporate Songs.
===Einspielformate===
alle Einspielformate durch die audiomarketeers möglich, dazu gehören u.a.:
* .wav
* .alaw
* .mp3
* .ulaw
==Contact Details==
audiomarketeers GmbH 
Königsbrügge 8 
33604 Bielefeld 

Christoph Winter 
Telefon: +49 521 - 968778-14 
Mobil: +49 175 - 7312098 
E-Mail: mailto:cwinter@audiomarketeers.com 
Website: http://www.audiomarketeers.com

Howto13r2:Alarm365 - ATT AG - 3rd Party Product

2024-09-25T11:57:47Z

Mpu: Mpu moved page Howto:Alarm365 - ATT AG - 3rd Party Product to Howto13r2:Alarm365 - ATT AG - 3rd Party Product without leaving a redirect

[[Image:Der Alarmserver.png|350px|right]]

==Product Name==
ATT AG - SWISS ALARM SOLUTIONS [https://www.attag.ch]
Alarmierung für Leben und Technik

==Certification Status==
{{Template:Compat_Status_"referral_prod."|certificate=nirvana.pdf}}

Testing of this product was updated July, 2022.

==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty Alarm Server}}
[[Category:3rdParty Alarm Server|{{PAGENAME}}]]

==Vendor==
[[Image:Der Alarmserver.png|350px]]

ATT-AudioText Telecom AG was founded in Switzerland in 1995 and since then has been developing customized solutions in the areas of:

Alarming (On premis - Cloud)
Self-reliant alarming
Crises- and emergency management
Lone worker
Nurse call system
Voice Mail
Computer Telephny Integration (CTI)
Interactive Voice Respone (IVR)
swiss made alarm server att ag
Strong technology partnerships enable ATT to offer unique support to partners and their end users, starting from consulting right up to support and maintenance of the delivered turnkey solutions.

The Alarm Management Server (AMX) centralizes the processing of all events seized by external sources (building/process control, fire alarm, network management, nurse call, etc.) and notifies the alarm organization based on the respective scenario through different communication media like SMS, telephone call (VOIP), email, SNMP traps, Paging or text messages on cordless handsets (DECT/WLAN) and smartphones by using data push notification services.

[https://www.attag.ch/ ATT AG]

==Description==
[[Image:AMX-ALARMSERVER-CLOUD.png|600px]]

Combine the benefits of the server and cloud-based solutions with AMX Hybrid. This version provides you the versatility and low-maintenance operation typical of AMX SaaS combined with the individual capabilities and interface connection of AMX On-premises. Using the local alarm media gateway (Alert Box), you can link not only standard but also manufacturer-specific interfaces and transmit all the notifications directly to your existing communication infrastructure.

'''Benefits at a glance:'''

* Independence from the infrastructure: web-based alert and crisis management platform
* Failover protection: geo-redundant cluster operation
* Ease of integration: alarm media gateway with redundant network connection (LTE backup)

==== Available Languages====
* German
* English
* French
* Italian

==Functions==

A lightning strike in the data centre, flooding in your region, an emergency case in the production line – whenever the worst case scenario occurs,
it is important to be prepared. According to a defined set of rules, AMX transmits alarms using all the available communication channels,
while informing users about certain events and which responses are expected from them. Through the confirmation function, AMX receives a qualified feedback on the availability and response times of your teams. All alerting operations are logged in detail and can be used for process improvement.

'''Key features from AMX - SWISS ALARM SOLUTIONS.:'''

* Display text on Deskphones, Dect-Phones, Wi-Fi, Mobile App, PC Display
* Confirmation via DTMF ( positive, negative)
* Textmessage via SOAP Interface
* Loudspeaker broadcast
* Control call forwarding
* Call intrusion
* Call recording
* LDAP Integration to import User
* Localisation

'''Offered Interfaces'''
* Digital contact inputs and outputs
* Serial connections via ESPA 4.4.4
* IP integration via ESPA-X, KNX, Modbus, BACnet
* Connection through OPC AE/DA/UA
* GETS Radio/GEC
* REST API Interface
* Email
* SMS
* Pager
* Mobile App
* PC Display (Popup)

==Use Cases==
'''Alerting'''
* [https://attag.ch/en/Branchen/ Silent alarm ]
* [https://attag.ch/en/Branchen/ Lone worker ]
* [https://attag.ch/en/Branchen/ Safety in schools ]
* [https://attag.ch/en/Branchen/ Fire alarm]
* [https://attag.ch/en/Branchen/ Standby service ]
* [https://attag.ch/en/Branchen/ Mobile App alarms]

'''Crisis management'''
* [https://attag.ch/en/Produkte/Krisenmanagement/ Crisis management and alarming ]

'''Technical Monitoring'''
* [https://attag.ch/en/Produkte/Produktmatrix/ Product matrix on site alarm server]
* [https://attag.ch/en/Produkte/ProduktmatrixCloud/ Product matrix cloud alarm server ]

==Version==
Product versions used for interop testing:
* AMX Version 19.0.11.0
* innovaphone V13 R2 SR13

==Configuration==

[[Image:amx-innovaphone-1.png]]

[[Image:amx-innovaphone-2.png]]

[[Image:amx-innovaphone-3.png]]

==Contact==
{|
| ATT AG - AudioText Telecom AG
|-
| Abdullah Toprak / CEO
|-
| Unterrietstrasse 2a
|-
| 8152 Glattbrugg
|-
| Tel: +41 44 908 60 07
|-
| Mobile: +41 79 751 28 43
|-
| Mail: [mailto:info@attag.ch www.attag.ch]
|-
| Formular: [https://attag.ch/Kontakt/Formular]
|}

Howto13r1:AgentOne® ContactCenter Suite - Sikom Software - 3rd Party Product

2024-09-25T11:56:25Z

Mpu: Mpu moved page Howto:AgentOne® ContactCenter Suite - Sikom Software - 3rd Party Product to Howto13r1:AgentOne® ContactCenter Suite - Sikom Software - 3rd Party Product without leaving a redirect

[[Image:Sikom_Logo_CMYK.png||200px|right]]
[[Image:AgentOne.png||200px|right]]

==Product Name==

[http://sikom.de/loesungen_agentone_01.php AgentOne® ContactCenter Suite]

==Certification Status==
{{Template:Compat_Status_referral_product_new}}

Vendor test report and configuration hints were received July, 2021.

==Category==
{{Category:3rdParty Contact Center Applications}}
[[Category:Referral Product|{{PAGENAME}}]]
[[Category:3rdParty Contact Center Applications|{{PAGENAME}}]]

==Vendor==


[[Image:Sikom_Logo_CMYK.png]]
{|
| colspan=99 |
|-
| colspan=99 | Sikom Software GmbH
|-
| colspan=99 | Tullastrasse 4
|-
| colspan=99 | 69126 Heidelberg
|-
| colspan=99 | Germany
|-
|}
[http://http://www.sikom.de/ueber_sikom-software_01.php www.sikom.de]

==Description==
Multimedia enablement prevents lost calls
AgentOne® ContactCenter intelligently links telephony- and Internet-based services. No matter if it is a call, an email, a fax message, chat communication or a document: All requests are treated with utmost attention. And if there is the need, you can even attach a document management system to feed incoming letters into the communication flow.

Flexible, sustainable and economical
Due to its robust flexibility AgentOne® Contact Center offers an unrivaled cost-benefit ratio and solid investment security. The scalable solution grows in line with your business.

High-end modules: Getting quickly to the right person
AgentOne® ContactCenter is based on a simple architecture concept: Sikom intelligent gateway, accepts the calls and provides a superb announcement management, including IVR features. As the universal routing instance, AgentOne® then assigns incoming requests to the most suitable employee. AgentOne® ContactCenter offers a multitude of routing options. It can even handle the extension of each employee like a separate service, thereby reproducing existing processes and structures in an optimal way. Based on this architecture, AgentOne® ContactCenter is the perfect tool not only for external communication but also for internal service centers and help desks.

Independent of the telephone system
No matter what kind of telephone system you employ, no matter if you use ISDN or Voice over IP, AgentOne® ContactCenter is fully compatible with all common telephone systems and can even set up hybrid networks.

==Competitive Analysis==
Sikom AgentOne® ContactCenter is based on a simple architecture concept: Sikom intelligent media gateway, accepts the calls and provides a superb announcement management. AgentOne®, a high-end automatic contact distribution (CC) system, routes incoming calls, chats, mails and other objects to the most suitable employees. AgentOne® ContactCenter offers comprehensive routing options and can even treat the extension of each employee like a separate service, thereby reproducing existing processes and structures in an optimal way. With this architecture, AgentOne® ContactCenter is the ideal tool not only for external communication but also for internal service and help desks.

==Functions==

Short summary of the most important features:
*Connection to all established business telephone systems via ISDN, S0/S2M, VoIP SIP
*Direct connection telephony local loop without business telephone systems via BlueFire® gateway
*Call routing engine and scheduler, ACD (Active Caller Distribution) call park function
*Integration of e-Mail, chat, social net, web callback, WebRTC, SMS, fax, voice-mail, document routing, smart queue into callflows
*Integration of DMS (Document Management Systems) and CRM (Customer Relationship Management)
*Multitenancy
*Real-time statistics
*Reporting
*Redundancy

==Version==




Product versions used for interop testing:

* AgentOne Release 6

* innovaphone V13r1

==Configuration==






The solution has been tested by the vendor.

 
Testumfang (Details siehe Testprotokoll)
 
http://docs.agentone.de/Sikom-Testprotokoll_Innovaphone_V3

 
Sikom certification
 
http://docs.agentone.de/Sikom-Zertifikat_Innovaphone_RZ.pdf
 

 
configuration for innovaphone
 
http://docs.agentone.de/Sikom-Configuration_innovaphone_IP_PBX_for_AgentOne_Contact_Center.pdf
 

 
AgentOne Rel 6.x include voicemediagateway
 
innovaphone IP811, Version 13r1
 
using MS TAPI – interface and SIP-Trunk - interface

==Pricing==
The software licenses are based on concurrent users, amount of channels and extra extensions / modules.

==Contact==


{|
|-
| colspan=99 | Sikom Software GmbH
|-
| colspan=99 | Tullastrasse 4
|-
| colspan=99 | 69126, Heidelberg
|-
| Tel: || +49 6221 13788 0
|-
| Fax: || +49 6221 13788 130
|-
| Mail: || [mailto:info@sikom.de info@sikom.de]
|}

Howto8:AgenTel - Voxtron - 3rd Party Product

2024-09-25T11:55:32Z

Mpu: Mpu moved page Howto:AgenTel - Voxtron - 3rd Party Product to Howto8:AgenTel - Voxtron - 3rd Party Product without leaving a redirect

==Product name==
[http://www.voxtron.com/products/agentel/ agenTel]

==Certification Status==


{{Template:Compat Status "customer-testimonial"|certificate=AgenTel - Voxtron - 3rd Party Product_-_Desc-agenTel-cert.pdf}}


Testing of this product has been finalized July 4th, 2011.

==Category==
{{Category:3rdParty Contact Center Applications}}
[[Category:Referral Product|{{PAGENAME}}]]
[[Category:3rdParty Contact Center Applications|{{PAGENAME}}]]

==Functions==
Call Center Solution incl. ACD- and IVR-System, Statistics, Wallboard, VoiceMail and SMS

==Version==
* innovaphone PBX v8 Hotfix16
* AgenTel 6.2
* [[Howto:XCAPI|XCAPI]] 3.3.205


==Vendor==
[http://www.voxtron.com/ Voxtron Europe N.V.]

==Description==
Call Center functionality within your reach - use efficient call center technology without investing into cost-intensive systems.

Route your incoming calls in an intelligent and efficient way, straight to the right person.

agenTel is a software-based inbound call center solution that offers you the opportunity to use call center technology in a cost-efficient way. No need to invest in expensive call center software, intended for very large groups of agents.

Voxtron's agenTel is a flexible and easy-to-use solution that fulfils the need of companies that want to route their incoming calls in an intelligent and efficient way, straight to the right person. agenTel is aimed at helping companies achieve a high degree of quality in customer interaction via telephone and develop and manage profitable customer relationships over time.

Before the call is connected to an agent, specific information about the caller such as calling number (CLIP), customer number, etc., is collected. In addition, the choices made by the caller in the predefined menu (e.g. language preference) are collected. All this data is used to decide how to route the call. When nobody is able to answer the call immediately, the caller can leave a voice-mail message. In this way, agenTel can answer your calls 24 hours a day, 7 days a week, without having to maintain staff around the clock. You can personalize the waiting time to a large extent, with music and messages chosen for that particular customer.

==Summary==

This solution proved to meet the expectations in the following customer projects:

* TUI
* [http://issuu.com/ecolife2/docs/cmm_01_2011_screen/48?zoomed=true&zoomPercent=96.30566835948582&zoomXPos=0.8012738853503185&zoomYPos=0.35405405405405405 case study Aduno]

'''Note:''' This is an end-of-life product. The replacing solution from Voxtron is [[Howto:Voxtron_-_Communication_Center_-_3rd_Party_Product|Voxtron Communication Center - 3rd Party Product]]

==Pricing==


==Contact==


{|
| colspan=99 | Voxtron GmbH
|-
| Tel: || +3237604040
|-
| Mail: || [mailto:info@voxtron.de info@voxtron.de]
|-
| Internet: || [http://www.voxtron.com/contact/contact-form/ Voxtron contact page]
|}

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

Howto9:Aficio™ MP 171 - RICOH - 3rd Party Product

2024-09-25T11:26:28Z

Mpu: Mpu moved page Howto:Aficio™ MP 171 - RICOH - 3rd Party Product to Howto9:Aficio™ MP 171 - RICOH - 3rd Party Product without leaving a redirect

Howto9:Acropolis Telecom CAP Trunk - SIP Provider Compatibility Test

2024-09-25T11:21:51Z

Mpu: Mpu moved page Howto:Acropolis Telecom CAP Trunk - SIP Provider Compatibility Test to Howto9:Acropolis Telecom CAP Trunk - SIP Provider Compatibility Test without leaving a redirect

'''Acropolis Telecom CAP Trunk innovaphone Compatibility Test Report'''
== Summary ==

'''SIP Provider: Acropolis Telecom'''

The provider supports all required innovaphone features and is therefore qualified as [[Howto:What_is_a_%22recommended_product%22%3F#SIP_Provider|recommended SIP Provider]].

That beeing said, the provider has achieved 89,2% of all possible test points (107 on total of 120 Points). For more information on the test rating, please refer to [[Howto:SIP_Interop_Test_Description#Summary|Test Description]]

* Features:
** Direct Dial In
** DTMF (RFC2833 and SIP INFO)
** NAT Detection
** Suppress CGPN Number (CLIP No Screaning works if the CGPN belongs to the costumer numbering range)

* Supported Codecs by the provider
** G711a
** G711u

* Notes:
** T.38 FAX It's not Supported.
** We can request G729 codec as Optional.
** SIP Provider have SIP Qualify of trunk on failover but was not tested.
** During the tests some call issues with loop in call scenarios (Call going out and in using the same SIP Trunk).

* Redundancy method used by the Provider:
**SIP Provider use SIP OPTIONS to check Gateway availability.
**always send to 1st IP Address (Master GW).
**if SIP OPTIONS does not answer, send to second IP Address (Standby GW).
**SIP Provider continues to send SIP OPTIONS to the first IP address (Master GW).
**if it answers again, send future call to the first IP address (Master GW).

==Certification Status==

{{Template:Compat Status "tested"}}





Testing of this product has been finalized in December of 2011.

== Testing Enviroment ==

=== Scenario NAT ===

[[Image:HFO_SIP_Compatibility_Test_5.PNG]]

This scenario describes a setup where the PBX and phones are in a private network. The IP800 should use a stun server, in order to send correct SIP - messages. The IP800 works as media relay, all RTP - streams go through the PBX.

== Test Results ==

For more information on the test procedure, please read the following wiki article: [[Howto:SIP_Interop_Test_Description|SIP Interop Test Description]]. Bold lines in the test results indicate a KO-criteria.

{| border="1"
!Tested feature
!Result
|----
|'''Call using g711a'''
|'''YES'''
|----
|'''Call using g711u'''
|'''YES'''
|----
|Call using g723
|NO
|----
|Call using g729
|NO*
|----
|Overlapped sending
|NO
|----
|'''Early media channel'''
|'''YES'''
|----
|Fax using T.38
|NO
|----
|CGPN can be suppressed
|YES
|----
|CLIP no screening
|NO*
|----
|Reverse Media Negotiation
|YES
|----
|'''Long time call possible'''
|'''YES'''
|----
|'''External Transfer'''
|'''YES'''
|----
|NAT Detection
|YES
|----
|Redudancy
|NO*
|----
|'''Voice Quality OK?'''
|'''YES'''
|}

* Notes in the Summary.

=== Direct Dial In ===

{| border="1"
!Tested feature
!Result
|----
|'''Inbound(Provider -> Innovaphone)'''
|'''YES'''
|----
|'''Outbound(Innovaphone -> Provider)'''
|'''YES'''
|}

=== DTMF ===

{| border="1"
!Tested feature
!Result
|----
|'''DTMF tones sent correctly'''
|'''YES'''
|----
|DTMF tones sent correctly via SIP-Info'''
|YES
|----
|'''DTMF tones received correctly'''
|'''YES'''
|}

=== Hold/Retrieve ===

{| border="1"
!Tested feature
!Result
|----
|'''Call can be put on hold'''
|'''YES'''
|----
|Held end hears music on hold / announcement from PBX
|YES
|}

=== Transfer with consultation ===

{| border="1"
!Tested feature
!Result
|----
|'''Call can be transferred'''
|'''YES'''
|----
|Held end hears music on hold
|YES

|}

=== Transfer with consultation (alerting only) ===

{| border="1"
!Tested feature
!Result
|----
|'''Call can be transferred'''
|'''YES'''
|----
|Held end hears music on hold or dialling tone
|YES
|----
|'''Call returns to transferring device if the third Endpoint is not available'''
|'''YES'''
|}

=== Blind Transfer ===

{| border="1"
!Tested feature
!Result
|----
|Call can be transferred
|YES
|----
|Held end hears dialling tone
|YES
|}

=== Broadcast Group & Waiting Queue ===

{| border="1"
!Tested feature
!Result
|----
|'''Caller can make a call to a Broadcast Group'''
|'''YES'''
|----
|'''Caller can make a call to a Waiting Queue'''
|'''YES'''
|----
|'''Announcement if nobody picks up the call'''
|'''YES'''
|}

== Configuration ==

===Firmware version===

All innovaphone devices use V9hf5 as firmware.

=== SIP - Trunk ===

*Trunk to Provider
[[Image:Acropolis_Telecom_CAP_Trunk_-_SIP_Compatibility_Test_1.jpg]]

*Trunk to PBX
[[Image:Acropolis_Telecom_CAP_Trunk_-_SIP_Compatibility_Test_2.jpg]]

=== Number Mapping ===

* In this example we have the trunk number 97517390 and the subscribers numbers will be 97517390X.

[[Image:Acropolis_Telecom_CAP_Trunk_-_SIP_Compatibility_Test_3.jpg]]

=== Route Settings ===

* Since the Provider doesn't support Overlap sending we need to use "force enblock" option in the routes. We recommend the use of "Interworking QSIG/SIP" option in the routes.

[[Image:Acropolis_Telecom_CAP_Trunk_-_SIP_Compatibility_Test_4.jpg]]

== Related Articles ==

[[Howto:France_-_Acropolis_Telecom_-_Cap_Trunk_-_SIP_Provider|France - Acropolis Telecom - SIP Provider]]

Howto9:A Fallback Scenario

2024-09-24T13:06:17Z

Mpu: Mpu moved page Howto:A Fallback Scenario to Howto9:A Fallback Scenario without leaving a redirect

==Applies To==

This information applies to

*All Innovaphone devices with PBX functionality
*V9 HF12 and up



==Example==
This is an example for a fallback scenario with an ACD Server, which is registered at a Gateway with the extension 9. Normally you call the 9222 to reach someone in the sales department. The ACD Server usually alarms the appropriate sales person. In case the connection to the ACD Server is lost the CFNR takes effect and routes the call to a waiting queue. To intelligently forward the call, the PBX uses the extension 222 and the PBX appends this extension to the CFNR Number. In this case the CFNR number is 8 and the call is transferred to the sales waiting queue (8222).

[[Image:A_fallback_scenario_01.png]]

==Configuration==
The configuration is simple. You just have to create a CFNR at the object that might fail and a matching extension that receives the call in a fallback case.

The appending of a number works with a Trunk Line, User object or Call Broadcast object as well.



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

Howto13r3:AT - tele tec - SIP Trunk SIP-Provider (2021)

2024-09-24T13:04:42Z

Mpu: Mpu moved page Howto:AT - tele tec - SIP Trunk SIP-Provider (2021) to Howto13r3:AT - tele tec - SIP Trunk SIP-Provider (2021) without leaving a redirect

== Summary ==
{{Template:SIP_TEST_STATUS_complete|update=March 30th, 2021|url=http://www.tele-tec.at/|productname=SIP Trunk|providername=Tele Tec}}
=== Remarks ===
T.38 can be ordered / enabled optionally by the provider.

{{ Template:SIP_TEST_NO_NIGHTLY_TESTS | fw-version = 13r1 Service Release 25 (107585)}}

=== {{SIP_TEST_ISSUES_MR_TITLE}} ===
{{SIP_TEST_ISSUES_MR_INTRO}}
; 180 RINGING : {{SIP_TEST_FACT_180 RINGING}}
; FAX T38 : {{SIP_TEST_FACT_FAX T38}}
; FAX T38ANDAUDIO : {{SIP_TEST_FACT_FAX T38ANDAUDIO}}
; REDIR 302 : {{SIP_TEST_FACT_REDIR 302}}
; SIP INFO : {{SIP_TEST_FACT_SIP INFO}}

{{SIP_TEST_FACTS_LIST}} [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_180_RINGING_FAILS|180_RINGING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_BASIC_CALL_FAILS|BASIC_CALL]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CLIR_FAILS|CLIR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CLNS_ONNET_FAILS|CLNS_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CLNS_FAILS|CLNS]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CONN_NR_DIFF_FAILS|CONN_NR_DIFF]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CONN_NR_INCOMING_FAILS|CONN_NR_INCOMING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_CONN_NR_FAILS|CONN_NR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_DTMF_FAILS|DTMF]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_EARLY_MEDIA_INBOUND_FAILS|EARLY_MEDIA_INBOUND]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_AUDIO_FAILS|FAX_AUDIO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_T38_ONNET_FAILS|FAX_T38_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_T38_FAILS|FAX_T38]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_FAX_T38ANDAUDIO_FAILS|FAX_T38ANDAUDIO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711A_ONNET_FAILS|G711A_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711A_FAILS|G711A]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711U_ONNET_FAILS|G711U_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G711U_FAILS|G711U]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G722_ONNET_FAILS|G722_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G722_FAILS|G722]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G729_ONNET_FAILS|G729_ONNET]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_G729_FAILS|G729]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_HOLD_RETRIEVE_FAILS|HOLD_RETRIEVE]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_IP_FRAGMENTATION_FAILS|IP_FRAGMENTATION]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_LARGE_SIP_MESSAGES_FAILS|LARGE_SIP_MESSAGES]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_MOBILITY_FAILS|MOBILITY]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_OPUS_NB_FAILS|OPUS_NB]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_OPUS_WB_FAILS|OPUS_WB]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_RALERT_DISC_FAILS|RALERT_DISC]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REDIR_302_FAILS|REDIR_302]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REDIR_DIVHDR_FAILS|REDIR_DIVHDR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REDIR_HISTHDR_FAILS|REDIR_HISTHDR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_REVERSE_MEDIA_FAILS|REVERSE_MEDIA]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SDP_ICE_FAILS|SDP_ICE]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SDP_RTCP_MUX_FAILS|SDP_RTCP_MUX]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SDP_VIDEO_FAILS|SDP_VIDEO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SIP_INFO_FAILS|SIP_INFO]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SRTP_INCOMING_FAILS|SRTP_INCOMING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SRTP_INTERNAL_FAILS|SRTP_INTERNAL]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SRTP_OUTGOING_FAILS|SRTP_OUTGOING]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_SUBSCRIBER_NR_FAILS|SUBSCRIBER_NR]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_BLIND_FAILS|XFER_BLIND]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_CONS_ALERT_FAILS|XFER_CONS_ALERT]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_CONS_EXT_FAILS|XFER_CONS_EXT]], [[Template:SIP_TEST_FACT_DESCRIPTION_TEST_XFER_CONS_FAILS|XFER_CONS]]

== Test Results ==
{{SIP_TEST_TESTRESULT_ONLYMR_INTRO}}
=== {{SIP_TEST_RESULTS_MR_TITLE}} ===
; Session Timer : {{Template:SIP_Profile_Test_EXPIRES_yes}}

; Signalling protocol : {{Template:SIP_Profile_Test_Registration_UDP}}

; NAT Traversal : {{Template:SIP_Profile_Test_NAT_a_no_c}}

; DTMF (RFC2833) : {{Template:SIP_Profile_Test_DTMF_RFC2833_yes}}

; Redundancy : {{Template:SIP_Profile_Test_REDUNDANCY_NOREG}}

; Correct signalling of Ringing-state : {{Template:SIP_Profile_Test_RINGING_no}}

; CLIR : {{Template:SIP_Profile_Test_CLIR_yes}}

; Clip No Screening (CLNS) : {{Template:SIP_Profile_Test_CLNS_yes}}

; COLP : {{Template:SIP_Profile_Test_COLP_out_yes_in_yes}} {{Template:SIP_Profile_Test_COLP_diff_no}}

; Early-Media : {{Template:SIP_Profile_Test_EARLY_MEDIA_INBOUND_yes}}

; Fax : {{Template:SIP_Profile_Test_AUDIOFAX_PSTN_yes}}
: {{Template:SIP_Profile_Test_T38_PSTN_no_onnet_yes_fallback_no}}

; Codecs : supported to/from PSTN: G711A
: supported onnet (VoIP to VoIP): G711A

; IP-Fragmentation : {{Template:SIP_Profile_Test_FRAGMENTATION_yes}}

; Large SIP messages : {{Template:SIP_Profile_Test_LARGE_MESSAGES_yes}}

; Reverse Media Negotiation : {{Template:SIP_Profile_Test_REV_MEDIA_NEG_yes}}

; Mobility Calls : {{Template:SIP_Profile_Test_MobilityCall_no_with_MediaRelay}} {{Template:SIP_Profile_Test_MobilityCall_no_ringing}}

; SRTP : {{Template:SIP_Profile_Test_SRTP_no}}

; Dialing of Subscriber Numbers : {{Template:SIP_Profile_Test_SUBSCRIBER_NR_yes}}

; Call Transfer : {{Template:SIP_Profile_Test_CALL_TRANSFER_ok}}

==Configuration==
Use profile ''AT-Tele_Tec-SIP_Trunk'' in ''Gateway/Interfaces/SIP'' to configure this SIP provider.

Please note the following configuration hints:
* <nowiki>Alert not signalled, 'Carrier w/o Alerting' required in all PBX 'Mobility' objects</nowiki>
* <nowiki>This is a SIP account without registration. Depending on the provider a firewall rule is necessary.</nowiki>

: {{SIP_TEST_V13_HINT}}

== Disclaimer ==
{{SIP_TEST_PREFACE}}

[[Category:Compat|{{PAGENAME}}]]
[[Category:3rdParty SIP Provider|{{PAGENAME}}]]