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.
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 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.
Calling number ANI II digits Change Inactive This field does not appear if the Remote media channel field specifies a 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 Inactive This field does not appear if the Remote media channel field specifies a SIP or ISDN 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 or ISDN Trunk. Indicates whether the call requires priority handling. Values:
  • True
  • False
Use TCAP if required Change Inactive 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 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.
Incoming trunk group ID Change Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive This field is hidden if Remote media channel specifies a SIP or ISDN 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 MF or ISUP. Specifies whether the routing request is for an operator call. Values:
  • True
  • False
Transit Network ID Change Inactive This field is hidden if Remote media channel specifies a SIP Trunk. Identifier for the transit network to which the call should be routed.
Echo cancellation Change Inactive 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 Inactive 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 Inactive 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 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.
FGD carrier ID Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not MF or ISUP. The 4-digit carrier ID associated with the Routing request. Leave this field blank to indicate no carrier ID.
Charge number (ANI) present Change Inactive This field is hidden if Remote media channel specifies a Media Channel that is not MF or ISUP. 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 Inactive This field is hidden if Remote media channel specifies a Media Channel that is not MF or ISUP. 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 Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISDN or 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 MF or ISUP. Specifies the originating exchange address (a string of digits 0 - 9) associated with the Routing request. The use of this parameter depends on the Media Channel type:
  • For ISUP, this corresponds to the Jurisdiction parameter and should be 6 digits long if present.
  • For MF, this is the originating LRN and should be 10 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 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 Inactive This field is hidden if Remote media channel specifies a Media Channel that is not ISUP. Specifies the dialed prefix associated with the Routing request. Values:
  • Unknown
  • 1+
  • 0+
  • 0-
  • None
Authorization Code - Code and PIN Change Inactive 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 Inactive 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.
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.
  • Query failed
    A TCAP query failed, or could not be made because Use TCAP if required was set to False.
  • 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 - 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. 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 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 - user defined MF call type Change Inactive 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
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 local 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 applies 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 area code so that the subscriber need only enter the local number.
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 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
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
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.