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 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.
There are different types of objects for different purposes available
- A normal User
- Used to enable pbx connection to Application Platform
- Create a reference to an innovaphone App that can be used in myApps
- BC Conference
- A Conference which automatically calls other users
- Used to enable Call Forwards an other things based on time/date or by calling to this object
- Call Broadcast
- Forward a call to a group
- Used to create a conference
- Config Template
- Config which can be applied to other objects
- DECT System
- Defines a DECT system
- Directory Search
- LDAP lookup based on number dialed
- DTMF Features
- Feature control for simple endpoints
- Executive in a executive/secretary configuration
- External UC
- To forward presence subscriptions to external presence server
- Defines a fax service
- For registration of gateways
- Integration with ICP system
- MCast Announce
- Calls endpoints and forwards media as IP multicast
- Message Waiting
- Message Waiting for external Systems
- used to connect messaging service
- Mobile Integration
- Numbering Node
- Number Map
- Maps to other number
- To register slave PBX
- Defines a push service
- Quick Dial
- Allows Quickdial based on external LDAP Directory
- Session Border
- Allows proxy registrations to other PBX
- control dynamic group memberships via myPBX client
- Trunk Line
- To register a trunk line
- Defines a voicemail service
- 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.
- 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.
- 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 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 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 email 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
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.
- Combines Fax, Mobility, myPBX and Video licenses
- Voicemail for this user (uses VoicemailUser license)
- Personal Fax with innovaphone Fax
- Mobility integration
- myPBX client
- innovaphone Video as part of the myPBX launcher
- innovaphone Application Sharing
- innovaphone Reporting. The myPBX call lists do not require this license
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.
- 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.
- 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 :
Hardware Id Name App 009033000000 myDeskphoneName phone exampleSoft mySoftphoneName softphone
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
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.