Route Verification Test Group

The Route Verification Test Group object is a child of the Route Verification Tests object.

Each Route Verification Test Group allows you to set default parameter values for a group of trunk and/or subscriber route verification tests. This means that, for each individual test in the group, you simply need to set up a small number of parameters specific to each test (such as the telephone number to be tested). You can also modify the other parameters in the test if you need them to be different from the parent test group, but there is no need to do this if you simply want to use the defaults set up in the parent test group.

If you have filled in the Expected result fields on one or more tests in this group, to specify the results that you expect to get when running each test, the operational status symbol next to the Route Verification Test Group object in the EMS Tree View provides a quick view of whether the last run of the tests was as expected:


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

Object-Specific Actions
Run all tests To run all the Trunk Route Verification Tests and Subscriber Route Verification Tests that are children of this Test Group, click on the 'Run all tests' pushbutton. Note that this action is not available when the object is disabled.
Cancel all tests To cancel the currently running test and abandon any other tests in the group that have not yet been run, click on the 'Cancel all tests' pushbutton. Note that this action is not available when no tests are running.

Parameter

Access

Description
Test name Change Unique user-friendly name identifying the test group. Specify a name of up to 64 characters.
Default trunk routing config set Change Config Set over which tests in this group should be run. You can override this for a specific test if necessary. Select from the list of active Config Sets.
Default subscriber type Change Specifies whether the Dialed number in tests in this group identifies a configured subscriber or a hypothetical subscriber. You can override this for a specific test if necessary. Values:
  • Configured
  • Hypothetical
Default subscriber directory number Change Directory number of the Individual Line or PBX from which to simulate dialing for tests in this group. You can override this for a specific test if necessary. Either type in the number, including the leading zero (which must match the directory number of a configured Individual Line or PBX), or click on the ellipsis symbol to the right of this field to select from a list of configured directory numbers.
Subscriber Group Change This field is valid only if Subscriber type is Hypothetical. Subscriber Group to which the hypothetical subscriber belongs. Select from the list of configured Subscriber Groups.
Subscriber NV and routing attributes Change This field is valid only if Subscriber type is Hypothetical. Subscriber routing attributes for the hypothetical subscriber. If required, select one or more of the following values:
  • Pre-paid / off-switch calling card subscriber
  • Fax / modem subscriber
  • Nomadic subscriber
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 whether to select from a list of ISUP Media Channels or SIP Trunks, then 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.
SIP type Change Set this field to indicate whether SIP trunks used by tests in this group support Basic SIP or SIP-T. Values:
  • Basic SIP (default)
  • SIP-T
Operator hold allowed Change Specifies whether operator hold is allowed on the call. Values:
  • True
  • False (default)
Priority call Change Indicates whether the call requires priority handling. Values:
  • True
  • False (default)
Ignore Originating Application Server Change This field is valid only if Subscriber type is Configured. Specifies whether the call setup request should ignore the subscriber's Originating 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.
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.
Calling party number Change The calling number on the ISUP message. 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 The area within which the calling number is unique. Values:
  • Unknown
  • International
  • National (default)
  • Subscriber
Calling number presentation restricted Change Specifies any restrictions on presenting the calling number to the called subscriber. Values:
  • Allowed (default)
  • Restricted
  • Number not available
  • No indication
Required retry routing Change 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 Indicates whether the call is a test call. Values:
  • True
  • False (default)
Operator call Change Specifies whether the routing request is for an operator call. Values:
  • True
  • False (default)
Echo cancellation Change Specifies the echo cancellation requirements associated with the Routing request. Values:
  • None (default)
  • Required
  • Preferred
Line Class Code 1 - 20 Change This field is valid only if Subscriber type is Hypothetical. It appears once for each Line Class Code that you have configured below the Trunk Routing and Policy Services object. The Line Class Code value used for the hypothetical subscriber. Specify an integer value in the range 0 - 2147483646. The default is 0. Alternatively, for a validated Line Class Code, you can select a specific value from the list of valid values by clicking on the ellipsis symbol at the end of the field. Either scroll down the alphabetic list of code value descriptions to select the value you want, or type the first few letters of the code's description so that the alphabetic list scrolls to select the entry you want.
Calling category Change The type of call as indicated by the Calling Party Category parameter in the ISUP signaling flows. Values:
  • Unknown (default)
    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 Specifies the bearer capability associated with the Routing request. Values:
  • Speech (default)
  • 3.1kHz audio
  • 64kbps data
  • 64kbps restricted
  • 56kbps data
Originating exchange address Change 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 Basic SIP, this parameter is not used.
The default is no address present.
Ported number Change Specifies the ported number associated with the Routing request. This is a 10-digit string of digits 0 - 9, or blank (the default) to specify no ported number.
LNP lookup performed Change This field does not apply in the UK.
Release control mode Change This field does not apply in the UK.
Included media channels - media channels included Change Specifies whether to run the test as though not all of the configured media channels 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 the 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 a test in this group 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 tests in this group. Click on the ellipsis symbol to the right of this field to choose whether to select from a list of 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 tests in this group. 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 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, 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 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
Included media channels - simulate media channels online - default Change Specifies whether the status of each Media Channel is checked when a child Route Verification Test is run. You can override this for a specific test if necessary. Values:
  • True
    The status of each Media Channel is not checked - all channels are assumed to be online.
  • False (default)
    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.
Number of tests Read only The number of Route Verification Test objects that are children of this Test Group.
Group test status Read only The progress or outcome of the last group test executed for this test group. Values:
  • Not run
  • In progress
  • Complete
  • Canceled
  • Canceling
If you have changed the value of one or more fields in this object since the last test was run, this field is set to Not run because no tests have been executed since the current field values were set.
Number of tests executed Read only The number of child RVT tests that have been completed during the current, most recently completed, or most recently canceled group test. If you have changed the value of one or more fields in this object since the last test was run, this field does not appear because no tests have been executed since the current field values were set.
Number of tests succeeded Read only The number of child RVT tests that completed successfully during the current, most recently completed, or most recently canceled group test. If you have changed the value of one or more fields in this object since the last test was run, this field does not appear because no tests have been executed since the current field values were set.
Number of tests failed Read only The number of child RVT tests that did not complete successfully during the current, most recently completed, or most recently canceled group test. If you have changed the value of one or more fields in this object since the last test was run, this field does not appear because no tests have been executed since the current field values were set.
Expected results - expected result Change Specifies whether you expect tests in this group to succeed or fail, and the failure mode if appropriate. Values:
  • None (default)
  • Succeeded
  • Identified Call Service access code
  • Failed - number validation
  • Failed - routing
  • Called number not found
  • Query failed
Expected results - expected destination Change This field appears only if Expected results - expected result is Succeeded. Specifies the destination or range of destinations to which you expect tests in this group 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 results - 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 tests in this group. Click on the ellipsis symbol to the right of this field to choose whether to select from a list of 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 results - media channel 2 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 3 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 4 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 5 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 6 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 7 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 8 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 9 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 tests in this group. 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 results - media channel 1.
Expected results - media channel 10 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 tests in this group. 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 results - media channel 1.
Expected results - cause of failure Change This field appears only if Expected results - 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 results - number of validated tests not yet run Read only The number of child RVT tests for which an expected result is defined that have not been run since their configuration parameters were last changed.
Expected results - number of validated tests passed Read only The number of child RVT tests for which an expected result is defined that have been run and produced the expected result.
Expected results - number of validated tests failed Read only The number of child RVT tests for which an expected result is defined that have been run and did not produce the expected result.
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 text string inserted into API tracing and PD logging for this object. (This string can include accented / international characters as defined in ISO 8859-1.) If you want to filter on this tag in the craft interface, do not include spaces or any of the characters ^ \ $ * + ? | ( ) , . ' ' " [ ] { }.
Export - number of objects exported Read only The total number of objects (including child objects) written to the export file so far in the current or most recent export operation.
Export - status Read only The status of the current or most recent export operation, if any. Values:
  • None
    No export has been attempted. Use the export pushbutton to start it.
  • In progress
    Export is in progress. Do not attempt to access the export file until the status has changed to Succeeded.
  • Succeeded
    Export completed successfully.
  • Failed
    Export failed. Check the Export - log correlator field for more details.
  • Partially failed
    A field in the configuration of the exported object or one of its child objects was not valid. Typically this is because a referenced object has been deleted. Either check and correct the configuration before retrying the export, or correct the error in the exported file before attempting to re-import it.
Export - file Change The name of the text file (in the EMS User's home directory on the EMS Server) to which configuration information for this object will be exported. The maximum length of the filename is 32 characters.
Export - log correlator Read only If the export status is Failed, this field contains a correlator for the log message that contains details of the failure. Click on the 'go to log' button next to this field to jump to this message in the EMS log viewer window.
Export - correlator metaswitch Read only If the export status is Failed, this field contains the name of the EMS Server or MetaSwitch Network Element that generated the failure log. You may need this information to find the log in the EMS log viewer window.
Requested status Read only Specifies whether an administrator has attempted to enable the Route Verification Test Group. 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 Route Verification Test object Group. Values:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.