Attribute Entry

Each Attribute Entry object is a child of an Attribute Set object.

Each object defines a single attribute (consisting of a type and a value) that may be added to the routing request during the number validation process.


Note that when the grandparent Config Set is active, this object cannot be modified; all fields are read only and all actions are disabled. You must deactivate the grandparent Config Set before you can modify the object.


Parameter

Access

Description
Attribute type Change Type of the attribute defined in this object. See the description of each Attribute value parameter below for more details of each attribute type. Values:
  • Allowed carrier call type (North America only)
  • Allowed dialing pattern (North America only)
  • ANI II digits (North America only)
  • ANI Screening lookup (North America only)
  • Announcement ID
  • Announcement Parameter 1
  • Announcement Parameter 2
  • Area code dialed
  • Authorization Code Service (North America only)
  • Billing - call type
  • Billing - structure code
  • Billing - override AIN billing (North America only)
  • Called address complete
  • Called address scope
  • Called address type
  • Call hold allowed
  • Calling category
  • Call type (North America only)
  • Carrier call type (North America only)
  • Carrier type (North America only)
  • Country code length
  • Customer announcement ID
  • Dialed prefix (North America only)
  • Dialing pattern (North America only)
  • Echo cancellation
  • FGD carrier ID (North America only)
  • FGD carrier dialing allowed (North America only)
  • FGD carrier requirement (North America only)
  • Force LNP lookup (North America only)
  • Force on-switch lookup
  • IN query ANI NPA (North America only)
  • IN query ANI NPA-NXX (North America only)
  • IN query ANI 1st preference (North America only)
  • IN query ANI 2nd preference (North America only)
  • IN query ANI 3rd preference (North America only)
  • IN trigger index (North America only)
  • IN US trigger match type (North America only)
  • ISUP called address prefix (North America only)
  • Maximum call duration
  • Message Billing Index
  • Number type for ANI lookup (North America only)
  • Operator call
  • Outgoing ISUP/ISDN Release Cause
  • Permit when service suspended
  • Priority call
  • Pseudo ANI egress signaling types (North America only)
  • Pseudo ANI presentation indicator (North America only)
  • Region code (North America only)
  • Release control mode (UK only)
  • Restricted line 950 call (North America only)
  • Routing control (UK only)
  • Signal access signaling for operator call (North America only)
  • Signaling FGD carrier ID (North America only)
  • Signaling Gateway
  • Test call
  • Transit Network ID (North America only)
  • UK call type (UK only)
  • Use modified operator NOA encoding (North America only)
  • Use operator requested NOA encoding (North America only)
  • Use Pseudo ANI (pANI) (North America only)
  • User Defined Attribute 1 - User Defined Attribute 20
    Each of the 20 User Defined Attribute options appears in this list only if you have configured a User Defined Attribute object with the corresponding numeric index value. It appears as UDA n - description (showing the index value in the range 1-20 and the configured description, if any).
  • User defined MF call type (North America only)
  • US LATA (North America only)
Attribute value - allowed carrier call type Change This field appears only if Attribute type is set to Allowed carrier call type. Specifies the carrier call types that may be used for a particular carrier. This is compared with the actual carrier call type set for the call at the end of number validation; if there is a mismatch, an appropriate error message is played. This attribute can be set up only in the Carrier Table, not in the main validation tables. Select one or more of the values:
  • International - not world zone 1
  • International - world zone 1
  • InterLATA
  • IntraLATA
  • InterLATA CDR (default)
Attribute value - allowed dialing pattern Change This field appears only if Attribute type is set to Allowed dialing pattern. Specifies the dialing patterns that may be used. This is compared with the actual dialing type for the call at the end of number validation and if there is a mismatch, an appropriate error message is played. Select one or more of the values:
  • 7 digits
  • 10 digits
  • 1+10 digits
  • 0+10 digits
  • Other
The default is all values selected (in other words, allow any dial pattern).
Attribute value - ANI II digits Change This field appears only if Attribute type is set to ANI II digits. II digits associated with North American ANI functionality. This is normally a property of a subscriber line but may be changed for some call types. This value is not checked or semantically interpreted, and you can configure any value within the range 00 to 99. The default is 0. For an incoming call over SIP or ISUP, this value is normally set by the originating exchange; for a call originating on the switch it is initially set by Call Services. Number Validation can override the initial value if required; the exception is that the initial value on an incoming call over SIP must be left unchanged.
Attribute value - ANI Screening lookup type Change This field appears only if Attribute type is set to ANI Screening lookup. Specifies whether an ANI Screening lookup should be performed when processing this call, and if so how the lookup should be performed. If the MetaSwitch NE provides a long-distance service to subscribers using its own carrier code, ANI Screening lookup is used to check the calling number to ensure that the calling subscriber is permitted to use this service. Values:
  • None (default)
    No ANI Screening lookup.
  • Lookup on carrier code (North America only)
    Check that the Transit Network ID associated with the call matches the on-switch carrier configured for the active Config Set, and if so perform an ANI Screening lookup using the configured ANI Screening Table.
  • Lookup in specific table
    Use the ANI Screening Table specified in Attribute value - ANI Screening lookup table to perform the lookup (without checking the Transit Network ID).
Attribute value - ANI Screening lookup table Change This field appears only if Attribute value - ANI Screening lookup type is visible and set to Lookup in specific table. Specifies the ANI Screening Table to be used for the ANI Screening lookup. If the specified number type is not available, the call is processed as if no match could be found. Click on the ellipsis symbol at the end of the field to select from the configured ANI Screening Tables. (In the current version there can be only one ANI Screening Table.)
Attribute value - announcement ID Change This field appears only if Attribute type is set to Announcement ID. The announcement ID is optionally set on failure of routing or number validation to request playing of a specific announcement. You cannot set both an Announcement ID and a Customer Announcement ID in the same attribute set. If no announcement ID is specified, and the call cannot be released immediately, the default announcement associated with the error code will be played. Values:
  • None (default)
  • Bad area code
  • Missing area code
  • Unnecessary area code
  • Unnecessary prefix
  • Number disconnected
  • Individual number changed
  • Bad CAC combination
  • Changed CAC
  • Wrong CAC
  • No intraLATA CAC
  • Bad CAC
  • No domestic CAC
  • No international CAC
  • Restricted CAC
  • Prohibited CAC
  • Prefix required
  • Group number changed
  • Media in use
  • Test tone
Depending on the Announcement ID value, you may need to set up additional Attribute Entry objects for parameters required by the announcement. See Announcement Parameters below for more information.
Attribute value - announcement parameter 1 Change This field appears only if Attribute type is set to Announcement Parameter 1. Numeric string for the first parameter to be included in the error announcement. This attribute is valid only in an Attribute Set that includes the Announcement ID or Customer Announcement ID attribute. Specify a string of up to 32 digits. Only ASCII digits 0 - 9 are valid.
Attribute value - announcement parameter 2 Change This field appears only if Attribute type is set to Announcement Parameter 2. Numeric string for the second parameter to be included in the error announcement. This attribute is valid only in an Attribute Set that includes the Announcement ID or Customer Announcement ID attribute. Specify a string of up to 32 digits. Only ASCII digits 0 - 9 are valid.
Attribute value - area code dialed Change This field appears only if Attribute type is set to Area code dialed. Attribute used at an originating exchange to indicate whether the calling subscriber dialed an area code as part of the called number. This is subsequently used by billing and MF. Values:
  • Unknown (default)
  • Not applicable
  • Not dialed
  • Dialed
Attribute value - Authorization Code Operation Change This field appears only if Attribute type is set to Authorization Code Service. Specifies whether this call requires an authorization code, and if so how the valid code is determined. Values:
  • None (default)
    No authorization code is required.
  • No Validation
    The authorization code specified in Attribute value - Authorization Code Prefix is used only in billing records for the call. The subscriber is not required to dial an authorization code to make the call.
  • On-Switch Calling Card / Hotline
    The subscriber must dial an authorization code (and optionally an associated PIN) to make the call, and the following fields define how this code is validated.
Attribute value - Authorization Code Table Change This field appears only if Attribute value - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. Specifies the authorization code table that is used to check the authorization code supplied for the call. Click on the ellipsis symbol at the end of the field to select from the configured Authorization Code Tables. If you change this value and Attribute value - Valid Authorization Codes is set to Specific code, you must specify a new value in the Attribute value - Authorization Code field.
Attribute value - Valid Authorization Codes Change This field appears only if Attribute value - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. Specifies whether this call requires a specific authorization code or any code from the specified table. Values:
  • Any code in table (default)
    The subscriber can use any authorization code in the table specified by Attribute value - Authorization Code Table.
  • Specific code (default)
    The subscriber must use the authorization code specified in Attribute value - Authorization Code.
Attribute value - Authorization Code Change This field appears only if Attribute value - Valid Authorization Codes is visible and set to Specific code. In particular, note that it is not used for non-validated codes; the Attribute value - Authorization Code Prefix field is used to specify these. Specifies the authorization code that must be supplied for the call. Click on the ellipsis symbol at the end of the field to select from the Authorization Codes in the specified table, or type in the code value (which must be of the length defined in the specified table). If you change the value of Attribute value - Authorization Code Table, you must specify a new value for this field.
Attribute value - Authorization Code Prefix Change This field appears only if Attribute type is set to Authorization Code Service. The use of this field depends on the setting of Attribute value - Authorization Code Operation, as follows.
  • If Authorization Code Operation is None, this field does not appear.
  • If Authorization Code Operation is No Validation, this field contains the complete authorization code that should be added to billing records for the call.
  • If Authorization Code Operation is On-Switch Calling Card / Hotline, this field defines an optional prefix for the authorization code. The complete code that is checked against authorization code tables consists of this prefix followed by the code dialed by the subscriber. For example, if the authorization code is the subscriber's home directory number (validated by a PIN), this field could contain the NPA code so that the subscriber need only enter the 7D number.
Attribute value - billing - call type Change This field appears only if Attribute type is set to Billing - call type. If you need to override the call type in the first billing record for this call, set this attribute in Number Validation to specify the call type to be used. Values:
  • 1
  • 5
  • 6
  • 9
  • 33
  • 45
  • 47
  • 88
  • 110
  • 119
  • 131
  • 132
  • 134
  • 141
  • 142
  • 710
  • 711
  • 720
  • 721
  • 800 - 999
    This range of values is reserved for your own custom billing records; you can use any value in this range.
See Call Type / Structure Code Combinations below for the valid combinations of call type and structure code. If the call would not normally generate any billing records, a billing record is created only if you specify both the structure code and the call type. Otherwise the selected call type replaces the call type in the first billing record for the call.
Attribute value - billing - override AIN billing Change This field appears only if Attribute type is set to Billing - override AIN billing. Specifies whether the values in Attribute value - billing - structure code and Attribute value - billing - call type should override the billing record produced for AIN calls as well as for standard calls. This field is ignored for non-AIN calls. Values:
  • Yes
    If a structure code is specified, it is used in the AIN billing record; the call type is also used in this record if it is specified. If the structure code is not specified, any specified call type is ignored.
  • No (default)
    The specified structure code and call type are ignored for AIN calls, and are used to override the NE's standard billing records only for non-AIN calls.
Attribute value - billing - structure code Change This field appears only if Attribute type is set to Billing - structure code. If you need to override the structure code in the first billing record for this call, specify the structure code to be used. Values:
  • 1
  • 20
  • 28
  • 79
  • 220
  • 221
  • 360
  • 364
  • 500
  • 625
  • 653
See Call Type / Structure Code Combinations below for the valid combinations of call type and structure code. If the call would not normally generate any billing records, a billing record is created only if you specify both the structure code and the call type. Otherwise the selected structure code replaces the structure code in the first billing record for the call.
Attribute value - called address scope Change This field appears only if Attribute type is set to Called address scope. Area within which the called address is unique.
  • For dialed digit addresses, the address scope is unknown on input and must be converted to a different value before successful completion of number validation.
  • For E.164 addresses, the scope is not normally changed during number validation except in the case where number validation adds an area code to the number when the address scope may be updated to reflect this.
Values:
  • Unknown (default)
  • International
  • National
  • Subscriber
  • No number
  • UK specific
Attribute value - called address type Change This field appears only if Attribute type is set to Called address type. Address type of the called address. Number validation uses this to determine which number validation table to use initially, and normally converts "dialed digit" addresses into E164 addresses. Values:
  • E.164 (default)
  • Dialed digits
Attribute value - call hold allowed Change This field appears only if Attribute type is set to Call hold allowed. Indicates whether holding this call is allowed. At a call originating exchange, call holding is normally allowed, but may be disallowed during number validation processing (typically when the call is routed to a carrier with whom there is no agreement to support call hold for operator calls). Values:
  • No (default)
  • Yes
Attribute value - calling category Change This field appears only if Attribute type is set to Calling category. The category of call being placed by the calling party. The output value of this attribute is used in the Calling Party Category field in an ISUP IAM. Values:
  • Normal (default)
  • Emergency
Attribute value - call type Change This field appears only if Attribute type is set to Call type. Type of the call being established. This is set by the number validation component at the call originating exchange to indicate the type of the call, and is used for Billing and Outgoing Call Blocking. Values:
  • Unknown (default)
  • Operator
  • Emergency
  • Local
  • IntraLATA
  • InterLATA national
  • InterLATA international
  • Toll free
  • Premium
  • Other non-geographic
  • Operator Service
  • Directory Assist
  • FGD cut through
  • FGB
  • International
  • International toll free
  • Other N11
  • Other
The default value Unknown can be used as a placeholder value during number validation, but should be replaced by a more specific value before number validation completes. The call will not be routed if this attribute value is set when number validation completes.
Attribute value - carrier call type Change This field appears only if Attribute type is set to Carrier call type. Carrier call type for this call. This attribute can only be set up in the main validation tables, not in the Carrier table, and is used internally within Number Validation to check that a carrier supports calls of a particular type. Values:
  • International - not world zone 1 (default)
  • International - world zone 1
  • InterLATA
  • IntraLATA
  • InterLATA CDR
Attribute value - carrier type Change This field appears only if Attribute type is set to Carrier type. FGD carrier type selected by number validation for this call. Values:
  • Unknown (default)
  • LEC
  • IC
  • International
  • InterLATA and international
Attribute value - country code length Change This field appears only if Attribute type is set to Country code length. Length of the country code for an international call. It may be used by signaling stacks in order to extract the country code prefix from the called number. This attribute is used only at an originating exchange. Non-zero values are used only for international calls. (In North America, it is set only for non-world zone 1 international calls which cannot be dialed using a standard NPA). Range: 0 - 3. The default is 0.
Attribute value - customer announcement ID Change This field appears only if Attribute type is set to Customer announcement ID. Identifies a customer-specific announcement that is to be played to the subscriber on Number Validation failure. You cannot set both a Customer Announcement ID and an Announcement ID in the same attribute set. You will need to set up an entry in the customer-specific message catalog to include the appropriate announcement; see the Integration and Customization Manual for more information about customizing announcements. Set this field to specify the message number for the appropriate announcement in the customized message catalog file. Each customer announcement may take up to two parameters, as specified by Announcement Parameter 1 and Announcement Parameter 2. If no Announcement ID or Customer Announcement ID is specified, and the call cannot be released immediately, the default announcement associated with the error code is played.
Attribute value - dialed prefix Change This field appears only if Attribute type is set to Dialed prefix. Identifies the US prefix digits used when dialing a call. In particular, this parameter distinguishes between 1/011 dialed calls and 0/01 dialed calls. This attribute is only ever set by number validation at an originating exchange. Values:
  • Unknown (default)
  • 1+
  • 0+
  • 0-
  • None
Attribute value - dialing pattern Change This field appears only if Attribute type is set to Dialing pattern. Indicates the dialing pattern used for the dialed number. This attribute is used internally during number validation to check that a number has been dialed correctly. Values:
  • 7 digits (default)
  • 10 digits
  • 1+10 digits
  • 0+10 digits
  • Other
Attribute value - echo cancellation Change This field is visible only if Attribute type is set to Echo cancellation.

Echo cancellation requirements for this call. This is normally configured in number validation, determined by analysis of the called address. For example, international calls often meet sufficient delay to require echo cancellation.

Echo cancellation can also be set up for each media channel in MF and ISUP Signaling. This is normally required if the media channel is known to have a long delay, for example if it represents a satellite link. Values:
  • Required (default)
  • Preferred
Attribute value - FGD carrier dialing allowed Change This field appears only if Attribute type is set to FGD carrier dialing allowed. Indicates whether dialing of an FGD carrier prefix is allowed for this call. For some calls where FGD carrier dialing is inappropriate, it is tolerated (for example 911 calls), whereas for others it is disallowed. Values:
  • No (default)
  • Yes
Attribute value - FGD carrier ID Change This field appears only if Attribute type is set to FGD carrier ID. Carrier ID associated with the call. This is normally the carrier ID to which the call should be routed (although this field is never used for routing). The exception is operator calls where the operator service for a given carrier may be provided by a different carrier. Enter the carrier ID as 4 decimal digits. The default is zero.
Attribute value - FGD carrier requirement Change This field appears only if Attribute type is set to FGD carrier requirement. Indicates whether a carrier is required for a particular call, and if so the type of carrier that is to be used. This attribute is used when determining the carrier information to use for a call at the end of number validation processing. Values:
  • None required (default)
    No carrier is required for this call, so carrier selection will not be performed.
  • Use dialed or PIC1
    Use the carrier ID dialed by the subscriber, or the subscriber's default long distance carrier ID (PIC1).
  • Use dialed or PIC2
    Use the carrier ID dialed by the subscriber, or the subscriber's default intraLATA carrier ID (PIC2).
  • Use dialed or PIC3
    Use the carrier ID dialed by the subscriber, or the subscriber's default international carrier ID (PIC3).
  • Use specified
    Use the value specified by the FGD carrier ID attribute; this attribute must be specified within the same Attribute Set.
Attribute value - force LNP lookup Change This field appears only if Attribute type is set to Force LNP lookup. Specifies whether to force an LNP lookup for this call even though the destination number is on the switch. This may be required if the NE supports subscribers in multiple local areas; in some cases there is a regulatory requirement to route calls between different areas using an external carrier even though both subscribers are on the same NE, and the carrier may require an LNP lookup to be performed before it accepts the call. Values:
  • Yes
  • No (default)
Attribute value - force on-switch lookup Change This field appears only if Attribute type is set to Force on-switch lookup. Specifies whether the NE should always look up the called address in the database of subscribers on this switch, and allow routing to the associated subscriber if found. This overrides the default behavior for some calls, avoiding the use of a long-distance carrier when both subscribers are on the same NE. For example, if a call is classed as an InterLATA or IntraLATA call it would normally be routed to an IXC even if the calling and called parties are co-located on the same switch. Forcing on-switch lookup suppresses billing records for the call; if you want to ensure that these records are created, set the Billing - call type and Billing - structure code attributes in the same Attribute Set. Typical call type / structure code combinations are 6 / 1 for intraLATA calls and 110 / 625 for intraLATA calls; see Call Type / Structure Code Combinations below for the valid combinations of call type and structure code. Note that setting this attribute is against equal access regulations in some circumstances, but in others, notably in VoIP networks, the regulations are more relaxed. Values:
  • Yes
  • No
Attribute value - IN query ANI 1st preference Change This field appears only if Attribute type is set to IN query ANI 1st preference. Specifies the preferred method for determining the ANI used in non-geographic number (toll-free) lookups for an adjacent switch. Depending on the trunk type over which the call is received, the adjacent switch may provide a partial ANI or no ANI; this attribute determines whether the ANI used for the lookup should be taken from the received ANI if available, from configured values on the MetaSwitch NE, or from some combination of the two. If the ANI information indicated by this attribute is not available, the following attributes 2nd preference and 3rd preference are used instead. Values:
  • Standard ANI (default)
    Use the full ANI information received on the call.
  • Provided 7-digit ANI with configured NPA
    Use the 7-digit ANI information received on the call, with the NPA value configured in Attribute value - IN query ANI NPA.
  • Source address NPA-NXX
    Use the first 6 digits of the received source address.
  • Configured NPA-NXX
    Use the NPA-NXX value configured in Attribute value - IN query ANI NPA-NXX.
Attribute value - IN query ANI 2nd preference Change This field appears only if Attribute type is set to IN query ANI 2nd preference. Specifies an alternative method for determining the ANI used in non-geographic number (toll-free) lookups for an adjacent switch if the ANI information indicated by the 1st preference attribute is not available. The valid values are the same as for the Attribute value - IN query ANI 1st preference attribute.
Attribute value - IN query ANI 3rd preference Change This field appears only if Attribute type is set to IN query ANI 3rd preference. Specifies an alternative method for determining the ANI used in non-geographic number (toll-free) lookups for an adjacent switch if the ANI information indicated by the 1st preference and 2nd preference attributes is not available. The valid values are the same as for the Attribute value - IN query ANI 1st preference attribute.
Attribute value - IN query ANI NPA Change NPA value to be used in non-geographic number (toll-free) lookups for an adjacent switch if the NPA is not provided in AIN information for the call. Specify a value in the range 0 - 999. If the parent Attribute Set contains an Attribute Entry for one of the IN query ANI 1st - 3rd preference attributes indicating that the MetaSwitch NE should use a configured ANI NPA value, it must also contain an Attribute Entry for this attribute specifying the required NPA value.
Attribute value - IN query ANI NPA-NXX Change NPA-NXX value to be used in non-geographic number (toll-free) lookups for an adjacent switch if the NPA-NXX is not provided in AIN information for the call. Specify a value in the range 0 - 999999. If the parent Attribute Set contains an Attribute Entry for one of the IN query ANI 1st - 3rd preference attributes indicating that the MetaSwitch NE should use a configured ANI NPA-NXX value, it must also contain an Attribute Entry for this attribute specifying the required NPA-NXX value.
Attribute value - IN trigger index Change This field appears only if Attribute type is set to IN trigger index. An Intelligent Networking trigger that will be deemed to have been hit if this attribute is set. When this attribute is present, the IN US trigger match type attribute must also be present. The attribute set containing this attribute may only be referred to from a number validation entry with an action (default or explicit) of Complete Validation. Select from the displayed list of IN Triggers.
Attribute value - IN US trigger match type Change This field appears only if Attribute type is set to IN US trigger match type. Type of Intelligent Networking trigger match. This attribute should be set based on the length of matching performed on the destination number when the attribute set containing this attribute is picked up. When this attribute is present, the IN trigger index attribute must also be present. Values:
  • NPA (default)
  • NPA XXX
  • NPA XXX XXXX
Attribute value - ISUP called address prefix Change This field appears only if Attribute type is set to ISUP called address prefix; it is used only for long-distance calls in Canada that are routed over ISUP trunks, and is not required for deployments elsewhere. Specifies a 4-character prefix (also known as an NXZZ code) to be added to the called number in the ISUP IAM message. These prefixes are not used for calls over non-ISUP trunks. This is a 4-character string in which the first character is a letter A - F and the remaining characters are letters A-F or numbers 0 - 9. Leaving this field blank indicates that no prefix is to be included. In most cases the string is of the form DNNN, where NNN is a 3-digit number; typical values are D081 for 1+10D dialed long distance calls, D138 for direct dialed international calls, and D022 for 1-600-XXX-XXXX calls.
  • For calls originating on the switch that will be routed over ISUP trunks, you can set the appropriate value in Number Validation.
  • For tandem calls, the received prefix is stored as an attribute of the call so that it can be re-used on the outgoing leg of the call. You may need to change or remove this attribute in Number Validation (in the same way as for calls originating on the switch), particularly if the called number changes during processing of the call. In particular, if the called number is changed by a Call Service, such as call forwarding, the received prefix is removed, so you will need to assign a new prefix in Number Validation (after the called number is changed) if a prefix is required. Note that an exception to this is Local Number Portability processing, which always leaves the prefix unchanged.
Attribute value - maximum call duration Change This field appears only if Attribute type is set to Maximum call duration.

Maximum permitted duration for a call. If this attribute (MCD) is set, the call will be terminated if it is still in progress when the specified limit is reached. This is typically used to prevent excessive call charges arising from calls to expensive destinations (for example long-distance or international calls).

The MCD attribute can be set in either Number Validation or Routing, and the duration is measured from the time when Number Validation or Routing completes with the MCD attribute set. This means that, if the specified duration is too short, the call may be terminated before it has been answered or before an announcement being played to it has completed.

A multi-party call can have the MCD attribute set on some branches of the call but not on others. If all MCD-controlled branches of the call end before the specified duration is reached, any remaining call branches are not affected by the MCD. However, if the MCD is reached on one branch of the call, all branches of the call are terminated at the same time, including those that do not have an MCD set.

The MCD attribute is ignored if any part of the call is identified as an emergency call; these calls will not be terminated when the MCD expires. Specify the duration in minutes, in the range 1 - 1440 (1 minute - 24 hours), or specify zero to indicate no limit.
Attribute value - message billing index Change This field appears only if Attribute type is set to Message Billing Index. Message Billing Index associated with the call. If this index is included, a billing record containing the MBI is recorded in billing files. You should normally include an MBI for a call from a subscriber whose billing type is FX rate; it is optional for other subscriber types. Enter the index as 3 decimal digits.
Attribute value - number type for ANI lookup Change This field appears only if Attribute type is set to Number type for ANI lookup. Specifies the type of number associated with the call (charge number or calling party number) that should be looked up in an ANI Screening lookup. If this number is not available, the call is processed as if no match could be found. Values:
  • Charge number
    Use the Charge Number for lookup.
  • Charge number preferred
    Use the Charge Number for lookup if it is available; use the Calling Party Number if this is the only number available.
  • Calling party number
    Use the Calling Party Number for lookup.
  • Calling party number preferred
    Use the Calling Party Number for lookup if it is available; use the Charge Number if this is the only number available.
Attribute value - operator call Change This field appears only if Attribute type is set to Operator call. Indicates whether some kind of operator involvement is required for this call. This is set by the number validation component at an originating exchange for direct calls to an operator, calls which require operator involvement and operator services calls. Currently this indicator is ignored at a non-originating exchange. Values:
  • No (default)
  • Yes
Attribute value - outgoing ISUP/ISDN release cause Change This field appears only if Attribute type is set to Outgoing ISUP/ISDN Release Cause. Indicates whether a specific release cause is to be reported to the originating switch if the call could not be routed on this switch, or if it was routed to another switch and was rejected there. The release cause will be reported only if the call was received over an ISUP or ISDN trunk. Note that setting a release cause does not in itself cause the call to be rejected. The valid values for this attribute are a subset of those defined in Q.850; the other values defined in Q.850 are not supported, generally because they do not apply to ISUP and ISDN trunks. See Outgoing Release Causes below for a full list of values and some restrictions on their use. Alternatively, you can specify Auto (the default) to indicate that the NE should use the release cause that it determined, or the release cause signaled by the terminating switch if the call was routed to another switch and was rejected there.
Attribute value - permit when service suspended Change This field appears only if Attribute type is set to Permit when service suspended. Specifies whether the NE should allow calls to this number even when the subscriber's telephone service is suspended. In general, a suspended subscriber can make calls to the emergency service number 911 and to one other number defined in the General Call Service Controls object. If you need to allow access to other numbers, set this attribute during number validation on all numbers for which access is required. Values:
  • Yes
  • No
Attribute value - priority call Change This field appears only if Attribute type is set to Priority call. Indicates whether the call requires priority handling. At an originating exchange, this defaults to No but can be set by number validation processing if required. Whether or not a call is a priority call may affect how it is routed. Values:
  • No (default)
  • Yes
Attribute value - pseudo ANI egress signaling types Change This field appears only if Attribute type is set to Pseudo ANI egress signaling types. Specifies the types of outgoing signaling stack for which Pseudo ANI is to be used. This attribute, set in Number Validation, allows you to restrict the use of Pseudo ANI so that it is used on some signaling types but not on others. This attribute applies only if the attribute Use Pseudo ANI (pANI) is also set. By default, if Use Pseudo ANI is set but this attribute is not set, Pseudo ANI is used on all signaling stack types. Values:
  • ISUP
  • ISDN access
  • ISDN trunk
  • SIP access
  • SIP trunk
  • Analog
Attribute value - pseudo ANI presentation indicator Change This field appears only if Attribute type is set to Pseudo ANI presentation indicator. Specifies the presentation indicator to be used with Pseudo ANI, which controls whether the Pseudo ANI calling number can be presented to the called user. This attribute applies only if the attribute Use Pseudo ANI (pANI) is also set. Values:
  • Restricted (default)
  • Available
Attribute value - region code Change This field appears only if Attribute type is set to Region code. Identifies the region associated with an international world zone 1 call. This is used by MF signaling. Range : 0 - 9. The default is 0.
Attribute value - release control mode Change This attribute is not valid in North America.
Attribute value - restricted line 950 call Change This field appears only if Attribute type is set to Restricted line 950 call. Indicates whether the call is to a 950-XXXX number from a restricted (hotel/motel) line. Values:
  • No (default)
  • Yes
Attribute value - routing control Change This attribute is not valid in North America.
Attribute value - signal access signaling for operator call Change This field appears only if Attribute type is set to Signal access signaling for operator call. Indicates whether the access signaling type should be signaled by ISUP for operator calls when using the "modified nature of address" encoding as specified in GR-1277. This attribute can be set only at a call originating exchange and is ignored for non operator calls. Values:
  • No (default)
  • Yes
Attribute value - signal FGD carrier ID Change This field appears only if Attribute type is set to Signaling FGD carrier ID. Indicates whether the FGD carrier ID should be signaled by ISUP. Values:
  • No (default)
  • Yes
Attribute value - Signaling Gateway Change This field appears only if Attribute type is set to Signaling Gateway. Specifies the Signaling Gateway associated with this call. Select from the displayed list of configured Signaling Gateways.
Attribute value - test call Change This field appears only if Attribute type is set to Test call. Indicates whether the call is a test call. This is set by number validation based on the dialed number and may be used in routing the call. Values:
  • No (default)
  • Yes
Attribute value - Transit Network ID Change This field appears only if Attribute type is set to Transit Network ID. Identifier for the transit network to which the call should be routed. This is normally set by number validation to the same as the carrier ID associated with the call (if any). However, for some operator calls, the transit network is different from the carrier ID for the call because one carrier provides operator services for another. Routing will use this attribute, if present, as the primary routing key. Range: 0 - 9999. The default is 0.
Attribute value - UK call type Change This attribute is not valid in North America.
Attribute value - use modified operator NOA encoding Change This field appears only if Attribute type is set to Use modified operator NOA encoding. Indicates whether ISUP should encode the IAM for an operator call according to the "basic" NOA or "modified" NOA rules as described in GR-1277. This parameter may be modified for each destination carrier. Values:
  • No (default)
    Use the basic NOA rules.
  • Yes
    Use the modified NOA rules.
Attribute value - use operator requested NOA encoding Change This field appears only if Attribute type is set to Use operator requested NOA encoding. Indicates whether ISUP should use the "operator requested" called address NOA variant when signaling an operator call. This attribute is relevant only on calls where "modified" NOA encoding is being used. Values:
  • No (default)
  • Yes
Attribute value - Use Pseudo ANI (pANI) Change This field appears only if Attribute type is set to Use Pseudo ANI (pANI). Specifies whether the calling party fields in outgoing messages contain the Charge Number from the original call (instead of the Calling Party Number). This is used for interworking between different signaling stacks (for example if the incoming side of the call is over MF which does not support delivery of calling numbers), or when the ANI should be presented to the called party instead of the calling number (for example on calls to the emergency operator). Values:
  • Never
    Never use the charge number.
  • Only when no calling number
    Use the charge number only if there is no calling number (or a zero-length number) specified.
  • Always (default)
    Use the charge number as ANI regardless of whether there is a calling number specified.
Note that the NE's use of Pseudo ANI is also affected by the attributes Pseudo ANI egress signaling types and Pseudo ANI presentation indicator.
Attribute value - user defined Change This field appears only if Attribute type is set to one of the User Defined Attribute values (UDA 1 - UDA 20) or to User defined MF call type.

Specifies a user-defined numeric value that should be added to this routing request for use later in the routing process, or for selection of an MF outgoing call profile if the call is transported over MF signaling.

User Defined Attributes are provided as an extension to allow you to perform routing that is specific to your deployment and cannot be controlled by other attributes; many deployments may not require them. They are configured using the User Defined Attribute objects.

The MetaSwitch Class 4/5 Softswitch does not assign a specific meaning to any particular User Defined Attribute or its value; you can use any of these attributes and assign values as required. For each attribute, you can specify an optional name to identify the attribute's meaning.

In Number Validation, you can specify a User Defined attribute as an integer value; you can then match on one or more of these values later in Number Validation or during Routing to determine how to route the call. The User Defined MF Call Type attribute applies only to calls routed over MF signaling.
  • In number validation and categorization for incoming MF calls, this attribute allows you to distinguish between incoming calls that are signaled differently, where the standard call attributes as set in the incoming profile are not sufficient to allow this. Other appropriate attributes can then be set in Number Validation as required.
  • For outgoing calls over MF, it allows selection of the appropriate outgoing call profile data entry (determining how the call is signaled to the peer) where the normal match fields are not sufficient.
In an MF Incoming Call Profile or in Number Validation, you can set this attribute to an integer value identifying the type of call; you can then match on this value later in an MF Outgoing Call Profile to determine how to signal the call. The MetaSwitch Class 4/5 Softswitch does not assign a specific meaning to any particular value for this attribute; you can assign values as required.
Attribute value - US LATA Change This field appears only if Attribute type is set to US LATA. The US LATA identifier used, defining defines the Local Access and Transport Area associated with a calling or forwarding subscriber. LATA identifiers are defined in the US Local Exchange Routing Guide (LERG) published by Telcordia. This attribute is used only when performing AIN TCAP lookups; these lookups may succeed if the attribute is absent, but are liable to fail. If all subscribers are associated with a single LATA, this attribute should be set up in a default attribute set early in the NV tables. If subscribers in different subscriber groups are associated with different LATAs, this attribute should be set in an attribute set specific to the subscriber group. Range: 0 - 999. The default is 0. If the LATA code you want to use contains 5 digits, use the first 3 digits in this field.
Requested status Read only Specifies whether an administrator has attempted to enable the Attribute Entry. 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 Attribute Entry. Values:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.

Announcement Parameters

Some announcements played to subscribers require one or more parameters that are inserted into the announcement; for example, an announcement informing the subscriber of an area code change requires a parameter specifying the new area code. Other announcements require no parameters (for example a "number disconnected" announcement). For more information about how parameters are included in announcements, see the Integration and Customization Manual.

If you have set up an Attribute Entry with Attribute type set to Announcement ID, and the specific announcement ID you have selected requires one or two parameters, any Attribute Set that includes this Attribute Entry must also include one or two additional Attribute Entries for these parameters. In these entries, Attribute type must be set to Announcement parameter 1 for the first parameter, and Announcement parameter 2 for the second.

In the delivered system, the announcement IDs requiring parameters are as follows. Note that the requirement for parameters with specific announcement IDs may be different if you have customized the announcements as described in the Integration and Customization Manual.

No announcement parameters:
  • Number disconnected
  • Individual number changed
  • Bad CAC combination
  • No intraLATA CAC
  • Bad CAC
  • No domestic CAC
  • No international CAC
  • Restricted CAC
  • Media in use
  • Test tone
  • Prohibited CAC
One announcement parameter:
  • Bad area code
  • Missing area code
  • Unnecessary area code
  • Unnecessary prefix
  • Changed CAC
  • Wrong CAC
  • Prefix required
Two announcement parameters:
  • Group number changed

Call Type / Structure Code Combinations

The parameters Attribute value - billing - call type and Attribute value - billing - structure code allow you to override the contents of the billing records generated by the MetaSwitch NE. You are recommended to use combinations of call type and structure code shown in the list below; the MetaSwitch NE supports other combinations of the valid values, but these do not correspond to standard billing records and you will need to ensure that your billing systems can deal with them.

For more information about the format of billing records that the MetaSwitch NE generates, see Operations Manual: Billing.


Call type


Description


Supported structure codes
1 Detailed Message Rate, with MBI 20
5 Detailed Message Rate, no MBI 1, 220, 500
6 Station paid (InterLATA) 1, 500
9 411 DA 28
33 555 DA 28
45 ISDN User Service 0001, 0220, 0221, 0500
47 Default AIN 221
88 555 non-DA 1, 500
110 InterLATA Station Paid 625
119 Terminating Access Record 625, 653
131 FGA - Originating 79
132 FGA - Terminating 1, 500
134 FGB - Originating 625
141 Interexchange Carrier Number Services 360
142 Local Exchange Carrier Number Services 364
710 Originating Toll AMA Recording 625
711 Terminating Toll AMA Recording 625
720 Connecting Network Access Incoming 625
721 Default LNP 1, 500
800 - 999 LEC defined Any

Outgoing Release Causes

When an incoming call attempt received over an ISUP or ISDN trunk is to be rejected because it cannot be routed, you can specify a release cause as an attribute to be signaled to the originating switch, which may help that switch to determine how to re-route the call.

The MetaSwitch NE supports the release cause values listed below, which are defined in the Q.850 specification. However, you should note the following restrictions.


Value


Description


ISUP
mapping


ISDN
mapping


Extra
info?

1 Unallocated number Unchanged Unchanged Yes
2 No route to specified transit network (national use) Unchanged Unchanged Yes
3 No route to destination Unchanged Unchanged Yes
4 Send special info tone Unchanged 41 No
5 Misdialed trunk prefix 31 28 No
6 Channel unacceptable 31 Unchanged No
7 Call awarded to established channel 31 Unchanged No
8 Call pre-empted Unchanged 41 No
9 Call pre-empted, circuit reserved Unchanged 17 No
16 Normal call clearing Unchanged Unchanged Yes
17 User busy Unchanged Unchanged Yes
18 User not responding Unchanged Unchanged No
19 User not answering Unchanged Unchanged No
20 Subscriber absent Unchanged 19 No
21 Call rejected Unchanged Unchanged Yes
22 Number changed Unchanged 1 Yes
27 Destination out of order Unchanged Unchanged No
28 Invalid number format Unchanged Unchanged No
29 Facilities rejected Unchanged 41 Yes
30 Response to status inquiry 31 Unchanged No
31 Normal, unspecified Unchanged 27 No
34 No circuit / channel available Unchanged Unchanged No
38 Network out of order Unchanged 41 No
41 Temporary failure Unchanged Unchanged No
42 Switching equipment congestion Unchanged Unchanged No
43 Access information discarded Unchanged Unchanged Yes
44 Requested circuit / channel not available Unchanged Unchanged No
46 Precedence call blocked Unchanged 41 No
47 Resource unavailable, unspecified Unchanged 41 No
50 Requested facility not subscribed Unchanged 41 Yes
53 Outgoing calls barred within CUG 63 41 No
55 Incoming calls barred within CUG 63 41 No
57 Bearer capability not authorized Unchanged Unchanged Yes
58 Bearer capability not presently available Unchanged 34 Yes
62 Inconsistency in outgoing information element Unchanged 41 No
63 Service or option not available, unspecified Unchanged 41 No
65 Bearer capability not implemented Unchanged Unchanged Yes
66 Channel type not implemented 79 41 Yes
69 Requested facility not implemented Unchanged 65 Yes
70 Only restricted digital information bearer capability is available (national use) Unchanged 41 No
79 Service option not implemented, unspecified Unchanged 41 No
87 User is not a member of CUG 95 41 No
88 Incompatible destination Unchanged Unchanged No (ISUP), Yes (ISDN)
90 Non existent CUG 95 41 No
91 Invalid transit network selection (national use) Unchanged 41 No
95 Invalid message, unspecified Unchanged 41 No
97 Message type non-existent or not implemented Unchanged 41 Yes
98 Message not compatible with call state Unchanged 41 Yes
99 Information element / parameter non-existent or not implemented Unchanged 41 No (ISUP), Yes (ISDN)
102 Recovery on timer expiry Unchanged Unchanged Yes
103 Parameter non-existent or not implemented - passed on (national use) Unchanged 41 Yes
110 Unrecognized parameter discarded Unchanged 41 Yes
111 Protocol error, unspecified Unchanged 41 No
127 Interworking, unspecified Unchanged Unchanged No