Trunk Route Verification Test

The Trunk Route Verification Test object is a child of a Route Verification Test Group object.

Each Trunk Route Verification Test simulates the validation and routing of an incoming call received over a trunk from a remote exchange.

Most of the modifiable fields in this object are also included in the parent RVT Group object, and the default values are taken from the settings in the parent object. You do not need to set these fields explicitly unless you want to use different values from those in the parent RVT Group. The only parameters that you need to set are the parameters specific to a particular test, such as the telephone number to be tested.

The Test result field and subsequent fields, which report the outcome of the test, are valid only after the test has been run. To run the test, click on the 'Run test' pushbutton.

The Expected result fields allow you to specify the results that you expect to get when running this test. If you configure an expected result, the operational status symbol next to this object in the EMS Tree View provides a quick view of whether the last run of the test was as expected:


You can change the values of parameters in this object at any time. However, if the test is running, and you change a parameter that could affect the results, the test is canceled.

Object-Specific Actions
Run test To run a Trunk Route Verification Test, click on the 'Run test' pushbutton. Note that this action is not available when the object is disabled.

Parameter

Access

Description
Test name Change Unique user-friendly name identifying the test. Specify a name of up to 64 characters.
Called number Change The called number to set on messages used in this test. This field can include digits 0 - 9 and/or the characters # and *.
Called address scope Change The called address scope to set on messages used in this test. Values:
  • Unknown (default)
  • International
  • National
  • Network specified
  • Subscriber
  • Abbreviated
  • Reserved 1
  • 950 Plus
  • No number
  • UK specific
Trunk Routing Config Set Change Config Set over which the test should be run. Choose Use default to use the default value specified in the parent RVT Group, or choose Specify value and select from the list of active Config Sets.
Remote media channel Change Remote media channel to be used as a match attribute in routing tables. Click on the ellipsis symbol to the right of this field to choose MF, ISDN, ISUP or SIP, then follow the dialogs to select the appropriate channel or trunk from the list. Media channels or ISDN PRIs that support only outgoing calls cannot be used to match this action and do not appear in the list.
SIP type Change This field appears only if Remote media channel specifies a SIP trunk. Set this field to indicate whether the trunk supports Basic SIP or SIP-T (to match the configuration of the selected trunk). Values:
  • Basic SIP (default)
  • SIP-T
Controlling ESA Protection Domain Change Specifies whether this test is to simulate operation in Emergency Standalone (ESA) mode, and if so the ESA Protection Domain from which the test is to simulate running. Select from the drop-down list of ESA Protection Domains, or select None: Main Call Agent in control to run the test normally (not in ESA mode).
Calling number ANI II digits Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk. The ANI II digits present for the calling number. This field is not mandatory, but if specified should be two digits long. If this field is not completed, the default value, 00, is used.
Operator hold allowed Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Specifies whether operator hold is allowed on the call. Values:
  • True
  • False
Priority call Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Indicates whether the call requires priority handling. Values:
  • True
  • False
Use TCAP if required Change This field describes whether TCAP queries are allowed for this routing test. If TCAP queries are required, and this field is set to False, the test result will be Query failed, and the TCAP Queries - Local Number Portability and TCAP Queries - Toll Free Lookup fields will give more detailed information describing exactly what query was required. Values:
  • True
  • False (default)
Ignore Terminating Application Server Change Specifies whether the call setup request should ignore the subscriber's Terminating Application Server, if one is configured, or should include routing to it. Values:
  • True
    Generate the call setup request without routing to the server.
  • False
    Include routing to the server as part of the generated call setup request.
Incoming trunk group ID Change The Trunk Group ID of the incoming media channel. This field must be set if Use TCAP if required is set to true. If Use TCAP if required is set to false, then this value makes no difference to the result of the test. Range: 0 - 9999.
Calling party number Change This field is hidden if Remote media channel specifies an MF Media Channel. The calling number on the signaling message associated with the Routing request. Specify the number as a string of digits 0-9, or leave this field blank to indicate that no number is to be provided. This field is required if a TCAP query is to be performed for local number portability or toll free lookup as part of this test, and must be set if Use TCAP if required is set to True.
Calling number scope Change This field is hidden if Remote media channel specifies an MF Media Channel. The area within which the calling number is unique. Values:
  • Unknown
  • International
  • National
  • Subscriber
Calling number presentation restricted Change This field is hidden if Remote media channel specifies an MF Media Channel. Specifies any restrictions on presenting the calling number to the called subscriber. Values:
  • Allowed
  • Restricted
  • Number not available
  • No indication
Test call Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Indicates whether the call is a test call. Values:
  • True
  • False
Operator call Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Specifies whether the routing request is for an operator call. Values:
  • True
  • False
Transit Network ID Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk. Identifier for the transit network to which the call should be routed.
Echo cancellation Change This field is hidden if Remote media channel specifies an MF Trunk. Specifies the echo cancellation requirements associated with the Routing request. Values:
  • None
  • Required
  • Preferred
User defined MF call type Change Specifies the User defined MF call type associated with the Routing request. Specify the call type as an integer value in the range 0 - 4294967295.
ISUP called address prefix Change This field 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.
Calling category Change This field appears only if the Remote media channel field specifies an ISUP Media Channel, or if the Remote media channel and SIP type fields specify a SIP-T Trunk. The type of call as indicated by the Calling Party Category parameter in the ISUP signaling flows. Values:
  • Unknown
    This value indicates that the ISUP signaling parameter explicitly states the category as unknown.
  • Ordinary calling subscriber
  • Calling subscriber with priority
  • Operator
  • Payphone
  • Test call
  • Emergency
  • High priority emergency
  • National Security and Emergency Preparedness (NS/EP)
  • OSS operator (UK only)
  • Admin Diversion - ordinary (UK only)
  • Admin Diversion - ordinary with priority (UK only)
  • Admin Diversion - payphone (UK only)
  • Admin Diversion - payphone with priority (UK only)
  • Other
    This value indicates a calling category that the MetaSwitch NE does not recognize.
Carrier identification parameter Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . The Carrier Identification Parameter (CIP) to be used for this test. Choose Use default to use the default value specified in the parent RVT Group, or choose Specify value and specify the CIP as a 4-digit number (with leading zeros if necessary). To run the test with no CIP (even if one was specified in the parent RVT Group), choose Specify value and leave this field blank.
Charge number (ANI) present Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Specifies whether a charge number (ANI) is associated with the Routing request. Values:
  • True
  • False
To indicate a zero-length ANI, set this parameter to True and leave the Charge number (ANI) field blank.
Charge number (ANI) Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Specifies the charge number (ANI) associated with the Routing request. This is a string of digits 0 - 9. To indicate a zero-length ANI, set Charge number (ANI) present to True and leave this field blank.
Bearer capability Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk , or if the Remote media channel field specifies an MF Media Channel. Specifies the bearer capability associated with the Routing request. Values:
  • Speech
  • 3.1kHz audio
  • 64kbps data
  • 64kbps restricted
  • 56kbps data
Originating exchange address Change This field does not appear if the Remote media channel and SIP type fields specify a Basic SIP Trunk, or if the Remote media channel field specifies an ISDN PRI . Specifies the originating exchange address (a 10-digit numeric string) associated with the Routing request. The use of this parameter depends on the Media Channel type:
  • For ISUP or SIP-T, this corresponds to the Jurisdiction parameter.
  • For MF, this is the originating LRN.
The default is no address present.
Ported number Change This field appears only if the Remote media channel and SIP type fields specify a SIP-T Trunk, or if the Remote media channel field specifies an ISUP Media Channel. Specifies the ported number associated with the Routing request. This is a 10-digit string of digits 0 - 9.
LNP lookup performed Change This field appears only if the Remote media channel and SIP type fields specify a SIP-T Trunk, or if the Remote media channel field specifies an ISUP Media Channel. Specifies whether an LNP lookup was performed in any part of the network before the call reached the MetaSwitch NE. Values:
  • True
  • False
Release control mode Change This field is hidden if Remote media channel specifies a Media Channel that is not MF. Specifies the release control mode associated with the Routing request: which party is responsible for releasing the call. Values:
  • Calling party
  • Called party
Dialed prefix Change This field appears only if the Remote media channel and SIP type fields specify a SIP-T Trunk, or if the Remote media channel field specifies an ISUP Media Channel. Specifies the dialed prefix associated with the Routing request. Values:
  • Unknown
  • 1+
  • 0+
  • 0-
  • None
Authorization Code - Code and PIN Change Indicates the authorization code and PIN, if any, associated with the Routing request. Specify the authorization code as a string of numeric digits, as it would be provided by the subscriber. If a PIN is required, append the 4 digits of the PIN to the end of the authorization code (without any spaces or other characters in between the code and PIN).
Authorization Code - Final Destination Number Change If the Routing request requires an authorization code followed by the final destination number, specify the final destination number (as a full directory number) in this field.
Included media channels - media channels included Change Specifies whether to run the test as though not all of the configured media channels are available. For example, you can use this field to simulate running the test in Emergency Standalone mode, in which only MF and SIP trunks connected to the Media Gateway in the specified ESA Protection Domain are available. Values:
  • All (default)
    Any configured media channel can be used in the test.
  • Specified
    Only the media channels specified in the following Included media channels - media channel fields can be used in the test.
  • All except specified
    Any media channel can be used in the test except for those specified in the following Included media channels - media channel fields.
  • None
    No media channel can be used in the test. It will complete successfully only if it is to a number on this switch and does not require trunk routing.
If this field is set to Specified or All except specified, you must set at least one of the following Included media channels - media channel fields to indicate one or more channels to be included or excluded. If you run this test and routing cannot be completed using the media channels that are permitted by the setting of these fields, the test will be marked as failed.
Included media channels - media channel 1 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. Click on the ellipsis symbol to the right of this field to choose whether to select from a list of MF Media Channels, ISDN trunk PRIs, ISUP Media Channels or SIP Trunks, then select the appropriate channel or trunk from the list. To remove the selected channel or trunk so that it is no longer included or excluded, select None.
Included media channels - media channel 2 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 3 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 4 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 5 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 6 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 7 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 8 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 9 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - media channel 10 Change This field appears only if Included media channels - media channels included is set to Specified or All except specified. A media channel to be included or excluded when running this test. If you need to select additional media channels to include or exclude, set this field as for Included media channels - media channel 1.
Included media channels - simulated incoming release cause Change Specifies whether to run the test as though it is a re-routing attempt because an earlier attempt to route the call over an ISUP or ISDN trunk failed. In general you should use this field in conjunction with the earlier Included media channels fields to exclude the trunk on which the earlier routing attempt would have failed. The valid values for this field, except for None and Use values on Test Group, are a subset of those defined in Q.850; the other values defined in Q.850 identify release causes for which re-routing is not appropriate, or are not appropriate to ISUP or ISDN trunks. Values:
  • None
    Run the test as though there is no release cause specified (for example on the first pass through routing).
  • 2 No route to specified transit network (national use)
  • 3 No route to destination
  • 34 No circuit / channel available
  • 41 Temporary failure
  • 42 Switching equipment congestion
  • 43 Access information discarded
  • 44 Requested circuit / channel not available
  • 46 Precedence call blocked
  • 47 Resource unavailable, unspecified
  • 58 Bearer capacity not presently available
  • 62 Inconsistency in outgoing information element
  • 63 Service or option not available, unspecified
  • 65 Bearer capability not implemented
  • 69 Requested facility not implemented
  • 70 Only restricted digital info bearer capability available
  • 79 Service option not implemented, unspecified
  • 88 Incompatible destination
  • 95 Invalid message, unspecified
  • 97 Message type non-existent or not implemented
  • 99 Info element / parameter non-existent or not implemented
  • 102 Recovery on timer expiry
  • 103 Parameter non-existent or not implemented - passed on
  • 111 Protocol error, unspecified
  • 127 Interworking, unspecified
  • Use values on Test Group
    Use the simulated incoming release cause, if any, specified on the parent Route Verification Test Group.
Included media channels - simulate media channels online Change Specifies whether the status of each Media Channel is checked when the test is run. Choose Use default or specify a value:
  • True
    The status of each Media Channel is not checked - all channels are assumed to be online.
  • False
    A Media Channel can be used for the test only if it is online.
Regardless of the setting of this field, the test still includes other admission control checks: for example, the Media Channel must exist, have suitable bearer capabilities, and support outgoing calls.
Test result Read only This field is valid only after the test has been run. To run the test, click on the 'Run test' pushbutton. This field indicates the status of the last test run. Note that if any of the previous fields have been modified since the last test was run, this field will be set to Not yet run. Values:
  • Not yet run
    The test has not been run yet, or one of more of the previous fields has changed since the test was last run.
  • Result pending
    The test is in progress.
  • Succeeded
    The test has run, and both the number validation and the routing succeeded.
  • Identified Call Service access code
    The test has run, and the routing component has identified the number dialed as a call service access code.
  • Not able to run
    The test was not able to run because the routing component is not in a suitable state to route requests.
  • Failed - number validation
    The test was run and number validation failed.
  • Failed - routing
    The test was run and routing failed.
  • Called number not found
    The routing component has determined that the call should be routed to a subscriber on this switch, but the subscriber does not exist.
  • System not fully active
    The test cannot be run because the system is not fully set up.
  • Query failed
    A TCAP query failed, or could not be made because Use TCAP if required was set to False.
  • Canceling
    The test is in the process of being canceled, either because an administrator used the "Cancel all tests" action in the parent Route Verification Test Group object or because one or more test values were changed.
  • Canceled
    The test was canceled.
Cause of failure Read only This field is valid only if Test result is set to Failed - number validation or Failed - routing. This field specifies the cause for either the number validation or routing failure. Values:
  • None
  • Incomplete digits
  • Address incomplete
  • Configuration inconsistent
  • Incomplete digit map
  • Number validation failed
  • Routing failed
  • Address not valid
  • Transit not valid
  • No route to address
  • No route to transit
  • Maximum number of routes tried
  • No route to address (congestion)
  • No route to transit (congestion)
  • LNP call misrouted
  • Unallocated number
  • Internal routing error
  • Temporary failure
  • Resource shortage
  • Call rejected
Expected result - expected result Change Specifies whether you expect this test to succeed or fail, and the failure mode if appropriate. Values:
  • Use values on Test Group (default)
    Use the default Expected results values specified on the parent Route Verification Test Group.
  • None
  • Succeeded
  • Identified Call Service access code
  • Failed - number validation
  • Failed - routing
  • Called number not found
  • Query failed
Expected result - expected destination Change This field appears only if Expected result - expected result is Succeeded. Specifies the destination or range of destinations to which you expect this test to route. Values:
  • Any media channel or on-switch subscriber (default)
    The test should be regarded as passed regardless of the chosen destination.
  • One of specified media channels
    The test should be regarded as passed only if it routes to a media channel specified in the following Expected results - media channel fields.
  • Any media channel except specified
    The test should be regarded as passed if it does not to a media channel specified in the following Expected results - media channel fields.
  • On-switch subscriber
    The test should be regarded as passed only if it routes to a subscriber on this switch.
Expected result - media channel 1 Change This field appears only if Expected results - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. Click on the ellipsis symbol to the right of this field to choose whether to select from a list of MF Media Channels, ISDN trunk PRIs, ISUP Media Channels or SIP Trunks, then select the appropriate channel or trunk from the list. To remove the selected channel or trunk so that it is no longer considered to be valid or not valid, select None.
Expected result - media channel 2 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for tests in this group, set this field as for Expected result - media channel 1.
Expected result - media channel 3 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 4 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 5 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 6 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 7 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 8 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 9 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - media channel 10 Change This field appears only if Expected result - expected destination is One of specified media channels or Any media channel except specified. A media channel considered to be valid or not valid for this test. If you need to select additional media channels considered to be valid or not valid for this test, set this field as for Expected result - media channel 1.
Expected result - cause of failure Change This field appears only if Expected result - expected result is Failed - number validation or Failed - routing. The expected cause for either the number validation or routing failure. Values:
  • None
  • Incomplete digits
  • Address incomplete
  • Configuration inconsistent
  • Incomplete digit map
  • Number validation failed
  • Routing failed
  • Address not valid
  • Transit not valid
  • No route to address
  • No route to transit
  • Maximum number of routes tried
  • No route to address (congestion)
  • No route to transit (congestion)
  • LNP call misrouted
  • Unallocated number
  • Internal routing error
  • Temporary failure
  • Resource shortage
  • Call rejected
Expected result - result as expected Read only This field does not appear if Expected result - expected result is None, or if it is Use values on Test Group and the parent Test Group's value is None. Indicates whether the result of the last run of this test matched the expected result. Values:
  • Yes
  • No
  • Not yet run to completion
    The test has not been run to completion since its configuration parameters were last changed.
Number validation - ANI II digits Read only The ANI II digits specified on the output from number validation.
Number validation - modified called number Read only The modified called number specified on the output from number validation.
Number validation - modified calling party number Read only The modified calling party number specified on the output from number validation.
Number validation - modified charge number Read only The modified charge number specified on the output from number validation.
Number validation - carrier selection method Read only The carrier selection method specified on the output from number validation. This indicates how the carrier for the call was selected; it is not included when a carrier is selected implicitly (800, 900-NXX, ...) rather than explicitly by the caller. Values:
  • Unspecified
  • Presubscribed
  • Presubscribed and input
  • Presubscribed, may have been input
  • Input
Number validation - call hold allowed Read only Whether the output from number validation specifies that holding the call is allowed. Values:
  • True
  • False
Number validation - release control mode Read only The release control mode for the call specified on the output from number validation. Values: Values:
  • Calling party
  • Called party
  • Last party
Number validation - restricted line 950 call Read only Whether the output from number validation specifies that the call is to a 950-XXXX number from a restricted line. Values:
  • True
  • False
Number validation - test call Read only Whether the output from number validation specifies that the call is a test call. Values:
  • True
  • False
Number validation - tone or announcement ID Read only The tone or announcement ID specified on the output from number validation.
Number validation - tone or announcement parameter 1 Read only The tone or announcement parameter 1 specified on the output from number validation.
Number validation - tone or announcement parameter 2 Read only The tone or announcement parameter 2 specified on the output from number validation.
Number validation - Transit Network ID Read only The Transit Network ID specified on the output from Number validation.
Number validation - echo cancellation Read only Whether the output from number validation specifies that echo cancellation is required for the call. Values:
  • None
  • Preferred
  • Required
Number validation - user defined attribute 1 - 20 Read only This field appears once for each User Defined Attribute that you have configured below the Trunk Routing and Policy Services object. The user defined attributes specified on the output from number validation.
Number validation - user defined MF call type Read only The User defined MF call type specified on the output from number validation.
Number validation - message billing index Read only The message billing index specified on the output from number validation.
Number validation - use Pseudo ANI (pANI) Read only Whether the output from number validation specifies that the calling party fields in outgoing messages contain the Charge Number from the original call (instead of the Calling Party Number). Values:
  • Never
  • Only when no calling number
  • Always
Number validation - pseudo ANI egress signaling types Read only This field does not appear if Number validation - use Pseudo ANI (pANI) is Never. The types of outgoing signaling stack for which Pseudo ANI is to be used, as specified on the output from number validation. Values:
  • ISUP
  • ISDN access
  • ISDN trunk
  • SIP access
  • SIP trunk
  • Analog
Number validation - pseudo ANI presentation indicator Read only This field does not appear if Number validation - use Pseudo ANI (pANI) is Never. The presentation indicator to be used with Pseudo ANI, as specified on the output from number validation. Values:
  • Restricted (default)
  • Available
Number validation - billing call type Read only The billing call type attribute, if any, specified on the output from number validation. Values:
  • 1
  • 5
  • 6
  • 9
  • 33
  • 47
  • 88
  • 110
  • 119
  • 131
  • 132
  • 134
  • 141
  • 142
  • 710
  • 711
  • 720
  • 721
  • 800 - 999
Number validation - billing structure code Read only The billing structure code attribute, if any, specified on the output from number validation. Values:
  • 1
  • 20
  • 28
  • 79
  • 220
  • 360
  • 364
  • 500
  • 625
  • 653
Number validation - override AIN billing Read only Whether the output from number validation specifies that the structure code and call type in AIN billing records for this call should be overridden with the configured values. Values:
  • Yes
  • No
Number validation - ISUP called address prefix Read only This field is used only for long-distance calls in Canada that are routed over ISUP trunks, and is not required for deployments elsewhere. Specifies the prefix, if any, added to the called number in the ISUP IAM message.
Number validation - calling category Read only The calling category, if any, specified on the output from number validation. Values:
  • Unknown
    This value indicates that the ISUP signaling parameter explicitly states the category as unknown.
  • Ordinary calling subscriber
  • Calling subscriber with priority
  • Operator
  • Payphone
  • Test call
  • Emergency
  • High priority emergency
  • National Security and Emergency Preparedness (NS/EP)
  • OSS operator (UK only)
  • Admin Diversion - ordinary (UK only)
  • Admin Diversion - ordinary with priority (UK only)
  • Admin Diversion - payphone (UK only)
  • Admin Diversion - payphone with priority (UK only)
  • Other
    This value indicates a calling category that the MetaSwitch NE does not recognize.
Number validation - FGD carrier ID Read only The 4-digit carrier ID, if any, specified on the output from number validation.
Number validation - called address scope Read only The called address scope, if any, specified on the output from number validation. Values:
  • Unknown
  • International
  • National
  • Network specified
  • Subscriber
  • Abbreviated
  • Reserved 1
  • 950 Plus
  • No number
  • UK specific
Number validation - ANI Screening lookup type Read only The type of ANI Screening lookup, if any, specified on the output from number validation. Values:
  • None
    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 Number validation - ANI Screening lookup table to perform the lookup (without checking the Transit Network ID).
Number validation - ANI Screening lookup table Read only This field applies only if Number validation - ANI Screening lookup type is set to Lookup in specific table. Specifies the ANI Screening Table to be used for the ANI Screening lookup.
Number validation - Number type for ANI lookup Read only The ANI lookup number type, if any, specified on the output from number validation. This identifies 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:
  • 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.
Number validation - Number used for ANI lookup Read only The number that was used for ANI lookup, if any, specified on the output from number validation.
Number validation - Matched ANI Screening Entry type Read only The type of ANI Screening match, if any, specified on the output from number validation. Values:
  • Not matched
    No ANI Screening Entry was matched.
  • Allowed
    The call matched an Allowed ANI Screening Entry.
  • Denied
    The call matched a Denied ANI Screening Entry.
Number validation - Matched ANI Screening Entry Read only This field does not appear if Number validation - Matched ANI Screening Entry type is set to Not matched. The name of the ANI Screening Entry that was matched in number validation.
Number validation - Authorization Code Operation Read only The authorization code operation required for this call, if any, determined in number validation. Values:
  • None
    No authorization code is required.
  • No Validation
    The authorization code specified in Number Validation - Authorization Code Prefix is used 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 to make the call, and the following fields define how this code is validated.
Number validation - Authorization Code Table Read only This field appears only if Number validation - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. The authorization code table used for this call, if any, determined in number validation.
Number validation - Valid Authorization Codes Read only This field applies only if Number validation - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. The authorization code matching required for this call, if any, determined in number validation. Values:
  • Any code in table
    The subscriber can use any authorization code in the table specified by Number Validation - Authorization Code Table.
  • Specific code
    The subscriber must use a specific authorization code.
Number validation - Authorization Code Prefix Read only The authorization code prefix required for this call, if any, determined in number validation. The use of this field depends on the setting of Number validation - 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 is 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.
Number validation - maximum call duration Read only The maximum call duration, if any, specified on the output from number validation.
Number validation - outgoing release cause Read only The outgoing release cause, if any, specified on the output from number validation. For a full list of the valid values, see the Attribute value - outgoing ISUP/ISDN release cause field in the Attribute Entry object.
Routing - test call Read only Whether the output from the routing step specifies that the call is a test call. Values:
  • True
  • False
Routing - modified called number Read only The modified called number specified on the output from the routing step.
Routing - modified calling party number Read only The modified calling party number specified on the output from the routing step.
Routing - modified charge number Read only The modified charge number specified on the output from the routing step.
Routing - operator call Read only Whether the output from the routing step specifies that the call is an operator call. Values:
  • True
  • False
Routing - tone or announcement ID Read only The tone or announcement ID specified on the output from the routing step.
Routing - tone or announcement parameter 1 Read only The tone or announcement parameter 1 specified on the output from the routing step.
Routing - tone or announcement parameter 2 Read only The tone or announcement parameter 2 specified on the output from the routing step.
Routing - Transit Network ID Read only The Transit Network ID specified on the output from the routing step.
Routing - media channel Read only This field appears only if the routing step was successful and the call is not routed to a subscriber on this switch. Specifies the media channel over which the call is to be routed (MF Trunk, ISUP trunk, ISDN PRI, or SIP trunk), or specifies Announcement service if the call is routed to an announcement.
Routing - on-switch subscriber type Read only This field appears only if the routing step was successful and the call is routed to another subscriber on this switch. Specifies the type of subscriber to which the call is to be routed. Values:
  • Individual Line
  • Business Group
  • Voicemail
    SMDI voicemail system
  • PBX
  • SIP
    Application Server or SIP voicemail system
Routing - on-switch subscriber number Read only This field appears only if the routing step was successful and the call is routed to another subscriber on this switch. Specifies the directory number to which the call is to be routed.
Routing - echo cancellation Read only Whether the output from the routing step specifies that echo cancellation is required for the call. Values:
  • None
  • Preferred
  • Required
TCAP queries - Local Number Portability Read only The result of any TCAP queries for local number portability. Values:
  • Failed - resource allocation failure
  • Failed - parameter information unavailable
  • Failed - TCAP failure
  • Not required
  • Successful (no Automatic Code Gapping)
  • Successful (encountered Automatic Code Gapping)
  • Not attempted - restriction on current call
  • Not attempted - Automatic Code Gapping controls in place
  • Failed - bad response
  • Failed - timeout
TCAP queries - Toll Free Lookup Read only The result of any TCAP queries for toll free lookup. Values:
  • Failed - resource allocation failure
  • Failed - parameter information unavailable
  • Failed - TCAP failure
  • Not required
  • Successful (no Automatic Code Gapping)
  • Successful (encountered Automatic Code Gapping)
  • Not attempted - restriction on current call
  • Not attempted - Automatic Code Gapping controls in place
  • Failed - bad response
  • Failed - timeout
Routing - FGD carrier ID Read only The 4-digit carrier ID, if any, specified on the output from routing.
Routing - charge number (ANI) present Read only Indicates whether the output from routing specified that a charge number (ANI) was present. Values:
  • True
  • False
Routing - charge number (ANI) Read only Indicates the charge number (ANI), if any, specified on the output from routing. This is a string of digits 0 - 9. If Charge number (ANI) present is True but this field is blank, this indicates a zero-length ANI.
Routing - dialed prefix Read only Indicates the dialed prefix, if any, specified on the output from routing. Values:
  • Unknown
  • 1+
  • 0+
  • 0-
  • None
Routing - maximum call duration Read only The maximum call duration, if any, specified on the output from the routing step.
Diagnostics - logging - log level Change Specifies the level of logs recorded for this object. Logs with a priority equal to or greater than the priority specified are recorded. Set to Default level to use the system-wide default level. Values:
  • Level 10 (diagnostics)
  • Level 20 (verbose statistics)
  • Level 30 (verbose operational)
  • Level 40 (statistics)
  • Level 50 (audit)
  • Level 60 (operational)
  • Level 70 (unexpected)
  • Level 80 (error)
  • Level 90 (fatal)
  • Default level (default)
Diagnostics - API trace - trace tag Change you want to filter on this tag in the craft interface, do not include spaces or any of the characters ^ \ $ * + ? | ( ) , . ' ' " [ ] { }.
Requested status Read only Specifies whether an administrator has attempted to enable the Trunk Route Verification Test. 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 Trunk Route Verification Test object. Values:
  • Enabled
    The object is enabled.
  • Disabled
    The object has not been enabled or has been disabled.