The Subscriber object defines an end user connected to the VP3000.
Each Subscriber object is a child of the Subscribers object. Because there may be a large number of Subscriber objects, the EMS System Explorer displays them in groups underneath the Subscribers object. Underneath the Subscribers object there is one entry for each Number Range configured (typically a range of 1000 numbers) and an additional entry for all subscribers with numbers not within a configured Number Range. Underneath each entry for a Number Range, the numbers are split into groups of 100 (for example, "subscribers 1000 - 1099"). Expand these groups to display the Subscriber objects within them.
To configure and enable a subscriber, you need to do the following:
When you first enable the subscriber, all the subscriber services are "not subscribed" by default. You can then activate individual services for this subscriber as required.
Note that the EMS currently includes Tasks to simplify the processes of adding, finding and configuring subscribers. See the MetaSwitch VP3000: Tasks Guide for more information.
Parameter |
Access |
Description |
Directory number | Create | The directory number of this subscriber. This is used by the VP3000 to identify a subscriber among all other subscribers. Either type in the number (noting that if you set the Number status to Normal or Ported from the directory number must be within an active Number Range), 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.) |
Signaling number | Change | Depending on your version of MetaSwitch, this field may not be included. The 10-digit number, if any, to be sent in signaling messages for this subscriber in place of the subscriber's directory number (for example, if the directory number corresponds to an outgoing-only line and should be replaced by the number of another line that accepts incoming calls). You cannot change this value while the Subscriber is enabled. |
Subscriber Group | Change | The Subscriber Group to which the subscriber belongs. Select from the list of all configured Subscriber Groups. |
Number status | Change | Specifies the status of this number. Values:
|
IAD Voice Port | Change | Identifies the IAD and the voice port to which the subscriber is connected. This field appears, and must be supplied, only if the Number status field is set to Normal or Ported to. Select from the list of IAD Voice Ports not currently in use by another subscriber. |
Ported exchange ID | Change | This field appears, and must be supplied, only if the Number status field is set to Ported from. This field is valid only in the UK. |
Signal function code | Change | The subscriber's signal function code which is used for CAS signaling. Values:
|
Line usage | Change | 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. Values:
|
Caller ID format | Change | The format of Caller ID messages played to this subscriber. You cannot change this value while the Subscriber is enabled. Values:
|
Long distance carrier | Change | The long distance carrier ID (PIC1) used by default for this subscriber. This is a 4-digit number. |
Local carrier | Change | The local carrier ID (PIC2) used by default for this subscriber. This is a 4-digit number. |
PIN | Change | The personal identification number (PIN) that this subscriber should use to access services related to their phone line. Specify a number of 1 - 10 digits. |
Locale | Change | The language variant used for voice announcements played to this subscriber. Values:
|
Billing type | Change | The type of billing used for calls within this subscriber's local area. Values:
|
Deny all usage sensitive features | Change | Specifies whether the subscriber is prevented from having usage sensitive billing for any call services. This field overrides the configuration of individual call services for this subscriber. Values:
|
Line side answer supervision supported | Change | Specifies whether Line Side Answer Supervision is supported for this subscriber. Values:
|
Digit masking required | Change | Flag set to indicate that this subscriber's line requires digit masking. Values:
|
Tariff group | Change | This field is not valid in North America. |
Active year | Read only | The year (4 digit number) in which the row status went active with Number Status set to reserved. This field and the following two fields are used to allow the number to be reserved for a given period of time. |
Active month | Read only | The month in which the row status went active with NumberStatus set to reserved. |
Active date | Read only | The date (in the month) in which the row status went active with NumberStatus set to reserved. |
Last incoming call - calling type | Read only | The type of the last calling number. Values:
|
Last incoming call - unique number | Read only | Specifies whether the last calling number was a unique 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 - 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:
|
Subscriber on-hook | Read only | Indicates whether the subscriber is on-hook. 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 for the 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. |
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. If set to True, the Diagnostics - trace tag must be specified. Values:
|
Diagnostics - trace tag | Change | The diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII characters other than whitespace. |
Diagnostics - trace remote number | Change | The remote 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 number is not specified, all calls made by and received by this subscriber will be API traced. |
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:
|