Reference:Administration/PBX/Objects

From innovaphone wiki
Revision as of 16:46, 21 March 2007 by Gpa (talk | contribs) (PBX_Objects added)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
There are also other versions of this article available: Reference (this version) | Reference7 | Reference8 | Reference9 | Reference10 | Reference11r1 | Reference11r2 | Reference12r1 | Reference12r2 | Reference13r1 | Reference13r2 | Reference13r3

All objects configured on the PBX are listed here. It is possible to display individual, several or all objects. To display one or more objects, you must enter the object’s name (Long Name) or first letter in the field, and then click show. Clicking show without entering a character string or letter displays all created objects.

The display of the PBX objects is organised in columns. For a more detailed description of the individual columns, please refer to the description of the standard entry fields further down in the text.

  • Long Name: The long name of the object.
  • Name: The name of the object.
  • No: The call number of the object.
  • Node: The node that the object is assigned to.
  • PBX: The PBX that an object is assigned to.
  • Filter: Display of the filters that were created for the relevant object. See chapter entitled “Administration/PBX/Filter”.
  • Groups: Display of the group(s) that the object belongs to. Clicking the link + or an existing group name opens a popup page, on which new groups can be defined and edited.
    Groups can be configured as static, dynamic-in or dynamic-out. For members of static groups, calls are always signalled. It works differently for members of dynamic groups, which register with or unregister from a group dynamically using a function key (Join Group). The difference between dynamic-in and dynamic-out lies in whether the object is to be contained in the relevant group as standard (in) or not (out).
    The active check box determines whether the group is enabled for the relevant object.
  • CF*: Display of the call forwarding(s) defined for the object. Clicking the link + or the name of an existing call forwarding opens a popup page, on which new call forwardings can be defined and edited. On this popup page, you can use the Type list box to select a call forwarding type (Call Forwarding Unconditional, Call Forwarding Busy and Call Forwarding No Response).
    A call forwarding can be made dependent on a Boolean object. This can be inverted with the Not button.
    With the Only and Only not filters, you can define additional exceptions, so that particular subscribers are excluded from the forwarding (Only not) or the forwarding is to apply only to a particular subscriber (Only).
  • Type: Display of the object type. Possible entries: bool, broadcast, dect, dtmf-ctrl, executive, gateway, multicast, mwi, map, loc, trunk, vm and waiting. If the object has already registered, then this is indicated through specification of the IP address, with which the object has registered. The registrations marked with a "*" use a password.


To add a new object, you must select the relevant object and then click the new link beside the PBX objects list box. Depending on which object was selected in the list box, the page setup of the subsequent popup changes. This popup page contains standard entry fields, some of which occur in all objects.

These fields are:

  • Long Name: The long name of the object. This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system.
  • Name: The name of the object. This name is used for signalling (like a call number) and must be unique throughout the system.
  • Number: The call number of the object. The call number must always be unique in relation to a node.
  • Hardware ID: The hardware ID of the terminal that is to register with this object.
  • Node: The node that the object is assigned to. The node determines the unique call number with which an object can be accessed throughout the system.
    Objects located in the root node can be accessed without a location prefix; otherwise, the location prefix always has to be dialled as well. If you enable the Local check box, then, despite a different location prefix, it is no longer necessary to use it.
    This list box is displayed only in connection with the PBX object of the PBX type.
  • PBX: The PBX or location that the object is assigned to. This PBX accepts registrations for the object.
    This list box is displayed only in connection with the PBX object of the PBX type.
  • Local: The effect of the Local flag is that objects of different nodes can be registered and called without a location prefix.
    This check box is displayed only in connection with the PBX object of the PBX type.
  • Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail.
  • Filter: For most PBX objects, you can allocate a specific filter (see chapter entitled "Administration/PBX/Filter").
  • Diversion Filter: A filter can also be selected for call forwarding should this take place (see chapter entitled "Administration/PBX/Filter").
  • CFNR Timeout: The time set here (in seconds) is the interval that elapses before a user’s call forwarding is initialised.
  • Busy on n Call(s): Maximum number of calls made simultaneously. If, for example, the numeric value two is entered, then busy is signalled to the third and all further incoming calls. Just as only two calls can be set up parallel.
  • Group Indications: If call groups have already been created, you can select them here and add them to new objects.


The object-specific entry fields are displayed accordingly as an extended section.
Below is an overview of all possible objects in the innovaphone PBX:


User Object:

With the User PBX object, you define the standard subscribers of the innovaphone PBX.

The following details are entered in the DECT section and are therefore only relevant for DECT handset registrations:

  • Gateway: The system name (Name) of the IP DECT device.
  • Display: A variable text that is output on the IP DECT handset display.
  • IPEI: The serial number of the IP DECT handset. Is required for unique registration of an IP DECT handset.
  • AC (Access Code): It is also possible to allocate an access code (a kind of PIN), which protects the IP DECT handset against unauthorised use.


Boolean Object:

The Boolean PBX object is used to define time-dependent true or false states in the innovaphone PBX, and can be used for call forwarding or filters.

For example, the Boolean object Working hours (Mo-Fr 08:00-18:00 hrs) can be defined, which in the true state (that is, during office hours) is set to true and outside office hours is set to false. This would enable a filter to be defined that allows calls during office hours only.

In the same way, this Boolean object can be used for call forwarding. In the true state (true), it would allow call forwarding to a particular subscriber during office hours, in the false state (false) outside office hours. The current state can be switched using manual override.

The following specifications are made in the Boolean section.

Announcement (URL)

  • TRUE: The path of the audio file to be played in the true state (true).
  • FALSE: The path of the audio file to be played in the false state (false). This specification only makes sense if a call is received directly on this object.

Announcement (URL) if manual override is active (optional)

  • TRUE: The path of the audio file to be played in the event of a manual override in the true state (true).
  • FALSE: The path of the audio file to be played in the event of a manual override in the false state (false). This specification only makes sense if a call is received directly on this object.


  • External Name/No: It is possible to forward a call directly to a subscriber or call number, without playing the audio file first.
  • Manual Override: The Manual Override list box allows you to change the current state. A manual override (MO) can also be set using DTMF. For this, the call number of the Boolean object, followed directly by the relevant DTMF code simply have to be dialled. The following DTMF codes are possible:
    <Boolean object call number>01 - MO default state
    <Boolean object call number>11 - MO true state
    <Boolean object call number>10 - MO false state
    For example, the Boolean object Working hours with the call number 50 in the true state would be transferred to the false state with the code 5011. It works exactly the same the other way round. If the Boolean object Working hours is in the false state, then it is transferred back to the true state with the code 5011. Note that the manual override should always be viewed in relation to the initial state.
  • Weekday + Time Specification: Here, you specify the time condition for the decision true (true) or (false).
 Note
 The current state of the Boolean object is visible in the Boolean section under chapter "Administration/PBX/Filter".


Call Broadcast Object:

With the Call Broadcast PBX object, it is to possible to distribute all calls arriving on this object to all member of a group that this Call Broadcast object belongs to. Here, it is possible to allocate a call number to this object, enabling in turn a call diversion, if say the subscribers of the Broadcast group are busy or cannot be reached.

The following specifications are made in the Broadcast section:

  • Execute Group Member Diversions: In the case of a call to a subscriber of a Broadcast group with enabled call forwarding, no call forwarding is evaluated as standard. With a checked check box, the call forwarding of the subscriber is evaluated in the case of a call to the Broadcast group.
  • Round Robin Timeout (s): With the Round Robin Timer (RRT), an algorithm can be enabled which, after the specified interval has elapsed, signals incoming calls to the next subscriber of the Call Broadcast group.
    A case example would be the support department of a company created as the Call Broadcast object. Several support staff belong to this object. By specifying the RRT, call distribution to the support staff can be automated. Here, the RRT is so intelligent that it makes a note of the last phoning subscriber and misses this subscriber out in the next signalling.


DECT System Object

To be able to register a DECT system in the innovaphone PBX, a DECT System PBX object is required. All DECT-specific information is stored in this DECT System PBX object. During initial start-up of a DECT system, this object must be created in an existing innovaphone PBX environment.

DTMF Features Object

The DTMF Features PBX object is used to set call diversions via DTMF (Dual Tone Multiple Frequency). For this, a DTMF Features object with a unique name and call number is defined. To set a call diversion, a user needs only to dial this call number, followed by the desired DTMF feature code (for example, *21* for CFU) and the destination number (where the call is to be diverted to) completed by the hash character (#). It works exactly the same when deleting existing call diversions via DTMF. First you dial the call number of the DTMF Features object, followed by the desired DTMF feature code (for example, ##21# for CFU). The destination number does not have to be specified when deleting. The following features codes were implemented for the DTMF Features object :

Set CFU = <DTMF object call number>*21*<Destination number>#
Delete CFU = <DTMF object call number>##21#
Set CFB = <DTMF object call number>*67*<Destination number>#
Delete CFB = <DTMF object call number>##67#
Set CFNR = <DTMF object call number>*61*<Destination number>#
Delete CFNR = <DTMF object call number>##61#.

 Note
 In a later version, the PBX will recognise all GSM feature codes independently, making the DTMF Features object superfluous.


Executive Object:

The Executive PBX object is used to implement the boss/secretary functions. The boss’s telephone registers with this object. Furthermore, two groups can be defined for this object: the primary secretary, which is directly subordinate to the boss, and the secondary secretary, which stands in for the primary secretary.

There is still a third group that can be defined – its members may phone the boss directly without the call being signalled on the phones of the secretaries. All calls to the boss are sent to the primary secretary. If no registration exists for the primary secretary, then the calls are forwarded to the secondary secretary. All calls to the secretary groups are signalled as a diverted call, with the boss displayed as the call diverter.

Every call received by the boss that was previously received by the secretaries is likewise signalled as a diverted call. It is thus possible to adjust the boss’s ring tone, so that it rings differently if the call was initialised by one of the secretaries. If a call is received directly on the boss’s phone, that is, not via the secretaries, it can be signalled with a different ring tone.

The following specifications are made in the EXECUTIVE section:

  • Primary: The Primary secretary group, when added, may be selected here.
  • Secondary: The Secondary secretary group, when added, may be selected here.
  • Direct Call: The Direct Call secretary group, when added, may be selected here.
  • Call Executive: Calls to the secretary’s phone are also signalled on the boss’s phone, if this check box is checked.

If no secretary groups have yet been created for this object, the Primary, Secondary and Direct Call entry fields are empty.


Gateway Object

TheGateway PBX object is used to register a gateway with the PBX. The Gateway PBX object thus provides the direct dialling capability with or without prefix.

  • Enblock Count: Time (in seconds), after which the call set-up begins.
  • Prefix: A prefix can be added.


MCast Announcement Object:

The MCast Announce PBX object allows a call to be put through directly on several telephones. For this, a group must be defined for the MCast Announce object, and all subscribers belonging to this group are addressed. The following specifications are made in the Multicast section:

  • Multicast Address: A multicast IP address must be specified. For IPv4, the multicast address range 224.0.0.0 to 239.255.255.255 applies.
  • Multicast Port: A port must also be specified. It can be any port of your choice.
  • Coder: The coder to be used for multicast calls can be selected here. You can select from the following: G729, G711A, G711u and G723.
  • Packetization (ms): Reduces the protocol overhead, thereby increasing the bandwidth available for voice data. Bear in mind that the overhead grows significantly with reduced packet size, since the per-packet transport overhead (IP protocol in LAN and additionally PPP protocol in WAN) remains the same while the voice data payload becomes less.
  • Call Busy Endpoints: Calls are also signalled on the phones of subscribers who are currently phoning and are therefore busy, if this check box is checked.


Message Waiting Object:

The Message Waiting PBX object was implemented to integrate external applications of other manufacturers (voicemail solutions) in the innovaphone PBX. Since some applications do not support the transmission of so-called MWI messages (LED on/off), the status regarding whether a message for a particular object exists is lost if say an MWI-enabled VoIP telephone is restarted.

The MWI object in the PBX is able to note the status for every object. For this, however, the external application (voicemail) must be prompted to send the current status for the individual user to the innovaphone PBX via H.450.7. The H.323 SETUP message must also be sent the call number of the relevant subscriber, or otherwise the PBX does not know which subscriber the MWI message should be sent to.

The status can also be sent using DTMF. Dazu muss einfach nur die Rufnummer des MWI-Objektes (z.B.: 20) gefolgt des entsprechenden DTMF-Code gewählt werden:

201 - Sends the MWI message, MWI LED on

202 - Sends the MWI message, MWI LED off

Furthermore, in the case of a call to this object, an audio file in the relevant coder format that is stored on a HTTP server can be played or even forwarded to a different subscriber.

The following specifications are made in the MWI section:

  • Announcement URL: The path of the audio file to be played.
  • External Name/No: After the audio file has played, the call can be forwarded to a different subscriber or call number.


Number Map Object:

The Number Map PBX object allows you to store abbreviated dialling numbers in the PBX. For example, you can define the abbreviated dialling number #1 (Number = #1) for the local police station (07031-110). When using several locations, this can have undesired side-effects however, since a subscriber of a different location (B) would always call the police station of the one location (A) with this abbreviated dialling number. Therefore, when defining a Number Map, the IP address range with network mask must always be specified.

The following specifications are made in the MAP section:

  • Address: The IP address range that is authorised to use this Number Map. To allow all subscribers to use this Number Map, you can leave this field empty.
  • Mask: If all subscribers are to be permitted to use this Number Map, you must enter the subnet mask 0.0.0.0; otherwise, you enter the relevant network mask of the authorised IP address range.
  • Dest. No: The destination number with which this Number Map is to be linked.


PBX Object:

If several locations are used, it is essential that a PBX object of the PBX type be created for each one. The name (Name) of this object is also the node description. The call number (Number) represents the prefix of the location. If a PBX object was defined, the menu set-up for the objects is extended through the addition of the Node, PBX and Local entry fields.


Trunk Line Object:

The Trunk Line PBX object represents the trunk line in the innovaphone PBX. To register an ISDN trunk line with the Trunk Line PBX object, an H.323 registration with specification of the gatekeeper ID and call number simply has to be activated on the interface with connected trunk line (see also chapter "Administration/Gateway/Interfaces").

The following specifications are made in the Trunk section:

  • Loopback: If the call number of the exchange was dialled in incoming calls via the exchange, call forwarding can be initiated by specifying a valid H.323 name (Name) or E.164 alias (Number).
  • Incomplete: If an incomplete call number was dialled in incoming calls via the exchange, call forwarding can be initiated by specifying a valid H.323 name (Name) or E.164 alias (Number).
  • Invalid: If an invalid call number was dialled in incoming calls via the exchange, call forwarding can be initiated by specifying a valid H.323 name (Name) or E.164 alias (Number).
  • Busy: If, in incoming calls via the exchange, a call number was dialled that is busy, call forwarding can be initiated by specifying a valid H.323 name (Name) or E.164 alias (Number).
  • No Answer Timeout: If, in incoming calls via the exchange, a call number was dialled and there is no answer, call forwarding can be initiated, after the specified time has elapsed (Timeout), by specifying a valid H.323 name (Name) or E.164 alias (Number).
  • Reroute supported: This check box can be enabled without reservation if the ISDN provider supports this feature. Since an external call diversion uses two B channels (one for the incoming call and one for the outgoing call), they can be saved by enabling this feature. The call is set up directly between the two external subscribers. The “Set Calling = Diverting No.” option therefore becomes superfluous, since in this sense no call diversion actually takes place, but rather the relocation of external incoming calls, which in turn are forwarded to an external subscriber.
  • 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 (Call Forwarding Unconditional, Call Forwarding Busy or Call Forwarding No Response) again via the Trunk Line object. For example: Subscriber A calls subscriber B. Subscriber B forwards the call from subscriber A to subscriber C.
    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 is not 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".
    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).
  • Outgoing Calls restricted: This check box allows you to suppress the display of the outgoing call number in general.
  • Outgoing Calls CGPN: The call number for outgoing calls (Calling Party Number) can be manipulated in general.

Here is an example of how a trunk line can be established or simulated:

  1. First, the Trunk Line PBX object with the E.164 call number 0 and the H.323 name Exchange must be created.
  2. On a free ISDN interface (PPP, TEL, BRI or PRI), you enable the H.323 registration and allocate the name of the of the Trunk Line object (Exchange) or the call number (0), as well as the IP address of the gatekeeper on which the PBX is operated. It is also sufficient to specify the local IP address 127.0.0.1 if the gatekeeper happens to be operated on the same device. The interface must have successfully registered with the PBX object and calls to the Trunk Line PBX object must be possible. A dial tone is played at this point only with a connected ISDN trunk line. Suffix dialling digits are accepted.
  3. To simulate a dial tone for least cost scenarios, for example (see also the chapter entitled "Administration/Gateway/Interface/Virtual Interface (TEST, TONE, HTTP)", a free VoIP interface is required, which likewise registers with the Trunk Line PBX object as the gateway (mode). The gatekeeper address is allocated as described in the previous point. The name (Exchange) or the call number (0) of the Trunk Line PBX object are also allocated in the same way (under Alias List).
  4. Finally, a route from the ISDN interface and from the VoIP interface to the TONE interface must be created, enabling the simulated dial tone to be played. Suffix dialling digits are accepted.


Voicemail Object:

For every PBX user, a personal answerphone can be defined. For this, a global Voicemail PBX object with a unique global call number must be created. A user’s voicemail number is made up of the voicemailbox number allocated here (for example, 66) and the user’s call number (for example, 47). In this case, the user-specific voicemail number would be 6647! Using a telephone’s function keys, the user can set up call forwarding (CFU) to his/her own voicemailbox, for example. It is even possible to program a direct dial (Message Waiting) to the voicemailbox to listen to existing messages. More detailed information on the function keys may be found in the telephone manual.

The following specifications are made in the Voicemail section:

  • Script URL: The path to the voicemail script file (vm.xml), which is located on a HTTP or WebDAV (Web-based Distributed Authoring and Versioning) server. Detailed information on setting up a WebDAV server and the voicemail is contained in the innovaphone knowledgebase under the keyword "WebDAV" or "voicemail".
  • Trace: A checked check box enables the output of trace information in respect of voicemail. See also the chapter entitled "Administration/Diagnostics/Tracing".


Waiting Queue Object:

The Waiting Queue PBX object represents a waiting loop in the innovaphone PBX. When a call is received on this object, an audio file stored on a HTTP server is played back. The following specifications are made in the Queue section:

1st Announcement

  • URL: The path of the audio file to be played. If a second Announcement is defined, this file is played only once. The playing of the audio file is repeated as standard.
    The URL can be specified in the following format:
    http://192.168.0.1/webdav/moh.$coder?coder=g729,g711a&repeat=true
    The specification of the wildcard .$coder?coder=g729,g711a in place of the file extension .g729 enables several formats to be specified. They must be specified separated by a comma and must be available on the Web server. With the addition &repeat=false, an automatic repeat can be disabled.
  • External Name/No: Forwarding to an external user can take place alternatively.


2nd Announcement

  • URL: The path of the second audio file to be played. If a second URL is specified here, then it is played after the first Announcement URL. For the second Announcement, the playing of the audio file is likewise repeated as standard (see 1st Announcement).
  • External Name/No: For the second Announcement, forwarding to an external user can likewise take place.


  • Max Call/Operator (%): By specifying a percentage value, calls that are forwarded to a call number or an operator (additional licences required) can be restricted.
  • Alert: The music on hold or announcement is played after the time interval specified here has elapsed.
  • Round Robin: Timeout before a switchover to the next subscriber.
  • Primary: Time interval for the Primary Group.
  • Primary Group: The Primary Group list box allows you to define which group should be the Primary Group, in so far as at least two groups were created for the Waiting Queue.
    If a Primary Group is specified, the calls are signalled first to the subscribers of the Primary Group, and are also signalled to the subscribers of the other group after the Primary time interval has elapsed.
  • DTMF | Dest. No | Dest. Name: It is also possible to allow call forwarding using touch-tone dialling (DTMF).
    DTMF = The DTMF character string (for example, 1 or *1#).
    Dest. No = The destination number.
    Dest. Name = The destination name.


..go back