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:
  • ANI II digits (North America only)
  • Area code dialed
  • Called address complete
  • Called address scope
  • Called address type
  • Country code length
  • FGD carrier ID (North America only)
  • FGD carrier dialing allowed (North America only)
  • FGD carrier requirement (North America only)
  • Call hold allowed
  • Operator call
  • Priority call
  • 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)
  • Test call
  • Announcement ID
  • Announcement Parameter 1
  • Announcement Parameter 2
  • Transit Network ID (North America only)
  • Call type (North America only)
  • Dialed prefix (North America only)
  • Allowed dialing pattern (North America only)
  • Dialing pattern (North America only)
  • Allowed carrier call type (North America only)
  • Carrier call type (North America only)
  • Carrier type (North America only)
  • Use modified operator NOA encoding (North America only)
  • Use operator requested NOA encoding (North America only)
  • Calling category
  • UK call type (UK only)
  • Customer announcement ID
  • IN trigger index (North America only)
  • IN trigger match type (North America only)
  • US LATA (North America only)
  • Echo cancellation
  • Force Local Lookup
  • User defined 1
  • User defined 2
  • User defined 3
  • Permit when service suspended
  • Message Billing Index
  • Use Pseudo ANI (pANI) (North America only)
  • Billing - call type
  • Billing - structure code
  • Billing - override AIN billing (North America only)
  • Force LNP lookup (North America only)
  • ISUP called address prefix (North America only)
  • User defined MF call type (North America only)
  • Pseudo ANI egress signaling types (North America only)
  • Pseudo ANI presentation indicator (North America only)
  • Signaling Gateway
  • ANI Screening lookup (North America only)
  • Number type for ANI lookup (North America only)
  • Authorization Code Service (North America only)
  • 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)
Attribute value - ANI II digits Change This attribute is not valid in the UK.
Attribute value - area code dialed Change Indicates whether an area code was dialed as part of the called number. This field is visible only if Attribute type is set to Area code dialed. Values:
  • Unknown (default)
  • Not applicable
  • Not dialed
  • Dialed
Attribute value - called address scope Change Area within which the called address is unique. This field is visible only if Attribute type is set to Called address scope. Values:
  • Unknown (default)
  • International
  • National
  • Subscriber
  • No number
  • UK specific
Attribute value - called address type Change Address type of the called address. This field is visible only if Attribute type is set to Called address type. Values:
  • E.164 (default)
  • Dialed digits
Attribute value - country code length Change Length of the country code for an international call. This field is visible only if Attribute type is set to Country code length. The default is 0. Range : 0 - 3
Attribute value - FGD carrier ID Change This attribute is not valid in the UK.
Attribute value - FGD carrier dialing allowed Change This attribute is not valid in the UK.
Attribute value - FGD carrier requirement Change This attribute is not valid in the UK.
Attribute value - call hold allowed Change Indicates whether holding this call is allowed. This field is visible only if Attribute type is set to Call hold allowed. Values:
  • No (default)
  • Yes
Attribute value - operator call Change Indicates whether operator involvement is required for this call. This field is visible only if Attribute type is set to Operator call. Values:
  • No (default)
  • Yes
Attribute value - priority call Change Indicates whether the call requires priority handling. This field is visible only if Attribute type is set to Priority call. Values:
  • No (default)
  • Yes
Attribute value - region code Change This attribute is not valid in the UK.
Attribute value - release control mode Change Specifies the release controlling party for a call. This field is visible only if Attribute type is set to Release control mode. Values:
  • Calling party (default)
  • Called party
  • Last party
Attribute value - restricted line 950 call Change This attribute is not valid in the UK.
Attribute value - routing control Change Indicates how routing retries should be controlled at different levels in the UK network. This field is visible only if Attribute type is set to Routing control. Values:
  • Alternate routing allowed, continuous routing allowed (default)
  • Alternate routing barred, continuous routing allowed
  • Alternate routing allowed, continuous routing barred
  • Alternate routing barred, continuous routing barred
  • Alternate routing allowed once, continuous routing allowed
  • Alternate routing allowed once, continuous routing barred
Attribute value - signal access signaling for operator call Change This attribute is not valid in the UK.
Attribute value - signal FGD carrier ID Change This attribute is not valid in the UK.
Attribute value - test call Change Indicates whether the call is a test call. This field is visible only if Attribute type is set to Test call. Values:
  • No (default)
  • Yes
Attribute value - announcement ID Change Identifies the announcement that is to be played to the subscriber. If no announcement ID is specified, the default announcement associated with the error code will be played. This field is visible only if Attribute type is set to Announcement ID. 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 Numeric parameter to be included in the error announcement. This field is visible only if Attribute type is set to Announcement Parameter 1. This attribute is valid only in an Attribute Set that includes the Announcement ID attribute. Specify a string of up to 32 digits. Only ASCII digits 0 - 9 are valid.
Attribute value - announcement parameter 2 Change Numeric parameter to be included in the error announcement. This field is visible only if Attribute type is set to Announcement Parameter 2. This attribute is valid only in an Attribute Set that includes the Announcement ID attribute. Specify a string of up to 32 digits. Only ASCII digits 0 - 9 are valid.
Attribute value - Transit Network ID Change This attribute is not valid in the UK.
Attribute value - call type Change This attribute is not valid in the UK.
Attribute value - dialed prefix Change This attribute is not valid in the UK.
Attribute value - allowed dialing pattern Change This attribute is not valid in the UK.
Attribute value - dialing pattern Change This attribute is not valid in the UK.
Attribute value - allowed carrier call type Change This attribute is not valid in the UK.
Attribute value - carrier call type Change This attribute is not valid in the UK.
Attribute value - carrier type Change This attribute is not valid in the UK.
Attribute value - use modified operator NOA encoding Change This attribute is not valid in the UK.
Attribute value - use operator requested NOA encoding Change This attribute is not valid in the UK.
Attribute value - calling category Change Calling category for this call. This field is visible only if Attribute type is set to Calling category. Values:
  • Normal (default)
  • Emergency
Attribute value - UK call type Change Type of the call being established. This field is visible only if Attribute type is set to UK call type. Values:
  • Unknown (default)
  • Broadband
    Reserved for use by broadband services 092 - 099.
  • Corporate, toll-free
    Corporate toll-free number (typically starting 0500).
  • Corporate
    Corporate number (typically starting 05, except for 0500).
  • Directory enquiries
    Call to directory enquiries (for example 192, 195, or 153).
  • Emergency
    Emergency call (for example 999). If this value is set, the call will be retried continuously until it is connected successfully or until the caller hangs up.
  • International
    International call dialed from the UK.
  • Local
    Local call.
  • Local, non-geographical
    Non-geographic number charged at or below local rates. Typically used for numbers starting with 084, except for a few numbers in the 084 range that are toll-free (for example, unmetered internet access).
  • Mobile
    Mobile phone number (typically starting with 077, 078, or 079).
  • National
    National geographic number.
  • National, non-geographical
    National non-geographic number. Typically used for numbers starting with 087, except for a few numbers in the 087 range that are toll-free (for example, unmetered internet access).
  • Operator
    Operator call (for example 100 or 155).
  • Other carrier
    Access codes for other carriers.
  • Paging
    Paging services number (typically starting with 076).
  • Personal numbering
    "Find-me-anywhere" personal number (typically starting with 070).
  • Premium
    Premium rate number (typically starting with 090 or 091).
  • Repair
    Repair service (for example 151 or 154).
  • Toll-free
    Toll-free number (typically starting 0800).
  • Other
    Any number that does not match one of the categories above.
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 - customer announcement ID Change Identifies a customer-specific announcement that is to be played to the subscriber. You will need to set up an entry in the customer-specific message catalog to include the appropriate announcement; see the MetaSwitch Class 5 Softswitch 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.
Attribute value - echo cancellation Change Echo cancellation requirements for this call. This field is visible only if Attribute type is set to Echo cancellation. Echo cancellation can be set up either in number validation (for example to use echo cancellation on all international calls), or on a specific Media Channel (for example to use echo cancellation on a media channel that represents a satellite link). Values:
  • Required (default)
  • Preferred
Attribute value - force local lookup Change This field is visible only if Attribute type is set to Force Local Lookup. Specifies whether the NE should always check whether the called number is for a local subscriber, even if its local area code is different from that of the calling number. This avoids using a long-distance carrier when both subscribers are on the same NE. Values:
  • Yes
  • No
Attribute value - user defined Change This field is visible only if Attribute type is set to User defined 1, User defined 2, User defined 3, or 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.
Attribute value - permit when service suspended Change This field is visible 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. Values:
  • Yes
  • No
Attribute value - message billing index Change Message Billing Index associated with the call. This field is visible only if Attribute type is set to Message Billing Index. Enter the index as 3 decimal digits.
Attribute value - Use Pseudo ANI (pANI) Change This field is visible only if Attribute type is set to Use Pseudo ANI (pANI). This field is valid only in the US.
Attribute value - billing - call type Change This field is visible 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, 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
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 - structure code Change This field is visible 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 - billing - override AIN billing Change This field is visible only if Attribute type is set to Billing - override AIN billing. This field is valid only in the US.
Attribute value - force LNP lookup Change This field is visible only if Attribute type is set to Force LNP lookup. This field is valid only in the US.
Attribute value - ISUP called address prefix Change This field is visible 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.
Attribute value - pseudo ANI egress signaling types Change This field is visible only if Attribute type is set to Pseudo ANI egress signaling types. This field is valid only in the US.
Attribute value - pseudo ANI presentation indicator Change This field is visible only if Attribute type is set to Pseudo ANI presentation indicator. This field is valid only in the US.
Attribute value - Signaling Gateway Change This field is visible only if Attribute type is set to Signaling Gateway. Specifies the Signaling Gateway that is to process this call (this identifies the point code with which the call is associated). Select from the displayed list of configured Signaling Gateways.
Attribute value - ANI Screening lookup type Change This field is visible only if Attribute type is set to ANI Screening lookup. This field is valid only in the US.
Attribute value - ANI Screening lookup table Change This field is visible only if Attribute value - ANI Screening lookup type is visible and set to Lookup in specific table. This field is valid only in the US.
Attribute value - number type for ANI lookup Change This field is visible only if Attribute type is set to Number type for ANI lookup. This field is valid only in the US.
Attribute value - Authorization Code Operation Change This field is visible only if Attribute type is set to Authorization Code Service. This field is valid only in the US.
Attribute value - Authorization Code Table Change This field is visible only if Attribute value - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. This field is valid only in the US.
Attribute value - Valid Authorization Codes Change This field is visible only if Attribute value - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. This field is valid only in the US.
Attribute value - Authorization Code Change This field is visible only if Attribute value - Valid Authorization Codes is visible and set to Specific code. This field is valid only in the US.
Attribute value - Authorization Code Prefix Change This field is visible only if Attribute type is set to Authorization Code Service. This field is valid only in the US.
Attribute value - IN query ANI NPA Change This field is valid only in the US.
Attribute value - IN query ANI NPA-NXX Change This field is valid only in the US.
Attribute value - IN query ANI 1st preference Change This field is valid only in the US.
Attribute value - IN query ANI 2nd preference Change This field is valid only in the US.
Attribute value - IN query ANI 3rd preference Change This field is valid only in the US.
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 MetaSwitch Class 5 Softswitch 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 MetaSwitch Class 5 Softswitch 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 Services and Subscribers.


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