innovaphone wiki - User contributions [en]

Reference13r2:Apps/PbxManager/Explorer

2025-11-17T16:16:41Z

Muschelpuster: /* after global config set give all Fax another config*/

The PBX Manager Explorer is a tool to search and modify the PBX objects configuration based on xpath expressions.

Care should be taken to apply any changes with the OK buttons. These changes come into effect immediately and cannot be reverted. It is good practise to save a backup of the configuration before applying any modification.

Clicking OK if there is no change is also not advised. It creates an unnecessary write operation.

== The search input ==

The search input is used for an xpath expression to filter the objects. Any object, for which an non-empty set is returned, is selected. If the search input is left empty, the expression "/user" is used, which selects all objects.

An example, which selects all objects with a long name starting With "A" would be

/user[starts-with(@cn, "A")]

== Add ==

To modify the data, an expression to add a tag or attribute can be added, by clicking on the plus icon. For example the expression

device/@hw = hw0

adds a "device" tag with the attribute "hw" set to hw0

== Del ==

By clicking on the minus icon an expression to remove a tag or attribut may be specified

== Display of current configuration ==

In the first window below the expressions, the current configuration for each selected object is displayed

== Preview of changed configuration ==

In the window below the configuration is display as if the changes where applied

== Operations ==

=== OK ===

applies the change to the current object

=== OK(all) ===

applies the change to all objects

=== Skip ===

skips the current object

=== Cancel ===

Cancels the operation. The changes already applied with OK are not reversed

== Examples ==
{{Template:3rd Party Input}}
==== Securing it with boolean object 'alwaystrue' ====
/user[not(pseudo) and starts-with(@cn, "T")] -> + cd/@type = cfnr 
/user[not(pseudo) and starts-with(@cn, "T")]/cd[not(ep)] -> + @bool = alwaystrue & + ep/@e164 = 88

=== Search all users with number ===
/user[not(pseudo)][@e164]

=== Search all user devices with Innovaphone MAC as hardware ID ===
/user/device[starts-with(@hw,"009033")]

=== Search all user with template "Config User" and remove password ===
/user[@config="Config User"] -> - @pwd - @pwdx

=== Give all phones without app the app phone ===
/user/device[starts-with(@hw,"009033")][not(@app)] -> + @app=phone

=== Give all user devices the flag 'Reverse Proxy' ===
/user[not(pseudo)][@e164]/device[not(@trusted)] -> + @trusted=true

=== Remove the Flag 'TLS only' from all user devices ===
/user[not(pseudo)][@e164]/device[@tls="true"] -> - @tls

=== Set a cfnr to 88 for all users with 'T' as first letter in name ===
/user[not(pseudo) and starts-with(@cn, "T")] -> + cd/@type = cfnr 
/user[not(pseudo) and starts-with(@cn, "T")]/cd[not(ep)] -> + ep/@e164 = 88

=== Setting an only int cfnr for all users ===

This is required, for example, for softphones that are not registered and internal callers should receive an announcement.

For this you have to enable the Call forward on myApps offline checkbox.

/user[not(pseudo)][@e164] -> + cd/@type = cfnr
Search for the empty cfnr and add the
/user[not(pseudo)][@e164]/cd[not(ep)] -> + ep/@e164 = 88 (or +ep/@h323 = Object-Name)
Add another + and add
+ src/@type = do

Finally, set the only int flag:

/user[not(pseudo)][@e164]/cd/src -> + ep/@ext = false

=== Disable all forkings with app rcc at node 'Testnode' ===
/user[not(pseudo)][@e164][@node="Testnode"]/fork[@app="rcc"][not(@off)] -> + @off = true

=== Give visibility-entries the flag 'visible' ===
This is a helpful job for migrations from V12 to set this in V13 new flag.

/user[not(pseudo)][@e164]/allow[not(@visible)] -> + @visible = true
or this example to remove the visibility flags for all users - new visibility flags can then be rolled out using a Config Template
/user[not(pseudo) and starts-with(@cn, *)] -> -allow

=== Replace all user passwords on users which already have set a password with '1234' ===
/user[not(pseudo)][@e164][@pwd] -> + @pwd = 1234

=== Move all members of Node 'node_old' to 'node_new' ===
/user[@node="_node_HQ"] -> + @node = node_new
Be careful by moving from node 'root', maybe you should use more filter options.

=== Remove Group Indications ===
/user[not(pseudo) ] [@gi] -> -@gi

=== Give all Users with a number and without a config template the template 'new_template' ===
/user[not(pseudo)][@e164][not(@config)] -> + @config = new_template

==== Give all users whose name starts with 'Fax' an having the config template 'New_template' the template 'new_template_fax' ====
/user[not(pseudo) and starts-with(@cn, "Fax") and @config= "_new_template_fax"] -> + @config = new_template

== Links ==
[https://www.w3schools.com/xml/xpath_intro.asp XPath Tutorial (w3schools.com)]

Reference13r2:Apps/PbxManager/Explorer

2025-11-17T15:14:05Z

Muschelpuster: /* reformating 'Remove Group Identication' and added 'template for users without an configured template*/

The PBX Manager Explorer is a tool to search and modify the PBX objects configuration based on xpath expressions.

Care should be taken to apply any changes with the OK buttons. These changes come into effect immediately and cannot be reverted. It is good practise to save a backup of the configuration before applying any modification.

Clicking OK if there is no change is also not advised. It creates an unnecessary write operation.

== The search input ==

The search input is used for an xpath expression to filter the objects. Any object, for which an non-empty set is returned, is selected. If the search input is left empty, the expression "/user" is used, which selects all objects.

An example, which selects all objects with a long name starting With "A" would be

/user[starts-with(@cn, "A")]

== Add ==

To modify the data, an expression to add a tag or attribute can be added, by clicking on the plus icon. For example the expression

device/@hw = hw0

adds a "device" tag with the attribute "hw" set to hw0

== Del ==

By clicking on the minus icon an expression to remove a tag or attribut may be specified

== Display of current configuration ==

In the first window below the expressions, the current configuration for each selected object is displayed

== Preview of changed configuration ==

In the window below the configuration is display as if the changes where applied

== Operations ==

=== OK ===

applies the change to the current object

=== OK(all) ===

applies the change to all objects

=== Skip ===

skips the current object

=== Cancel ===

Cancels the operation. The changes already applied with OK are not reversed

== Examples ==
{{Template:3rd Party Input}}
==== Securing it with boolean object 'alwaystrue' ====
/user[not(pseudo) and starts-with(@cn, "T")] -> + cd/@type = cfnr 
/user[not(pseudo) and starts-with(@cn, "T")]/cd[not(ep)] -> + @bool = alwaystrue & + ep/@e164 = 88

=== Search all users with number ===
/user[not(pseudo)][@e164]

=== Search all user devices with Innovaphone MAC as hardware ID ===
/user/device[starts-with(@hw,"009033")]

=== Search all user with template "Config User" and remove password ===
/user[@config="Config User"] -> - @pwd - @pwdx

=== Give all phones without app the app phone ===
/user/device[starts-with(@hw,"009033")][not(@app)] -> + @app=phone

=== Give all user devices the flag 'Reverse Proxy' ===
/user[not(pseudo)][@e164]/device[not(@trusted)] -> + @trusted=true

=== Remove the Flag 'TLS only' from all user devices ===
/user[not(pseudo)][@e164]/device[@tls="true"] -> - @tls

=== Set a cfnr to 88 for all users with 'T' as first letter in name ===
/user[not(pseudo) and starts-with(@cn, "T")] -> + cd/@type = cfnr 
/user[not(pseudo) and starts-with(@cn, "T")]/cd[not(ep)] -> + ep/@e164 = 88

=== Setting an only int cfnr for all users ===

This is required, for example, for softphones that are not registered and internal callers should receive an announcement.

For this you have to enable the Call forward on myApps offline checkbox.

/user[not(pseudo)][@e164] -> + cd/@type = cfnr
Search for the empty cfnr and add the
/user[not(pseudo)][@e164]/cd[not(ep)] -> + ep/@e164 = 88 (or +ep/@h323 = Object-Name)
Add another + and add
+ src/@type = do

Finally, set the only int flag:

/user[not(pseudo)][@e164]/cd/src -> + ep/@ext = false

=== Disable all forkings with app rcc at node 'Testnode' ===
/user[not(pseudo)][@e164][@node="Testnode"]/fork[@app="rcc"][not(@off)] -> + @off = true

=== Give visibility-entries the flag 'visible' ===
This is a helpful job for migrations from V12 to set this in V13 new flag.

/user[not(pseudo)][@e164]/allow[not(@visible)] -> + @visible = true
or this example to remove the visibility flags for all users - new visibility flags can then be rolled out using a Config Template
/user[not(pseudo) and starts-with(@cn, *)] -> -allow

=== Replace all user passwords on users which already have set a password with '1234' ===
/user[not(pseudo)][@e164][@pwd] -> + @pwd = 1234

=== Move all members of Node 'node_old' to 'node_new' ===
/user[@node="_node_HQ"] -> + @node = node_new
Be careful by moving from node 'root', maybe you should use more filter options.

=== Remove Group Indications ===
/user[not(pseudo) ] [@gi] -> -@gi

=== Give all Users with a number and without a config template the template 'new_template' ===
/user[not(pseudo)][@e164][not(@config)] -> + @config = new_template

== Links ==
[https://www.w3schools.com/xml/xpath_intro.asp XPath Tutorial (w3schools.com)]

Reference13r2:PBX/Objects/LDAP

2025-10-27T18:41:26Z

Muschelpuster: /* innovaphone PBX (searching for WQs) */ -> expanded with examles for call broadcast und WQ & CB together

__toc__

The LDAP object is an adapter between an LDAP directory and contact search inside myApps.

The search functionality is provided as a hidden app that has the same name as the LDAP object. The hidden app provides the client API "com.innovaphone.search" that can be used by other apps like the phone or softphone app to display contacts from the configured LDAP directory.

Note: To activate the LDAP search for users, you need to give them access to the hidden app at the user object or a suitable template.
 [[Image:EstosMetaV13-4.PNG|Sample]]]

Note: The LDAP object is only intended for third-party LDAP servers:
* The innovaphone PBX has its own search provider that comes with the Users App.
* innovaphone Contacts has its own search provider.

== General Configuration Options ==

; Long Name: must be unique in the PBX.
; Name: the ID of the app object.
; Password: choose any strong password. Both users and administrators don't need to know it, in order to use the LDAP search.

== Server ==
In this tab the LDAP server and the LDAP credentials are configured.

;Enable: This checkmark enables/disables the whole search functionality of the object.
;Host: DNS name or IP address of the LDAP server.
;Port: TCP port number of the LDAP server. Standard ports are 389 for LDAP and 636 for LDAPS (LDAP over TLS).
;TLS: Enables LDAPS (secure connection using TLS).
;User: Username for authenticating at the LDAP server.
;Password: Password for authenticating at the LDAP server.

== Search ==
In this tab the LDAP attributes are configured that shall be used for the LDAP search request.

;Search Base: The search base inside the directory. Leave empty to search in the root of the directory. The search base may contain a placeholder $s that is replaced by the SIP URI of the user. This can be used to search in private phone books in directories like C4B.
;Object Filter: An additional object filter that can be used to hide entries from the search results.
;Meta Name Attribute: If the directory supports full text search (like innovaphone Contacts or Estos Meta Directory) please configure the attribute for full text search here and leave the "Search Attribute" fields empty.
;Search Attribute: For directories that don't support full text search (like the innovaphone PBX) you can configure up to 4 attributes that shall be included in the search request.

== Attributes ==
In this tab the attributes from the LDAP search result are mapped to the attributes of the "com.innovaphone.search" API for displaying the result in other apps.
Please configure the name of the attribute in the directory for each given attribute. Leave empty if it doesn't exist in the directory.

For the following attributes, a comma-separated list with up to 4 items can be configured:
* telephonenumber
* mobile
* homephone
* facsimiletelephonenumber
* sip
* email

== Configuration examples ==
=== Estos MetaDirectory ===

'''Note:''' To enable full text search, MetaDirectory allows configuring a custom attribute to contain the full search string. This should be done whenever possible to get the best search quality and performance. If you configured an attribute, for example "custom0", configure it at the LDAP object as Meta Name Attribute.

==== Search ====
;Search Base:dc=meta
;Search Attribute:givenName
;Search Attribute:company
;Search Attribute:sn
;Search Attribute:telephoneNumber
;Search Attribute:displayName
You can chose 4 of this example search attributes, or you can search to each field defined in EMD/Search/Standardsearch. For this you enter only as fist Search Attribute: searchContact . If you don't use telephoneNumber the number dialing at the mobile client works a little bit smoother, but you have no name resolution at number dialing. But anyway this is only working, if you dial E.164 with a 'preceding'+. So, you have the choice.
;Meta Name Attribute:custom0 (example, custom0 is the name of a custom attribute for full text search configured in the MetaDirectory)

==== Attributes ====
;cn:displayName
;givenname:givenName
;sn:sn
;company:company
;street:streetAddress
;postalcode:postalCode
;city:l
;country:c
;telephonenumber:telephoneNumber
;mobile:mobile
;homephone:homePhone
;facsimiletelephonenumber:facsimileTelephoneNumber
;email:mail

=== innovaphone Contacts ===
'''Note: Don't use the LDAP object against innovaphone Contacts.''' The Contacts app alread offers a search provider for myApps out of the box that is much better suited. This is just a documentational example.

==== Server ====
;Host: The DNS name or IP address of the app platform hosting the Contacts instance.
;Port: The LDAPS post of the Contacts instance configured in the PBX Manager plugin "Contacts".
;TLS: on
;User: The LDAP user configured in the PBX Manager plugin "Contacts".
;Password: The LDAP password configured in the PBX Manager plugin "Contacts".

==== Search ====
;Search Base:"dc=entries"
;Meta Name Attribute:"metaSearchText"

==== Attributes ====
;cn:"cn"
;givenname:"givenname"
;sn:"sn"
;company:"company"
;postiion:"position"
;street:"street"
;postalcode:"postalcode"
;city:"city"
;country:"country"
;telephonenumber:"telephonenumber"
;mobile:"mobile"
;homephone:"homephone"
;sip:"sip"
;email:"email"
;url:"url"

=== innovaphone PBX (searching for WQs) ===
This example configures an LDAP object to search for all waiting queues.

==== Server ====
;Host: The DNS name or IP address of the PBX.
;Port: The LDAPS post of the PBX
;TLS: on
;User: The LDAP user of the PBX (e.g. "ldap-guest")
;Password: The LDAP password of the PBX.

==== Search ====
;Search Base:"cn=PBX0"
;Object Filter:"(pbx=<pseudo type="waiting"*)"
;Search Attribute:"cn"
;Search Attribute:"h323"
;Search Attribute:"e164"

==== Attributes ====
;cn:"cn"
;telephonenumber:"e164"
;sip:"h323"
;email:"email"

=== innovaphone PBX (searching for CBs) ===
This example configures an LDAP object to search for all call broadcast groups.

==== Server ====
;Host: The DNS name or IP address of the PBX.
;Port: The LDAPS post of the PBX
;TLS: on
;User: The LDAP user of the PBX (e.g. "ldap-guest")
;Password: The LDAP password of the PBX.

==== Search ====
;Search Base:"cn=PBX0"
;Object Filter:"(pbx=<pseudo type="broadcast"*)"
;Search Attribute:"cn"
;Search Attribute:"h323"
;Search Attribute:"e164"

==== Attributes ====
;cn:"cn"
;telephonenumber:"e164"
;sip:"h323"
;email:"email"

=== innovaphone PBX (searching for CBs and WQs) ===
This example configures an LDAP object to search for all call broadcast groups and waiting queues together.

==== Server ====
;Host: The DNS name or IP address of the PBX.
;Port: The LDAPS post of the PBX
;TLS: on
;User: The LDAP user of the PBX (e.g. "ldap-guest")
;Password: The LDAP password of the PBX.

==== Search ====
;Search Base:"cn=PBX0"
;Object Filter:"(|(pbx=<pseudo type="waiting"*)(pbx=<pseudo type="broadcast"*))"
;Search Attribute:"cn"
;Search Attribute:"h323"
;Search Attribute:"e164"

==== Attributes ====
;cn:"cn"
;telephonenumber:"e164"
;sip:"h323"
;email:"email"

=== innovaphone PBX (searching for users) ===
'''Note: Don't use the LDAP object against an innovaphone PBX to search for users.''' The Users App already offers a search provider for myApps out of the box that is much better suited. This is just a documentational example.

==== Server ====
;Host: The DNS name or IP address of the PBX.
;Port: The LDAPS port of the PBX
;TLS: on
;User: The LDAP user of the PBX (e.g. "ldap-guest")
;Password: The LDAP password of the PBX.

==== Search ====
;Search Base:"cn=PBX0"
;Search Attribute:"cn"
;Search Attribute:"h323"
;Search Attribute:"e164"

==== Attributes ====
;cn:"cn"
;telephonenumber:"e164"
;sip:"h323"
;email:"email"

== Reverse Lookup ==
For the Reverse Lookup, the [[{{NAMESPACE}}:PBX/Config/General | "Reverse Lookup URL"]] must be configured.

= Related Articles =
* [[Reference13r2:Concept_Number_Resolution_and_LDAP]]

Reference13r2:Apps/PbxManager/Explorer

2024-09-23T16:16:59Z

Muschelpuster: /* Move all members of Node 'node_old' to 'node_new' */

The PBX Manager Explorer is a tool to search and modify the PBX objects configuration based on xpath expressions.

Care should be taken to apply any changes with the OK buttons. These changes come into effect immediately and cannot be reverted. It is good practise to save a backup of the configuration before applying any modification.

Clicking OK if there is no change is also not advised. It creates an unnecessary write operation.

== The search input ==

The search input is used for an xpath expression to filter the objects. Any object, for which an non-empty set is returned, is selected. If the search input is left empty, the expression "/user" is used, which selects all objects.

An example, which selects all objects with a long name starting With "A" would be

/user[starts-with(@cn, "A")]

== Add ==

To modify the data, an expression to add a tag or attribute can be added, by clicking on the plus icon. For example the expression

device/@hw = hw0

adds a "device" tag with the attribute "hw" set to hw0

== Del ==

By clicking on the minus icon an expression to remove a tag or attribut may be specified

== Display of current configuration ==

In the first window below the expressions, the current configuration for each selected object is displayed

== Preview of changed configuration ==

In the window below the configuration is display as if the changes where applied

== Operations ==

=== OK ===

applies the change to the current object

=== OK(all) ===

applies the change to all objects

=== Skip ===

skips the current object

=== Cancel ===

Cancels the operation. The changes already applied with OK are not reversed

== Examples ==
{{Template:3rd Party Input}}
==== Securing it with boolean object 'alwaystrue' ====
/user[not(pseudo) and starts-with(@cn, "T")] -> + cd/@type = cfnr 
/user[not(pseudo) and starts-with(@cn, "T")]/cd[not(ep)] -> + @bool = alwaystrue & + ep/@e164 = 88

=== Search all users with number ===
/user[not(pseudo)][@e164]

=== Search all user devices with Innovaphone MAC as hardware ID ===
/user/device[starts-with(@hw,"009033")]

=== Search all user with template "Config User" and remove password ===
/user[@config="Config User"] -> - @pwd - @pwdx

=== Give all phones without app the app phone ===
/user/device[starts-with(@hw,"009033")][not(@app)] -> + @app=phone

=== Give all user devices the flag 'Reverse Proxy' ===
/user[not(pseudo)][@e164]/device[not(@trusted)] -> + @trusted=true

=== Remove the Flag 'TLS only' from all user devices ===
/user[not(pseudo)][@e164]/device[@tls="true"] -> - @tls

=== Set a cfnr to 88 for all users with 'T' as first letter in name ===
/user[not(pseudo) and starts-with(@cn, "T")] -> + cd/@type = cfnr 
/user[not(pseudo) and starts-with(@cn, "T")]/cd[not(ep)] -> + ep/@e164 = 88

=== Setting an only int cfnr for all users ===

This is required, for example, for softphones that are not registered and internal callers should receive an announcement.

For this you have to enable the Call forward on myApps offline checkbox.

/user[not(pseudo)][@e164] -> + cd/@type = cfnr
Search for the empty cfnr and add the
/user[not(pseudo)][@e164]/cd[not(ep)] -> + ep/@e164 = 88 (or +ep/@h323 = Object-Name)
Add another + and add
+ src/@type = do

Finally, set the only int flag:

/user[not(pseudo)][@e164]/cd/src -> + ep/@ext = false

=== Disable all forkings with app rcc at node 'Testnode' ===
/user[not(pseudo)][@e164][@node="Testnode"]/fork[@app="rcc"][not(@off)] -> + @off = true

=== Give visibility-entries the flag 'visible' ===
This is a helpful job for migrations from V12 to set this in V13 new flag.

/user[not(pseudo)][@e164]/allow[not(@visible)] -> + @visible = true
or this example to remove the visibility flags for all users - new visibility flags can then be rolled out using a Config Template
/user[not(pseudo) and starts-with(@cn, *)] -> -allow

=== Replace all user passwords on users which already have set a password with '1234' ===
/user[not(pseudo)][@e164][@pwd] -> + @pwd = 1234

=== Move all members of Node 'node_old' to 'node_new' ===
/user[@node="_node_HQ"] -> + @node = node_new
Be careful by moving from node 'root', maybe you should use more filter options.

== Links ==
[https://www.w3schools.com/xml/xpath_intro.asp XPath Tutorial (w3schools.com)]

Howto:ESENTA SIAS - ESENTA GmbH - 3rd Party Product

2024-06-10T16:35:06Z

Muschelpuster: /* Configure SIP credentials in ESENTA Sias */

[[Image:ESENTA logo.png||200px|right]]

==Product Name==


ESENTA [https://esenta.de/details/ Sias]

==Certification Status==

{{Template:Compat_Status_referral_terminals|manufacturername=Esenta GmbH|certificationdate=in November 2023}}

==Category==


[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:ESENTA logo.png|150px]]

ESENTA GmbH specializes in leading-edge building communication and automation solutions. Since our inception in Kappelrodeck in 2018, we have dedicated ourselves to crafting state-of-the-art smart home solutions and IP video door intercom systems. Our flagship product, the SIAS IP video door intercom, transcends the traditional doorbell, weaving security, convenience, and advanced technology into the fabric of daily living.

==Description==









[[File:Sias.png|150px|ESENTA SIAS]]

ESENTA SIAS is an advanced IP intercom system with a feature-rich touchscreen interface for residential and commercial buildings, offering direct calling to residents, video streaming, and two-way communication through an intuitive app. The system enhances property access with multifactor authentication including NFC and fingerprint verification, allows remote door operation, and is designed for integration into smart home ecosystems. It's crafted to streamline visitor management with customizable nameplates on its display, does not mandate cloud usage, supports flexible network connectivity and ensures a secure and seamless user experience.




''Benefits at a glance:''

* Direct Calling and Communication
* Multifactor Authentication
* Remote Door Operation
* Smart Home Integration
* Customizable Interface
* Global Access (Optional Cloud)
* Flexible Connectivity
* Enhanced Security
* User-Friendly Management

==Functions==





'''Connectivity and Communication:'''
* Real-Time Notifications: Sends alerts to smartphones or tablets when someone rings the bell or when motion is detected.
* Video Streaming: Offers a live video feed via a high-resolution wide-angle camera viewable on the ESENTA app.
* Two-Way Audio: Allows for communication with visitors through the app using the intercom's microphone and speaker.

'''Security and Access:'''
* Fingerprint Authentication: A capacitive fingerprint reader that can store up to 100 different fingerprints.
* Code Entry: Users can enter access codes directly on the touchscreen display.
* PIR/Radar Sensor: Detects people in proximity to the door.
* Sabotage Detection: Features an accelerometer to detect any tampering efforts.

'''Smart Home Compatibility:'''
* Integration: Easily integrates with existing smart home systems using open interfaces like MQTT and REST API.
* User Interface: Control the system through a web interface or smartphone app, customizing access and functions as needed.

'''Installation and Setup:'''
* Network Integration: Can be connected via standard networking cable or through a 2-Wire module using existing wires.
* Device Support: Compatible with a wide range of devices including Android/iOS smartphones, SIP phones, and tablets.
* Multiple SIP Server Support: Capable of connecting to several SIP servers at once.

'''Energy and Power:'''
* Voltage Compatibility: Supports an input voltage range from 12V to 48V DC and is compatible with passive Power over Ethernet (PoE).
* Power Consumption: Operates on a low energy consumption of 4-6 Watts.

==innovaphone CTI ready==


* Initiate outgoing call no
* Answer incoming call no
* Hold/Retrieve no
* Transfer no

==innovaphone Reverse Proxy ready==


* STUN yes
* TURN yes
* ICE yes
* SIP/TCP yes
* SIP/TLS yes
==innovaphone WebRTC ready==


* Codec G.711 yes
* Codec OPUS yes
* DTLS encryption yes (RFC 5764)

==Supported Codecs==

* G.722 no
* G.711 A-law yes
* G.711 y-law yes
* G.723.1 (53) no
* G.729A no
* Opus yes (RFC 7587, NB)

==DTMF Support==


* SIP INFO (RFC 2976)
* RTP DTMF (RFC 4733)

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==


Supports RFC3261 Digest Authentication Scheme (Section 22.4) yes

==Support LDAP Phonebook==


* Support LDAP Phonebook no

==Version==




Product versions used for interop testing:

* ESENTA Sias Version 1.37 (26)

* innovaphone V13r3sr10

==Configuration==






===Setting up a user for ESENTA Sias===
In the innovaphone user interface, navigate to the subpage PBX > Objects

Press new and then fill in the following fields

* Long Name (a descriptive name, here: Sias)
* Name (the short name, here: sias)
* Password (a password of your choice)
* Hardware Id (the user name, here: sias)
* Activate Media Relay

[[File:NewUser.png|Create new user|500px]]

===Configure SIP credentials in ESENTA Sias===

In the ESENTA SIAS web interface, navigate to SIP telephony.
* Under SIP Server enter the IP address of the innovaphone PBX, port 5060, protocol TCP
* Enter the name from the innovaphone Hardware ID field as the Auth user name
* Enter the selected password as the Auth password
* Set Media Encoding to RTP/AVP
* Select RTP (RFC-4733) as DTMF Mode

[[File:Settings_sias.png|SIAS settings|500px]]

If you need to register at a PBX behind a Reverse Proxy, you need to set your PBX system name in the field 'SIP Server' and address your Reverse Proxy via IP or name in the field 'Outbound Proxy'.

===Adding a call button to ESENTA Sias===

Navigate to the nameplates subpage and click on Add nameplate.

Enter the SIP address in the format sip:[phone number]@[innovaphone server] ([phone number] replaced with the destination number assigned to the user in the innovaphone PBX, [innovaphone server] replaced with the server IP/Host).

Then press Save.

[[File:Nameplate.png|SIAS nameplate|500px]]

==Summary==


This tutorial shows the integration with our native SIP stack, but soon our innovaphone myApps Platform App based on WebRTC technology will be available, which supports two-way video calls and integrates well into the innovaphone ecosystem.

==Video on phone==
Video on innovaphone phones is possible. Use this link: http://IP-Adress-ESENTA/snapshot/480x272.jpg?refresh=1 
Tested on IP111, IP112, IP232 simultaneous on 10 Phones by Mehrens U.C. .

==Contact==



{|
| ESENTA GmbH
|-
| Hauptstraße 165
|-
| 77876 Kappelrodeck
|-
| Tel: +49 (0) 78 42 99 77 461
|-
| Mail: [mailto:info@esenta.de info@esenta.de]
|}

For any questions please refer to [https://esenta.de/contact-us/ our contact page].

Howto:ESENTA SIAS - ESENTA GmbH - 3rd Party Product

2024-06-10T16:34:39Z

Muschelpuster: /* Hint how to configure a registration over RP*/

[[Image:ESENTA logo.png||200px|right]]

==Product Name==


ESENTA [https://esenta.de/details/ Sias]

==Certification Status==

{{Template:Compat_Status_referral_terminals|manufacturername=Esenta GmbH|certificationdate=in November 2023}}

==Category==


[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:ESENTA logo.png|150px]]

ESENTA GmbH specializes in leading-edge building communication and automation solutions. Since our inception in Kappelrodeck in 2018, we have dedicated ourselves to crafting state-of-the-art smart home solutions and IP video door intercom systems. Our flagship product, the SIAS IP video door intercom, transcends the traditional doorbell, weaving security, convenience, and advanced technology into the fabric of daily living.

==Description==









[[File:Sias.png|150px|ESENTA SIAS]]

ESENTA SIAS is an advanced IP intercom system with a feature-rich touchscreen interface for residential and commercial buildings, offering direct calling to residents, video streaming, and two-way communication through an intuitive app. The system enhances property access with multifactor authentication including NFC and fingerprint verification, allows remote door operation, and is designed for integration into smart home ecosystems. It's crafted to streamline visitor management with customizable nameplates on its display, does not mandate cloud usage, supports flexible network connectivity and ensures a secure and seamless user experience.




''Benefits at a glance:''

* Direct Calling and Communication
* Multifactor Authentication
* Remote Door Operation
* Smart Home Integration
* Customizable Interface
* Global Access (Optional Cloud)
* Flexible Connectivity
* Enhanced Security
* User-Friendly Management

==Functions==





'''Connectivity and Communication:'''
* Real-Time Notifications: Sends alerts to smartphones or tablets when someone rings the bell or when motion is detected.
* Video Streaming: Offers a live video feed via a high-resolution wide-angle camera viewable on the ESENTA app.
* Two-Way Audio: Allows for communication with visitors through the app using the intercom's microphone and speaker.

'''Security and Access:'''
* Fingerprint Authentication: A capacitive fingerprint reader that can store up to 100 different fingerprints.
* Code Entry: Users can enter access codes directly on the touchscreen display.
* PIR/Radar Sensor: Detects people in proximity to the door.
* Sabotage Detection: Features an accelerometer to detect any tampering efforts.

'''Smart Home Compatibility:'''
* Integration: Easily integrates with existing smart home systems using open interfaces like MQTT and REST API.
* User Interface: Control the system through a web interface or smartphone app, customizing access and functions as needed.

'''Installation and Setup:'''
* Network Integration: Can be connected via standard networking cable or through a 2-Wire module using existing wires.
* Device Support: Compatible with a wide range of devices including Android/iOS smartphones, SIP phones, and tablets.
* Multiple SIP Server Support: Capable of connecting to several SIP servers at once.

'''Energy and Power:'''
* Voltage Compatibility: Supports an input voltage range from 12V to 48V DC and is compatible with passive Power over Ethernet (PoE).
* Power Consumption: Operates on a low energy consumption of 4-6 Watts.

==innovaphone CTI ready==


* Initiate outgoing call no
* Answer incoming call no
* Hold/Retrieve no
* Transfer no

==innovaphone Reverse Proxy ready==


* STUN yes
* TURN yes
* ICE yes
* SIP/TCP yes
* SIP/TLS yes
==innovaphone WebRTC ready==


* Codec G.711 yes
* Codec OPUS yes
* DTLS encryption yes (RFC 5764)

==Supported Codecs==

* G.722 no
* G.711 A-law yes
* G.711 y-law yes
* G.723.1 (53) no
* G.729A no
* Opus yes (RFC 7587, NB)

==DTMF Support==


* SIP INFO (RFC 2976)
* RTP DTMF (RFC 4733)

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==


Supports RFC3261 Digest Authentication Scheme (Section 22.4) yes

==Support LDAP Phonebook==


* Support LDAP Phonebook no

==Version==




Product versions used for interop testing:

* ESENTA Sias Version 1.37 (26)

* innovaphone V13r3sr10

==Configuration==






===Setting up a user for ESENTA Sias===
In the innovaphone user interface, navigate to the subpage PBX > Objects

Press new and then fill in the following fields

* Long Name (a descriptive name, here: Sias)
* Name (the short name, here: sias)
* Password (a password of your choice)
* Hardware Id (the user name, here: sias)
* Activate Media Relay

[[File:NewUser.png|Create new user|500px]]

===Configure SIP credentials in ESENTA Sias===

In the ESENTA SIAS web interface, navigate to SIP telephony.
* Under SIP Server enter the IP address of the innovaphone PBX, port 5060, protocol TCP
* Enter the name from the innovaphone Hardware ID field as the Auth user name
* Enter the selected password as the Auth password
* Set Media Encoding to RTP/AVP
* Select RTP (RFC-4733) as DTMF Mode

[[File:Settings_sias.png|SIAS settings|500px]]

If you need to register at a PBX behind a Reverse Proxy, you need to set your PBX system name in the field 'SIP server' and address your Reverse Proxy via IP or name in the field 'Outbound Proxy'.

===Adding a call button to ESENTA Sias===

Navigate to the nameplates subpage and click on Add nameplate.

Enter the SIP address in the format sip:[phone number]@[innovaphone server] ([phone number] replaced with the destination number assigned to the user in the innovaphone PBX, [innovaphone server] replaced with the server IP/Host).

Then press Save.

[[File:Nameplate.png|SIAS nameplate|500px]]

==Summary==


This tutorial shows the integration with our native SIP stack, but soon our innovaphone myApps Platform App based on WebRTC technology will be available, which supports two-way video calls and integrates well into the innovaphone ecosystem.

==Video on phone==
Video on innovaphone phones is possible. Use this link: http://IP-Adress-ESENTA/snapshot/480x272.jpg?refresh=1 
Tested on IP111, IP112, IP232 simultaneous on 10 Phones by Mehrens U.C. .

==Contact==



{|
| ESENTA GmbH
|-
| Hauptstraße 165
|-
| 77876 Kappelrodeck
|-
| Tel: +49 (0) 78 42 99 77 461
|-
| Mail: [mailto:info@esenta.de info@esenta.de]
|}

For any questions please refer to [https://esenta.de/contact-us/ our contact page].

Reference13r3:Concept OAuth2 Windows Authentication

2024-03-21T14:15:29Z

Muschelpuster: /* Configuration PBX - hint for trusting certificates */

[[Category:Concept|OAuth2 and myApps Windows Authentication]]
[[Category:Concept_OAuth2]]
[[Category:Concept_myApps]]

Users can login-in to myApps using their windows password. The PBX uses OAuth2 with an OpenID configuration to verify the login information.

== Applies to ==
* innovaphone devices with a PBX from version 13r3
* innovaphone myApps (all platforms)

== How it works ==
=== Connection to the OpenID server ===
The OAuth2 service of the PBX retrieves the OpenID configuration from the configured OpenID server. 
This configuration is used to generate an authorization URL and to verify the login information which is retrieved after the login.

[[Image:MyApps OAuth2 flow config.png]]

=== Login with windows password in myApps ===
The login process using windows credentials:

* myApps starts the login and learns that OpenID is configured
* If the user selects OpenID for authentication, myApps opens the authorization URL of your OpenID server inside a popup window.
* after a successfull login with the windows credentials, the OpenID server redirects back to the '''Redirect URI''' of the PBX
* the redirect contains an id_token which itself contains the login information
* the signature of the id_token is verified against the OpenID configuration to ensure that the login is from the correct OpenID server
* the myApps login is completed

[[Image:MyApps OAuth2 flow login.png]]

;Shared secret:
OAuth2 doesn't offer a shared secret and the user's password is unknown by the PBX and myApps.
So we do an ECDHE key agreement to create a shared secret that is used for digest calculations and encryption of session parameters.

;Session credentials:
The PBX creates session credentials for future connections and stores them at the user object. After that it encrypts the credentials using the shared secret and sends them to the web application.

;Login:
For the initial login, the username from the id_token and the shared secret is used.
For subsequent connections, the session credentials are used.

Note: If the user is already logged-in at the OpenID provider, the redirect to the Redirect URL is done without asking for credentials and the login is completed automatically.

;Logout:
If the user actively logs out, the session credentials are deleted in the PBX and on the myApps client.
So for the next authentication, the login screen is displayed again.

Note: Logging out from myApps does not mean a logging out from the OpenID provider.

=== Characteristics ===
* The windows password is just used inside the OpenID authorization page. It is unknown by the PBX and the myApps client and it is never stored or transmitted over the network.
* During the login, a shared secret is negotiated using an ECDHE handshake. Session credentials are created and stored in the PBX at the user object and the DOM storage of the browser. So the user doesn't have to authenticate again, if the PBX or the browser is restarted.
* On logout the session credentials are deleted in the DOM Storage of the browser and in the PBX. So the next time the user is asked again for authentication.

== Requirements ==
=== OpenID server ===
We have developed and tested the functionality based on Microsoft Active Directory Federation Service (AD FS):
* Windows Server 2022 has been successfully tested
* Windows Server 2019 has been successfully tested
* Windows Server 2016 has been successfully tested
* Windows Server 2012 is not supported
* Microsoft Azure AD has been successfully tested (13r3 SR2 onwards)

In principle, any server that meets the following conditions should work
* OpenID compliant server
* It has a well-known configuration URI, e.g. <code>https://adfs.domain.com/adfs/.well-known/openid-configuration</code>
* The OpenID configuration must deliver:
** Authorization endpoint
** JWKS URI
** support for id_token response type
** support for id_token signing algorithm RS256
** support for response mode form_post
** support for upn claim
** support for nonce claim (optionally, but the random client nonce must be still echoed inside the ID token)
** at least one key which is used for token signing

However, as we have not carried out tests with other OpenID server variants, use with such servers is not supported.

=== PBX ===
* Firmware from version 13r3 or later.
* Working DNS configuration.
* The usernames (Name) of the user objects in the PBX must match the Windows usernames which are sent within the id_token (normally the upn field in AD FS).
* OAuth2 authentication must be enabled on the PBX/Config/Authentication page in the advanced UI.

=== RP/Firewalls ===

* all communication is done via HTTPs
* RPs/Firewalls must allow access to the AD FS authorization URL (with can be retrieved by looking at the response of the openid configuration URL)
* RPs/Firewalls must allow access to the OAuth2 module on the PBX which is accessed by the myApps clients, e.g. <code>https://pbx.domain.com/OAUTH2/oauth2_login.htm</code>
* the PBX must be able to access the OpenID configuration URL

== Configuration Microsoft AD FS ==
This just describes the configuration on a Windows 2019 server, but every OpenID server meeting the above mentioned requirements should be possible to use.

=== Activate AD FS server role ===
* make sure the AD FS server role is activated in your Windows Server

=== Server application with Client-ID ===
* open your AD FS management
* go to ''Application groups''
* add a new ''Application group''
* select ''Server application''
* give it a name of your choice and proceed
* note down the Client-ID
* add the Redirect URI of your PBX, e.g. <code>https://pbx.domain.com:443/OAUTH2/oauth2_login.htm</code>
** here you can also add multiple Redirect URIs for all your slaves and standbys too
* generate a secret key (this key isn't used inside the PBX, so you don't need to note it)

=== Token signature certificate ===
* open your AD FS management
* go to ''Service''
* go to ''Certificates''
* ensure you have a ''Token-signing'' certificate

There are also Powershell commands to add server applications etc., but they are out of scope of this article.

== Configuration Microsoft Azure AD ==

Support has been added in 13r3 SR2. 
Login to your Microsoft Azure portal, e.g. on https://portal.azure.com and '''Manage Azure Active Directory'''.

=== Add App Registration ===

* click on '''+ Add''' and select '''App Registration'''
* enter any name
* select suitable supported account types according to your usage
* '''Redirect URI''': select '''Web''' as platform and add the Redirect URI of your PBX, e.g. <code>https://pbx.domain.com:443/OAUTH2/oauth2_login.htm</code>
** here you can also add multiple Redirect URIs for all your slaves and standbys too
* click '''Register''' to add this App Registration

=== Authentication ===

* open the '''Authentication''' page of this new App Registration
* tick '''ID tokens (used for implicit and hybrid flows)''' so that the ID token is sent to the PBX on a successfull login
* save

=== Token Configuration ===

* open the '''Token Configuration''' page
* click '''+ add optional claim'''
* select '''ID''' as token type
* tick '''email''' in the list of available claims
* click '''Add''' and a second time '''Add''' (no need to tick the additional questioned checkbox)

=== Overview ===

* open the '''Overview''' page
* note the '''Application (client) ID''' for your OAuth2 configuration on the PBX
* note the '''Directory (tenant) ID''' for your OAuth2 configuration on the PBX
** the configuration URL will look like this: https://login.microsoftonline.com/Directory_tenant_ID/v2.0/.well-known/openid-configuration (as long as Microsoft doesn't change this or offers different variants ...)

== Configuration PBX ==
On all PBXes in the system:
* Configure the OAuth2 service on the innovaphone device on page [[{{NAMESPACE}}:Services/OAuth2/Config | Services/OAuth2/Config]].
* Activate OAuth2 authentication on page [[{{NAMESPACE}}:PBX/Config/Authentication | PBX/Config/Authentication ]]
* The first test will not work; you must trust the rejected Microsoft certificates on page [[{{NAMESPACE}}:General/Certificates | General/Certificates ]]

== Usage ==
Depending on the configuration on page[[{{NAMESPACE}}:PBX/Config/Authentication | PBX/Config/Authentication ]] users can use their PBX user password, their Windows password or both for the myApps login.
;OAuth2 only: Shows a button redirecting to the OpenID provider.
;PBX only: Shows a login form with fields for username and password.
;PBX and OAuth2: Shows both and lets the user decide.

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

;OAuth2
: fetching the OpenID configuration
: processing of incoming id_tokens
: communication between the OAuth2 module and the PBX

;PBX: communication between the PBX and the myApps client

;HTTP Client
: the HTTPS communication for fetching the OpenID configuration

Additionally, you can enable the following trace flags at the myApps client.
;Browser Console
: login-flow and possible errors from the client perspective

== Alarms and Events ==
* an event is generated on every id_token which cannot be parsed or verified
* an alarm is generated if the Open ID configuration cannot be fetched or is invalid

== Test page ==

You can also use the test page at ''Services/OAuth2/Test''.

== id_token ==
The OpenID server redirects to the PBX after a successfull login. This redirect contains two form variables:
* id_token
* state: this is just echoed from the initial authorization URL to be able to link the login in myApps to the id_token

An id_token is a JSON Web Token in the following format:

base64url(JSON header).base64url(JSON payload).base64url(binary signature)

=== decoded header example ===
<syntaxhighlight lang="javascript">
{
"typ": "JWT",
"alg": "RS256",
"x5t": "VtIJQ2e2n7_Nmui0Bk7veW5IUPQ",
"kid": "VtIJQ2e2n7_Nmui0Bk7veW5IUPQ"
}
</syntaxhighlight>

=== decoded payload example ===
<syntaxhighlight lang="javascript">
{
"aud": "8e4e2791-8583-4141-ce5b-a16f048758d9",
"iss": "https://adfs.domain.com/adfs",
"iat": 1663142781,
"nbf": 1663142781,
"exp": 1663146381,
"auth_time": 1663138217,
"nonce": "123456",
"sub": "wtj0QFR+Y2vsjTJXCclEZ4vtQKIEZKIOSpPRvxxLIxY=",
"upn": "username@domain.com",
"unique_name": "DOMAIN\\username",
"sid": "S-1-5-11-864245398-616249376-725345543-3105"
}
</syntaxhighlight>

=== signature ===
The signature is binary. The signature is verified by calculating the SHA256 hash of "base64url(header).base64url(payload)" and generation of an RSA public key of the '''n''' and '''e''' properties of the OpenID key with the '''kid''' retrieved inside the header JSON. With this rsa key and the hash the binary signature is verified.

Reference14r1:Concept Let's Encrypt

2024-01-31T11:54:57Z

Muschelpuster: /* Devices certificate configuration */

[[Category:Concept|Let%27s%20Encrypt]]

Certificates are automatically generated for innovaphone gateways and App Platforms.

== Applies to ==
* innovaphone gateways from version 14r1
* innovaphone App Platform with version 14r1 apps (image version 110036 or higher)

== How it works ==

* Each configured innovaphone client requests a new certificate '''30''' days before it's current certificate expires.
* Therefor an app websocket connection is opened to the Connector for Let's Encrypt App Service.
* The client sends a certificate signing request to the Connector for Let's Encrypt App Service.
* The Connector for Let's Encrypt App Service itself communitates via HTTPs and [https://en.wikipedia.org/wiki/JSON_Web_Token JWT] with Let's Encrypt to request a new certificate.
* Let's Encrypt triggers an HTTP challenge for every DNS entry where the token for the DNS entry is verified.
** the HTTP challenge always works '''without''' HTTPS on Port 80 on a subpath of '''/.well-known/acme-challenge/''', e.g. http://mydns.com/.well-known/acme-challenge/1290378712893z12983
* After successfull HTTP challenges for every DNS name, the new certificate is send back to the client.
* The certificate is installed X days before the old certificate expires, while X can be configured in the PBX Manager Plugin.

=== Flow without Reverse Proxy ===

[[Image:letsencrypt-flow.png]]

=== Flow with Reverse Proxy ===
[[Image:letsencrypt-flow-rp.png]]

== Requirements ==
=== ACMEv2 compliant certification service ===

Our Connector for Let's Encrypt App Service uses the ACMEv2 protocol. So in general every ACMEv2 compliant service could be used. 
Officially tested is Let's Encrypt itself with this URL: https://acme-v02.api.letsencrypt.org

=== Gateways and App Platform ===
* Firmware from version 14r1 or later
* innovaphone App Platform with App Platform Manager version 14r1 or higher and image version 110036 or higher
* innovaphone App Connector for Let's Encrypt version 14r1 or higher
* working DNS configuration

=== Reverse-Proxy ===

* Port 80 must be available from WAN (external DNS should be correct for every DNS name, which gets a Let's Encrypt certificate) to the Reverse-Proxy, as the HTTP challenge uses this port to verify the token. (The ACMEv2 protocol doesn't allow another port!)
* The Reverse-Proxy automatically forwards incoming requests to <code>/.well-known/acme-challenge/</code> to the Connector for Let's Encrypt App before the local ruleset is checked. The App checks if the challenge can be verified.
** If this is not possible, because the App doesn't know anything about this request, the Reverse-Proxy takes care about the request by its normal configured ruleset.
** This means: if a 3rd-party device behind the Reverse-Proxy tries to generate a Let's Encrypt certificate by themselves (without the Connector for Let's Encrypt App) you have to create a rule for the Path "'''/.well-known/acme-challenge/'''" in your Reverse-proxy rules.
** Conclusion: If you want to use the automatic forwarding you have to connect the Reverse-Proxy as the first device to the app. Otherwise, devices behind Reverse-Proxy (mostly the PBX) can't obtain a certificate.
* The App Platform must be able to communicate with the Let's Encrypt URLs.

== Limitations ==
* You can configure up to '''100''' DNS entries for a single device. More DNS entries are not supported by Let's Encrypt. 
* You cannot configure DNS entries with wildcards. Such wildcard entries require the so called DNS challenge mechanism which is not supported by our Connector for Let's Encrypt App Service.

== Configuration ==

=== Connector for Let's Encrypt PBX Manager Plugin ===
Configure the [[Reference14r1:Concept_App_Service_Let%27s_Encrypt#Let.27s_Encypt_Config | PBX Manager Plugin]] of the Connector for Let's Encrypt App Service.

=== innovaphone Gateways ===
Configure the [[Reference14r1:Services/Letsencrypt | Let's Encrypt service]] on every gateway which shall get a Let's Encrypt certificate.

=== innovaphone App Platform ===
Configure Let's Encrypt in the settings of the App Platform Manager on every App Platform which shall get a Let's Encrypt certificate.

=== RP ===
If your gateways and/or App Platforms are behind an innovaphone reverse proxy, you must configure the [[Reference14r1:Services/Letsencrypt | Let's Encrypt service]] here too. 
You must configure all DNS names which are used by the individual devices behind the RP. 
 
The RP will request a certificate with multiple SAN entries while every individual device will request an own certificate with a single SAN entry (or still multiple if a single device shall have multiple DNS entries).

=== Devices certificate configuration ===
If you want to rollout the Let's Encrypt root certificates to your devices, configure the URL for Let's Encrypt root certificates in a certificates configuration (App Devices -> Domains -> your domain -> Device Configurations) which will then ensure that always the latest root certificates are available in the trust list of your devices. 
You can find this URL in the [[Reference14r1:Apps/PbxManager/App_Connector_for_Let's_Encrypt | PBX Manager Plugin]].

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

;Let's Encrypt
: communication between gateway and the Connector for Let's Encrypt App Service
: processing of incoming id_tokens

;HTTP Client
: the HTTPS communication with the Connector for Let's Encrypt App Service

=== App Platform ===

Enable these trace flags for diagnostics:

==== App Platform Manager ====
;App
: requests of new certificates
;AppWebsocket
: communication with the Connector for Let's Encrypt App Service
;Websocket Client
: communication with the Connector for Let's Encrypt App Service

==== Connector for Let's Encrypt App Service ====
;App
: app logs
;HttpClient
: communication with Let's Encrypt itself
;AppWebsocket
: communication with the clients

== Alarms and Events ==
* an event is generated for every failed certificate creation by the Connector for Let's Encrypt App Service
* an alarm is generated on the corresponding device as long as the certificate creation fails

==Related Articles==
* [[Reference14r1:Services/Letsencrypt]]
* [[Reference14r1:Concept_App_Service_Connector_for_Let%27s_Encrypt]]
* [[Reference14r1:Apps/PbxManager/App_Connector_for_Let%27s_Encrypt]]

Reference14r1:Concept Let's Encrypt

2024-01-31T11:54:20Z

Muschelpuster: /* Devices certificate configuration */

[[Category:Concept|Let%27s%20Encrypt]]

Certificates are automatically generated for innovaphone gateways and App Platforms.

== Applies to ==
* innovaphone gateways from version 14r1
* innovaphone App Platform with version 14r1 apps (image version 110036 or higher)

== How it works ==

* Each configured innovaphone client requests a new certificate '''30''' days before it's current certificate expires.
* Therefor an app websocket connection is opened to the Connector for Let's Encrypt App Service.
* The client sends a certificate signing request to the Connector for Let's Encrypt App Service.
* The Connector for Let's Encrypt App Service itself communitates via HTTPs and [https://en.wikipedia.org/wiki/JSON_Web_Token JWT] with Let's Encrypt to request a new certificate.
* Let's Encrypt triggers an HTTP challenge for every DNS entry where the token for the DNS entry is verified.
** the HTTP challenge always works '''without''' HTTPS on Port 80 on a subpath of '''/.well-known/acme-challenge/''', e.g. http://mydns.com/.well-known/acme-challenge/1290378712893z12983
* After successfull HTTP challenges for every DNS name, the new certificate is send back to the client.
* The certificate is installed X days before the old certificate expires, while X can be configured in the PBX Manager Plugin.

=== Flow without Reverse Proxy ===

[[Image:letsencrypt-flow.png]]

=== Flow with Reverse Proxy ===
[[Image:letsencrypt-flow-rp.png]]

== Requirements ==
=== ACMEv2 compliant certification service ===

Our Connector for Let's Encrypt App Service uses the ACMEv2 protocol. So in general every ACMEv2 compliant service could be used. 
Officially tested is Let's Encrypt itself with this URL: https://acme-v02.api.letsencrypt.org

=== Gateways and App Platform ===
* Firmware from version 14r1 or later
* innovaphone App Platform with App Platform Manager version 14r1 or higher and image version 110036 or higher
* innovaphone App Connector for Let's Encrypt version 14r1 or higher
* working DNS configuration

=== Reverse-Proxy ===

* Port 80 must be available from WAN (external DNS should be correct for every DNS name, which gets a Let's Encrypt certificate) to the Reverse-Proxy, as the HTTP challenge uses this port to verify the token. (The ACMEv2 protocol doesn't allow another port!)
* The Reverse-Proxy automatically forwards incoming requests to <code>/.well-known/acme-challenge/</code> to the Connector for Let's Encrypt App before the local ruleset is checked. The App checks if the challenge can be verified.
** If this is not possible, because the App doesn't know anything about this request, the Reverse-Proxy takes care about the request by its normal configured ruleset.
** This means: if a 3rd-party device behind the Reverse-Proxy tries to generate a Let's Encrypt certificate by themselves (without the Connector for Let's Encrypt App) you have to create a rule for the Path "'''/.well-known/acme-challenge/'''" in your Reverse-proxy rules.
** Conclusion: If you want to use the automatic forwarding you have to connect the Reverse-Proxy as the first device to the app. Otherwise, devices behind Reverse-Proxy (mostly the PBX) can't obtain a certificate.
* The App Platform must be able to communicate with the Let's Encrypt URLs.

== Limitations ==
* You can configure up to '''100''' DNS entries for a single device. More DNS entries are not supported by Let's Encrypt. 
* You cannot configure DNS entries with wildcards. Such wildcard entries require the so called DNS challenge mechanism which is not supported by our Connector for Let's Encrypt App Service.

== Configuration ==

=== Connector for Let's Encrypt PBX Manager Plugin ===
Configure the [[Reference14r1:Concept_App_Service_Let%27s_Encrypt#Let.27s_Encypt_Config | PBX Manager Plugin]] of the Connector for Let's Encrypt App Service.

=== innovaphone Gateways ===
Configure the [[Reference14r1:Services/Letsencrypt | Let's Encrypt service]] on every gateway which shall get a Let's Encrypt certificate.

=== innovaphone App Platform ===
Configure Let's Encrypt in the settings of the App Platform Manager on every App Platform which shall get a Let's Encrypt certificate.

=== RP ===
If your gateways and/or App Platforms are behind an innovaphone reverse proxy, you must configure the [[Reference14r1:Services/Letsencrypt | Let's Encrypt service]] here too. 
You must configure all DNS names which are used by the individual devices behind the RP. 
 
The RP will request a certificate with multiple SAN entries while every individual device will request an own certificate with a single SAN entry (or still multiple if a single device shall have multiple DNS entries).

=== Devices certificate configuration ===
If you want to rollout the Let's Encrypt root certificates to your devices, configure the URL for Let's Encrypt root certificates in a certificates configuration (App Devices -> Domains -> your Domain -> Device Configurations) which will then ensure that always the latest root certificates are available in the trust list of your devices. 
You can find this URL in the [[Reference14r1:Apps/PbxManager/App_Connector_for_Let's_Encrypt | PBX Manager Plugin]].

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

;Let's Encrypt
: communication between gateway and the Connector for Let's Encrypt App Service
: processing of incoming id_tokens

;HTTP Client
: the HTTPS communication with the Connector for Let's Encrypt App Service

=== App Platform ===

Enable these trace flags for diagnostics:

==== App Platform Manager ====
;App
: requests of new certificates
;AppWebsocket
: communication with the Connector for Let's Encrypt App Service
;Websocket Client
: communication with the Connector for Let's Encrypt App Service

==== Connector for Let's Encrypt App Service ====
;App
: app logs
;HttpClient
: communication with Let's Encrypt itself
;AppWebsocket
: communication with the clients

== Alarms and Events ==
* an event is generated for every failed certificate creation by the Connector for Let's Encrypt App Service
* an alarm is generated on the corresponding device as long as the certificate creation fails

==Related Articles==
* [[Reference14r1:Services/Letsencrypt]]
* [[Reference14r1:Concept_App_Service_Connector_for_Let%27s_Encrypt]]
* [[Reference14r1:Apps/PbxManager/App_Connector_for_Let%27s_Encrypt]]

Reference14r1:Concept Let's Encrypt

2024-01-31T11:49:41Z

Muschelpuster: /* Reverse-Proxy */ - hint to connect Reverse-Proxy fist with the app

[[Category:Concept|Let%27s%20Encrypt]]

Certificates are automatically generated for innovaphone gateways and App Platforms.

== Applies to ==
* innovaphone gateways from version 14r1
* innovaphone App Platform with version 14r1 apps (image version 110036 or higher)

== How it works ==

* Each configured innovaphone client requests a new certificate '''30''' days before it's current certificate expires.
* Therefor an app websocket connection is opened to the Connector for Let's Encrypt App Service.
* The client sends a certificate signing request to the Connector for Let's Encrypt App Service.
* The Connector for Let's Encrypt App Service itself communitates via HTTPs and [https://en.wikipedia.org/wiki/JSON_Web_Token JWT] with Let's Encrypt to request a new certificate.
* Let's Encrypt triggers an HTTP challenge for every DNS entry where the token for the DNS entry is verified.
** the HTTP challenge always works '''without''' HTTPS on Port 80 on a subpath of '''/.well-known/acme-challenge/''', e.g. http://mydns.com/.well-known/acme-challenge/1290378712893z12983
* After successfull HTTP challenges for every DNS name, the new certificate is send back to the client.
* The certificate is installed X days before the old certificate expires, while X can be configured in the PBX Manager Plugin.

=== Flow without Reverse Proxy ===

[[Image:letsencrypt-flow.png]]

=== Flow with Reverse Proxy ===
[[Image:letsencrypt-flow-rp.png]]

== Requirements ==
=== ACMEv2 compliant certification service ===

Our Connector for Let's Encrypt App Service uses the ACMEv2 protocol. So in general every ACMEv2 compliant service could be used. 
Officially tested is Let's Encrypt itself with this URL: https://acme-v02.api.letsencrypt.org

=== Gateways and App Platform ===
* Firmware from version 14r1 or later
* innovaphone App Platform with App Platform Manager version 14r1 or higher and image version 110036 or higher
* innovaphone App Connector for Let's Encrypt version 14r1 or higher
* working DNS configuration

=== Reverse-Proxy ===

* Port 80 must be available from WAN (external DNS should be correct for every DNS name, which gets a Let's Encrypt certificate) to the Reverse-Proxy, as the HTTP challenge uses this port to verify the token. (The ACMEv2 protocol doesn't allow another port!)
* The Reverse-Proxy automatically forwards incoming requests to <code>/.well-known/acme-challenge/</code> to the Connector for Let's Encrypt App before the local ruleset is checked. The App checks if the challenge can be verified.
** If this is not possible, because the App doesn't know anything about this request, the Reverse-Proxy takes care about the request by its normal configured ruleset.
** This means: if a 3rd-party device behind the Reverse-Proxy tries to generate a Let's Encrypt certificate by themselves (without the Connector for Let's Encrypt App) you have to create a rule for the Path "'''/.well-known/acme-challenge/'''" in your Reverse-proxy rules.
** Conclusion: If you want to use the automatic forwarding you have to connect the Reverse-Proxy as the first device to the app. Otherwise, devices behind Reverse-Proxy (mostly the PBX) can't obtain a certificate.
* The App Platform must be able to communicate with the Let's Encrypt URLs.

== Limitations ==
* You can configure up to '''100''' DNS entries for a single device. More DNS entries are not supported by Let's Encrypt. 
* You cannot configure DNS entries with wildcards. Such wildcard entries require the so called DNS challenge mechanism which is not supported by our Connector for Let's Encrypt App Service.

== Configuration ==

=== Connector for Let's Encrypt PBX Manager Plugin ===
Configure the [[Reference14r1:Concept_App_Service_Let%27s_Encrypt#Let.27s_Encypt_Config | PBX Manager Plugin]] of the Connector for Let's Encrypt App Service.

=== innovaphone Gateways ===
Configure the [[Reference14r1:Services/Letsencrypt | Let's Encrypt service]] on every gateway which shall get a Let's Encrypt certificate.

=== innovaphone App Platform ===
Configure Let's Encrypt in the settings of the App Platform Manager on every App Platform which shall get a Let's Encrypt certificate.

=== RP ===
If your gateways and/or App Platforms are behind an innovaphone reverse proxy, you must configure the [[Reference14r1:Services/Letsencrypt | Let's Encrypt service]] here too. 
You must configure all DNS names which are used by the individual devices behind the RP. 
 
The RP will request a certificate with multiple SAN entries while every individual device will request an own certificate with a single SAN entry (or still multiple if a single device shall have multiple DNS entries).

=== Devices certificate configuration ===
If you want to rollout the Let's Encrypt root certificates to your devices, configure the URL for Let's Encrypt root certificates in a certificates configuration which will then ensure that always the latest root certificates are available in the trust list of your devices. 
You can find this URL in the [[Reference14r1:Apps/PbxManager/App_Connector_for_Let's_Encrypt | PBX Manager Plugin]].

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

;Let's Encrypt
: communication between gateway and the Connector for Let's Encrypt App Service
: processing of incoming id_tokens

;HTTP Client
: the HTTPS communication with the Connector for Let's Encrypt App Service

=== App Platform ===

Enable these trace flags for diagnostics:

==== App Platform Manager ====
;App
: requests of new certificates
;AppWebsocket
: communication with the Connector for Let's Encrypt App Service
;Websocket Client
: communication with the Connector for Let's Encrypt App Service

==== Connector for Let's Encrypt App Service ====
;App
: app logs
;HttpClient
: communication with Let's Encrypt itself
;AppWebsocket
: communication with the clients

== Alarms and Events ==
* an event is generated for every failed certificate creation by the Connector for Let's Encrypt App Service
* an alarm is generated on the corresponding device as long as the certificate creation fails

==Related Articles==
* [[Reference14r1:Services/Letsencrypt]]
* [[Reference14r1:Concept_App_Service_Connector_for_Let%27s_Encrypt]]
* [[Reference14r1:Apps/PbxManager/App_Connector_for_Let%27s_Encrypt]]

Reference13r2:Apps/PbxManager/Explorer

2023-05-25T05:37:29Z

Muschelpuster: Give visibility-entries the flag 'visible'

Howto talk:CH - Plus Vier Eins - IPTelefonie SIP-Provider (2023)

2023-04-18T09:15:55Z

Muschelpuster: my fault - comment deleted

Howto talk:CH - Plus Vier Eins - IPTelefonie SIP-Provider (2023)

2023-04-03T12:12:37Z

Muschelpuster: New page: There is a eror in description. It will relased with V13r3sr4 and not with V13r3sr3.

There is a eror in description. It will relased with V13r3sr4 and not with V13r3sr3.

Howto12r1:Avoid Multiple Callbacks

2023-03-29T08:22:12Z

Muschelpuster: /* Known Problems / Limitations */

When you call a group number, several phones or terminals ring at the same time. A similar function can also be created using a queue. If such a group call is not answered, the missed call is displayed on all the terminals. This applies to all types of terminals: an innovaphone IP telephone, an IP DECT telephone, an IP telephone from a third party or an analogue telephone connected via an adapter. Missed calls are also displayed simultaneously in the various myApps clients: the phone app, the softphone app including the mobile client, the RCC app or the switchboard app. If one of these participants calls back, the other members of the group are often unaware of this and call back independently, unaware of the callback that has already taken place. This is not only a waste of time, but also leads to unwanted reactions from the person being called. For example, the caller cannot understand why, after calling a single number, they are now being called back several times and by different people. The problem of multiple callbacks is exacerbated in the age of mobile and distributed workplaces. There are software solutions that try to solve this problem. However, such solutions are difficult or impossible to use in some workplaces and scenarios. For example, physical telephones are not considered at all, and it is impossible to cancel missed calls on an analogue phone. The proposed solution solves this problem, works fully automatically, does not require any user interaction or training and is device independent, i.e. it works with any phone or client. Here is how it works.

==Applies to==

innovaphone PBX V12 or higher

The feature requires no license.

==Operation==
The user calls the missed call as usual from the callback list of the phone or application. The first user in the group who calls back is immediately connected to the caller. If the called user is busy and is called back again by the same user, this is done immediately. So for the first recalled, everything is as usual.
If another (the second and all others) user of the called group calls back a voice announcement "The callback has already been made by the participant" followed by the caller's number and the prompt " Wait to call back anyway". If the participant does not hang up, he will be connected to the caller after two seconds. In this case, he automatically becomes the status of the "first" caller, so he can recall again without a warning (while the other group members now receive a warning).

==How it works==
The group (or queue) is not called directly, but to reach the group number you must call first a XML. This XML manipulates the number of the caller and adds an prefix. Then writes this number in a file and now connects to the group number (or queue).
If this number is now called back from the call list, a reality a second XML is called because of then previously prefix. This 2nd XML checks whether this is the first callback to this number and if so, the call is transfered to the caller immediately, if not, the warning message is played and if the call is up after 2 seconds the connection is made to the destination and the new recaller stored in a file.

Example: The group call number should be "9", actually the number "81" is assigned to the group and the number "9" to the XML. If a call comes from the number "01234" to "9", the XML remembers this number and adds the prefix "88". So the call list doesn't say "01234" but "8801234".

If this number is called, the call comes to the second XML with the number "88". This second XML recognizes "01234" as the called number, saves the phone number of the callback and connects to this number. If a second user calls back the "8801234", the second XML recognizes that a user has already called back and plays the warning.

==Installation==
All files are copied into a myApps directory (Files App). The necessary subdirectories are created automatically. Two VM objects are now created in the PBX, one for incoming calls (IN) and one for callback (OUT). The first receives the number of the group (or the WQ) and the second the desired Prefix. Enter the parameter "$_pbxcoder=g711a" in the URL of the XML. In our previous example, the VM object pointing to the "MMcallbackIN.xml" file would be assigned the number "9" and the VM object pointing to the "MMcallbackOUT.xml" file would be assigned the number "88".

Open now the first XML (“MMcallbackIN.xml”) with a text editor and edit line 5. The number of the group is specified under “value”.
(in the example above the "81", i.e. <assign out="$Group" value="81" />).

In line 6, the prefix code is specified (in the example above this is "88", i.e. <assign out="$CBxml" value="88" />).

Note: If the phone number of the caller is transferred from the PBX to the XML without a leading zero (just try it), you can add the trunk access code here, so in the example instead of "88" there would simply be "880".

==Country and language customization==
The package contains only german language data in dthe .g711a format. Therefore you have to specify the corresponding fixed codec in the URL, e.g.
http://xxx.zz.yy.ww/DRIVE/CF0/MCB/MMcallbackOUT.xml?$_pbxcoder=g711a
This is only required for "OUT XML" because "IN XML" does not reflect any language data.

If you have to play messages in another language (or the content should be different), proceed as follows:

Create the voice file "Track100.wav" with the content "The callback has already been processed by the subscriber" and the voice file "Track101.wav" with the content "Please Wait to call back anyway.” Then create the files with the announcement zero to nine “0.wav” to “9.wav”.

All of these files are now to be transcoded and imported using the conversion tool from wav to g711.
Note: the prompts 0-9 can be found in the voicemail application.

==Known Problems / Limitations==
• The caller's phone number is changed by the XML, so it is not possible to resolve the external caller's name from a phonebook or it is necessary to save the phone number with and without the area code.

• Only en-bloc dialling is possible, but this is the case anyway when dialling from call lists.

• If a call is answered and called back (e.g. with redial), the mechanism described also takes place. So there is no distinction between missed and answered calls; if a participant who called the group is called back, the other group members receive the warning.

==Download==

Howto12r1:Avoid Multiple Callbacks

2023-03-29T07:10:07Z

Muschelpuster: /* Installation */

When you call a group number, several phones or terminals ring at the same time. A similar function can also be created using a queue. If such a group call is not answered, the missed call is displayed on all the terminals. This applies to all types of terminals: an innovaphone IP telephone, an IP DECT telephone, an IP telephone from a third party or an analogue telephone connected via an adapter. Missed calls are also displayed simultaneously in the various myApps clients: the phone app, the softphone app including the mobile client, the RCC app or the switchboard app. If one of these participants calls back, the other members of the group are often unaware of this and call back independently, unaware of the callback that has already taken place. This is not only a waste of time, but also leads to unwanted reactions from the person being called. For example, the caller cannot understand why, after calling a single number, they are now being called back several times and by different people. The problem of multiple callbacks is exacerbated in the age of mobile and distributed workplaces. There are software solutions that try to solve this problem. However, such solutions are difficult or impossible to use in some workplaces and scenarios. For example, physical telephones are not considered at all, and it is impossible to cancel missed calls on an analogue phone. The proposed solution solves this problem, works fully automatically, does not require any user interaction or training and is device independent, i.e. it works with any phone or client. Here is how it works.

==Applies to==

innovaphone PBX V12 or higher

The feature requires no license.

==Operation==
The user calls the missed call as usual from the callback list of the phone or application. The first user in the group who calls back is immediately connected to the caller. If the called user is busy and is called back again by the same user, this is done immediately. So for the first recalled, everything is as usual.
If another (the second and all others) user of the called group calls back a voice announcement "The callback has already been made by the participant" followed by the caller's number and the prompt " Wait to call back anyway". If the participant does not hang up, he will be connected to the caller after two seconds. In this case, he automatically becomes the status of the "first" caller, so he can recall again without a warning (while the other group members now receive a warning).

==How it works==
The group (or queue) is not called directly, but to reach the group number you must call first a XML. This XML manipulates the number of the caller and adds an prefix. Then writes this number in a file and now connects to the group number (or queue).
If this number is now called back from the call list, a reality a second XML is called because of then previously prefix. This 2nd XML checks whether this is the first callback to this number and if so, the call is transfered to the caller immediately, if not, the warning message is played and if the call is up after 2 seconds the connection is made to the destination and the new recaller stored in a file.

Example: The group call number should be "9", actually the number "81" is assigned to the group and the number "9" to the XML. If a call comes from the number "01234" to "9", the XML remembers this number and adds the prefix "88". So the call list doesn't say "01234" but "8801234".

If this number is called, the call comes to the second XML with the number "88". This second XML recognizes "01234" as the called number, saves the phone number of the callback and connects to this number. If a second user calls back the "8801234", the second XML recognizes that a user has already called back and plays the warning.

==Installation==
All files are copied into a myApps directory (Files App). The necessary subdirectories are created automatically. Two VM objects are now created in the PBX, one for incoming calls (IN) and one for callback (OUT). The first receives the number of the group (or the WQ) and the second the desired Prefix. Enter the parameter "$_pbxcoder=g711a" in the URL of the XML. In our previous example, the VM object pointing to the "MMcallbackIN.xml" file would be assigned the number "9" and the VM object pointing to the "MMcallbackOUT.xml" file would be assigned the number "88".

Open now the first XML (“MMcallbackIN.xml”) with a text editor and edit line 5. The number of the group is specified under “value”.
(in the example above the "81", i.e. <assign out="$Group" value="81" />).

In line 6, the prefix code is specified (in the example above this is "88", i.e. <assign out="$CBxml" value="88" />).

Note: If the phone number of the caller is transferred from the PBX to the XML without a leading zero (just try it), you can add the trunk access code here, so in the example instead of "88" there would simply be "880".

==Country and language customization==
The package contains only german language data in dthe .g711a format. Therefore you have to specify the corresponding fixed codec in the URL, e.g.
http://xxx.zz.yy.ww/DRIVE/CF0/MCB/MMcallbackOUT.xml?$_pbxcoder=g711a
This is only required for "OUT XML" because "IN XML" does not reflect any language data.

If you have to play messages in another language (or the content should be different), proceed as follows:

Create the voice file "Track100.wav" with the content "The callback has already been processed by the subscriber" and the voice file "Track101.wav" with the content "Please Wait to call back anyway.” Then create the files with the announcement zero to nine “0.wav” to “9.wav”.

All of these files are now to be transcoded and imported using the conversion tool from wav to g711.
Note: the prompts 0-9 can be found in the voicemail application.

==Known Problems / Limitations==
• The caller's phone number is changed by the XML, so it is not possible to resolve the external caller's name from a phonebook or it is necessary to save the phone number with and without the area code.

• Only en-bloc dialing is possible, but this is the case anyway when dialing from call lists.

• If a call is answered and called back (e.g. with redial), the mechanism described also takes place. So there is no distinction between missed and answered calls; if a participant who called the group is called back, the other group members receive the warning.

==Download==

Howto12r1:Avoid Multiple Callbacks

2023-03-29T07:07:37Z

Muschelpuster: /* Operation */

When you call a group number, several phones or terminals ring at the same time. A similar function can also be created using a queue. If such a group call is not answered, the missed call is displayed on all the terminals. This applies to all types of terminals: an innovaphone IP telephone, an IP DECT telephone, an IP telephone from a third party or an analogue telephone connected via an adapter. Missed calls are also displayed simultaneously in the various myApps clients: the phone app, the softphone app including the mobile client, the RCC app or the switchboard app. If one of these participants calls back, the other members of the group are often unaware of this and call back independently, unaware of the callback that has already taken place. This is not only a waste of time, but also leads to unwanted reactions from the person being called. For example, the caller cannot understand why, after calling a single number, they are now being called back several times and by different people. The problem of multiple callbacks is exacerbated in the age of mobile and distributed workplaces. There are software solutions that try to solve this problem. However, such solutions are difficult or impossible to use in some workplaces and scenarios. For example, physical telephones are not considered at all, and it is impossible to cancel missed calls on an analogue phone. The proposed solution solves this problem, works fully automatically, does not require any user interaction or training and is device independent, i.e. it works with any phone or client. Here is how it works.

==Applies to==

innovaphone PBX V12 or higher

The feature requires no license.

==Operation==
The user calls the missed call as usual from the callback list of the phone or application. The first user in the group who calls back is immediately connected to the caller. If the called user is busy and is called back again by the same user, this is done immediately. So for the first recalled, everything is as usual.
If another (the second and all others) user of the called group calls back a voice announcement "The callback has already been made by the participant" followed by the caller's number and the prompt " Wait to call back anyway". If the participant does not hang up, he will be connected to the caller after two seconds. In this case, he automatically becomes the status of the "first" caller, so he can recall again without a warning (while the other group members now receive a warning).

==How it works==
The group (or queue) is not called directly, but to reach the group number you must call first a XML. This XML manipulates the number of the caller and adds an prefix. Then writes this number in a file and now connects to the group number (or queue).
If this number is now called back from the call list, a reality a second XML is called because of then previously prefix. This 2nd XML checks whether this is the first callback to this number and if so, the call is transfered to the caller immediately, if not, the warning message is played and if the call is up after 2 seconds the connection is made to the destination and the new recaller stored in a file.

Example: The group call number should be "9", actually the number "81" is assigned to the group and the number "9" to the XML. If a call comes from the number "01234" to "9", the XML remembers this number and adds the prefix "88". So the call list doesn't say "01234" but "8801234".

If this number is called, the call comes to the second XML with the number "88". This second XML recognizes "01234" as the called number, saves the phone number of the callback and connects to this number. If a second user calls back the "8801234", the second XML recognizes that a user has already called back and plays the warning.

==Installation==
All files are copied into a myApps directory (Files App). The necessary subdirectories are created automatically. Two VM objects are now created in the PBX, one for the incoming calls (IN) and one for the callback (OUT). The first receives the number of the group (or the WQ), the second the desired Prefix. Enter the parameter "$_pbxcoder=g711a" in the URL of the XML. In our previous example, the VM object pointing to the "MMcallbackIN.xml" file would be assigned the number "9" and the VM object pointing to the "MMcallbackOUT.xml" file would be assigned the number "88".

Open now the first XML (“MMcallbackIN.xml”) with a text editor and edit line 5. The number of the group is specified under “value”.
(in the example above the "81", i.e. <assign out="$Group" value="81" />).

In line 6, the prefix code is specified (in the example above this is "88", i.e. <assign out="$CBxml" value="88" />).

Note: If the phone number of the caller is transferred from the PBX to the XML without a leading zero (just try it), you can add the trunk access code here, so in the example instead of "88" there would simply be "880".

==Country and language customization==
The package contains only german language data in dthe .g711a format. Therefore you have to specify the corresponding fixed codec in the URL, e.g.
http://xxx.zz.yy.ww/DRIVE/CF0/MCB/MMcallbackOUT.xml?$_pbxcoder=g711a
This is only required for "OUT XML" because "IN XML" does not reflect any language data.

If you have to play messages in another language (or the content should be different), proceed as follows:

Create the voice file "Track100.wav" with the content "The callback has already been processed by the subscriber" and the voice file "Track101.wav" with the content "Please Wait to call back anyway.” Then create the files with the announcement zero to nine “0.wav” to “9.wav”.

All of these files are now to be transcoded and imported using the conversion tool from wav to g711.
Note: the prompts 0-9 can be found in the voicemail application.

==Known Problems / Limitations==
• The caller's phone number is changed by the XML, so it is not possible to resolve the external caller's name from a phonebook or it is necessary to save the phone number with and without the area code.

• Only en-bloc dialing is possible, but this is the case anyway when dialing from call lists.

• If a call is answered and called back (e.g. with redial), the mechanism described also takes place. So there is no distinction between missed and answered calls; if a participant who called the group is called back, the other group members receive the warning.

==Download==

Howto:Gigaset-Provisioning-App - Gigaset - Partner App

2023-01-23T12:45:32Z

Muschelpuster: /* Display Name mandatory */

[[Image:Gigaset-logo.png||200px|right]]

==Product Name==


[https://www.gigaset.com Gigaset] Gigaset-Provisioning-App

==Certification Status==



{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed December 2022.

==Category==

[[Category:Partner_Apps|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:Gigaset-LOGO.png|150px]]



With innovative communication solutions from Gigaset professional, your organisation can unlock its true potential and stay ahead of the competition.
Our cutting-edge telephony technology is delivered by a community of dedicated partners that can help you create a complete communications solution rather than a multitude of products.
With Gigaset professional, you gain access to an open platform designed for its user-friendliness, flexibility and outstanding performance, while offering seamless compatibility with leading on-premise telephony systems and cloud-based service providers.

[https://www.gigaset.com/pro/en_en/ Gigaset - Pro]

==Description==



<table>
<tr>
<tr>
<td colspan="5">Gigaset-Provisioning App supports:</td>
</tr>
<td colspan="5">DECT IP PRO</td>
</tr>
<tr>
<td>N870 [[Image:N870.png‎|250px]]</td>
<td>
- IP DECT Multicell System 
- max. number basestations: 6000 
- max. number handsets: 20000 
- max. number parallel Calls: 6000 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N870 N870]
 
<td></td>
<td>N670 [[Image:N670_Mini_Multicell_EN.png‎|250px]]</td>
<td>
- IP DECT Singlecell and Mini-Multicell System 
- max. number basestations: 3 
- max. number handsets: 20 
- max. number parallel Calls: 8 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N670 N670]
 
</tr>
</table>



The Gigaset Provisioning App integrates the Gigaset Single-, MiniMulti and Multicell Systems into the innovaphone PBX environment.
After the initial setup, user and phonebook management can be done from the innovaphone myApps environment,
so that no further activities need to be performed on the Gigaset system.

==Functions==




* Add / Remove Gigaset handset
* Configure the Phonebook on Gigaset Environment

With the Gigaset Provisioning App it is possible to automatically add and remove DECT devices via IPUI provisioning on the Gigaset Nx70 IP DECT.
In addition, the LDAP configuration can be provisioned.

== Provided APIs ==




* Websocket
* AdminApi
* TableUsers
* Services

==Licensing==


No license is required for this app

==Prerequisites==


None (at least knowledge about installing an App on the AP Platform and adding the App Object via PBX Manager)

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5

===Application versions used for interop testing===


* Gigaset Provisioning-App - 13R3 136017
* Gigaset Provisioning-App - 13R2 132017

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5
* Gigaset Nx70 V2.49.1

==Configuration==




===Install the App===

===Gigaset - Provisoning - App===

As an admin, create the environment settings in the Gigaset Provisioning App.
For the innovaphone PBX, enter the domain, the IP address of the PBX or the FQDN and the PBX password.
For the Gigaset Nx70 IP DECT Pro, enter the MAC ID (MAC address plus 4-digit code, can be found on the web UI under Status or on the integrator's box),
the IP address of the integrator and the admin password and select the DECT frequency.
If the Admin Password does not match the one assigned, it would be overwritten in the next step, during the 1st provisioning with the one entered here.

Under Phonebook settings you can activate the sync of the standard LDAP directory of the innovaphone PBX (PBX0).
or alternatively enter all parameters manually according to the LDAP server used.
Please enter the IP address, port and previously created access data for the innovaphone LDAP.

Click on the Save icon to save the entered configuration. The app generates a provisioning path from the data.
This path does not change as long as you do not change the MAC-ID.
Copy this path and paste it on the Gigaset Integrator under Settings --> System --> Provisioning and configuration.
Execute the first provisioning via the button "Start Auto Configuration" and log out of the web interface,
because as long as you are logged in, no provisioning can be performed by the app!

[[Image:innovaphone_GigasetApp_Admin.png]]

===Add Devices to User===

Now create new end devices as usual via UserAdmin or the Profile app. Select "Gigaset" in the manufacturer selection field and then enter the IPUI of the handset instead of the MAC address.
You can find the IPUI of the handset on the box, in the battery compartment or by switching to the menu on the handset with the right button and typing "*#06#".
Now the IPUI is displayed in the top line.

After you have saved the new handset, Gigaset Provisioning will automatically transfer the account to the integrator and start the login window for 5 minutes.
Now you can register the new handset with the default PIN "0000".

If you want to trigger provisioning again, e.g. to open the login window again, press the Save button in the Admin area of the Gigaset Provisioning app again.
The successful transfer is indicated by a message.
If the provisioning was not successful, this is also displayed.
This can have 2 reasons, either you are still logged in on the integrator in the background
or you have changed the admin password on the integrator in the meantime and have not stored the new one in the settings of the app.

[[Image:innovaphone_GigasetApp_User.png]]

==Know Restrictions==
===Display Name mandatory===
The app does not use the Long Name if Display Name is empty as commonly known from Innovaphone. If there is no Display Name the number will be used at the Gigaset. The phone book replication is working with Display Name too.

===Option Reverse Proxy will not be set automatically by provisioning===
If the clients should register over a Reverse Proxy you need to set this option manually. It's necessary to use RTP over the TURN because this option of V13r3 only works for devices registered over a Reverse Proxy (PBX - Config - General - Media relay endpoints - TURN = checked).

==Contact==
Gigaset Communications GmbH 
Frankenstraße 2 
46395 Bocholt

Tel: +49 2871 91-0 
E-Mail: de.pro@gigaset.com

'''Support''' 
+49 (89) 8780 6575 + PIN Code 
support@gigaset.com

'''Become a partner''' 
https://gigasetportal.force.com/Partner

'''App Feature Request''' 
Dennis Zimmermann 
Technical Sales Manager 
dennis.zimmermann@gigaset.com

Howto:Gigaset-Provisioning-App - Gigaset - Partner App

2023-01-23T12:43:46Z

Muschelpuster: /* Option Reverse Proxy will not be set automatically by provisioning */

[[Image:Gigaset-logo.png||200px|right]]

==Product Name==


[https://www.gigaset.com Gigaset] Gigaset-Provisioning-App

==Certification Status==



{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed December 2022.

==Category==

[[Category:Partner_Apps|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:Gigaset-LOGO.png|150px]]



With innovative communication solutions from Gigaset professional, your organisation can unlock its true potential and stay ahead of the competition.
Our cutting-edge telephony technology is delivered by a community of dedicated partners that can help you create a complete communications solution rather than a multitude of products.
With Gigaset professional, you gain access to an open platform designed for its user-friendliness, flexibility and outstanding performance, while offering seamless compatibility with leading on-premise telephony systems and cloud-based service providers.

[https://www.gigaset.com/pro/en_en/ Gigaset - Pro]

==Description==



<table>
<tr>
<tr>
<td colspan="5">Gigaset-Provisioning App supports:</td>
</tr>
<td colspan="5">DECT IP PRO</td>
</tr>
<tr>
<td>N870 [[Image:N870.png‎|250px]]</td>
<td>
- IP DECT Multicell System 
- max. number basestations: 6000 
- max. number handsets: 20000 
- max. number parallel Calls: 6000 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N870 N870]
 
<td></td>
<td>N670 [[Image:N670_Mini_Multicell_EN.png‎|250px]]</td>
<td>
- IP DECT Singlecell and Mini-Multicell System 
- max. number basestations: 3 
- max. number handsets: 20 
- max. number parallel Calls: 8 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N670 N670]
 
</tr>
</table>



The Gigaset Provisioning App integrates the Gigaset Single-, MiniMulti and Multicell Systems into the innovaphone PBX environment.
After the initial setup, user and phonebook management can be done from the innovaphone myApps environment,
so that no further activities need to be performed on the Gigaset system.

==Functions==




* Add / Remove Gigaset handset
* Configure the Phonebook on Gigaset Environment

With the Gigaset Provisioning App it is possible to automatically add and remove DECT devices via IPUI provisioning on the Gigaset Nx70 IP DECT.
In addition, the LDAP configuration can be provisioned.

== Provided APIs ==




* Websocket
* AdminApi
* TableUsers
* Services

==Licensing==


No license is required for this app

==Prerequisites==


None (at least knowledge about installing an App on the AP Platform and adding the App Object via PBX Manager)

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5

===Application versions used for interop testing===


* Gigaset Provisioning-App - 13R3 136017
* Gigaset Provisioning-App - 13R2 132017

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5
* Gigaset Nx70 V2.49.1

==Configuration==




===Install the App===

===Gigaset - Provisoning - App===

As an admin, create the environment settings in the Gigaset Provisioning App.
For the innovaphone PBX, enter the domain, the IP address of the PBX or the FQDN and the PBX password.
For the Gigaset Nx70 IP DECT Pro, enter the MAC ID (MAC address plus 4-digit code, can be found on the web UI under Status or on the integrator's box),
the IP address of the integrator and the admin password and select the DECT frequency.
If the Admin Password does not match the one assigned, it would be overwritten in the next step, during the 1st provisioning with the one entered here.

Under Phonebook settings you can activate the sync of the standard LDAP directory of the innovaphone PBX (PBX0).
or alternatively enter all parameters manually according to the LDAP server used.
Please enter the IP address, port and previously created access data for the innovaphone LDAP.

Click on the Save icon to save the entered configuration. The app generates a provisioning path from the data.
This path does not change as long as you do not change the MAC-ID.
Copy this path and paste it on the Gigaset Integrator under Settings --> System --> Provisioning and configuration.
Execute the first provisioning via the button "Start Auto Configuration" and log out of the web interface,
because as long as you are logged in, no provisioning can be performed by the app!

[[Image:innovaphone_GigasetApp_Admin.png]]

===Add Devices to User===

Now create new end devices as usual via UserAdmin or the Profile app. Select "Gigaset" in the manufacturer selection field and then enter the IPUI of the handset instead of the MAC address.
You can find the IPUI of the handset on the box, in the battery compartment or by switching to the menu on the handset with the right button and typing "*#06#".
Now the IPUI is displayed in the top line.

After you have saved the new handset, Gigaset Provisioning will automatically transfer the account to the integrator and start the login window for 5 minutes.
Now you can register the new handset with the default PIN "0000".

If you want to trigger provisioning again, e.g. to open the login window again, press the Save button in the Admin area of the Gigaset Provisioning app again.
The successful transfer is indicated by a message.
If the provisioning was not successful, this is also displayed.
This can have 2 reasons, either you are still logged in on the integrator in the background
or you have changed the admin password on the integrator in the meantime and have not stored the new one in the settings of the app.

[[Image:innovaphone_GigasetApp_User.png]]

==Know Restrictions==
===Display Name mandatory===
The app does not use the Long Name if Display Name is empty as commonly known from Innovaphone. If there is no Display Name the number will be used.

===Option Reverse Proxy will not be set automatically by provisioning===
If the clients should register over a Reverse Proxy you need to set this option manually. It's necessary to use RTP over the TURN because this option of V13r3 only works for devices registered over a Reverse Proxy (PBX - Config - General - Media relay endpoints - TURN = checked).

==Contact==
Gigaset Communications GmbH 
Frankenstraße 2 
46395 Bocholt

Tel: +49 2871 91-0 
E-Mail: de.pro@gigaset.com

'''Support''' 
+49 (89) 8780 6575 + PIN Code 
support@gigaset.com

'''Become a partner''' 
https://gigasetportal.force.com/Partner

'''App Feature Request''' 
Dennis Zimmermann 
Technical Sales Manager 
dennis.zimmermann@gigaset.com

Howto:Gigaset-Provisioning-App - Gigaset - Partner App

2023-01-23T12:42:53Z

Muschelpuster: /* Display Name mandantory */

[[Image:Gigaset-logo.png||200px|right]]

==Product Name==


[https://www.gigaset.com Gigaset] Gigaset-Provisioning-App

==Certification Status==



{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed December 2022.

==Category==

[[Category:Partner_Apps|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:Gigaset-LOGO.png|150px]]



With innovative communication solutions from Gigaset professional, your organisation can unlock its true potential and stay ahead of the competition.
Our cutting-edge telephony technology is delivered by a community of dedicated partners that can help you create a complete communications solution rather than a multitude of products.
With Gigaset professional, you gain access to an open platform designed for its user-friendliness, flexibility and outstanding performance, while offering seamless compatibility with leading on-premise telephony systems and cloud-based service providers.

[https://www.gigaset.com/pro/en_en/ Gigaset - Pro]

==Description==



<table>
<tr>
<tr>
<td colspan="5">Gigaset-Provisioning App supports:</td>
</tr>
<td colspan="5">DECT IP PRO</td>
</tr>
<tr>
<td>N870 [[Image:N870.png‎|250px]]</td>
<td>
- IP DECT Multicell System 
- max. number basestations: 6000 
- max. number handsets: 20000 
- max. number parallel Calls: 6000 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N870 N870]
 
<td></td>
<td>N670 [[Image:N670_Mini_Multicell_EN.png‎|250px]]</td>
<td>
- IP DECT Singlecell and Mini-Multicell System 
- max. number basestations: 3 
- max. number handsets: 20 
- max. number parallel Calls: 8 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N670 N670]
 
</tr>
</table>



The Gigaset Provisioning App integrates the Gigaset Single-, MiniMulti and Multicell Systems into the innovaphone PBX environment.
After the initial setup, user and phonebook management can be done from the innovaphone myApps environment,
so that no further activities need to be performed on the Gigaset system.

==Functions==




* Add / Remove Gigaset handset
* Configure the Phonebook on Gigaset Environment

With the Gigaset Provisioning App it is possible to automatically add and remove DECT devices via IPUI provisioning on the Gigaset Nx70 IP DECT.
In addition, the LDAP configuration can be provisioned.

== Provided APIs ==




* Websocket
* AdminApi
* TableUsers
* Services

==Licensing==


No license is required for this app

==Prerequisites==


None (at least knowledge about installing an App on the AP Platform and adding the App Object via PBX Manager)

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5

===Application versions used for interop testing===


* Gigaset Provisioning-App - 13R3 136017
* Gigaset Provisioning-App - 13R2 132017

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5
* Gigaset Nx70 V2.49.1

==Configuration==




===Install the App===

===Gigaset - Provisoning - App===

As an admin, create the environment settings in the Gigaset Provisioning App.
For the innovaphone PBX, enter the domain, the IP address of the PBX or the FQDN and the PBX password.
For the Gigaset Nx70 IP DECT Pro, enter the MAC ID (MAC address plus 4-digit code, can be found on the web UI under Status or on the integrator's box),
the IP address of the integrator and the admin password and select the DECT frequency.
If the Admin Password does not match the one assigned, it would be overwritten in the next step, during the 1st provisioning with the one entered here.

Under Phonebook settings you can activate the sync of the standard LDAP directory of the innovaphone PBX (PBX0).
or alternatively enter all parameters manually according to the LDAP server used.
Please enter the IP address, port and previously created access data for the innovaphone LDAP.

Click on the Save icon to save the entered configuration. The app generates a provisioning path from the data.
This path does not change as long as you do not change the MAC-ID.
Copy this path and paste it on the Gigaset Integrator under Settings --> System --> Provisioning and configuration.
Execute the first provisioning via the button "Start Auto Configuration" and log out of the web interface,
because as long as you are logged in, no provisioning can be performed by the app!

[[Image:innovaphone_GigasetApp_Admin.png]]

===Add Devices to User===

Now create new end devices as usual via UserAdmin or the Profile app. Select "Gigaset" in the manufacturer selection field and then enter the IPUI of the handset instead of the MAC address.
You can find the IPUI of the handset on the box, in the battery compartment or by switching to the menu on the handset with the right button and typing "*#06#".
Now the IPUI is displayed in the top line.

After you have saved the new handset, Gigaset Provisioning will automatically transfer the account to the integrator and start the login window for 5 minutes.
Now you can register the new handset with the default PIN "0000".

If you want to trigger provisioning again, e.g. to open the login window again, press the Save button in the Admin area of the Gigaset Provisioning app again.
The successful transfer is indicated by a message.
If the provisioning was not successful, this is also displayed.
This can have 2 reasons, either you are still logged in on the integrator in the background
or you have changed the admin password on the integrator in the meantime and have not stored the new one in the settings of the app.

[[Image:innovaphone_GigasetApp_User.png]]

==Know Restrictions==
===Display Name mandatory===
The app does not use the Long Name if Display Name is empty as commonly known from Innovaphone. If there is no Display Name the number will be used.

===Option Reverse Proxy will not be set automatically by provisioning===
If the clients should register over a Reverse Proxy you need to set this option manually. It's necessary to use RTP over the TURN because this option of V13r3 only works for devices registered over a Reverse Proxy (PBX - Config - General - Media relay endpoints) TURN = checked).

==Contact==
Gigaset Communications GmbH 
Frankenstraße 2 
46395 Bocholt

Tel: +49 2871 91-0 
E-Mail: de.pro@gigaset.com

'''Support''' 
+49 (89) 8780 6575 + PIN Code 
support@gigaset.com

'''Become a partner''' 
https://gigasetportal.force.com/Partner

'''App Feature Request''' 
Dennis Zimmermann 
Technical Sales Manager 
dennis.zimmermann@gigaset.com

Howto:Gigaset-Provisioning-App - Gigaset - Partner App

2023-01-23T12:41:57Z

Muschelpuster: added Known Restrictions

[[Image:Gigaset-logo.png||200px|right]]

==Product Name==


[https://www.gigaset.com Gigaset] Gigaset-Provisioning-App

==Certification Status==



{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed December 2022.

==Category==

[[Category:Partner_Apps|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:Gigaset-LOGO.png|150px]]



With innovative communication solutions from Gigaset professional, your organisation can unlock its true potential and stay ahead of the competition.
Our cutting-edge telephony technology is delivered by a community of dedicated partners that can help you create a complete communications solution rather than a multitude of products.
With Gigaset professional, you gain access to an open platform designed for its user-friendliness, flexibility and outstanding performance, while offering seamless compatibility with leading on-premise telephony systems and cloud-based service providers.

[https://www.gigaset.com/pro/en_en/ Gigaset - Pro]

==Description==



<table>
<tr>
<tr>
<td colspan="5">Gigaset-Provisioning App supports:</td>
</tr>
<td colspan="5">DECT IP PRO</td>
</tr>
<tr>
<td>N870 [[Image:N870.png‎|250px]]</td>
<td>
- IP DECT Multicell System 
- max. number basestations: 6000 
- max. number handsets: 20000 
- max. number parallel Calls: 6000 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N870 N870]
 
<td></td>
<td>N670 [[Image:N670_Mini_Multicell_EN.png‎|250px]]</td>
<td>
- IP DECT Singlecell and Mini-Multicell System 
- max. number basestations: 3 
- max. number handsets: 20 
- max. number parallel Calls: 8 
for further information see: 
[https://teamwork.gigaset.com/gigawiki/display/GPPPO/N670 N670]
 
</tr>
</table>



The Gigaset Provisioning App integrates the Gigaset Single-, MiniMulti and Multicell Systems into the innovaphone PBX environment.
After the initial setup, user and phonebook management can be done from the innovaphone myApps environment,
so that no further activities need to be performed on the Gigaset system.

==Functions==




* Add / Remove Gigaset handset
* Configure the Phonebook on Gigaset Environment

With the Gigaset Provisioning App it is possible to automatically add and remove DECT devices via IPUI provisioning on the Gigaset Nx70 IP DECT.
In addition, the LDAP configuration can be provisioned.

== Provided APIs ==




* Websocket
* AdminApi
* TableUsers
* Services

==Licensing==


No license is required for this app

==Prerequisites==


None (at least knowledge about installing an App on the AP Platform and adding the App Object via PBX Manager)

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5

===Application versions used for interop testing===


* Gigaset Provisioning-App - 13R3 136017
* Gigaset Provisioning-App - 13R2 132017

* innovaphone V13r2 SR19
* innovaphone V13r3 Beta5
* Gigaset Nx70 V2.49.1

==Configuration==




===Install the App===

===Gigaset - Provisoning - App===

As an admin, create the environment settings in the Gigaset Provisioning App.
For the innovaphone PBX, enter the domain, the IP address of the PBX or the FQDN and the PBX password.
For the Gigaset Nx70 IP DECT Pro, enter the MAC ID (MAC address plus 4-digit code, can be found on the web UI under Status or on the integrator's box),
the IP address of the integrator and the admin password and select the DECT frequency.
If the Admin Password does not match the one assigned, it would be overwritten in the next step, during the 1st provisioning with the one entered here.

Under Phonebook settings you can activate the sync of the standard LDAP directory of the innovaphone PBX (PBX0).
or alternatively enter all parameters manually according to the LDAP server used.
Please enter the IP address, port and previously created access data for the innovaphone LDAP.

Click on the Save icon to save the entered configuration. The app generates a provisioning path from the data.
This path does not change as long as you do not change the MAC-ID.
Copy this path and paste it on the Gigaset Integrator under Settings --> System --> Provisioning and configuration.
Execute the first provisioning via the button "Start Auto Configuration" and log out of the web interface,
because as long as you are logged in, no provisioning can be performed by the app!

[[Image:innovaphone_GigasetApp_Admin.png]]

===Add Devices to User===

Now create new end devices as usual via UserAdmin or the Profile app. Select "Gigaset" in the manufacturer selection field and then enter the IPUI of the handset instead of the MAC address.
You can find the IPUI of the handset on the box, in the battery compartment or by switching to the menu on the handset with the right button and typing "*#06#".
Now the IPUI is displayed in the top line.

After you have saved the new handset, Gigaset Provisioning will automatically transfer the account to the integrator and start the login window for 5 minutes.
Now you can register the new handset with the default PIN "0000".

If you want to trigger provisioning again, e.g. to open the login window again, press the Save button in the Admin area of the Gigaset Provisioning app again.
The successful transfer is indicated by a message.
If the provisioning was not successful, this is also displayed.
This can have 2 reasons, either you are still logged in on the integrator in the background
or you have changed the admin password on the integrator in the meantime and have not stored the new one in the settings of the app.

[[Image:innovaphone_GigasetApp_User.png]]

==Know Restrictions==
===Display Name mandantory===
The app does not use the Long Name if Display Name is empty as commonly known from Innovaphone. If there is no Display Name the number will be used.

===Option Reverse Proxy will not be set automatically by provisioning===
If the clients should register over a Reverse Proxy you need to set this option manually. It's necessary to use RTP over the TURN because this option of V13r3 only works for devices registered over a Reverse Proxy (PBX - Config - General - Media relay endpoints) TURN = checked).

==Contact==
Gigaset Communications GmbH 
Frankenstraße 2 
46395 Bocholt

Tel: +49 2871 91-0 
E-Mail: de.pro@gigaset.com

'''Support''' 
+49 (89) 8780 6575 + PIN Code 
support@gigaset.com

'''Become a partner''' 
https://gigasetportal.force.com/Partner

'''App Feature Request''' 
Dennis Zimmermann 
Technical Sales Manager 
dennis.zimmermann@gigaset.com

Reference9:Maintenance/Upload/DRAM

2022-12-23T21:54:14Z

Muschelpuster: /* Known Problems */

This function allows you to upload a new '''firmware''' version into the DRAM of the VoIP device. The new firmware is started immediately after upload.

The firmware loaded to DRAM is active until the next reset, power cycle or trap.

This function can be used to test new firmware.

=== Known Problems ===

If you use IP200A, IP230, IP240, IP302, IP305, IP22, IP24 or IP28 you have to set the unit into the Bootcode Mode. You can find the Bootcode Mode under the reset tab. If you did not set the bootcode mode, the device trap.

Howto13r3:Firmware Upgrade V13r2 V13r3

2022-12-22T07:00:52Z

Muschelpuster: /* Flash Memory */

{{FIXME|reason=This article is still work in progress}}
== Applies To ==
This information applies to:

* All 13r3 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 13r3, see [[Howto:Firmware Upgrade]]

== Migration Policy ==
Here is how you upgrade a system to 13r3 from 13r2. For hints on upgrading a system to 13r2 see [[Howto:V13_Firmware_Upgrade_V13r1_V13r2]].

=== Single AP/Single PBX===
* Create a new update job in devices and select 13r3 as major version

===Shared AP/Several PBX'es===
We generally recommend to upgrade the entire system (endpoints, PBXs, AP) in ''one shot''.

If this is not possible for any reason, the recommended sequence is:
# update the master PBX
# update the slave PBX and all its endpoints location by location
# update the App Platform to the latest build (currently 110019)
# update all Apps
# perform the configuration changes described below

Note that during the update time frame, some App data such as Reporting and Recording may be incomplete.

We recommend to review all the configuration changes described below before you begin the update.

== Configuration Changes ==
In 13r3 we have introduced some new features which are automatically configured if you use the installer to setup your new 13r3 from scratch. If you upgrade an existing installation, you have to configure the following settings manually.

=== Default SRTP key exchange value in device configuration of Phones/Interfaces ===
Before v13r3, the default value for SRTP key exchange was SDES-DTLS - with v13r3 it changes to the more secure DTLS-SDES. Therefore innovaphone devices now use DTLS instead - if the called endpoint has this preference. To make sure the more secure key exchange is used, we recommend adjusting the ''SRTP key exchange setting'' in the Devices App, ''Device Configuration'' for ''[Phone]'' and ''[Analog phone/fax]''. An exception to this recommendation is if you are using old phone models (IP110A, IP240A) or gateway models (IP24, IP22) in your setup - as these may have CPU performance issues in the connection setup phase. In that case, use '''SDES-DTLS''' as value for the ''SRTP key exchange'' for all devices, not only for the old phone models.

===Group Fax===
The fax object has to be configured as external resource of a group fax object in 13r3. It is therefore '''mandatory''' to assign the fax object as an external resource to all group fax objects after the upgrade.

Also, with 13r3, group faxes can have their own international fax number and company name, so you should fill in these fields, or else the fax header will be empty.

===Contacts App | User drop-down menu for sharing address books===
With 13r3, personal address books can be created and shared with users/groups. To have a search and drop-down menu in the sharing step, you have to activate the "Admin" option at the "ContactsApi" app object (tab "App") over the Advanced UI. Otherwise, no results will be shown, and you have to enter the correct h323 name of a user.

===Improved Conference Rooms===
* The ''Web Access allowed'' checkbox in the conference app has to be set in order to access the Conference Web Access UI.
: To be able create HTTP links for external participants, the conferencing App is required.
* Update the [[Reference13r3:PBX/Objects/Conference/Announcement_types#Sample_Announcement_Files | announcements]] for your conference rooms, to include also the ''Web Access announcements''.
* it is recommended to use a second Turn-Server listening on TCP port 443 as a fallback option for external conference participants, with local firewalls not allowing access to your standard Turn-server. Configure this second Turn-Server in [[Reference13r3:IP4/General/STUN#TURN_Extern | IP4/General/STUN -> Turn Extern]] [[User:Sga|Sga]] TBD: info zu inno Turn Fallback server
* 13r3 adds a search-API for the Conference Rooms, allowing users to search for Conference room names from their Phone, Softphone or RCC App. Each conference object provides its own search API which is named like ''<Name-of-conference-object>.search'' and access to it can be granted using the App-Section of a PBX-object. The PBX-Manager Plugin for Conferences offers also an option to add the rights for all conference rooms and their search-APIs to the Config-User and/or Config-Admin template.

=== NTLM/OAuth===
13r3 introduces OAuth2 Windows Authentication for myApps. If your are currently using NTLM/Netlogon for authentication, you might want to consider upgrading it OAuth2, since this authentication mechanisms is more secure. See [[Reference13r3:Concept OAuth2 Windows Authentication]] for details.
In 13r3 only Microsoft AD FS is supported as OpenID Server.

===HTTP-Proxy===
13r3 introduces [[Reference13r3:Concept_myApps_platform_services#HTTP_proxy_support | HTTP-Proxy]] support for myApps. Now, myApps follows by default the OS-settings regarding HTTP-Proxy. This might affect existing setups when updating from 13r2 to 13r3. We recommend to check before a 13r3 update if an HTTP-Proxy is used and if so, test before the update for interop problems between myApps and the used HTTP-Proxy.

===Physical Location===
The Softphone App supports in 13r3 the determination of the Physical Location. Similar to an IP-Phone, this is determined automatically based on HTTP-Redirects of the myApps PBX-login process. If you use PBX-objects with activated "Local" option (often this is a Trunk Line object), the determined physical location might lead to a different behavior when calling these objects. If this leads to unwanted call flows, you can either adjust the initial myApps registration PBX or configure the Physical location manually at the Softphone.

== Application Platform and its applications ==
===App Platform image===

It is not mandatory but recommended to [[Reference13r3:Concept_App_Platform#Update_of_the_App_Platform_itself | update the App Platform image]] to the latest version to receive a newer kernel and updated Linux packages.

===Recordings App===
Please follow the procedure described in the [[Reference13r3:Concept_App_Service_Recordings#Upgrade_from_V13r2_to_V13r3_Recordings_App | Recordings App concept article]].

===Reports App===
The Reports App will improve missed calls queries by adding a new database index during the first start after an update. Depending on the size of the reporting database, this database adjustment can take some minutes and results also in high CPU-load and missed CDRs during that time.

=== App Service Queues, Switchboard App ===
To allow monitoring of all queues by all switchboard users, configure a group (e.g. with the name ''queues'') in the PBX and assign it as '''Static''' to all Waiting Queues used by the Switchboard App and assign it also as '''Static''' and '''Active''' to all Switchboard Users.

===Apps new in 13r3===
New Apps will not be installed automatically by the 13r2 to 13r3 upgrade. The installation description of new 13r3 apps is usually in the concept article. New apps are:
* [[Reference13r3:Concept_App_Service_Connector_for_kuando®#Configuration | Connector for kuando®]]
* [[Reference13r3:Concept_App_Service_Connector_for_Microsoft_365 | innovaphone myApps Connector for Microsoft 365]]

== Changes visible to end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a 13r3 upgrade, as the change will be visible/audible in the behaviour of the application/device.
===Rework of Phone & Softphone UI===
Several feature and UI improvements, see 'Features' in [[Reference13r3:Concept_App_SoftphoneApp#Features | Reference13r3:Concept App SoftphoneApp ]] and [[Reference13r3:Concept Multi-Video-Conference]].

===CallForwarding in Profile App===
Added configuration option on call diversions: call forwardings depending on ''myApps online'' and ''Presence'' state. This can be switched on or off by the user in the Profile App.

===Focus App===
The "App focus" can be used to define a default app for the user. It is started and shown automatically when myApps is loaded. When closing other apps, the app is shown instead of the home screen. Users can activate (default) or deactivate the Focus function in their myApps Client settings (hamburger menu). See 'Features' in [[Reference13r3:Concept_myApps#Features | Reference13r3:Concept myApps]]

===Pin Apps===
Apps can be pinned to the main window. Pinned apps are always running and can't be closed. They are also started automatically when the myApps client is loaded. This setting is locally stored per-client. So you can pin different apps on your computer and your smartphone. See 'Features' in [[Reference13r3:Concept_myApps#Features | Reference13r3:Concept myApps]]

=== Fax App ===
The [[Reference13r3:Concept_App_Service_Fax#Mail_Configuration | Mail Configuration]] section of the Fax App offers in 13r3 additional options:
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF
* Error notifications for outgoing fax jobs

==Hardware Restrictions==
For a list of devices with no/restricted support in 13r3, see the [[Howto:Firmware_Upgrade#Version_13r3 | Firmware Upgrade article]].

==Known Problems==
===Boolean App===
Following the update to 13r3, it is not possible to edit Boolean Apps using the myApps client (except when using the myApps client in a web browser). To resolve this issue, you will need to delete the approxy folder for all users who use the boolean app. You can locate this folder in the following directory: %USERPROFILE%\AppData\Local\innovaphone\myApps.
Reload or restart myApps afterwards.

=== Resources Considerations ===
New firmware always has more features which in turn requires more resources. Growing firmware will thus consume both more flash and RAM for sure. A given system configuration will run flawlessly after a firmware largely only if there is still enough memory left after boot.

Standard configurations which are according [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported | the specs ]] will run on all supported hardware. However, unusual configurations may not. It is a good idea to examine both flash and RAM memory left on high load situations in your existing configuration to see if there is enough resources left for an upgrade. Please find details in [[Reference:Device Health Check]].

==== RAM ====
As a rough rule of thumb, a 13r3 release will consume the same amount of RAM compared to a v13r2 firmware.

==== Flash Memory ====
As a rough rule of thumb, a v13r3 release will consume ~ 0.5 MB flash more compared to a v13r2 firmware.

New firmware comes with new code for new features which consumes more flash memory for the firmware image. For this reason, devices may run out of flash memory during upgrade to v13r3. Here is the recommended procedure for upgrade on such devices:

* save entire configuration
* reset to factory defaults
* load saved configuration (this will reorganize the flash memory usage)
* upgrade to new firmware

When there is still not enough flash memory available to store the new firmware (Web GUI ends up in a ''Firmwareupdate failed:no space'' / Update client end in a ''Error 0x00130001 Major FLASHMAN0 no space'' event) please open a support case with your current configuration file.

==== Conferences ====
Since Conferences now use [[Reference13r3:Concept_Multi-Video-Conference | multiple video streams]] to display each conference participant (in 13r1 & 13r2 only the video stream of the speaker was shown), the number of concurrent video streams used in a single conference increased dramatically. Please review this [[Reference13r3:Concept_Multi-Video-Conference#Bandwidth_Consideration | bandwidth considerations]]. As a result, a device hosting a multivideo conference on its CONF or SCNF interface has a higher CPU load in 13r3 than in 13r2.

[[Image:13r3_conference_bandwidth.png|700px|Estimated Conference bandwidth requirements]]

The graph shows the bandwidth needed for a device running the CONF interface to participate in a conference. The values shown are for when all participants are in gallery mode (which is the worst case scenario) and in fullscreen presentation mode (which is the best case scenario). In general, the actual bandwidth needed will fall somewhere between these two extremes. To calculate the CPU requirements for the device, you can use the following formula: CPU% = Bandwidth (in Mbps) / x, where x is 0.42 for a xx10 device, 0.56 for a xx11 device, and 3.6 for a xx13 device. For example, if you are hosting a conference with 10 participants on a xx11 device in gallery mode, the upstream and downstream bandwidth would be 25 Mbps. Using the formula, you can calculate the CPU requirements as follows: CPU% = 25 Mbps / 0.56 = 44.64%. This means that the device should have at least 45% free CPU capacity to handle the conference.

From the client's perspective, the worst case values for upstream bandwidth (when presenting) would be 1 Mbps, and for downstream bandwidth (when in a gallery mode conference with 20 participants) would be 5 Mbps.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]

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

Reference13r2:Apps/PbxManager/Explorer

2022-12-16T13:40:25Z

Muschelpuster: /* Disable all forkings with app rcc at node 'Testnode' */

Reference13r2:Apps/PbxManager/Explorer

2022-12-16T13:38:06Z

Muschelpuster: /* Securing it with boolean object 'alwaystrue' */

Reference13r2:Apps/PbxManager/Explorer

2022-12-15T16:44:26Z

Muschelpuster: /* Give all phones without app the app phone */

Reference13r2:Apps/PbxManager/Explorer

2022-12-15T16:37:46Z

Muschelpuster: /* Give all phones without app the app phone */

Reference13r2:Apps/PbxManager/Explorer

2022-12-10T12:03:19Z

Muschelpuster: /*Give Reverse Proxy flag*/

Reference13r2:Apps/PbxManager/Explorer

2022-12-09T21:22:26Z

Muschelpuster: /* Set a cfnr to 88 for all users with 'T' as first letter in name */

Reference13r2:Apps/PbxManager/Explorer

2022-12-09T21:22:12Z

Muschelpuster: /* Remove the Flag 'TLS only' from all user devices */

Reference13r2:Apps/PbxManager/Explorer

2022-12-09T21:19:56Z

Muschelpuster: /*CFNR for users by name */

Reference13r2:Apps/PbxManager/Explorer

2022-12-09T13:14:25Z

Muschelpuster: /* Examples */

Reference13r2:Apps/PbxManager/Explorer

2022-12-09T13:09:25Z

Muschelpuster: /* Links*/

Reference13r2:Apps/PbxManager/Explorer

2022-12-09T13:02:19Z

Muschelpuster: /* Examples */

Howto:DE - Deutsche Telekom - CompanyFlex TCP SIP-Provider (2020)

2022-10-11T05:09:07Z

Muschelpuster: /* Multi Location */

== Summary ==
{{Template:SIP_TEST_STATUS_complete|update=November 19th, 2020|url=https://geschaeftskunden.telekom.de/internet-dsl/tarife/festnetz-internet-dsl/companyflex|productname=CompanyFlex Complete TCP|providername=Deutsche_Telekom}}

<internal>Provider SBC: BroadWorks</internal>

Note: For security reasons, Telekom limits all of your SIP Trunks, CompanyFlex connection allows several TCP sessions, but there are limits on messages per second based on a source IP address.

=== {{SIP_TEST_ISSUES_MR_TITLE}} ===
{{SIP_TEST_ISSUES_MR_INTRO}}
; CLIR : {{SIP_TEST_FACT_CLIR}}
; EARLY MEDIA INBOUND : {{SIP_TEST_FACT_EARLY MEDIA INBOUND}}
; FAX T38 ONNET : {{SIP_TEST_FACT_FAX T38 ONNET}}
; FAX T38 : {{SIP_TEST_FACT_FAX T38}}

{{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}} ===
; Registration : {{Template:SIP_Profile_Test_Registration_TCP_no_UDP}}

; NAT Traversal : {{Template:SIP_Profile_Test_NAT_a_no_c}}

; DTMF (RFC2833) : {{Template:SIP_Profile_Test_DTMF_RFC2833_yes}}

; Session Timer : {{Template:SIP_Profile_Test_EXPIRES_yes}}

; Redundancy : {{Template:SIP_Profile_Test_REDUNDANCY_no}}

; Correct signalling of Ringing-state : {{Template:SIP_Profile_Test_RINGING_yes}}

; CLIR : {{Template:SIP_Profile_Test_CLIR_no}}

; Clip No Screening (CLNS) : {{Template:SIP_Profile_Test_CLNS_yes}} {{Template:SIP_Profile_Test_CLNS_clns_302_not_recommended}}

; 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_no}}

; Fax : {{Template:SIP_Profile_Test_AUDIOFAX_PSTN_yes}}
: {{Template:SIP_Profile_Test_T38_PSTN_no_onnet_no_fallback_yes}}

; Codecs : supported to/from PSTN: G711A
: supported onnet (VoIP to VoIP): G711A, G711U and G722

; 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}}

; SRTP : {{Template:SIP_Profile_Test_SRTP_no}}

; Dialing of Subscriber Numbers : {{Template:SIP_Profile_Test_SUBSCRIBER_NR_no}}

; Call Transfer : {{Template:SIP_Profile_Test_CALL_TRANSFER_ok}}

==Configuration==
Use profile ''DE-Deutsche_Telekom-CompanyFlex_TCP'' in ''Gateway/Interfaces/SIP'' to configure this SIP provider.

Please note the following configuration hints:
* <nowiki>Dialling of subscriber numbers not possible, 'Dialing Location' must be configured without 'Area Code'</nowiki>

: {{SIP_TEST_V12_HINT}}

==Multi Location==
It's possible to have different MSNs and DDIs from different locations on the same trunk. But this is limited to 60 number objects. A number object is an MSN or the first DDI digit. So a complete DDI block from 0 to 9 (0-99 or 0-999) is counted as 10 number objects.

== Disclaimer ==
{{SIP_TEST_PREFACE}}

[[Category:Compat|{{PAGENAME}}]]
[[Category:3rdParty SIP Provider|{{PAGENAME}}]]

Howto:DE - Deutsche Telekom - CompanyFlex TLS SIP-Provider (2020)

2022-10-11T05:08:19Z

Muschelpuster: /* Multi Location */

== Summary ==
{{Template:SIP_TEST_STATUS_complete|update=November 19th, 2020|url=https://geschaeftskunden.telekom.de/internet-dsl/tarife/festnetz-internet-dsl/companyflex|productname=CompanyFlex_TLS|providername=Deutsche_Telekom}}
<internal>Provider SBC: BroadWorks</internal>

=== {{SIP_TEST_ISSUES_MR_TITLE}} ===
{{SIP_TEST_ISSUES_MR_INTRO}}
; CLIR : {{SIP_TEST_FACT_CLIR}}
; EARLY MEDIA INBOUND : {{SIP_TEST_FACT_EARLY MEDIA INBOUND}}
; FAX T38 ONNET : {{SIP_TEST_FACT_FAX T38 ONNET}}
; FAX T38 : {{SIP_TEST_FACT_FAX T38}}
; FAX T38ANDAUDIO : {{SIP_TEST_FACT_FAX T38ANDAUDIO}}
; SDP VIDEO : {{SIP_TEST_FACT_SDP VIDEO}}
; 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}} ===
; Registration : {{Template:SIP_Profile_Test_Registration_TCP_no_UDP}}

; NAT Traversal : {{Template:SIP_Profile_Test_NAT_a_no_c}}

; DTMF (RFC2833) : {{Template:SIP_Profile_Test_DTMF_RFC2833_yes}}

; Session Timer : {{Template:SIP_Profile_Test_EXPIRES_yes}}

; Redundancy : {{Template:SIP_Profile_Test_REDUNDANCY_no}}

; Correct signalling of Ringing-state : {{Template:SIP_Profile_Test_RINGING_yes}}

; CLIR : {{Template:SIP_Profile_Test_CLIR_no}}

; Clip No Screening (CLNS) : {{Template:SIP_Profile_Test_CLNS_yes}} {{Template:SIP_Profile_Test_CLNS_clns_302_not_recommended}}

; 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_no}}

; Fax : {{Template:SIP_Profile_Test_AUDIOFAX_PSTN_yes}}
: {{Template:SIP_Profile_Test_T38_PSTN_no_onnet_no_fallback_no}}

; Codecs : supported to/from PSTN: G711A
: supported onnet (VoIP to VoIP): G711A, G711U and G722

; 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}}

; SRTP : {{Template:SIP_Profile_Test_SRTP_yes}}

; Dialing of Subscriber Numbers : {{Template:SIP_Profile_Test_SUBSCRIBER_NR_no}}

; Call Transfer : {{Template:SIP_Profile_Test_CALL_TRANSFER_ok}}

==Configuration==
Use profile ''DE-Deutsche_Telekom-CompanyFlex_TLS'' in ''Gateway/Interfaces/SIP'' to configure this SIP provider.

Please note the following configuration hints:
* <nowiki>If you intend to use SIPS (SIP/TLS) registration, you need to add the ' TeleSec ServerPass Class 2 CA' certificate to the trust list of your SBC</nowiki>
* <nowiki>Dialling of subscriber numbers not possible, 'Dialing Location' must be configured without 'Area Code'</nowiki>

: {{SIP_TEST_V12_HINT}}

==Multi Location==
It's possible to have different MSNs and DDIs from different locations on the same trunk. But this is limited to 60 number objects. A number object is an MSN or the first DDI digit. So a complete DDI block from 0 to 9 (0-99 or 0-999) is counted as 10 number objects.

== Disclaimer ==
{{SIP_TEST_PREFACE}}

[[Category:Compat|{{PAGENAME}}]]
[[Category:3rdParty SIP Provider|{{PAGENAME}}]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2022-04-13T11:20:52Z

Muschelpuster: /* Known Problems */

[[Image:3rdPartyGoldfischglas 03.png|right]]
==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Service Contacts#Upload Data by HTTP Post|Concept App Service Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

==Setting up LibreOffice==
* Depending on your security settings for executing macros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the visible sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the columns as they are. At hidden row 2 is the headline as used in export for debugging reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there is a few information needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers, and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the descriptions of the setting values and a notice on every cell which describes the value with a few words. At column B you have to enter the values and you will find a notice with a short German description.

====ImportData====
This table will be filled by the Upload-Macro and exported. Off course this can also be hidden, but not with the latest version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know your improvements.
Here it is important, that the row 1 is not modified, because this is not touched by the macro. So to make it a little safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in German. You don't need this sheet, so there was no need to translate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will be saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now, the clipboard will be filled with an empty cell and the document will be saved at its original name as ODS-file.
Now the macro creates a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be addressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the script is deleting the import.utf8 and itself to prevent files with the credentials and contacts at the folder. The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the macro now you see the data-file upload.utf8 and the script-file uploader.cmd in the workspace and you can analyse both files and run uploader.cmd.
You will find some other commented lines (rem print) at the macro, you can uncomment this to get some messages by running the macro.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the current sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear in the settings there is a little security risk. Maybe in the next version there comes a password request if the value is empty, but you know - you can improve it too.
* There is no logical check for the settings, it is up to you to check everything.
* Naturally, because of the use of Windows scripts it will only work on Windows.
* You need at least 2 contacts lines, otherwise the upload fails, but you can improve it too
* Of course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Service Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2022-04-13T11:19:31Z

Muschelpuster: /* Known Problems */

[[Image:3rdPartyGoldfischglas 03.png|right]]
==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Service Contacts#Upload Data by HTTP Post|Concept App Service Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

==Setting up LibreOffice==
* Depending on your security settings for executing macros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the visible sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the columns as they are. At hidden row 2 is the headline as used in export for debugging reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there is a few information needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers, and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the descriptions of the setting values and a notice on every cell which describes the value with a few words. At column B you have to enter the values and you will find a notice with a short German description.

====ImportData====
This table will be filled by the Upload-Macro and exported. Off course this can also be hidden, but not with the latest version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know your improvements.
Here it is important, that the row 1 is not modified, because this is not touched by the macro. So to make it a little safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in German. You don't need this sheet, so there was no need to translate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will be saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now, the clipboard will be filled with an empty cell and the document will be saved at its original name as ODS-file.
Now the macro creates a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be addressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the script is deleting the import.utf8 and itself to prevent files with the credentials and contacts at the folder. The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the macro now you see the data-file upload.utf8 and the script-file uploader.cmd in the workspace and you can analyse both files and run uploader.cmd.
You will find some other commented lines (rem print) at the macro, you can uncomment this to get some messages by running the macro.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the current sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear in the settings there is a little security risk. Maybe in the next version there comes a password request if the value is empty, but you know - you can improve it too.
* There is no logical check for the settings, it is up to you to check everything.
* Naturally, because of the use of Windows scripts it will only work on Windows.
* You need at least 2 contacts-lines, otherwise the upload fails (this is somewhere in the script)
* Of course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Service Contacts]]

Reference13r1:Concept App Platform

2022-01-07T17:20:51Z

Muschelpuster: /* Database */ hint for problems after restart pgsql

= General =
* V13 uses [https://buildroot.org/ buildroot]
* this is an own (innovaphone) collection of packages
* For further information see: [https://buildroot.org/docs.html Buildroot Documentations]

== Requirements ==

* V13 or up
* Gateway (arm): IPx10 (with CF card) or IPx11 (with mSATA SSD)
* Virtual (x86_64)
** HyperV with [https://docs.microsoft.com/de-de/windows-server/virtualization/hyper-v/deploy/upgrade-virtual-machine-version-in-hyper-v-on-windows-or-windows-server#supported-virtual-machine-configuration-versions VM-configuration Version] 6.2 (minimum: Windows 10 or Windows Server 2016)
** VMWare

== Default credentials ==

'''During INSTALL, the default passwords are replaced with the global Admin PW!'''
* SSH-Login with '''admin''' and '''ipapps'''
* root login with '''root''' and '''iplinux''' (the root login is not directly possible, you have to login as admin first and use the command ''su root'')
* manager App (web login) '''pwd'''

= App Platform - arm (Gateway)=

* The installation image has a size of ~50MB. During installation, the following partitions are created:
** /dev/sda1 fat32: 200MB (contains ramdisk, rootfs and kernel)
** /dev/sda2 ext4: depends on disk size (contains databases, log files and apps)
** /dev/sda3 ext4: 500MB (contains the rootfs)
** /dev/sda4 swap: 512MB

When comparing potential performance of the IPxx11 platform compared to the IPxx10 platform, there are some major differences:
* SSDs found in the xx11 are faster and more reliable than the CF found in the xx10
* the available RAM for the AP (as specified in column ''RAM for LAP (GB) out of RAM'' in chapter ''Technical data and recommended number of users supported'' of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|How to implement large PBXs]]) is factor 6 larger on the xx11 (1,536 GB) than on the xx10 (0,256 GB))
* the xx11 has gigabit Ethernet while the xx10 has 100Mbps Ethernet. The xx10 is therefore not well suited for Apps with larger network traffic, such as Recordings
* the CPU of the xx11 (although it runs on the same frequency) is roughly 20% faster than the xx10

While it is hard to predict the performance of the AP in a specific scenario, we see that in a real life environment an AP running on an xx11 platform can well support 150 users. The xx10 platform is estimated to support 120 users. Because CPU performance is the limiting factor, larger setups can be built based on the virtual machine platform (see [[#App_services_and_multi-threading|App services and multi-threading]] below).

= App Platform - x86-64 (Virtual Machine 64bit) =

* The default disk size is 16GB. It should be increased '''before''' the first start if needed!

* Multiple CPUs are supported, default is one CPU

* default RAM: 512MB
* static IP address, DNS, Gateway can be configured with the command '''setip''' on the console. Run '''setip --help''' to get a list of parameters. (Example: setip --addr=x.x.x.x --mask=x.x.x.x --gateway=x.x.x.x --dns1=x.x.x.x)
* If you have permission problems change to su user (Password is iplinux or your new admin password)
* To figure out your ip address you can use the command: ''ip address'' on the console.
* '''loadkeys de''' can be used to change to german keyboard layout (etc.)

* partitions:
** /dev/sda1 ext2: 350MB (contains ramdisk, rootfs and kernel)
** /dev/sda2 ext4: depends on disk size (contains databases, log files and apps)
** /dev/sda3 ext4: 500MB (contains the rootfs)
** /dev/sda4 swap: 512MB

= Installation =
==ARM Gateway==

If you setup a Gateway with the install procedure, the App Platform is installed automatically (Https Download has to be allowed and shouldn't be blocked by any firewall.) 
You can also install it manually:
* Open App Platform -> General and '''Enable Linux Support'''. Restart the gateway.
* You need to enable Proxy-ARP on [[Reference13r1:IP4/ETH/IP|ETH0]] or [[Reference13r1:IP4/ETH/IP|ETH1]], so your Gateway and the Linux Appliance will share the same physical interface.
* Open App Platform -> IP and configure the IP settings of the App Platform. Restart the Gateway.
* Open App Platform -> Installation and select the given version or enter an own path to the ''app-platform-armel.img'' image file.
* The installation runs without any further required step.

==Virtual machine==

* Import the image into your server environment.
* Edit the disk size, if needed.
* Start the machine and wait until it reboots and starts again.
* Note: If you need to access an IP addresses available through a VPN connection from from inside the virtual machine, it could be that you need to set the network of your VM to NAT (and also add the URL for an IP to /etc/hosts)

[https://wiki.innovaphone.com/index.php?title=Reference12r1:Concept_Innovaphone_Virtual_Appliance#Configuration More Configuration Hints regarding VM Ware]

== Backup of the Apps ==

Each App Service can have multiple instances and each instance has its own database. The manager app itself also has its own database. 
There are no other files which need to be backuped. 
The standard way to backup the databases is through the Devices App [[Reference13r1:Concept_App_Service_Devices#Backups]]. 
 
An alternate way is to use a command file which is similar to the command files from the firmware.

===Commands===
* '''times''' 0,12 # backup only at 0 or 12 o'clock
* '''backup-instances''' http://user:pw@ip/path/#I-#D.dump PUT
** PUT and POST are supported, all instances including the manager itself are saved
* '''backup-instance''' http://user:pw@ip/path/#I-#D.dump apidemo example.com PUT
** backup a single instance with instance name and instance domain
* '''backup-manager''' http://user:pw@ip/path/#I-#D.dump

===Hash parameters===
* #L App Platform label (neu), e.g. 10024
* #A App label (neu), e.g. 130004
* #I instance name (neu), e.g. reporting1
* #D instance domain (neu), e.g. innovaphone.com
* #m MAC address of the LAP, e.g. 00ab11eeff
* #d Current date and time (plain UTC without daylight saving and timezone adjustments) 20051010-170130
* #bn rolling backup index
* ## escapes a hash mark

= App Platform Infrastructure and Concept =
== Webserver ==
The app platform includes a webserver that is highly optimized for handling many Websocket connections at a low memory footprint.
All apps use that webserver by registering for specific HTTP subpath. So they can all use the same HTTP/HTTPS ports - typically the standard ports.

=== Import Custom SSL Certificate ===
You have to upload a PEM Certificate with the following chain structure and without password encoding.

-----BEGIN CERTIFICATE-----
(certificate: your_domain_name.crt)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Intermediate certificate: DigiCertCA.crt)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Root certificate: TrustedRoot.crt)
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
(certificate Key: your_domain_name.key)
-----END RSA PRIVATE KEY-----

=== Known issues ===
*The app platform webserver can use only the default http/https ports 80/443.
*By design, there is no possibility to restore the default webserver certificate on the App Platform, if another certificate was once uploaded. 
**If nevertheless needed, you must login with Putty (see [[#How_to_retrieve_files_from_the_AP | Retrieve files]]) and execute these commands as root:
**''psql -d manager -c "DELETE FROM config WHERE name='webserverCertificate'"''
**''/etc/init.d/S92manager restart''
*The app platform webserver interprets URLs case-sensitive. In other words, <nowiki>http://<addr>/file.txt</nowiki> is not the same as <nowiki>http://<addr>/FILE.TXT</nowiki>

== Database ==
The app platform creates a database for each app instance with a given password. In the installer there will be used randomly generated passwords. You can set a new database password for every instance in the Application Platform.

The apps should store all data in that database. That makes sure that a consistent backup and restore of app instances can be done by the app platform manager.
In hosted scenarios, having separate databases for each instance also makes sure that the data of different customers are clearly separated and can easily be moved from one physical platform to another.

The default configuration decline database request from extern. If you need external access you can change the PGSQL configuration (as root) in the file ''/mnt/sda2/pgsql/pg_hba.conf''.
After editing pg_hba.conf, the database-service has to be restarted with the command <code>/etc/init.d/S50postgresql restart</code>
(Please think about it before you do it, because a better way is to create your own local app with local database access.)

You can find the official documentation for the pg_hba.conf here: https://www.postgresql.org/docs/11/auth-pg-hba-conf.html

Sometimes the Apps are not proper working after this. You can wait a while until everything is working again or you go the hard way:
* stop the manager
** <code>/etc/init.d/S92manager stop</code>
* restart the database-service (maybe not really necessary, but makes a good feeling)
**<code>/etc/init.d/S50postgresql restart</code>
* start the manager
** <code>/etc/init.d/S92manager start</code>

== App Platform Manager ==
The App Platform Manager is the central component of the App Platform. It does the following:
* Installing app services by downloading the binaries from an app store.
* Running and monitoring app services. If an app service crashes it is restarted, automatically.
* Management of app instances and providing them with the environment they need:
** A database
** A webserver path
** A password for authentication
* Backup and restore of app instances.
* Collecting debug information like tracing and crash dumps.
* System monitoring (CPU usage, memory usage, etc).

== App Services ==
App services are runned by the App Platform Manager. They implement an interface that is used by the manager to start, stop and configure app instances. Each service runs in a separate child process of the manager.

== App Instances ==
The actual functionality of an app service is provided by app instances. They run in the same process as the app service but have a distinct webserver path and their own database. There can be 0..n instances of an app service. Instances can optionally host (web) apps that can be opened in the myApps client.

Each instance of an App service has two passwords. The instance password itself and a database password. If you want to change it you must update the password on both sides. 
The instance password must match to the password in the corresponding PBX App objects, while one instance can have different App objects. 
The database password must be just known to the manager and not outside of the App Platform.

== Relationship between app instances and app objects in the PBX ==
Typically an app instance is connected to one or more app objects in a customer PBX. This is done by configuring the same parameters on both sides:
* URL
* Password
The password is used by the PBX for authenticating itself, users and services against the app instance.

Some apps need a websocket connection with the PBX. When "websocket" is activated at the app object, the PBX establishes a websocket connection to the app instance and provides the APIs that are configured at the app object.

=== Supported scenarios ===
It is important to understand that the concept does not do any assumptions on how PBXes and APs are correlated. So you can have
* One AP for one customer
* One AP for many customers
* Many APs for one customer
* Many APs for many customers

Attention: The V13 installer can only configure the scenario "''One AP for one customer''". If you want to have a different scenario, you have to configure it manually.

For hosting or cloud scenarios you need special scenarios. Please refer our [[Howto:V13_Hosting| V13 Hosting]] instructions.

=== Restrictions ===
Currently we don't have redundancy for app instances or APs.

== Update of the App Platform itself ==
The App Platform is build on top of buildroot and will receive updates and fixes from time to time. 
You can update the used build inside the Manager App by using the '''Update''' button at the top. 

It is strongly advised to make a full backup (VM) or at least backup all apps (Gateway) before you run such an update!

== App services and multi-threading ==
Each App Service runs in a single process with no multi-threading, independent of the instances of the App Service. However, each instance maintains its own database connection and the database responds to this connect with the creation of a new process. Each app service therefore uses 1+''n'' threads (where ''n'' is the number of instances). All communication between app service instances and their clients must pass the single-threaded web server. On platforms with multi-threading support (i.e. VMware or Hyper-V), up to 1 + ''m'' + ''m'' * ''n'' (with ''m'' being the number of Apps and ''n'' the number of instances per App) threads can be utilized.

= Known Issues =

== Reboot after an image update hangs (ARM gateway) ==

If it happens, that the AP doesn't recover after the reboot, please open the Admin UI of the corresponding gateway and take a look at App Platform -> General. 
If '''Kernel command line''' is set to '''/dev/ram0''', the AP booted the ramdisk. 
Try to login with putty in this case (default credentials admin/ipapps and root/iplinux) and issue this command: 
''cat /apps/install_step1.log'' 
 
If this file contains '''finished''' at the end, you can reconfigure the settings under App Platform -> General: 
* press '''Stop'''
* Initrd file: empty
* Kernel command line: '''root=/dev/sda3'''
* Ramdisk size: empty
* press '''Start'''

The AP should boot and run the already updated image.

= Tracing =
Each App Service has its own log file, which can be accessed through the Manager App. You can configure a log file size for each App Service. 
Each App Intance has its own trace flags. The following trace flags can be set: 

* Alarm client: used by the manager to send alarms to an alarm server
* App: logs from the App Service itself
* App WebSocket: logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
* AppSharing: just native clients
* AppProxy: just native clients, logs requests which are proxied between the local webserver and the remote server
* Audio: just native clients
* Browser: just native clients
* Command: the command interface is used to execute shell commands, e.g. used by the manager App
* Config: logs config changes of an App
* Database: database logs
* DB files: database file logs
* DNS: DNS request logging
* DTLS: just native clients, DTLS request logging
* Ethernet: interface to get ethernet adapater infos, just manager App
* File: logs for file system access (synchronous), e.g. manager App
* Files: logs for file system access (asynchronous)
* HTTP client: http client logs
* HTTP file: logs for static HTTP files
* ICE: just native clients
* LDS: local domain sockets
* Media: just native clients
* Media channel: just native clients
* Process: IProcess interface logs which is used for spawning, killing processes etc.
* SMTP: SMTP client logs
* TCP: TCP logs
* Time: ITime interface logs
* TLS: TLS logs
* TURN: just native clients
* UDP: UDP logs
* Video: just native clients
* WebSocket client: logs outgoing websocket connections
* Webserver traffic: logs incoming HTTP traffic, which is forwarded from the webserver to the App
* WebDAV service: logs WebDAV requests to the App
* Webserver: enables webserver specific logs

== RPCAP ==

If you open the Manager App, click on the Manager in the left list and then on the Diagnostics button, you can enable RPCAP. 
You can add the interface in wireshark with the string:
rpcap://<APP-Platform-IP>/eth0

'''Please don't forget to disable RPCAP after your testing!'''

= How-Tos =

== How to retrieve files from the AP ==
To retrieve files from the AP which can not be retrieved via the AP manager UI, you can connect to the AP using the SCP protocol on port 22.

For example, in WinSCP
* use ''SCP'' as protocol (NB: WebDAV is not supported on most of the directories on the AP)
* use the ''DNS'' name or IP address of your AP (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''/home/admin'' as start directory
* use ''su root'' to be root (''iplinux'' as default password)

You can now copy files to ''/home/admin'' (e.g. from /var/log/apps/manager/...). 

== App Platform/Apps app not online anymore due to full disk ==
If the apps app is not online anymore and you can't access any apps anymore, try to login with an SSH client to see if your disk is full.
Login as admin and afterwards as root (su root). 
 
* issue '''df -h''' and see the disk usage of /dev/sda2, if this is 100%, your disk is too full
* stop the manager
** /etc/init.d/S92manager stop
* empty the 500 MB file, which is exactly for this case here (manager must be 13r1 SR9 or higher to have this file)
** echo "" > /mnt/sda2/empty_if_no_space
* delete log files to recover some space
** rm /var/log/apps/*/*
** rm /var/log/core_dumps/*/*
* restart the postgresql server (see the output if this worked or not)
** /etc/init.d/S50postgresql restart
* restart the manager
** /etc/init.d/S92manager restart
* wait until everything is online again
* open the Apps app and try to find the instance which uses the most disk space and try to delete files/content from it
** you may want to stop all app services first to prevent more writes to the database
** if not possible, you can delete this instance, but you'll loose all data from this instance then!
* after that you can try [[Reference13r1:Concept_App_Platform#Shrink_the_physically_size_of_PostgreSQL_database_files]] to free up space
** If this does not work you can create a backup from the database, delete the database and import the database again.
* free up at least 500 MB so that the manager can create the file again
* delete /mnt/sda2/empty_if_no_space if you are done and restart the manager:
** rm /mnt/sda2/empty_if_no_space
** /etc/init.d/S92manager restart
** the manager restart automatically recreates the empty_if_no_space file if this file doesn't exist

Make sure, that you do '''not''' have backups configured to a local files instance while this files instance is not excluded from backups.
An instance can be excluded from backups in the instance settings in the AP Manager.

If all of this doesn't help, you can resize the file system on a VM:
* proceed with [[Reference13r1:Concept_App_Platform#Resizing_the_disk_of_a_Virtual_machine]]

== Resizing the disk of a Virtual machine ==

* stop the VM
* expand the disk using your VM utilities
* start the VM and boot from the first boot entry '''rescue/setup'''
* login with '''root''' and '''iplinux'''
* execute this command: '''/home/root/install_step1.sh log.txt resize'''
* the VM reboots automatically after a successful resize

== Shrink the physically size of PostgreSQL database files ==
Tuples that are deleted in your databse are not physically removed from the database-file. So the claimed space on the harddisk is still in use after the delete operation.
If you need to free up some disk space you can force to reorganize the physically database-file on your harddisk.

'''Important: You are operating on the Database, you have to make a Backup of your Database before you do this!'''

Login via SSH to the APPlatform with the ''admin'' User
su root
/etc/init.d/S92manager stop # not always needed, but in case of database errors recommended, of course no app is online then
sudo -u postgres reindexdb -a
sudo -u postgres vacuumdb -a -f
/etc/init.d/S92manager restart # just execute if the manager has been stopped above

sudo -u postgres reindexdb -d dbname # for a single database with dbname
sudo -u postgres vacuumdb -d dbname -f # for a single database with dbname

Note: This may take some time and CDRs (or other data written to a DB) won't be received during this time.

After the process you can check the free dispace via <code>df -h</code>. You can check the claimed space from the database file with the command <code>du -sh /mnt/sda2/pgsql/</code>.

== Change IP Addresses / DNS Names / System Name ==

If you want to change the System Name or the DNS Name of the PBX and/or AP Platform you must change records manually '''in the described order'''!
You have to know the Admin password to directly Login to the AP-Plattform.

=== App Platform ===
; Settings - General
* ''Devices app URL''
* ''App platform DNS name''

; Settings - Alarms and Events
* ''URL''

; All Instances
* ''Domain''
* ''Webserver path''

=== PBX ===
Download the configuration and ''search/replace'' in the config file. Upload the config file and reboot.

Manual:
* ''URL'' in all PBX Object (Apps, Voicemail ...)
* [[Reference9:Gateway/CDR|CDRx]]
* [[Reference13r1:PBX/Config/General|IP address for App Platform]]
* [[Reference13r1:PBX/Config/myApps|Reset Password Page]]
* [[Reference13r1:PBX/Config/Authentication|Verification link]]

Depending on your change you have to activate/deactivate the Setting [[Reference13r1:PBX/Config/General|Operation without DNS]]

=== Additional Devices / Steps ===
* ''Devices Registration URL''
* ''Alarm server''
* Reverse Proxy configuration
* Change ''Domain Name'' in Devices if you have also changed the system name

== How to recover from a broken File System ==
Sometimes you may find messages in the ''messages'' log file (in ''var/log'') like

initial error at 1500329378: ext4_journal_start_sb:328
last error at 1500329378: ext4_journal_start_sb:328

Or you get events like "Broken file system" from your AP.

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the App Platform and any applications and restore your backups.

=== Gateway ===

* Open the WebGUI of the gateway running your LAP and proceed to ''App Platform/General''
** terminate Linux (''Status/Stop'')
** modify the Kernel command line from root=/dev/sda3 to root=/dev/ram0
** modify the Initrd file to ramdisk.ext2.xz
** modify the ramdisk size to 100000
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line (user: root, pw: iplinux)
** on the command prompt, use <code>e2fsck -p -f /dev/sda2</code>
** on the command prompt, use <code>e2fsck -p -f /dev/sda3</code>
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''App Platform/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/ram0'' to <code>root=/dev/sda3</code>
** clear the Initrd file field
** clear the ramdisk size field
** start Linux again
:: This will run Linux on the original partition.

=== VM ===

Restart the VM and select the first entry in the boot menu from grub.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line
** on the command prompt, use <code>e2fsck -p -f /dev/sda2</code>
** on the command prompt, use <code>e2fsck -p -f /dev/sda3</code>
:: this should fix any issue on the file system
* Reboot your VM
[[Category:Concept]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T10:29:20Z

Muschelpuster: /* Debugging */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

==Setting up LibreOffice==
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the visible sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevent files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the data-file upload.utf8 and the script-file uploader.cmd in the workspace and you can anlyze both files and run uploader.cmd.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running the macro.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T10:26:48Z

Muschelpuster: /* Macro */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

==Setting up LibreOffice==
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the visible sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevent files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the script-file uploader.cmd in the workspace and you can anlyze and run it.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running it.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T10:23:19Z

Muschelpuster: /* Tables */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

==Setting up LibreOffice==
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the visible sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevant files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the script-file uploader.cmd in the workspace and you can anlyze and run it.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running it.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T10:22:19Z

Muschelpuster: /* Setting up LibreOffice */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

==Setting up LibreOffice==
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevant files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the script-file uploader.cmd in the workspace and you can anlyze and run it.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running it.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T10:21:34Z

Muschelpuster: /* Problem Details */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because they can edit the contacts and have only to click upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

===Setting up LibreOffice===
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevant files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the script-file uploader.cmd in the workspace and you can anlyze and run it.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running it.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T10:19:33Z

Muschelpuster: /* System Requirements */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because the can edit the contacts and have only to klick upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important)
** tested with LibreOffice V5.4
** tested with OpenOffice V4.1
* The ODF-Document from this article

===Setting up LibreOffice===
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevant files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the script-file uploader.cmd in the workspace and you can anlyze and run it.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running it.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]

Howto:Edit and upload contacts at the ContactsApp with Libre Office

2021-01-25T07:13:01Z

Muschelpuster: /* Known Problems */

==Applies To==
This information applies to

* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance.



==Problem Details==
Up from V13 there is with the ContactsApp a nice tool for serving contacts. Unfortunately there is no Contacts-Editor, but there are some customers outside, which have no LDAP-Source and which are not so fit in handling the UTF8-Export/Import.
This project is a try to make it more easy for the customers, because the can edit the contacts and have only to klick upload (if you prepared everything well).

==System Requirements==
* Innovaphone PBX V13 with a running AppPlattform and a running ContactsApp-Instance
* A Windows-PC that supports PowerShell (tested with Win10)
* workspace-folder with write-access on the PC with a real mounted drive (C:, D:...)
* the PowerShell-Script from [[Reference13r1:Concept App Contacts#Upload Data by HTTP Post|Concept App Contacts]] saved as CSV-Import.ps1 and the CURL-Ressources in the workspace-folder
* LibreOffice (portable or installed is not important - tested with V5.4)
* The ODF-Document from this article

===Setting up LibreOffice===
* Depending on your security settings for executing makros you have to adjust this. Put your document-path to the trust-list (Tools -> Options -> LibreOffice -> Macro Security -> Trusted Sources).

==Description of the ODS-file==
===Tables===
The document contains 4 sheets. The 4th sheet is hidden and there is no need to show it. You can edit the name of the sheets, but don't rearange them - the macro needs them in this order.

====PhoneBook====
As you already assumed this is where you edit your contacts. You can customize row 1 and 3, but data has to start at cell A4 and keep the coloums as they are. At hidden row 2 is the headline as used in export for debuggig reasons.

====Settings====
Here is where you set your environment. For starting the PowerShell-Script there are a few informations needed. This is the address (name or IP) of your App-Plattform. Then there is needed the put-user and the password, which you can set in the settings of the ContacsApp at the PBX-Manager.
Additional there is the PBX-Domain needed, on which your instance is running. If you upload a file, the ContacsApp saves the filename and if you upload again you have to use the same filename to update your data and prevent a double data. Here is a problem at many customers and so we write the destination name also in the settings to reduce the trouble here.
At column A you will find the desciptions of the setting values and a notice on every cell which descibes the value with a few words. At column B you have to enter the values and you will find a notice with a short german desciption.

====ImportData====
This table will be filled by the Upload-Macro and exported. Offcourse this can also be hidden, but not with actual version of the macro. If you can improve this feel so free and do it and be so friendly and let us all know youre improvements.
Here it is important, that the row 1 will not modified, because this will not touched by the macro. So to make it a little bit safer it's hidden and you know, you can improve this too.

====Hilfsdaten====
This is the hidden sheet and you see this will be created in german. You don't need this sheet, so there was no need to trsanslate it after creation. It calculates different valus for the macro, because it was the lazy way. Keep it hidden, it looks a little bit chaotic and don't modify it.

===Macro===
Most parts of the macro are recorded, so it's not optimized to a clean programming style. But you know - you can improve it.
The macro jumps to cell A4 of the Phone-Book-sheet, marks all data and copy it to the clipboard. Then it jumps to the sheet Importdata and insert the clipboard-content, with the starting point A2. After this sheet will saved at the workspace with the name upload.utf8. This will be done by the 'Save As' dialogue.
To rescue some ugly things which are done until now the clipboard will be filled with a empty cell and the document will saved at its original name as ODS-file.
Now the macro creats a cmd-file named uploader.cmd at the workspace. It writes some DOS-commands. The correct drive will be adressed and then the script jumps to the workspace-folder and starts the PowerShell-Script CSV-Import.ps1. At the end the sript is deleting the import.utf8 and itselfe to prevant files with the crendentials and contacts at the folder . The output of CSV-Import.ps1 will be saved in a file called upload.log.

==Debugging==
There are some ways to find a problem on this solution. At first have a look at the upload.log which is located in the workspace.
Then you can stop the autorun of the script. Call the Macro-Editor in Libre Office Calc and edit the Basic-Macros. You will find the macro under document-makros in Module Innovaphone. It is simple named Main. Now you search for the command 'shell (MakroFile,4)' and make it to a comment by writing rem left from the command. After running the makro now you see the script-file uploader.cmd in the workspace and you can anlyze and run it.
You will find some other commented lines (rem print) at the macro, yo can uncomment this to get some messages by running it.

==Version History==
===V1.0===
The first try.
===V1.1===
* Improve the handling of the UTF8-file (removed unneeded steps)
* Fixing a bug with wrong saving after user saved ODS-file under new name

==Known Problems==
* By running the Macro you can get a warning that only the actual sheet is saved. Don't worry about this, the macro is fixing it one step later.
* By running the upload you lose the content of the clipboard on your PC.
* Because the password is written clear at the seetings there is al little security risk. Mabye in the next version there comes a password-request if the value is empty, but yo know - you can improve it too.
* There is no logical check for the settings, is up to you to check everything.
* Naturally, because the use of Windows-scripts it will only work on Windows.
* Off course this solution comes without any warranty or support. If you need help ask the [https://forum.innovaphone.com Community].

==Download==
[[Image:Contacts-App-Importer.zip]]

==Related Articles==
[[Reference13r1:Concept App Contacts]]