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 all 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.

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 Inactive Unique user-friendly name identifying the test. Specify a name of up to 64 characters.
Called number Change Inactive The called number to set on messages used in this test. Specify the full national telephone number, without the leading zero.
Called address scope Change Inactive 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 Inactive Config Set over which the test should be run. 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 ISUP or SIP, then follow the dialogs to select the appropriate channel or trunk from the list. Media channels that support only outgoing calls cannot be used to match this action and do not appear in the list.
Operator hold allowed Change Inactive This field does not appear if the Remote media channel field specifies a SIP Trunk. Specifies whether operator hold is allowed on the call. Values:
  • True
  • False
Priority call Change Inactive This field does not appear if the Remote media channel field specifies a SIP Trunk. Indicates whether the call requires priority handling. Values:
  • True
  • False
Ignore Terminating Application Server Change Inactive 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.
Calling party number Change Inactive 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.
Calling number scope Change Inactive The area within which the calling number is unique. Values:
  • Unknown
  • International
  • National
  • Subscriber
Calling number presentation restricted Change Inactive Specifies any restrictions on presenting the calling number to the called subscriber. Values:
  • Allowed
  • Restricted
  • Number not available
  • No indication
Required retry routing Change Inactive Specifies whether alternative or continuous retry routing is required. Values:
  • Alternate routing allowed, continuous routing allowed
  • 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
Test call Change Inactive This field is hidden if Remote media channel specifies a SIP Trunk. Indicates whether the call is a test call. Values:
  • True
  • False
Operator call Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. Specifies whether the routing request is for an operator call. Values:
  • True
  • False
Echo cancellation Change Inactive Specifies the echo cancellation requirements associated with the Routing request. Values:
  • None
  • Required
  • Preferred
User defined MF call type Change Inactive This field is valid only in the US.
Calling category Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. 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.
Bearer capability Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. Specifies the bearer capability associated with the Routing request. Values:
  • Speech
  • 3.1kHz audio
  • 64kbps data
  • 64kbps restricted
  • 56kbps data
Originating exchange address Change Inactive
  • This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. Specifies the originating exchange address (a string of digits 0 - 9) associated with the Routing request. This corresponds to the ISUP Jurisdiction parameter and should be 6 digits long if present.
Ported number Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. Specifies the ported number associated with the Routing request. This is a 10-digit string of digits 0 - 9.
LNP lookup performed Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. Specifies whether an LNP lookup is to be performed as part of the Routing request. Values:
  • True
  • False
Release control mode Change Inactive This field does not apply in the UK.
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 local subscriber that does not exist.
  • System not fully active
    The test cannot be run because the system is not fully set up.
  • Canceled
    The test was canceled because an administrator used the "Cancel all tests" action in the parent Route Verification Test Group object.
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
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 - 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 - 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 - 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 Read only The user defined attribute 1 specified on the output from number validation.
Number validation - user defined attribute 2 Read only The user defined attribute 2 specified on the output from number validation.
Number validation - user defined attribute 3 Read only The user defined attribute 3 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 - 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
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 - 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 - 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
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 - operator call Read only Whether the output from the routing step specifies that the call is an operator call. Values:
  • True
  • False
Routing - routing control Read only Whether the output from the routing step specifies that alternative or continuous retry routing is required. Values:
  • Alternate routing allowed, continuous routing allowed
  • 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
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 - media channel Read only This field is valid only if the routing step was successful. Specifies the media channel over which the call is to be routed.
Routing - local subscriber type Read only This field is valid only if the routing step was successful and the Routing - media channel field indicates that the call is routed to another subscriber on the local exchange. Specifies the type of subscriber to which the call is to be routed. Values:
  • Individual Line
  • Business Group
  • Voicemail System
  • PBX
Routing - local subscriber number Read only This field is valid only if the routing step was successful and the Routing - media channel field indicates that the call is routed to another subscriber on the local exchange. 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
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 An optional diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII 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.