Reference9:PBX/Objects: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Special:Prefixindex/Reference9:PBX/Objects}}
[[#PBX Object Types | List of PBX Object Types]]


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.
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.
Line 26: Line 26:
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.
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 ==
== General 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 ]].
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.
Depending on the type of the object different configuration parameters are available. Some configuration parameters are common for all objects.


{|
;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.
|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.  For practical reasons, you should limit it to ''20 - extension length'' characters.  
;Hide from LDAP: When this checkmark 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.
|-
 
|valign=top nowrap=true|'''Name'''
;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 signalling (like a call number) and must be unique throughout the system.<br>
 
Note that from V8 on, clients ''cannot'' use the '''Name''' property as registration name.  They must use one of the devices ([[#Devices|see below]]).  Likewise, for those objects that have a '''Number''' property, when a registration is attempted using this number, the corresponding object is looked up, the '''Name''' property retrieved and a registration tried.  As a result, the registration will fail if the object does not have a device with a hardware-id identical to the objects '''Name'''.
;Name: The name of the object. This name is used for signalling (like a call number) and must be unique throughout the system. The character '@' should not be used.
|-
 
|valign=top nowrap=true|'''Hardware ID'''
:Note: From V8 on, clients ''cannot'' use the '''Name''' property as registration name.  They must use one of the devices.  Likewise, for those objects that have a '''Number''' property, when a registration is attempted using this number, the corresponding object is looked up, the '''Name''' property retrieved and a registration tried.  As a result, the registration will fail if the object does not have a device with a hardware-id identical to the objects '''Name'''.
|The Hardware Id from v7 is replaced by the Devices configuration ([[#Devices|see below]])
:Note: from V9 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.
|-
:With this configuration you can send emails using the myPBX client buddy list to other PBX members. The PBX creates then the email address from the name field and system name.
|valign=top nowrap=true|'''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. See [[Reference:PBX Locations]].
;Hardware ID: The Hardware Id from v7 is replaced by the Devices configuration.
|-
 
|valign=top nowrap=true|'''PBX'''
;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.
|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.
 
|-
;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects
|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. 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.
;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.
|-
 
|valign=top nowrap=true|'''Send Number'''
;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.
|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.
 
|-
;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.
|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.
;Reject ext. Calls: Calls from external sources to this object are rejected.
|-
 
|valign=top nowrap=true|'''Filter'''
;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.
|The filter configured here restricts the numbers which may be called by a endpoint registered to this object
 
|-
;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|'''Diversion Filter'''
 
|The filter configured here restricts the numbers which calls may be diverted to by a endpoint registered to this object
;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 availabe within the CDRs generated by the gateway.
|-
 
|valign=top nowrap=true|'''Reject ext. Calls'''
;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.
|If this checkmark is set a call from an external source to this object is rejected. A calling party numbering plan private is used to decide that the call is coming from an internal source. An invalid number destination is excuted for calls rejected because of this.
 
|-
;Hide Connected Endpoint: This checkmark hides the name and number of the connected endpoint if an object with this checkmark 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.
|valign=top nowrap=true|'''Response Timeout'''
|Overides the PBX global response timeout for this object
|-
|valign=top nowrap=true|'''Busy on n Call(s)'''
|If this value is set a call to this user object is rejected with User Busy if n or more calls are active on this user object. If the object is of the gateway type (Gateway, Trunk, ...) calls from endpoints registered to this object are rejected as well in this case.
|-
|valign=top nowrap=true|'''Twin Phones'''
|With this checkmark the twin phone mode is enabled for this object, which means that one user uses different phones. The main difference is, that if one phone is busy and additional call is sent to the busy phone only as call waiting and not to the other phones.
If "Call Waiting" is disabled on the busy phone a second call gets a busy tone and a missed call is displayed when the active call is terminated.
|-
|valign=top nowrap=true|'''No Inband Disconnect'''
|If this checkmark is set, a call disconect 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.
|-
|valign=top nowrap=true|'''Store Phone Config'''
|If this checkmark is set, the PBX stores the config of the phone. The first time a phone registers the predefined config at the PBX is sent to the phone even if it is empty. Then the local config stored at the phone is merged into the received config and the result is returned to the PBX. After this the local config is deleted and no local config is stored on the phone anymore. Later config changes on the phone will be sent to the PBX and stored there. On registration the PBX sends the complete config to the phone again.
|-
|valign=top nowrap=true|'''Discard Config on Phone'''
|If this checkmark is set in addition to ''Store Phone Config'' the local config stored at the phone is discarded but not returned to the PBX when the phone registers the first time, i.e. the phone is configured with the config predefined at the PBX.
|-
|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 V7 is set to 48 characters.
|}


== Devices ==
== Devices ==
Line 99: Line 76:
There are security build in mechanisms :
There are security build in mechanisms :


* If the '''AdminPwd''' checkmark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.
* 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 checkmark '''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 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)
* 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).
for 20 seconds. After that time it is possible to register at that object with the right password.


== Objects with empty node or PBX ==
== Objects with empty node or PBX ==
Line 112: Line 90:


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

Latest revision as of 06:56, 22 April 2015

List of PBX Object Types

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.

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.

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 checkmark 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 signalling (like a call number) and must be unique throughout the system. The character '@' should not be used.
Note: From V8 on, clients cannot use the Name property as registration name. They must use one of the devices. Likewise, for those objects that have a Number property, when a registration is attempted using this number, the corresponding object is looked up, the Name property retrieved and a registration tried. As a result, the registration will fail if the object does not have a device with a hardware-id identical to the objects Name.
Note: from V9 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.
With this configuration you can send emails using the myPBX client buddy list to other PBX members. The PBX creates then the email address from the name field and system name.
Hardware ID
The Hardware Id from v7 is replaced by the Devices configuration.
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.
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.
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.
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 availabe within the CDRs generated by the gateway.
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 checkmark hides the name and number of the connected endpoint if an object with this checkmark 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.

Devices

With the devices configuration it is possible to identify the different devices, which may register for a user. The Hardware Id is used to match the incoming registration. The Text can be used for a description of the device. On the SOAP/TAPI interface Text can be used to let the user select the device which shall be controlled. If no device is configured the Name and v7 Hardware Id are used for default devices to ensure v7 configuration compatibility.

To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id identical to the object Name.

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

PBX Object Types

Retrieved from "https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects&oldid=37429"