Versions Compared

Old Version 5

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

The Digit Parameter Handling feature

Noprint
Panel
borderColorgreen
bgColortransparent
borderWidth2

Back to Table of Contents

Back to CLI Configure Mode

Back to Profiles - CLI

Section
Column
Panel

In this section:

Table of Contents
maxLevel2

 

This object allows you to configure criteria for applying DM/PM (digit manipulation/parameter manipulation) rules. You can also use this entity to define criteria for applying URI manipulation rules.

...

There is also a URI parameter type used to match the contents of the specified URI type.

Note

The following entities are not available when the SBC is configured for ePSX.

  • dmPmCriteria
  • dmPmRule
  • numberTranslationCriteria
  • prefixProfile

Command Syntax

 

Code Block
languagenone
% set profiles digitParameterHandling 
	dmPmCriteria <dmPmCriteria_id>  
	dmPmRule <dmPmRule_id> 
	numberTranslationCriteria <numberTranslationCriteria> 
	numberingPlan <numberingPlan> 
	prefixProfile <prefixProfile>

DM/PM Criteria:

Code Block
languagenone
% set profiles digitParameterHandling dmPmCriteria
	<dmPmCriteria_id> 
	criteriaType <digit | parameter | uri> 
	parameterPresenceCheck <doesntExist | exists> 
	uriCriteria 
		host 
			operation <equals | ignore | notEquals> 
			value <0-64 chars> 
		presentationMatch 
			operation <equals | ignore | notEquals> 
			value <allowed | none | numberUnavailable | restricted | spare>
		userInfo 
			operation <equals | ignore | notEquals> 
			value 
				matchValue <0-64 chars> 
				startCharacterPosition <0-63 chars> 
		validateUserInfoDigits <equals | ignore | notEquals> 
	uriType <calledUri | callingUri | fromUri | paiSipUri | toUri> 
 

DM/PM Rule:

Div
classpdf6pttext
Code Block
languagenone
% set profiles digitParameterHandling dmPmRule <dmPmRule_id> 
	subRule <0-9> 
		criteria <dmPmCriteria_id> 
		ruleType 
			digit digitManipulation 
				digitStringManipulation 
					action 
						<addDestinationCountry | addIngressTrunkGroupCountry | addOriginatingCountry | none>
					numberOfDigits 
					replacement 
					startDigitPosition 
				numberParameterManipulation 
				numberType 
			parameter 
			uri 
		uriParameterManipulation 
			hostPortManipulation 
			uriParameterManipulation 
			uriType 
			userInfoManipulation 
		digitManipulation 
			digitStringManipulation 
				action <addDestinationCountry | addIngressTrunkGroupCountry | addOriginatingCountry | none> 
				numberOfDigits <0-30> 
				replacement 
					digitString <252 | 253 | 254 | billingNumber | calledDirectoryNumber | calledInNumber | calledNumber | 
						calledUri | callingName | callingNumber | callingUri | causeOfNoId | contractorNumberdialedNumber | 
						fromUri | gnAdditionalCalled | gnAdditionalCalling | gnAdditionalConnected | gnAdditionalOriginalCalled | 
						gnAdditionalRedirecting | gnAdditionalRedirection | gnCalledCesId | gnCollectCallNumber | gnDestination | 
						gnDialedDigits | gnLocalAni | gnNetworkProvidedNumber | gnPortedDialed | gnRedirectingTerminating | 
						gnThirdPartyNumber | gnUserCallingNotScreened | gnUserCallingScreened | location | none | 
						originalCalledNumber | outpulseNumber | paiSipDisplayName | paiSipUri | paiTelDisplayName | 
						presentationNumber | pretranslated | redirecting | redirection | sipFromDisplayName | toUri | twoStageCollected> 
					numberOfDigits <0-30> 
					startDigitPosition <0-29> 
					type <constant | variable> 
					value <0-64 chars> 
				startDigitPosition <0-29> 
			numberParameterManipulation 
				includeInEgress <discardInEgress | includeInEgress | none> 
				natureOfAddress <noa_name> 
				numberLength <0-30, noInput> 
				numberingPlanIndicator 
					<data | ignore | isdn | none | offsetUnused | private | spare0Unknown | spare1 | spare2 | spare3 | spare4 | 
					spare5 | spare6 | spare7 | telephony | telex> 
				presentation <allowed | none | numberUnavailable | restricted | spare> 
				screening <networkProvidedNotScreened | 
					none | userProvidedFailedNetworkScreening | userProvidedNotScreened | userProvidedPassedNetworkScreening> 
			numberType <billingNumber | calledDirectoryNumber | 
					calledNumber | callingNumber | contractorNumber | gnAdditionalCalled | gnAdditionalCalling | gnAdditionalConnected | 
					gnAdditionalOriginalCalled | gnAdditionalRedirecting | gnAdditionalRedirection | gnCalledCesId | gnDestination | 
					gnDialedDigits | gnNQI-252 |  | gnNQI-253 | gnNQI-254 | gnNetworkProvidedNumber | gnPortedDialed | gnRedirectingTerminating | 
					gnUserCallingNotScreened | gnUserCallingScreened | location | originalCalledNumber | outpulseNumber | pretranslated | redirecting | 
					redirection | twoStageCollected> 
			ruleType <digit | parameter | uri> 
 

 

Number Translation Criteria:

Code Block
languagenone
% set profiles digitParameterHandling 
	numberTranslationCriteria <trigger_criteria_id>
	calledUri
	callingNumber 
	carrier 
	none
	toHeader
	trunkGroup 

Each of the above parameters (except 'none') use following options: 
		<element_id_1> 
		<element_id_1> 
		<national_code> 
		<country_code> 
		lookupType <e911 | enumCnam | enumLnp | enumSipAor>

Numbering plan:

Code Block
languagenone
% set profiles digitParameterHandling numberingPlan 
	<numberPlan_id> 
	lengths 
		areaCode 
		exchangeCode 
		line 
		nationalNumber 
		subscriberNumber  

Each of the above parameters uses following sub-parameters:
	 max <0-999> 
	 min <0-999>

Prefix Profile:

Code Block
languagenone
% set profiles digitParameterHandling prefixProfile 
	<prefixProfile>
	entry <matching pattern: + +86 00 01 1 02 2 03 3 04 4 05 5 06 6 07 7 08 8 09 9 110 113 114 115 116 119 120 176>

Command Parameters

The following parameters are defined in this section:

Table of Contents
maxLevel3
minLevel3

DM/PM Criteria Parameters

Div
classpdf6pttext
Caption
0Table
1DM/PM criteria parameters
 

Parameter

Length/Range

Description

dmPmCriteria

N/A

Specifies the name of a DM/PM criteria, which can be assigned to one or more DM/PM rules.

  • <unique DM/PM Criteria name> – Select an existing rule or enter a new name.
  • criteriaType – Select the type of manipulation to occur:
    • digit – (default)
    • parameter
    • uri
  • digitCriteria – The criteria for applying DM/PM rules.
  • digitMatch
    • operation 
      • equals – Criterion applies if the designated value matches the actual value exactly (see value parameter below for additional options to choose).
      • ignore – (default) Do not apply criterion (see value parameter below for additional options to choose).
      • notEquals – Criterion applies if the designated value does not match the actual value (see value parameter below for additional options to choose).
      • value – The value to use for matching. Options are: 
      • matchValue – Specifies the value to use for matching. The number of digits in the match value must be the same as the number specified in the Number of Digits field (default = "").
      • numberOfDigits – Total number of digits to use for comparison. For example, if the start digit position is 0 and the number of digits specified is 3, reading from left to right, the ERE would use the first, second, and third digits of the complete number for the comparison. (range: 0-2147483647 / default = 0).
      • startDigitPosition – The first position within the complete number specified in Digit Type field to start the comparison with value specified in the Match Value field. The start digit position 0 is the left-most digit of the complete number. (range: 0-2147483647 / default = 0).
  • egressFlag – Egress flag criteria:
    • operation
    • equals – Set the egress flag to a particular value.
    • ignore – (default) Do not apply the criterion in this section.
    • notEquals – The criterion applies if the designated value does not match the actual value.
    • value – Choose whether to apply DM rule for egress flag:
    • dontSend
    • send
    • natureOfAddress – NOA criteria
  • operation (same as for egressFlag above)

  • value:

    950 (default)aniNotAvailableOrNotProvided
    aniOfCalledPartyNationalNumberaniOfCalledPartyNoNumberPresent
    aniOfCalledPartySubscriberNumberaniOfCallingPartyNationalNumber
    aniOfCallingPartySubscriberNumberany
    apnNumberingPlanignore
    internationalinternationalNotRestricted
    internationalOperatorinternationalRestricted
    nationalnationalNotRestricted
    nationalOperatornationalRestricted
    networkSpecificnoNumberCutThroughnoNumberOperatorRequested
    nonepartialCallingLineId
    passThrough spare00...spare26
  • numberLength
    • operation: Specify how to match the Number Length criteria with the specified value (in value field):
  • equals
  • greaterThanOrEquals
  • ignore (default)
  • lessThanOrEquals
  • notEquals
  • value <unsignedInt> (range: 0-32 / default = 0)
  • numberingPlanIndicator
  • operation: Specify how to match the Numbering Plan Indicator with the specified value (in valuefield):
    • equals
    • ignore (default)
    • notEquals
  • value
    • data (default)
    • isdn
    • private
    • spare0Unknown
    • spare1
    • spare2
    • spare3 - spare7
    • telex
  • presentationMatch
    • operation: Specify how to match the Presentation Match criteria with the specified value (in valuefield):
      • equals
      • ignore (default)
      • notEquals
  • value
    • allowed
    • none (default)
    • number Unavailable
    • restricted
    • spare
  • screeningMatch
    • operation: Specify how to match the Screening Match criteria with the specified value (in value field):
      • equals
      • ignore (default)
      • notEquals
  • value
    • networkProvidedNotScreened
    • none (default)
    • userProvidedFailedNetworkScreening
    • userProvidedNotScreened
    • userProvidedPassedNetworkScreening
  • digitType – Digit/parameter type to apply this DM/PM Criteria. 

<252 | 253 | 254 | billingNumber (default)
calledDirectoryNumber | calledInNumber 
calledNumber | callingNumber
contractorNumber | dialedNumber | fromUri
gnAdditionalCalled | gnAdditionalCalling |
gnAdditionalConnected |
gnAdditionalOriginalCalled |
gnAdditionalRedirecting |
gnAdditionalRedirection | gnCalledCesId |
gnCollectCallNumber | gnDestination
gnDialedDigits | gnLocalAni
gnNetworkProvidedNumber | gnPortedDialed |
gnRedirectingTerminating |
gnThirdPartyNumber |
gnUserCallingNotScreened
gnUserCallingScreened | location |
originalCalledNumber | outpulseNumber |
presentationNumber | pretranslated |
redirecting | redirection |
twoStageCollected>

  • parameterPresenceCheck – Check for presence of this call parameter when applying DM/PM rule.
    • doesntExist – The ERE applies the associated PM rule if the parameter is not present in call parameters.
    • exists – (default) The ERE applies the associated PM rule if the parameter is present in call parameters.

DM/PM Rule Parameters

The DM/PM Rule parameters are listed in the table below:

Caption
0Table
1DM/PM Rule Parameters
 

Parameter

 Length/Range

 Description

dmPmRule

 1-23

The name of this DM/PM (digit manipulation/parameter manipulation) rule.

The default DM/PM rules are listed below. You can also create your own DM/PM rules.

  • PAI_AND_FROM_HEADER*
  • PAI_DISPLAY_NAMES_1_NTL*
  • PAI_SIP_DSPNAME_CLG_NAM
  • PAI_TEL_DSPNAME_GN_CPN
  • PRFX_TO_HEADER_CDPN_NTL*
  • PRFX_TO_HEADER_GDPN_NTL*
  • PRFX_TO_HEADER_OCN_NTL*
  • SIP_ADD_PLUS
  • SIP_REMOVE_CLG81
  • SIP_REMOVE_PLUS1
  • SIP_REMOVE_PLUS39
  • SIP_REMOVE_PLUS44
  • SIP_REMOVE_PLUS49
  • SIP_REMOVE_PLUS52
  • SIP_REMOVE_PLUS81
  • SIP_REMOVE_PLUS86
  • SIP_REMOVE_PLUS9
    * Uses seeded DM/PM criteria groups (see Tables 2 and 3 below for details).

subRule

 

Sub-rule priority (0-9)

  • criteria – DM/PM Criteria:

CALLED_NOA_NATIONAL | CALLING_!SEND |
CALLING_ALLOWED | CALLING_EXISTS |
CALLING_NOA_NATIONAL | CALLING_NOT_EXISTS |
CALLING_RESTRICTED | CLG_NAME_EXISTS |
GN_CALLING_ALLOWED | GN_CALLING_EXISTS | GN_CALLING_NOA_NATIONAL |
GN_CALLING_NOT_EXISTS | GN_CALLING_RESTRICTED |
GN_DIALED_NOA_NATIONAL | OCN_NOA_NATIONAL |
PAI_TEL_DISPLAY_NAME | SIP_MATCH_INTL_CD |
SIP_MATCH_INTL_CG | SIP_MATCH_INTL_GNACG |
SIP_MATCH_INTL_GNOCLD | SIP_MATCH_INTL_ORIGIN |
SIP_MATCH_INTL_PORTED | SIP_MATCH_INTL_RDRCTG |
SIP_MATCH_INTL_RDRCTN | SIP_MATCH_NOINTL_CD |
SIP_MATCH_NOINTL_CG | SIP_MATCH_NOINTL_GNACG |
SIP_MATCH_NOINTL_GNOCLD | SIP_MATCH_NOINTL_ORIGIN |
SIP_MATCH_NOINTL_PORTED | SIP_MATCH_NOINTL_RDRCTG | 
SIP_MATCH_NOINTL_RDRCTN | SIP_MATCH_PLUS1_GNACG |
SIP_MATCH_PLUS1_GNOCLD | SIP_MATCH_PLUS1_ORIGIN |
SIP_MATCH_PLUS1_PORTED | SIP_MATCH_PLUS1_RDRCTG |
SIP_MATCH_PLUS1_RDRCTN | SIP_MATCH_PLUS39_GNACG |
SIP_MATCH_PLUS39_GNOCLD | SIP_MATCH_PLUS39_ORIGIN |
SIP_MATCH_PLUS39_PORTED | SIP_MATCH_PLUS39_RDRCTG |
SIP_MATCH_PLUS39_RDRCTN | SIP_MATCH_PLUS44_GNACG |
SIP_MATCH_PLUS44_GNOCLD | SIP_MATCH_PLUS44_ORIGIN |
SIP_MATCH_PLUS44_PORTED | SIP_MATCH_PLUS44_RDRCTG |
SIP_MATCH_PLUS44_RDRCTN | SIP_MATCH_PLUS49_GNACG |
SIP_MATCH_PLUS49_GNOCLD | SIP_MATCH_PLUS49_ORIGIN |
SIP_MATCH_PLUS49_PORTED | SIP_MATCH_PLUS49_RDRCTG |
SIP_MATCH_PLUS49_RDRCTN | SIP_MATCH_PLUS52_GNACG |
SIP_MATCH_PLUS52_GNOCLD | SIP_MATCH_PLUS52_ORIGIN |
SIP_MATCH_PLUS52_PORTED | SIP_MATCH_PLUS52_RDRCTG |
SIP_MATCH_PLUS52_RDRCTN | SIP_MATCH_PLUS81_CLG |
SIP_MATCH_PLUS81_GNACG | SIP_MATCH_PLUS81_GNOCLD |
SIP_MATCH_PLUS81_ORIGIN | SIP_MATCH_PLUS81_PORTED |
SIP_MATCH_PLUS81_RDRCTG | SIP_MATCH_PLUS81_RDRCTN |
SIP_MATCH_PLUS86_GNACG | SIP_MATCH_PLUS86_GNOCLD |
SIP_MATCH_PLUS86_ORIGIN | SIP_MATCH_PLUS86_PORTED |
SIP_MATCH_PLUS86_RDRCTG | SIP_MATCH_PLUS86_RDRCTN |
SIP_MATCH_PLUS91_GNACG | SIP_MATCH_PLUS91_GNOCLD |
SIP_MATCH_PLUS91_ORIGIN | SIP_MATCH_PLUS91_PORTED |
SIP_MATCH_PLUS91_RDRCTG | SIP_MATCH_PLUS91_RDRCTN |
SIP_MATCH_PLUS_CLG | SIP_MATCH_PLUS_GNACG |
SIP_MATCH_PLUS_GNOCLD | SIP_MATCH_PLUS_ORIGIN |
SIP_MATCH_PLUS_PORTED | SIP_MATCH_PLUS_RDRCTG |
SIP_MATCH_PLUS_RDRCTN | TO_HEADER_EXISTS

  • priority (0-999)
  • digitManipulation
  • parameterManipulation – Use parameter to specify parameter manipulation rules.
    • availability
      • no
      • none (default)
      • yes
    • characterManipulation
      • numberOfCharacters – Number Of characters. (range: 0-64 / default = 24)
      • replacement– Use this parameter to specify replacement type and value.
        • replacementType
          • constant (default)
          • variable
        • value (range: 1-23 characters)
    • startCharacterPosition – The character starting point (range: 0-22 / default = 0).
    • parameterType – Parameter type.

additionalCategory | callingName |
carrierCode | carrierSelectionParameter |
causeOfNoId | chargeRateInfoIndicator |
cliBlockingIndicator | cpc | dpcIndicator
forwardCallIndicator | jurisdiction | olip |
originatingCarrier | originatingChargeArea
paiSipDisplayName | paiTelDisplayName |
sipFromDisplayName | transitNetworkSelection | zzCode

    • presentation <allowed | none | numberUnavailable | restricted | spare>
  • ruleType – Rule type. (see table for listing of sub-parameters)
    • digit
    • parameter (default)
    • uri

digitManipulation

 

The type of digit manipulation to perform.

  • digitStringManipulation – Options include:
    • action – The action to take when the matching criteria is met (used for international gateway support involving setting NOA to ‘International’ and adding country code):
      • addDestinationCountry
      • addIngressTrunkGroupCountry
      • addOriginatingCountry
      • none (default)
    • numberOfDigits – Number of digits (range: 0-30 / default = 0)
    • replacement – Use when this is a replacement DM rule.
    • startDigitPosition – The start digit position (range: 0-29 / default = 0).
  • numberParameterManipulation – Options for manipulating number parameter:
    • includeInEgress – Specify whether to include in egress, discard in egress or take no action:
      • discardInEgress
      • includeInEgress
      • none (default)
  • natureOfAddress – Nature Of Address options.

950 (default)
aniNotAvailableOrNotProvided
aniOfCalledPartyNationalNumber
aniOfCalledPartyNoNumberPresent
aniOfCalledPartySubscriberNumber
aniOfCallingPartyNationalNumber
aniOfCallingPartySubscriberNumber
any
apnNumberingPlan
ignore
international
internationalNotRestricted
internationalOperator
internationalRestricted
national
nationalNotRestricted
nationalOperator
nationalRestricted
networkSpecific
noNumberCutThrough
noNumberOperatorRequested
none
partialCallingLineId
passThrough
spare00...spare26

  • numberLength – Enter either "noInput" or a number.
    • noInput (default)
    • <number> (range: 0-31)
  • numberingPlanIndicator – Numbering Plan Indicator types:

data | ignore | isdn | none |
offsetUnused | private | spare0Unknown |
spare1 | spare2 | spare3 | spare4 |
spare5 | spare6 | spare7 | telephony |
telex

  • presentation – Presentation options include:
    • allowed
    • none (default)
    • numberUnavailabl
    • restricted
    • spare
  • screening – Network screening indicator of calling party number. Options include:
    • networkProvidedNotScreened – Network-provided screening, not screened.
    • none (default) •userProvidedFailedNetworkScreening – User-provided screening, failed network screening.
    • userProvidedNotScreened – User-provided screening, not screened.
    • userProvidedPassedNetworkScreening – User-provided screening, passed network screening.
  • numberType – Specify the number type:
    • billingNumber (default)
    • calledDirectoryNumber
    • calledNumber
    • callingNumber
    • contractorNumber
    • gnAdditionalCalled
    • gnAdditionalCalling
    • gnAdditionalConnected
    • gnAdditionalOriginalCalled
    • gnAdditionalRedirecting
    • gnAdditionalRedirection
    • gnCalledCesId
    • gnDestination
    • gnDialedDigits
    • gnNQI-252
    • gnNQI-253 
    • gnNQI-254
    • gnNetworkProvidedNumber
    • gnPortedDialed
    • gnRedirectingTerminating
    • gnUserCallingNotScreened
    • gnUserCallingScreened
    • location
    • originalCalledNumber
    • outpulseNumber
    • pretranslated
    • redirecting
    • redirection
    • twoStageCollected

The following DM/PM rules include assigned criteria groups.

Note

Criteria groups are not visible to the operator and cannot be modified.

Caption
0Table
1DM/PM Rules with Assigned Criteria Groups
 

...

  • CPN_!SEND_RES_!EXST
  • GN_CPN_!EXST_CPN_ALLOW
  • GN_CPN_!EXST_CPN_EXST
  • GN_CPN_!EXST_CPN_RESTRC
  • GN_CPN_ALLOW_CPN_EXST
  • GN_CPN_EXSTS_CPN_!EXSTS
  • GN_CPN_EXSTS_CPN_EXSTS
  • GN_CPN_RES_CPN_EXISTS

...

TOHD_EXST_CALLED_NTL

...

TOHD_EXST_GN_DIALED_NTL

...

TOHD_EXST_OCN_NTL

...

  • GN_CPN!EXST_CPN_NTL_TEL
  • GN_CPN_!EXST_CPN_ALLOW
  • GN_CPN_!EXST_CPN_EXST
  • GN_CPN_!EXST_CPN_RESTRC
  • GN_CPN_ALLOW_CPN_!EXST
  • GN_CPN_ALLOW_CPN_EXST
  • GN_CPN_EXSTS_CPN_EXSTS
  • GN_CPN_NTL_TEL
  • GN_CPN_RES_CPN_!EXST
  • GN_CPN_RES_CPN_EXISTS

The following table shows the criteria sub-rule sequence for each Criteria Group executed against the DM/PM rules. The logical operator defines the logic used when processing the criteria.

Caption
0Table
1How DM/PM Criteria Groups are Processed
 

DM/PM Criteria Group ID

Criteria ID Sequence

Logical
Operator

CPN_!SEND_RES_!EXST

  1. CALLING_!SEND
  2. CALLING_RESTRICTED
  3. CALLING_NOT_EXISTS

OR

GN_CPN!EXST_CPN_NTL_TEL

  1. GN_CALLING_NOT_EXISTS
  2. CALLING_NOA_NATIONAL
  3. PAI_TEL_DISPLAY_NAME

AND

GN_CPN_!EXST_CPN_ALLOW

  1. GN_CALLING_NOT_EXISTS
  2. CALLING_ALLOWED

AND

GN_CPN_!EXST_CPN_EXST

  1. GN_CALLING_NOT_EXISTS
  2. CALLING_EXISTS

AND

GN_CPN_!EXST_CPN_RESTRC

  1. GN_CALLING_NOT_EXISTS
  2. CALLING_RESTRICTED

AND

GN_CPN_ALLOW_CPN_!EXST

  1. GN_CALLING_ALLOWED
  2. CALLING_NOT_EXISTS

AND

GN_CPN_ALLOW_CPN_EXST

  1. GN_CALLING_ALLOWED
  2. CALLING_EXISTS

AND

GN_CPN_EXSTS_CPN_!EXSTS

  1. GN_CALLING_EXISTS
  2. CALLING_NOT_EXISTS

AND

GN_CPN_EXSTS_CPN_EXSTS

  1. GN_CALLING_EXISTS
  2. CALLING_EXISTS

AND

GN_CPN_NTL_TEL

  1. GN_CALLING_NOA_NATIONAL
  2. PAI_TEL_DISPLAY_NAME

AND

GN_CPN_RES_CPN_!EXST

  1. GN_CALLING_RESTRICTED
  2. CALLING_NOT_EXISTS

AND

GN_CPN_RES_CPN_EXISTS

  1. GN_CALLING_RESTRICTED
  2. CALLING_EXISTS

AND

TOHD_EXST_CALLED_NTL

  1. TO_HEADER_EXISTS
  2. CALLED_NOA_NATIONAL

AND

TOHD_EXST_GN_DIALED_NTL

  1. TO_HEADER_EXISTS
  2. GN_DIALED_NOA_NATIONAL

AND

TOHD_EXST_OCN_NTL

  1. TO_HEADER_EXISTS
  2. OCN_NOA_NATIONAL

AND

Sub-rule Rule Type Parameters

The Sub-rule Rule parameters are listed in the table below:

Div
classpdf6pttext

Parameter

 Description

digit

Digit rule type.

  • criteria (see subRule criteria listing in "DM/PM Rules Parameters" table above)
  • digitManipulation
    • digitStringManipulation
      • action <addDestinationCountry | addIngressTrunkGroupCountry | addOriginatingCountry | none>
      • numberOfDigits (range: 0-30 / default = 0)
      • replacement
        • digitString <digit string
        • numberOfDigits (range: 0-30 / default = 0)
        • startDigitPosition (range: 0-29 / default = 0)
        • type <constant|variable>
        • value (max. 64 characters)
    • numberParameterManipulation
      • includeInEgress <discardInEgress | includeInEgress | none>
      • natureOfAddress <NOA>
      •  numberLength (0-30, or 'noInput')
      • numberingPlanIndicator <NPA>
      • presentation <allowed | none | numberUnavailable | restricted | spare>
      • screening <networkProvidedNotScreened | none |
        userProvidedFailedNetworkScreening | userProvidedNotScreened |
        userProvidedPassedNetworkScreening>
    •  numberType <type>

parameter

Parameter rule type (default).

  • criteria (see subRule description in "DM/PM Rules Parameters" table above)
  • parameterManipulation
    • additionalCategory
      • informationMobile1 <any | [auto] | inflight | maritime | pager>
      • userName <[mobile1] | mobile2 | pstn1>
  • parameterType <type>

uri

URI rule type.

  • criteria (see subRule description in "DM/PM Rules Parameters" table above)
  • uriParameterManipulation
    • uriType
    • uriParameterManipulation
    • userInfoManipulation
    • hostPortManipulation
      • numberOfCharacters (range: 0-64 / default = 0)
      • portNumber (range: 0-65535, or 'noChange')
      • replacement
        • characterString <calledUri | callingUri | fromUri | none | paiSipUri | toUri>
        • startCharacterPosition – The character starting point (range: 0-63 / default = 0).
        • type
        • value
         
      • startCharacterPosition – The character starting point (range: 0-63 / default = 0).

Number Translation Criteria Parameters

The Number translation parameters are as shown below:

Caption
0Table
1 Number translation parameters
 

Parameter

Description

numberTranslationCriteria

The number translation criteria (route) label. Use this object to configure Number Translation Criteria for one of element types defined below.

Each element type includes the following addtional parameters to configure.

    • <elementID1> – A textual field (1-23 characters) to specify the domain name to associate with this element type. For example, the name of the trunk group which will apply this DM/PM rule.
    • <elementID2> – A textual field (1-23 characters) to specify userinfo to associate with this element type. For example, the IP peer of the trunk group applying this DM/PM rule.
    • <national> – A textual field (1-23 characters) to store the calling number, called number or number prefix to associate with this element type.
    • <country> – The Country code to associate with this element type.
    • lookupType – Choose an ENUM lookup type:
      • e911 – Emergency number translation services for subscribers with phone numbers not tied to a specific geographic location (NA variant only).
      • enumCnam – Calling name lookup in the IP network.
      • enumLnp – Number portability lookup in the IP network.
      • enumSipAor – SIP address of the record lookup in the IP network.
calledUri

This call processing element specifies the destination of the call. And this parameter is with respect to Request-URI in the received INVITE from UE. When configuring number translation for a Carrier, set the following parameters (see above for field descriptions):

  • <elementID1>
  • <elementID2>
  • <national>
  • <country>
  • lookupType

callingNumber

This call processing element specifies the source of the call. When configuring number translation for a Carrier, set the following parameters (see above for field descriptions):

  • <elementID1>
  • <elementID2>
  • <national>
  • <country>
  • lookupType

carrier

When configuring number translation for a Carrier, set the following parameters (see above for field descriptions):

  • <elementID1>
  • <elementID2>
  • <national>
  • <country>
  • lookupType

none

When configuring number translation with no element type, set the following parameters (see above for field descriptions):

  • <elementID1>
  • <elementID2>
  • <national>
  • <country>
  • lookupType
toHeader This call processing element specifies the destination of the call with respect to To Header in the received INVITE from UE. When configuring number translation for a Carrier, set the following parameters (see above for field descriptions):
  • <elementID1>
  • <elementID2>
  • <national>
  • <country>
  • lookupType

trunkGroup

When configuring number translation for a trunk group, set the following parameters (see above for field descriptions):

  • <elementID1>
  • <elementID2>
  • <national>
  • <country>
  • lookupType

Numbering Plan Parameters

The Numbering Plan parameters are as shown below:

Caption
0Table
1Numbering Plan Parameters
 

...

Parameter

...

Description

...

numberingPlan

Specifies numbering plan.

  • CHINA_NUM_PLAN
  • GENERIC_NUM_PLAN
  • GERMANY_NUM_PLAN
  • INDIA_NUM_PLAN
  • ITALY_NUM_PLAN
  • JAPAN_NUM_PLAN
  • MEXICO_NUM_PLAN
  • NANP_ACCESS
  • UK_NUM_PLAN

 

 

Note

The numbering plans above are default plans, but you can also create your own numbering plans.

...

lengths

The minimum and maximum lengths for various number types.

  • areaCode
  • exchangeCode
  • line
  • nationalNumber=
  • subscriberNumber

...

    • max <#> – Enter maximum value. (range: 0-999 / default = 4).
    • min <#> – Enter minimum value. (range: 0-999 / default = 4).

...

prefixProfile

...

Prefix profile name.

Prefix Profile Parameters

The Prefix Profile Parameters are as shown below:

Caption
0Table
1Prefix Profile Parameters
 

...

Parameter

...

Description

...

prefixProfile

Prefix profile name. Enter a profile name or select from list of default profiles.

  • CHINA_DIAL_PLAN
  • GENERIC_DIAL_PLAN
  • GERMANY_DIAL_PLAN
  • ITALY_DIAL_PLAN
  • INDIA_DIAL_PLAN
  • JAPAN_DIAL_PLAN
  • MEXICO_DIAL_PLAN
  • NA_DIAL_PLAN
  • UK_DIAL_PLAN

 

 

Note

The prefix profiles above are default profiles. You may also create your own prefix profiles.

...

entry

...

Use this object to configure the Prefix Profile using the parameters below.

  • <matching pattern> – (up to 28 characters)
  • <match start location> – 0
  • <total min digits> – 3
  • <total max digits> – 3
  • applyDmRule – Enable to apply Dm/Pm Rule.
    • disable (default)
    • enable
  • callType – Select linear Call Type.
    • _private (default)
    • carrierCutThrough
    • internationalOperator
    • internationalType
    • ipVpnService
    • localOperator
    • longDistanceOperator
    • mobile
    • nationalOperator
    • nationalType
    • otherCarrierChosen
    • test
    • transit
    • userName
Note

Do not select _private option when provisioning Prefix Profile on ERE. Private call routing is not fully supported at this time.

 

  • determineArea – When this flag is enabled, the area code is determined from the analyzed digits.
    • disable (default)
    • enable

  • digitType – Select digit type (default = unknown) 

    900PremiumToll | 950CarrierAccess | carrierAccess | directoryAssistance |
    easilyIdentifiableNumber | emergency | governmentEmergency | ieps |
    international |     internationalOperator | internetOffloadAnonymous |
    internetOffloadEconomy | internetOffloadPremium | internetOffloadStandard |
    internetReception |     ipVpn | localOperator | longDistanceOperator | national |
    nationalOperator | noDigits | otherCarrierChosen | private | serviceAccessCode |
    subscriber |     subscriberOperator | test | tollFree |transit | unknown | userName |
    verticalServiceCode

  • dmPmRule – Dm/Pm Rule identifier:
    • PAI_AND_FROM_HEADER
    • PAI_DISPLAY_NAMES_1_NTL
    • PAI_SIP_DSPNAME_CLG_NAM
    • PAI_TEL_DSPNAME_GN_CPN
    • PRFX_TO_HEADER_CDPN_NTL
    • PRFX_TO_HEADER_GDPN_NTL
    • PRFX_TO_HEADER_OCN_NTL
    • SIP_ADD_PLUS SIP_REMOVE_CLG81
    • SIP_REMOVE_PLUS1
    • SIP_REMOVE_PLUS39 SIP_REMOVE_PLUS44
    • SIP_REMOVE_PLUS49 SIP_REMOVE_PLUS52
    • SIP_REMOVE_PLUS81 SIP_REMOVE_PLUS86
    • SIP_REMOVE_PLUS91
  • natureOfAddress – Nature Of Address. 
  • 950 (default)
  • aniNotAvailableOrNotProvided
  • aniOfCalledPartyNationalNumber
  • aniOfCalledPartyNoNumberPresent
  • aniOfCalledPartySubscriberNumber
  • aniOfCallingPartyNationalNumber
  • aniOfCallingPartySubscriberNumber
  • anyapnNumberingPlan
  • ignore
  • international
  • internationalNotRestricted
  • internationalOperator
  • internationalRestricted
  • national
  • nationalNotRestricted
  • nationalOperator
  • nationalRestricted
  • networkSpecific
  • noNumberCutThrough
  • noNumberOperatorRequested
  • none
  • partialCallingLineId
  • passThrough
  • spare00...spare26
  • numberLeadingPrefixDigits <#> – Enter number of Leading Prefix Digits (range: 0-999 / default = 0).
  • numberLeadingPrefixDigitsToStrip <#> – Enter number of Leading Prefix Digits To Strip (range: 0-999 / default = 0).
  • numberingPlanIndicator – Numbering Plan Indicator.

data | ignore | isdn | none | offsetUnused | private | spare0Unknown | spare1 | spare2 |
spare3 | spare4 | spare5 | spare6 | spare7 | telephony | telex

Command Example

...

languagenone

...



Info
iconfalse

Related articles:

Children Display
depth2

 

Pagebreak