PBX

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 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'.
  • If you select 'automatic selection', the EMS will assign the subscriber the next free number within this number range.
  • If you select 'manual selection', the following dialog box presents sub-ranges of 100 numbers. Select the sub-range from which the number should be taken and click on Next. In the next dialog box, select a number and click on OK to accept this number. (If no number is shown, this indicates that there are no free numbers in the range; click on Back and select a different number range.)
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. The EMS uses this value to generate default DID and DNIS codes (based on the final digits of the directory number); you can override it by providing a specific DID or DNIS code. Range: 1-25. Leave this field with no value if you do not want to specify a default; in this case you must provide specific DNIS and/or DID codes.
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 Self-Care, 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. As a short-cut to select the Subscriber Group, you can type match details into the field and click on the search button to select from a list of items that match these details. Match details can be a text string, a wildcard string such as B*, a range such as CA-FL, an index value such as =3, or an index range such as =1-20. For more details, refer to the description of the Details panel in Operations Manual: Overview.
Number status Change Inactive Specifies the status of this number. Values:
  • Normal (default)
    Normal number on this exchange.
  • Ported to
    Number from a different exchange that has been ported to this exchange (for use by a subscriber connected to this exchange).
  • Ported from (UK only)
    Number ported from this exchange to a different exchange (for use by a subscriber connected to that exchange).
  • Ported out (North America only)
    Number ported from this exchange to a different exchange (for use by a subscriber connected to that exchange).
  • Reserved - ported in (North America only)
    Number from a different exchange that has been ported to this exchange, but is not yet in use by a subscriber connected to this exchange.
  • Recently moved
    Number that a subscriber has recently stopped using, to change to another exchange or to another number on this exchange. When someone calls this number, the NE plays an announcement about the change.
  • Reserved - old number
    Number that has previously been used and is being kept for a period of time before re-use.
  • Reserved for future use
    Number that has been reserved for future use.
  • Non-geographic
    Non-geographic number owned by this switch. This number status is used when there is a requirement to define a subscriber with a non-geographic Directory Number. Calls to this subscriber will only succeed if this switch and adjacent switches are configured to route calls directly to this number without performing AIN non-geographic number lookups.
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:
  • True
  • False (default)
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:
  • True
    The caller hears an announcement about the number change, and is then connected to the new number. The field Moved to directory number must specify a number configured on this MetaSwitch NE.
  • False (default)
    The caller hears an announcement that the number has changed, but is not automatically connected.
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 MetaSwitch NE 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:
  • Analog line/T1 CAS
  • ISDN PRI (valid only in US)
  • SIP
You cannot change this value if the PBX has any child PBX Lines.
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:
  • Lowest available (default)
    Use the lowest-numbered line that is free.
  • Highest available
    Use the highest-numbered line that is free.
  • Least recently used
    Use the line that has been free for the longest period of time.
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:
  • 10 digit max ANI
    The PBX supports a maximum ANI length of 10 digits. If this fix bit is set and a calling number is longer than 10 digits, no ANI parameter is sent to the PBX. If the fix bit is not set, the ANI parameter is sent regardless of its length.
  • Always 10 digit ANI
    The ANI sent to the PBX must be 10 digits. If this fix bit is set and a calling number is shorter than 10 digits, the NE pads it with zeros. If the fix bit is not set, the ANI parameter is sent unchanged regardless of its length.
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*.
  • Each of prefix, separator and suffix is a string of 1 - 5 digits, or may be omitted. The valid digits are 0 - 9, * and #.
  • At least one of ANI and DNIS must be included.
  • No other characters (for example spaces used as separators) are valid.
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:
  • True (default)
  • False
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. If this field contains no value, Directory number is set, and Send DID sequence is set to True, the EMS provides a default value as follows.
  • If Default number of DID digits is set, this field is set to the last digits of the Directory number corresponding to the value of Default number of DID digits.
  • If you hit Apply to create the PBX and Default number of DID digits has not been set, this field is set to the entire Directory number.
  • On any other PBX which is not being created where Default number of DID digits has not been set, this field is set to the entire Directory number. (This is similar to the creation scenario, in the previous bullet. However, there the value is not filled in until Apply is pressed so that a value can be provided for Default number of DID digits, as in the first bullet.)
This field will not update to a new default if there is a value set, even if that value was an earlier default value.
Calling number screening Change This field is visible only if Call Agent signaling type is set to SIP. Specifies whether the calling number provided by the PBX on outgoing calls is used as the presentation number. This field does not apply if the Presentation number field is specified; the configured number always takes precedence. Choose Use default or specify a value:
  • No screening
    Use the number supplied by the PBX, whatever the number is.
  • Valid format (North America only)
    This value does not apply in the UK.
  • Owned DN
    Use the number provided by the PBX if it matches the PBX's Directory number, a number in one of the PBX's DID Range objects, or one of the PBX's DISA Number objects.
  • Ignore provided number
    Never use the number provided by the PBX.
If a presentation number is not configured but the number provided by the PBX does not pass the screening defined by this field, the Directory number is used instead.
Default maximum call appearances for PBX lines Change Inactive 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. The default maximum number of simultaneous call branches in which each PBX Line on this PBX can participate. You can override this default for a specific PBX Line by specifying a different maximum value. The actual maximum number of simultaneous call appearances may be limited by the maximum value specified on the Configured SIP Binding that each PBX Line uses, if this is lower, especially if two or more PBX Lines (on different PBXs) use the same binding. 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. (This field defaults to 0000, which is not a valid PIN, so you are forced to enter a specific value.)
Locale Change The language variant used for voice announcements played to this subscriber. Values:
  • English (US)
  • English (UK)
  • English (Canadian)
  • French (Canadian)
  • User Defined 1
  • User Defined 2
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:
  • Pre-paid / off-switch calling card subscriber
    The subscriber uses a pre-paid or off-switch calling card service. The NE must check with an external pre-paid billing platform before routing the call, to ensure that the subscriber is permitted to make this type of call (local, long-distance, international etc.)
  • Fax / modem subscriber
    The subscriber can make fax or modem calls (for which compression should not be used) in addition to standard voice calls. This attribute is typically used to route calls for this subscriber over TDM trunks in preference to SIP trunks.
  • Nomadic subscriber
    This attribute can be used to provide additional routing control not covered by the other attributes.
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:
  • True
    The subscriber is not permitted to use any call service that is configured with usage sensitive billing; this may be configured explicitly in the subscriber configuration or by default from a Persistent Profile or the global setting.
  • False
    The subscriber can use all call services that are configured, regardless of the billing type.
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:
  • None (default)
    Service is not suspended: the customer can make and receive calls as normal.
  • Incoming calls
    The subscriber is prevented from receiving incoming calls, except that he or she can still receive calls from the operator.
  • Outgoing calls
    The subscriber is prevented from making calls, except that he or she can still make calls to emergency services or to the designated suspended service access number.
  • Incoming and outgoing calls
    The subscriber is prevented from making or receiving any calls, except for calls to emergency services or to the designated suspended service access number.
Digit masking required Change Flag set to indicate that this subscriber's line requires digit masking. Values:
  • True
    Digit masking is required: calls to this subscriber's line will be rejected unless a network look-up has been performed before routing. This may be required for a subscriber running a premium rate service
  • False (default)
    Digit masking is not required.
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:
  • True
  • False (default)
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:
  • Unknown (default)
  • EEST (+2)
  • CET (+1)
  • GMT (+0)
  • WET (-1)
  • GMT-2 (-2)
  • GMT-3 (-3)
  • AST (-4)
  • EST (-5)
  • CST (-6)
  • MST (-7)
  • PST (-8)
  • ALST (-9)
  • HST (-10)
  • SST (-11)
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 subscriber's time 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:
  • True
  • False (default)
If Timezone is set to Unknown (so this field is hidden), this field is treated as being set to False.
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 Ancillary Servers Guide for more details of this file. The child statistics object of a PBX always reports line traffic usage. Values:
  • True
  • False (default)
Note that if the maximum allowed number of currently active studies has been met, setting this field to True will be rejected when you apply the change.
Enabled date Read only The date and time at which this object was enabled in the EMS.
Line Class Code 1 - 20 Change / Change Inactive This field appears once for each Line Class Code that you have configured below the Trunk Routing and Policy Services object. The field name for each code appears as LCC n - description (showing the index value in the range 1-20 and the configured description, if any). The access to this field (Change or Change Inactive) depends on the configuration of the Line Class Code. A Line Class Code is used as a match attribute in number validation and/or routing to provide additional options for routing calls originating from this subscriber. If you need to perform specific routing for this subscriber's calls, set this field to a value used as a match value for the Line Class Code in the appropriate Number Validation Entry or Routing Action. Select Use default, or specify the Line Class Code as an integer value in the range 0 - 2147483646. You cannot select Use default if the corresponding Line Class Code object has Allow inheritance set to False; you will have to specify a value. Alternatively, if one or more valid values have been configured in the Line Class Code object, you can select a specific value from the list of valid values by clicking on the ellipsis symbol at the end of the field. Either scroll down the alphabetic list of code value descriptions to select the value you want, or type the first few letters of the code's description so that the alphabetic list scrolls to select the entry you want.
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:
  • Level 10 (diagnostics)
  • Level 20 (verbose statistics)
  • Level 30 (verbose operational)
  • Level 40 (statistics)
  • Level 50 (audit)
  • Level 60 (operational)
  • Level 70 (unexpected)
  • Level 80 (error)
  • Level 90 (fatal)
  • Default level (default)
Diagnostics - API trace - enabled Change Specifies whether API tracing is enabled for this object. Values:
  • True
  • False (default)
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. However, if you want to filter on this tag in the craft interface, do not include spaces or any of the 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:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - one or more child objects are not operating normally, and need operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which one or more child objects depend is not operating normally.
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:
  • None
    No export has been attempted. Use the export pushbutton to start it.
  • In progress
    Export is in progress. Do not attempt to access the export file until the status has changed to Succeeded.
  • Succeeded
    Export completed successfully.
  • Failed
    Export failed. Check the Export - log correlator field for more details.
  • Partially failed
    A field in the configuration of the exported object or one of its child objects was not valid. Typically this is because a referenced object has been deleted. Either check and correct the configuration before retrying the export, or correct the error in the exported file before attempting to re-import it.
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:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.
Actual status Read only Specifies the current status of the PBX. Values:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.