The PBX object defines a PBX (Private Branch Exchange) connected to the NE. It is a child of the PBXs object.
To configure and enable a PBX, you need to do the following:
When you first enable the PBX, most of the subscriber services are disabled by default, except for a small number that can be enabled by default in the global Call Services configuration. You can then activate individual services for this subscriber as required.
Note that the EMS currently includes Tasks to simplify the processes of adding and configuring PBXs and their child objects. See the MetaSwitch Class 5 Softswitch Tasks Guide for more information.
![]() |
It is not possible to change the Call Agent signaling type of a PBX if any PBX Lines are present. Before changing the Call Agent signaling type of a PBX, you must first delete all existing PBX Lines. |
Parameter |
Access |
Description |
Directory number | Create | The directory number (full national telephone number including the leading zero) of this PBX. (This is the actual number used on this exchange; the number that is presented to users may be different if the number has been ported.) This is used by the NE to identify a PBX among all other subscribers. Either type in the number (noting that the directory number must be within an active Number Range if you set the Number status to Normal, Ported from, or Non-geographic), or click on the ellipsis symbol at the end of the field to select from the list of numbers not currently in use.
If you click on the ellipsis symbol, the dialog box that appears displays a list of configured Number Ranges. Select the Number Range from which the new subscriber's number should be taken and click on Next.
The next dialog box offers 'manual selection' or 'automatic selection'.
|
Presentation number | Change Inactive | The presentation number of this PBX (the number that is presented to users; the actual number used on this exchange may be different if the number has been ported). Specify the full national telephone number (including the leading zero). |
Persistent Profile | Change | The Persistent Profile that is used as a basis for the configuration of this PBX and its call services. The default values for many other fields in the PBX's configuration are taken from the selected profile. Select from the list of Persistent Profiles that are configured for use by PBXs, or select Persistent Profile "None" to use the system defaults instead of using a profile. |
Default number of DID digits | Change | The default number of digits used in LDN DNIS and DID range creation.
Range: 0-25. If you attempt to set this field to zero, it will be reset to an empty value. |
Customer information | Change Inactive | A text field that can be used to store information about the PBX, for example the address of the customer associated with it. This field is optional; you can supply up to 64 characters of free-form text. The text wraps to the width of the field on screen, or you can use the Enter key to force linebreaks. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 2 | Change | A text field that can be used to store additional information about the PBX. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 3 | Change | A text field that can be used to store additional information about the PBX. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 4 | Change | A text field that can be used to store additional information about the PBX. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 5 | Change | A text field that can be used to store additional information about the PBX. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 6 | Change | A text field that can be used to store additional information about the PBX. This field is reserved for use by Web Services, so you should not edit it using the EMS. The total contents of all six Customer information fields must not exceed 164 characters. |
Subscriber Group | Change Inactive | The Subscriber Group to which the PBX belongs. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Select from the list of all configured Subscriber Groups. |
Number status | Change Inactive | Specifies the status of this number. Values:
|
Recently moved from old number | Change Inactive | Specifies whether this subscriber has recently moved to this directory number from a different number. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Values:
|
Moved from directory number | Change | The old directory number from which this subscriber has moved. This field appears only if Recently moved from old number is set to True. Specify the number as a full national telephone number including the leading zero. |
Connect call after announcement | Change Inactive | This field appears only if Number status is set to Recently moved. Specifies whether a caller who calls the old number should be connected to the new number after an announcement. Values:
|
Moved to directory number | Change Inactive | The new directory number to which this subscriber has now moved. This field appears only if Number status is set to Recently moved, and is required if Connect call after announcement is set to True. Specify the number as a full national telephone number including the leading zero. |
Ported exchange ID | Change Inactive | The ID of the exchange to which calls for this PBX should be redirected. This is a 5-digit number, allocated by the OFTEL Numbering Unit. When redirecting the call, the local exchange identifies the target exchange by adding a 6-digit prefix to the called number; the prefix consists of the digit 5 followed by this exchange ID. This field appears, and must be supplied, only if the Number status field is set to Ported from. |
Call Agent signaling type | Change Inactive | The type of signaling used by the PBX to connect to the NE. Values:
|
Line selection method | Change Inactive | This field appears only if Call Agent signaling type is set to Analog line/T1 CAS. Specifies the order in which the NE allocates lines for incoming calls to the PBX. This should be different from the order used by the PBX itself to allocate lines for outgoing calls, to minimize glare. Values:
|
Fix bits | Change Inactive | A series of options that control the details of how the MetaSwitch NE interoperates with the PBX. If required, select one or more of the following values:
|
ANI / DNIS format | Change Inactive | This field appears only if Call Agent signaling type is set to Analog line/T1 CAS.
The format of ANI and DNIS digits outpulsed to the PBX, identifying the calling number and/or the PBX Line for which the call is intended. This is a string of the format prefixDNISseparatorANIsuffix or prefixANIseparatorDNISsuffix. The default is *ANI*DNIS*.
|
Send DID sequence for Listed Directory Number | Change Inactive | Specifies whether the DNIS digit sequence (or, for an analog PBX, the digit sequence described in the ANI / DNIS format parameter) is required on calls to the PBX's listed directory number, as well as on DID calls. Values:
|
DNIS used in DID sequence for Listed Directory Number | Change Inactive | This parameter appears only if Send DID sequence for Listed Directory Number is set to True. Specify the digit sequence that should be used as the DNIS digits to identify the listed directory number. The length of this sequence must match the length of any DID codes that you will use with this PBX.
This field defaults if it contains no value, Directory number is set and Send DID sequence is set to true, in the following situations.
|
Maximum call appearances | Change Inactive | The maximum number of simultaneous call branches in which the PBX can participate. This field appears, and must be supplied, only if Number status is set to Normal, Ported to, or Non-geographic and Call Agent signaling type is set to SIP. Choose Use default or specify a value. The default is 64. |
Deliver ISDN User Provided Number on emergency call | Change Inactive | This field is valid only in the US. |
PIN | Change | The personal identification number (PIN) that can be used on this PBX to access some of the Call Services. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. You must specify a valid PIN before the subscriber can access any services that require a PIN. Specify a 4-digit number. |
Locale | Change | The language variant used for voice announcements played to this subscriber. Values:
|
Number Validation and routing attributes | Change | Attributes used to determine how a call made by the subscriber is routed to the network. This field appears only if Number status is set to Normal, Ported to, or Non-geographic.
Choose Use default or, if required, select one or more of the following values:
|
Deny all usage sensitive features | Change | Specifies whether the subscriber is prevented from using any call services that are configured with usage sensitive billing. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Choose Use default or specify a value:
|
Service suspended | Change | Specifies whether service for this subscriber is currently suspended (the subscriber is prevented from making or receiving calls). This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Values:
|
Digit masking required | Change | Flag set to indicate that this subscriber's line requires digit masking. Values:
|
Tariff group | Change | The subscriber's tariff group. The values that this field can take are network specific, with codes agreed between the PNOs concerned. Choose Use default or specify a value in the range 0 - 63. |
Terminating facility marks - service interception | Change | Indicates whether this subscriber has Service Interception applied. This information is required for Subscriber's Terminating Facility Marks. Values:
|
Timezone | Change | Specifies the timezone for this PBX. Note that you cannot explicitly set this field to Unknown. Choose Use default or specify a value:
|
Adjust for Daylight Savings | Change | This field appears only if Timezone is not set to Unknown. This specifies whether the time for this line should be automatically adjusted for daylight savings time. This moves the time for the PBX forward one hour at 1am (local time) on the last Sunday in March, and back one hour at 1am (local time) on the last Sunday in October. Choose Use default or specify a value:
|
Line Traffic Study | Change | This field specifies whether this PBX should have statistics for line traffic usage recorded in the metastats.txt log file. See the MetaSwitch Class 5 Softswitch Ancillary Servers Guide for more details of this file. The child statistics object of a PBX always reports line traffic usage. Values:
|
Enabled date | Read only | The date and time at which this object was enabled in the EMS. |
Line Class Code 1 | Change | A code used as a match attribute in number validation and/or routing to provide additional options for routing calls originating from this subscriber. Choose Use default or specify any integer value in the range 0 - 2147483646. If you need to perform specific routing for this subscriber's calls, set this code to a value used as a match value for Line Class Code 1 in the appropriate Number Validation Entry or Routing Action. |
Line Class Code 2 | Change | A code used as a match attribute in number validation and/or routing to provide additional options for routing calls originating from this subscriber. Choose Use default or specify any integer value in the range 0 - 2147483646. If you need to perform specific routing for this subscriber's calls, set this code to a value used as a match value for Line Class Code 2 in the appropriate Number Validation Entry or Routing Action. |
Line Class Code 3 | Change | A code used as a match attribute in number validation and/or routing to provide additional options for routing calls originating from this subscriber. Choose Use default or specify any integer value in the range 0 - 2147483646. If you need to perform specific routing for this subscriber's calls, set this code to a value used as a match value for Line Class Code 3 in the appropriate Number Validation Entry or Routing Action. |
Line Class Code 4 | Change | A code used as a match attribute in number validation and/or routing to provide additional options for routing calls originating from this subscriber. Choose Use default or specify any integer value in the range 0 - 2147483646. If you need to perform specific routing for this subscriber's calls, set this code to a value used as a match value for Line Class Code 4 in the appropriate Number Validation Entry or Routing Action. |
Line Class Code 5 | Change | A code used as a match attribute in number validation and/or routing to provide additional options for routing calls originating from this subscriber. Choose Use default or specify any integer value in the range 0 - 2147483646. If you need to perform specific routing for this subscriber's calls, set this code to a value used as a match value for Line Class Code 5 in the appropriate Number Validation Entry or Routing Action. |
Diagnostics - logging - log level | Change | Specifies the level of logs recorded for this object. Logs with a priority equal to or greater than the priority specified are recorded. Set to Default level to use the system-wide default level. Values:
|
Diagnostics - API trace - enabled | Change | Specifies whether API tracing is enabled for this object. Values:
|
Diagnostics - API trace - trace tag | Change | An optional diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII characters. |
Diagnostics - API trace - trace remote number | Change | The remote directory number that should be API traced. Outgoing calls made to this number or incoming calls received from this number should be API traced. If a directory number is not specified, all calls made by and received by this subscriber will be API traced. |
PBX Line Attention Required alarms | Read only | The total number of PBX Line children of this object that are in Attention Required state. |
PBX Line Attention Required alarm events | Read only / Reset | The total number of times that the alarm state for a PBX Line child object has gone to Attention Required. |
PBX Line Attend To Dependent alarms | Read only | The total number of PBX Line children of this object that are in Attend To Dependent state. |
PBX Line Attend To Dependent alarm events | Read only / Reset | The total number of times that the alarm state for a PBX Line child object has gone to Attend To Dependent. |
Child Call Service Attention Required alarms | Read only | The total number of Call Service children of this object that are in Attention Required state. |
Child Call Service Attention Required alarm events | Read only / Reset | The total number of times that the alarm state for a Call Service child object has gone to Attention Required. |
Child Call Service Attend To Dependent alarms | Read only | The total number of Call Service children of this object that are in Attend To Dependent state. |
Child Call Service Attend To Dependent alarm events | Read only / Reset | The total number of times that the alarm state for a Call Service child object has gone to Attend To Dependent. |
Summary child alarm state | Read only | Summarizes the alarm status for all children of this object. Values:
|
Export - number of objects exported | Read only | The total number of objects (including child objects) written to the export file so far in the current or most recent export operation. |
Export - status | Read only | The status of the current or most recent export operation, if any. Values:
|
Export - file | Change | The name of the text file (in the EMS User's home directory on the EMS Server) to which configuration information for this object will be exported. The maximum length of the filename is 32 characters. |
Export - log correlator | Read only | If the export status is Failed, this field contains a correlator for the log message that contains details of the failure. Click on the 'go to log' button next to this field to jump to this message in the EMS log viewer window. |
Export - correlator metaswitch | Read only | If the export status is Failed, this field contains the name of the EMS Server or MetaSwitch Network Element that generated the failure log. You may need this information to find the log in the EMS log viewer window. |
Requested status | Read only | Specifies whether an administrator has attempted to enable the PBX. Values:
|
Actual status | Read only | Specifies the current status of the PBX. Values:
|