Reference:Administration/PBX/Objects: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
No edit summary
(→‎Object Properties: Diversion Filter meaning extended)
 
(19 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Reference:Administration/PBX/Objects/Executive]]
This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criterias. New objects can be created and existing objects can be changed or deleted.
[[/Executive]]
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.
== 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.


* '''Long Name:''' The long name of the object.
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 subnodes can be displayed by entering the prefix of a node here.
* '''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.<br>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).<br>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).<br>A call forwarding can be made dependent on a Boolean object. This can be inverted with the Not button.<br>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.


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.


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


These fields are:
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.
* '''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.<br>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.<br>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.<br>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.<br>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 "[[PBX_Filter|Administration/PBX/Filter]]").
* '''Diversion Filter:''' A filter can also be selected for call forwarding should this take place (see chapter entitled "[[PBX_Filter|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.


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.


The object-specific entry fields are displayed accordingly as an extended section.<br>Below is an overview of all possible objects in the innovaphone 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.
 
=== 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 Properties ==
 
* Note : never use special character "@" in any Object (Name, Long Name, Display Name), see also [[Support:Using @ in the Objects Names considered harmful in Master Slave Scenarios ]].
 
* Note : also never use special character "/" in any Object (Name, Long Name, Display Name), if you use it you get a problem with the Voicemail Scripts if you use Voicemails.
The Voicemail Script did not find the correct User.
 
Depending on the type of the object different configuration parameters are available. Some configuration parameters are common for all objects.
 
{|
|valign=top nowrap=true|'''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.
|-
|valign=top nowrap=true|'''Name'''
|The name of the object. This name is used for signalling (like a call number) and must be unique throughout the system.
|-
|valign=top nowrap=true|'''Hardware ID'''
|The hardware ID is a name which can be used to register an endpoint to this object. This name is not displayed and cannot be used to call the object. Some endpoints use default names to register based on the MAC address of the endpoint, which can be configured here. This way there is no need to configure any Name/Number on the endpoint itself.
|-
|valign=top nowrap=true|'''Node'''
|The node that the object is assigned to. A Node hierachy 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.
|-
|valign=top nowrap=true|'''PBX'''
|The PBX that the object is assigned to. This PBX accepts registrations for the object.
|-
|valign=top nowrap=true|'''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.
|-
|valign=top nowrap=true|'''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.  Currently works for non-gateway object types only.
|-
|valign=top nowrap=true|'''Password / Retype Password'''
|If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail.
|-
|valign=top nowrap=true|'''Filter'''
|The filter configured here restricts the numbers which may be called by a endpoint registered to this object
|-
|valign=top nowrap=true|'''Diversion Filter'''
|The filter configured here restricts the numbers which calls may be diverted to by a endpoint registered to this object. The Diversion Filter prevents the setting of a Call Forward to specific destination via an IP-Phone or myPBX, but do not prevents the execution of already configured Call Forward.
|-
|valign=top nowrap=true|'''CFNR Timeout'''
|Overides the PBX global CFNR timeout for this object
|-
|valign=top nowrap=true|'''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.
|-
|valign=top nowrap=true|'''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 V6 is set to 32 characters.
|}


== PBX Object Types ==
== PBX Object Types ==
 
* [[/User|User]]
*[[/User|User]]
* [[/Call Broadcast Conference|BC Conference]]
*[[/Boolean|Boolean]]
* [[/Boolean|Boolean]]
*[[/Call_Broadcast|Call Broadcast]]
* [[/Call_Broadcast|Call Broadcast]]
*[[/DECT_System|DECT System]]
* [[/DECT_System|DECT System]]
*[[/DTMF_Features|DTMF Features]]
* [[/DTMF_Features|DTMF Features]]
*[[/Executive|Executive]]
* [[/Executive|Executive]]
*[[/Gateway|Gateway]]
* [[/Gateway|Gateway]]
*[[/MCast_Announce|MCast Announce]]
* [[/MCast_Announce|MCast Announce]]
*[[/Message_Waiting|Message Waiting]]
* [[/Message_Waiting|Message Waiting]]
*[[/Number_Map|Number Map]]
* [[/Number_Map|Number Map]]
*[[/PBX|PBX]]
* [[/Node|Node]]
*[[/Trunk_Line|Trunk Line]]
* [[/Trunk_Line|Trunk Line]]
*[[/Voicemail|Voicemail]]
* [[/Voicemail|Voicemail]]
*[[/Waiting_Queue|Waiting Queue]]
* [[/Waiting_Queue|Waiting Queue]]

Latest revision as of 16:42, 26 September 2013

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criterias. 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 subnodes 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.

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.

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 Properties

* Note : never use special character "@" in any Object (Name, Long Name, Display Name), see also Support:Using @ in the Objects Names considered harmful in Master Slave Scenarios .

* Note : also never use special character "/" in any Object (Name, Long Name, Display Name), if you use it you get a problem with the Voicemail Scripts if you use Voicemails.
The Voicemail Script did not find the correct User.

Depending on the type of the object different configuration parameters are available. Some configuration parameters are common for all objects.

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.
Name The name of the object. This name is used for signalling (like a call number) and must be unique throughout the system.
Hardware ID The hardware ID is a name which can be used to register an endpoint to this object. This name is not displayed and cannot be used to call the object. Some endpoints use default names to register based on the MAC address of the endpoint, which can be configured here. This way there is no need to configure any Name/Number on the endpoint itself.
Node The node that the object is assigned to. A Node hierachy 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.
PBX The PBX that the object is assigned to. This PBX accepts registrations for the object.
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.
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. Currently works for non-gateway object types only.
Password / Retype Password If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail.
Filter The filter configured here restricts the numbers which may be called by a endpoint registered to this object
Diversion Filter The filter configured here restricts the numbers which calls may be diverted to by a endpoint registered to this object. The Diversion Filter prevents the setting of a Call Forward to specific destination via an IP-Phone or myPBX, but do not prevents the execution of already configured Call Forward.
CFNR Timeout Overides the PBX global CFNR timeout for this object
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 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 V6 is set to 32 characters.

PBX Object Types

Retrieved from "https://wiki.innovaphone.com/index.php?title=Reference:Administration/PBX/Objects&oldid=31120"