innovaphone wiki - User contributions [en]

Reference15r1:PBX/Config/General

2026-03-17T14:28:29Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 IP-Addresses (Mixed IPv4 and IPv6 allowed, but no DNS names) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX. (If you use a SAN certificate you have to enter the first SAN-Name)
:Checking only on the certificate is also possible, by omitting the IP-address, eg '/*.domain.de'. Registrations sent with this certificate are considered to be coming over the Reverse Proxy.
:If empty addresses are used, unauthenticated registrations from unknown or internal addresses are not allowed, but any registration must be authenticated, with a password or the certificate from the reverse proxy.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password. The password for contacts is found in settings/contacts/configuration as Password(LDAP). Leave the field empty, when no ldap password is required.
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).
'''Max. length internal number'''

In the phone and softphone App: If the number, witch is dialed is 7 digits or longer, the subscriber prefix is added. (A reset of the pbx and the myApps is needet after changes.)
;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:PBX/Config/Security#PBX_password]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:PBX/Config/Security#PBX_password]]

Reference15r1:PBX/Config/General

2026-03-17T14:27:35Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 IP-Addresses (Mixed IPv4 and IPv6 allowed, but no DNS names) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX. (If you use a SAN certificate you have to enter the first SAN-Name)
:Checking only on the certificate is also possible, by omitting the IP-address, eg '/*.domain.de'. Registrations sent with this certificate are considered to be coming over the Reverse Proxy.
:If empty addresses are used, unauthenticated registrations from unknown or internal addresses are not allowed, but any registration must be authenticated, with a password or the certificate from the reverse proxy.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password. The password for contacts is found in settings/contacts/configuration as Password(LDAP). Leve the fild empty, when no ldap password is required.
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).
'''Max. length internal number'''

In the phone and softphone App: If the number, witch is dialed is 7 digits or longer, the subscriber prefix is added. (A reset of the pbx and the myApps is needet after changes.)
;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:PBX/Config/Security#PBX_password]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:PBX/Config/Security#PBX_password]]

Reference15r1:PBX/Config/General

2026-03-17T14:26:46Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 IP-Addresses (Mixed IPv4 and IPv6 allowed, but no DNS names) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX. (If you use a SAN certificate you have to enter the first SAN-Name)
:Checking only on the certificate is also possible, by omitting the IP-address, eg '/*.domain.de'. Registrations sent with this certificate are considered to be coming over the Reverse Proxy.
:If empty addresses are used, unauthenticated registrations from unknown or internal addresses are not allowed, but any registration must be authenticated, with a password or the certificate from the reverse proxy.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password. The password for contacts is found in settings/contacts/configuration as Password(LDAP). Leve the fild empty, when no ldap password is required.
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).
'''Max. length internal number'''

In the phone and softphone App: If the number, witch is dialed is 7 digits or longer, the subscriber prefix is added. (A reset of the pbx and the myApps is needet after changes.)
;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:PBX/Config/Security#PBX_password]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:PBX/Config/Security#PBX_password]]

Reference13r3:Concept Number Resolution and LDAP

2026-03-17T14:22:40Z

Hawk: /* Contacts App */

= General =
This document shows the V13 concept of number resolution, LDAP search and reverse lookup.

= Short overview and scenarios =
There are basically two different directions for resolutions:

* Number to Name (Reverse Lookup)
:Backward resolutions are performed centrally for incoming and outgoing calls on PBX-level. A [[{{NAMESPACE}}:PBX/Config/General|''Reverse Lookup URL'']] can be stored per PBX.
:By default, this is a 1-to-1 relationship (a single PBX can query an single LDAP source).

* Name to Number (Forward Search)
:Forward search differs between software and hardware:
:* myApps
::1-to-n relationship. A user can search simultaneously in multiple sources
:* Desk phone
::Search can be done according to the LDAP configuration in the [[{{NAMESPACE}}:Phone/User/Directories|external directories]] settings of the user object.

=Number to Name (Reverse Lookup)=

== Concept ==
Resolution is done at the PBX for incoming and outgoing calls according to the locally defined reverse lookup setting. The URL might be different within PBXes of the same system (master, slaves).

For a general overview about the URL definition, refer to the [[{{NAMESPACE}}:Concept_Reverse_Lookup|concept article on reverse lookup]].

In incoming direction resolution is done only for calls without any provider embedded display name information.

Resolution is done by LDAP-queries against sources like the PBX phonebook itself, V13-contacts application or any external 3rd-pty directory.

Setup is done via the ''Reverse Lookup URL'' which is configured under [[{{NAMESPACE}}:PBX/Config/General|PBX/Config/General]]. 
If a resolution succeeds via this mechanism, the resolved name is given to all other applications/locations. (MyApps, Phones (also DECT), CDRs, Reporting, Call-List, etc.)

== PBX Configuration ==

Central PBX Reverse Lookup is activated by definition of the [[{{NAMESPACE}}:PBX/Config/General|''Reverse Lookup URL'']].

The URL is an [https://tools.ietf.org/html/rfc2255 RFC2255] encoded string. The format is explained [[{{NAMESPACE}}:PBX/Config/General|here]].

Examples of reverse lookup url's for most common directories can be found below. Other LDAP-based directory services may be used as well.

The LDAP-URL also supports the attribute DN (Distinguished Name) [[ReleaseNotes13r1:Firmware#66919_-_PBX_Reverse_Lookup:_Allow_X.500_bindname_format|since v13r1sr10]]

Following prerequisites apply:

=== Prefix section ===

Depending on the PBX setup (flat or nodes) prefixes are defined either in the general PBX config and/or in the node/pbx-objects.
Only the "deepest" definition is taken into account for number conversion/adaption. In case of empty prefixes, no higher-leveled definitions are taken into account.

E.g. if the called pbx-user is located within a node, the prefix definition of this node is used for number normalisation. If those node prefixes are empty, no other prefixes in e.g. PBX-general are used.

In general, prefix definition may contain prefixes for
* International (INT)
* National (NTL)
* Subscriber (SUB)
* Area Code (AC)
* Country Code (CC)

Usage and definition depend on the country specific number plan.

The PBX tries to format the incoming number (CGPN) by performing a match against the prefixes in left to right order. In case of any prefix field is empty, the next one will be investigated.

Following rules apply upon prefix match:
* INT prefix matches: remove INT prefix
* NTL prefix matches: remove NTL prefix, prepend CC
* SUB prefix matches: remove SUB prefix, prepend CC + AC

'''Examples'''

1) German mobile call (best practice pbx config) 
:CGPN: 00171123456 (0 Trunk + mobile number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): 000/00/0/7031/49 
:Result: 49171123456 

2) German mobile call (missing pbx config) 
:CGPN: 00171123456 (0 Trunk + mobil number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): none 
:Result: 00171123456 

3) German city call (typically ISDN, SIP-CGPNs are always signaled in international format) 
:CGPN: 0123456 (0 Trunk + local subscriber number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): 000/00/0/7031/49 
:Result: 497031123456 

4) Spain national call (no SUB) 
:CGPN: 0925123456 (0 Trunk + national number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): 000/0//912/34 
:Result: 925123456 

=== URL definition ===

In general, reverse lookup uses the above created result after number conversion with prefixes.
Depending on the used phone book source, the reverse lookup URL might look different.
The number handed over to those source needs to be adapted by use of following variables:

* %n - cgpn
** if phone book entries are stored in international format with "+xyz", leading "+" may be prepended by using this notation: '+%n'. This is the default setting configured by Installer.
** if phone book entries are stored in international format with "00xyz", leading "00" may be prepended by using this notation: '00%n'
* %u - h323 name of the current object. Used to change the relationship of the searchbase to the user. A specific LDAP source can be requested depending of the user which receive the call.
: See [[{{NAMESPACE}}:Concept_App_Service_Contacts#Reverse_Number_Lookup_for_Personal_Directories | Reverse Number Lookup for Personal Directories]] for how the PBX's LDAP client handles user information

==== Contacts App ====

ldaps://ap.domain.tld/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=ap.domain.tld\contacts

Contacts is asked by further instances (e.g. PhoneAPP) for details about the found contact via websocket query.
 The password for this ldap access is found in settings/contacts/configuration as Password(LDAP).

==== Estos MetaDir ====

ldap://metadir.domain.tld:712/dc=meta?givenname,sn,company?sub?(|(telephoneNumber=+%n)(mobile=+%n)(homePhone=+%n))?bindname=username

==== C4B ====

ldap[s]://c4b.domain.tld:[Port]/vdir=VDir?givenname,sn,company?sub?(|(telephoneNumber=+%n)(mobile=+%n)(homePhone=+%n))?bindname=c4b.domain.tld\telbook

==== Active Directory ====

ldaps://domain.tld:636/OU=tld,OU=company,DC=city,DC=LOCAL?givenName,sn,company?sub?(|(telephoneNumber=+%n)(mobile=+%n)(homePhone=+%n))?bindname=domain\username

==== PBX as LDAP Server ====

This refers to the legacy [[Howto:Maintaining a Phone Directory in the PBX| PBX-directory solution]].

ldap://ldap.domain.tld/cn=PBX0?dn,e164,email?sub?(&(node=PhoneBook)(e164=000%n))?bindname=telbook

== Outlook Reverse Lookup ==
* Works with myAPPs '''windows launcher''' client and so Windows compliant only
* Contact data will be found in all exchange accounts and all contact folders of these accounts
* requires a configured MAPI profile in Outlook (Exchange Account)
* For details [[Reference13r2:Concept_myAPPs_Search_in_local-Outlook_Contacts|refer to the respective concept]]

== Legacy Device Configuration ==

By default, reverse number lookup is done at the PBX and displayed at the phone. Phone originated directories such as internal phone book, pbx access and external ldap are disabled.

Optionally, it is possible to enable the resolution directly at the phone. This is done by unticking the [[{{NAMESPACE}}:Phone/User/Preferences | option "Disable Phonenumber Look-up"]] at Phone/User/Preferences.

The phone will then use the directory settings of the appropriate user, which are defined in the user object or config template.

If the resolution on the local phone provides a result, this is shown instead of the resolution of the PBX.

Be aware that this might lead to a different result than displayed on the PhoneAPP/SoftphoneAPP/CallList etc. as these applications always resolve against PBX-located settings.

== DECT ==
In V13, reverse number lookup for DECT systems is also done via the PBX-defined ReverseLookupURL.
Definition of any directory for reverse lookup in [[{{NAMESPACE}}:DECT2/Config/Master|DECT/Config/Master]] is obsolete.

=Name to Number (Forward Search)=
Search can be done by use of various sources. Those may be
* PBX itself (UsersApp)
* included ContactsApp
* any other external directories

== UsersApp ==
All PBX users can be searched via the UsersApp.

Preventing PBX-users from being found in Users/PhoneApp can be realized by disabling option "Visible" in privacy settings.

== ContactsApp ==
Further, contacts can be managed and searched within the [[Courseware:IT_Connect_-_09.0_Contacts|ContactsApp]].

It is possible to define several contact instances hosting different contact data and assign those to dedicated users/config template.

=== Usage ===
Configure LDAP query with Contacts e.g. at phone:
* use of the correct user incl. domain (e.g. domain.tld\contacts)
* Correct password (visible in plain text in PBXManager/APContacts/configuration, checkmark show password)
* Search attributes:
** Meta Name Attributes -> metaSearchText
** Meta Number Attributes -> metaSearchNumber

=== 3rd Party Terminals ===
To directly search for global Contacts, so all Contacts that are directly uploaded to the App via the import Button, you can set up the Contacts App as ldap server in your 3rd Party terminal environment

==== Requirements ====
*innovaphone AP with Contacts App (At least Version 13r3!)
*3rd Party Phone (Tested with Phones from Atcom, Snom (Firmware Version 10.1.49.11) and Yealink (Firmware Version 73.85.0.5), no gurantee that all 3rd Party Phones are supported for ldap query through Contacts)
** For Gigaset Handsets (Tested with Gigaset N870, Firmware: V2.59) please follow [[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App#Contacts_APP|the instructions here]].
*LDAP activated at the Contacts App within the PBX Manager with Port, Username and Password
*Global Contacts stored in the Contacts App (Private Phonebooks are not supported to search)

==== Client config ====
*You can use following Parameters for all the tested Devices
**LDAP Name Filter ->(|(cn=%)(sn=%))
**LDAP Number Filter ->(|(telephoneNumber=%)(mobile=%)(homephone=%))
**Server Address -> DNS or IP of the App Platform with Contacts
**Port -> 389 or 636 (depending on configuration and if Client supports TLS)
**Base -> dc=entries
**Username -> User (LDAP) According to your Contacts configuration in the PBX Manager
**Password -> Password (LDAP) According to your Contacts configuration in the PBX Manager
**LDAP Name Attributes -> cn sn displayName
**LDAP Number Attributes -> telephoneNumber mobile homephone
**LDAP Display Name -> %cn
**Protocol -> Version 3

*You can either use LDAP or LDAPS

==== Multiple Numbers for one Contact ====
If you have a Contact which has multiple Numbers, you can choose which Number you would like to call
*For Gigaset, Snom and Yealink Phones you can select which Number you would like to select
*For Atcom you have to reconfigure your config
**Here you need to rewrite "LDAP Number Attributes" in lowercase letters in order for it to works

== PhoneApp / SoftphoneApp / myAPPs ==

Within Phone/SoftphoneAPP search requests can be performed towards multiple sources in parallel if assigned to the respective user.

=== LDAP Object ===
To extend the amount of external search sources you can use the LDAP Object in the PBX.

To be defined depending on the external source attributes [[{{NAMESPACE}}:PBX/Objects/LDAP|according to this description]].

LDAP object has to be assigned via App-tab to dedicated user / configuration template.

== myPBX ==
For myPBX, forward search is performed as usual via the [[{{NAMESPACE}}:Phone/User/Directories | Phone/User/Directories]].
myPBX does not perform forward search in databases defined via ldap-objects.

== Outlook Forward Search ==
* Works with myAPPs and myPBX [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts|'''windows launcher''']] and so Windows compliant only
* Contact data will be found in all exchange accounts and all contact folders of these accounts
* requires a configured MAPI profile in Outlook (Exchange Account)

== Hardware Phone ==
Search on the hardware phone is done by use of the [[{{NAMESPACE}}:Phone/User/Directories|configured directories]] at the phone.

In case of phone connection via ReverseProxy, refer to [[Howto:V13_LDAP_IP_Phones_Directory_Services_via_Reverse_Proxy|this description]] on how to configure search.

= Troubleshooting =

== Reverse Lookup doesn't work ==

=== SIP Trunk name delivery ===
Reverse Lookups are only executed for incoming calls without any embedded display name information. Some SIP provider will send the phone number as additional ''Display Name'' Information. In this case the Reverse Lookup will not be performed. 
This additional carrier information can be removed within the routing by deactivating the flag "[[{{NAMESPACE}}:Gateway/Routes/Map|Interworking (QSIG,SIP)]]" in the incoming SIP route.

=== Contacts password ===
Reverse lookup against contacts does not work due to wrong password usage. Password used at ReverseLookupURL has to be equal to password defined at AP Contacts settings in PBXManager

== MyAPPs - Forward Search with LDAP Object ==

In case of non-working search request to a configured LdapApp-object, one can search in the myapps traces and crosscheck for related responses. The trace can be taken with the web console of your browser (F12), or by activating the trace flag "[[{{NAMESPACE}}:Concept_myApps#Tracing_and_logging|Browser]]" available in your myApps client.

In the following example an LdapApp-object exists with the Name "MetaDir" and is configured as App to the User who searches for "jon doe":

// search pattern is "jon doe"
PhoneSearchBar::onSearchInputChange() input=jon doe

One can see the following lines in myAPPs-trace:

// start connection and login
open MetaDir url=http://localhost:10008/appproxy/ext/pbx.domain.de/PBX0/APPS/MetaDir/ldap_api.htm?
name=MetaDir&title=MetaDir&scheme=dark&lang=de&originalUrl=http%3A%2F%2Fpbx.domain.de%2FPBX0%2FAPPS%2FMetaDir%2Fldap_api
started: MetaDir (hidden)
AppWebsocket(MetaDir) ws://localhost:10008/appproxy/ext/pbx.domain.de/PBX0/APPS/MetaDir/132075/websocket
AppWebsocket(MetaDir) ws://localhost:10008/appproxy/ext/pbx.domain.de/PBX0/APPS/MetaDir/132075/websocket
send: {"mt":"AppLogin","app":"ldap_api","domain":"domain.de","sip":"slutz","guid":"e9653d7a7a615901b5b300155dbb1337","dn":"slutz","info":{"appobj":"MetaDir","appurl":"../../APPS/MetaDir/ldap_api","cn":"slutz","unlicensed":true,"groups":["test"]},"digest":"***","pbxObj":"MetaDir"}

// Login successful and Search API is registered
recv: {"mt":"AppLoginResult","ok":true}
recv from MetaDir: {"mt":"RegisterApi","api":"com.innovaphone.search"}

// send search request to LDAP APP
send to MetaDir: {"mt":"ApiRequest","api":"com.innovaphone.search","consumer":"dev:009033465440","provider":"*","src":"2","msg":{"mt":"Search","type":"contact","search":"jon doe"}}

// receive result from LDAP App
recv from MetaDir: {"mt":"ApiResult","api":"com.innovaphone.search","consumer":"dev:009033465449","src":"2","msg":{"mt":"SearchInfo","type":"contact","dn":"Jon Doe","contact":{"cn":"John Doe","givenname":"John","sn":"Doe","company":"Company","street":"street 123","postalcode":"12345","city":"city","telephonenumber":["+49123456789"],"homephone":[],"mobile":["+49123456789"],"sip":[],"email":["john.doe@domain.de"]}}}

= Related Articles =
* [[{{NAMESPACE}}:PBX/Config/General]]
* [[{{NAMESPACE}}:PBX/Objects/LDAP]]
* [[{{NAMESPACE}}:Phone/User/Directories]]
* [[{{NAMESPACE}}:Concept_App_Service_Contacts]]
* [[Howto:V13_LDAP_IP_Phones_Directory_Services_via_Reverse_Proxy]]
* [[{{NAMESPACE}}:Concept_Number_Adjustments_(Dialing_Location)]]
* [[{{NAMESPACE}}:Concept_Reverse_Lookup]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts]]

Howto:Gigaset-DeskPhone-App - Gigaset - Partner App

2025-11-18T15:27:00Z

Hawk: /* Known Problems */

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

==Product Name==


[[Image:Gigaset-DeskPhoneApp-Logo.png|100px|gigaset-deskphoneapp-logo.png/|gigaset-deskphoneapp-logo.png/]]
[https://www.gigaset.com Gigaset] Gigaset-DeskPhone-App

==Certification Status==



{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed July 2025.

==Category==

[[Category:Partner Apps|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty Terminal Devices|{{PAGENAME}}]]

==Vendor==



[[Image:Gigaset-LOGO.png|150px|gigaset-logo.png/|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==

{| class="wikitable"
| colspan="5" |Gigaset-DeskPhone App supports:
!
!
!
|-
| colspan="5" |DeskPhone P-Series
!
!
!
|-
!
!P710 IP PRO
!P810 IP PRO
!P810B IP PRO
!P820 IP PRO
!P825 IP PRO
!P850W IP PRO
!P855BW IP PRO
|-
!
![[File:P710.png|frameless|p710.png/|p710.png/]]
! colspan="2" |[[File:P810.png|frameless|p810.png/|p810.png/]]
! colspan="2" |[[File:P82x.png|frameless|360x360px|p82x.png/|p82x.png/]]
! colspan="2" |[[File:P85x.png|frameless|358x358px|p85x.png/|p85x.png/]]
|-
|
|
| colspan="2" |
| colspan="2" |
| colspan="2" |
|-
|Display
|2,8" TFT colour
| colspan="2" |3,36" TFT colour
| colspan="2" |5" TFT colour
| colspan="2" |5" TFT colour
|-
|Resolution (pixels)
|320 x 240
| colspan="2" |320 x 240
| colspan="2" |480 x 272
| colspan="2" |480 x 272
|-
|Tiltable display
| -
| colspan="2" | -
| -
|Yes
| -
|Yes
|-
|LAN switch
|2 ports, Gbit
| colspan="2" |2 ports, Gbit
| colspan="2" |2 ports, Gbit
| colspan="2" |2 ports, Gbit
|-
|PoE
|IEEE 802.3af, class 2
| colspan="2" |IEEE 802.3af, class 2
| colspan="2" |IEEE 802.3af, class 3
| colspan="2" |IEEE 802.3af, class 3
|-
|IP
|IPv4 & IPv6
| colspan="2" |IPv4 & IPv6
| colspan="2" |IPv4 & IPv6
| colspan="2" |IPv4 & IPv6
|-
|WLAN IEEE 802.11n/ac
| -
| colspan="2" | -
| colspan="2" | -
| colspan="2" |Yes
|-
|Bluetooth
| -
| -
|Yes
| colspan="2" | -
| -
|Yes
|-
|Headset connection via
|EHS/DHSG/RJ9 interface
| colspan="2" |EHS/DHSG/RJ9 interface
| colspan="2" |EHS/DHSG/RJ9 interface
| colspan="2" |EHS/DHSG/RJ9 interface
|-
|Function keys
|4 self labeling
| colspan="2" |4 (12) self labeling
| colspan="2" |8 (28) self labeling
| colspan="2" |10 (36) self labeling
|-
|G.711 A-law, µ-law

G.722 (wideband)

G.726, G.729AB, GSM 6.10 (FR)
|
| colspan="2" |Yes
| colspan="2" |Yes
| colspan="2" |Yes
|-
|Soft-keys
|4
| colspan="2" |4
| colspan="2" |4
| colspan="2" |4
|-
|SIP accounts
|6
| colspan="2" |12
| colspan="2" |12
| colspan="2" |12
|-
|USB
|No
| colspan="2" |1
| colspan="2" |1
|2
|1
|-
|P800 KEY PRO support
|No
| colspan="2" |via USB
| colspan="2" |via USB
| colspan="2" |via USB
|-
|GRAPE (Redirect and Provisioning)
|Yes
| colspan="2" |Yes
| colspan="2" |Yes
| colspan="2" |Yes
|}


The Gigaset DeskPhone App integrates the Gigaset P-Series IP PRO Phones 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 Phones.

==Functions==




* Add / Remove Gigaset DeskPhones
* Configure the Phonebook, keys and PBX Menue on Gigaset DeskPhones

With the Gigaset DeskPhone App it is possible to automatically add and remove DeskPhones.
In addition, the Phonebook, keys and PBX Menue configuration can be provisioned.

===Multi-PBX ready===




n.a.

===Cloud ready===



YES

== Provided APIs ==




* Websocket
* AdminApi
* TableUsers
* Services
* PbxApi

==Licensing==


No license is required for this app

==Prerequisites==


For BLF key signaling and pick-up a Group is needed where all phones are member of and logged in.

a PBX Object DTMF Features must be configured, with activated "Autocomplete '#'"

The app must not be installed and set up via myApps, that must be done via browser!

Because the connection from myApps to the app platform is only recognised as an http connection by SDK, even if https is used.

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

''If the instance is operated in the innovaphone myApps Cloud, please request the following approvals on the Cloud RP via ticket at cloud@innovaphone.com, specifying the “instance number|domain name”:''

''musterschuster-p.innovaphone.com -> SIPS 5061 mit Check Certificate''

''musterschuster-a.innovaphone.com -> SIP 5060 (= Realm'00')''

''If you require additional realms for multiple customer master locations, e.g., for multiple Gigaset apps or instances, the following must also be requested:''

''musterschuster-a.realm01 -> SIP 50601''

''- bis max. -''

''musterschuster-a.realm50 -> SIP 50650''

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V14r2
* innovaphone V15r1 final

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


* Gigaset DeskPhone-App - 142001 sr1

* innovaphone V15r1 final
* Gigaset Desktop IP PRO 10.1.198.16

==Configuration==


===Install the App===

===Gigaset - DeskPhone - App===

==== innovaphone settings ====
As an admin, create the environment settings in the Gigaset DeskPhone 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. If you want to show VoiceMail Messages into Phone Display enter the VoiceMail Number. Also define if reverse proxy and/or STUN Server should be activated or not and configure it accordingly. 

[[File:DeskPhone inno settings.png|frameless|600x600px|deskphone_inno_settings.png/|deskphone_inno_settings.png/]]

==== Gigaset settings ====
Enter the parameters for the phones to reach the App Platform. SIP realm and App Platform adress as an IP adress or FQDN. Also SIP port and protocol. if you need other SIP port then 5060/5061 via reverse Proxy, maybee if you use Gigaset DECT Provsioing App in paralell, enter it here. Port to Reverse Proxy still stays as 5060/5061.

'''Please note:''' If you want to use more then one Gigaset App instance or Gigaset DECT Provisioning in paralell, you need for each instance a SIP realm and a dedicated forwarding rule to the AP must be configured on the reverse proxy!

Username and password will be set for the phones web-ui. the phone connects via SIP with the App Platform, therefore the SIP-Password is needed. You can generate a random Password by uses the button below.

If activating the additional admin mode, only basic settings will be shown in the web UI. After entering the administrator mode password, the complete admin web UI of the phone will be unlocked again.

[[File:DeskPhone gigaset settings.png|frameless|600x600px|deskphone_gigaset_settings.png/|deskphone_gigaset_settings.png/]]

==== number formatting ====
access code, prefixes, country and area code will be automatically read from the system.

this settings are not used by the phone at the moment.

[[File:DeskPhone number formatting.png|frameless|600x600px|deskphone_number_formatting.png/|deskphone_number_formatting.png/]]

==== key settings ====
This DeskPhone app reads the user's key configuration in two places. 1. Configured keys of the type: Dial and Partner

and 2. The user's favorites.

You can choose the order in which these two are displayed on the phone:

* Favorites first, then keys
* Keys first, then favorites
* Do not provision any changes

[[File:DeskPhone key settings1.png|frameless|543x543px|deskphone_key_settings1.png/|deskphone_key_settings1.png/]]

and you can choose where these keys should start on the phone:

* Ocupy from first page
* Occupy from second page
* Assign to key module
* Do not provision any changes

[[File:DeskPhone key settings2.png|frameless|547x547px|deskphone_key_settings2.png/|deskphone_key_settings2.png/]]

==== PBX menu settings ====
DekPhone App will automatically provide a PBX menu to the phones, like Gigaset Feature Control App does for Gigaset DECT. [[Howto:Gigaset-Feature-Control-App - Gigaset - Partner App]]

* Directory: will provide the local innovaphone LDAP contacts for dialing
* Diversion: see actual call diversion, set/change/activate/deactivate Diversion targets for Always, Busy and on No response.
* Group: show, join and leave Groups
* Presence: see actual Presence, change Presence to Online/Away/Busy/DND
* Working: see actual status of working and Start/Stop working

[[File:DeskPhone pbxmenu settings.png|frameless|600x600px|deskphone_pbxmenu_settings.png/|deskphone_pbxmenu_settings.png/]]

* advanced call forwarding: extend the Diversion menu by Diversion Busy and on No response.
* static groups: static Groups are shown on buttom of the list.
* function key: F4 as default, but you can choose F1-F3 also, or deactivate. this are they keys below the display of the phone.
* context sensitivity of the function key: e.g. on F4 normally info button is displayed when info messages are present, and into info menu the PBX menu button will shown until all mssages ar read, which this switch you can deactivate this behavior.
* menu name: this name will be displayed on the previously selected key.

==== phone book settings ====
Under Phonebook settings you can activate sync for a phonebook.
{| class="wikitable"
|+
![[File:DeskPhone phonebook settings1.png|frameless|555x555px|deskphone_phonebook_settings1.png/|deskphone_phonebook_settings1.png/]]
![[File:DeskPhone phonebook settings2.png|frameless|542x542px|deskphone_phonebook_settings2.png/|deskphone_phonebook_settings2.png/]]
|}
there are three different phone books available, you can configure only one at a time. the same for all three, first thing to choose is phone book key and set a name that will be displayed on the key.

# the standard LDAP directory of the innovaphone PBX (PBX0), which is also integrated in PBX menu. Please enter the IP address, port and previously created access data for the innovaphone LDAP.
# LDAP server where you manuelly enter all parameters.
# Contacts APP, enter the neccessary parameters:
#* phone book key : F3 (default)
#* Phonebook key name: name that will be displayed on the key
#* Host : innoapp.domain.de (address of the AP)
#* Port : 636
#* TLS : yes
#* LDAP search base : 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 are preconfigured

[[File:DeskPhone phonebook settings Contacts.png|frameless|762x762px|deskphone_phonebook_settings_contacts.png/|deskphone_phonebook_settings_contacts.png/]] 

==== custom provisioning settings ====
You have the possibility to add provisioning parameters by your own in xml strings. You can find an overview of provisioning parameters here: 
'''[https://teamwork.gigaset.com/gigawiki/display/GPPPO/FAQ+-+Auto+provisioning%3A+Parameters Gigaset Desktop Phone Settings] '''

[[File:DeskPhone custom settings.png|frameless|545x545px|deskphone_custom_settings.png/|deskphone_custom_settings.png/]]

 
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;

 

==== Advanced settings ====

* "Reload Gigaset Devices" will be reload all Gigaset DeskPhones from Devices List. Keyword is the APP-Name, which is also inserted into the Devices. Wildcards are allowed.
* Execute Provisioning NOW will send a SIP-Notify to every connected Phone to force them to pull again the Provisioning File from Provisioning App.
* Firmware URLs: if you want to Update DeskPhone Firmware by the Provisioning App enter here a Web Url where the Phone can download it. e.g. path from Gigaset Wiki Firmware File.
* provisioning via HTTP instead of HTTPS: Gigaset DeskPhones does '''NOT support self signed certificates!''' if you have no official sigend certificates, force the App to provide a HTTP Link insted of HTTPS. The fact that the Copy Link button is not displayed is a restriction in the innovaphone SDK for unsecure connections.
* generate new secret: if needed you can generate a new secret. or if you have to reinstall the app, you can copy your previously used secret in.
* provisioning path: The app generates a provisioning path from its data. This path does not change as long as you do not regenerate a new secret. Copy this path and paste it on every new phone, you have to copy the Provisioning URL into the phone via Web-Ui. Setup --> Advanced --> Update --> Setting URL: copy it here and apply. Afterwards type on the phone: Settings --> Maintenance (5) --> Synchronize Settings (4) --> Ok

 

===Add Devices to User and start Provisioning===

Now create new end devices as usual via UserAdmin or the Profile app. Select "Gigaset + ''APP-Name''" in the manufacturer selection field and then enter the MAC adress of the phone.
You can find the MAC of the phone on the box, under the phone or by pressing settings --> Information (6) --> System Info (2) on the phone.

After you have saved the new phone, you have to copy the Provisioning URL into the phone via Web-Ui.

Setup --> Advanced --> Update --> Setting URL: copy it here and apply.

Afterwards type on the phone: Settings --> Maintenance (5) --> Synchronize Settings (4) --> Ok

[[File:DeskPhone Users Admin.png|frameless|883x883px|deskphone_users_admin.png/|deskphone_users_admin.png/]][[File:DeskPhone Devices1.png|frameless|900x900px|deskphone_devices1.png/|deskphone_devices1.png/]]

[[File:DeskPhone Web-Ui.png|frameless|790x790px|deskphone_web-ui.png/|deskphone_web-ui.png/]][[File:DeskPhone Devices2.png|frameless|900x900px|deskphone_devices2.png/|deskphone_devices2.png/]]

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

=== 142004 sr1 ===

* change in socket connection handling

=== 142003 sr1 ===

* change for MOH not working
* added SIP-Server and APP-Platform via provisioning Parameter to trusted Hosts.
* call forwardings service codes optimisation
* PBX menu Directory Edit Mode button fixed

=== 142001 sr1 ===
- Startversion 

==Known Problems==

=== ReProvisioning or check-sync for CallForwarding or others are not working after time ===
Socket connection does not recognised when the device port has changed. fixed in 142004 sr1

=== URLs are shown as http instead of https ===
The app must not be installed and set up via myApps, that must be done via browser!

Because the connection from myApps to the app platform is only recognised as an http connection by SDK, even if https is used.

=== MOH not working ===
put this parameter in the custom phone settings part:

<user_hold_inactive idx="1" perm="">on</user_hold_inactive>

=== Same SIP Port/Protocol for PBX and APP-Plattform via Reverse Proxy ===
is not working, due to load optimizations of Reverse Proxy. choose 5061/TLS for PBX and 5060/TCP for App Plattform.

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

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

=== no Audio / disconnect after 30 - Gigaset phone is connected through a Reverse Proxy ===
Media Relay works only in a LAN. For working through a Reverse Proxy a view more settings are needed. See here:
https://wiki.innovaphone.com/index.php?title=Howto13r3:Step-by-Step_Media_Relay_connection_for_third_party_phone

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

Reference14r1:PBX/Config/General

2025-09-22T10:12:51Z

Hawk: /* Standby PBX */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave. A network connection between master and slave in the LAN or via VPN is mandatory.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings ]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master. DNS is not supported.

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed.

;Master: The IP address of the PBX master. DNS is not supported.

;Replicate from Master: Turns on full replication from the master PBX.

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

Reference14r1:PBX/Config/General

2025-09-22T10:09:48Z

Hawk: /* Slave PBX */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave. A network connection between master and slave in the LAN or via VPN is mandatory.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings ]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master. DNS is not supported.

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

Reference14r1:PBX/Config/General

2025-09-22T10:07:02Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave. A network connection between master and slave in the LAN or via VPN is mandatory.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings ]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

Reference15r1:PBX/Objects/User

2025-09-11T06:06:22Z

Hawk:

With the User PBX object, the standard subscriber of the innovaphone PBX is configured.

;Do Not Disturb: No calls are sent to the user if set. Can be set by 'External UC' applications (e.g. Estos Procall)

;Hide Connected Endpoint: In some cases it is desireable not to reveal the final destination of a call to a caller. For example a call center agent should not be called directly by the customer or to suppress call forwarding destinations.

;Call forward based on Presence: enables use of forwarding based on presence. Typically set via ProfileApp. Feature description [[Courseware:IT_Advanced_-_More_on_advanced_PBX_object_properties_and_behavior#Forwardings_based_on_presence|see here]]

;Call forward on myApps offline: If this checkmark is set, a CFNR will be executed without delay if no myApps client is online for the user. In case of a myApps on a smartphone, the push will not be triggered if the smartphone is in standby and the call will follow the configured CFNR immediately.

;Onboarding seen: The information if a user has already seen the onboarding video.

;Home Screen Apps: Comma separated list of applications to be displayed at myApps-homescreen. New lines are indicated by ':' . Application names must match with respective App-object-name. Definition typically is made via myApps or UsersAdminApp.

In addition to these options, all those that can be set for a [[{{NAMESPACE}}:PBX/Objects/Config_Template]] object can be set for a ''User'' object too.

== General Configuration Options ==

The information about general configuration options shared by all objects can be found at [[{{NAMESPACE}}:PBX/Objects]].

== Configuration Options which can be defined by a Template ==

Some of the configuration options of a user object can be defined by Templates. More information about these options can be found at [[{{NAMESPACE}}:PBX/Objects/Config_Template]]

== DECT configuration options ==

The following details are entered in the DECT section and are therefore only relevant for DECT handset registrations:
* '''Gateway:''' The system name (Name) of the IP DECT device.
* '''Display:''' A variable text that is output on the IP DECT handset display.
* '''IPEI:''' The serial number of the IP DECT handset. Is required for unique registration of an IP DECT handset.
* '''AC (Access Code):''' It is also possible to allocate an access code (a kind of PIN), which protects the IP DECT handset against unauthorised use.

Reference13r1:Concept Number Adjustments (Dialing Location)

2025-04-28T14:09:52Z

Hawk: /* Phone App, Softphone App */

[[Category:Concept|Number Adjustments]]
Very often numbers are not available in the standard e.164 international format, but in subscriber or national format and maybe also formated with space, bracket, hyphens or other characters. This article defines all mechanisms in the innovaphone PBX used to adjust numbers. This can be the calling party number for display or for reverse lookup, or the called party number obtained from a directory or other purposes. These mechanisms are implemented in the PBX, the endpoints or in gateways.

== PBX ==

=== Incoming Calls from Trunks ===

A Calling Party Numbers sent in a call from the gateway to the trunk should be formated in a way, that it can be used to call back the caller, in the "Unknown Number" format. Which means it should contain any necessary prefixes for national or international numbers.

The PBX Trunk objects adds the Trunk number as prefix.

=== Reverse Lookup ===

The reverse lookup assumes that a directory exists for the numbers in the international format. For this reason, the number is converted to the international format for the lookup. The prefixes configured in the ''Node'' object are used for this purpose. If no prefixes are configured, the root node prefixes configured on the PBX/Config page are used.

The reverse lookup is performed when the call is sent out to a user, so for different users there can be different results.

* If the start of the number matches the prefix for international numbers, the prefix is removed and the resulting number is used for the lookup
* If the start of the number matches the prefix for national numbers, the prefix is removed and the country code is added. The resulting number is used for the lookup
* If the start of the number matches the prefix for subscriber numbers, the prefix is removed and the country code and area code are added. The resulting number is used for the lookup

=== Type of number handling ===

For any calls sent to the PBX, e.g. outgoing calls from phones, the type of number of the calling party number and called party number is converted to the prefixes defined in the node of the object on which the call is received. If the prefix is not defined in the node, the prefix defined in PBX/config is used. The type of number is then set to Unknown.
For SIP calls a '+' at the beginning of the number is treated as a Type international.

The type of number values for International, National and Subscriber are converted into their respective prefixes.

This way an international number obtained from a directory can be directly used for dialing.

=== PBX internal calls ===

For internal calls, especially when nodes are used, as calling party number the shortest possible number, which can be used for call back, is presented to the called endpoint.

=== PBX database used as LDAP database ===

The user database of the PBX can be used as a directory. In case of a configuration with nodes (e.164 configuration), at a given user only the number within the node is stored. As "otherTelephoneNumber" the complete number from the root node is provided.
If the config option "Adjust LDAP results for e.164" is set, a '+' is added as prefix to this number, so that it can be directly used to be dialed as international number.

== Phone App, Softphone App ==

The myApps Phone App and Softphone App get the for the node of the user configured prefixes in the AttachResult or RegisterResult messages. These prefixes are used to adjust numbers from directories before they are dialed:
* If the number starts with '+' it is sent as it is to the PBX. The PBX then does the adjustment.
* If the number starts with what is configured as international prefix, the number is sent as it is to the PBX.
* If the number seems to be an international number, which means it matches the international prefix with the subscriber prefix removed from the beginning, the subscriber prefix is added.
* If the number seems to be a national number, which means it matches the national prefix with the subscriber prefix removed from the beginning, the subscriber prefix is added.
* If the number is 7 digits or longer, the subscriber prefix is added. (This can be set as ''Max. length internal number'' in PBX/Config/General; a reset of the pbx and the myApps is needet after changes.)
Settings are applied to search results from sources via search-api-provider. Manually entered numbers are assumed to contain the respective trunk prefix.

== IOS Callkit ==

Before a number is sent to callkit a prefix, which matches the subscriber prefix is removed and added again when the call is actually sent to the PBX, so that the formating done in callkit, which works based on public numbers, works.

== Android ConnectionService (similar functionality as CallKit under IOS) ==

Before a number is sent to ConnectionService a prefix, which matches the subscriber prefix is removed and added again when the call is actually sent to the PBX, so that the formating done in ConnectionService, which works based on public numbers, works.

Reference15r1:PBX/Config/General

2025-04-28T14:09:25Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 IP-Addresses (Mixed IPv4 and IPv6 allowed but no DNS names) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX. (If you use a SAN certificate you have to enter the first SAN-Name)
:If empty addresses are used, unauthenticated registrations from unknown or internal addresses are not allowed, but any registration must be authenticated, with a password or the certificate from the reverse proxy.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).
'''Max. length internal number'''

In the phone and softphone App: If the number, witch is dialed is 7 digits or longer, the subscriber prefix is added. (A reset of the pbx and the myApps is needet after changes.)
;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security&action=edit&redlink=1|Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security&action=edit&redlink=1|Reference9:Administration/PBX/Security]]

Reference15r1:PBX/Config/General

2025-04-28T14:07:34Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 IP-Addresses (Mixed IPv4 and IPv6 allowed but no DNS names) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX. (If you use a SAN certificate you have to enter the first SAN-Name)
:If empty addresses are used, unauthenticated registrations from unknown or internal addresses are not allowed, but any registration must be authenticated, with a password or the certificate from the reverse proxy.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).
'''Max. length internal number'''

In the phone and softphone App: If the number, witch is dialed is 7 digits or longer, the subscriber prefix is added. (A reset of the pbx and the myapps is needet after changes.)
;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security&action=edit&redlink=1|Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security&action=edit&redlink=1|Reference9:Administration/PBX/Security]]

Reference13r1:Concept Number Adjustments (Dialing Location)

2025-04-28T08:45:40Z

Hawk: /* Phone App, Softphone App */

[[Category:Concept|Number Adjustments]]
Very often numbers are not available in the standard e.164 international format, but in subscriber or national format and maybe also formated with space, bracket, hyphens or other characters. This article defines all mechanisms in the innovaphone PBX used to adjust numbers. This can be the calling party number for display or for reverse lookup, or the called party number obtained from a directory or other purposes. These mechanisms are implemented in the PBX, the endpoints or in gateways.

== PBX ==

=== Incoming Calls from Trunks ===

A Calling Party Numbers sent in a call from the gateway to the trunk should be formated in a way, that it can be used to call back the caller, in the "Unknown Number" format. Which means it should contain any necessary prefixes for national or international numbers.

The PBX Trunk objects adds the Trunk number as prefix.

=== Reverse Lookup ===

The reverse lookup assumes that a directory exists for the numbers in the international format. For this reason, the number is converted to the international format for the lookup. The prefixes configured in the ''Node'' object are used for this purpose. If no prefixes are configured, the root node prefixes configured on the PBX/Config page are used.

The reverse lookup is performed when the call is sent out to a user, so for different users there can be different results.

* If the start of the number matches the prefix for international numbers, the prefix is removed and the resulting number is used for the lookup
* If the start of the number matches the prefix for national numbers, the prefix is removed and the country code is added. The resulting number is used for the lookup
* If the start of the number matches the prefix for subscriber numbers, the prefix is removed and the country code and area code are added. The resulting number is used for the lookup

=== Type of number handling ===

For any calls sent to the PBX, e.g. outgoing calls from phones, the type of number of the calling party number and called party number is converted to the prefixes defined in the node of the object on which the call is received. If the prefix is not defined in the node, the prefix defined in PBX/config is used. The type of number is then set to Unknown.
For SIP calls a '+' at the beginning of the number is treated as a Type international.

The type of number values for International, National and Subscriber are converted into their respective prefixes.

This way an international number obtained from a directory can be directly used for dialing.

=== PBX internal calls ===

For internal calls, especially when nodes are used, as calling party number the shortest possible number, which can be used for call back, is presented to the called endpoint.

=== PBX database used as LDAP database ===

The user database of the PBX can be used as a directory. In case of a configuration with nodes (e.164 configuration), at a given user only the number within the node is stored. As "otherTelephoneNumber" the complete number from the root node is provided.
If the config option "Adjust LDAP results for e.164" is set, a '+' is added as prefix to this number, so that it can be directly used to be dialed as international number.

== Phone App, Softphone App ==

The myApps Phone App and Softphone App get the for the node of the user configured prefixes in the AttachResult or RegisterResult messages. These prefixes are used to adjust numbers from directories before they are dialed:
* If the number starts with '+' it is sent as it is to the PBX. The PBX then does the adjustment.
* If the number starts with what is configured as international prefix, the number is sent as it is to the PBX.
* If the number seems to be an international number, which means it matches the international prefix with the subscriber prefix removed from the beginning, the subscriber prefix is added.
* If the number seems to be a national number, which means it matches the national prefix with the subscriber prefix removed from the beginning, the subscriber prefix is added.
* If the number is 7 digits or longer, the subscriber prefix is added. (This can be set as ''Max. length internal number'' in PBX/Config/General; a reset of the pbx and the myapps is needet after changes.)
Settings are applied to search results from sources via search-api-provider. Manually entered numbers are assumed to contain the respective trunk prefix.

== IOS Callkit ==

Before a number is sent to callkit a prefix, which matches the subscriber prefix is removed and added again when the call is actually sent to the PBX, so that the formating done in callkit, which works based on public numbers, works.

== Android ConnectionService (similar functionality as CallKit under IOS) ==

Before a number is sent to ConnectionService a prefix, which matches the subscriber prefix is removed and added again when the call is actually sent to the PBX, so that the formating done in ConnectionService, which works based on public numbers, works.

Reference13r1:Concept Number Adjustments (Dialing Location)

2025-04-28T08:44:19Z

Hawk: /* Phone App, Softphone App */

[[Category:Concept|Number Adjustments]]
Very often numbers are not available in the standard e.164 international format, but in subscriber or national format and maybe also formated with space, bracket, hyphens or other characters. This article defines all mechanisms in the innovaphone PBX used to adjust numbers. This can be the calling party number for display or for reverse lookup, or the called party number obtained from a directory or other purposes. These mechanisms are implemented in the PBX, the endpoints or in gateways.

== PBX ==

=== Incoming Calls from Trunks ===

A Calling Party Numbers sent in a call from the gateway to the trunk should be formated in a way, that it can be used to call back the caller, in the "Unknown Number" format. Which means it should contain any necessary prefixes for national or international numbers.

The PBX Trunk objects adds the Trunk number as prefix.

=== Reverse Lookup ===

The reverse lookup assumes that a directory exists for the numbers in the international format. For this reason, the number is converted to the international format for the lookup. The prefixes configured in the ''Node'' object are used for this purpose. If no prefixes are configured, the root node prefixes configured on the PBX/Config page are used.

The reverse lookup is performed when the call is sent out to a user, so for different users there can be different results.

* If the start of the number matches the prefix for international numbers, the prefix is removed and the resulting number is used for the lookup
* If the start of the number matches the prefix for national numbers, the prefix is removed and the country code is added. The resulting number is used for the lookup
* If the start of the number matches the prefix for subscriber numbers, the prefix is removed and the country code and area code are added. The resulting number is used for the lookup

=== Type of number handling ===

For any calls sent to the PBX, e.g. outgoing calls from phones, the type of number of the calling party number and called party number is converted to the prefixes defined in the node of the object on which the call is received. If the prefix is not defined in the node, the prefix defined in PBX/config is used. The type of number is then set to Unknown.
For SIP calls a '+' at the beginning of the number is treated as a Type international.

The type of number values for International, National and Subscriber are converted into their respective prefixes.

This way an international number obtained from a directory can be directly used for dialing.

=== PBX internal calls ===

For internal calls, especially when nodes are used, as calling party number the shortest possible number, which can be used for call back, is presented to the called endpoint.

=== PBX database used as LDAP database ===

The user database of the PBX can be used as a directory. In case of a configuration with nodes (e.164 configuration), at a given user only the number within the node is stored. As "otherTelephoneNumber" the complete number from the root node is provided.
If the config option "Adjust LDAP results for e.164" is set, a '+' is added as prefix to this number, so that it can be directly used to be dialed as international number.

== Phone App, Softphone App ==

The myApps Phone App and Softphone App get the for the node of the user configured prefixes in the AttachResult or RegisterResult messages. These prefixes are used to adjust numbers from directories before they are dialed:
* If the number starts with '+' it is sent as it is to the PBX. The PBX then does the adjustment
* If the number starts with what is configured as international prefix, the number is sent as it is to the PBX
* If the number seems to be an international number, which means it matches the international prefix with the subscriber prefix removed from the beginning, the subscriber prefix is added
* If the number seems to be a national number, which means it matches the national prefix with the subscriber prefix removed from the beginning, the subscriber prefix is added
* If the number is 7 digits or longer, the subscriber prefix is added. (This can be set as ''Max. length internal number'' in PBX/Config/General; a reset of the pbx and the myapps is needet after changes)
Settings are applied to search results from sources via search-api-provider. Manually entered numbers are assumed to contain the respective trunk prefix.

== IOS Callkit ==

Before a number is sent to callkit a prefix, which matches the subscriber prefix is removed and added again when the call is actually sent to the PBX, so that the formating done in callkit, which works based on public numbers, works.

== Android ConnectionService (similar functionality as CallKit under IOS) ==

Before a number is sent to ConnectionService a prefix, which matches the subscriber prefix is removed and added again when the call is actually sent to the PBX, so that the formating done in ConnectionService, which works based on public numbers, works.

Reference14r2:Concept App Service Recordings

2024-11-19T14:52:32Z

Hawk: /* Configuration */

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

== Requirements ==

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

== Apps ==

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

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

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

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

== PBX Manager Plugin ==

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

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

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

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

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

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

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

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

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

== Licensing ==

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

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

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

== Recording on Special Interfaces ==

* Trunk Interface/Gateway

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

* Waiting Queue

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

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

=== Compatibility ===

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

=== License Changes ===

Licensing is the same as version 14r1

=== Database Conversion ===

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

=== Update App Object configuration ===

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

=== Download recording ===

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

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

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

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

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

== 4 Eyes Access ==

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

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

== Notes ==
To each recording textual notes can be added. To achieve this a part of the [[{{NAMESPACE}}:Concept_App_Connect|Connect application]] is invoked. Pressing the "Note" button on the recording entry opens a window beneath the entry where the connect app is invoked. Input and Handling of the notes is as in the connect app. Pressing the "note" button again closes the window.
To enable this functionality the appropriate Connect application must be selected in the recordings pbxmanger plugin

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

== Troubleshooting ==

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

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

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

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

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

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

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

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

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

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

=== Notes from Recordings are not saved if RecordingsUser-Objects name is not "recordings" ===
The RecordingsUser object must be called “recordings”, otherwise no notes can be saved in Connect.
If the object needs to be renamed, the new app must be assigned to the user and the Connect instance must then be restarted.

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

2024-11-11T09:36:07Z

Hawk: /* Contacts APP */

[[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
* 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 SIP RVP TLS.png|Caption2
</gallery>

{| class="wikitable" style="margin-top:auto;margin-top: 0px;"
|
[[Image:Innovaphone GigasetApp Admin2.0 HTTP.png]]
|
[[Image: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]]

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

===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]]
 
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===
From Software V2.59 you are able to connect Gigaset DECT also with innovaphone Contacts APP.
Therefore a new Provisioning Parameter is implemented: 
'''<param name="LDAPDir.0.BlankFilter" value="(metaSearchNumber=0*)"/>''' 
For Reverse Lookup the numbers must be saved without +49, for example 02871 91-0 instead of +49 2871 91-0 
For Reverse Lookup you must set also a Provisioning Parameter, to change default behaviour: 
<param name="AreaCodes.0.Wildcarding" value="1" /> 
The LDAP Configuration into the Provisioning APP should looks like this: 
'''Namefilter field must filled with: "(metaSearchNumber=%)"''' 
[[Image:Provisioning_APP_Contacts_Parameter.png|500px]] 
You need to enter the Credentials from the Contacts APP. There are found into:
PBX-Manager --> AP Contacts --> Change Configuration 
Host : apps.firma.de (adress from the App-Platform) 
Port : 636 
LDAP : dc=entries 
Username : (you find it in PBX Manager / Ap contacts / edit configurations / User (LDAP)) 
Password (deutsche Oberfläche: Benutzername) : (you find it in PBX Manager / Ap contacts / edit configurations / Password(LDAP)) 
name filter (deutsche Oberfläche: Passwort) : (|(cn=%)(sn=%)) 
number filter (deutsche Oberfläche: Namensfilter) : (metaSearchNumber=%) 
all other like in the picture shown 
 

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

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

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

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

2024-11-08T09:16:43Z

Hawk: /* Contacts APP */

[[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
* 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 SIP RVP TLS.png|Caption2
</gallery>

{| class="wikitable" style="margin-top:auto;margin-top: 0px;"
|
[[Image:Innovaphone GigasetApp Admin2.0 HTTP.png]]
|
[[Image: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]]

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

===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]]
 
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===
From Software V2.59 you are able to connect Gigaset DECT also with innovaphone Contacts APP.
Therefore a new Provisioning Parameter is implemented: 
'''<param name="LDAPDir.0.BlankFilter" value="(metaSearchNumber=0*)"/>''' 
For Reverse Lookup the numbers must be saved without +49, for example 02871 91-0 instead of +49 2871 91-0 
For Reverse Lookup you must set also a Provisioning Parameter, to change default behaviour: 
<param name="AreaCodes.0.Wildcarding" value="1" /> 
The LDAP Configuration into the Provisioning APP should looks like this: 
'''Namefilter field must filled with: "(metaSearchNumber=%)"''' 
[[Image:Provisioning_APP_Contacts_Parameter.png|500px]] 
You need to enter the Credentials from the Contacts APP. There are found into:
PBX-Manager --> AP Contacts --> Change Configuration 
Host : apps.firma.de (adress from the App-Platform) 
Port : 636 
LDAP : dc=entries 
Username : (PBX Manager / Ap contacts / edit configurations / User (LDAP) 
Password (deutsche Oberfläche: Benutzername) : (PBX Manager / Ap contacts / edit configurations / Password(LDAP) 
name filter (deutsche Oberfläche: Passwort) : (|(cn=%)(sn=%)) 
number filter (deutsche Oberfläche: Namensfilter) : (metaSearchNumber=%) 

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

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

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

Reference9:PBX/Objects/DTMF Features

2024-11-06T07:35:39Z

Hawk: /* Pickup Directed */

The DTMF Features PBX object is no longer used just to configure call diversions via DTMF but also to use several other features. This is usefull for analog, dect (which already have their [[Reference8:Feature Codes|own feature codes]]) and softphone devices. 

Each configured feature code will be represented as own pbx object, but will be only editable through the main object. 

See [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties]] for generic object properties.
==Configuration==
Featurecodes can contain variable digits, which are defined by an '$', followed by a certain number of digits in brackets like '$(3)', which means, that three digits must be dialed or by a '#', which means, that a not specified count of digits is dialed, completed by a #, like '$#'. 
'''Note: do not use a '$' without brackets or '#', otherwise the code won't work as intended.'''

You can configure feature codes according to the following image:

[[Image:DTMF featuresV9.png|DTMF Features]]

For all features a default for the invocation code is defined, but this default can be changed on a per system basis. The following features are available:

===Mobility features===
Feature codes used in mobility scenarios have no default code and are disabled per default. 
If you want to use these codes you have to define their numbers according to your numbering plan, because one can't use the digits '*' and '#' from the mobile phone.

====Not working features with mobility====
Mobility users currently can't use the following features:
* pickup
* park
* call completion

===Calling over a gateway object===
From V8 Hotfix 3 on it won't be possible to call over a gateway object into the dtmf object, e.g. to prevent incoming mobility calls, which can't be assigned to a mobility user, to set a CFU on a trunk object.

==Call handling==
If you are calling the feature code with enblock dialing (setup contains the complete code), the call won't be connected, so there won't be any costs for this call. 
If you are calling with overlap dialing, the call will be connected just for the feature codes join and leave a single group.

==Features==

=== CFU activate/deactivate ===

These codes allows to activate and deactivate unconditional call forward for a given endpoint.
The default codes are *21*$# to activate and #21# to deactivate. $ stands for the number to which calls are forwarded.

=== CFB activate/deactivate ===

These codes allows to activate and deactivate call forward on busy for a given endpoint.
The default codes are *67*$# to activate and #67# to deactivate. $ stands for the number to which calls are forwarded.

=== CFNR activate/deactivate ===

These codes allows to activate and deactivate call forward on no response for a given endpoint.
The default codes are *61*$# to activate and #61# to deactivate. $ stands for the number to which calls are forwarded.

=== Pickup Group ===

With this feature code any call which is ringing within the configured groups can be picked.

The default code is *0#

Please note that pickup is not supported for mobility calls (neither group nor directed).

All members must be active in a group.

=== Pickup Directed ===

With this feature code a call which is ringing at a indicated extension number can be picked.

The default code is *0*$#. $ stands for the extension number from which the call shall be picked.

All members must be active in a group.

=== Park ===

These codes allow to park and uppark a call at the own extension number to a specified parking position.

The default code is *16$(1) to park and #16$(1) to unpark. $(1) stands for the single digit park position.

To dial the code for the park a consultation call has to be initiated with R (Flash).

Multidigit park positions are now possible. To use multidigit park positions, define the code like *16$#. $# stands for one or more digits, terminated by #. No digit will be canceled.

=== Park To ===

These codes allow to park and unpark a call to a specified park position at an specified extension number.

The default code is *17$(1)$# to park and #17$(1)$# to unpark. $(1) stands for the one digit park position and $ for the extension number.

To dial the code for the park a consultation call has to be initiated with R (Flash).

Multidigit park positions are now possible. To use multidigit park positions, define the code like #16$#. $# stands for one or more digits, terminated by #. No digit will be canceled.

=== Completion of Calls/CC Cancel ===

This code has to be dialed to initiate call completion to busy subscriber/call completion no response (ccbs/ccnr).
The default code for call completion is *37*$#. $ stands for the number to call complete.
The default code to cancel an active call completion is #37*$#.

=== Join/Leave Group ===

This code can be used to join or leave dynamic groups. After dialing the first part of the code, e.g. *31*, you get the first entry of an alphabetical sorted list of all available groups. You can scroll through this list using the '*' for the next group and the '1' for the previous group. You select the desired group with '#'.
 
Example with five groups:
1. group1 dynamic in
2. group2 dynamic in
3. group3 dynamic out
4. group4 static (static groups won't be shown)
5. group5 dynamic in

If you now dial the default join code *31*, you will first get group1 displayed. By pressing * twice, you have group3 and by using # you are joining this group.

If you are dialing the default leave code #31*, you will first get group1 too, as all in and out groups are shown independet of their current state.

There is also the possibility to select the desired group by index. So if you know that your desired group to join is the third group in the list (just the list of available groups, e.g. out state OR in state), just dial the index after the default code:
 #31*3# would select the third group, in this case group3 and leave it.
Group index 1 has to be followed by a *, as the 1 jumps to the previous group and the following * will jump to the next group, which is index 1 again.

From V8 Hotfix 9 onwards, dynamic in groups will be preceeded with '* '

=== Join/Leave all groups ===

With this feature code you can join or leave all dynamic groups at once. 
Default code for joining: *32# 
Default code for leaving: #32# 

=== Enable/disable mobility ===

With this feature code you can enable or disable the mobility by calling from the mobile phone. 
There are no default codes for these features. Suitable codes could look like this: 
Enabling: 041 
Disabling: 042 

=== Enable/disable mobility call waiting===

With this feature code you can enable or disable the mobility call waiting flag by calling from the mobile phone. 
There are no default codes for these features. Suitable codes could look like this: 
enabling: 043 
disabling: 044 

=== Un/Set presence ===

This allows you to set [[Reference8:Administration/PBX/Objects/Edit Presence|presence]] information for the calling user. 
There is no default code for this feature, as you have to define it according to your numbering plan. There is one parameters for this feature. It sets the activity and the note to a preconfigured pair (exactly one digit). 
So a suitable code could look like '''040$(1)'''.

You have a third tab on the configuration page of the pbx dtmf object, where you can configure 10 activity/note pairs (digit 0 - 9).
 
The unset presence feature code is used to unset the current presence activity and note.
A suitable code could look like '''041''', as no parameter is needed..
 
For both the set and unset presence feature codes, a further parameter can be configured to enable/disable mobility. 
If given, the parameter must be one char long and enables mobility on digit '1' and disables it on digit '0'. 
 
A suitable set presence code would be '''040$(1)$(1)''' and unset '''041$(1)'''.

== Common node and loc configuration for DTMF CTRL ==

=== Concept 1 ===

pbx - empty 
node - empty 
local - on 

Object should be called on the pbx, where the endpoint is registered. Independent of node/pbx of the calling endpoint and also from escapes, which might be set on the node of the calling endpoint.

DTMF CTRL is replicated via LDAP, independent of pbx/node.

=== Concept 2 ===

pbx - empty 
node - root 
local - off 

Similar to 1, but DTMF CTRL can't be called out of nodes with prefixes. If an endpoint is registered on a slave, but redirected from a master, the call is rerouted to master and back.

DTMF CTRL is replicated via LDAP, independent of pbx.

=== Concept 3 ===

pbx - name of pbx 
node - name of node 
local - off 

Must be dialed with node prefix if called from another node. Is processed on configured pbx.

== Known Problems ==

An alarm might occur if you upgrade from a V6, because the pickup string is currently configured under PBX->General.
See the [[Reference:Administration/Diagnostics/Events/0x00020002|alarm description]] for more information.

===Join/leave Group over Number Map if you have more than 9 Groups===
If you use more than 9 groups and a number-map object to join/leave groups you have to use a * for each digit from the group number. Example. In your number map you map the *31# for the first group, *31**# for the second group etc.

Reference9:PBX/Objects/DTMF Features

2024-11-06T07:34:51Z

Hawk: /* Pickup Group */

The DTMF Features PBX object is no longer used just to configure call diversions via DTMF but also to use several other features. This is usefull for analog, dect (which already have their [[Reference8:Feature Codes|own feature codes]]) and softphone devices. 

Each configured feature code will be represented as own pbx object, but will be only editable through the main object. 

See [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties]] for generic object properties.
==Configuration==
Featurecodes can contain variable digits, which are defined by an '$', followed by a certain number of digits in brackets like '$(3)', which means, that three digits must be dialed or by a '#', which means, that a not specified count of digits is dialed, completed by a #, like '$#'. 
'''Note: do not use a '$' without brackets or '#', otherwise the code won't work as intended.'''

You can configure feature codes according to the following image:

[[Image:DTMF featuresV9.png|DTMF Features]]

For all features a default for the invocation code is defined, but this default can be changed on a per system basis. The following features are available:

===Mobility features===
Feature codes used in mobility scenarios have no default code and are disabled per default. 
If you want to use these codes you have to define their numbers according to your numbering plan, because one can't use the digits '*' and '#' from the mobile phone.

====Not working features with mobility====
Mobility users currently can't use the following features:
* pickup
* park
* call completion

===Calling over a gateway object===
From V8 Hotfix 3 on it won't be possible to call over a gateway object into the dtmf object, e.g. to prevent incoming mobility calls, which can't be assigned to a mobility user, to set a CFU on a trunk object.

==Call handling==
If you are calling the feature code with enblock dialing (setup contains the complete code), the call won't be connected, so there won't be any costs for this call. 
If you are calling with overlap dialing, the call will be connected just for the feature codes join and leave a single group.

==Features==

=== CFU activate/deactivate ===

These codes allows to activate and deactivate unconditional call forward for a given endpoint.
The default codes are *21*$# to activate and #21# to deactivate. $ stands for the number to which calls are forwarded.

=== CFB activate/deactivate ===

These codes allows to activate and deactivate call forward on busy for a given endpoint.
The default codes are *67*$# to activate and #67# to deactivate. $ stands for the number to which calls are forwarded.

=== CFNR activate/deactivate ===

These codes allows to activate and deactivate call forward on no response for a given endpoint.
The default codes are *61*$# to activate and #61# to deactivate. $ stands for the number to which calls are forwarded.

=== Pickup Group ===

With this feature code any call which is ringing within the configured groups can be picked.

The default code is *0#

Please note that pickup is not supported for mobility calls (neither group nor directed).

All members must be active in a group.

=== Pickup Directed ===

With this feature code a call which is ringing at a indicated extension number can be picked.

The default code is *0*$#. $ stands for the extension number from which the call shall be picked.

=== Park ===

These codes allow to park and uppark a call at the own extension number to a specified parking position.

The default code is *16$(1) to park and #16$(1) to unpark. $(1) stands for the single digit park position.

To dial the code for the park a consultation call has to be initiated with R (Flash).

Multidigit park positions are now possible. To use multidigit park positions, define the code like *16$#. $# stands for one or more digits, terminated by #. No digit will be canceled.

=== Park To ===

These codes allow to park and unpark a call to a specified park position at an specified extension number.

The default code is *17$(1)$# to park and #17$(1)$# to unpark. $(1) stands for the one digit park position and $ for the extension number.

To dial the code for the park a consultation call has to be initiated with R (Flash).

Multidigit park positions are now possible. To use multidigit park positions, define the code like #16$#. $# stands for one or more digits, terminated by #. No digit will be canceled.

=== Completion of Calls/CC Cancel ===

This code has to be dialed to initiate call completion to busy subscriber/call completion no response (ccbs/ccnr).
The default code for call completion is *37*$#. $ stands for the number to call complete.
The default code to cancel an active call completion is #37*$#.

=== Join/Leave Group ===

This code can be used to join or leave dynamic groups. After dialing the first part of the code, e.g. *31*, you get the first entry of an alphabetical sorted list of all available groups. You can scroll through this list using the '*' for the next group and the '1' for the previous group. You select the desired group with '#'.
 
Example with five groups:
1. group1 dynamic in
2. group2 dynamic in
3. group3 dynamic out
4. group4 static (static groups won't be shown)
5. group5 dynamic in

If you now dial the default join code *31*, you will first get group1 displayed. By pressing * twice, you have group3 and by using # you are joining this group.

If you are dialing the default leave code #31*, you will first get group1 too, as all in and out groups are shown independet of their current state.

There is also the possibility to select the desired group by index. So if you know that your desired group to join is the third group in the list (just the list of available groups, e.g. out state OR in state), just dial the index after the default code:
 #31*3# would select the third group, in this case group3 and leave it.
Group index 1 has to be followed by a *, as the 1 jumps to the previous group and the following * will jump to the next group, which is index 1 again.

From V8 Hotfix 9 onwards, dynamic in groups will be preceeded with '* '

=== Join/Leave all groups ===

With this feature code you can join or leave all dynamic groups at once. 
Default code for joining: *32# 
Default code for leaving: #32# 

=== Enable/disable mobility ===

With this feature code you can enable or disable the mobility by calling from the mobile phone. 
There are no default codes for these features. Suitable codes could look like this: 
Enabling: 041 
Disabling: 042 

=== Enable/disable mobility call waiting===

With this feature code you can enable or disable the mobility call waiting flag by calling from the mobile phone. 
There are no default codes for these features. Suitable codes could look like this: 
enabling: 043 
disabling: 044 

=== Un/Set presence ===

This allows you to set [[Reference8:Administration/PBX/Objects/Edit Presence|presence]] information for the calling user. 
There is no default code for this feature, as you have to define it according to your numbering plan. There is one parameters for this feature. It sets the activity and the note to a preconfigured pair (exactly one digit). 
So a suitable code could look like '''040$(1)'''.

You have a third tab on the configuration page of the pbx dtmf object, where you can configure 10 activity/note pairs (digit 0 - 9).
 
The unset presence feature code is used to unset the current presence activity and note.
A suitable code could look like '''041''', as no parameter is needed..
 
For both the set and unset presence feature codes, a further parameter can be configured to enable/disable mobility. 
If given, the parameter must be one char long and enables mobility on digit '1' and disables it on digit '0'. 
 
A suitable set presence code would be '''040$(1)$(1)''' and unset '''041$(1)'''.

== Common node and loc configuration for DTMF CTRL ==

=== Concept 1 ===

pbx - empty 
node - empty 
local - on 

Object should be called on the pbx, where the endpoint is registered. Independent of node/pbx of the calling endpoint and also from escapes, which might be set on the node of the calling endpoint.

DTMF CTRL is replicated via LDAP, independent of pbx/node.

=== Concept 2 ===

pbx - empty 
node - root 
local - off 

Similar to 1, but DTMF CTRL can't be called out of nodes with prefixes. If an endpoint is registered on a slave, but redirected from a master, the call is rerouted to master and back.

DTMF CTRL is replicated via LDAP, independent of pbx.

=== Concept 3 ===

pbx - name of pbx 
node - name of node 
local - off 

Must be dialed with node prefix if called from another node. Is processed on configured pbx.

== Known Problems ==

An alarm might occur if you upgrade from a V6, because the pickup string is currently configured under PBX->General.
See the [[Reference:Administration/Diagnostics/Events/0x00020002|alarm description]] for more information.

===Join/leave Group over Number Map if you have more than 9 Groups===
If you use more than 9 groups and a number-map object to join/leave groups you have to use a * for each digit from the group number. Example. In your number map you map the *31# for the first group, *31**# for the second group etc.

Reference14r2:Concept App Service Working

2024-10-23T14:45:42Z

Hawk: /* innovaphone-working-admin */

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

* innovaphone PBX from version 14r2

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

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) to display the working time information for all users and where the configuration settings can be changed.
The app is designed to help employees and employers to easily track working hours in a digital manner.

==How it works==

The first time a user starts the Working App on myApps a new entry is created in the database for this user, based on the "Name" of this user, which will be used to store all the working hours entries, vacation days, sick days and national holidays. Entering the working hours is a two step task, because after defining the start/stop time it is also necessary to "confirm/submit" these hours as correct, after the confirmation is done the user can't change them anymore and they will be displayed on the admin app.

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

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. This can be done by clicking on the start/stop button. The user have also a calendar view to add, edit or delete working hours.

=== innovaphone-working-api ===
[[Image: Innovaphone-working-api.png]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

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

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

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Periodic reports are generated with a list of users who do not comply with the hours restrictions. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

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

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

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

* No email reports are available on 14r2

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

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

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

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

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

'''Absences'''

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

'''Times'''

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

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

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

'''Absences'''

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

'''Times'''

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

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

== PBX Manager Plugins ==

=== Working ===

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

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

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

Trace flags for myApps Client:
*Browser Console

==Known issues==

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

Reference14r2:Concept App Service Working

2024-10-23T14:43:56Z

Hawk: /* innovaphone-working-admin */

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

* innovaphone PBX from version 14r2

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

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) to display the working time information for all users and where the configuration settings can be changed.
The app is designed to help employees and employers to easily track working hours in a digital manner.

==How it works==

The first time a user starts the Working App on myApps a new entry is created in the database for this user, based on the "Name" of this user, which will be used to store all the working hours entries, vacation days, sick days and national holidays. Entering the working hours is a two step task, because after defining the start/stop time it is also necessary to "confirm/submit" these hours as correct, after the confirmation is done the user can't change them anymore and they will be displayed on the admin app.

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

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. This can be done by clicking on the start/stop button. The user have also a calendar view to add, edit or delete working hours.

=== innovaphone-working-api ===
[[Image: Innovaphone-working-api.png]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

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

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

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Periodic reports are generated with a list of users who do not comply with the hours restrictions. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

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

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

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

* No email reports are available on 14r2

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

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

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

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

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

'''Absences'''

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

'''Times'''

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

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

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

'''Absences'''

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

'''Times'''

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

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

== PBX Manager Plugins ==

=== Working ===

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

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

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

Trace flags for myApps Client:
*Browser Console

==Known issues==

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

Reference14r2:Concept App Service Working

2024-10-23T13:23:03Z

Hawk: /* Configuration */

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

* innovaphone PBX from version 14r2

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

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) to display the working time information for all users and where the configuration settings can be changed.
The app is designed to help employees and employers to easily track working hours in a digital manner.

==How it works==

The first time a user starts the Working App on myApps a new entry is created in the database for this user, based on the "Name" of this user, which will be used to store all the working hours entries, vacation days, sick days and national holidays. Entering the working hours is a two step task, because after defining the start/stop time it is also necessary to "confirm/submit" these hours as correct, after the confirmation is done the user can't change them anymore and they will be displayed on the admin app.

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

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. This can be done by clicking on the start/stop button. The user have also a calendar view to add, edit or delete working hours.

=== innovaphone-working-api ===
[[Image: Innovaphone-working-api.png]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

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

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

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Periodic reports are generated with a list of users who do not comply with the hours restrictions. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

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

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

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

* No email reports are available on 14r2

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

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

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

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

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

'''Absences'''

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

'''Times'''

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

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

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

'''Absences'''

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

'''Times'''

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

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

== PBX Manager Plugins ==

=== Working ===

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

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

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

Trace flags for myApps Client:
*Browser Console

==Known issues==

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

Reference14r2:Concept App Service Working

2024-10-23T13:18:42Z

Hawk: /* innovaphone-working-admin */

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

* innovaphone PBX from version 14r2

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

==Concept==

The innovaphone Service Working App is an app to track working hours.
There is a user app (Working User) to start/stop time tracking (clock style) or to add entries manually. These entries must be confirmed (=submitted) to be displayed on the admin app. Once they are confirmed, they can no longer be edited. There is also an admin app (Working Manager) to display the working time information for all users and where the configuration settings can be changed.
The app is designed to help employees and employers to easily track working hours in a digital manner.

==How it works==

The first time a user starts the Working App on myApps a new entry is created in the database for this user, based on the "Name" of this user, which will be used to store all the working hours entries, vacation days, sick days and national holidays. Entering the working hours is a two step task, because after defining the start/stop time it is also necessary to "confirm/submit" these hours as correct, after the confirmation is done the user can't change them anymore and they will be displayed on the admin app.

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

== Apps ==
=== innovaphone-working ===
[[Image: Innovaphone-working.png]]
This is an app (Working User), where the user can enter the working hours, holidays, sick and vacation days. This can be done by clicking on the start/stop button. The user have also a calendar view to add, edit or delete working hours.

=== innovaphone-working-api ===
[[Image: Innovaphone-working-api.png]]
This is a hidden app (Working Api), where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

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

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

Parameters:
;Websocket: to set a websocket connection.

=== innovaphone-working-admin ===
[[Image: Innovaphone-working-admin.png‎]]
This is an admin app (Working Manager), where an administrator (i.e. Human Resources) can see the users' working hours. Periodic reports are generated with a list of users who do not comply with the hours restrictions. Several settings like the working hours per day can be configured per user and they are set to 8 hours from monday to friday by default.

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

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

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

* No email reports are available on 14r2

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

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

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

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

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

'''Absences'''

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

'''Times'''

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

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

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

'''Absences'''

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

'''Times'''

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

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

== PBX Manager Plugins ==

=== Working ===

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

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

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

Trace flags for myApps Client:
*Browser Console

==Known issues==

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

Howto:MyApps Cloud - Using Gigaset-Provisioning-App in innovaphone cloud environments

2024-07-22T07:40:55Z

Hawk: /* View on the Gigaset Provisioning App */

[[Category:myApps_Cloud|Gigaset|{{PAGENAME}}]]

__toc__

=Disclaimer=
Gigaset is a 3rd party brand. As such, innovaphone is not liable for any malfunction of the Gigaset firmware or Gigaset-Provisioning-App itself, or malfunction caused through or due to changes in the Gigaset firmware or Gigaset-Provisioning-App.

=Applies To=
*This article is only intended as a supplement to the detailed configuration description from our colleagues at Gigaset.
**[[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App | ''Howto:Gigaset-Provisioning-App'']]
*It is often difficult to match the field names in the Gigaset Provisioning App with the names from the innovaphone myApps Cloud.
**We will therefore provide additional example screenshots of the configuration windows with terms from our cloud environment here.
*The Gigaset Provisioning App is a 3rd party product which is not permanently tested by innovaphone for functionality in our cloud environments.
**If you have any '''comments on changes''' or '''errors in this article''', you are welcome to send them in a Ticket to [Mailto:cloud@innovaphone.com Cloud-Support].

==Special thanks==
*The description of the implementation on our innovaphone myApps Cloud platforms was primarily created by Mr. Martin Pfeiffer from Mehrens.
*He tested this together with another reseller in our cloud on a Gigaset N870 and provided us with his results.
 

=Be aware of the following=

==How do I get the necessary SIP ports for my cloud instance forwarded?==
Open a Ticket via [Mailto:cloud@innovaphone.com Cloud-Support] 
*'''Subject:'''
**''Instance-Number|Cloud-Instance-Domain-Name'' - Gigaset-Prov-App Port enabling on RP
*'''Text:
Dear Cloud-Team, 
Please set up our necessary host forwardings for SIP in your central RP. 
Port 5061 TLS 
(''Port 5060 TCP'' ... only if you wish / you need this port ... see below [[Howto:MyApps_Cloud_-_Using_Gigaset-Provisioning-App_in_innovaphone_cloud_environments#Known_Issues | ''Known Issues'']]) 
- ''xxx-a(apps).innovaphone.com'' (address of the App Platform) 
- ''xxx-p(pbx).innovaphone.com'' (address of the PBX) 
 

==View on the Gigaset Provisioning App==
Recommended configuration
[[Image: gspapp_config.png|thumb|upright=1.0|right|Gigaset-Provisioning-App config]]
[[Image: gspapp_LDAP.png|thumb|upright=1.0|right|LDAP Directory, config]]

{| class="wikitable" border="1" cellspacing="1" cellpadding="10" style="text-align:left; font-size:13px; font-family:Arial, Helvetica, sans-serif !important;;"
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''innovaphone environment/settings'''
|-
| SIP domain
| cloud.muster.de
| (System Name of PBX)
|-
| SIP server
| cloudmuster-p.innovaphone.com
| (DNS of the PBX)
|-
| Port
| 5061
| (or if needed 5060)
|-
| TLS ''checkbox''
| check
| (or 'uncheck' if you need 5060)
|-
| MasterPBX Name
| master
| ('master' for PBX Name is our cloud default)
|-
| PBX password
| 123xxx78
| ('''NOT''' the admin or domain password)
|-
| Handset display name fallback
| Longname
|
|-
| Reverse-Proxy ''checkbox''
| Enabled
|
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Gigaset environment/settings'''
|-
| Connecting using ''checkbox''
| SIP
|
|-
| Gigaset Integrator MAC-ID
| 549EC2xxxx60'''-4xx7'''
| (from 'state' of the master antenna - possibly named iPUI)
|-
| SIP Realm in App Service
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| App Platform FQDN
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| Port
| 5061
|
|-
| TLS ''checkbox''
| check
|
|-
| Gigaset Integrator Password
| 12x4
| (Password of the Gigaset master antenna for the user 'admin')
|-
| SIP username
| gigasetuser
| (create a user in the PBX with this name)
|-
| SIP password
| 56x8
| (Password of the 'gigasetuser')
|-
| DECT frequency
| Europa
|
|-
| Registration window in seconds
| 300
| (is default)
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Phone number formatting'''
|-
| Access code
| 0
|
|-
| Prefix for Int/Ntl/Subsciber
| 00
| 0
|-
| Dialing location
| 49
| 7031 (your prefix)
|-
| internal number length
| e.g. 3
| (or '73009' your main phone number)
|-
| wildcarding ''checkbox''
| check
| (or uncheck if you use your main phone number)
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Directory settings'''
|-
| Directory synchronisation ''checkbox''
| On
|
|-
| Source
| cloudmuster-p.innovaphone.com
| Port 636
|-
| TLS ''checkbox''
| check
|
|-
| App Platform FQDN
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| Username & Password
|
|
|-
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Append your own provisioning parameters in XML format'''
|-
| Copy the 'Provisioning path'
|''http'''s'''://cloudmuster-a.innovaphone.com/cloud.muster.de/Giga...'' (if necessary change http: to http'''s''':)
| (... see below [[Howto:MyApps_Cloud_-_Using_Gigaset-Provisioning-App_in_innovaphone_cloud_environments#Known_Issues | ''Known Issues'']])
|-
| '' Set auto update intervall''
| '' <param name="Provisioning.global.Period" value="time in seconds" />''
|-
| '''Save changes''' and start provisioning
| click on the ''floppy disk icon''
|
|-
|}
 

==View on the settings in the Gigaset Integrator==
Continue on the customer side with the master antenna
[[Image: gspapp_ProvPath.png|thumb|upright=1.0|right|provisioning path, start config]]

*Navigate to:
**Settings > System > Provisioning and configuration > Provisioning server
*Insert copied provisioning path:
**http'''s'''://cloudmuster-a.innovaphone.com/cloud.muster.de/Giga...
*Then click on
**'''Start auto configuration'''
**This must also be done after any changes in the Gigaset Provisioning App!
 

==Collection of further possibly helpful screenshots==
*Gigasetuser configuration on the PBX
[[Image: gspapp_gigasetuser.png|thumb|upright=1.0|right|gigasetuser, config]]
 
 
 

*Checking the ''auto configuration'' on the Gigaset Integrator
*Provider profil 'innovaphone'
[[Image: gspapp_profile.png|thumb|upright=1.0|right|check, Gigaset profiles]]
 
 
 

*Handset registration
[[Image: gspapp_HandsetReg.png|thumb|upright=1.0|right|check, handset registration]]
 
 
 

=Known Issues=
*It has been shown in field projects, that although the SIP registrations/connections generally work with TLS (5061) ...
**... but they are often more stable with 5060.
*The provisioning link from the Gigaset Provisioning App is possibly created as an http link ...
**... but it only works in the Gigaset Integrator as an http'''s''' link.
*When provisioning the handsets, the Gigaset MAC/'''iPUI''' can be read on the box (you require this with the UsersAdmin).
**If you have many handsets, it can also be done using a standard barcode scanner.
*Check whether the checkboxes for ''PBX Pwd'', ''Reverse Proxy'' and ''Media Relay'' were automatically set in the user object when the phone was created for the user.
**Set manually if necessary. [[Image: gspapp_pwd-rp-mrelay.png|thumb|upright=1.0|right|user devices, checkboxes]]
 

== Related Articles ==
*[[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App | ''Howto:Gigaset-Provisioning-App'']]

Howto:MyApps Cloud - Using Gigaset-Provisioning-App in innovaphone cloud environments

2024-07-22T07:39:38Z

Hawk: /* View on the Gigaset Provisioning App */

[[Category:myApps_Cloud|Gigaset|{{PAGENAME}}]]

__toc__

=Disclaimer=
Gigaset is a 3rd party brand. As such, innovaphone is not liable for any malfunction of the Gigaset firmware or Gigaset-Provisioning-App itself, or malfunction caused through or due to changes in the Gigaset firmware or Gigaset-Provisioning-App.

=Applies To=
*This article is only intended as a supplement to the detailed configuration description from our colleagues at Gigaset.
**[[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App | ''Howto:Gigaset-Provisioning-App'']]
*It is often difficult to match the field names in the Gigaset Provisioning App with the names from the innovaphone myApps Cloud.
**We will therefore provide additional example screenshots of the configuration windows with terms from our cloud environment here.
*The Gigaset Provisioning App is a 3rd party product which is not permanently tested by innovaphone for functionality in our cloud environments.
**If you have any '''comments on changes''' or '''errors in this article''', you are welcome to send them in a Ticket to [Mailto:cloud@innovaphone.com Cloud-Support].

==Special thanks==
*The description of the implementation on our innovaphone myApps Cloud platforms was primarily created by Mr. Martin Pfeiffer from Mehrens.
*He tested this together with another reseller in our cloud on a Gigaset N870 and provided us with his results.
 

=Be aware of the following=

==How do I get the necessary SIP ports for my cloud instance forwarded?==
Open a Ticket via [Mailto:cloud@innovaphone.com Cloud-Support] 
*'''Subject:'''
**''Instance-Number|Cloud-Instance-Domain-Name'' - Gigaset-Prov-App Port enabling on RP
*'''Text:
Dear Cloud-Team, 
Please set up our necessary host forwardings for SIP in your central RP. 
Port 5061 TLS 
(''Port 5060 TCP'' ... only if you wish / you need this port ... see below [[Howto:MyApps_Cloud_-_Using_Gigaset-Provisioning-App_in_innovaphone_cloud_environments#Known_Issues | ''Known Issues'']]) 
- ''xxx-a(apps).innovaphone.com'' (address of the App Platform) 
- ''xxx-p(pbx).innovaphone.com'' (address of the PBX) 
 

==View on the Gigaset Provisioning App==
Recommended configuration
[[Image: gspapp_config.png|thumb|upright=1.0|right|Gigaset-Provisioning-App config]]
[[Image: gspapp_LDAP.png|thumb|upright=1.0|right|LDAP Directory, config]]

{| class="wikitable" border="1" cellspacing="1" cellpadding="10" style="text-align:left; font-size:13px; font-family:Arial, Helvetica, sans-serif !important;;"
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''innovaphone environment/settings'''
|-
| SIP domain
| cloud.muster.de
| (System Name of PBX)
|-
| SIP server
| cloudmuster-p.innovaphone.com
| (DNS of the PBX)
|-
| Port
| 5061
| (or if needed 5060)
|-
| TLS ''checkbox''
| check
| (or 'uncheck' if you need 5060)
|-
| MasterPBX Name
| master
| ('master' for PBX Name is our cloud default)
|-
| PBX password
| 123xxx78
| ('''NOT''' the admin or domain password)
|-
| Handset display name fallback
| Longname
|
|-
| Reverse-Proxy ''checkbox''
| Enabled
|
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Gigaset environment/settings'''
|-
| Connecting using ''checkbox''
| SIP
|
|-
| Gigaset Integrator MAC-ID
| 549EC2xxxx60'''-4xx7'''
| (from 'state' of the master antenna - possibly named iPUI)
|-
| SIP Realm in App Service
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| App Platform FQDN
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| Port
| 5061
|
|-
| TLS ''checkbox''
| check
|
|-
| Gigaset Integrator Password
| 12x4
| (Password of the Gigaset master antenna for the user 'admin')
|-
| SIP username
| gigasetuser
| (create a user in the PBX with this name)
|-
| SIP password
| 56x8
| (Password of the 'gigasetuser')
|-
| DECT frequency
| Europa
|
|-
| Registration window in seconds
| 300
| (is default)
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Phone number formatting'''
|-
| Access code
| 0
|
|-
| Prefix for Int/Ntl/Subsciber
| 00
| 0
|-
| Dialing location
| 49
| 7031 (your prefix)
|-
| internal number length
| e.g. 3
| (or '73009' your main phone number)
|-
| wildcarding ''checkbox''
| check
| (or uncheck if you use your main phone number)
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Directory settings'''
|-
| Directory synchronisation ''checkbox''
| On
|
|-
| Source
| cloudmuster-p.innovaphone.com
| Port 636
|-
| TLS ''checkbox''
| check
|
|-
| App Platform FQDN
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| Username & Password
|
|
|-
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Append your own provisioning parameters in XML format'''
|-
| Copy the 'Provisioning path'
|''http'''s'''://cloudmuster-a.innovaphone.com/cloud.muster.de/Giga...'' (if necessary change http: to http'''s''':)
| (... see below [[Howto:MyApps_Cloud_-_Using_Gigaset-Provisioning-App_in_innovaphone_cloud_environments#Known_Issues | ''Known Issues'']])
|-
|
| '' ''<param name="Provisioning.global.Period" value="time in seconds" />''
|-
| '''Save changes''' and start provisioning
| click on the ''floppy disk icon''
|
|-
|}
 

==View on the settings in the Gigaset Integrator==
Continue on the customer side with the master antenna
[[Image: gspapp_ProvPath.png|thumb|upright=1.0|right|provisioning path, start config]]

*Navigate to:
**Settings > System > Provisioning and configuration > Provisioning server
*Insert copied provisioning path:
**http'''s'''://cloudmuster-a.innovaphone.com/cloud.muster.de/Giga...
*Then click on
**'''Start auto configuration'''
**This must also be done after any changes in the Gigaset Provisioning App!
 

==Collection of further possibly helpful screenshots==
*Gigasetuser configuration on the PBX
[[Image: gspapp_gigasetuser.png|thumb|upright=1.0|right|gigasetuser, config]]
 
 
 

*Checking the ''auto configuration'' on the Gigaset Integrator
*Provider profil 'innovaphone'
[[Image: gspapp_profile.png|thumb|upright=1.0|right|check, Gigaset profiles]]
 
 
 

*Handset registration
[[Image: gspapp_HandsetReg.png|thumb|upright=1.0|right|check, handset registration]]
 
 
 

=Known Issues=
*It has been shown in field projects, that although the SIP registrations/connections generally work with TLS (5061) ...
**... but they are often more stable with 5060.
*The provisioning link from the Gigaset Provisioning App is possibly created as an http link ...
**... but it only works in the Gigaset Integrator as an http'''s''' link.
*When provisioning the handsets, the Gigaset MAC/'''iPUI''' can be read on the box (you require this with the UsersAdmin).
**If you have many handsets, it can also be done using a standard barcode scanner.
*Check whether the checkboxes for ''PBX Pwd'', ''Reverse Proxy'' and ''Media Relay'' were automatically set in the user object when the phone was created for the user.
**Set manually if necessary. [[Image: gspapp_pwd-rp-mrelay.png|thumb|upright=1.0|right|user devices, checkboxes]]
 

== Related Articles ==
*[[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App | ''Howto:Gigaset-Provisioning-App'']]

Howto:MyApps Cloud - Using Gigaset-Provisioning-App in innovaphone cloud environments

2024-07-22T07:38:17Z

Hawk: /* View on the Gigaset Provisioning App */

[[Category:myApps_Cloud|Gigaset|{{PAGENAME}}]]

__toc__

=Disclaimer=
Gigaset is a 3rd party brand. As such, innovaphone is not liable for any malfunction of the Gigaset firmware or Gigaset-Provisioning-App itself, or malfunction caused through or due to changes in the Gigaset firmware or Gigaset-Provisioning-App.

=Applies To=
*This article is only intended as a supplement to the detailed configuration description from our colleagues at Gigaset.
**[[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App | ''Howto:Gigaset-Provisioning-App'']]
*It is often difficult to match the field names in the Gigaset Provisioning App with the names from the innovaphone myApps Cloud.
**We will therefore provide additional example screenshots of the configuration windows with terms from our cloud environment here.
*The Gigaset Provisioning App is a 3rd party product which is not permanently tested by innovaphone for functionality in our cloud environments.
**If you have any '''comments on changes''' or '''errors in this article''', you are welcome to send them in a Ticket to [Mailto:cloud@innovaphone.com Cloud-Support].

==Special thanks==
*The description of the implementation on our innovaphone myApps Cloud platforms was primarily created by Mr. Martin Pfeiffer from Mehrens.
*He tested this together with another reseller in our cloud on a Gigaset N870 and provided us with his results.
 

=Be aware of the following=

==How do I get the necessary SIP ports for my cloud instance forwarded?==
Open a Ticket via [Mailto:cloud@innovaphone.com Cloud-Support] 
*'''Subject:'''
**''Instance-Number|Cloud-Instance-Domain-Name'' - Gigaset-Prov-App Port enabling on RP
*'''Text:
Dear Cloud-Team, 
Please set up our necessary host forwardings for SIP in your central RP. 
Port 5061 TLS 
(''Port 5060 TCP'' ... only if you wish / you need this port ... see below [[Howto:MyApps_Cloud_-_Using_Gigaset-Provisioning-App_in_innovaphone_cloud_environments#Known_Issues | ''Known Issues'']]) 
- ''xxx-a(apps).innovaphone.com'' (address of the App Platform) 
- ''xxx-p(pbx).innovaphone.com'' (address of the PBX) 
 

==View on the Gigaset Provisioning App==
Recommended configuration
[[Image: gspapp_config.png|thumb|upright=1.0|right|Gigaset-Provisioning-App config]]
[[Image: gspapp_LDAP.png|thumb|upright=1.0|right|LDAP Directory, config]]

{| class="wikitable" border="1" cellspacing="1" cellpadding="10" style="text-align:left; font-size:13px; font-family:Arial, Helvetica, sans-serif !important;;"
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''innovaphone environment/settings'''
|-
| SIP domain
| cloud.muster.de
| (System Name of PBX)
|-
| SIP server
| cloudmuster-p.innovaphone.com
| (DNS of the PBX)
|-
| Port
| 5061
| (or if needed 5060)
|-
| TLS ''checkbox''
| check
| (or 'uncheck' if you need 5060)
|-
| MasterPBX Name
| master
| ('master' for PBX Name is our cloud default)
|-
| PBX password
| 123xxx78
| ('''NOT''' the admin or domain password)
|-
| Handset display name fallback
| Longname
|
|-
| Reverse-Proxy ''checkbox''
| Enabled
|
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Gigaset environment/settings'''
|-
| Connecting using ''checkbox''
| SIP
|
|-
| Gigaset Integrator MAC-ID
| 549EC2xxxx60'''-4xx7'''
| (from 'state' of the master antenna - possibly named iPUI)
|-
| SIP Realm in App Service
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| App Platform FQDN
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| Port
| 5061
|
|-
| TLS ''checkbox''
| check
|
|-
| Gigaset Integrator Password
| 12x4
| (Password of the Gigaset master antenna for the user 'admin')
|-
| SIP username
| gigasetuser
| (create a user in the PBX with this name)
|-
| SIP password
| 56x8
| (Password of the 'gigasetuser')
|-
| DECT frequency
| Europa
|
|-
| Registration window in seconds
| 300
| (is default)
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Phone number formatting'''
|-
| Access code
| 0
|
|-
| Prefix for Int/Ntl/Subsciber
| 00
| 0
|-
| Dialing location
| 49
| 7031 (your prefix)
|-
| internal number length
| e.g. 3
| (or '73009' your main phone number)
|-
| wildcarding ''checkbox''
| check
| (or uncheck if you use your main phone number)
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Directory settings'''
|-
| Directory synchronisation ''checkbox''
| On
|
|-
| Source
| cloudmuster-p.innovaphone.com
| Port 636
|-
| TLS ''checkbox''
| check
|
|-
| App Platform FQDN
| cloudmuster-a.innovaphone.com
| (DNS of the App-Platform)
|-
| Username & Password
|
|
|-
|- colspan="12" style="font-weight:bold; background-color:#c0c0c0;"
| '''Append your own provisioning parameters in XML format'''
|-
| Copy the 'Provisioning path'
|''http'''s'''://cloudmuster-a.innovaphone.com/cloud.muster.de/Giga...'' (if necessary change http: to http'''s''':)
| (... see below [[Howto:MyApps_Cloud_-_Using_Gigaset-Provisioning-App_in_innovaphone_cloud_environments#Known_Issues | ''Known Issues'']])
|-
| '' ''<param name="Provisioning.global.Period" value="time in seconds" />''
|-
| '''Save changes''' and start provisioning
| click on the ''floppy disk icon''
|
|-
|}
 

==View on the settings in the Gigaset Integrator==
Continue on the customer side with the master antenna
[[Image: gspapp_ProvPath.png|thumb|upright=1.0|right|provisioning path, start config]]

*Navigate to:
**Settings > System > Provisioning and configuration > Provisioning server
*Insert copied provisioning path:
**http'''s'''://cloudmuster-a.innovaphone.com/cloud.muster.de/Giga...
*Then click on
**'''Start auto configuration'''
**This must also be done after any changes in the Gigaset Provisioning App!
 

==Collection of further possibly helpful screenshots==
*Gigasetuser configuration on the PBX
[[Image: gspapp_gigasetuser.png|thumb|upright=1.0|right|gigasetuser, config]]
 
 
 

*Checking the ''auto configuration'' on the Gigaset Integrator
*Provider profil 'innovaphone'
[[Image: gspapp_profile.png|thumb|upright=1.0|right|check, Gigaset profiles]]
 
 
 

*Handset registration
[[Image: gspapp_HandsetReg.png|thumb|upright=1.0|right|check, handset registration]]
 
 
 

=Known Issues=
*It has been shown in field projects, that although the SIP registrations/connections generally work with TLS (5061) ...
**... but they are often more stable with 5060.
*The provisioning link from the Gigaset Provisioning App is possibly created as an http link ...
**... but it only works in the Gigaset Integrator as an http'''s''' link.
*When provisioning the handsets, the Gigaset MAC/'''iPUI''' can be read on the box (you require this with the UsersAdmin).
**If you have many handsets, it can also be done using a standard barcode scanner.
*Check whether the checkboxes for ''PBX Pwd'', ''Reverse Proxy'' and ''Media Relay'' were automatically set in the user object when the phone was created for the user.
**Set manually if necessary. [[Image: gspapp_pwd-rp-mrelay.png|thumb|upright=1.0|right|user devices, checkboxes]]
 

== Related Articles ==
*[[Howto:Gigaset-Provisioning-App_-_Gigaset_-_Partner_App | ''Howto:Gigaset-Provisioning-App'']]

Reference12r1:PBX/Objects/Waiting Queue

2024-07-11T09:18:51Z

Hawk: /* Presence Disables Operator */

The Waiting Queue PBX object is used to put calls sent to this object into a queue. While the call is in the queue, it may either remain in alerting state or it be connected with an announcement played. Two announcements can be configured played one after the other, the second is repeated. Calls which are in the queue can be sent to groups of operators configured for the queue. Calls are strictly sent in a first in first out manner to operators. The next call is sent only after the previous call is connected. Destinations can be configured, which can be dialed using DTMF while a call is in the queue and connected.

'''The Waiting Queue PBX object does not support DTMF tone detection. Only 'telephone-event' (RFC-2833) or DTMF signalling (H.245 User Input Indication / SIP INFO(dtmf-relay)) are supported.'''

== Configuration ==

=== Addressing ===

The Long Name, Name Number and Node configuration parameters have the same meaning as for any other object.

=== Registration ===

Hardware ID, PBX, Send Number, Password, Filter, Diversion Filter and Group Indications are used only for endpoints registered directly to the Waiting Queue object. This maybe useful to set diversions for the Waiting Queue object and such endpoints can be used to make calls and are treated as operators of the Waiting Queue.

=== CFNR Timeout ===

The timeout used for call forward no response. See Diversions. Please note that the timeout is limited to 900 seconds.

=== Max Calls ===

This configuration parameter can be used to limit the calls in the queue. Calls connected to a operator do not count in this respect anymore.

=== Announcements ===

For announcements the URL and/or Extern Name/no have to be configured. If no Extern Name/no is configured the local HTTP interface is used to retrieve the announcements. The URL has the following format:

<nowiki>http://<addr>/<filename.$coder>?coder=<coder-list>[&repeat=true|repeat=n|disc=true|random=true|record=true]</nowiki>

{|
|valign=top nowrap=true|'''addr'''
|The IP address of the web server. A DNS name cannot be used here.
|-
|valign=top nowrap=true|'''filename.$coder'''
|The filename of the announcement files including any path. $coder will be replaced by the actual coder used.
|-
|valign=top nowrap=true|'''coder-list'''
|A comma seperated list of all available coder. For each coder in the list the respective announcement file must be available on the server. The available coders are g711a,g711u,g722,g723,g729,opus-nb,opus-wb. Te order of coders is not significant, OPUS_NB will be used as preferred coder (if present)
|-
|valign=top nowrap=true|'''repeat=true'''
|If this is present the announcement will be repeated. If this is used for the 1st Announcement the 2nd Announcement will never be played.
|-
|valign=top nowrap=true|'''repeat=<n>'''
|If this is present the announcement will be repeated another n times.

|-
|valign=top nowrap=true|'''fallback=true'''
|If this is present and the specified announcement file is not available, the built-in MOH pattern will be played.
|-
|valign=top nowrap=true|'''random=true'''
|If this is present, the announcement will be started at a random offset, so each caller will hear it from a different point in time. This works with non-local URLs only though.
|}

Example

<nowiki>http://145.253.157.2/announce/welcome.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb</nowiki>

If no URL is configured the local HTTP interface plays the built-in music on hold by default.

If an Extern Name/No is configured then no local HTTP interface is used, but a call is sent to the configured Name/No. The URL is sent with this call as user-user-info, so that a remote HTTP interface can use it the same way as the local HTTP interface. As destination of the call any voip endpoint can be used.

1st announcement is played once when the call is connected. When 1st announcement is complete, the 2nd announcement is played repeatedly. If there is no 2nd announcement, the caller will be disconnected when the 1st announcement has completed.

There are 2 pseudo URLs available, TONE and MOH. Such URLs will be interpreted locally and connect to the systems tone and music-on-hold interface, respectively.

{|
|valign=top nowrap=true|'''TONE'''
|as URL will produce a constant tone (often recognized as a dial-tone). You can add a '''?tone=ringback''' which will give you a tone sequence with 1 second tone and 4 seconds silence (this is often recognized as a ring-back tone).

It's possible to define different tones from different countries with a '''?tone=ringback&tones=X''' where X it's a numeric value from 0 to 27, this numeric order match with the list of TONES we can find at the Gateway->Interfaces->TONE, where 2 it's US and 8 it's Swiss for example.

You can also add a '''?tone=busy''' which will give you a busy tone sequence. Notice that the queue is only playing the busy tone, it will not disconnect the call. (To disconnect the call after a while, use the CFNR to a not existing user or to a Disconnect user object, routed to the DISC interface.)
|-
|valign=top nowrap=true|'''MOH'''
|will produce the built-in music-on-hold. Please note that both TONE and MOH never end, so '''repeat=true''' is not required and '''disc=true''' will have no effect.
|}

'''V7 hotfix9''': At any location inside the URL placeholders can be used, which are replaced by a string defined for the placeholder. The following placeholders are available:
{|
|valign=top nowrap=true|'''#p'''
|Position of this call within the queue. '''0''' means the next available operator will answer this call.
|-
|valign=top nowrap=true|'''##'''
|Is replaced by '''#'''
|}

Example

<nowiki>http://145.253.157.2/announce/queue_place#p.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb</nowiki>

will be resolved to the files ''queue_place1.g711a'',''queue_place2.g711a'', ''queue_place3.g711a''...., depended on place in queue. So you have to create one set of prompt files for each queue place.

'''Recommended solution:''' Create a welcome prompt in 1st Announcement URL and a ''queue_place'' prompt which will be repeated in 2nd Announcement URL. This way every time the 2nd Announcement is repeated it will provide the queue position to the caller.

=== Max Call/Operator(%) ===

This configuration parameter allows to limit the number of current calls depending on the number of operator registrations in the primary group. Only the configured percentage of operator registrations are accepted as calls. Calls currently connected to operators do count in this context. For example if 2 operators are registered and the value is set to 150%, the 4th call received will get a busy. Note that only operators in the primary group count for this, this means if there is no primary group configured all calls are rejected with busy if any value is entered here.

=== Alert Timeout ===

The timeout (in seconds) after which the Waiting Queue connects incoming calls. If no timeout is configured the Waiting Queue will never connect. If a timeout of 0 is configured the Waiting Queue connects right away.

=== Round Robin Timeout ===

If a '''Round Robin Timeout''' is configured the call is not sent to all members of the primary group, it starts with one only.
After the round robin timeout has expired, the call is sent to all members of the primary group. The operator which is selected for the first call changes every call. (Round robin manner like a static list so all are used)

If the '''Speedup if more calls waiting''' checkmark is set, the round robin timeout will be removed as soon as a second ringing call exist and all members of the primary group will be signalled.

If the '''Call longest idle''' checkmark is set, the next operator to be called is based on which one has the longest idle time of an answered call distributed over the waiting queue.

=== Primary Group/Timeout ===

The call is sent to this group first, either to all members at the same time, or in a round robin manner. After the configured Primary Group Timeout expires the call is sent to all operators. If Primary group operators are busy the call is immediately sent to Secondary Groups members. Operators are all members of groups in which the Waiting Queue object itself is active member. The operators do not need to be active members of these groups. If Primary Group Timeout is empty, the call is sent to primary and secondary group immediately.

=== CFNR on no Operators ===

If this option is configured, calls are rejected with No User Responding if there is no operator. If a CFNR is configured at the Waiting Queue, it is executed in this case.

=== Support for RTP-DTMF ===

If the announcement interface for a Waiting queue is not the PBX internal one and the calling endpoint can only do RTP-DTMF, the announcement interface receives the RTP-DTMF and not the waiting queue. When this checkmark is set, the '''uui-dtmf=on''' argument to the URL is added, which tells the announcement interface to send back the received DTMF as USER-INFO.

This feature is needed for a Hosting Scenario where the PBX is located in a private network and the Media interface on a different system in the public network.

=== Operator connect for SOAP ===

On the SOAP/TAPI interface a call to a waiting queue is normally indicated as connected as soon it is connected signalingwise, this means it is indicated as connected if an announcement is played. This behaviour can be changed so that it is indicated connected only after an operator has accepted the call by setting this checkmark. This also will affect the PBX CDRs state accordingly.

=== Call busy Operators ===

Normally an operator who is already engaged in a Waiting Object call is not called again. If this checkmark is set, calls are delivered to these (busy) operators as well.

=== CFU disables Operator ===

If this checkmark is set a operator which has a CFU set is not called.

=== Execute Operator CFB/CFNR ===

If this checkmark is set, CFB or CFNR is executed for calls sent thru the Waiting Queue to operator phones otherwise these CFB/CFNR are ignored for such calls.
'''Note:''' Only CFB/CFNR configured by the operator will be executed. ''Administrative CFx'' will be ignored (e.g. call forwardings using Bool or Only/Only Not parameters).

=== No Mobility for Operators ===

If this checkmark is set, mobility for operators is not executed.

=== Announcement w/o Connect ===

If this checkmark is set, no connect is sent on incoming calls to play the announcements. This feature allows to provide free-of-charge waiting queues. For this to work, the carrier has to support early media (and not all do, for example German Telekom is known to not support this feature as of December 2012 on ISDN lines). On TE ISDN interfaces the Annex-N option has to be enabled for this.

=== Presence Disables Operator ===

If this checkmark is set, no calls are sent to an operator with any presence information that is not "Available".

=== Set Operator Presence ===

If this checkmark is set the presence of an operator is set to busy whenever the operator accepts a call. A timeout can be set after which this presence information is cleared again after the call release.

=== DTMF destinations ===

A list of DTMF destinations can be configured. Any DTMF digits dialed after the call is connected to an announcement is matched to this list. If a match is found the call is sent to Dest. No/Dest. Name. If no Dest. No/Dest. Name is configured more DTMF digits may be dialed for the final destination. If the destination of the call is not an endpoint, but a gateway (Trunk object, Gateway object, Voicemail object), the call is sent only after a timeout of 4s after the last digit is dialed.

A '.' entered as DTMF map will catch all DTMF digits dialled after this map and append them at the end of ''Dest. No''.

Example
DTMF Dest. No Description
55. 11 if the DTMF sequence "55222" is dialled, the destination number is "11222"
. <empty> the dialled DTMF sequence is passed completely to the destination

A '~' character before the DTMF destination indicates that no ct_complete shall be generated. This means the dialed DTMF destination does not show up in the redial list of the phone.

== Call Forwarding ==

Call Forwarding can be used with the Waiting Queue object and can be set/reset by endpoints registered to the Waiting Queue object itself.

{|
|valign=top nowrap=true|'''CFU'''
|Executed as usual
|-
|valign=top nowrap=true|'''CFB'''
|Executed if the Busy on ... calls condition or the Max Call/Operator(%) condition applies.
|-
|valign=top nowrap=true|'''CFNR'''
|Executed if the CFNR timeout expires and no operator has accepted the call, even if the call is connected to an announcement or if the first announcement ends and no second announcement is configured.
|}

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:12:29Z

Hawk: /* Edit Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
* Point to Point (most ISDN with a number area)
* Point to Multipoint (most ISDN with single numbers)
* Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
* After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
* The same protocol you have to configure manual in the Admin UI in interfaces.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]
* Line-bound SIP connections are not listed.
* More options for the trunk objekt you find in the Admin UI / PBX / Objects / trunk-object.

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:09:28Z

Hawk: /* Add Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]
* Line-bound SIP connections are not listed.
* More options for the trunk objekt you find in the Admin UI / PBX / Objects / trunk-object.

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:09:04Z

Hawk: /* Add Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]
* Line-bound SIP connections are not listed.
* More options for the trunk objekt you find in the Admin UI / PBX / Objects / trunk-object.

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:07:57Z

Hawk: /* Edit Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]
* Line-bound SIP connections are not listed.
* More options for the trunk objekt you find in the Admin UI / PBX / Objects / trunk-object.

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:07:34Z

Hawk: /* Known issues */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: (Line-bound SIP connections are not listed)
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]
* Line-bound SIP connections are not listed.
* More options for the trunk objekt you find in the Admin UI / PBX / Objects / trunk-object.

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:05:56Z

Hawk: /* Known issues */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: (Line-bound SIP connections are not listed)
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]
* Line-bound SIP connections are not listed.

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T09:04:47Z

Hawk: /* Edit Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
; Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
; SBC (SIP)
: Klick on the country code where the provider of your SIP came from.
: (Line-bound SIP connections are not listed)
: Select the SIP wizzard of your SIP contract.

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T08:59:04Z

Hawk: /* Edit Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Klick (+ Add) to select the target Gateway.
: Klick on the Gateway, you wont to use.
: Chuse if you wont to connect an ISDN-Interface (BRI/PRI/TEL) or an SBC Interface (SIP) to this Trunk.
# Interface
: All possible interfaces where lited. Chuse one, by clicking on them.
: Select a protocoll
- Point to Point (most ISDN with a number area)
- Point to Multipoint (most ISDN with single numbers)
- Manual (Setting was not changed, standart: Point to Multipoint); no wizzard for numbermapping
- After selecting a protocol a wizzard opend to configure the "numbermapping" of the interface.
# SBC (SIP)

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/Trunks

2024-07-01T08:42:17Z

Hawk: /* Add Trunk */

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; SIP
: The name of the PBX object

; Number
: The number of the object

; Loopback
: target number, when the called number is the trunk-number
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: target number, when the called number is incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: target number, when an incomming call was received
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: target number, when an incomming call was received with: busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: target number, when an incomming call was received with: rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: target number, when an incomming call was received with: no answer
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk and klick OK. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Select the target Gateway and the Interface (BRI/PRI/TEL) or an SBC Interface (SIP1-SIP16) for the Trunk

== Known issues ==

* defintion of protocol mode PtP (default PtmP) in PBXManager has no effect to the physical interface settings
: adjustment has to be done via [[{{NAMESPACE}}:Interfaces/BRI/Protocol|AdvancedUI]]

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

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

2024-05-27T13:22:29Z

Hawk:

[[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]]

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

Reference14r1:Apps/PbxManager/App Voicemail

2024-05-16T14:39:22Z

Hawk: /* Add a (group) voicemail object */

This PBX Manager Plugin contains 2 sections:
* Change the Settings for the voicemail objects.
* Add, edit or delete (group) voicemail objects on the PBX.

== Change Settings ==
; User
: User configured on the PBX to authenticate against the webserver on App Platform.

; Password
: Password configured on the PBX to authenticate against the webserver on App Platform.
: Adding an additional character displays an eye-symbol to see the password in cleartext.
: Remark: the displayed password also contains the additionally entered character.

; Delete voicemails after x (days)
: New and stored voicemail messages will be deleted automatically after x days (not applicable when left empty). Deletion-procedure will be triggered on change.

== Add a (group) voicemail object ==
; Name
: Name of Voicemail Object.

; SIP
: SIP of Voicemail Object

; Number
: Number of Voicemail Object
: A Group voicemail is client and server in one person. So you call this number twice. e.g.: Number:803, Call for GroupVM: 803803

; PBX
: PBX of Voicemail Object

; Node
: Node of Voicemail Object

; Default PIN
: The default PIN of this (group) voicemail system. 8765 by default (if not set).

; Email Notification Checkmark
: Check if emails shall be send

; Custom Checkmark
: Check if a custom voicemail is configured

; MWI users (''only for Group Voicemail Objects'')
: Comma separated list of (SIP/name) names of users whose phones are actively informed about changes in the voicemail.
: Each user has to be a active meber of a new group.

Reference14r1:PBX/Config/General

2024-02-21T11:37:08Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Chat no Attachments: If checked, no file attachments are allowed in chats for any user

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Defines additional visibility for active group members. These are added to the visibility rights derived from the [[{{NAMESPACE}}:PBX/Objects/Visibility | Visibility settings ]] in user or template definitions. Note that changes made here only take effect after a re-registration.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. Leave empty to keep the standard logo. The image size should be 220x150px or less with 24Bit color deep or less and an RGB range. The file format should be PNG or JPEG.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

Reference14r1:PBX/Config/General

2023-12-18T08:51:44Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Allows to restrict default visibility to active group members. If changed active subscriptions are not affected. Is used to prevent standard users from getting access to sensitive information like activities/presences of group members in myPBX. If not generally allowed by the administrator via this setting, normal users are not able to change it via myPBX.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. The image size should be 220x150px or less, RGB color and a deep of color 24Bit or less. Leave empty to keep the standard logo. The file format should be PNG or JPEG.
:Username and password or filekey cannot be stored in the link. Save the file to a location with anonymous access. Or save the file in Files, in a folder with username and password sharing. Store the link with user name and password in HTTP/Client on the phone.
:You can distribute this to all phones via Devices/Device Configuration/Expert Configuration.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

Reference14r1:PBX/Config/General

2023-12-18T08:51:13Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Allows to restrict default visibility to active group members. If changed active subscriptions are not affected. Is used to prevent standard users from getting access to sensitive information like activities/presences of group members in myPBX. If not generally allowed by the administrator via this setting, normal users are not able to change it via myPBX.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. The image size should be 220x150px or less, RGB color and a deep of color 24Bit or less. Leave empty to keep the standard logo. The file format should be PNG or JPEG.
:Username and password or filekey cannot be stored in the link. Save the file to a location with anonymous access. Or save the file in Files, in a folder with username and password sharing. Store the link with user name and password in HTTP/Client on the phone.
You can distribute this to all phones via Devices/Device Configuration/Expert Configuration.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

Reference14r1:PBX/Config/General

2023-12-18T08:50:20Z

Hawk: /* Common */

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verified certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, separated by comma. Registrations from one of these addresses are assumed to be routed through a Reverse Proxy. To the address '/<certificate name>' can be added to also check the TLS certificate of the Reverse Proxy. If the reverse proxy certificate is to be verified, the certificate or the issuer of the reverse proxy certificate must be trusted in the PBX.
; Assume TLS: If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Media relay endpoint/Firewall public IP: For media relay endpoints (e.g. third party SIP phones) the public address of the firewall of the PBX network can be configured. This address is signaled in the SDP to received RTP from the phone. The firewall should have configured a port forwarding to the PBX or the TURN, for the RTP range of the PBX or TURN.

;Media relay endpoint/TURN: If this checkmark is set, the PBX allocates TURN endpoints for calls to or from media relay endpoints, which registerd thru the reverse proxy (e.g. third party SIP phones)

;IP address for App Platform
: The ip address of an App Platform can be configured here, with a DNS name used for it. If myApps uses a host to access the PBX different from the configured DNS name of the PBX, the hostname in any App url, which matches the configured AP DNS, is replaced by the AP IP. This way it is possible to configure a PBX with DNS names and access it with myApps when the DNS is not yet set up. If the checkmark ''Operation without DNS'' is set as well any matching DNS name is replaced also when an App service requests the URL of another App service (Example: Users requesting the URL of Devices for provisioning) and in the URL sent to the App services itself (Example: Devices uses this URL to construct the URL set at devices for the Devices registration).

: Note that this mode is intended to be able to run the PBX using DNS names while the DNS is not yet in place. Once the DNS is up and running, neither the DNS name of the AP nor its IP address should be configured here.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=g711a,g711u,g722,g723,g729,opus-nb,opus-wb&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=g729,g711a,g711u,g723,opus-nb,opus-wb'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:The maximum length of the URL is limited to 500 characters (bytes).

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

: See [[Howto:Dynamic_MOH]] for more details on how to use dynamic music on hold.

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Security block time(s): Time for which a registration to a user is blocked after attempt with wrong password. Default is 20s. With a value of 0 this features is turned off.

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Retries on busy (14s): Number of retries (Each attempt runs for 14 seconds) of blind transfer to a busy endpoint, before a recall back to the initiator is executed. During an attempt, the PBX waits to see if the target is free, and then delivers the call. The default value are 4-retries if the field is empty. If there is a 0 configured no further (in addition to the initial) will be executed. (This function depends on the ''Recall Timeout'' so the ''Recall Timeout'' must not be empty)

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Group Default Visibility: Allows to restrict default visibility to active group members. If changed active subscriptions are not affected. Is used to prevent standard users from getting access to sensitive information like activities/presences of group members in myPBX. If not generally allowed by the administrator via this setting, normal users are not able to change it via myPBX.

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users.

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed through the PBX. With the '''No Media Relay if Addresses are identical or private''' checkmark, this is not done if the two call endpoints registration addresses are either private or equal (i.e. external endpoints behind the same NAT router). To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used.
:;Auto: Media traffic is routed through the PBX if calls are between private and public registration addresses but not for calls between private and private or public and public registration addresses. To identify an address as private the "Private Networks" configuration from ''IP4/General/Settings'' is used. In v11 this was the behaviour if ''RTP Proxy'' was ''on''.
: Please note that when media relay is in effect for a call, '''video is not working'''. With ICE (available from v12r1), media relay in the PBX should be obsolete except for special applications. Check ''On'' or ''Auto'' only if you need to have this, since it creates CPU load on the PBX.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. For details, refer to the [[{{NAMESPACE}}:Concept_Call_Detail_Record_CDR_PBX|CDR description article]].

;Reverse Lookup URL
: A String in the LDAP URL Format according [https://tools.ietf.org/html/rfc2255 RFC2255] which will be used by the PBX to make a lookup for all external numbers.
: Number resolutions will be forwarded to internal applications like generated CDRs, Phone App etc..
: Example: ''ldaps://ap.innovaphone.com/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=innovaphone.com\contacts''
:* dn: ''dc=entries''
:* attributes: ''givenname,sn,company''
:* scope: ''sub''
:* filter: ''(metaSearchNumber=+%n)''
:** %n is a placeholder for the given cgpn
:* extension: ''bindname=innovaphone.com\contacts''
:** The username for the authentication.
:'''Variables'''
:* %n - cgpn
:* %u - h323 name of the current object
: Also there is an additional field for the LDAP password
: Examples are listed in the [[{{NAMESPACE}}:Concept_Number_Resolution_and_LDAP#PBX_Configuration|Concept Article]]

;Logo URL
:The URL to a customized logo image that will be displayed on the phones. The image size should be 220x150px or less, RGB color and a deep of color 24Bit or less. Leave empty to keep the standard logo. The file format should be PNG or JPEG.
Username and password or filekey cannot be stored in the link. Save the file to a location with anonymous access. Or save the file in Files, in a folder with username and password sharing. Store the link with user name and password in HTTP/Client on the phone.
You can distribute this to all phones via Devices/Device Configuration/Expert Configuration.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber/Area-Code/Country-Code: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber''' (in Germany, <code>0</code> is a commonly used trunk line access code).
::The SubscriberID is used for hotkey-actions within myAPPs-launcher. By use of node-objects, adjust the Subscriber Prefix in the respective [[{{NAMESPACE}}:PBX/Objects/Node#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|node object number mapping]].
::For myPBX-launcher hotkeys, refer to the [[{{NAMESPACE}}:Phone/User/Directories#Dialing_location|dialing location settings]].

:* '''Area-Code''' (in Germany for example, the town Mannheim has area code <code>621</code>).
:* '''Country-Code''' (for Germany, <code>49</code> would be used)

: These settings resemble the same settings found in the [[{{NAMESPACE}}:PBX/Objects/Node | Node ]] and [[{{NAMESPACE}}:PBX/Objects/PBX | PBX ]] object. However, they apply to the ''root'' node instead (and should be consistent through all PBXs in a multi-PBX system).

;Adjust LDAP results for e.164: Add a "+" prefix to an PBX-internal LDAP-contact-search result. This is used for 3rd-party- and DECT-phones which are not able to benefit from the Dialing Location settings in case of LDAP-search in an E.164-setup. See also [[{{NAMESPACE}}:Concept_Number_Adjustments_%28Dialing_Location%29#PBX_database_used_as_LDAP_database|concept description]].

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object (The length of the password is limited to 16 characters)

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX). For the replication process the [[Reference9:PBX/Config/Security|PBX Password]] is used which have to be the same password on all PBXes in the system.

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination. Destination has to be an object with active registration.

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to slave or standby, check also password in [[Reference9:Administration/PBX/Security]]

File:Wiki Collage.png

2023-10-20T13:23:03Z

Hawk: Hawk uploaded a new version of File:Wiki Collage.png

Special Accessories by Mehrens Unified Communication GmbH

2023-10-19T10:07:01Z

Hawk: /* 6 MEHRENS IP2x2 mobile phone stand */

==Special Accessories by Mehrens Unified Communication GmbH==
Mehrens Unified Communication GmbH
Special Accessories by Mehrens Unified Communication GmbH with 3D printing technologie

==Certification Status==




==Category==





==Vendor==
[[Image:MehrensLogo.jpg]]

As a partner, you have an innovaphone Value Added Distributor Pro at your side.
We connect people and always stand up for your needs.
As a “value added” distribution, we also provide our partners with technical advice and support in their day-to-day business.
We develop our own products for innovaphone devices to expand the range of functions and meet the requirements of end customers.

==Description==

===3D-Products===
[[Image:Wiki_Collage.png]]
====1 Kuando Monitor-Halter====
Kuando Monitor Holder The Kuando Busylight UC Omega is difficult or impossible to attach to modern narrow monitors with the included adhesive pad. We are therefore offering a new solution here: a holder that can hold the Kuando Busylight UC Omega and can be attached to all monitors with a frame thickness of up to 38 mm at the top.
====2 DECT/WLAN telephone wall and pipe mount====
DECT/WLAN telephone wall and pipe mount suitable for DECT and WLAN telephones IP64, IP65 and IP73, as well as Ascom D43, D63 and I63. Holder can be attached with two screws, or with up to 4 cable ties, two each for a vertical and horizontal pole .Application locations include: B. in the forklift, in the emergency vehicle, on the picking truck, in short, at all mobile work locations where you want to have your DECT phone with you but not in your hand.
====3 Wall mount for IP2X2 phones====
Wall mount for IP2X2 telephones + Drop-Stop Bundle Unscrew the two upper housing screws on the back and place this wall mount corner on top. The screw is screwed back in through the wall bracket and now also holds the wall bracket. This has a holder on the wall side for a normal wall screw including a drilling template.
====4 Wall kit / wall and ceiling mount====
Wall kit / wall and ceiling mount for IP411, IP811, IP3011, IP6010, IP29-2, IP29-4, IP29-8, IP600, IP1500, IP400, IP2000, IP3000, IP6000, IP38, IP302, IP305, IP800, IP302 , IP1130, IP0010, IP1060, IP1130, so all stainless steel housings. The kit includes a wall/ceiling bracket, 3 mounting screws for connection to the stainless steel housing and a locking tab. The safety tab is required for mounting under the table to prevent the holder from unhooking. The securing tab is not required for wall mounting. The kit includes a wall / ceiling bracket, 3 mounting screws for the connection to the stainless steel housing and a securing strap. The safety tab is required for assembly under the table to prevent the bracket from unhooking. The securing strap is not required for wall mounting.
====5 Stand-Up for IP112 / IP111 / IP10X*====
Stand-Up for IP112 / IP111 / IP10X* The stand-up changes the tilt of an IP-111, IP112, IP101*, or IP102* from 28 degrees to 40 degrees. *On the IP10x, the stand-up sits a little looser, but is secure. Pack: 2 pcs.
====6 MEHRENS IP2x2 mobile phone stand====
MEHRENS IP2x2 mobile phone stand for mobile phone cases.
It comes in three diferent versions Standart (6a), Big and for Apple MagSafe(6b).
====7 IP11x display anti-glare protection====
Display glare protection for IP111 and IP112 against unwanted reflections. Functions and visibility of the display are not restricted. It can be stuck to the phone with double-sided adhesive tape.
====8 Drop Stop - for IP222 / IP232====
Drop-Stop - for IP222 / IP232 The drop-stop, manufactured using the 3D printing process, gives your phone a classic receiver stop. This means that there is no longer any play between the receiver and the base device, which means that the receiver no longer falls off the base unit when you hastily grab it. The receiver can be hung up again more forcefully, as with classic telephones with a mechanical rocker. A conversation is no longer accidentally ended when you The receiver is not grasped properly and the contact is opened for the call by briefly rocking and then immediately closed again.
====9 Rack cover for innovaphone 19" installation frame (IP800 rack)====
====10 Flat Wall Kit for IP1XX====
Flat Wall Kit for IP1XXFlat mounting option for IP101, IP102, IP111, IP112 and IP112a. 5 mm distance from the wall for laying the LAN cables. Particularly suitable for wall telephones in narrow hallways, in-table mounting for e.g. .B. maritime operations, or mobile operations centers. Two-piece mounting set for the click mount in the telephone and four normal screw heads.

==Version==
All products were tested on old and current production lines.

Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==
Individual assembly instructions (if necessary) are included with the product or are engraved on the product.

==Contact==

Mehrens Unified Communication GmbH

Memellandstr. 4, 24537 Neumünster

Telephone number: +49 (0) 43 21 - 96 66 9 - 50

Fax: +49 (0) 43 21 - 96 66 9 - 66

E-Mail: vertrieb@mehrens.de

Shop / Homepage: www.mehrens.de

File:Wiki Collage.png

2023-10-19T08:47:29Z

Hawk: Hawk uploaded a new version of File:Wiki Collage.png

Special Accessories by Mehrens Unified Communication GmbH

2023-10-19T08:44:10Z

Hawk: /* Contact */

==Special Accessories by Mehrens Unified Communication GmbH==
Mehrens Unified Communication GmbH
Special Accessories by Mehrens Unified Communication GmbH with 3D printing technologie

==Certification Status==




==Category==





==Vendor==
[[Image:MehrensLogo.jpg]]

As a partner, you have an innovaphone Value Added Distributor Pro at your side.
We connect people and always stand up for your needs.
As a “value added” distribution, we also provide our partners with technical advice and support in their day-to-day business.
We develop our own products for innovaphone devices to expand the range of functions and meet the requirements of end customers.

==Description==

===3D-Products===
[[Image:Wiki_Collage.png]]
====1 Kuando Monitor-Halter====
Kuando Monitor Holder The Kuando Busylight UC Omega is difficult or impossible to attach to modern narrow monitors with the included adhesive pad. We are therefore offering a new solution here: a holder that can hold the Kuando Busylight UC Omega and can be attached to all monitors with a frame thickness of up to 38 mm at the top.
====2 DECT/WLAN telephone wall and pipe mount====
DECT/WLAN telephone wall and pipe mount suitable for DECT and WLAN telephones IP64, IP65 and IP73, as well as Ascom D43, D63 and I63. Holder can be attached with two screws, or with up to 4 cable ties, two each for a vertical and horizontal pole .Application locations include: B. in the forklift, in the emergency vehicle, on the picking truck, in short, at all mobile work locations where you want to have your DECT phone with you but not in your hand.
====3 Wall mount for IP2X2 phones====
Wall mount for IP2X2 telephones + Drop-Stop Bundle Unscrew the two upper housing screws on the back and place this wall mount corner on top. The screw is screwed back in through the wall bracket and now also holds the wall bracket. This has a holder on the wall side for a normal wall screw including a drilling template.
====4 Wall kit / wall and ceiling mount====
Wall kit / wall and ceiling mount for IP411, IP811, IP3011, IP6010, IP29-2, IP29-4, IP29-8, IP600, IP1500, IP400, IP2000, IP3000, IP6000, IP38, IP302, IP305, IP800, IP302 , IP1130, IP0010, IP1060, IP1130, so all stainless steel housings. The kit includes a wall/ceiling bracket, 3 mounting screws for connection to the stainless steel housing and a locking tab. The safety tab is required for mounting under the table to prevent the holder from unhooking. The securing tab is not required for wall mounting. The kit includes a wall / ceiling bracket, 3 mounting screws for the connection to the stainless steel housing and a securing strap. The safety tab is required for assembly under the table to prevent the bracket from unhooking. The securing strap is not required for wall mounting.
====5 Stand-Up for IP112 / IP111 / IP10X*====
Stand-Up for IP112 / IP111 / IP10X* The stand-up changes the tilt of an IP-111, IP112, IP101*, or IP102* from 28 degrees to 40 degrees. *On the IP10x, the stand-up sits a little looser, but is secure. Pack: 2 pcs.
====6 MEHRENS IP2x2 mobile phone stand====
MEHRENS IP2x2 mobile phone stand for mobile phone cases.
It comes in three diferent versions Standart, Big and for Apple MagSafe.
====7 IP11x display anti-glare protection====
Display glare protection for IP111 and IP112 against unwanted reflections. Functions and visibility of the display are not restricted. It can be stuck to the phone with double-sided adhesive tape.
====8 Drop Stop - for IP222 / IP232====
Drop-Stop - for IP222 / IP232 The drop-stop, manufactured using the 3D printing process, gives your phone a classic receiver stop. This means that there is no longer any play between the receiver and the base device, which means that the receiver no longer falls off the base unit when you hastily grab it. The receiver can be hung up again more forcefully, as with classic telephones with a mechanical rocker. A conversation is no longer accidentally ended when you The receiver is not grasped properly and the contact is opened for the call by briefly rocking and then immediately closed again.
====9 Rack cover for innovaphone 19" installation frame (IP800 rack)====
====10 Flat Wall Kit for IP1XX====
Flat Wall Kit for IP1XXFlat mounting option for IP101, IP102, IP111, IP112 and IP112a. 5 mm distance from the wall for laying the LAN cables. Particularly suitable for wall telephones in narrow hallways, in-table mounting for e.g. .B. maritime operations, or mobile operations centers. Two-piece mounting set for the click mount in the telephone and four normal screw heads.

==Version==
All products were tested on old and current production lines.

Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==
Individual assembly instructions (if necessary) are included with the product or are engraved on the product.

==Contact==

Mehrens Unified Communication GmbH

Memellandstr. 4, 24537 Neumünster

Telephone number: +49 (0) 43 21 - 96 66 9 - 0

Fax: +49 (0) 43 21 - 96 66 9 - 66

Email: info@mehrens.de

Special Accessories by Mehrens Unified Communication GmbH

2023-10-19T08:43:19Z

Hawk: /* 3D-Products */

==Special Accessories by Mehrens Unified Communication GmbH==
Mehrens Unified Communication GmbH
Special Accessories by Mehrens Unified Communication GmbH with 3D printing technologie

==Certification Status==




==Category==





==Vendor==
[[Image:MehrensLogo.jpg]]

As a partner, you have an innovaphone Value Added Distributor Pro at your side.
We connect people and always stand up for your needs.
As a “value added” distribution, we also provide our partners with technical advice and support in their day-to-day business.
We develop our own products for innovaphone devices to expand the range of functions and meet the requirements of end customers.

==Description==

===3D-Products===
[[Image:Wiki_Collage.png]]
====1 Kuando Monitor-Halter====
Kuando Monitor Holder The Kuando Busylight UC Omega is difficult or impossible to attach to modern narrow monitors with the included adhesive pad. We are therefore offering a new solution here: a holder that can hold the Kuando Busylight UC Omega and can be attached to all monitors with a frame thickness of up to 38 mm at the top.
====2 DECT/WLAN telephone wall and pipe mount====
DECT/WLAN telephone wall and pipe mount suitable for DECT and WLAN telephones IP64, IP65 and IP73, as well as Ascom D43, D63 and I63. Holder can be attached with two screws, or with up to 4 cable ties, two each for a vertical and horizontal pole .Application locations include: B. in the forklift, in the emergency vehicle, on the picking truck, in short, at all mobile work locations where you want to have your DECT phone with you but not in your hand.
====3 Wall mount for IP2X2 phones====
Wall mount for IP2X2 telephones + Drop-Stop Bundle Unscrew the two upper housing screws on the back and place this wall mount corner on top. The screw is screwed back in through the wall bracket and now also holds the wall bracket. This has a holder on the wall side for a normal wall screw including a drilling template.
====4 Wall kit / wall and ceiling mount====
Wall kit / wall and ceiling mount for IP411, IP811, IP3011, IP6010, IP29-2, IP29-4, IP29-8, IP600, IP1500, IP400, IP2000, IP3000, IP6000, IP38, IP302, IP305, IP800, IP302 , IP1130, IP0010, IP1060, IP1130, so all stainless steel housings. The kit includes a wall/ceiling bracket, 3 mounting screws for connection to the stainless steel housing and a locking tab. The safety tab is required for mounting under the table to prevent the holder from unhooking. The securing tab is not required for wall mounting. The kit includes a wall / ceiling bracket, 3 mounting screws for the connection to the stainless steel housing and a securing strap. The safety tab is required for assembly under the table to prevent the bracket from unhooking. The securing strap is not required for wall mounting.
====5 Stand-Up for IP112 / IP111 / IP10X*====
Stand-Up for IP112 / IP111 / IP10X* The stand-up changes the tilt of an IP-111, IP112, IP101*, or IP102* from 28 degrees to 40 degrees. *On the IP10x, the stand-up sits a little looser, but is secure. Pack: 2 pcs.
====6 MEHRENS IP2x2 mobile phone stand====
MEHRENS IP2x2 mobile phone stand for mobile phone cases.
It comes in three diferent versions Standart, Big and for Apple MagSafe.
====7 IP11x display anti-glare protection====
Display glare protection for IP111 and IP112 against unwanted reflections. Functions and visibility of the display are not restricted. It can be stuck to the phone with double-sided adhesive tape.
====8 Drop Stop - for IP222 / IP232====
Drop-Stop - for IP222 / IP232 The drop-stop, manufactured using the 3D printing process, gives your phone a classic receiver stop. This means that there is no longer any play between the receiver and the base device, which means that the receiver no longer falls off the base unit when you hastily grab it. The receiver can be hung up again more forcefully, as with classic telephones with a mechanical rocker. A conversation is no longer accidentally ended when you The receiver is not grasped properly and the contact is opened for the call by briefly rocking and then immediately closed again.
====9 Rack cover for innovaphone 19" installation frame (IP800 rack)====
====10 Flat Wall Kit for IP1XX====
Flat Wall Kit for IP1XXFlat mounting option for IP101, IP102, IP111, IP112 and IP112a. 5 mm distance from the wall for laying the LAN cables. Particularly suitable for wall telephones in narrow hallways, in-table mounting for e.g. .B. maritime operations, or mobile operations centers. Two-piece mounting set for the click mount in the telephone and four normal screw heads.

==Version==
All products were tested on old and current production lines.

Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==
Individual assembly instructions (if necessary) are included with the product or are engraved on the product.

==Contact==

Mehrens Unified Communication GmbH
Memellandstr. 4, 24537 Neumünster

Telephone number: +49 (0) 43 21 - 96 66 9 - 0
Fax: +49 (0) 43 21 - 96 66 9 - 66

Email: info@mehrens.de

Special Accessories by Mehrens Unified Communication GmbH

2023-10-19T08:42:48Z

Hawk: /* Vendor */

==Special Accessories by Mehrens Unified Communication GmbH==
Mehrens Unified Communication GmbH
Special Accessories by Mehrens Unified Communication GmbH with 3D printing technologie

==Certification Status==




==Category==





==Vendor==
[[Image:MehrensLogo.jpg]]

As a partner, you have an innovaphone Value Added Distributor Pro at your side.
We connect people and always stand up for your needs.
As a “value added” distribution, we also provide our partners with technical advice and support in their day-to-day business.
We develop our own products for innovaphone devices to expand the range of functions and meet the requirements of end customers.

==Description==

===3D-Products===
File:Wiki_Collage.png
====1 Kuando Monitor-Halter====
Kuando Monitor Holder The Kuando Busylight UC Omega is difficult or impossible to attach to modern narrow monitors with the included adhesive pad. We are therefore offering a new solution here: a holder that can hold the Kuando Busylight UC Omega and can be attached to all monitors with a frame thickness of up to 38 mm at the top.
====2 DECT/WLAN telephone wall and pipe mount====
DECT/WLAN telephone wall and pipe mount suitable for DECT and WLAN telephones IP64, IP65 and IP73, as well as Ascom D43, D63 and I63. Holder can be attached with two screws, or with up to 4 cable ties, two each for a vertical and horizontal pole .Application locations include: B. in the forklift, in the emergency vehicle, on the picking truck, in short, at all mobile work locations where you want to have your DECT phone with you but not in your hand.
====3 Wall mount for IP2X2 phones====
Wall mount for IP2X2 telephones + Drop-Stop Bundle Unscrew the two upper housing screws on the back and place this wall mount corner on top. The screw is screwed back in through the wall bracket and now also holds the wall bracket. This has a holder on the wall side for a normal wall screw including a drilling template.
====4 Wall kit / wall and ceiling mount====
Wall kit / wall and ceiling mount for IP411, IP811, IP3011, IP6010, IP29-2, IP29-4, IP29-8, IP600, IP1500, IP400, IP2000, IP3000, IP6000, IP38, IP302, IP305, IP800, IP302 , IP1130, IP0010, IP1060, IP1130, so all stainless steel housings. The kit includes a wall/ceiling bracket, 3 mounting screws for connection to the stainless steel housing and a locking tab. The safety tab is required for mounting under the table to prevent the holder from unhooking. The securing tab is not required for wall mounting. The kit includes a wall / ceiling bracket, 3 mounting screws for the connection to the stainless steel housing and a securing strap. The safety tab is required for assembly under the table to prevent the bracket from unhooking. The securing strap is not required for wall mounting.
====5 Stand-Up for IP112 / IP111 / IP10X*====
Stand-Up for IP112 / IP111 / IP10X* The stand-up changes the tilt of an IP-111, IP112, IP101*, or IP102* from 28 degrees to 40 degrees. *On the IP10x, the stand-up sits a little looser, but is secure. Pack: 2 pcs.
====6 MEHRENS IP2x2 mobile phone stand====
MEHRENS IP2x2 mobile phone stand for mobile phone cases.
It comes in three diferent versions Standart, Big and for Apple MagSafe.
====7 IP11x display anti-glare protection====
Display glare protection for IP111 and IP112 against unwanted reflections. Functions and visibility of the display are not restricted. It can be stuck to the phone with double-sided adhesive tape.
====8 Drop Stop - for IP222 / IP232====
Drop-Stop - for IP222 / IP232 The drop-stop, manufactured using the 3D printing process, gives your phone a classic receiver stop. This means that there is no longer any play between the receiver and the base device, which means that the receiver no longer falls off the base unit when you hastily grab it. The receiver can be hung up again more forcefully, as with classic telephones with a mechanical rocker. A conversation is no longer accidentally ended when you The receiver is not grasped properly and the contact is opened for the call by briefly rocking and then immediately closed again.
====9 Rack cover for innovaphone 19" installation frame (IP800 rack)====
====10 Flat Wall Kit for IP1XX====
Flat Wall Kit for IP1XXFlat mounting option for IP101, IP102, IP111, IP112 and IP112a. 5 mm distance from the wall for laying the LAN cables. Particularly suitable for wall telephones in narrow hallways, in-table mounting for e.g. .B. maritime operations, or mobile operations centers. Two-piece mounting set for the click mount in the telephone and four normal screw heads.

==Version==
All products were tested on old and current production lines.

Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==
Individual assembly instructions (if necessary) are included with the product or are engraved on the product.

==Contact==

Mehrens Unified Communication GmbH
Memellandstr. 4, 24537 Neumünster

Telephone number: +49 (0) 43 21 - 96 66 9 - 0
Fax: +49 (0) 43 21 - 96 66 9 - 66

Email: info@mehrens.de

Special Accessories by Mehrens Unified Communication GmbH

2023-10-19T08:42:24Z

Hawk: /* Vendor */

==Special Accessories by Mehrens Unified Communication GmbH==
Mehrens Unified Communication GmbH
Special Accessories by Mehrens Unified Communication GmbH with 3D printing technologie

==Certification Status==




==Category==





==Vendor==
[[Image:MehrensLogo.jpg]]
As a partner, you have an innovaphone Value Added Distributor Pro at your side.
We connect people and always stand up for your needs.
As a “value added” distribution, we also provide our partners with technical advice and support in their day-to-day business.
We develop our own products for innovaphone devices to expand the range of functions and meet the requirements of end customers.

==Description==

===3D-Products===
File:Wiki_Collage.png
====1 Kuando Monitor-Halter====
Kuando Monitor Holder The Kuando Busylight UC Omega is difficult or impossible to attach to modern narrow monitors with the included adhesive pad. We are therefore offering a new solution here: a holder that can hold the Kuando Busylight UC Omega and can be attached to all monitors with a frame thickness of up to 38 mm at the top.
====2 DECT/WLAN telephone wall and pipe mount====
DECT/WLAN telephone wall and pipe mount suitable for DECT and WLAN telephones IP64, IP65 and IP73, as well as Ascom D43, D63 and I63. Holder can be attached with two screws, or with up to 4 cable ties, two each for a vertical and horizontal pole .Application locations include: B. in the forklift, in the emergency vehicle, on the picking truck, in short, at all mobile work locations where you want to have your DECT phone with you but not in your hand.
====3 Wall mount for IP2X2 phones====
Wall mount for IP2X2 telephones + Drop-Stop Bundle Unscrew the two upper housing screws on the back and place this wall mount corner on top. The screw is screwed back in through the wall bracket and now also holds the wall bracket. This has a holder on the wall side for a normal wall screw including a drilling template.
====4 Wall kit / wall and ceiling mount====
Wall kit / wall and ceiling mount for IP411, IP811, IP3011, IP6010, IP29-2, IP29-4, IP29-8, IP600, IP1500, IP400, IP2000, IP3000, IP6000, IP38, IP302, IP305, IP800, IP302 , IP1130, IP0010, IP1060, IP1130, so all stainless steel housings. The kit includes a wall/ceiling bracket, 3 mounting screws for connection to the stainless steel housing and a locking tab. The safety tab is required for mounting under the table to prevent the holder from unhooking. The securing tab is not required for wall mounting. The kit includes a wall / ceiling bracket, 3 mounting screws for the connection to the stainless steel housing and a securing strap. The safety tab is required for assembly under the table to prevent the bracket from unhooking. The securing strap is not required for wall mounting.
====5 Stand-Up for IP112 / IP111 / IP10X*====
Stand-Up for IP112 / IP111 / IP10X* The stand-up changes the tilt of an IP-111, IP112, IP101*, or IP102* from 28 degrees to 40 degrees. *On the IP10x, the stand-up sits a little looser, but is secure. Pack: 2 pcs.
====6 MEHRENS IP2x2 mobile phone stand====
MEHRENS IP2x2 mobile phone stand for mobile phone cases.
It comes in three diferent versions Standart, Big and for Apple MagSafe.
====7 IP11x display anti-glare protection====
Display glare protection for IP111 and IP112 against unwanted reflections. Functions and visibility of the display are not restricted. It can be stuck to the phone with double-sided adhesive tape.
====8 Drop Stop - for IP222 / IP232====
Drop-Stop - for IP222 / IP232 The drop-stop, manufactured using the 3D printing process, gives your phone a classic receiver stop. This means that there is no longer any play between the receiver and the base device, which means that the receiver no longer falls off the base unit when you hastily grab it. The receiver can be hung up again more forcefully, as with classic telephones with a mechanical rocker. A conversation is no longer accidentally ended when you The receiver is not grasped properly and the contact is opened for the call by briefly rocking and then immediately closed again.
====9 Rack cover for innovaphone 19" installation frame (IP800 rack)====
====10 Flat Wall Kit for IP1XX====
Flat Wall Kit for IP1XXFlat mounting option for IP101, IP102, IP111, IP112 and IP112a. 5 mm distance from the wall for laying the LAN cables. Particularly suitable for wall telephones in narrow hallways, in-table mounting for e.g. .B. maritime operations, or mobile operations centers. Two-piece mounting set for the click mount in the telephone and four normal screw heads.

==Version==
All products were tested on old and current production lines.

Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==
Individual assembly instructions (if necessary) are included with the product or are engraved on the product.

==Contact==

Mehrens Unified Communication GmbH
Memellandstr. 4, 24537 Neumünster

Telephone number: +49 (0) 43 21 - 96 66 9 - 0
Fax: +49 (0) 43 21 - 96 66 9 - 66

Email: info@mehrens.de

Special Accessories by Mehrens Unified Communication GmbH

2023-10-19T08:41:50Z

Hawk: /* Special Accessories by Mehrens Unified Communication GmbH */

==Special Accessories by Mehrens Unified Communication GmbH==
Mehrens Unified Communication GmbH
Special Accessories by Mehrens Unified Communication GmbH with 3D printing technologie

==Certification Status==




==Category==





==Vendor==
<nowiki>[[Image:MehrensLogo.jpg]]</nowiki>
As a partner, you have an innovaphone Value Added Distributor Pro at your side.
We connect people and always stand up for your needs.
As a “value added” distribution, we also provide our partners with technical advice and support in their day-to-day business.
We develop our own products for innovaphone devices to expand the range of functions and meet the requirements of end customers.

==Description==

===3D-Products===
File:Wiki_Collage.png
====1 Kuando Monitor-Halter====
Kuando Monitor Holder The Kuando Busylight UC Omega is difficult or impossible to attach to modern narrow monitors with the included adhesive pad. We are therefore offering a new solution here: a holder that can hold the Kuando Busylight UC Omega and can be attached to all monitors with a frame thickness of up to 38 mm at the top.
====2 DECT/WLAN telephone wall and pipe mount====
DECT/WLAN telephone wall and pipe mount suitable for DECT and WLAN telephones IP64, IP65 and IP73, as well as Ascom D43, D63 and I63. Holder can be attached with two screws, or with up to 4 cable ties, two each for a vertical and horizontal pole .Application locations include: B. in the forklift, in the emergency vehicle, on the picking truck, in short, at all mobile work locations where you want to have your DECT phone with you but not in your hand.
====3 Wall mount for IP2X2 phones====
Wall mount for IP2X2 telephones + Drop-Stop Bundle Unscrew the two upper housing screws on the back and place this wall mount corner on top. The screw is screwed back in through the wall bracket and now also holds the wall bracket. This has a holder on the wall side for a normal wall screw including a drilling template.
====4 Wall kit / wall and ceiling mount====
Wall kit / wall and ceiling mount for IP411, IP811, IP3011, IP6010, IP29-2, IP29-4, IP29-8, IP600, IP1500, IP400, IP2000, IP3000, IP6000, IP38, IP302, IP305, IP800, IP302 , IP1130, IP0010, IP1060, IP1130, so all stainless steel housings. The kit includes a wall/ceiling bracket, 3 mounting screws for connection to the stainless steel housing and a locking tab. The safety tab is required for mounting under the table to prevent the holder from unhooking. The securing tab is not required for wall mounting. The kit includes a wall / ceiling bracket, 3 mounting screws for the connection to the stainless steel housing and a securing strap. The safety tab is required for assembly under the table to prevent the bracket from unhooking. The securing strap is not required for wall mounting.
====5 Stand-Up for IP112 / IP111 / IP10X*====
Stand-Up for IP112 / IP111 / IP10X* The stand-up changes the tilt of an IP-111, IP112, IP101*, or IP102* from 28 degrees to 40 degrees. *On the IP10x, the stand-up sits a little looser, but is secure. Pack: 2 pcs.
====6 MEHRENS IP2x2 mobile phone stand====
MEHRENS IP2x2 mobile phone stand for mobile phone cases.
It comes in three diferent versions Standart, Big and for Apple MagSafe.
====7 IP11x display anti-glare protection====
Display glare protection for IP111 and IP112 against unwanted reflections. Functions and visibility of the display are not restricted. It can be stuck to the phone with double-sided adhesive tape.
====8 Drop Stop - for IP222 / IP232====
Drop-Stop - for IP222 / IP232 The drop-stop, manufactured using the 3D printing process, gives your phone a classic receiver stop. This means that there is no longer any play between the receiver and the base device, which means that the receiver no longer falls off the base unit when you hastily grab it. The receiver can be hung up again more forcefully, as with classic telephones with a mechanical rocker. A conversation is no longer accidentally ended when you The receiver is not grasped properly and the contact is opened for the call by briefly rocking and then immediately closed again.
====9 Rack cover for innovaphone 19" installation frame (IP800 rack)====
====10 Flat Wall Kit for IP1XX====
Flat Wall Kit for IP1XXFlat mounting option for IP101, IP102, IP111, IP112 and IP112a. 5 mm distance from the wall for laying the LAN cables. Particularly suitable for wall telephones in narrow hallways, in-table mounting for e.g. .B. maritime operations, or mobile operations centers. Two-piece mounting set for the click mount in the telephone and four normal screw heads.

==Version==
All products were tested on old and current production lines.

Product versions used for interop testing:

* 3rd-Pty-Product Version

* innovaphone V12r2sr24

==Configuration==
Individual assembly instructions (if necessary) are included with the product or are engraved on the product.

==Contact==

Mehrens Unified Communication GmbH
Memellandstr. 4, 24537 Neumünster

Telephone number: +49 (0) 43 21 - 96 66 9 - 0
Fax: +49 (0) 43 21 - 96 66 9 - 66

Email: info@mehrens.de