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:

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 Inactive Unique user-friendly name identifying the test group. Specify a name of up to 64 characters.
Trunk Routing Config Set Change Inactive Config Set over which the tests should be run. Select from the list of active Config Sets.
Subscriber type Change Inactive Specifies whether the Dialed number is for a configured subscriber or a hypothetical subscriber. Values:
  • Configured
  • Hypothetical
Controlling ESA Protection Domain Change Inactive Specifies whether tests in this group are 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).
Subscriber directory number Change Inactive This field is valid only if Subscriber type is Configured. Directory number of the Individual Line or PBX from which to simulate dialing. Either type in the number (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 Inactive 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.
Billing type Change Inactive This field is valid only if Subscriber type is Hypothetical. The billing type for the hypothetical subscriber for local calls. Values:
  • Flat rate billing
  • Message rate billing
  • FX rate billing
Long distance carrier ID Change Inactive This field is valid only if Subscriber type is Hypothetical. The long distance carrier ID used by default for the hypothetical subscriber. This field may be left blank if you wish to simulate a situation in which the subscriber has not subscribed to a long distance carrier.
Local carrier ID Change Inactive This field is valid only if Subscriber type is Hypothetical. The local carrier ID used by default for the hypothetical subscriber. This field may be left blank if you wish to simulate a situation in which the subscriber has not subscribed to a local carrier.
International carrier ID Change Inactive This field is valid only if Subscriber type is Hypothetical. The international carrier ID used by default for the hypothetical subscriber. This field may be left blank if you wish to simulate a situation in which the subscriber has not subscribed to an international carrier.
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 MF Media Channels, ISDN trunk PRIs, ISUP Media Channels or SIP Trunks, then 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 Inactive 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
Calling number ANI II digits Change Inactive 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 Specifies whether operator hold is allowed on the call. Values:
  • True
  • False
Priority call Change Inactive Indicates whether the call requires priority handling. Values:
  • True
  • False
Use TCAP if required Change Inactive This field describes whether TCAP queries should be used for this routing test. Values:
  • True
  • False (default)
Ignore Originating Application Server Change Inactive 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 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. Range: 0 - 9999.
Calling party number Change Inactive The calling number on the ISUP message. This field is required if a successful TCAP query is to be performed for local number portability or toll free lookup as part of this test. 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 (default)
  • Subscriber
Calling number presentation restricted Change Inactive Specifies any restrictions on presenting the calling number to the called subscriber. Values:
  • Allowed (default)
  • Restricted
  • Number not available
  • No indication
Test call Change Inactive Indicates whether the call is a test call. Values:
  • True
  • False
Operator call Change Inactive Specifies whether the routing request is for an operator call. Values:
  • True
  • False (default)
Transit Network ID Change Inactive Identifier for the transit network to which the call should be routed.
Echo cancellation Change Inactive Specifies the echo cancellation requirements associated with the Routing request. Values:
  • None (default)
  • Required
  • Preferred
Line Class Code 1 - 20 Change Inactive 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.
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 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.
FGD carrier ID Change Inactive The 4-digit carrier ID associated with the Routing request. Leave this field blank to indicate no carrier ID (this is the default).
Charge number (ANI) present Change Inactive Specifies whether a charge number (ANI) is associated with the Routing request. Values:
  • True
  • False (default)
To indicate a zero-length ANI, set this parameter to True and leave the Charge number (ANI) field blank.
Charge number (ANI) Change Inactive 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 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 Inactive 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.
  • For ISDN or Basic SIP, this parameter is not used.
The default is no address present.
Ported number Change Inactive 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 Inactive Specifies whether an LNP lookup is to be performed as part of the Routing request. Values:
  • True
  • False (default)
Release control mode Change Inactive Specifies the release control mode associated with the Routing request: which party is responsible for releasing the call. Values:
  • Calling party (default)
  • Called party
Dialed prefix Change Inactive Specifies the dialed prefix associated with the Routing request. Values:
  • Unknown (default)
  • 1+
  • 0+
  • 0-
  • None
User defined MF call type Change Inactive Indicates the User defined MF call type associated with the Routing request. Specify the call type as an integer value in the range 0 - 4294967295.
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.
Included media channels - media channels included Change Inactive 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 local number 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 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 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.
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
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 Inactive 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 Inactive 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 local 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.
  • Local subscriber
    The test should be regarded as passed only if it routes to a local subscriber.
Expected results - media channel 1 Change Inactive 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 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 results - media channel 2 Change Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive 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 Inactive 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 diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII 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
  • In progress
  • Succeeded
  • Failed
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.