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:
|
Attribute value - ANI II digits | Change | II digits associated with ANI functionality. This field is visible only if Attribute type is set to ANI II digits. This is normally a property of the subscriber line. For an incoming call over SIP or ISUP, this value is normally set by the originating exchange; for a locally originated call it is initially set by Call Services. Number Analysis can override the initial value if required; the exception is that the initial value on an incoming call over SIP must be left unchanged. This value is not checked or semantically interpreted and the user is free to configure whatever is required within the range 0 to 99. The default is 0. |
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:
|
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:
|
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:
|
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 | Carrier ID associated with the call. This field is visible only if Attribute type is set to FGD carrier ID. Enter the carrier ID as 4 decimal digits. The default is zero. |
Attribute value - FGD carrier dialing allowed | Change | Indicates whether dialing of an FGD carrier prefix is allowed for this call. This field is visible only if Attribute type is set to FGD carrier dialing allowed. Values:
|
Attribute value - FGD carrier requirement | Change | Indicates the carrier requirements for a particular call. This field is visible only if Attribute type is set to FGD carrier requirement. Values:
|
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:
|
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:
|
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:
|
Attribute value - region code | Change | Identifies the region associated with an international world zone 1 call. This field is visible only if Attribute type is set to Region code. The default is 0. Range : 0 - 9 |
Attribute value - release control mode | Change | This attribute is not valid in North America. |
Attribute value - restricted line 950 call | Change | Indicates whether the call is to a 950-XXXX number from a restricted line. This field is visible only if Attribute type is set to Restricted line 950 call. Values:
|
Attribute value - routing control | Change | This attribute is not valid in North America. |
Attribute value - signal access signaling for operator call | Change | 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 field is visible only if Attribute type is set to Signal access signaling for operator call. Values:
|
Attribute value - signal FGD carrier ID | Change | Indicates whether the FGD carrier ID should be signaled by ISUP. This field is visible only if Attribute type is set to Signaling FGD carrier ID. Values:
|
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:
|
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:
|
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 | Identifier for the transit network to which the call should be routed. This field is visible only if Attribute type is set to Transit Network ID. The default is 0. Range: 0 - 9999 |
Attribute value - call type | Change | Type of the call being established. This field is visible only if Attribute type is set to Call type. Values:
|
Attribute value - dialed prefix | Change | Identifies the US prefix digits used when dialing a call. This field is visible only if Attribute type is set to Dialed prefix. Values:
|
Attribute value - allowed dialing pattern | Change | Indicates the dialing patterns that may be used. This field is visible only if Attribute type is set to Allowed dialing pattern. Select one or more of the values:
|
Attribute value - dialing pattern | Change | Indicates the dialing pattern used for the dialed number. This field is visible only if Attribute type is set to Dialing pattern. Values:
|
Attribute value - allowed carrier call type | Change | Carrier call types that may be used. This field is visible only if Attribute type is set to Allowed carrier call type. Select one or more of the values:
|
Attribute value - carrier call type | Change | Carrier call type for this call. This field is visible only if Attribute type is set to Carrier call type. Values:
|
Attribute value - carrier type | Change | Carrier type for this call. This field is visible only if Attribute type is set to Carrier type. Values:
|
Attribute value - use modified operator NOA encoding | Change | 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 field is visible only if Attribute type is set to Use modified operator NOA encoding. Values:
|
Attribute value - use operator requested NOA encoding | Change | Indicates whether ISUP should use the "operator requested" called address NOA variant when signaling an operator call. This field is visible only if Attribute type is set to Use operator requested NOA encoding. This attribute is relevant only on calls where "modified" NOA encoding is being used. Values:
|
Attribute value - calling category | Change | Calling category for this call. This field is visible only if Attribute type is set to Calling category. Values:
|
Attribute value - UK call type | Change | This attribute is not valid in North America. |
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 - IN trigger index | Change | The IN Trigger used. Select from the displayed list of IN Triggers. This field is only valid if Attribute type is set to IN trigger index. |
Attribute value - IN US trigger match type | Change | The IN US trigger match type used. This field is only valid if Attribute type is set to IN trigger match type. Values:
|
Attribute value - US LATA | Change | The US LATA identifier used. Select from the displayed list of LATA identifiers. LATA identifiers are defined in the US Local Exchange Routing Guide, published by Telcordia. This field is only valid if Attribute type is set to LATA. Range: 0 - 999. The default is 0. |
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:
|
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:
|
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, or for selection of an MF outgoing call profile if the call is transported over MF signaling. |
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:
|
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). Specifies whether the calling party fields in outgoing messages contain the Charge Number from the original call (instead of the Calling Party Number). Values:
|
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:
|
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:
|
Attribute value - billing - override AIN billing | Change | This field is visible 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:
|
Attribute value - force LNP lookup | Change | This field is visible 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 local to the NE. 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:
|
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. Specifies a prefix to be added to the called number in the ISUP IAM message. 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. 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. |
Attribute value - pseudo ANI egress signaling types | Change | This field is visible 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 applies only if the attribute Use Pseudo ANI (pANI) is also set. The default is to use Pseudo ANI on all signaling stack types. Values:
|
Attribute value - pseudo ANI presentation indicator | Change | This field is visible only if Attribute type is set to Pseudo ANI presentation indicator. Specifies the presentation indicator to be used with Pseudo ANI. This attribute applies only if the attribute Use Pseudo ANI (pANI) is also set. Values:
|
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. Specifies whether an ANI Screening lookup should be performed when processing this call, and if so how the lookup should be performed. Values:
|
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. Specifies the ANI Screening Table to be used for the ANI Screening lookup. 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 - number type for ANI lookup | Change | This field is visible only if Attribute type is set to Number type for ANI lookup. Specifies the type of number associated with the call 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:
|
Attribute value - Authorization Code Operation | Change | This field is visible 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:
|
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. 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 is visible 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:
|
Attribute value - Authorization Code | Change | This field is visible 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 is visible 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.
|
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 query ANI 1st preference | Change | Specifies the preferred method for determining the ANI used in non-geographic number (toll-free) lookups for an adjacent switch (from a combination of configured values and the ANI, if any, provided on the call). If the ANI information indicated by this attribute is not available, the following attributes 2nd preference and 3rd preference are used instead. Values:
|
Attribute value - IN query ANI 2nd preference | Change | 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 | 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. |
Requested status | Read only | Specifies whether an administrator has attempted to enable the Attribute Entry. Values:
|
Actual status | Read only | Specifies the current status of the Attribute Entry. Values:
|
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:
|
One announcement parameter:
|
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 |