innovaphone wiki - User contributions [en]

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

2025-03-17T14:30:06Z

Kvandaele: Section added under known problems: "Provisioning option not available in Users Admin..."

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

==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|gigaset-logo.png/]]



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|n870.png/]]</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|n670_mini_multicell_en.png/]]</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
* PbxApi (since SR1)

==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, the SIP- or SIP-TLS Port, the MasterPBX-Name and the PBX password. You can also set Logname or E164 as an alternative, when DN is not set. Also define if reverse proxy should be activated or not. 

'''There are two different ways to configure provisioing from this app to the gigaset integrator. '''

The '''simple way is http'''. Therefore you have to 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, the admin password and select the DECT frequency. You can also define an alternative open dect registration time window (default 300s).
Provisioning via http is quit simple to configure, but has a few disadvantages: you can't be logged in on WebUi at the same time and the App Platform must reachable by IP-Address from Gigaset Integrator, and vise versa. 

That's why we implemented the '''second connection method via SIP'''. 
Therfore you have to 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 SIP Realm of the App Platfrom, the App Platfrom FQDN, App Platform SIP- or SIP-TLS Port and additionally a sip username and password of your choice!
of course also the admin password from the integrator and select the DECT frequency. You can also define an alternative open dect registration time window (default 300s).
Advantages of the provisioning via SIP is that you can be logged in into the WebUi in paralell and this will also work e.g. for cloud environments and other scenarios where PBX and Gigaset Integrator are not into the same routed network. 

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. 

Call number formatting reads access code and prefixes from the pbx or you can define it manually. 
This is used for reverse lookup and call settings. you can change more call settings manually or via own provisioning parameters. 
If you activate wild carding and enter your internal number length and Emergencey Numbers, the Gigaset DECT System will wildcarding your phone number search into the phonebook.
for example: the access code will be stripped and then *4989123 is searched for instead of 004989123, or *89123 is searched instead of 089123. 

You have the possibility to add provisioning parameters by your own in xml strings. You can find all provisioning parameters here: 
'''[https://teamwork.gigaset.com/gigawiki/display/GPPPO/FAQ+-+Auto+provisioning%3A+Parameters Gigaset Provisioing Parameters] '''
 
please have in mind, that you have to replace special signs with placeholders: 
& – '&amp'; 
‘ – '&apos'; 
< – '&lt'; 
> – '&gt'; 
” – '&quot'; 
Ä - '&#196'; 
Ö - '&#214'; 
Ü - '&#220'; 
ä - '&#228'; 
ö - '&#246'; 
ü - '&#252'; 
ß - '&#223'; 
 
here are a few examples for popular provisioning parameters: 
<param name="DmGlobal.0.SuotaEnable" value="1" /> --> Enable Software Update over the Air for Gigaset Handsets 
<param name="hs.@.DirectAccessDir" value="1"/> --> change Directory Access Key to Local Directory 
<param name="hs.@.IntKeyDir" value="10"/> --> change Int Key to LDAP Directory 
<param name="hs.@.ShowMissedCalls" value="0" /> --> deactivates LED signaling for Missed Calls 
<param name="hs.@.ShowMissedAlarms" value="0" /> --> deactivates LED signaling for Missed Alarms 
<param name="hs.@.ShowMissedNetAM" value="0" /> --> deactivates LED signaling for Missed Voicemails 
 

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! 

<gallery>
Innovaphone GigasetApp Admin2.0 HTTP.png|Caption1|innovaphone_gigasetapp_admin2.0_http.png/
Innovaphone GigasetApp Admin2.0 SIP RVP TLS.png|Caption2|innovaphone_gigasetapp_admin2.0_sip_rvp_tls.png/
</gallery>

{| class="wikitable" style="margin-top:auto;margin-top: 0px;"
|
[[Image:Innovaphone GigasetApp Admin2.0 HTTP.png|innovaphone_gigasetapp_admin2.0_http.png/]]
|
[[Image:Innovaphone GigasetApp Admin2.0 SIP RVP TLS.png|innovaphone_gigasetapp_admin2.0_sip_rvp_tls.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|innovaphone_gigasetapp_user.png/]]

===Usage over ReverseProxy===
As you can see, the app provides a small SIP server. For this SIP server, a SIP realm should be used that is not used in any other system in the environment.
As an example: If the SIP realm / system domain of the environment is "example.com", "gigaset.example.com" could be used as the SIP realm for the App Service. The advantage now is that we can enter this domain on the reverse proxy and direct it from there to the SIP port of the App Service. 

[[Image:Gigaset-rvp-all.png|gigaset-rvp-all.png/]]

===Multiple Instances===
If you want to run multiple instances of the app on one AppPlatform, the local SIP ports of the app service must not overlap. This means that different ports must be used for SIP provisioning in each app service. The distinction can be made in the reverse proxy on the basis of the SIP realm used. 
If the local SIP port of the app is e.g. 5065, but the reverse proxy can only be reached via port 5060/5061. An outbound proxy must also be distributed to the DECT Manager. This is done via the area for own provisioning parameters. 

[[Image:Gigaset-rvp-special.PNG|gigaset-rvp-special.png/]]
 
In view on the example above: 
<param name="SipProvider.19.OutboundProxyAddress" value="app.example.com"/> 
<param name="SipProvider.19.OutboundProxyMode" value="0"/> 
<param name="SipProvider.19.OutboundProxyPort" value="5061"/> 

===Contacts APP===
Use innovaphone Contacts App for forward search and reverse lookup from Gigaset Handsets
====Requirements====
* Gigaset firmware V2.59 or higher (supports new provisioning parameter <param name="LDAPDir.0.BlankFilter" value="(metaSearchNumber=0*)"/> )
* for Reverse Lookup number formatting in Contacts has to be '''without''' +49 - for example 02871 91-0 instead of +49 2871 91-0 .
* for Reverse Lookup the provisioning parameter <param name="AreaCodes.0.Wildcarding" value="1" /> has to be set to change the default behaviour
====Configuration====
* Host : apps.company.tld (address of the AP)
* Port : 636
* LDAP : dc=entries
* Username : [from PBX-Manager / AP Contacts / Change Configuration / User (LDAP)]
* Password : [from PBX-Manager / AP Contacts / Change Configuration / Password (LDAP)]
* Name filter : (|(cn=%)(sn=%))
* Number filter : (metaSearchNumber=%)
* all other entries as shown in below screenshot

[[Image:Provisioning_APP_Contacts_Parameter.png|500px|provisioning_app_contacts_parameter.png/]]

[[Image:PBX Manager Contacts Parameter.png|750px|pbx_manager_contacts_parameter.png/]] 

===Forward lookup on different Nodes===
In some cases internal PBX Users are in different Nodes. When searching on a Handset for internal PBX Users the Result won't show the Nodeprefix for the Users - therefore the Calls would get lost and not reach the right Destination. For this to work you can either use a Meta Directory or an innovaphone PBX for use as Phone Book only.

Use of an innovaphone PBX as Phone Book:
You can use an additional innovaphone PBX which replicates all the Users from the Master PBX with type "Active Directory Replication", this way you're able to define the nodes within the extension field.
It's important here to also define the guid for the Users, this Configuration will look like this then:

[[Image:gigaset-forward-lookup-nodes.png|750px|gigaset-forward-lookup-nodes.png/]] 

At last: You have to set the phone book PBX as your target phone book at the phone book settings

==Release Notes==
===Update Notice===

Even though this should be the standard procedure, we would still like to point this out. 
Before installing an update, we recommend backing up the PBX and the Gigaset application on the application platform so that a rollback of the configuration is possible.

===136017 - final===
- Startversion 

===136035 - SR1===
====GUI and App====
- Change App Icon and Logo 
- Support more languages 

====Innovaphone System Settings====
- Add Configuration for SIP Port of PBX 
- Add Checkmark for TLS 
- Add Configuration for PBX Name of Master PBX (required after Update) 
- Add Configuration for Usage of Longname or Number instead no Displayname is availabe. 
- Add Checkmark "ReverseProxy" for authorization of DECT Devices over ReverseProxy 

====Gigaset System Settings====
With the update, you have the option to run the Gigaset app as a small SIP server. This is necessary to register the transmitter with the app via a special SIP profile. The registration is done with a separate SIP domain directly on the AppPlatform without registering via the PBX. This makes it possible to run the app via the reverse proxy on Cloud PBX environments. 
- Add Registration time for DECT Device Register 
- Add New Option "Connect via SIP" instead of http 
- implementation of small SIP server methods "Register" , "Check Sync" 
- Add Configuration for Provisiong SIP Domain (different from PBX Domain) 
- Add Configuration for SIP Port of App Platform 
- Add Checkmark for TLS 
- Add Username for SIP Authentication on App Platform 
- Add Password for SIP Authentication on App Platform 
- Add the possibility of specifying the prefixes and internal number length, for phone number formatting, based on the innovapone configuration 
- Add Checkmark for wildcarding, so that reverse lookup in Phonebooks works independent of the saved format 
- Add the possibility of specifying emergency numbers 
- Add a field for adding individual provisioning parameters as an xml string 

===136036 - SR2===
- Increase paketsize for receiving SIP Request in App Service

==Known Problems==
===Provisioning of devices via Users Admin not working===
Please note the following for environments that do not have Internet access. In this case, the assignment of devices via the Users Admin may be disrupted.
The Gigaset App works together with the provisioning service of the Devices App. The online provisioning server from innovpahone "config.innovaphone.com" is entered as the default in the Devices app. If the environment cannot reach the server, the process is aborted.
To avoid this, offline provisioning must be configured for the domain in the Devices app.
https://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_Offline_Provisioning

===Reverse Lookup is not Working for LDAP===
As an Workaround, delete international and national dialing location from number formatting parameters. 

===LDAP Configuration double fields in german===
When WebUi is in german Language, filed username/Benutzername is present twice, so each field is offset by one. 
As an Workaround use WebUi in englisch language.

=== Provisioning option not available in Users Admin when giving Profile app a custom name ===
When the name or long name of your profile app PBX object differs from the default names "Profile" (long name) and "profile" (name), you won't have the option to select "Gigaset - Gigaset Provisioning" as the manufacturer of the phone if you try to create new phone registrations via Users Admin. 

== Related Articles ==
*[[Howto:MyApps Cloud - Using Gigaset-Provisioning-App in innovaphone cloud environments| Howto:Using Gigaset-Provisioning-App in innovaphone myApps cloud environments]]

==Contact==
Gigaset Technologies 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

Reference11r1:Phone/Preferences

2024-06-04T10:12:47Z

Kvandaele: 2N doorphone URL added to section "Important hints for background image"

* '''Background Image''': URL for background image display
:Only on phones with colour display supported.
:An http/https URL to a picture - in '''png''' format, colour-space 8 bit RGB and with the size of the Display - stored at a web server (e.g CF card) must be entered.
:Both .jpg and .mjpg file formats are supported too. They will be scaled to the appropriate screen size automatically.
:Motion JPEG sources will be updated continiously to the screen (Note: if the stream stops after a period of time, you can add a <code>refresh=n</code>, so the stream will be reinitiated after n-seconds). Normal JPEG sources can be updated by adding a <code>refresh=n</code> URL query argument. Refresh interval is given in seconds. See [[Howto:Door Phone with Video in V10]] for details.
:'''Picture sizes'''
:Before V11: IP11x, IP222, IP241: 320px (width) and 240px (height); IP232: 480 x 272.
:Since V11: reduced visible area due to the new phone UI leads to following sizes: IP11x, IP241, IP222: 320 x 200; IP232: 480 x 200.
:Since V11, background images will be displayed on selection of the camera app (left icon in bottom menu - visible if picture can be read via given path and fits to phone requirements).
:'''Important hints for background image'''
:You need a png file with exactly the size of the display. Otherwise the phone does not display the customized background.
:If your picture doesn't work, it is most likely an unsupported picture file format. You may find a hint in the phone's trace saying something like <code>png::png(noname) width=320 height=240 colour_type=3 depth=8 not supported</code>. The only non-obvious information here is ''colour_type=3''.
:If you're using a 2N doorphone, you can use an URL following the format http://192.168.0.1/api/camera/snapshot?width=320&height=240&fps=10. [https://wiki.2n.com/hip/hapi/latest/en/5-prehled-funkci-http-api/5-8-api-camera/5-8-2-api-camera-snapshot Details can be found here.]
Here is the key to it:
:: greyscale = 0
:: truecolour = 2
:: indexed_colour = 3 (not supported!)
:: greyscale_with_alpha = 4
:: truecolour_with_alpha = 6
:You can use also place-holders in the image URL, as of v9hf8 [[Reference9:Release_Notes_Firmware_V9#2418_-_IP241.2CIP222.2CIP232:_Support_for_placeholder_in_background_image_url | v9hf8 ''$serial'' and ''$product'']] are supported
:'''Errors'''
:''Interlaced data order is not supported'' - disable interlacing (known as "Adam7") when storing image data into PNG file.
:''Allocation limit exceeded'' - uploaded picture is too big for the internal phone memory (IP2x2 - 3MB, IP11x - 10MB). Downsize source file and upload again.

* '''No Call Transfer on Hook-On''': By default going on hook or pressing the speaker or the headset key initiates a call transfer when there exist both an active call and a connected call on hold. If this checkmark is set both calls are released when going on hook. A call transfer can be initiated by the R-4 key sequence then ('R' (flash) key immediately followed by the digit 4).
* '''No Local Conference Tone''': By default a conference tone is merged into conversation when a conference is established. Frequency, volume and pattern of this tone depend on the configured dial tone scheme. If this checkmark is set no conference tone is generated when the phone itself establishes a conference.
* '''No Local Intrusion Tone''': By default an intrusion tone is generated to notify the user about a call intrusion. If this checkmark is set no intrusion tone is generated the phone itself.
* '''Display Name on Pickup/Partner Key''': By default the number of the calling/called/connected party is displayed in the label field of a partner or pickup function key. If this checkmark is set the 'Name' attribute from the PBX user object (if available) is displayed instead.
* '''Keep Calling Party Info on Pickup Key''':If this checkmark is set the Number of the calling party is fully displayed and the called Party is reduced instead.
* '''Start Outbound Call on Electronic Hook Switch (EHS) Signal''': A wireless headset usually has an Electronic Hook Switch button. If the base station of the headset is attached to the phone via the DHSG interface the phone receives a hook switch signal whenever the button is pressed. By default this signal is ignored when the phone is in idle mode. When sitting in front of phone it's quite inconvenient to set up a call by pressing this button, when being far from phone no digits can be dialled. But in some cases it can be useful to set up a call, for example when the phone is configured for direct dialling. If this checkmark is set the Electronic Hook Switch Signal will set up an outbound call when the phone is in idle mode.
* '''Go onhook if final call is released by remote side even if handset is lifted''': if a call is disconnected, no disconnect sound is played - the phone is silent immediately.
* '''Use Handset like a Headset Ignore Hookswitch Signals''': some switchboard operators are used to work with the handset in a headset like manner. they never place the handset on hook and expect to receive inbound calls via handset instead via speakerphone. If checked the handset will be operated like a headset, the headset port is disabled. inbound calls are accepted on the handset with the respective 'headset'-key (space (IP200a/IP240), Ok (IP230)). this key can also be used to drop the current call or to start a new call when the phone is idle. The speaker key works as usual. This mode is '''not supported''' for the '''IP110''', '''IP111''' and '''IP150'''.
* '''Handset replaced by Headset, ignore Hookswitch Signals''': This mode must be set when when a headset is plugged into the handset port of an '''IP111'''. The 'headset'-key is used to accpt a call, to start a new call or to drop a call on the headset. The speaker key works as usual. This mode '''not supported''' for other telephones.

Reference13r3:Concept myApps Redundancy

2024-05-30T08:40:36Z

Kvandaele:

[[Category:Concept|myApps Redundancy]]
[[Category:Concept_myApps]]

The myApps client handles the failure of a single PBX by failover to a secondary PBX.

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

== General concept ==
The innovaphone PBX has implemented a mechanism, that by adding a single PBX to an installation, from the failure of any single PBX can be recovered.
* For a single PBX a standby PBX can be configured
* For a slave PBX the master can act as standby
* For a master PBX any slave PBX can act as standby

The myApps client can connect to any PBX in the system. If it does not match the PBX on which the user is configured on, the client follows a number of rediects until it ends up at the user's PBX.
* Slave PBXes redirect to their master PBX.
* The master PBX redirects to the slave PBX of the user.

=== Handling of standby cases ===

If the current PBX has no registration to the PBX it would redirect to, it acts as a standby and keeps the myApps connection.

For cases in which the initial PBX is unavailable the myApps client tries to connect to two PBXes in an alternating manner:
;Primary PBX: This is the PBX where the client tries to connect first.
;Secondary PBX: This is the PBX, where the client tries to connect, when the connection to the primary PBX failed.

=== Handling of connection loss ===
If the connection to the current PBX is lost:
* myApps tries to re-connect to the current PBX first.
* If the current PBX is unavailable it restarts connecting to the primary and secondary PBX in an alternating manner.

== Determination of primary and secondary PBX ==
On each successful connection in a non-standby case, myApps determines the primary and secondary PBX automatically and stores the information for handling standby cases.

=== Primary PBX ===

The PBX configured in the myApps client is used as the primary PBX.

=== Secondary PBX ===

There are different cases to be considered to determine the secondary PBX:
* In case the client was redirected to the PBX the user is configured on, this PBX is used as secondary PBX.
* In case the client was not redirected, the normal rules for standby PBXes apply, which means if there is an explicit standby available for this PBX, it is used as secondary PBX. If no standby is available, but this is a slave PBX, the master is used.

== Published information for the softphone app ==
The myApps client publishes the determined configuration along with other connection details in the API model of com.innovaphone.client inside the <code>connInfo</code> object.

This information is used by the softphone app. See [[Reference13r3:Concept_Softphone_Redundancy]] for details.

Example:

"connInfo": {
"up": true,
"standby": false,
"cur": "slave.example.com/PBX0",
"pri": "master.example.com/PBX0",
"sec": "slave.example.com/PBX0",
"phys": "master"
}

Values:
;up: true, if the connection is up. false if myApps is offline.
;standby: true, if the myApps client is connected to a standby PBX. false, if the myApps client is connected to the user's PBX.
;cur: the current PBX in the format host/pbx-module
;pri: the primary PBX in the format host/pbx-module
;sec: the secondary PBX in the format host/pbx-module
;phys: the physical location, if configured explicitly

== Configuration ==
For configuration in the myApps launcher, see [[Reference13r3:Concept_myApps_platform_services#Server_configuration]].

In the browser the PBX specified by the URL is used as the primary PBX. An explicit physical location can be set using a URL parameter, see [[Reference13r3:Concept_myApps#Supported_URL_Parameters]].

== Tracing ==
Trace flags
;App
;Browser
;Browser Console
;Sigaling
: to see the connection flow including redirects and determined configuration