The Business Group Line object defines a subscriber line within a Business Group.
Each Business Group Line object is a child of a Business Group Number Block object. Because there may be a large number of Business Group Line objects, the EMS System Explorer displays them in groups underneath the Business Group Number Block object. Underneath the Business Group Number Block object, the directory numbers assigned to the Business Group Number Block are split into groups of 200; expand these groups to display the Business Group Line objects within them.
To configure and enable a Business Group Line, you need to do the following:
When you first enable the Business Group Line, 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.
Object-Specific Actions | |
Export | To export the configuration of this Business Group Line to a text file, click on the 'Export' pushbutton. See MetaSwitch Class 5 Softswitch Operations Manual: Overview for more details of exporting configuration information. |
Parameter |
Access |
Description |
Directory number | Create | The directory number (full national telephone number including the leading zero) of this subscriber. (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 subscriber among all other subscribers. Either type in the number (noting that the directory number must be within the parent Business Group Number Block 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 presents sub-ranges from the parent Business Group Number Block. 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.) If you need to change the subscriber's directory number, you can do this using the Tasks interface; use one of the Configure Business Group Line tasks under Update Tasks. |
Presentation number | Change Inactive | The presentation number of this subscriber (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 Business Group Line and its call services. The default values for many other fields in the Business Group Line's configuration are taken from the selected profile. Select from the list of Persistent Profiles that are configured for use by Business Group Lines, or select Persistent Profile "None" to use the default values derived from the parent Business Group's configuration instead of using a profile. |
Intercom dialing code | Read only | If this subscriber's directory number is included within an Intercom Code Range defined for this Business Group, this field shows the intercom code that other subscribers within the group can use to call this subscriber. |
Allow direct dialing | Change | Specifies whether this Business Group Line can be dialed directly or can be accessed only through its associated MADN. Values:
|
Customer information | Change | A text field that can be used to store information about the Business Group Line, 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 Business Group Line. 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 Business Group Line. 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 Business Group Line. 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 Business Group Line. 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 Business Group Line. 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 this Business Group Line belongs. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Choose Use default to use the setting from the parent Business Group Number Block, or select a specific entry 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 Inactive | 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 subscriber 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 this subscriber's telephone to connect to the NE. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Values:
|
Access Device | Create | The Access Device that this subscriber uses to connect to the NE. This field appears only if Number status is set to Normal, Ported to, or Non-geographic and Call Agent signaling type is set to Analog line/T1 CAS. Click on the ellipsis symbol at the end of the field to choose from access devices on Trunk / Access Gateways or access devices on Subscriber Gateways. Then select from the displayed list of gateways of the specified type, and then select from the displayed list of Access Devices on the specified gateway. |
Access Line number | Create | The Access Line number on the specified Access Device that this subscriber uses. This field appears only if Number status is set to Normal, Ported to, or Non-geographic and Call Agent signaling type is set to Analog line/T1 CAS.
Either type in the number (which must not match the access line number used by any other subscriber on this access device), or click on the ellipsis symbol at the end of the field to select from the list of numbers not currently in use.
The highest line number that you can specify depends on the access device type: for an IAD it is the number of voice ports configured, and for other devices it is a configured parameter on the access device.
If you click on the ellipsis symbol, the dialog box that appears offers 'manual selection' or 'automatic selection'.
|
ISDN Interface | Change Inactive | This field appears only if the Call Agent signaling type field is set to ISDN PRI; it is not valid for a Business Group Line. |
ISDN default bearer capabilities | Change Inactive | This field appears only if the Call Agent signaling type field is set to ISDN PRI; it is not valid for a Business Group Line. |
Use DN for identification | Change Inactive | Specifies whether the subscriber registers using their directory number instead of a textual user name. This field appears only if Call Agent signaling type is set to SIP and Number status is set to Normal, Ported to, or Non-geographic.
If this field is set to True, the SIP user name field will be hidden. If you change the value of this field and SIP authentication required is True, you must reenter the value in the New SIP password and Confirm new SIP password fields.
Values:
|
SIP user name | Change Inactive | The SIP subscriber's user name. This field appears, and must be supplied, only if Call Agent signaling type is set to SIP and Number status is Normal, Ported to, or Non-geographic. Set this field to the user part of the SIP URI, not including the prefix or domain name. This is a string of 1 - 32 characters, which must not match any other SIP user name with the same domain name; the first character must be a letter (either uppercase or lowercase). Alternatively, if SIP authentication required is True, it can be the subscriber's directory number; specify this as a numeric string that exactly matches the contents of the Directory number field. |
SIP domain name | Change Inactive | The SIP subscriber's domain name. This field appears, and must be supplied, only if Call Agent signaling type is set to SIP and Number status is Normal, Ported to, or Non-geographic. Set this field to match the domain name configured on the SIP device; typically this is a DNS hostname that resolves to the MetaSwitch NE's virtual IP address, or the IP address of a Session Border Controller through which the device accesses the NE. |
Use static NAT mapping | Change Inactive | Specifies whether the NE should perform Network Address Translation on the contents of messages sent to this subscriber. This field appears only if Call Agent signaling type is set to SIP and Number status is Normal, Ported to, or Non-geographic. Values:
|
SIP registration status | Read only | Specifies whether this subscriber is currently registered with the NE using a Registered SIP Binding and can make SIP phone calls. This field appears only if Call Agent signaling type is set to SIP and Number status is Normal, Ported to, or Non-geographic. (The Registered SIP Binding appears in the EMS as an associated object below this subscriber.) Values:
|
SIP authentication required | Change Inactive | Specifies whether this subscriber uses SIP authentication (and must supply authentication parameters in SIP signaling messages). This field appears, and must be supplied, only if Call Agent signaling type is set to SIP and Number status is set to Normal, Ported to, or Non-geographic. Values:
|
New SIP password | Change Inactive | The password that this subscriber uses with his or her SIP phone to register. The password is not displayed in the EMS and you cannot view it, although you can change it to a new value if necessary. This field appears, and must be supplied, only if Call Agent signaling type is set to SIP and Number status is set to Normal, Ported to, or Non-geographic. Specify a text string of 6 - 15 characters. If you use the Refresh pushbutton to refresh the object's status, any characters you have typed will be discarded without changing the password. |
Confirm new SIP password | Change Inactive | This field appears, and must be supplied, only if Call Agent signaling type is set to SIP and Number status is set to Normal, Ported to, or Non-geographic. To confirm that you have typed the new password correctly, type it again in this field. The characters you type must exactly match the characters you typed in the New SIP password field. If you use the Refresh pushbutton to refresh the object's status, any characters you have typed will be discarded without changing the password. |
Preferred location of Trunk Gateway | Change Inactive | This field appears only if Call Agent signaling type is set to SIP. Specifies the location for Trunk / Access Gateways that should be used to route calls for this object where possible (to reduce unnecessary long-distance traffic when a call can be routed locally). Select from the displayed list of available Location objects or None (no location). The value defaults to None. |
Maximum call appearances | Change Inactive | The maximum number of simultaneous call branches in which the subscriber can participate. This field appears, and must be supplied, only if Call Agent signaling type is set to SIP. Choose Use default or specify a value. When the subscriber's SIP phone registers with the NE, creating a Registered SIP Binding object, this value determines the number of SIP Call Appearance child objects of the Registered SIP Binding. |
Maximum permitted contact refresh interval | Change Inactive | The maximum time for which a SIP registration from this subscriber remains valid. This field appears, and must be supplied, only if Call Agent signaling type is set to SIP. Choose Use default or specify a value. This time corresponds to the Expires header on the SIP request; the SIP phone will be disconnected if the user does not re-register within this time. The SIP phone may specify a shorter interval when registering, but if it specifies a longer interval or does not specify one, the value in this field is used in the SIP response. If the SIP phone specifies an interval lower than 3600 seconds (1 hour), this field must be set to the exact value specified by the SIP phone; otherwise the registration attempt is rejected and the SIP phone is disconnected. |
Signal function code | Change Inactive | The subscriber's signal function code which is used for CAS signaling. This field appears only if Call Agent signaling type is set to Analog line/T1 CAS and Number status is set to Normal, Ported to, or Non-geographic. Values:
|
Line usage | Change Inactive | Specifies whether the subscriber intends to use this line for voice and/or fax, or exclusively for fax. This controls the use of compression on the line. This field appears only if Number status is set to Normal, Ported to, or Non-geographic. Values:
|
FSK format | Change Inactive | The type of FSK tones used to pass Caller ID messages to this subscriber. This field appears only if Call Agent signaling type is set to Analog line/T1 CAS and Number status is set to Normal, Ported to, or Non-geographic, and does not appear if the subscriber uses an access device on a Subscriber Gateway. Values:
|
PIN | Change | The personal identification number (PIN) that this subscriber should use to access services related to their phone line. 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. |
Number Validation and routing attributes | Change | Attributes used to determine how a call made by the subscriber is routed to the network. Choose Use default or, if required, select the following value:
|
Line side answer supervision supported | Change Inactive | Specifies whether Line Side Answer Supervision is supported for this subscriber. This field appears only if Call Agent signaling type is set to Analog line/T1 CAS and Number status is set to Normal, Ported to, or Non-geographic. Values:
|
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.
Choose Use default to use the setting from the parent Business Group, or specify a value:
|
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. |
Originating facility marks - disabled | Change | Indicates whether this subscriber line is disabled. This information is required for Subscriber's Originating Facility Marks. Values:
|
Originating facility marks - AD&C | Change | Indicates whether this subscriber requires Advice of Duration and Charge (AD&C). This information is required for Subscriber's Originating Facility Marks. Values:
|
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:
|
Terminating facility marks - fixed destination service | Change | Indicates whether this subscriber has Fixed Destination Service applied. This information is required for Subscriber's Terminating Facility Marks. Values:
|
Timezone | Change | Specifies the timezone for this Business Group Line. 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 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:
|
Line Traffic Study | Change | Specifies whether this line should have statistics for line traffic usage recorded. 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. |
Call Lists - missed calls | Read only | This field appears only if the Call Lists service is enabled in the Global General Call Service Controls object and Number status is set to Normal, Ported to or Non-geographic. A list of the most recent calls to this Business Group Line, that were not answered or were forwarded to another line, starting with the most recent call. For each call, the display shows the date and time (in the subscriber's local timezone) at which the call was made, and the calling number (if available). For more details of the call list format, see Call list format. |
Call Lists - answered calls | Read only | This field appears only if the Call Lists service is enabled in the Global General Call Service Controls object and Number status is set to Normal, Ported to or Non-geographic. A list of the most recent calls to this Business Group Line that were answered, starting with the most recent call. For each call, the display shows the date and time (in the subscriber's local timezone) at which the call was made, the calling number (if available), and the call duration if the call has completed. For more details of the call list format, see Call list format. |
Call Lists - dialed calls | Read only | This field appears only if the Call Lists service is enabled in the Global General Call Service Controls object and Number status is set to Normal, Ported to or Non-geographic. A list of the most recent calls dialed from this Business Group Line (or created using 3-Way Calling or Call Transfer), starting with the most recent call. For each call, the display shows the date and time (in the subscriber's local timezone) at which the call was made, the calling number, and the call duration if the call has completed. For more details of the call list format, see Call list format. |
Last incoming call - calling type | Read only | The type of the last calling number. Values:
|
Last incoming call - calling number | Read only | This field is visible only if the Last incoming call - calling type field is set to Ordinary or Pay phone. The directory number of the calling party for the last call made to this subscriber. |
Last incoming call - calling presentation number | Read only | The presentation number of the calling party for the last call made to this subscriber. This field is visible only if the Last incoming call - calling type field is set to Ordinary, Pay phone, Ordinary (presentation number only), or Pay phone (presentation number only). |
Last incoming call - time of call | Read only | The date and time of the last call made to this subscriber. |
Last incoming call - caller waited | Read only | Indicates whether the last caller was subjected to call waiting. Values:
|
Last incoming call - call answered | Read only | Indicates whether the last incoming call was answered by the subscriber. Values:
|
Last incoming call - call traced | Read only | Indicates whether the last incoming call has been traced by the subscriber. Values:
|
Last outgoing call - called type | Read only | The type of the last called number (in the following field). Values:
|
Last outgoing call - called number | Read only | This field is visible only if the Last outgoing call - called type field is set to Ordinary or Pay phone. The last number called by this subscriber. |
Last outgoing call - number presentation | Read only | Indicates whether the calling number was presented or withheld on the last outgoing call. Values:
|
Alarm state | Read only | Specifies whether any alarms are currently raised for this subscriber. Values:
|
Alarm log correlator | Read only | Identifier of the log message that was generated when this subscriber last entered Attention Required or Attend To Dependent alarm state. This field is reset when the Attention Required alarm events and the Attend To Dependent alarm events are reset to zero. |
Additional alarm log correlator | Read only | If available, the identifier of the log message for the original event that caused the last Attention Required or Attend To Dependent alarm state for this object. This field is reset when the Attention Required alarm events and the Attend To Dependent alarm events are reset to zero. |
Attention Required alarm events | Read only / Reset | Number of times (since the alarm count was reset) that this object's alarm state has gone to Attention Required. |
Attend To Dependent alarm events | Read only / Reset | Number of times (since the alarm count was reset) that this object's alarm state has gone to Attend To Dependent. |
Alarm state changed timestamp | Read only | The time at which the Alarm state last changed. |
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:
|
Diagnostics - 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 - 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 - 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. |
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 subscriber. Values:
|
Actual status | Read only | Specifies the current status of the subscriber. Values:
|
Call list format
If the Call Lists service is enabled in the Global General Call Service Controls object, the Call Lists fields in this object provide a record of the most recent calls to and from this Business Group Line.
Missed calls, Answered calls
The following information is displayed for missed calls (calls to this Business Group Line that were not answered or were forwarded to another line), and for answered calls:
An example answered call list is shown below. The missed call list is similar except that the call duration is not shown.
28 Jul 05 08:13:04 - 02081230001 - 00:00:07 28 Jul 05 08:08:52 - 02081230004 - 00:00:08 28 Jul 05 08:04:51 - 02081230008 - 00:00:05
If the called subscriber does not have Calling Number Delivery, the entry appears as in the following example.
28 Jul 05 08:13:04 - - 00:00:07 28 Jul 05 08:08:52 - 02081230004 - 00:00:08 28 Jul 05 08:04:51 - 02081230008 - 00:00:05
Dialed calls
The following information is displayed for calls dialed from this Business Group Line (or created using 3-Way Calling or Call Transfer):
An example dialed call list is shown below.
28 Jul 05 10:33:38 - 02081230001 - 00:00:04 28 Jul 05 10:32:38 - 02081230006 - 00:00:08 28 Jul 05 10:29:04 - 02081230002 - 00:01:43