Persistent Profile

The Persistent Profile object is a child of the Persistent Profiles object. It defines a standard set of configuration parameters that can be used by one or more subscribers (individual lines, business groups, business group lines, MADNs, MLHG Pilot DNs, or PBXs). Child objects of this object define the Call Services parameters used by the same subscribers.

For each field in the persistent profile, you can either specify an explicit value or choose Use default. The default value for each field is normally the same as the system-defined default for the equivalent field if you are configuring a subscriber without using a persistent profile. The only exception to this is that, if you are using the profile to configure a Business Group Line, MADN, or MLHG Pilot DN, the default value is derived from the overall Business Group configuration (which may in turn be derived from a profile used by the Business Group).


If you modify a profile that is used by a large number of subscribers, it may take some time for the NE to apply the change to all of the subscribers. For example, if there are 10,000 subscribers using the profile, it may be up to 5 minutes before all of these subscribers are updated. You can check whether such an update is in progress by checking the field Synchronization of subscribers in progress in the Persistent Profile object (which is set to True when the profile has been updated and the NE is in the process of updating all the subscribers using this profile), or the field Synchronization with profile in progress in the Business Group object (which is set to True when the Business Group's profile has been updated and the NE is in the process of updating the Business Group Lines within the group).


Parameter

Access

Description
Name Change A name to identify this Persistent Profile in the EMS. This is a text string of 1 - 45 characters, which must not match the name of any other Persistent Profile configured on this Call Agent.
Valid subscriber types Change Specifies the types of subscriber for which this persistent profile can be used. Select one or more of the following values:
  • Individual Line
  • PBX
  • Business Group
  • Business Group Line
  • Multiple Appearance Directory Number
  • MLHG Pilot Directory Number
Synchronization of subscribers in progress Read only Specifies whether subscriber configurations are currently being updated as a result of a recent change to this profile. Values:
  • True
    The profile has recently been changed, and the NE is in the process of applying the change to subscribers using this profile. Some subscribers may still be using the previous settings from before the change.
  • False
    All subscribers using this profile are using the current settings as specified in the profile, except where the subscriber configuration overrides it.
MADN call limit algorithm Change This field applies only when the profile is used by a MADN. Specifies how the NE should limit the total number of concurrent incoming calls to the MADN. When this limit is reached, any further incoming call attempts will receive a busy indication. Choose Use default or specify a value:
  • Total calls cannot exceed number of members
    The total number of concurrent incoming calls to the MADN, including both calls connected to MADN members and queued calls, cannot exceed the number of lines configured as MADN Members. Note that some calls may be queued if one or more lines are busy with outgoing calls or direct-dialed incoming calls to a MADN Member.
  • Total calls cannot exceed specified value
    The total number of concurrent incoming calls to the MADN, including both calls connected to MADN members and queued calls, cannot exceed the number specified in the MADN call limit value field.
  • Queued calls cannot exceed specified value
    The total number of queued incoming calls to the MADN cannot exceed the number specified in the MADN call limit value field.
MADN call limit value Change This field applies only when the profile is used by a MADN. It appears only if MADN call limit algorithm is set to Total calls cannot exceed specified value or Queued calls cannot exceed specified value. Choose Use default or specify the maximum total number of incoming calls (minimum 1) or the maximum number of queued calls (zero indicates that calls will never be queued).
Flash-hook call services provided by Change This field applies only when the subscriber's Call Agent signaling type is set to SIP. Specifies whether this SIP subscriber can flash-hook, and use Call Services provided by the MetaSwitch NE that require a flash-hook (such as Call Waiting). Values:
  • MetaSwitch
    The subscriber's SIP device supports flash-hooking, and can use these call services. The subscriber cannot use multiple SIP registrations; the value of Maximum simultaneous registrations is ignored and only one registration is permitted.
  • Endpoint
    The subscriber's SIP device does not support flash-hooking. (SIP devices may support these call services natively.)
PBX calling number screening Change This field applies only when the profile is used by a PBX with a Call Agent signaling type of ISDN PRI or SIP. Specifies whether the number provided by a PBX is used as the calling party number and/or charge number for outbound calls from this PBX. This field does not apply if both the Calling party number and Charge number fields are specified for the PBX object; 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)
    Use the number provided by the PBX if it meets the standard North American 10 digit format.
  • 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 calling party number and / or charge number is not configured on the PBX but the number provided by the PBX does not pass the screening defined by this field, the Directory number for the PBX is used instead.
Maximum simultaneous registrations Change This field applies only when the profile is used by a SIP subscriber. The maximum number of SIP devices that can register at the same time using this subscriber's details. See the description of SIP Call Forking in the Call Services Manual for more information. Choose Use default or specify a value in the range 1 - 32. A value of 1 (the default) means that each subscriber using this profile can have only one device registered at a time. If you allow multiple registrations, by specifying a value greater than 1, the subscriber must not use the Personal Communication Manager service (specified in the child Personal Communication Manager Service object) or flash-hook call services provided by MetaSwitch (specified in the field Flash-hook call services provided by).
Media Gateway Model Change This field applies only when the profile is used by a SIP subscriber. The Media Gateway Model used by this subscriber. Choose Use default or select from the displayed list of SIP Media Gateway Models. To indicate that the Media Gateway Model should be selected by matching against the SIP User Agent string provided when the SIP device registers with the MetaSwitch NE, select Derived from SIP User Agent from the list. If you change the Media Gateway Model in a profile used by a subscriber who is already in a call, this call continues using the existing model. The new model is used from the start of the subscriber's next call.
Maximum call appearances Change Inactive This field applies only when the profile is used by a SIP subscriber. The maximum number of simultaneous call branches in which the subscriber can participate. 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 This field applies only when the profile is used by a SIP subscriber. The maximum time for which a SIP registration from this subscriber remains valid. 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.
Long distance carrier Change The long distance carrier ID (PIC1) used by default for this subscriber. This field appears only if the subscriber's Number status is set to Normal, Ported to, or Non-geographic. Choose Use default or specify the carrier ID as a 4-digit number.
IntraLATA carrier Change The intraLATA carrier ID (PIC2) used by default for this subscriber. This field appears only if the subscriber's Number status is set to Normal, Ported to, or Non-geographic. Choose Use default or specify the carrier ID as a 4-digit number.
International carrier Change The international carrier ID (PIC3) used by default for this subscriber. This field appears only if the subscriber's Number status is set to Normal, Ported to, or Non-geographic. Choose Use default or specify the carrier ID as a 4-digit number.
Billing type Change The type of billing used for calls within this subscriber's local area. Choose Use default or specify a value:
  • Flat rate
    The subscriber pays a fixed fee that covers all local calls.
  • Message rate
    The subscriber is billed for each call.
  • FX rate
    The line is served by an exchange in a different location from the subscriber (a foreign exchange). A Message Billing Index (MBI) should be specified in Number Validation for each call, which can be used to provide detailed control over billing.
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 the subscriber's 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 (such as ISUP) in preference to SIP trunks.
  • Nomadic subscriber
    The subscriber uses VoIP service and may do so from multiple locations. This attribute is typically used to route emergency (911) calls from this subscriber to a VoIP Emergency Call Services system that can provide details of the subscriber's current location.
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.
Force LNP lookup Change This field is used to force an LNP lookup for a particular subscriber. This is typically only used when a ported subscriber is moving. During the period where the subscriber number is configured as active on two switches, the number portability database is the definitive reference for which number is active. If this field is set to True, LNP information for this subscriber will never be cached, so a lookup is required every time a call arrives for the subscriber. The typical sequence used for porting a subscriber is as follows.
  • Set force LNP lookup flag on original subscriber record
  • Create new subscriber record on recipient switch, also setting force LNP lookup flag
  • Update LNP database at time when line is to be moved.
  • Clear force LNP lookup flag on new subscriber record.
  • Delete old subscriber record or mark it as "Reserved, ported out" as required.
This field is valid only when the subscriber's Number Status is set to Normal, Ported to, or Non-geographic. Choose Use default or specify a value:
  • True
  • False
Timezone Change Specifies the timezone for this subscriber. Note that you cannot explicitly set this field to Unknown. Choose Use default or specify a value:
  • Unknown
  • 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 2am (local time) on the second Sunday in March, and back one hour at 2am (local time) on the first Sunday in November. Choose Use default or specify a value:
  • True
  • False
If Timezone is set to Unknown (so this field is hidden), this field is treated as being set to False.
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). 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.
Child Call Service Attention Required alarms Read only The total number of child objects 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 child object has gone to Attention Required.
Child Call Service Attend To Dependent alarms Read only The total number of child objects 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 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.