innovaphone wiki - User contributions [en]

Reference15r1:PBX/Objects/Gateway

2026-01-25T12:46:06Z

Gd:

The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls the incoming calling party number is passed on.

See [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|respective article]] for generic object properties.

== Gateway Object specific Configuration ==

;Enblock Count: If this number of digits is dialed after the number of the Gateway object itself, the call is sent out as enblock call. This is useful to connect to gateway which are not capable of overlap receiving.

;Enblock as Diverting No: If this checkmark is set, the called party number is transmitted as diverting leg2 information. As called party number the number of the gateway object is sent or no number if the Prefix checkmark is set. This is useful with Microsoft Exchange since this expects the number of the mailbox as diverting number.

;Prefix: If this checkmark is set, the number of the Gateway object itself is removed from the called party number for outgoing calls and added to the calling party number for incoming calls

;Domain: Route calls with matching domain part in the destination to this object.

;Loop Detect: If checked outgoing calls are blocked if a call with identical source and destination addresses already exists.

;International Match: If a call is received, the calling party number is compared to this number. If there is a match (head match) this number is removed from the calling party number, so that only additional digits remain. E.g. on an incoming call from a registration on this Gateway object the CGPN 00049703173009123 will be mapped to 123 (if the number is set to 00049703173009). Note that this comparison is done after the replacements configured in PBX/Config/General/Prefix for ... have been performed

;National Match: Same as 'International Match' only for national calling party number. This comparison is done if the comparison for the International Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 00703173009123 will be mapped to 123 (if the number is set to 00703173009)

;Subscriber Match: Same as 'International Match' only for subscriber calling party number. This comparison is done if the comparison for the National Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 073009123 will be mapped to 123 (if the number is set to 073009)

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Set Called Number from User Name: If this checkmark is set, for outgoing calls with a destination name but no number, the number of a PBX user with the name is set as destination number. This is useful for setups, where this GW object is used for overflow calls from slave to master over the public network, which only support numbers. This works only if a full replication of all users to the slave is configured.

;Internal Destination: If this checkmark is set, all calls from devices registered at this object are marked as Internal (Numbering plan set to private). This is usefull if systems are registered to this object, which cannot send calls with the private numbering plan but should be regarded as internal (e.g. voicemail systems).

The device registering with a gateway object is normally expected to send local extension numbers as calling party number (i.e. extensions local to the PBX and 'behind' the gateways own number). However, if it sends these numbers as full numbers (that is, including the various prefixes such as county code, are code, trunk, etc.), these can be stripped using the next 3 fields:

;Outgoing Calls No Name: If set no calling Name is sent with outgoing calls

;Outgoing Calls No URL: If set no src-URL is sent with outgoing calls

;No Presence/Dialog Subscribe: If set no subscribe sessions are forwarded thru this gateway object

;No Inband Disconnect: If this checkmark is set, a call disconnect with inband information will not be forwarded to the endpoint registered to the user, but the call will be cleared immediatelly without the inband information beeing sent..

;Fax License: TBD.

;Obtain Channels lic on outgoing call: If this checkmark is set, a PBX Channels license will be acquired for calls to a Conference interface. PBX Channels licenses must be installed on the PBX for this to work.

;No media calls: With this checkmark set only calls without media are allowed. In this case also no Port license is required.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Courseware:IT_Advanced_-_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Gateway object, Gateways registered to the same device config are used round-robin. The gateways registered to different devices are used in the sequence of the configured devices.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Gateways object are diverted.
;CFB: A CFB is executed if a call is rejected with ''User Busy'' by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (''no channel'', ''no gatway registered'', ...)

Reference16r1:PBX/Config/General

2025-10-13T13:34:03Z

Gd:

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

;No email as call destination: If checked an email address configured at a user cannot be used to call this user. This is useful, if there may be conflicts of email addresses with destinations to be called via federation.

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

Reference16r1:PBX/Config/General

2025-10-13T13:32:21Z

Gd: Created page with "== 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'''..."

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

2025-05-04T08:05:13Z

Gd:

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, adding a new User Object after deleting a User Object with the same Name, to that this is a new user and old information should not be reconnected to this user. Without this checkmark set, the name is used to connect the new User Object to the old information. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when adding a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect from a user with the same name are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UC: Combines Fax, Mobility, myPBX and Video licenses
;Voicemail: Voicemail for this user (uses VoicemailUser license)
;Fax: Personal Fax with innovaphone Fax
;Mobility: Mobility integration
;myPBX: myPBX client
;Video: innovaphone Video as part of the myPBX launcher
;AppSharing: innovaphone Application Sharing
;Reporting: innovaphone Reporting. The myPBX call lists do not require this license

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference15r1:PBX/Objects/Trunk Line

2025-04-30T13:47:04Z

Gd: /* Trunk Object specific configuration */

The Trunk Line object is typically used to register gateways to external lines. Several registrations are accepted. Calls sent to the trunk object are sent to the registrations in a round-robin manor. If the call to a registration fails in a way that indicates a local problem the next registration is tried.

Some general diversions can be configured for incoming calls e.g. for calls to invalid numbers.

== Trunk Object specific configuration ==

;Loopback: Destination (Name or Number) to which calls are forwarded, which dialed the same Trunk object. This is typically used if the number of the Trunk object (e.g. 0) shall be used as extension number of the switchboard for incoming calls. If the '''Internal''' checkmark is set, this is executed also if the trunk is called from within the PBX with a calling party number matching the number of the trunk object. This can happen if for example an escape is configured for the node of the trunk object matching the number of the trunk object.

;Incomplete: Destination (Name or Number) to which calls are forwarded, which dialed an incomplete number. If the incoming call is enblock this can be determined immediately. For overlap receiving calls a timeout of 4s is used. Sometimes it is desired that calls without extension number are sent to the switchboard. In this case the number of the switchboard should be configured here.

;Invalid: Destination (Name or Number) to which calls are forwarded, which dialed an invalid number. Typically the number of the switchboard is configured here so that incoming calls with an invalid extension are not lost. This is executed also for calls rejected because of the 'Reject ext. Calls' property at a called object.

;Busy: Destination (Name or Number) to which calls are forwarded, which dialed a busy number. If a CFB is configured at a called user this takes precedence. A CFB at at the called user to a number '''-''' turns this off for this user.

;Rejected: Calls which are rejected by the user (busy after alert), can be redirected to a configurable destination.

;No Answer: Destination (Name or Number) to which calls are forwarded, which dialed a destination which exists, but does not answer. The timeout value is configured in the '''Response Timeout''' field (on PBX/General or at the User object) which is used for CFNR as well. (There is no field '''Timeout''' configurable for this anymore) If a CFNR is configured at a called user this takes precedence. A CFNR at the called user to a number '''-''' turns this off for this user.

;Reroute supported: This check box turn on rerouting of incoming calls which are diverted to the same Trunk object. Normally an incoming call which is diverted to the same Trunk object is sent out on the Trunk as normal outgoing call. If this option is checked a reroute request is sent out instead. If the call is received from an ISDN interface this is mapped to partial rerouting. By doing this no channel is used on the ISDN interface for such a call (instead of 2) and the original calling party number is sent to the final destination by the ISDN network. Rerouting is supported only for CFU and CFB, not for CFNR.

:If your Provider does not support (partial) rerouting and you nevertheless configure ''Reroute supported'', the call forward will fail with a cause code ''Recovery on timer expiry.''

;Set Calling=Diverting No: Concerns calls that arrive on the PBX via the Trunk Line PBX object and are then forwarded by CFU, CFB or CFNR again to the Trunk Line object. For example: Subscriber A calls subscriber B. Subscriber B forwards the call from subscriber A to subscriber C.<br>The CGPN (Calling Party Number) remains unchanged for a call diversion. Merely the DGPN (Diverting Party Number) is also sent as information, so that both call numbers are visible at the diversion destination (subscriber C). For an external call diversion to the PSTN, it may not be permitted to use an external CGPN (subscriber A), however. Therefore, the CGPN must be replaced by an associated call number, in this case the DGPN (subscriber B). If this check box is not enabled, the local telephone office, in such as case, will automatically replace the CGPN through "screening".<br>If you enable this check box, the diversion call is signalled as a normal outgoing call. The CGPN is then a number that belongs to the connection (subscriber B).

; Set Diverting=Calling No: For calls from the PBX to the trunk, the ''calling party number'' (CGPN) is set as ''diverting number'' (DGPN) (a.k.a. ''leg2 info'') if there is none yet in the call. If set, the party the call needs to be billed to is always included in the DGPN thus

;Discard received diverting No: If set, received diverting info within calls from the trunk are discarded

;Outgoing Calls restricted: If this checkmark is set all calls sent out on the Trunk object are sent with CLIR (Calling Line Identification Restricted).

;Automatic Hangup: If this checkmark is set calls, which were already connected and then disconnected by remote party, are automatically released (hung up) two seconds after the disconnect, even if in-band info was indicated with the disconnect. This is useful when providers indicate but do not provide in-band info, or in general, because most providers only provide a busy tone in this situation and no announcement, so 2s are more then enough.

;Outgoing Calls CGPN: If a number is configured here all calls sent out to the Trunk object are sent with this number as Calling extension. For example the number of the switchboard can be configured here so that callbacks are not sent to the original caller but to the switchboard.

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Outgoing No Name: If this checkmark is set no calling name nor calling name display information is sent with outgoing calls

;No Presence/Dialog Subscribe: If checked, no presence or dialog subscriptions are forward out through this Trunk line object.

;No Call Completion: Prohibit call completion to this trunk. Some SIP providers create media calls on call completion tries, which results in phones ringing unexpectedly.

;Fake Connect on inc. Call: If this checkmark is set an incoming call is connected (send out a fake connect message) as soon as inband info is available from the destination of the call even if the destination did not connect the call already. This is especially useful for call forward out to a public network, so that the caller can hear the real inband info from the public network. Also timeouts can be avoided in such a case for the incoming call if the call is forwarded to a destination with slow alert or connect (e.g. GSM). Since v10 if there is no in-band info, now an alert is sent on this call in this case.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Courseware:IT_Advanced_-_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

;Name as Number: This option allows to send a Name of a PBX object as calling number for outgoing calls. The source name of the call is compared to the first field. If the name starts with the configured string, any digit in the remaining name is sent as calling line id. The second field may contain a number which is added as prefix to the calling line id. For incoming calls the called number is matched to the second field and in case of a match a name is called composed of the first field and any additional dialed digits. This way the same number can be used to call an endpoint as is displayed as calling line id.

:If the configured name starts with '?' for a match the "External" field configured at a user is used.
:If the configured name starts with '!' for a match the "External" field configured at a user is used. Only the number of the user is sent, without any adjustments for nodes

:This works only for users replicated to this PBX.

== Devices ==

The device configuration is used as always to allow the registrations of devices. In case of a trunk object this is typically a gateway or SBC.

The name of the device serves one special purpose, if the name starts with '#'. In this case, if a call is sent out to the trunk and the calling party number of this calls matches the digits following the '#', not just the next gateway is used, but instead the registration with the matching name is used. Incoming calls on such a registration are sent to the number following the '#'. This way multiple registrations to SIP providers can be mapped to internal numbers for incoming and outgoing calls.

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Trunk Line object, Gateways registered to the same devices Hardware Id are used in round-robin. If the Gateways register to different devices Hardware Id, they are used in the sequence of the configured devices Hardware Ids.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Trunk object are diverted.
;CFB: A CFB is executed if a call is rejected with User Busy by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (no channel, no gateway registered, ...)

== Group Indications ==

The trunk object generates group indications for incoming and outgoing calls including a park position (a number from 0 to n), which is sort of a virtual channel number. Together with Park function keys on the phone this can be used to simulate an oldstyle key system, so that each phone can have Line keys (the Park function key) for each available line (the position). With these Line keys a line can be aquired, monitored, a call can be parked on the line and picked up from the line.

= Related Articles =
* [[{{NAMESPACE}}:PBX/Objects]]

Reference15r1:PBX/Objects/Trunk Line

2025-04-30T13:44:49Z

Gd: Created page with "The Trunk Line object is typically used to register gateways to external lines. Several registrations are accepted. Calls sent to the trunk object are sent to the registrations in a round-robin manor. If the call to a registration fails in a way that indicates a local problem the next registration is tried. Some general diversions can be configured for incoming calls e.g. for calls to invalid numbers. == Trunk Object specific configuration == ;Loopback: Destination (..."

The Trunk Line object is typically used to register gateways to external lines. Several registrations are accepted. Calls sent to the trunk object are sent to the registrations in a round-robin manor. If the call to a registration fails in a way that indicates a local problem the next registration is tried.

Some general diversions can be configured for incoming calls e.g. for calls to invalid numbers.

== Trunk Object specific configuration ==

;Loopback: Destination (Name or Number) to which calls are forwarded, which dialed the same Trunk object. This is typically used if the number of the Trunk object (e.g. 0) shall be used as extension number of the switchboard for incoming calls. If the '''Internal''' checkmark is set, this is executed also if the trunk is called from within the PBX with a calling party number matching the number of the trunk object. This can happen if for example an escape is configured for the node of the trunk object matching the number of the trunk object.

;Incomplete: Destination (Name or Number) to which calls are forwarded, which dialed an incomplete number. If the incoming call is enblock this can be determined immediately. For overlap receiving calls a timeout of 4s is used. Sometimes it is desired that calls without extension number are sent to the switchboard. In this case the number of the switchboard should be configured here.

;Invalid: Destination (Name or Number) to which calls are forwarded, which dialed an invalid number. Typically the number of the switchboard is configured here so that incoming calls with an invalid extension are not lost. This is executed also for calls rejected because of the 'Reject ext. Calls' property at a called object.

;Busy: Destination (Name or Number) to which calls are forwarded, which dialed a busy number. If a CFB is configured at a called user this takes precedence. A CFB at at the called user to a number '''-''' turns this off for this user.

;Rejected: Calls which are rejected by the user (busy after alert), can be redirected to a configurable destination.

;No Answer: Destination (Name or Number) to which calls are forwarded, which dialed a destination which exists, but does not answer. The timeout value is configured in the '''Response Timeout''' field (on PBX/General or at the User object) which is used for CFNR as well. (There is no field '''Timeout''' configurable for this anymore) If a CFNR is configured at a called user this takes precedence. A CFNR at the called user to a number '''-''' turns this off for this user.

;Reroute supported: This check box turn on rerouting of incoming calls which are diverted to the same Trunk object. Normally an incoming call which is diverted to the same Trunk object is sent out on the Trunk as normal outgoing call. If this option is checked a reroute request is sent out instead. If the call is received from an ISDN interface this is mapped to partial rerouting. By doing this no channel is used on the ISDN interface for such a call (instead of 2) and the original calling party number is sent to the final destination by the ISDN network. Rerouting is supported only for CFU and CFB, not for CFNR.

:If your Provider does not support (partial) rerouting and you nevertheless configure ''Reroute supported'', the call forward will fail with a cause code ''Recovery on timer expiry.''

;Set Calling=Diverting No: Concerns calls that arrive on the PBX via the Trunk Line PBX object and are then forwarded by CFU, CFB or CFNR again to the Trunk Line object. For example: Subscriber A calls subscriber B. Subscriber B forwards the call from subscriber A to subscriber C.<br>The CGPN (Calling Party Number) remains unchanged for a call diversion. Merely the DGPN (Diverting Party Number) is also sent as information, so that both call numbers are visible at the diversion destination (subscriber C). For an external call diversion to the PSTN, it may not be permitted to use an external CGPN (subscriber A), however. Therefore, the CGPN must be replaced by an associated call number, in this case the DGPN (subscriber B). If this check box is not enabled, the local telephone office, in such as case, will automatically replace the CGPN through "screening".<br>If you enable this check box, the diversion call is signalled as a normal outgoing call. The CGPN is then a number that belongs to the connection (subscriber B).

; Set Diverting=Calling No: For calls from the PBX to the trunk, the ''calling party number'' (CGPN) is set as ''diverting number'' (DGPN) (a.k.a. ''leg2 info'') if there is none yet in the call. If set, the party the call needs to be billed to is always included in the DGPN thus

;Discard received diverting No: If set, received diverting info within calls from the trunk are discarded

;Outgoing Calls restricted: If this checkmark is set all calls sent out on the Trunk object are sent with CLIR (Calling Line Identification Restricted).

;Automatic Hangup: If this checkmark is set calls, which were already connected and then disconnected by remote party, are automatically released (hung up) two seconds after the disconnect, even if in-band info was indicated with the disconnect. This is useful when providers indicate but do not provide in-band info, or in general, because most providers only provide a busy tone in this situation and no announcement, so 2s are more then enough.

;Outgoing Calls CGPN: If a number is configured here all calls sent out to the Trunk object are sent with this number as Calling extension. For example the number of the switchboard can be configured here so that callbacks are not sent to the original caller but to the switchboard.

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Outgoing No Name: If this checkmark is set no calling name nor calling name display information is sent with outgoing calls

;No Presence/Dialog Subscribe: If checked, no presence or dialog subscriptions are forward out through this Trunk line object.

;No Call Completion: Prohibit call completion to this trunk. Some SIP providers create media calls on call completion tries, which results in phones ringing unexpectedly.

;Fake Connect on inc. Call: If this checkmark is set an incoming call is connected (send out a fake connect message) as soon as inband info is available from the destination of the call even if the destination did not connect the call already. This is especially useful for call forward out to a public network, so that the caller can hear the real inband info from the public network. Also timeouts can be avoided in such a case for the incoming call if the call is forwarded to a destination with slow alert or connect (e.g. GSM). Since v10 if there is no in-band info, now an alert is sent on this call in this case.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Courseware:IT_Advanced_-_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

;Name as Number: This option allows to send a Name of a PBX object as calling number for outgoing calls. The source name of the call is compared to the first field. If the name starts with the configured string, any digit in the remaining name is sent as calling line id. The second field may contain a number which is added as prefix to the calling line id. For incoming calls the called number is matched to the second field and in case of a match a name is called composed of the first field and any additional dialed digits. This way the same number can be used to call an endpoint as is displayed as calling line id.

:If the configured name starts with '?' for a match the "External" field configured at a user is used.

:This works only for users replicated to this PBX.

== Devices ==

The device configuration is used as always to allow the registrations of devices. In case of a trunk object this is typically a gateway or SBC.

The name of the device serves one special purpose, if the name starts with '#'. In this case, if a call is sent out to the trunk and the calling party number of this calls matches the digits following the '#', not just the next gateway is used, but instead the registration with the matching name is used. Incoming calls on such a registration are sent to the number following the '#'. This way multiple registrations to SIP providers can be mapped to internal numbers for incoming and outgoing calls.

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Trunk Line object, Gateways registered to the same devices Hardware Id are used in round-robin. If the Gateways register to different devices Hardware Id, they are used in the sequence of the configured devices Hardware Ids.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Trunk object are diverted.
;CFB: A CFB is executed if a call is rejected with User Busy by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (no channel, no gateway registered, ...)

== Group Indications ==

The trunk object generates group indications for incoming and outgoing calls including a park position (a number from 0 to n), which is sort of a virtual channel number. Together with Park function keys on the phone this can be used to simulate an oldstyle key system, so that each phone can have Line keys (the Park function key) for each available line (the position). With these Line keys a line can be aquired, monitored, a call can be parked on the line and picked up from the line.

= Related Articles =
* [[{{NAMESPACE}}:PBX/Objects]]

Reference15r1:PBX/Config/Chat

2025-02-17T07:53:18Z

Gd: Created page with "This config page is used for configurations related to the PBX built-In Chat functionality. == Basic operation == Without a chat license, chat is only supported with the Chat App provided by the PBX, which only supports volatile chat, meaning the Chat messages are not stored. If a Chat or Connect license is available, Chat can be provided by another App, which can be configured == App for Advanced Chat == Input field to configure the App, which is used for Chat. By d..."

This config page is used for configurations related to the PBX built-In Chat functionality.

== Basic operation ==

Without a chat license, chat is only supported with the Chat App provided by the PBX, which only supports volatile chat, meaning the Chat messages are not stored. If a Chat or Connect license is available, Chat can be provided by another App, which can be configured

== App for Advanced Chat ==

Input field to configure the App, which is used for Chat. By default "connect" is used. If the input is set empty, it reverts back to the default. The App "connect" is used as default, since this is the default name of the Connect App. This simplifies upgrade from version 14. Without any configuration change the Chat App changes to the new Chat functionality in Connect.

Reference15r1:PBX/Config/myApps

2025-02-10T18:40:20Z

Gd: Created page with "All the settings on that page can be done per PBX. Note that they are not synchronized automatically across PBXes. ==User Registration== * Registration Page: the URL to the form to register a new user, e.g. https://ap.innovaphone.com/innovaphone.com/usersapp/register.htm * Reset Password Page: the URL to the form to reset the password, e.g. https://ap.innovaphone.com/innovaphone.com/usersapp/password.htm * Privacy Policy URL: an URL to a privacy policy document. If conf..."

All the settings on that page can be done per PBX. Note that they are not synchronized automatically across PBXes.

==User Registration==
* Registration Page: the URL to the form to register a new user, e.g. https://ap.innovaphone.com/innovaphone.com/usersapp/register.htm
* Reset Password Page: the URL to the form to reset the password, e.g. https://ap.innovaphone.com/innovaphone.com/usersapp/password.htm
* Privacy Policy URL: an URL to a privacy policy document. If configured, it will be displayed on the login page of myApps.
* Edit Profile App: the name of the Profile App (e.g. "profile") that will be opened when the button "Edit Profile" on myApps menu is clicked.
* Tutorial App: the name of an app providing tutorials or manuals for the end user that will be shown as "Tutorials" in the myApps menu.

==Launcher Software Update==
* App store URL: the URL to an App Store where a software.json file along with the launcher files can be found, e.g. https://store.innovaphone.com/release/download/
* Build number: the build number to use, e.g. 131880

==Shared Services==
* Directory Service URL: This URL is used tp access a directory for available shared service. By default https://shared-services.innovaphone.com is used.

== Softphone Registration ==
; No physical location (from 13r3 SR7)
:If turned off, the Softphone App in the myApps Launcher will use the primary PBX (configured PBX) as the physical location.
:If turned on, the Softphone App in the myApps Launcher will use the registration PBX (final redirect target) as the physical location.
:If an explicit physical location is configured at the myApps Softphone, it will always be used, no matter how the checkmark is configured.
; Recording URL
: Configure the web link in order to send the recording raw data to the recording App service instance (for softphone App only)
; Recording Username
: for optional [[Howto14r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin|WebDav-Access]] (from 14r1)
; Recording Password
: for optional WebDav-Access
; Recording by default on
: Choose whether calls will be recorded at the start of the call or not
; Record external calls only
: Choose if only external calls will be recorded
; Recording incall control allowed by user
: Choose if users are able to start / stop their recording during a call (default is on)
; Recording URL in softphone app hidden
: Omit display and change option of the recording URL used in the softphone app

==Client Settings==
This section contains administrative settings for the myApps clients connected to the PBX.
<br>
''Hint'': Changed settings only take effect on new myApps connections. So myApps or the PBX needs to be restarted before the new settings are applied.
; Autostart
:If turned on, myApps will be started automatically each time the user logs in on his computer. myApps for Windows only.
; Show in taskbar
: If turned on, myApps will be displayed in the Windows taskbar, additionally to the task tray. myApps for Windows only.
; Auto appear offline
: The time of inactivity after which users should be displayed as offline. myApps for Windows only, applies for browser version also from 13r2 SR11).
; Autostart video
: This setting controls the default behaviour of phone apps on new phone calls. If ''on'' video telephony is done by default. If ''off'' audio-only calls are done by default. Note that during the call the user can turn video on or off at any time with both options.
; Hotkey dial
: The hotkey for dialling a selected phone number. myApps for Windows only.
; Hotkey accept
: The hotkey for accepting ringing calls. myApps for Windows only.
; Hotkey reject
: The hotkey for rejecting ringing calls or disconnecting active calls. myApps for Windows only.
; Log flags
: A hex string that represents the trace flags of the myApps launcher. See [[{{NAMESPACE}}:Concept_myApps_platform_services#Troubleshooting]].
Example trace flags:

0x000000001 (activate App trace)
+ 0x000000008 (activate DNS trace)
+ 0x000000080 (activate HTTP client trace)
+ 0x000008000 (activate App WebSocket client trace)
+ 0x080000000 (activate AppProxy client trace)
+ 0x200000000 (activate Webserver client trace)
============
0x280008089 <---- hide-mask

App, Browser, ICE, TURN, Signaling and Audio are the recommended flags to track call signaling and audio issues. Please use following mask: '''0x856000001'''.

; Docking
: Alignment of the Docking Mode or deactivated
; Show desktop notification
: Enable/Disable native Windows Notifications
; Audio/Video/AppSharing outside VPN
: Enable/Disable ignoring ICE candiates with an interfacetype of ''IF_TYPE_PPP'' or ''IF_TYPE_TUNNEL''
; Disable Outlook search
: Enable/Disable search in Outlook contacts when using native myAPPs-Windows-Client

For each setting there is a force checkmark with the following meaning:
;force on: The administrative setting will be used by all clients. The user is not able to change it. Previous user settings are ignored. Note that the force checkmark has no effect, if the corresponding option is unset.
;force off: The administrative setting is used as a default by all clients. The user can change it locally at any time. Previous user settings have priority.

==Custom app for MS Teams==
Download for a custom app that opens myapps inside MS Teams. The app is pre-configured with the DNS Name of the PBX.

For details see [[Reference13r2:Concept myApps Custom App for MS Teams|Reference13r2:Concept myApps Custom App for MS Teams]]

Reference14r2:PBX/Objects/Waiting Queue

2025-02-01T11:44:19Z

Gd: /* Announcements */

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|'''#c'''
|The conference id of the incoming call as hex string. Can be used to provide call specific announcements, if call is monitored by RCC
|-
|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.
|}

Reference14r2:PBX/Objects/Waiting Queue

2025-02-01T11:42:25Z

Gd: Created page with "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 onl..."

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

Reference15r1:Concept Apps

2025-01-15T14:22:42Z

Gd: /* App Objects Parameters */

[[Category:Concept|Apps]]

The innovaphone PBX allows the integration of Apps into the innovaphone myApps client. An App consists of an App Service from which the App is loaded and executed in the innovaphone myApps client as a Web application inside an iframe. The App Service may be the PBX itself, an AppService running on an innovaphone App Platform, or any other webserver.

The PBX controls which user may use which App. This is the main mechanism for assigning rights to users.

So called App Objects are used in the PBX include Apps into the PBX. The main configuration items in an App Object are the link to an App Service and the password, which acts as a shared secret between the PBX and the App Service, so that the PBX can authenticate the user for the App Service.

There is the generic App Object, which can be used for any App without special integration into the PBX. Some services of the PBX use external App Services (e.g. Push). For these services, some special App Objects are available.

== Applies To ==

* innovaphone PBX from version 13r1

== App Objects Parameters ==

App Objects use a common set of parameters to link an App into the PBX. Not all App Objects use all these parameters

;Description, Long Name, Name: Same meaning as for all objects

;Password: This is the shared secret between the PBX and the App Service. It allows the PBX to authenticate users for the App Service. If an App Service provides a PBX Manager Plugin for configuration, this password is typically set by the Plugin as a random string. Manual configuration of ths password should only done, if there is no other way.

;URL: The link to the App Service. This should be configured without filename extension. A postfix of .htm is added to the URL to load the App code as Web application. A postfix of .png is added to load the icon to be displayed in myApps. A size of 100px x 100px is recommended for the icon to have a nice display on 4K monitors.

;Icon URL: Optional link to an App Icon. If not configured the App URL is used for the Icon as well, by just loading a .png file with the same name as the .htm for the App code.

;Modes: A comma seperated list of Modes can be configured here. The modes can be used App specific to switch on different modes for functionality which only should be available for some users. Different rights levels can be implemented with this. For each mode configured here an entry shows up in the Apps section in the form of <app>~<mode>. By checking such an entry the user has access to this mode. (To App developers: If there are multiple modes checked, all these modes are added to the appobj property, seperated by ~, for example myapp~admin~debug).

;Licenses: If the App uses Service Licenses, the number of licenses to be used by this service can be configured here. The PBX then tries to acquire licenses of the type '''Service(<''name of the App''>)''' The booked licenses are only displayed on the master PBX in the corresponding app object. The booked licenses are not displayed on the slave PBX.

;Plain website: Indicates that this App service is a website, which does not make use of the authentication provided by the PBX. No App icon can be displayed for this kind of Apps.

;Hidden: Apps marked as hidden are not displayed in the myApps client. This kind of Apps is used to provide APIs for other Apps and are loaded automatically when the API is used.

;Share: With this checkmark the App is marked as a shared service, so it can be accessed by a PBX of another Domain using the PBX Manager Plugin "Shared Services". This requires a working Open H.323 Federatiion configuration including a valid certificate for the Domain of the PBX.

;Remote: This checkmark indicates, that this App Object defines the access to an App shared by another domain. This Checkmark is set automatically by the PBX Manager Plugin "Shared Services".

;Websocket: If set, the App Object establishes a Websocket connection to the App Service. This way the App Service itself can make use of APIs provided by the PBX.

;No Certificate check: If set, the certificate of the service is not checked. This is useful in a controlled environment, where no risk of a man in the middle (between PBX and App Service) existis.

For each API an App Services wants to use the correspondig flag must be set in the App object to grant access to the API. The available APIs are

;PbxSignal: Allows to register an endpoint using the innovaphone Json signaling protocol. Apps like Softphones can use this API
;EpSignal: Allows an App to insert itself into the signaling path to a registered endpoint. Apps, which control registered phones and may want to add additional media for calls of endpoints can use this API
;Messages: Access to saved chat messages
;TableUsers: This API publishes the table "users". This can be used to replicate the PBX users
;Admin: Create/Update/Delete Users and other PBX config itemss
;PbxApi: User level access to the PBX, with functions like presence monitoring
;Services: API which is used to get access to APIs provided by other App Services
;RCC: Remote Call Control. The functionality including message names and parameters is based on the SOAP API

== Objects ==

There are different objects, which are used as App Objects. A generic one and some for special purposes.

=== App ===

The App object is the generic mechanism to include an App in innovaphone myApps.

=== AP ===

An App object, which is used to load the hidden App from a App Platform Manager, which provides the APIs which are needed to configure an AP and load PBX Manager Plugins from the AP

=== Push ===

An special App object, which connects to a push service. The PBX uses this to deliver push notifications to smartphones. Any user, which wants to make use of the Push service, needs to have the push object configured as push property.

=== Voicemail ===

Executes voicemail scripts and loads the visual voicemail App from a voicemail App Service

=== Fax ===

Does the call signaling to FAX interfaces and load the Fax App from a fax App Service

== PBX Manager Plugins ==

If an app plugin creates the first object or, if only one exists and it is edited, the plugin creates a new password and sets it both in this object and in the app instance. If further objects are created or edited, it is checked if another object with valid login information exists, and if so, this password is used. If not, a new password is created and configured in both sides; in this case the other existing objects aren't changed and must be saved again to set the same password.

=== App Platforms ===

The App Platforms plugin creates the AP object for a foreign AP, which may offer cloud services (e.g. the Push service from innovaphone). It generates an account on the App Platform with a random password and configures the AP object for this account.

The account must be confirmed with a link sent by email. With the email verification it is possible to reconnect to an existing account, even if the password got lost and the account cannot be used by anyone not having access to this email address

=== Contacts ===

You can configure an LDAP login inside the PBX Manager Plugin of the Contacts App.

Reference15r1:PBX/Objects/App

2025-01-15T14:14:06Z

Gd: Created page with "The App object is used to create a reference to an innovaphone App that can be used in myApps. App objects can also be used for accepting incoming app websocket connections to the PBX with the configured credentials. Note that each app needs specific settings depending on the needed or provided features. See the app documentation to find out what checkmarks should be set. Find a functional description of the individual configuration options here {{NAMESPACE}}:Concept..."

The App object is used to create a reference to an innovaphone App that can be used in myApps.
App objects can also be used for accepting incoming app websocket connections to the PBX with the configured credentials.

Note that each app needs specific settings depending on the needed or provided features. See the app documentation to find out what checkmarks should be set.

Find a functional description of the individual configuration options here [[{{NAMESPACE}}:Concept_Apps#App_Objects_Parameters]].

Reference15r1:Gateway/GK/GW

2025-01-11T14:34:06Z

Gd: /* Interface (VoIP Interfaces) */

Below is an overview of all the gateway's configurable VoIP interfaces:
* '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "[[#Interface_.28VoIP_Interfaces.29|Administration/Gateway/VOIP/Interface (VoIP interfaces)]]".
* '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are contained in the chapter entitled "[[#CGPN.2FCDPN_Mappings|Administration/Gateway/Interfaces/CGPN-CDPN Mappings]]" further up in the text.
* '''Registration:''' If a terminal has successfully registered with a gateway, then this is indicated in this column through specification of the IP address <Name of the VoIP interface:Call number:IP address>.

== Interface (VoIP Interfaces) ==
Clicking the relevant VoIP interface (GW1-12 <Name of the VoIP interface>) in the Interface column opens a popup page, on which the VoIP interfaces can be individually configured. Like the PBX objects, this popup page also contains standard entry fields that occur, more or less, in all VoIP interfaces.

These standard fields are:
* '''Name:''' The descriptive name of the VoIP interface.
* '''Disable:''' A checked check box disables the relevant VoIP interface.
* '''Protocol:''' The protocol to be used, that is, H.323 or SIP. Depending on which protocol is used, the set-up of the entry fields changes.
* '''Mode:''' Describes the mode of registration. Possible registration modes are:
# Gateway without Registration - Logs the VoIP interface (gateway) on to the configured gatekeeper without a registration.
# Register as Endpoint - Registers a VoIP terminal with the configured gatekeeper.
# Register as Gateway - Registers a VoIP gateway with the configured gatekeeper.
# Gatekeeper/Registrar - Is required for managing all gatekeeper registrations on a gateway.
# ENUM - Is used to register an ENUM connection with the relevant interface.
* '''Gatekeeper Address (primary):''' The primary Gatekeeper IP address at which the terminal or gateway is to register via the relevant interface. Only necessary for modes 2 and 3.
* '''Gatekeeper Address (secondary):''' The alternative gatekeeper IP address at which the terminal or gateway is to register via the relevant interface, if registration with the primary gatekeeper fails. Only necessary for modes 2 and 3 .
* '''Local Domain:''' Replaces the existing system/domain name (for H323 federation only).
* '''Mask:''' By specifying a network mask, incoming calls can be filtered. Specification of the network mask 255.255.0.0 therefore allows incoming calls on the relevant interface for terminals from the IP address range 192.168.0.0 - 192.168.255.255 .
* '''Gatekeeper Identifier:''' It is also sufficient to specify only the gatekeeper ID. Every gatekeeper in a network can be identified by means of its own gatekeeper ID, so that several gatekeepers can be operated in a network, with each terminal nevertheless identifying the correct gatekeeper by means of Gatekeeper Discovery (uses the multicast address 224.0.1.41).
* '''STUN SERVER:''' The STUN server name or IP address must be configured if this device has no public IP address while the SIP server is accessible under a public IP address. The value is given by the SIP provider or administrator (for example, stun.xten.com or 64.69.76.23). You can choose any STUN server; it does not necessarily have to correspond to the one of the SIP provider.
* '''Local Signalling Port:''' Signalling Port used by the Interface.
* '''SIP - Register as Gateway/Endpoint:'''
** '''Remote Domain (SIP Only):''' SIP Domain of the remote SIP Server to register (often equal to the SIP Proxy).
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination and it's set at Remote Domain.
* '''SIP - Gateway without Registration:'''
** '''Remote Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "FROM" field and removes it if match.
** '''Local Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "TO" field and removes it if match.
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (INVITE,etc) are to be sent to, this field it's mandatory.
** '''Filter Incoming Calls (SIP Only):''' Accept Incoming Call on this interface only if the domain part of the "To:" field SIP URI matches the ''Local Domain'' configured. If not accepted, the call may still be accepted by another interface
* '''H323/TLS - Gateway without Registration
** '''Federation:''' Turns on open federation, which means the domain part of a destination name is used to look up the remote gateway in the DNS
** '''Veriyfy Cert:''' If set, the remote ceritficate on an incoming call is verified against the domain part of the source name

=== Authorization section ===
In the '''Authorization''' section, you can store a password for the VoIP interface.
* '''Password / Retype:''' The security of the registration can be raised by specifying a password (Password). The password must be confirmed (Retype).

=== Alias List section ===
In the '''Alias List''' section, you specify the call name (H.323) and the call number (E.164) of the relevant registration. For VoIP end points, you should define the assigned direct dialling number or MSN as the E.164 address, and the name as the H.323 name. For VoIP gateways it is sufficient to define the name.
* '''Name:''' The H.323 name.
* '''Number:''' The E.164 call number.

=== Coder Preferences section ===
The standard entry fields in the '''Coder Preferences''' section were already described in chapter "[[Reference:Administration/Gateway/Interfaces#Interface_.28ISDN.2C_SIP_.26_virtual_interfaces.29|Administration/Gateway/Interfaces/Interface (physical and virtual interfaces)]]".

=== Media Properties ===
The standard entry fields in the '''Media Properties''' section were already described [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]].

=== H.323 Interop Tweaks section ===
In addition to the standard fields, several advanced settings are available in the '''H.323 Interop Tweaks''' section. They are normally not necessary and are merely used to solve compatibility problems with some PBXs:
* '''No Faststart:''' The H.245 faststart procedure is enabled as standard. Outgoing calls are made with faststart, incoming calls with faststart are answered with faststart.<br>A checked check box disables the H.245 faststart procedure. Outgoing calls are made without faststart, incoming calls with and without faststart are answered without faststart.
* '''No H.245 Tunneling:''' The H.245 tunneling procedure is enabled as standard. The voice data connection is negotiated in the TCP signalling connection*) already available. This can be advantageous in connection with NAT and firewalls.
A checked check box disables the H.245 tunneling procedure, meaning that a separate TCP connection is set up for this negotiation. This applies to the signalling connection leading out of the gatekeeper.
* '''Suppress HLC:''' A checked check box disables the transmission of HLC (High Layer Compatibility) information elements.
* '''Suppress FTY:''' A checked check box disables the transmission of FTY (Facility) information elements.
* '''Suppress Subaddress:''' A checked check box disables the transmission of Subaddress information elements.
*) From a technical viewpoint, the H.245 protocol does not establish its own TCP connection,
but shares the H.225 TCP connection.

=== SIP Interop Tweaks section ===
Miscellaneous interoperability options for SIP.
{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-
|valign=top nowrap=true|'''No Early Media'''
|Ignore any SDP answer received before final connect response. (Affects only outgoing SIP calls)
|-
|valign=top nowrap=true|'''No Inband Information on Error'''
|Controls interworking of Q.931 DISC message. If this option is set, DISC message is always interworked into BYE request.
|-
|valign=top nowrap=true|'''No Inband Disconnect'''
|TBD.
|-
|valign=top nowrap=true|'''No Remote Hold Signaling'''
|Disables interworking of "inactive" into RemoteHold (affects connected SIP calls only).
|-
|valign=top nowrap=true|'''Take Refer-To URI as Remote Target URI'''
|If enabled: When REFER is received and transfer is executed by the Gateway application and a new INVITE is sent, the Request-URI of this INVITE matches the URI that has been received in Refer-To header in REFER.<br/>
If not enabled: The Request-URI of the outgoing INVITE is created by usual means. Userpart of the Request-URI usually contains the CDPN as provided by Gateway application.
|-
|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls . '''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header). '''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only. '''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number. '''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string. '''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id). '''CGPN in user part of URI''': Variable From-URI with actual calling party number. '''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number.
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262). '''Supported''': Supported as optional extension. '''Required''': Required as mandatory extension. '''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Microsoft Presence Format'''
|Enables special Microsoft Presence format/scheme, only used for SIP Federation with Lync 2013.
|}

== CGPN/CDPN Mappings ==
A detailed description may be found in the chapter entitled "[[Reference:Administration/Gateway/Interfaces#CGPN.2FCDPN_Mappings|Administration/Gateway/Interface/CGPN-CDPN Mappings]]".

Reference15r1:Gateway/GK/GW

2025-01-11T14:28:59Z

Gd: Created page with "Below is an overview of all the gateway's configurable VoIP interfaces: * '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "Administration/Gateway/VOIP/Interface (VoIP interfaces)". * '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are co..."

Below is an overview of all the gateway's configurable VoIP interfaces:
* '''Interface:''' The name of the interface. Clicking this name opens a popup page, on which all settings can be made. The settings are described in more detail in the following chapter "[[#Interface_.28VoIP_Interfaces.29|Administration/Gateway/VOIP/Interface (VoIP interfaces)]]".
* '''CGPN In, CDPN In, CGPN Out, CDPN Out:''' Precise details on CGPN In, CDPN In, CGPN Out and CDPN Out mappings are contained in the chapter entitled "[[#CGPN.2FCDPN_Mappings|Administration/Gateway/Interfaces/CGPN-CDPN Mappings]]" further up in the text.
* '''Registration:''' If a terminal has successfully registered with a gateway, then this is indicated in this column through specification of the IP address <Name of the VoIP interface:Call number:IP address>.

== Interface (VoIP Interfaces) ==
Clicking the relevant VoIP interface (GW1-12 <Name of the VoIP interface>) in the Interface column opens a popup page, on which the VoIP interfaces can be individually configured. Like the PBX objects, this popup page also contains standard entry fields that occur, more or less, in all VoIP interfaces.

These standard fields are:
* '''Name:''' The descriptive name of the VoIP interface.
* '''Disable:''' A checked check box disables the relevant VoIP interface.
* '''Protocol:''' The protocol to be used, that is, H.323 or SIP. Depending on which protocol is used, the set-up of the entry fields changes.
* '''Mode:''' Describes the mode of registration. Possible registration modes are:
# Gateway without Registration - Logs the VoIP interface (gateway) on to the configured gatekeeper without a registration.
# Register as Endpoint - Registers a VoIP terminal with the configured gatekeeper.
# Register as Gateway - Registers a VoIP gateway with the configured gatekeeper.
# Gatekeeper/Registrar - Is required for managing all gatekeeper registrations on a gateway.
# ENUM - Is used to register an ENUM connection with the relevant interface.
* '''Gatekeeper Address (primary):''' The primary Gatekeeper IP address at which the terminal or gateway is to register via the relevant interface. Only necessary for modes 2 and 3.
* '''Gatekeeper Address (secondary):''' The alternative gatekeeper IP address at which the terminal or gateway is to register via the relevant interface, if registration with the primary gatekeeper fails. Only necessary for modes 2 and 3 .
* '''Local Domain:''' Replaces the existing system/domain name (for H323 federation only).
* '''Mask:''' By specifying a network mask, incoming calls can be filtered. Specification of the network mask 255.255.0.0 therefore allows incoming calls on the relevant interface for terminals from the IP address range 192.168.0.0 - 192.168.255.255 .
* '''Gatekeeper Identifier:''' It is also sufficient to specify only the gatekeeper ID. Every gatekeeper in a network can be identified by means of its own gatekeeper ID, so that several gatekeepers can be operated in a network, with each terminal nevertheless identifying the correct gatekeeper by means of Gatekeeper Discovery (uses the multicast address 224.0.1.41).
* '''STUN SERVER:''' The STUN server name or IP address must be configured if this device has no public IP address while the SIP server is accessible under a public IP address. The value is given by the SIP provider or administrator (for example, stun.xten.com or 64.69.76.23). You can choose any STUN server; it does not necessarily have to correspond to the one of the SIP provider.
* '''Local Signalling Port:''' Signalling Port used by the Interface.
* '''SIP - Register as Gateway/Endpoint:'''
** '''Remote Domain (SIP Only):''' SIP Domain of the remote SIP Server to register (often equal to the SIP Proxy).
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination and it's set at Remote Domain.
* '''SIP - Gateway without Registration:'''
** '''Remote Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "FROM" field and removes it if match.
** '''Local Domain (SIP Only):''' Check the Domain/IP Address on the SIP URI "TO" field and removes it if match.
** '''Proxy (SIP Only):''' DNS name or IP address of the SIP proxy where SIP messages (INVITE,etc) are to be sent to, this field it's mandatory.
** '''Filter Incoming Calls (SIP Only):''' Accept Incoming Call on this interface only if the domain part of the "To:" field SIP URI matches the ''Local Domain'' configured. If not accepted, the call may still be accepted by another interface

=== Authorization section ===
In the '''Authorization''' section, you can store a password for the VoIP interface.
* '''Password / Retype:''' The security of the registration can be raised by specifying a password (Password). The password must be confirmed (Retype).

=== Alias List section ===
In the '''Alias List''' section, you specify the call name (H.323) and the call number (E.164) of the relevant registration. For VoIP end points, you should define the assigned direct dialling number or MSN as the E.164 address, and the name as the H.323 name. For VoIP gateways it is sufficient to define the name.
* '''Name:''' The H.323 name.
* '''Number:''' The E.164 call number.

=== Coder Preferences section ===
The standard entry fields in the '''Coder Preferences''' section were already described in chapter "[[Reference:Administration/Gateway/Interfaces#Interface_.28ISDN.2C_SIP_.26_virtual_interfaces.29|Administration/Gateway/Interfaces/Interface (physical and virtual interfaces)]]".

=== Media Properties ===
The standard entry fields in the '''Media Properties''' section were already described [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]].

=== H.323 Interop Tweaks section ===
In addition to the standard fields, several advanced settings are available in the '''H.323 Interop Tweaks''' section. They are normally not necessary and are merely used to solve compatibility problems with some PBXs:
* '''No Faststart:''' The H.245 faststart procedure is enabled as standard. Outgoing calls are made with faststart, incoming calls with faststart are answered with faststart.<br>A checked check box disables the H.245 faststart procedure. Outgoing calls are made without faststart, incoming calls with and without faststart are answered without faststart.
* '''No H.245 Tunneling:''' The H.245 tunneling procedure is enabled as standard. The voice data connection is negotiated in the TCP signalling connection*) already available. This can be advantageous in connection with NAT and firewalls.
A checked check box disables the H.245 tunneling procedure, meaning that a separate TCP connection is set up for this negotiation. This applies to the signalling connection leading out of the gatekeeper.
* '''Suppress HLC:''' A checked check box disables the transmission of HLC (High Layer Compatibility) information elements.
* '''Suppress FTY:''' A checked check box disables the transmission of FTY (Facility) information elements.
* '''Suppress Subaddress:''' A checked check box disables the transmission of Subaddress information elements.
*) From a technical viewpoint, the H.245 protocol does not establish its own TCP connection,
but shares the H.225 TCP connection.

=== SIP Interop Tweaks section ===
Miscellaneous interoperability options for SIP.
{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-
|valign=top nowrap=true|'''No Early Media'''
|Ignore any SDP answer received before final connect response. (Affects only outgoing SIP calls)
|-
|valign=top nowrap=true|'''No Inband Information on Error'''
|Controls interworking of Q.931 DISC message. If this option is set, DISC message is always interworked into BYE request.
|-
|valign=top nowrap=true|'''No Inband Disconnect'''
|TBD.
|-
|valign=top nowrap=true|'''No Remote Hold Signaling'''
|Disables interworking of "inactive" into RemoteHold (affects connected SIP calls only).
|-
|valign=top nowrap=true|'''Take Refer-To URI as Remote Target URI'''
|If enabled: When REFER is received and transfer is executed by the Gateway application and a new INVITE is sent, the Request-URI of this INVITE matches the URI that has been received in Refer-To header in REFER.<br/>
If not enabled: The Request-URI of the outgoing INVITE is created by usual means. Userpart of the Request-URI usually contains the CDPN as provided by Gateway application.
|-
|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls . '''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header). '''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only. '''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number. '''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string. '''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id). '''CGPN in user part of URI''': Variable From-URI with actual calling party number. '''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number.
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262). '''Supported''': Supported as optional extension. '''Required''': Required as mandatory extension. '''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Microsoft Presence Format'''
|Enables special Microsoft Presence format/scheme, only used for SIP Federation with Lync 2013.
|}

== CGPN/CDPN Mappings ==
A detailed description may be found in the chapter entitled "[[Reference:Administration/Gateway/Interfaces#CGPN.2FCDPN_Mappings|Administration/Gateway/Interface/CGPN-CDPN Mappings]]".

Reference15r1:PBX/Objects

2025-01-10T09:03:57Z

Gd: /* General Object Properties */

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, when changing the Name of a User object to indicate that this is a new user and old information should not be reconnected to this user. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when changing the name of a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UC: Combines Fax, Mobility, myPBX and Video licenses
;Voicemail: Voicemail for this user (uses VoicemailUser license)
;Fax: Personal Fax with innovaphone Fax
;Mobility: Mobility integration
;myPBX: myPBX client
;Video: innovaphone Video as part of the myPBX launcher
;AppSharing: innovaphone Application Sharing
;Reporting: innovaphone Reporting. The myPBX call lists do not require this license

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference15r1:PBX/Objects

2025-01-10T08:57:54Z

Gd: Created page with "This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted. == Display of existing Objects == By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Lo..."

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UC: Combines Fax, Mobility, myPBX and Video licenses
;Voicemail: Voicemail for this user (uses VoicemailUser license)
;Fax: Personal Fax with innovaphone Fax
;Mobility: Mobility integration
;myPBX: myPBX client
;Video: innovaphone Video as part of the myPBX launcher
;AppSharing: innovaphone Application Sharing
;Reporting: innovaphone Reporting. The myPBX call lists do not require this license

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference15r1:Apps/PbxManager/Shared Services

2025-01-08T14:30:40Z

Gd:

With the Cloud Services Plugin, Apps which are published as Cloud Services can be added to the local myApps installation.

== SIP URI ==

With the SIP URI a remote App, which is published as cloud service can be address. Iz uses the format <app name>@<remote myApps domain>. Example: connect@community.innovaphone.com. With the ? icon next to the SIP URI input field, a directory service for Cloud Services can be opened. The SIP URI for any cloud service selected there is automatically put into this input field. The URL for the Cloud Services directory can be configured in the PBX Advanced UI on the myApps page.

== App Long Name ==

Configure a name for the App displayed in the myApps Client for this App here. This name must be unique within the PBX

== App Name ==

The name of the created App Object. This name must be unique within the PBX. This is the name, which is used to assign users to the App, either directly or via template

Reference15r1:Apps/PbxManager/Shared Services

2025-01-08T14:28:43Z

Gd: Created page with "With the Cloud Services Plugin, Apps which are published as Cloud Services can be added to the local myApps installation. == SIP URI == With the SIP URI a remote App, which is published as cloud service can be address. Iz uses the format <app name>@<remote myApps domain>. Example: connect@community.innovaphone.com. With the ? icon next to the SIP URI input field, a directory service for Cloud Services can be opened. The SIP URI for any cloud service selected there is a..."

With the Cloud Services Plugin, Apps which are published as Cloud Services can be added to the local myApps installation.

== SIP URI ==

With the SIP URI a remote App, which is published as cloud service can be address. Iz uses the format <app name>@<remote myApps domain>. Example: connect@community.innovaphone.com. With the ? icon next to the SIP URI input field, a directory service for Cloud Services can be opened. The SIP URI for any cloud service selected there is automatically put into this input field

== App Long Name ==

Configure a name for the App displayed in the myApps Client for this App here. This name must be unique within the PBX

== App Name ==

The name of the created App Object. This name must be unique within the PBX. This is the name, which is used to assign users to the App, either directly or via template

Reference15r1:Apps/PbxManager/App Messages

2025-01-08T14:18:02Z

Gd: Created page with "With the Messages PBX-Manager plugin, the needed app objects for all connected apps can be created and configured. In addition, the creeated app objects can be assigned to specific config templates, if any exist. == Add an app object == you can choose between "Connect" (for the Connect App) and "Api" (for the Messages Api). ;name :The ''name'' displayed for the app object which must be unique. ;SIP :The ''sip'' from the app object which must be unique. If config te..."

With the Messages PBX-Manager plugin, the needed app objects for all connected apps can be created and configured.
In addition, the creeated app objects can be assigned to specific config templates, if any exist.

== Add an app object ==
you can choose between "Connect" (for the Connect App) and "Api" (for the Messages Api).

;name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

If config templates exist, they will be listed with a checkbox.
The app object will be assigned to the config templates if a checkbox is checked.

For the Connect App an checkboy is availble to make the App available for public access as a cloud service

Reference15r1:Concept Apps

2024-12-09T11:39:29Z

Gd: Created page with "Apps The innovaphone PBX allows the integration of Apps into the innovaphone myApps client. An App consists of an App Service from which the App is loaded and executed in the innovaphone myApps client as a Web application inside an iframe. The App Service may be the PBX itself, an AppService running on an innovaphone App Platform, or any other webserver. The PBX controls which user may use which App. This is the main mechanism for assigning rights..."

[[Category:Concept|Apps]]

The innovaphone PBX allows the integration of Apps into the innovaphone myApps client. An App consists of an App Service from which the App is loaded and executed in the innovaphone myApps client as a Web application inside an iframe. The App Service may be the PBX itself, an AppService running on an innovaphone App Platform, or any other webserver.

The PBX controls which user may use which App. This is the main mechanism for assigning rights to users.

So called App Objects are used in the PBX include Apps into the PBX. The main configuration items in an App Object are the link to an App Service and the password, which acts as a shared secret between the PBX and the App Service, so that the PBX can authenticate the user for the App Service.

There is the generic App Object, which can be used for any App without special integration into the PBX. Some services of the PBX use external App Services (e.g. Push). For these services, some special App Objects are available.

== Applies To ==

* innovaphone PBX from version 13r1

== App Objects Parameters ==

App Objects use a common set of parameters to link an App into the PBX. Not all App Objects use all these parameters

;Description, Long Name, Name: Same meaning as for all objects

;Password: This is the shared secret between the PBX and the App Service. It allows the PBX to authenticate users for the App Service. If an App Service provides a PBX Manager Plugin for configuration, this password is typically set by the Plugin as a random string. Manual configuration of ths password should only done, if there is no other way.

;URL: The link to the App Service. This should be configured without filename extension. A postfix of .htm is added to the URL to load the App code as Web application. A postfix of .png is added to load the icon to be displayed in myApps. A size of 100px x 100px is recommended for the icon to have a nice display on 4K monitors.

;Icon URL: Optional link to an App Icon. If not configured the App URL is used for the Icon as well, by just loading a .png file with the same name as the .htm for the App code.

;Modes: A comma seperated list of Modes can be configured here. The modes can be used App specific to switch on different modes for functionality which only should be available for some users. Different rights levels can be implemented with this. For each mode configured here an entry shows up in the Apps section in the form of <app>~<mode>. By checking such an entry the user has access to this mode. (To App developers: If there are multiple modes checked, all these modes are added to the appobj property, seperated by ~, for example myapp~admin~debug).

;Licenses: If the App uses Service Licenses, the number of licenses to be used by this service can be configured here. The PBX then tries to acquire licenses of the type '''Service(<''name of the App''>)''' The booked licenses are only displayed on the master PBX in the corresponding app object. The booked licenses are not displayed on the slave PBX.

;Plain website: Indicates that this App service is a website, which does not make use of the authentication provided by the PBX. No App icon can be displayed for this kind of Apps.

;Hidden: Apps marked as hidden are not displayed in the myApps client. This kind of Apps is used to provide APIs for other Apps and are loaded automatically when the API is used.

;Websocket: If set, the App Object establishes a Websocket connection to the App Service. This way the App Service itself can make use of APIs provided by the PBX.

;No Certificate check: If set, the certificate of the service is not checked. This is useful in a controlled environment, where no risk of a man in the middle (between PBX and App Service) existis.

For each API an App Services wants to use the correspondig flag must be set in the App object to grant access to the API. The available APIs are

;PbxSignal: Allows to register an endpoint using the innovaphone Json signaling protocol. Apps like Softphones can use this API
;EpSignal: Allows an App to insert itself into the signaling path to a registered endpoint. Apps, which control registered phones and may want to add additional media for calls of endpoints can use this API
;Messages: Access to saved chat messages
;TableUsers: This API publishes the table "users". This can be used to replicate the PBX users
;Admin: Create/Update/Delete Users and other PBX config itemss
;PbxApi: User level access to the PBX, with functions like presence monitoring
;Services: API which is used to get access to APIs provided by other App Services
;RCC: Remote Call Control. The functionality including message names and parameters is based on the SOAP API

== Objects ==

There are different objects, which are used as App Objects. A generic one and some for special purposes.

=== App ===

The App object is the generic mechanism to include an App in innovaphone myApps.

=== AP ===

An App object, which is used to load the hidden App from a App Platform Manager, which provides the APIs which are needed to configure an AP and load PBX Manager Plugins from the AP

=== Push ===

An special App object, which connects to a push service. The PBX uses this to deliver push notifications to smartphones. Any user, which wants to make use of the Push service, needs to have the push object configured as push property.

=== Voicemail ===

Executes voicemail scripts and loads the visual voicemail App from a voicemail App Service

=== Fax ===

Does the call signaling to FAX interfaces and load the Fax App from a fax App Service

== PBX Manager Plugins ==

If an app plugin creates the first object or, if only one exists and it is edited, the plugin creates a new password and sets it both in this object and in the app instance. If further objects are created or edited, it is checked if another object with valid login information exists, and if so, this password is used. If not, a new password is created and configured in both sides; in this case the other existing objects aren't changed and must be saved again to set the same password.

=== App Platforms ===

The App Platforms plugin creates the AP object for a foreign AP, which may offer cloud services (e.g. the Push service from innovaphone). It generates an account on the App Platform with a random password and configures the AP object for this account.

The account must be confirmed with a link sent by email. With the email verification it is possible to reconnect to an existing account, even if the password got lost and the account cannot be used by anyone not having access to this email address

=== Contacts ===

You can configure an LDAP login inside the PBX Manager Plugin of the Contacts App.

Reference15r1:PBX/Objects/Gateway

2024-10-28T11:26:36Z

Gd:

The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls the incoming calling party number is passed on.

See [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|respective article]] for generic object properties.

== Gateway Object specific Configuration ==

;Enblock Count: If this number of digits is dialed after the number of the Gateway object itself, the call is sent out as enblock call. This is useful to connect to gateway which are not capable of overlap receiving.

;Enblock as Diverting No: If this checkmark is set, the called party number is transmitted as diverting leg2 information. As called party number the number of the gateway object is sent or no number if the Prefix checkmark is set. This is useful with Microsoft Exchange since this expects the number of the mailbox as diverting number.

;Prefix: If this checkmark is set, the number of the Gateway object itself is removed from the called party number for outgoing calls and added to the calling party number for incoming calls

;Domain: Route calls with matching domain part in the destination to this object.

;Loop Detect: If checked outgoing calls are blocked if a call with identical source and destination addresses already exists.

;International Match: If a call is received, the calling party number is compared to this number. If there is a match (head match) this number is removed from the calling party number, so that only additional digits remain. E.g. on an incoming call from a registration on this Gateway object the CGPN 00049703173009123 will be mapped to 123 (if the number is set to 00049703173009). Note that this comparison is done after the replacements configured in PBX/Config/General/Prefix for ... have been performed

;National Match: Same as 'International Match' only for national calling party number. This comparison is done if the comparison for the International Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 00703173009123 will be mapped to 123 (if the number is set to 00703173009)

;Subscriber Match: Same as 'International Match' only for subscriber calling party number. This comparison is done if the comparison for the National Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 073009123 will be mapped to 123 (if the number is set to 073009)

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Internal Destination: If this checkmark is set, all calls from devices registered at this object are marked as Internal (Numbering plan set to private). This is usefull if systems are registered to this object, which cannot send calls with the private numbering plan but should be regarded as internal (e.g. voicemail systems).

The device registering with a gateway object is normally expected to send local extension numbers as calling party number (i.e. extensions local to the PBX and 'behind' the gateways own number). However, if it sends these numbers as full numbers (that is, including the various prefixes such as county code, are code, trunk, etc.), these can be stripped using the next 3 fields:

;Outgoing Calls No Name: If set no calling Name is sent with outgoing calls

;Outgoing Calls No URL: If set no src-URL is sent with outgoing calls

;No Presence/Dialog Subscribe: If set no subscribe sessions are forwarded thru this gateway object

;No Inband Disconnect: If this checkmark is set, a call disconnect with inband information will not be forwarded to the endpoint registered to the user, but the call will be cleared immediatelly without the inband information beeing sent..

;Fax License: TBD.

;Obtain Channels lic on outgoing call: If this checkmark is set, a PBX Channels license will be acquired for calls to a Conference interface. PBX Channels licenses must be installed on the PBX for this to work.

;No media calls: With this checkmark set only calls without media are allowed. In this case also no Port license is required.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Course13:IT_Advanced_-_07_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Gateway object, Gateways registered to the same device config are used round-robin. The gateways registered to different devices are used in the sequence of the configured devices.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Gateways object are diverted.
;CFB: A CFB is executed if a call is rejected with ''User Busy'' by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (''no channel'', ''no gatway registered'', ...)

Reference15r1:PBX/Objects/Gateway

2024-10-28T11:23:25Z

Gd: Created page with "The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls the incoming calling party number is passed on. See respective article for generic object properties. == Gateway Object specific Configuration == ;Enblock Count: If this number of digits is dialed after the number of the Gateway o..."

The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls the incoming calling party number is passed on.

See [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties|respective article]] for generic object properties.

== Gateway Object specific Configuration ==

;Enblock Count: If this number of digits is dialed after the number of the Gateway object itself, the call is sent out as enblock call. This is useful to connect to gateway which are not capable of overlap receiving.

;Enblock as Diverting No: If this checkmark is set, the called party number is transmitted as diverting leg2 information. As called party number the number of the gateway object is sent or no number if the Prefix checkmark is set. This is useful with Microsoft Exchange since this expects the number of the mailbox as diverting number.

;Prefix: If this checkmark is set, the number of the Gateway object itself is removed from the called party number for outgoing calls and added to the calling party number for incoming calls

;Domain: Route calls with matching domain part in the destination to this object.

;Loop Detect: If checked outgoing calls are blocked if a call with identical source and destination addresses already exists.

;International Match: If a call is received, the calling party number is compared to this number. If there is a match (head match) this number is removed from the calling party number, so that only additional digits remain. E.g. on an incoming call from a registration on this Gateway object the CGPN 00049703173009123 will be mapped to 123 (if the number is set to 00049703173009). Note that this comparison is done after the replacements configured in PBX/Config/General/Prefix for ... have been performed

;National Match: Same as 'International Match' only for national calling party number. This comparison is done if the comparison for the International Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 00703173009123 will be mapped to 123 (if the number is set to 00703173009)

;Subscriber Match: Same as 'International Match' only for subscriber calling party number. This comparison is done if the comparison for the National Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 073009123 will be mapped to 123 (if the number is set to 073009)

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Internal Destination: If this checkmark is set, all calls from devices registered at this object are marked as Internal (Numbering plan set to private). This is usefull if systems are registered to this object, which cannot send calls with the private numbering plan but should be regarded as internal (e.g. voicemail systems).

The device registering with a gateway object is normally expected to send local extension numbers as calling party number (i.e. extensions local to the PBX and 'behind' the gateways own number). However, if it sends these numbers as full numbers (that is, including the various prefixes such as county code, are code, trunk, etc.), these can be stripped using the next 3 fields:

;Outgoing Calls No Name: If set no calling Name is sent with outgoing calls

;Outgoing Calls No URL: If set no src-URL is sent with outgoing calls

;No Presence/Dialog Subscribe: If set no subscribe sessions are forwarded thru this gateway object

;No Inband Disconnect: If this checkmark is set, a call disconnect with inband information will not be forwarded to the endpoint registered to the user, but the call will be cleared immediatelly without the inband information beeing sent..

;Fax License: TBD.

;Obtain Channels lic on outgoing call: If this checkmark is set, a PBX Channels license will be acquired for calls to a Conference interface. PBX Channels licenses must be installed on the PBX for this to work.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Course13:IT_Advanced_-_07_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Gateway object, Gateways registered to the same device config are used round-robin. The gateways registered to different devices are used in the sequence of the configured devices.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Gateways object are diverted.
;CFB: A CFB is executed if a call is rejected with ''User Busy'' by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (''no channel'', ''no gatway registered'', ...)

Reference15r1:PBX/Config/General

2024-09-27T09:59:42Z

Gd: /* 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).

;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/Config/General

2024-09-27T09:59:08Z

Gd: /* 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).

;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/Config/General

2024-09-27T09:54:09Z

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

Reference13r2:PBX/Objects/Trunk Line

2024-08-08T12:47:13Z

Gd: /* Trunk Object specific configuration */

The Trunk Line object is typically used to register gateways to external lines. Several registrations are accepted. Calls sent to the trunk object are sent to the registrations in a round-robin manor. If the call to a registration fails in a way that indicates a local problem the next registration is tried.

Some general diversions can be configured for incoming calls e.g. for calls to invalid numbers.

== Trunk Object specific configuration ==

;Loopback: Destination (Name or Number) to which calls are forwarded, which dialed the same Trunk object. This is typically used if the number of the Trunk object (e.g. 0) shall be used as extension number of the switchboard for incoming calls. If the '''Internal''' checkmark is set, this is executed also if the trunk is called from within the PBX with a calling party number matching the number of the trunk object. This can happen if for example an escape is configured for the node of the trunk object matching the number of the trunk object.

;Incomplete: Destination (Name or Number) to which calls are forwarded, which dialed an incomplete number. If the incoming call is enblock this can be determined immediately. For overlap receiving calls a timeout of 4s is used. Sometimes it is desired that calls without extension number are sent to the switchboard. In this case the number of the switchboard should be configured here.

;Invalid: Destination (Name or Number) to which calls are forwarded, which dialed an invalid number. Typically the number of the switchboard is configured here so that incoming calls with an invalid extension are not lost. This is executed also for calls rejected because of the 'Reject ext. Calls' property at a called object.

;Busy: Destination (Name or Number) to which calls are forwarded, which dialed a busy number. If a CFB is configured at a called user this takes precedence. A CFB at at the called user to a number '''-''' turns this off for this user.

;Rejected: Calls which are rejected by the user (busy after alert), can be redirected to a configurable destination.

;No Answer: Destination (Name or Number) to which calls are forwarded, which dialed a destination which exists, but does not answer. The timeout value is configured in the '''Response Timeout''' field (on PBX/General or at the User object) which is used for CFNR as well. (There is no field '''Timeout''' configurable for this anymore) If a CFNR is configured at a called user this takes precedence. A CFNR at the called user to a number '''-''' turns this off for this user.

;Reroute supported: This check box turn on rerouting of incoming calls which are diverted to the same Trunk object. Normally an incoming call which is diverted to the same Trunk object is sent out on the Trunk as normal outgoing call. If this option is checked a reroute request is sent out instead. If the call is received from an ISDN interface this is mapped to partial rerouting. By doing this no channel is used on the ISDN interface for such a call (instead of 2) and the original calling party number is sent to the final destination by the ISDN network. Rerouting is supported only for CFU and CFB, not for CFNR.

:If your Provider does not support (partial) rerouting and you nevertheless configure ''Reroute supported'', the call forward will fail with a cause code ''Recovery on timer expiry.''

;Set Calling=Diverting No: Concerns calls that arrive on the PBX via the Trunk Line PBX object and are then forwarded by CFU, CFB or CFNR again to the Trunk Line object. For example: Subscriber A calls subscriber B. Subscriber B forwards the call from subscriber A to subscriber C.<br>The CGPN (Calling Party Number) remains unchanged for a call diversion. Merely the DGPN (Diverting Party Number) is also sent as information, so that both call numbers are visible at the diversion destination (subscriber C). For an external call diversion to the PSTN, it may not be permitted to use an external CGPN (subscriber A), however. Therefore, the CGPN must be replaced by an associated call number, in this case the DGPN (subscriber B). If this check box is not enabled, the local telephone office, in such as case, will automatically replace the CGPN through "screening".<br>If you enable this check box, the diversion call is signalled as a normal outgoing call. The CGPN is then a number that belongs to the connection (subscriber B).

; Set Diverting=Calling No: For calls from the PBX to the trunk, the ''calling party number'' (CGPN) is set as ''diverting number'' (DGPN) (a.k.a. ''leg2 info'') if there is none yet in the call. If set, the party the call needs to be billed to is always included in the DGPN thus

;Discard received diverting No: If set, received diverting info within calls from the trunk are discarded

;Outgoing Calls restricted: If this checkmark is set all calls sent out on the Trunk object are sent with CLIR (Calling Line Identification Restricted).

;Automatic Hangup: If this checkmark is set calls, which were already connected and then disconnected by remote party, are automatically released (hung up) two seconds after the disconnect, even if in-band info was indicated with the disconnect. This is useful when providers indicate but do not provide in-band info, or in general, because most providers only provide a busy tone in this situation and no announcement, so 2s are more then enough.

;Outgoing Calls CGPN: If a number is configured here all calls sent out to the Trunk object are sent with this number as Calling extension. For example the number of the switchboard can be configured here so that callbacks are not sent to the original caller but to the switchboard.

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Outgoing No Name: If this checkmark is set no calling name nor calling name display information is sent with outgoing calls

;No Presence/Dialog Subscribe: If checked, no presence or dialog subscriptions are forward out through this Trunk line object.

;No Call Completion: Prohibit call completion to this trunk. Some SIP providers create media calls on call completion tries, which results in phones ringing unexpectedly.

;Fake Connect on inc. Call: If this checkmark is set an incoming call is connected (send out a fake connect message) as soon as inband info is available from the destination of the call even if the destination did not connect the call already. This is especially useful for call forward out to a public network, so that the caller can hear the real inband info from the public network. Also timeouts can be avoided in such a case for the incoming call if the call is forwarded to a destination with slow alert or connect (e.g. GSM). Since v10 if there is no in-band info, now an alert is sent on this call in this case.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Course13:IT_Advanced_-_07_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

;Name as Number: This option allows to send a Name of a PBX object as calling number for outgoing calls. The source name of the call is compared to the first field. If the name starts with the configured string, any digit in the remaining name is sent as calling line id. The second field may contain a number which is added as prefix to the calling line id. For incoming calls the called number is matched to the second field and in case of a match a name is called composed of the first field and any additional dialed digits. This way the same number can be used to call an endpoint as is displayed as calling line id.

:If the configured name starts with '?' for a match the "External" field configured at a user is used.

:This works only for users replicated to this PBX.

== Devices ==

The device configuration is used as always to allow the registrations of devices. In case of a trunk object this is typically a gateway or SBC.

The name of the device serves one special purpose, if the name starts with '#'. In this case, if a call is sent out to the trunk and the calling party number of this calls matches the digits following the '#', not just the next gateway is used, but instead the registration with the matching name is used. Incoming calls on such a registration are sent to the number following the '#'. This way multiple registrations to SIP providers can be mapped to internal numbers for incoming and outgoing calls.

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Trunk Line object, Gateways registered to the same devices Hardware Id are used in round-robin. If the Gateways register to different devices Hardware Id, they are used in the sequence of the configured devices Hardware Ids.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Trunk object are diverted.
;CFB: A CFB is executed if a call is rejected with User Busy by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (no channel, no gateway registered, ...)

== Group Indications ==

The trunk object generates group indications for incoming and outgoing calls including a park position (a number from 0 to n), which is sort of a virtual channel number. Together with Park function keys on the phone this can be used to simulate an oldstyle key system, so that each phone can have Line keys (the Park function key) for each available line (the position). With these Line keys a line can be aquired, monitored, a call can be parked on the line and picked up from the line.

Reference14r1:Concept App Service Messages

2024-02-13T14:54:59Z

Gd: /* Admin UI for access rights */

[[Category:Concept|Connect]]


;Please note the [[#Known issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Known issues of 14r1 final release ==

There are some issues in our 14r1 final release, which we plan to fix during the first service releases. These issues are minor enough, so that we did not think holding up the release was necessary.

=== Admin UI for access rights ===

The styling of the admin UI will be updated, but most important at the moment are the following things an admin should know
* New Zones can only configured as "subzones" to the zones configured by the Apps on the PBX. So if you have configured an app "connect" on the PBX subzones to this zone should be configured in the form of connect?<sub-zone>, e.g. connect?marketing
* For the new sub-zones, the name of the app is case sensitive. So if the name of the app object is connect, a zone Connect?merketing does not work.
* PBX groups can be used to assign access rights to zones. To indicate that a group is a PBX group a prefix of '?' has to be used. So if you have defined a group 'development' in the PBX you have to use the name '?development' in the access rights UI.
* To grant access to a zone to all users, just click on the + to add access rights and then click ok without filling in any information

=== Tooltips ===

Some tooltips are still missing.

=== Channels Unread count ===

* The unread count at channels is sometimes wrong. The count eventually changes to the correct one, when you open the channel.

=== Feed ===

* The header for the date is sometimes duplicated. If the feed is reloaded the display is correct.
* New liked messages show up in noted messages. If the feed is reloaded these messages disappear

=== Stream ===

* Sometime Hashtags are missing from the message, esspecially if entered at the beginning of the text and using suggestions.
* suggestions for hashtags or notifies do not work directly after enter

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2024-02-13T08:37:49Z

Gd: /* Admin UI for access rights */

[[Category:Concept|Connect]]


;Please note the [[#Known issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Known issues of 14r1 final release ==

There are some issues in our 14r1 final release, which we plan to fix during the first service releases. These issues are minor enough, so that we did not think holding up the release was necessary.

=== Admin UI for access rights ===

The styling of the admin UI will be updated, but most important at the moment are the following things an admin should know
* New Zones can only configured as "subzones" to the zones configured by the Apps on the PBX. So if you have configured an app "connect" on the PBX subzones to this zone should be configured in the form of connect?<sub-zone>, e.g. connect?marketing
* PBX groups can be used to assign access rights to zones. To indicate that a group is a PBX group a prefix of '?' has to be used. So if you have defined a group 'development' in the PBX you have to use the name '?development' in the access rights UI.
* To grant access to a zone to all users, just click on the + to add access rights and then click ok without filling in any information

=== Tooltips ===

Some tooltips are still missing.

=== Channels Unread count ===

* The unread count at channels is sometimes wrong. The count eventually changes to the correct one, when you open the channel.

=== Feed ===

* The header for the date is sometimes duplicated. If the feed is reloaded the display is correct.
* New liked messages show up in noted messages. If the feed is reloaded these messages disappear

=== Stream ===

* Sometime Hashtags are missing from the message, esspecially if entered at the beginning of the text and using suggestions.
* suggestions for hashtags or notifies do not work directly after enter

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:PBX/Config/General

2024-02-09T18:08:51Z

Gd:

== 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: 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:Concept App Service Messages

2023-12-13T12:46:13Z

Gd: /* Known issues of 14r1 final release */

[[Category:Concept|Connect]]


;Please note the [[#Known issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Known issues of 14r1 final release ==

There are some issues in our 14r1 final release, which we plan to fix during the first service releases. These issues are minor enough, so that we did not think holding up the release was necessary.

=== Admin UI for access rights ===

The styling of the admin UI will be updated, but most important at the moment are the following things an admin should know
* New Zones can only configured as "subzones" to the zones configured by the Apps on the PBX. So if you have configured an app "connect" on the PBX subzones to this zone should be configured in the form of connect?<sub-zone>, e.g. connect?marketing
* PBX groups can be used to assign access rights to zones. To indicate that a group is a PBX group a prefix of '?' has to be used. So if you have defined a group 'development' in the PBX you have to use the name '?development' in the access rights UI.

=== Tooltips ===

Some tooltips are still missing.

=== Channels Unread count ===

* The unread count at channels is sometimes wrong. The count eventually changes to the correct one, when you open the channel.

=== Feed ===

* The header for the date is sometimes duplicated. If the feed is reloaded the display is correct.
* New liked messages show up in noted messages. If the feed is reloaded these messages disappear

=== Stream ===

* Sometime Hashtags are missing from the message, esspecially if entered at the beginning of the text and using suggestions.
* suggestions for hashtags or notifies do not work directly after enter

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-12-13T12:28:08Z

Gd:

[[Category:Concept|Connect]]


;Please note the [[#Known issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Known issues of 14r1 final release ==

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-12-13T12:26:27Z

Gd: /* Know issues of 14r1 final release */

[[Category:Concept|Connect]]


;Please note the [[#Known Issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Known issues of 14r1 final release ==

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-12-13T12:25:34Z

Gd:

[[Category:Concept|Connect]]


;Please note the [[#Known Issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Know issues of 14r1 final release ==

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-12-13T12:24:48Z

Gd:

[[Category:Concept|Connect]]


;Please note the [[Known Issues of 14r1 final release]]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Know issues of 14r1 final release ==

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-12-13T12:23:16Z

Gd:

[[Category:Concept|Connect]]


;Please note the [Known Issues for 14r1 final release]

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Know issues in 14r1 final release ==

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-12-13T12:22:02Z

Gd:

[[Category:Concept|Connect]]


The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and social tool, which can be used for organization internal communication. The social tool tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zones: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

== Know issues in 14r1 final release ==

== Related Articles ==
[[Howto14r1:Set_up_Connect]]

Reference14r1:Concept App Service Messages

2023-10-20T13:20:41Z

Gd:

[[Category:Concept|Connect]]


This product is currently in Beta. It is not officially released yet.
The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and a micro blogging tool, which can be used for organization internal collaboration. The micro blogging tool uses the following concepts:
;Messages: Text posted by a user into a zone
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Zoness: All messages are posted to a zone. Zones are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of zones is to define a zone for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on a zone or on tags. If no zone is defined , messages with the right tags are filtered from all zones. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Zones ==

Each App within the PBX defines a zone within messages, named as the App Object. This way each App has its private zone within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these zones is defined by the access to the Apps. In addition subzones to these zones may be defined. These subzones can be configured within the Messages App. For each subzone it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purposes. The user can assign tags in the form of hashtags within the message text. Tags are valid accross zoness. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

Reference14r1:Concept App Service Messages

2023-10-17T12:51:33Z

Gd: Created page with "The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and a mico blogging tool, which can be used for organization internal collaboration. The micro blogging tool uses the following concepts: ;Messages: Text posted by a user into a topic ;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion ;Topics: All messages are posted to a topic..."

The App Service Messages provides the persistent storage of Chat messages as available with the premium chat and a mico blogging tool, which can be used for organization internal collaboration. The micro blogging tool uses the following concepts:
;Messages: Text posted by a user into a topic
;Discussions: Replies may be posted to a message. The original message and all replies to it or replies to other replies form a discussion
;Topics: All messages are posted to a topic. Topics are used to define who has access to the messages/posts and provide some structuring for the messages. A typical use of topics is to define a topic for a department or a project.
;Tags: Tags can be attached to Messages in the form of hashtags within the text. Tags can be used to define channels
;Likes: A message post can be marked as liked by a user
;Notifys: A user maybe notified with a posted message, by adding @<user> to the text
;Channels: Are used as discussion rooms for a given subject. A channel filters messages based on topic or tags. If no topic is defined , messages with the right tags are filtered from all topics. Multiple tags may be defined. Messages have to contain all the defined tags. If messages are posted within a channel all the tags are attached automticalls to assign the message to the channel.
;Message Stream: The message stream displays the messages of the currently selected channel
;Feed: The message feed displays the likes and notifys for the user
;Unread Indication: A message which is not yet read is marked as unread. A message can be indicated as read by a single click on the text. The same message may appear in different channels and the feed. If marked as read in one context, it is displayed as read everywhere.
;Follow: Following a user or a channel can be set. A message which from a channel/user which is followed shows up in the feed

Messages can be used by other Apps as a platform. It provides an Api to post messages and also allows the integration of a Messages window into an App.

== Apps ==

The App Service Messages provides Apps, which can be used by App Objects of the PBX.

=== innovaphone-connect ===

This App is the micro blogging user Interface

== Topics ==

Each App within the PBX defines a topic within messages, named as the App Object. This way each App has its private topic within Messages, so that a channels maybe defined esspecially for messages from this App. The access to these topics is defined by the access to the Apps. In addition subtopics to these topics may be defined. These subtopics can be configured within the Messages App. For each subtopic it can be defined seperatly which users or groups of users have access. The groups defined in the PBX are used for this purpose.

== Tags ==

Tags can be attached to messages for search and filter purpioses. The user can assign tags in the form of hashtags within the message text. Tags are valid accross topics. There are mechanisms to filter messages based on tags

== Notifications ==

For a message user notifications may be set. These notifications are used to display these messages in the notifications area of the messages UI and E-Mail notifications are created for the notifications. The can add notifications within the message text with an @<user-id> notation.

== Likes ==

User can add likes to messages. The likes are displayed in the notification area of the UI

== E-Mail Notifications ==

An email connector can be configured within the messages app, which is used to send emails to notify a user of a new message. There are several conditions under which a notification is sent:
;Notify: If a user is notified within the message with @<user> an email notification is sent as well
;Reply: A message posted as reply to a message from the user results in a email notification. This happens for any posts to a discussion, the user has posted to regardless if the reply was to a message of the user directly or any other message of the discussion

== Full text search ==

For all words in the message bodies an index is built, so that words or sequences of words may be found efficiently.

For a search for multiple words two modes are implemented. If the search entry is set in quotes, the exact sequence of the word must appear in the message for a message otherwise just all the words must be present.

== Connect App UI concepts ==

The Connect UI consists of two major parts. On the left side there is the main navigation, which covers the search, channel selection and the feed. On the right is the stream. The stream can either show the content of a channel, or a single discussion, entered from the search or the feed.

=== The Stream ===

The middle part of the UI is the main message stream. It displays the messages from the selected channel or from a specific discussion. It is used to post messages. When messages are posted tags are assigned automatically so that the message fits to the selected channel or the message is added to the selected discussion. Unread messages are marked. A click from the user is needed to mark a message as read. A message marked as read in the context of one channel it appears as read in all matching channels.

The display of messages is organized in discussions. Initially only the first message of a discussion is displayed. By click on the respective control, the discussion is expanded, so that all messages of the discussion are displayed.

Messages within a discussion are always displayed in their chronological order.

Messages can be posted as response to other messages. When a response is posted it is always displayed at the end of the discussion, even if it was a response to an early message of the discussion. To identfy to which message the response was posted a control is provided at a displayed message to hide all messages of the discussion except the messages to which this message was a response.

Reference14r1:Concept Apps

2023-09-14T15:46:45Z

Gd: /* App Objects Parameters */

[[Category:Concept|Apps]]

The innovaphone PBX allows the integration of Apps into the innovaphone myApps client. An App consists of an App Service from which the App is loaded and executed in the innovaphone myApps client as a Web application inside an iframe. The App Service may be the PBX itself, an AppService running on an innovaphone App Platform, or any other webserver.

The PBX controls which user may use which App. This is the main mechanism for assigning rights to users.

So called App Objects are used in the PBX include Apps into the PBX. The main configuration items in an App Object are the link to an App Service and the password, which acts as a shared secret between the PBX and the App Service, so that the PBX can authenticate the user for the App Service.

There is the generic App Object, which can be used for any App without special integration into the PBX. Some services of the PBX use external App Services (e.g. Push). For these services, some special App Objects are available.

== Applies To ==

* innovaphone PBX from version 13r1

== App Objects Parameters ==

App Objects use a common set of parameters to link an App into the PBX. Not all App Objects use all these parameters

;Description, Long Name, Name: Same meaning as for all objects

;Password: This is the shared secret between the PBX and the App Service. It allows the PBX to authenticate users for the App Service. If an App Service provides a PBX Manager Plugin for configuration, this password is typically set by the Plugin as a random string. Manual configuration of ths password should only done, if there is no other way.

;URL: The link to the App Service. This should be configured without filename extension. A postfix of .htm is added to the URL to load the App code as Web application. A postfix of .png is added to load the icon to be displayed in myApps. A size of 100px x 100px is recommended for the icon to have a nice display on 4K monitors.

;Icon URL: Optional link to an App Icon. If not configured the App URL is used for the Icon as well, by just loading a .png file with the same name as the .htm for the App code.

;Modes: A comma seperated list of Modes can be configured here. The modes can be used App specific to switch on different modes for functionality which only should be available for some users. Different rights levels can be implemented with this. For each mode configured here an entry shows up in the Apps section in the form of <app>~<mode>. By checking such an entry the user has access to this mode. (To App developers: If there are multiple modes checked, all these modes are added to the appobj property, seperated by ~, for example myapp~admin~debug).

;Licenses: If the App uses Service Licenses, the number of licenses to be used by this service can be configured here. The PBX then tries to acquire licenses of the type '''Service(<''name of the App''>)'''

;Plain website: Indicates that this App service is a website, which does not make use of the authentication provided by the PBX. No App icon can be displayed for this kind of Apps.

;Hidden: Apps marked as hidden are not displayed in the myApps client. This kind of Apps is used to provide APIs for other Apps and are loaded automatically when the API is used.

;Websocket: If set, the App Object establishes a Websocket connection to the App Service. This way the App Service itself can make use of APIs provided by the PBX.

For each API an App Services wants to use the correspondig flag must be set in the App object to grant access to the API. The available APIs are

;PbxSignal: Allows to register an endpoint using the innovaphone Json signaling protocol. Apps like Softphones can use this API
;EpSignal: Allows an App to insert itself into the signaling path to a registered endpoint. Apps, which control registered phones and may want to add additional media for calls of endpoints can use this API
;Messages: Access to saved chat messages
;TableUsers: This API publishes the table "users". This can be used to replicate the PBX users
;Admin: Create/Update/Delete Users and other PBX config itemss
;PbxApi: User level access to the PBX, with functions like presence monitoring
;Services: API which is used to get access to APIs provided by other App Services
;RCC: Remote Call Control. The functionality including message names and parameters is based on the SOAP API

== Objects ==

There are different objects, which are used as App Objects. A generic one and some for special purposes.

=== App ===

The App object is the generic mechanism to include an App in innovaphone myApps.

=== AP ===

An App object, which is used to load the hidden App from a App Platform Manager, which provides the APIs which are needed to configure an AP and load PBX Manager Plugins from the AP

=== Push ===

An special App object, which connects to a push service. The PBX uses this to deliver push notifications to smartphones. Any user, which wants to make use of the Push service, needs to have the push object configured as push property.

=== Voicemail ===

Executes voicemail scripts and loads the visual voicemail App from a voicemail App Service

=== Fax ===

Does the call signaling to FAX interfaces and load the Fax App from a fax App Service

== PBX Manager Plugins ==

If an app plugin creates the first object or, if only one exists and it is edited, the plugin creates a new password and sets it both in this object and in the app instance. If further objects are created or edited, it is checked if another object with valid login information exists, and if so, this password is used. If not, a new password is created and configured in both sides; in this case the other existing objects aren't changed and must be saved again to set the same password.

=== App Platforms ===

The App Platforms plugin creates the AP object for a foreign AP, which may offer cloud services (e.g. the Push service from innovaphone). It generates an account on the App Platform with a random password and configures the AP object for this account.

The account must be confirmed with a link sent by email. With the email verification it is possible to reconnect to an existing account, even if the password got lost and the account cannot be used by anyone not having access to this email address

=== Contacts ===

You can configure an LDAP login inside the PBX Manager Plugin of the Contacts App.

Reference14r1:PBX/Objects/App

2023-09-14T15:38:40Z

Reference14r1:Concept Apps

2023-09-14T15:37:56Z

[[Category:Concept|Apps]]

The innovaphone PBX allows the integration of Apps into the innovaphone myApps client. An App consists of an App Service from which the App is loaded and executed in the innovaphone myApps client as a Web application inside an iframe. The App Service may be the PBX itself, an AppService running on an innovaphone App Platform, or any other webserver.

The PBX controls which user may use which App. This is the main mechanism for assigning rights to users.

So called App Objects are used in the PBX include Apps into the PBX. The main configuration items in an App Object are the link to an App Service and the password, which acts as a shared secret between the PBX and the App Service, so that the PBX can authenticate the user for the App Service.

There is the generic App Object, which can be used for any App without special integration into the PBX. Some services of the PBX use external App Services (e.g. Push). For these services, some special App Objects are available.

== Applies To ==

* innovaphone PBX from version 13r1

== App Objects Parameters ==

App Objects use a common set of parameters to link an App into the PBX. Not all App Objects use all these parameters

;Description, Long Name, Name: Same meaning as for all objects

;Password: This is the shared secret between the PBX and the App Service. It allows the PBX to authenticate users for the App Service. If an App Service provides a PBX Manager Plugin for configuration, this password is typically set by the Plugin as a random string. Manual configuration of ths password should only done, if there is no other way.

;URL: The link to the App Service. This should be configured without filename extension. A postfix of .htm is added to the URL to load the App code as Web application. A postfix of .png is added to load the icon to be displayed in myApps. A size of 100px x 100px is recommended for the icon to have a nice display on 4K monitors.

;Licenses: If the App uses Service Licenses, the number of licenses to be used by this service can be configured here. The PBX then tries to acquire licenses of the type '''Service(<''name of the App''>)'''

;Plain website: Indicates that this App service is a website, which does not make use of the authentication provided by the PBX. No App icon can be displayed for this kind of Apps.

;Hidden: Apps marked as hidden are not displayed in the myApps client. This kind of Apps is used to provide APIs for other Apps and are loaded automatically when the API is used.

;Websocket: If set, the App Object establishes a Websocket connection to the App Service. This way the App Service itself can make use of APIs provided by the PBX.

For each API an App Services wants to use the correspondig flag must be set in the App object to grant access to the API. The available APIs are

;PbxSignal: Allows to register an endpoint using the innovaphone Json signaling protocol. Apps like Softphones can use this API
;EpSignal: Allows an App to insert itself into the signaling path to a registered endpoint. Apps, which control registered phones and may want to add additional media for calls of endpoints can use this API
;Messages: Access to saved chat messages
;TableUsers: This API publishes the table "users". This can be used to replicate the PBX users
;Admin: Create/Update/Delete Users and other PBX config itemss
;PbxApi: User level access to the PBX, with functions like presence monitoring
;Services: API which is used to get access to APIs provided by other App Services
;RCC: Remote Call Control. The functionality including message names and parameters is based on the SOAP API

== Objects ==

There are different objects, which are used as App Objects. A generic one and some for special purposes.

=== App ===

The App object is the generic mechanism to include an App in innovaphone myApps.

=== AP ===

An App object, which is used to load the hidden App from a App Platform Manager, which provides the APIs which are needed to configure an AP and load PBX Manager Plugins from the AP

=== Push ===

An special App object, which connects to a push service. The PBX uses this to deliver push notifications to smartphones. Any user, which wants to make use of the Push service, needs to have the push object configured as push property.

=== Voicemail ===

Executes voicemail scripts and loads the visual voicemail App from a voicemail App Service

=== Fax ===

Does the call signaling to FAX interfaces and load the Fax App from a fax App Service

== PBX Manager Plugins ==

If an app plugin creates the first object or, if only one exists and it is edited, the plugin creates a new password and sets it both in this object and in the app instance. If further objects are created or edited, it is checked if another object with valid login information exists, and if so, this password is used. If not, a new password is created and configured in both sides; in this case the other existing objects aren't changed and must be saved again to set the same password.

=== App Platforms ===

The App Platforms plugin creates the AP object for a foreign AP, which may offer cloud services (e.g. the Push service from innovaphone). It generates an account on the App Platform with a random password and configures the AP object for this account.

The account must be confirmed with a link sent by email. With the email verification it is possible to reconnect to an existing account, even if the password got lost and the account cannot be used by anyone not having access to this email address

=== Contacts ===

You can configure an LDAP login inside the PBX Manager Plugin of the Contacts App.

Reference13r3:IP4/NAT/General

2023-05-31T11:15:46Z

Gd: /* STUN/TURN server */

__NOTOC__
If the device is used as a router, it is able to connect IP terminals from the network with a non-public address to the public Internet. For this, '''NAT''' (Network Address Translation) is necessary. Additional configuration is required on the different IP interfaces (e.g. ETH, PPP, etc.) to define on which interfaces the public and on which interfaces the private network is accessed.

;Enable NAT: If this checkmark is set, NAT is enabled. Without this checkmark being set all other NAT settings are without effect.

;Default forward destination: If all incoming data packets from the public network are to be forwarded to a particular private IP address, the destination IP address must be entered here.

;Disable DNS Forwarding: No DNS requests are answered by this host, if this option is enabled.

===Add new map===
;Port-specific forwarding: To be able to address several internal destinations, different port numbers are assigned to IP addresses of the internal network here.

===STUN/TURN server===
;Enable STUN: If this checkmark is set, a STUN server is started on the box. The STUN server works like a regular STUN server from external. From internal binding requests create a NAT mapping and the binding response contains the public address of the mapping.

;Non standard port: The port that shall be used for the STUN server. If empty the well known port 3478 is used.

;STUN Changed Address: If the ''Enable STUN'' checkmark is ticked, an IP address:port must be configured, which will be used as source address for replies, when the client is asking for a ''changed address''. This is used for the classic STUN NAT detection mechanism. Basically any address/port can be used here. It could be that a IP provider does not forward packets with a wrong address, so it is safer to use an address, which is valid in the network of the device. It is also better to use an address, which is not used for something else, because it could be that the local router uses these packets to update its ARP table. You can use 3480 as port. Note that NAT detection will not work properly if no ''STUN Changed Address'' is configured

;TURN: Up to four TURN accounts can be configured. If a TURN account is configured a TURN server is enabled for this account.

;TURN Public Address: A TURN server can be operated in a private network behind a firewall. In this case port forwarding must be configured on the firewall for the complete RTP port range to the TURN server. On the TURN server the used public address of the firewall has to be configured, so that this can be provided to the remote RTP peer to send the RTP data to.

;Cluster: TURN servers can be operated in a cluster behind a single firewall. Each TURN server within the cluster should be asigned a seperate RTP port range. On the firewall port forwarding to the different TURN servers has to be forwarded for the RTP port ranges. To distribute the incoming requests standard TCP or UDP load balancing to the different TURN servers has to be configured.
:If in this setup the other RTP peer use the same TURN cluster, the RTP is forwarded between the two session using the public firewall address, this requires the firewall to support hairpinning. To avoid this, on each TURN server all the TURN servers of the cluster can be configured, with their RTP port ranges (first, last) and their local (internal) addresses. If the RTP peer is identified as belonging to the same cluster, the local address is then used for the RTP.

== Known Issues ==

Note: In v12r1 and higher version it's no longer necessary to enable NAT for the STUN/TURN services be enabled. If NAT is disabled make sure the UDP-NAT port range values are also deleted / not set.

==Related Articles==

* [[Howto:How to configure NAT in V6]]
* [[Howto:Avoid DNS Amplification Attacks]]

Reference13r3:IP4/NAT/General

2023-05-31T10:40:30Z

Gd: /* STUN/TURN server */

__NOTOC__
If the device is used as a router, it is able to connect IP terminals from the network with a non-public address to the public Internet. For this, '''NAT''' (Network Address Translation) is necessary. Additional configuration is required on the different IP interfaces (e.g. ETH, PPP, etc.) to define on which interfaces the public and on which interfaces the private network is accessed.

;Enable NAT: If this checkmark is set, NAT is enabled. Without this checkmark being set all other NAT settings are without effect.

;Default forward destination: If all incoming data packets from the public network are to be forwarded to a particular private IP address, the destination IP address must be entered here.

;Disable DNS Forwarding: No DNS requests are answered by this host, if this option is enabled.

===Add new map===
;Port-specific forwarding: To be able to address several internal destinations, different port numbers are assigned to IP addresses of the internal network here.

===STUN/TURN server===
;Enable STUN: If this checkmark is set, a STUN server is started on the box. The STUN server works like a regular STUN server from external. From internal binding requests create a NAT mapping and the binding response contains the public address of the mapping.

;Non standard port: The port that shall be used for the STUN server. If empty the well known port 3478 is used.

;STUN Changed Address: If the ''Enable STUN'' checkmark is ticked, an IP address:port must be configured, which will be used as source address for replies, when the client is asking for a ''changed address''. This is used for the classic STUN NAT detection mechanism. Basically any address/port can be used here. It could be that a IP provider does not forward packets with a wrong address, so it is safer to use an address, which is valid in the network of the device. It is also better to use an address, which is not used for something else, because it could be that the local router uses these packets to update its ARP table. You can use 3480 as port. Note that NAT detection will not work properly if no ''STUN Changed Address'' is configured

;TURN: Up to four TURN accounts can be configured. If a TURN account is configured a TURN server is enabled for this account.

;TURN Public Addres: A TURN server can be operated in a private network behind a firewall. In this case port forwarding must be configured on the firewall for the complete RTP port range to the TURN server. On the TURN server the used public address of the firewall has to be configured, so that this can be provided to the remote RTP peer to send the RTP data to.

;Cluster: TURN servers can be operated in a cluster behind a single firewall. Each TURN server within the cluster should be asigned a seperate RTP port range. On the firewall port forwarding to the different TURN servers has to be forwarded for the RTP port ranges. To distribute the incoming requests standard TCP or UDP load balancing to the different TURN servers has to be configured.
:If in this setup the other RTP peer use the same TURN cluster, the RTP is forwarded between the two session using the public firewall address, this requires the firewall to support hairpinning. To avoid this, on each TURN server all the TURN servers of the cluster can be configured, with their RTP port ranges (first, last) and their local (internal) addresses. If the RTP peer is identified as belonging to the same cluster, the local address is then used for the RTP.

== Known Issues ==

Note: In v12r1 and higher version it's no longer necessary to enable NAT for the STUN/TURN services be enabled. If NAT is disabled make sure the UDP-NAT port range values are also deleted / not set.

==Related Articles==

* [[Howto:How to configure NAT in V6]]
* [[Howto:Avoid DNS Amplification Attacks]]

Reference13r3:IP4/NAT/General

2023-05-31T10:36:49Z

Gd: /* STUN/TURN server */

__NOTOC__
If the device is used as a router, it is able to connect IP terminals from the network with a non-public address to the public Internet. For this, '''NAT''' (Network Address Translation) is necessary. Additional configuration is required on the different IP interfaces (e.g. ETH, PPP, etc.) to define on which interfaces the public and on which interfaces the private network is accessed.

;Enable NAT: If this checkmark is set, NAT is enabled. Without this checkmark being set all other NAT settings are without effect.

;Default forward destination: If all incoming data packets from the public network are to be forwarded to a particular private IP address, the destination IP address must be entered here.

;Disable DNS Forwarding: No DNS requests are answered by this host, if this option is enabled.

===Add new map===
;Port-specific forwarding: To be able to address several internal destinations, different port numbers are assigned to IP addresses of the internal network here.

===STUN/TURN server===
;Enable STUN: If this checkmark is set, a STUN server is started on the box. The STUN server works like a regular STUN server from external. From internal binding requests create a NAT mapping and the binding response contains the public address of the mapping.
;Non standard port: The port that shall be used for the STUN server. If empty the well known port 3478 is used.
;STUN Changed Address: If the ''Enable STUN'' checkmark is ticked, an IP address:port must be configured, which will be used as source address for replies, when the client is asking for a ''changed address''. This is used for the classic STUN NAT detection mechanism. Basically any address/port can be used here. It could be that a IP provider does not forward packets with a wrong address, so it is safer to use an address, which is valid in the network of the device. It is also better to use an address, which is not used for something else, because it could be that the local router uses these packets to update its ARP table. You can use 3480 as port. Note that NAT detection will not work properly if no ''STUN Changed Address'' is configured
;TURN: Up to four TURN accounts can be configured. If a TURN account is configured a TURN server is enabled for this account.

;Cluster: TURN servers can be operated in a cluster behind a single firewall. Each TURN server within the cluster should be asigned a seperate RTP port range. On the firewall port forwarding to the different TURN servers has to be forwarded for the RTP port ranges. To distribute the incoming requests standard TCP or UDP load balancing to the different TURN servers has to be configured.
:If in this setup the other RTP peer use the same TURN cluster, the RTP is forwarded between the two session using the public firewall address, this requires the firewall to support hairpinning. To avoid this, on each TURN server all the TURN servers of the cluster can be configured, with their RTP port ranges (first, last) and their local (internal) addresses. If the RTP peer is identified as belonging to the same cluster, the local address is then used for the RTP.

== Known Issues ==

Note: In v12r1 and higher version it's no longer necessary to enable NAT for the STUN/TURN services be enabled. If NAT is disabled make sure the UDP-NAT port range values are also deleted / not set.

==Related Articles==

* [[Howto:How to configure NAT in V6]]
* [[Howto:Avoid DNS Amplification Attacks]]

Reference13r2:Apps/PbxManager/Templates

2022-11-08T08:59:28Z

Gd: /* Phone settings */

This PBX Manager Plugin allows to configure Config Templates

== Inheritance ==

Allows to configure up to four other templates, from which this template inherits the settings

== Settings ==

Some general user settings can be configured here

;Filter, Diversion Filter: Reference to filters which restrict the numbers which may be called or to which diversions may be set or executed

== Apps ==

Apps which shall be available to the user can be configured

== Licenses ==

Licenses assigned to the user can be configured here. If nothing is set for a given license it may be inherited from other templates. With '+' the license is set, with '-' the license is removed

== Function Keys ==

Some selected functions keys may be configured for the desk phones. The complete set of function keys is availabe thru the advanced admin UI.

== Phone settings ==

Some general settings of innovaphone desk phones can be configured here. For all settings the advanced admin UI hast to be used.

Reference13r2:Apps/PbxManager/Templates

2022-11-08T08:58:30Z

Gd: /* Function Keys */

Reference13r2:Apps/PbxManager/Templates

2022-11-08T08:57:22Z

Gd: /* Licenses */

Reference13r2:Apps/PbxManager/Templates

2022-11-08T08:54:15Z

Gd: /* Apps */

Reference13r2:Apps/PbxManager/Templates

2022-11-08T08:53:30Z

Gd: /* Settings */

Reference13r2:Apps/PbxManager/Templates

2022-11-07T17:16:33Z

Gd: